其他接口说明

最近更新时间:2020-06-04 18:53:15

目录

其他接口说明

1、横竖屏设置

  • 设置横竖屏setRequestedOrientation

方法描述

设置授权页前个页面的方向,授权页默认通过android:screenOrientation="behind"跟随前个页面的方向。

public void setRequestedOrientation(Activity activity, boolean isPortrait)

代码示例

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

参数说明

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

2、回调接口实现

通过实现AbstractOneLoginListener接口,通过它的多个回调可获取预取号、拉起授权页取号时的各种返回状态与结果,每次调用拉起授权页方法前必须先传入该接口的实现,否则不能正常拉起授权页。

2.1、结果返回

方法描述

当前流程的结果返回。取号成功、取号失败、切换账号、点返回或者按返回键从授权页返回取消登录等都从该回调返回结果,具体请参考 OneLogin 返回码。

public onResult(JSONObject jsonObject)

参数说明

参数 类型 说明
jsonObject JSONObject 回调信息

jsonObject 的参数说明

  • 取号成功
参数名 必须 类型 说明
msg String 运营商返回的状态信息
process_id String 流水号(有效期10分钟)
app_id String 金山云后台配置唯一 id
operator 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 具体的错误原因
operator String 客户端获取的运营商
clienttype String 客户端,1 表示 Android
sdk String SDK 的版本号
status int 状态码,状态码为 500

2.2、获取脱敏手机号

方法描述

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

public void onRequestTokenSecurityPhone(String phone)

参数说明

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

2.3、隐私条款点击

方法描述

隐私条款点击回调

public void onPrivacyClick(String name, String url)

参数说明

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

2.4、登录按钮点击

方法描述

登录按钮点击回调

public void onLoginButtonClick()

2.5、授权页面拉起

方法描述

授权页面拉起回调

public void onAuthActivityCreate(Activity activity)

参数说明

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

2.6、隐私条款页面拉起

方法描述

隐私条款页面拉起回调

public void onAuthWebActivityCreate(Activity activity)

参数说明

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

2.7、隐私条款 CheckBox 点击

方法描述

CheckBox点击回调

public void onPrivacyCheckBoxClick(boolean isChecked)

参数说明

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

2.8、一键登录加载 loading

方法描述

点一键登录时弹出自定义对话框式 loading 时机

public void onLoginLoading()

2.9、一键登录结合其他验证方式

方法描述

点一键登录时是否先调用其他验证方式进行验证

public boolean onRequestOtherVerify()

参数说明

参数 类型 说明 默认值
返回值 boolean 是否先调用其他验证方式进行验证 false

2.10、返回按钮点击

方法描述

点授权页面标题栏返回按钮或者手机返回键时的回调。

注: 该回调与带-20301/-20302返回码的onResult回调共存,两者都会返回

public void onBackButtonClick()

2.11、切换账号点击

方法描述

点授权页面切换账号栏的回调。

注: 该回调与带-20303返回码的onResult回调共存,两者都会返回

public void onSwitchButtonClick()

3、日志打印

  • 日志打印控制setLogEnable

方法描述

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

public void setLogEnable(boolean logEnable)

参数说明

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

代码示例

OneLoginHelper.with().setLogEnable(false);

4、预取号状态判断

  • 取号是否有效isPreGetTokenResultValidate

方法描述

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

public boolean isPreGetTokenResultValidate()

代码示例

OneLoginHelper.with().isPreGetTokenResultValidate();

5、SDK 版本号

  • 获取 SDK 版本号sdkVersion

方法描述

获取 SDK 版本号

public void sdkVersion()

代码示例

OneLoginHelper.with().sdkVersion()

6、初始化状态判断

  • 初始化是否成功isInitSuccess

方法描述

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

public boolean isInitSuccess()

代码示例

OneLoginHelper.with().isInitSuccess();

7、隐私条款是否勾选

  • 隐私条款是否勾选isPrivacyChecked

方法描述

判断是否勾选同意隐私条款声明。

public boolean isPrivacyChecked()

代码示例

OneLoginHelper.with().isPrivacyChecked();

8、关闭授权页加载动画

  • 关闭授权页面的 loading stopLoading

方法描述

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

public void stopLoading()

代码示例

OneLoginHelper.with().stopLoading();

9、隐私页 WebView 配置

  • 配置隐私页 WebView 控件的 WebViewClient 属性 setWebViewClient

方法描述

配置隐私页 WebView 控件的 WebViewClient 属性,用以自定义处理 WebView 加载隐私后的事件回调

public void setWebViewClient(WebViewClient webViewClient)

代码示例

OneLoginHelper.with().setWebViewClient(new WebViewClient() {
    @Override
    public boolean shouldOverrideUrlLoading(WebView view, WebResourceRequest request) {
        return false;
    }

    @Override
    public void onReceivedSslError(WebView view, SslErrorHandler handler, SslError error) {
        handler.proceed();
    }
});

10、一键登录延迟取号

  • 点一键登录后延迟取号 requestTokenDelay

方法描述

点击一键登录后,onRequestOtherVerify 回调返回 true, 先进行其他方式进行预校验,校验通过后通过该接口通知 SDK 进行取号

public void requestTokenDelay()

代码示例

OneLoginHelper.with().requestTokenDelay();

金山云,开启您的云计算之旅

免费注册