SDK方法说明

当前版本支持将预取号逻辑封装在 SDK 内部处理,同时兼容老版本单独预取号模式, API 接口分两种调用方式介绍:

预取号和授权页拉起时机均由开发者自主控制

初始化init

SDK 初始化接口,可放在 ApplicationonCreate 方法中进行初始化。

方法描述

public void init(Context context);

参数说明

参数 类型 说明
context Context 上下文

预取号preGetToken

方法描述

public void preGetToken(String custom, int timeout, AbstractOneLoginListener oneLoginListener);

参数说明

参数 类型 说明
custom String 产品ID
timeout int 超时时间,单位:ms,取值范围:1000~15000
oneLoginListener AbstractOneLoginListener 回调监听器,需要开发者自己实现

取号requestToken

方法描述

public void requestToken(OneLoginThemeConfig oneLoginThemeConfig, AbstractOneLoginListener listener)

参数说明

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

预取号逻辑封装在SDK内部,开发者只需控制授权页拉起时机

初始化init

SDK 初始化接口,可放在 Application 的 onCreate方法中进行初始化。

方法描述

public void init(Context context)

参数说明

参数 类型 说明
context Context 上下文

注册register

方法描述

注册接口,0.9.0 版本新增,可同init方法一起放在 Application 的 onCreate 方法中进行注册。

public void register(String app_id)
public void register(String app_id, int timeout)

参数说明

参数 类型 说明
app_id String 极验后台配置唯一产品id,请在官网申请
timeout int 超时时间,单位:ms,取值范围:1000~15000,默认5000

取号requestToken

方法描述

public void requestToken(OneLoginThemeConfig oneLoginThemeConfig, AbstractOneLoginListener listener)

参数说明

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

公共接口说明

OneLoginThemeConfig实现接口

创建实例

OneLoginThemeConfig oneLoginThemeConfig = new OneLoginThemeConfig.Builder().build();

设置授权页面背景setAuthBGImgPath

方法描述

设置背景图片。

setAuthBGImgPath(String authBGImgPath)

参数说明

参数 参数类型 说明 默认值
authBGImgPath String 设置背景图片。放在 drawable 文件下,以下背景图片路径与之保持一致 gt_one_login_bg

设置弹窗主题相关setDialogTheme

方法描述
设置弹窗主题相关。

setDialogTheme(boolean isDialogTheme, int dialogWidth, int dialogHeight, int dialogX, int dialogY, boolean isDialogBottom, boolean isWebViewDialogTheme)

参数说明

参数 参数类型 说明 默认值
isDialogTheme boolean 是否使用弹窗模式,true 为使用,false 为不使用 false
dialogWidth int 弹窗模式宽度,长宽的单位都为dp以下单位与之保持一致 300
dialogHeight int 弹窗模式高度 500
dialogX int 授权⻚弹窗X偏移量(以屏幕⼼为原点) 0
dialogY int 授权⻚弹窗Y偏移量(以屏幕⼼为原点) 0
isDialogBottom boolean 授权⻚弹窗是否贴于屏幕底部 true:显示到屏幕底部,dialogY 参数设置将⽆效 false:不显示到屏幕底部,以 dialogY 参数为准 false
isWebViewDialogTheme boolean 隐私页面是否使用弹窗模式 false

状态栏设置setStatusBar

方法描述

设置状态栏颜色、字体颜色。

setStatusBar(int statusBarColor,int navigationBarColor,boolean isLightColor)

参数说明

参数 参数类型 说明 默认值
statusBarColor int 自定义状态栏背景颜色 0
navigationBarColor int 自定义底部导航栏背景颜色 0
isLightColor boolean 设置状态栏内容的颜色(只能黑白),true 为黑色,false 为白色 false

标题栏设置setAuthNavLayout

方法描述

设置标题栏布局

setAuthNavLayout(int navColor, int authNavHeight, boolean authNavTransparent, boolean authNavGone)

参数说明

参数 参数类型 说明 默认值
navColor int 标题栏颜色 0xFF3973FF
authNavHeight int 标题栏高度 49
authNavTransparent boolean 标题栏是否透明 true
authNavGone boolean 标题栏是否隐藏,此处的隐藏为 View.GONE false

标题栏文字设置setAuthNavTextView

方法描述
设置标题栏中间文字相关

setAuthNavTextView(String navText, int navTextColor, int navTextSize, boolean navTextNormal, String navWebViewText, int navWebViewTextColor, int navWebViewTextSize)

