SDK方法说明

初始化

方法描述

public void init(Context context)

参数说明

参数 类型 说明
context Context 上下文

预取号

方法描述

app_id:产品id,请在官网申请

public void preGetToken(String app_id,int timeout, AbstractOneLoginListener listener)

参数说明

参数 类型 说明
app_id String 极验后台配置唯一id
timeout int 设置的预取号超时时间
listener AbstractOneLoginListener 回调监听器,需要开发者自己实现

AbstractOneLoginListener实现接口

回调

方法说明

整个流程的结果返回

public onResult(JSONObject jsonObject)

参数说明

参数 类型 说明
jsonObject JSONObject 错误信息
jsonObject的参数说明

预取号成功

参数名 必须 类型 说明
msg String 运营商返回的状态信息
process_id String 流水号
app_id String 极验后台配置唯一id
operatorType String 客户端获取的运营商
clienttype String 客户端,1表示Android
sdk String sdk的版本号
status int 状态码,状态码为200
accessCode String 运营商返回的accessCode
number String 运营商返回的去敏手机号

预取号失败

参数名 必须 类型 说明
errorCode String 错误码
msg String 运营商返回的状态信息
process_id String 流水号
app_id String 极验后台配置唯一id
metadata JSONObject 具体的错误原因
operatorType String 客户端获取的运营商
clienttype String 客户端,1表示Android
sdk String sdk的版本号
status int 状态码,状态码为500

取号

方法描述

public void requestToken(OneLoginThemeConfig oneLoginThemeConfig, AbstractOneLoginListener listener)

参数说明

参数 类型 说明
oneLoginThemeConfig OneLoginThemeConfig 全局配置接口
listener AbstractOneLoginListener 回调监听器,需要开发者自己实现

OneLoginThemeConfig实现接口

创建实例

OneLoginThemeConfig oneLoginThemeConfig=new OneLoginThemeConfig.Builder().build();
方法说明
方法名 传参类型 说明
setNavColor int 设置标题栏的整个背景颜色(如0xffffffff,以下与之相同)
setNavText String 设置标题栏中间的文字
setNavTextColor int 设置标题栏中间的文字颜色
setNavReturnImgPath String 设置标题栏的返回按钮图片(放在drawable文件下的文件名,不包括后缀。如:ic_launcher。以下的图片路径与之相同)
setAuthNavTransparent boolean 设置授权页导航栏是否透明
setAuthBGImgPath String 设置整个页面的背景图片
setLogoImgPath String 设置logo的地址
setLogoWidthDip int 设置logo的宽度,单位dp
setLogoHeightDip int 设置logo的高度,单位dp
setLogoHidden boolean 隐藏logo
setLogoOffsetY int 设置logo相对于标题栏下边缘y偏移
setLogoOffsetY_B int 设置logo相对于底部y偏移
setNumberColor int 设置手机号码字体颜色
setNumberSize String 设置号码栏字体大小
setNumFieldOffsetY int 设置号码栏相对于标题栏下边缘y偏移
setNumFieldOffsetY_B int 设置号码栏相对于底部y偏移
setSloganTextColor int 设置slogan字体颜色
setSloganOffsetY int 设置slogan相对于标题栏下边缘y偏移
setSloganOffsetY_B int 设置slogan相对于底部y偏移
setLogBtnText String 设置登录按钮文字
setLogBtnTextColor int 设置登录按钮文字颜色
setLogBtnImgPath String 设置登录按钮图片
setLogBtnOffsetY int 设置登录按钮相对于标题栏下边缘y偏移
setLogBtnOffsetY_B int 设置登录按钮相对于底部y偏移
setSwitchAccTextColor int 设置切换账号的字体颜色
setSwitchAccHidden boolean 隐藏切换账号
setSwitchOffsetY int 设置切换账号相对于标题栏下边缘y偏移
setSwitchOffsetY_B int 设置切换账号相对于底部y偏移
setClauseColor int,int 设置隐私条款名称颜色(基础文字颜色,协议文字颜色)
setUncheckedImgPath String 设置选择框未选中时候的图片
setCheckedImgPath String 设置选择框选中时候的图片
setPrivacyState boolean 隐私条款check默认状态
setClauseOne String,String 设置开发者隐私条款1名称和URL(名称,url)
setClauseTwo String,String 设置开发者隐私条款2名称和URL(名称,url)
setPrivacyOffsetY int 设置隐私条相对于标题栏下边缘y偏移
setPrivacyOffsetY_B int 设置隐私条相对于底部y偏移

