其他接口说明

最近更新时间:2020-06-10 21:07:25

目录

其他接口说明

1、设置日志开关

设置日志开关,建议开发调试时打开日志,上线时关闭日志

/**
 * @abstract 设置是否允许打印日志
 *
 * @param enabled YES,允许打印日志 NO,禁止打印日志
 */
+ (void)ksc_setLogEnabled:(BOOL)enabled;

2、获取当前网络信息和运营商信息

获取当前网络信息和运营商信息,该接口可判断当前是否开启了 Wifi 和 蜂窝移动网络,并能准确判断当前蜂窝移动网络是 4G、3G 还是 2G,还能判断当前对应的运营商

/**
 获取当前 OneLogin 可用的网络信息

 @discussion
 当使用的是非移动、联通、电信三大运营商, 则返回nil。
 OneLogin 仅在大陆支持移动、联通、电信三大运营商。

 @seealso
 OLNetworkInfo 中有属性的详细描述
 */
+ (nullable KSCNetworkInfo *)currentNetworkInfo;

3、设置超时时长

设置请求超时时长

/**
 设置请求超时时长。默认时长5s。

 @param timeout 超时时长
 */
+ (void)ksc_setRequestTimeout:(NSTimeInterval)timeout;

4、服务条款复选框是否勾选

判断服务条款左边复选框是否勾选

/**
 * @abstract 服务条款左边复选框是否勾选
 */
+ (BOOL)isProtocolCheckboxChecked;

5、获取SDK版本号

获取 SDK 版本号

/**
 获取SDK版本号

 @return SDK当前的版本号
 */
+ (NSString *)sdkVersion;

6、获取当前授权页面

获取当前授权页面对应的 Controller

/**
 * @abstract 获取当前授权页面对应的ViewController
 *
 * @return 当前授权页面对应的ViewController
 */
+ (UIViewController * _Nullable)currentKscAuthViewController;

7、回调接口

7.1、加载授权页面进度条回调

/**
 * 授权页自定义Loading,会在点击登录按钮之后触发
 * containerView为loading的全屏蒙版view
 * 请自行在containerView添加自定义loading
 * 设置block后,默认loading将无效
 */
typedef void(^OLLoadingViewBlock)(UIView *containerView);

7.2、停止授权页面进度条回调

/**
 * 停止授权页自定义Loading,会在调用[OneLogin stopLoading]时触发
 * containerView为loading的全屏蒙版view
 */
typedef void(^OLStopLoadingViewBlock)(UIView *containerView);

7.3、授权页面视图生命周期回调

/**
 * 授权页面视图生命周期回调
 * @param viewLifeCycle 值为viewDidLoad、viewWillAppear、viewWillDisappear、viewDidAppear、viewDidDisappear
 * @param animated 是否有动画
 */
typedef void(^OLAuthViewLifeCycleBlock)(NSString *viewLifeCycle, BOOL animated);

7.4、监听授权按钮点击的回调

/**
 * 点击授权页面授权按钮的回调,用于监听授权页面登录按钮的点击
 */
typedef void(^OLClickAuthButtonBlock)(void);

7.5、点击授权页面勾选框的回调

/**
 * 点击授权页面隐私协议前勾选框的回调
 */
typedef void(^OLClickCheckboxBlock)(BOOL isChecked);

7.6、点击授权页面弹窗背景的回调

/**
 * 点击授权页面弹窗背景的回调
 */
typedef void(^OLTapAuthBackgroundBlock)(void);

7.7、授权页面旋转时的回调

/**
 * @abstract 授权页面旋转时的回调,可在该回调中修改自定义视图的frame,以适应新的布局
 */
typedef void(^OLAuthVCTransitionBlock)(CGSize size, id<UIViewControllerTransitionCoordinator> coordinator, UIView *customAreaView);

7.8、接管授权按钮点击事件的回调

/**
 * 是否自定义授权页面登录按钮点击事件,用于完全接管授权页面点击事件,当返回 YES 时,可以在 block 中添加自定义操作
 */
typedef BOOL(^OLCustomAuthActionBlock)(void);

7.9、点击切换账号按钮的回调

/**
 * 点击授权页面切换账号按钮的回调
 */
typedef void(^OLClickSwitchButtonBlock)(void);

7.10、点击运营商隐私协议的回调

typedef void(^OLViewPrivacyTermItemBlock)(KSCPrivacyTermItem *termItem, UIViewController *controller);

/**
 * 点击授权页面运营商隐私协议的回调
 */
@property (nullable, nonatomic, copy) KSCViewPrivacyTermItemBlock carrierTermItemBlock;

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

免费注册