参数说明

参数 参数类型 说明 默认值
navText String 文字设置 一键登录
navTextColor int 字体颜色 0xFFFFFFFF
navTextSize int 字体大小,单位为sp,以下设置字体大小的单位与之保持一致 17
navTextNormal boolean 设置是否隐私条款页面的标题栏中间文字使用默认值,true 为使用navWebViewText,false为使用默认隐私条款的名字 false
navWebViewText String 隐私条款页面的标题栏中间文字 服务条款
navWebViewTextColor int 隐私条款页面的标题栏中间文字颜色 0xFF000000
navWebViewTextSize int 隐私条款页面的标题栏中间文字大小 17

标题栏字体设置setAuthNavTextViewTypeface

方法描述

设置标题栏中间文字的字体相关

setAuthNavTextViewTypeface(Typeface navTextTypeface,Typeface navWebViewTextTypeface)

参数说明

参数 参数类型 说明 默认值
navTextTypeface Typeface 标题栏的文字的字体 Typeface.DEFAULT
navWebViewTextTypeface Typeface 条款页面标题栏的文字的字体 Typeface.DEFAULT

标题栏返回按钮设置setAuthNavReturnImgView

方法描述

设置标题栏返回按钮相关

setAuthNavReturnImgView(String navReturnImgPath, int returnImgWidth, int returnImgHeight, boolean navReturnImgHidden, int returnImgOffsetX)
setAuthNavReturnImgView(String navReturnImgPath, int returnImgWidth, int returnImgHeight, boolean navReturnImgHidden, int returnImgOffsetX, int returnImgOffsetY)

参数说明

参数 参数类型 说明 默认值
navReturnImgPath String 返回按钮图片 gt_one_login_ic_chevron_left_black
returnImgWidth int 返回按钮图片宽度 24
returnImgHeight int 返回按钮图片高度 24
navReturnImgHidden boolean 返回按钮是否隐藏 false
returnImgOffsetX int 返回按钮图片距离屏幕左边X轴偏移量 12
returnImgOffsetY int 返回按钮图片距离标题栏顶部偏移量,可选配,不传该参数默认标题栏垂直居中 0

logo设置setLogoImgView

方法描述

设置logo相关

setLogoImgView(String logoImgPath, int logoWidth, int logoHeight, boolean logoHidden, int logoOffsetY, int logoOffsetY_B, int logoOffsetX)

参数说明

参数 参数类型 说明 默认值
logoImgPath String logo 图片 gt_one_login_logo
logoWidth int logo 图片宽度 71
logoHeight int logo 图片高度 71
logoHidden boolean logo 是否隐藏 false
logoOffsetY int logo 相对于状态栏下边缘y偏移 125
logoOffsetY_B int logo 相对于底部y偏移 0
logoOffsetX int logo 相对于屏幕左边X轴偏移量,当为0时表示居中显示 0

号码显示设置setNumberView

方法描述

设置号码相关

setNumberView(int numberColor, int numberSize, int numFieldOffsetY, int numFieldOffsetY_B, int numFieldOffsetX)

参数说明

参数 参数类型 说明 默认值
numberColor int 号码栏字体颜色 0xFF3D424C
numberSize int 号码栏字体大小 24
numFieldOffsetY int 号码栏相对于标题栏下边缘y偏移 200
numFieldOffsetY_B int 号码栏相对于底部y偏移 0
numFieldOffsetX int 号码栏相对于屏幕左边X轴偏移量,当为0时表示居中显示 0

号码字体设置setNumberViewTypeface

方法描述

设置号码栏字体相关

setNumberViewTypeface(Typeface numberViewTypeface)

参数说明

参数 参数类型 说明 默认值
numberViewTypeface Typeface 号码栏的文字的字体 Typeface.DEFAULT

切换账号视图设置setSwitchView

方法描述

设置切换账号相关

setSwitchView(String switchText, int switchColor, int switchSize, boolean switchAccHidden, int switchAccOffsetY, int switchOffsetY_B, int switchOffsetX)

参数说明

参数 参数类型 说明 默认值
switchText int 切换账号文字 切换账号
switchColor String 切换账号字体颜色 0xFF3973FF
switchSize int 切换账号字体大小 14
switchAccHidden boolean 切换账号是否隐藏 false
switchAccOffsetY int 切换账号相对于标题栏下边缘y偏移 249
switchOffsetY_B int 切换账号相对于底部y偏移 0
switchOffsetX int 切换账号相对于屏幕左边X轴偏移量,当为0时表示居中显示 0