AbstractOneLoginListener实现接口

回调

方法说明

整个流程的结果返回

public onResult(JSONObject jsonObject)

参数说明

参数 类型 说明
jsonObject JSONObject 错误信息
jsonObject的参数说明

取号成功

参数名 必须 类型 说明
msg String 运营商返回的状态信息
process_id String 流水号
app_id String 极验后台配置唯一id
operatorType String 客户端获取的运营商
clienttype String 客户端,1表示Android
sdk String sdk的版本号
status int 状态码,状态码为200
token String 运营商返回的accessToken

取号失败

参数名 必须 类型 说明
errorCode String 错误码
msg String 运营商返回的状态信息
process_id String 流水号
app_id String 极验后台配置唯一id
metadata JSONObject 具体的错误原因
operatorType String 客户端获取的运营商
clienttype String 客户端,1表示Android
sdk String sdk的版本号
status int 状态码,状态码为500

开发者自定义控件

方法描述

在requestToken()方法之前实现。允许开发者在授权页面titlebar和body添加自定义的控件
注意:自定义的控件不允许覆盖SDK默认的UI。

public OneLoginHelper addOneLoginRegisterViewConfig(String id, AuthRegisterViewConfig authRegisterViewConfig)

代码示例

OneLoginHelper.with().addOneLoginRegisterViewConfig(id, authRegisterViewConfig);

参数说明

参数 类型 说明
id String 开发者自定义控件名称
authRegisterViewConfig AuthRegisterViewConfig 配置开发者自定义控件的控件来源,位置和处理逻辑等

AuthRegisterViewConfig实现接口

创建实例

AuthRegisterViewConfig authRegisterViewConfig =new AuthRegisterViewConfig.Builder().build();
方法说明
方法名 传参类型 说明
setView View 开发者传入自定义的控件,需要设置好控件的布局属性,SDK只支持RelativeLayout布局
setRootViewId int 设置控件的位置。RootViewId.ROOT_VIEW_ID_TITLE_BAR指标题栏,RootViewId.ROOT_VIEW_ID_BODY指授权页空白处
setCustomInterface CustomInterface 设置控件事件。CustomInterface是一个接口,实现了点击方法

finish授权页

SDK默认除了返回按钮触以外,默认是不finsih授权页的,需要开发自行实现。

方法描述

public void quitAuthActivity()

代码示例

OneLoginHelper.with().quitAuthActivity();

参数说明

关闭验证

方法描述

在activity的onDestroy()方法中实现

public void cancel()

代码示例

OneLoginHelper.with().cancel();

参数说明

内部方法

方法描述

获取SDK版本号

public void sdkVersion()

参数说明

代码示例

OneLoginHelper.with().sdkVersion()

混淆规则

-dontwarn com.geetest.onelogin.**
-keep class com.geetest.onelogin.** {
*;
}
-dontwarn com.cmic.sso.sdk.**
-keep class com.cmic.sso.sdk.** {
*;
}
-dontwarn com.unicom.xiaowo.login.**
-keep class com.unicom.xiaowo.login.** {
*;
}
-dontwarn cn.com.chinatelecom.account.api.**
-keep class cn.com.chinatelecom.account.api.** {
*;
}

日志打印

SDK提供部分日志,TAG为Geetest_OneLogin