切换账号字体设置setSwitchViewTypeface

方法描述

设置切换账号字体相关

setSwitchViewTypeface(Typeface switchViewTypeface)

参数说明

参数 参数类型 说明 默认值
switchViewTypeface Typeface 切换账号的文字的字体 Typeface.DEFAULT

登录按钮布局设置setLogBtnLayout

方法描述

设置登录按钮布局

setLogBtnLayout(String loginImgPath, int logBtnWidth, int logBtnHeight, int logBtnOffsetY, int logBtnOffsetY_B, int logBtnOffsetX)

参数说明

参数 参数类型 说明 默认值
loginImgPath String 登录按钮背景图片 gt_one_login_btn_normal
logBtnWidth int 登录按钮宽度 268
logBtnHeight int 登录按钮高度 36
logBtnOffsetY int 登录按钮相对于标题栏下边缘y偏移 249
logBtnOffsetY_B int 登录按钮相对于底部y偏移 0
logBtnOffsetX int 登录按钮相对于屏幕左边X轴偏移量,当为0时表示居中显示 0

登录按钮文字设置setLogBtnTextView

方法描述

设置登录按钮中间文字相关

setLogBtnTextView(String loginButtonText, int loginButtonColor, int logBtnTextSize)

参数说明

参数 参数类型 说明 默认值
loginButtonText String 文字设置 一键登录
loginButtonColor int 文字颜色 0xFFFFFFFF
logBtnTextSize int 文字大小 15

登录按钮文字字体设置setLogBtnTextViewTypeface

方法描述

设置登录按钮中间文字的字体相关

setLogBtnTextViewTypeface(Typeface logBtnTextViewTypeface)

参数说明

参数 参数类型 说明 默认值
logBtnTextViewTypeface Typeface 登录按钮中间的文字的字体 Typeface.DEFAULT

登录加载视图设置setLogBtnLoadingView

方法描述

设置loading图片相关

setLogBtnLoadingView(String loadingView, int loadingViewWidth, int loadingViewHeight, int loadingViewOffsetRight)
setLogBtnLoadingView(String loadingView, int loadingViewWidth, int loadingViewHeight, int loadingViewOffsetRight, int loadingViewOffsetY)

参数说明

参数 参数类型 说明 默认值
loadingView String loading图片地址 umcsdk_load_dot_white
loadingViewWidth int loading图片宽度 20
loadingViewHeight int loading图片高度 20
loadingViewOffsetRight int loading图片距离登录框右边X轴偏移量 12
loadingViewOffsetY int loading图片距离登录框Y轴偏移量,可选配,不传该参数默认登录框垂直居中 0

标语设置setSloganView

方法描述

设置Slogan相关

setSloganView(int sloganColor, int sloganSize, int sloganOffsetY, int sloganOffsetY_B, int sloganOffsetX)

参数说明

参数 参数类型 说明 默认值
sloganColor int 设置Slogan字体颜色 0xFFA8A8A8
sloganSize int 设置Slogan字体大小 10
sloganOffsetY int 设置Slogan相对于标题栏下边缘y偏移 382
sloganOffsetY_B int 设置Slogan相对于底部y偏移 0
sloganOffsetX int 设置Slogan相对于屏幕左边X轴偏移量,当为0时表示居中显示 0

标语字体设置setSloganViewTypeface

方法描述

设置slogan文字的字体相关

setSloganViewTypeface(Typeface sloganViewTypeface)

参数说明

参数 参数类型 说明 默认值
sloganViewTypeface Typeface slogan 的文字的字体 Typeface.DEFAULT

隐私栏布局设置setPrivacyLayout

方法描述

设置隐私条款布局

setPrivacyLayout(int privacyLayoutWidth, int privacyOffsetY, int privacyOffsetY_B, int privacyOffsetX,boolean isUseNormalWebActivity)

参数说明

参数 参数类型 说明 默认值
privacyLayoutWidth int 设置隐私条款宽度,隐私条款大部分为字体,只规定宽度,高度自适应 256
privacyOffsetY int 设置隐私条款相对于标题栏下边缘y偏移 0
privacyOffsetY_B int 设置隐私条款相对于底部y偏移 18
privacyOffsetX int 设置隐私条款对于屏幕左边X轴偏移量,当为0时表示居中显示 0
isUseNormalWebActivity boolean 设置是否跳转到默认的隐私条款页面 true

注:privacyOffsetYprivacyOffsetY_B两个偏移量必须有一个为0,否则优先采用privacyOffsetY_B

隐私栏勾选框设置setPrivacyCheckBox

方法描述

设置隐私条款选择框相关

setPrivacyCheckBox(String unCheckedImgPath, String checkedImgPath, boolean privacyState, int privacyCheckBoxWidth, int privacyCheckBoxHeight)
setPrivacyCheckBox(String unCheckedImgPath, String checkedImgPath, boolean privacyState, int privacyCheckBoxWidth, int privacyCheckBoxHeight, int privacyCheckBoxOffsetY)

参数说明

参数 参数类型 说明 默认值
unCheckedImgPath String 设置未选中下按钮的图片地址 gt_one_login_unchecked
checkedImgPath String 设置选中下按钮的图片地址 gt_one_login_checked
privacyState boolean 设置选择框是否默认选中 true
privacyCheckBoxWidth int 选择框图片宽度 9
privacyCheckBoxHeight int 选择框图片高度 9
privacyCheckBoxOffsetY int 选择框图片Y轴偏移,可选配 2

隐私条款文字显示设置setPrivacyClauseView

方法描述

设置隐私条款字体相关

setPrivacyClauseView(int baseClauseColor, int color, int privacyClauseTextSize)

参数说明

参数 参数类型 说明 默认值
baseClauseColor int 设置隐私条款基础文字颜色 0xFFA8A8A8
color int 设置隐私条款协议文字颜色 0xFF3973FF
privacyClauseTextSize int 设置隐私条款字体大小 10

隐私条款文字设置setPrivacyTextView

方法描述

设置除了隐私条款其他的字体相关

setPrivacyTextView(String privacyTextViewTv1, String privacyTextViewTv2, String privacyTextViewTv3, String privacyTextViewTv4)

参数说明

参数 参数类型 说明 默认值
privacyTextViewTv1 String 设置隐私条款文字1 登录即同意
privacyTextViewTv2 String 设置隐私条款文字2
privacyTextViewTv3 String 设置隐私条款文字3
privacyTextViewTv4 String 设置隐私条款文字4 并使用本机号码登录

设置隐私栏文字的字体setPrivacyClauseViewTypeface

方法描述

设置隐私栏文字的字体相关

setPrivacyClauseViewTypeface(Typeface privacyClauseBaseTextViewTypeface, Typeface privacyClauseTextViewTypeface)

参数说明

参数 参数类型 说明 默认值
privacyClauseBaseTextViewTypeface Typeface 隐私栏基础的文字的字体 Typeface.DEFAULT
privacyClauseTextViewTypeface Typeface 隐私条款的文字的字体 Typeface.DEFAULT

开发者隐私条款设置setPrivacyClauseText

方法描述

设置开发者隐私条款相关。

自定义隐私条款顺序。按顺序设置,当有条款名称与条款URL一起为空时,则使用默认的运营商隐私条款。否则按照顺序排列,自定义隐私条款最多只能两个。

setPrivacyClauseText(String clauseNameOne, String clauseUrlOne, String clauseNameTwo, String clauseUrlTwo, String clauseNameThree, String clauseUrlThree)

参数说明

参数 参数类型 说明 默认值
clauseNameOne String 设置隐私条款1名称 null
clauseUrlOne String 设置隐私条款1URL null
clauseNameTwo String 设置隐私条款2名称 null
clauseUrlTwo String 设置隐私条款2URL null
clauseNameThree String 设置隐私条款3名称 null
clauseUrlThree String 设置隐私条款3URL null

未同意隐私条款时的文字提示setPrivacyUnCheckedToastText

方法描述

设置未同意隐私条款时的文字提示相关。

setPrivacyUnCheckedToastText(String privacyUnCheckedToastText)

参数说明

参数 参数类型 说明 默认值
privacyUnCheckedToastText String 设置未同意隐私条款的文字提示相关 请同意服务条款

AbstractOneLoginListener实现接口

结果返回onResult

方法描述

整个流程的结果返回

public onResult(JSONObject jsonObject)

参数说明

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

jsonObject的参数说明

  • 取号成功
参数名 必须 类型 说明
msg String 运营商返回的状态信息
process_id String 流水号(有效期10分钟)
app_id String 极验后台配置唯一id
operatorType String 客户端获取的运营商
clienttype String 客户端,1表示Android
sdk String sdk的版本号
status int 状态码,状态码为200
token String 运营商返回的accessToken
authcode String 电信运营商返回的authcode
  • 取号失败
参数名 必须 类型 说明
errorCode String 错误码
msg String 运营商返回的状态信息
process_id String 流水号(有效期10分钟)
app_id String 极验后台配置唯一id
metadata JSONObject 具体的错误原因
operatorType String 客户端获取的运营商
clienttype String 客户端,1表示Android
sdk String sdk的版本号
status int 状态码,状态码为500

获取脱敏手机号onRequestTokenSecurityPhone

方法描述

获取用于界面展示的脱敏手机号

public void onRequestTokenSecurityPhone(String phone)

参数说明

参数 类型 说明
phone String 脱敏手机号

隐私条款点击onPrivacyClick

方法描述

隐私条款点击回调

public void onPrivacyClick(String name, String url)

参数说明

参数 类型 说明
name String 隐私条款名称
url String 隐私条款地址

登录按钮点击onLoginButtonClick

方法描述

登录按钮点击回调

public void onLoginButtonClick()

授权页面拉起onAuthActivityCreate

方法描述

授权页面拉起回调

public void onAuthActivityCreate(Activity activity)

参数说明

参数 类型 说明
activity Activity 授权页面

隐私条款页面拉起onAuthWebActivityCreate

方法描述

隐私条款页面拉起回调

public void onAuthWebActivityCreate(Activity activity)

参数说明

参数 类型 说明
activity Activity 隐私条款页面

CheckBox点击onPrivacyCheckBoxClick

方法描述

CheckBox点击回调

public void onPrivacyCheckBoxClick(boolean isChecked)

参数说明

参数 类型 说明
isChecked boolean CheckBox是否点击

finish授权页dismissAuthActivity

方法描述

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

public void dismissAuthActivity()

代码示例

OneLoginHelper.with().dismissAuthActivity();

参数说明

日志开关setLogEnable

方法描述

设置是否开启SDK日志打印功能,默认是开启的。

public void setLogEnable(boolean logEnable)

代码示例

OneLoginHelper.with().setLogEnable(false);

参数说明

参数 类型 说明
logEnable boolean 是否开启日志

初始化是否成功isInitSuccess

方法描述

判断是否初始化成功,cancel之后必须重新初始化。

public boolean isInitSuccess()

代码示例

OneLoginHelper.with().isInitSuccess();

参数说明

预取号是否有效isPreGetTokenResultValidate

方法描述

判断是否预取号结果是否有效,预取号失败、预取号结果超期、预取号结果已使用情况均返回预取号结果失效。

public boolean isPreGetTokenResultValidate()

代码示例

OneLoginHelper.with().isPreGetTokenResultValidate();

参数说明

预取号是否成功isPreGetTokenSuccess

方法描述

判断是否预取号成功,取号必须在预取号成功之后。已废弃,后续版本可能移除。

public boolean isPreGetTokenSuccess()

代码示例

OneLoginHelper.with().isPreGetTokenSuccess();

参数说明

隐私条款是否同意isPrivacyChecked

方法描述

判断隐私条款是否同意。

public boolean isPrivacyChecked()

代码示例

OneLoginHelper.with().isPrivacyChecked();

参数说明

accessCode是否过期isAccessCodeExpired

方法描述

判断预取号accessCode是否过期。已废弃,后续版本可能移除。

public boolean isAccessCodeExpired()

代码示例

OneLoginHelper.with().isAccessCodeExpired();

参数说明

设置横竖屏setRequestedOrientation

方法描述

设置当前页面横竖屏。

public void setRequestedOrientation(Activity activity, boolean isPortrait)

代码示例

OneLoginHelper.with().setRequestedOrientation(MainActivity.this, true);

参数说明

参数 类型 说明
activity Activity 当前调用OneLogin的页面
isPortrait boolean 是否是竖屏

关闭授权页面的loadingstopLoading

方法描述

关闭授权页面的loading,在校验方法中实现

public void stopLoading()

代码示例

OneLoginHelper.with().stopLoading();

参数说明

获取SDK版本号sdkVersion

方法描述

获取SDK版本号

public void sdkVersion()

参数说明

代码示例

OneLoginHelper.with().sdkVersion()

开发者自定义控件

添加自定义控件addOneLoginRegisterViewConfig

方法描述

在requestToken()方法之前实现。允许开发者在授权页面titlebarbody添加自定义的控件
注意:自定义的控件不允许覆盖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是一个接口,实现了点击方法