OneLogin

OneLogin 的主要外部调用接口

Protocol

userDidDismissAuthViewController

用户点击了授权页面的返回按钮

Declaration

- (void)userDidDismissAuthViewController;

userDidSwitchAccount

用户点击了授权页面的”切换账户”按钮

Declaration

- (void)userDidSwitchAccount;

Method

registerWithAppID:

向SDK注册AppID

Declaration

+ (void)registerWithAppID:(NSString *)appID;

Parameters

Param Description
appID 产品id, 请在官网注册获取

setDelegate:

设置代理对象

Declaration

+ (void)setDelegate:(nullable id<OneLoginDelegate>)delegate;

Parameters

Param Description
delegate 代理对象

setRequestTimeout:

设置请求超时时长。默认8秒。

Declaration

+ (void)setRequestTimeout:(NSTimeInterval)timeout;

Parameters

Param Description
timeout 请求超时的时长

preGetTokenWithCompletion:

预取号接口

Declaration

+ (void)preGetTokenWithCompletion:(void(^)(NSDictionary *sender))completion;

Parameters

Param Description
completion 预取号的处理回调

Discussion

// 成功的返回格式
{
status = 200; // NSNumber, 200为成功的状态码
processID = 47dab9b7c26629cd9bc117f88e2f9233; // NSString, 流水号
appID = 2**************************d; // NSString, 产品ID
operatorType = CU; // NSString, 运营商类型(CM/CU/CT)
msg = "\U83b7\U53d6accessCode\U6210\U529f"; // NSString, 相关的描述消息
}

// 失败的返回格式
{
status = 500; // NSNumber, 500为失败的状态码
processID = 47dab9b7c26629********f88e2f9233; // NSString, 流水号
appID = 2**************************d; // NSString, 产品ID
operatorType = CT; // NSString, 运营商类型(CM/CU/CT)
errorCode = -30003, // NSNumber, 当运营商不成功时的错误码
msg = "\U83b7\U53d6accessCode\U6210\U529f"; // NSString, 相关的描述消息
}

requestTokenWithViewController:viewModel:completion:

取号接口

Declaration

+ (void)requestTokenWithViewController:(UIViewController *)viewController viewModel:(nullable OLAuthViewModel *)viewModel completion:(void(^)(NSDictionary * _Nullable result))completion;

Parameters

Param Description
viewController 视图控制器
viewModel 自定义的试图模型
completion 取号接口的处理回调

Discussion

// 成功返回的格式:
{
status = 200; // NSNumber, 200为成功的状态码
processID = 47dab9b7c26629cd9bc117********33; // NSString, 流水号
appID = 2**************************d; // NSString, 产品ID
token = 62718774ad1247188bc678********d3; // NSString, 运营商返回的accessToken, 用于查询真实的本机号
operatorType = CU; // NSString, 运营商类型(CM/CU/CT)
msg = "\U83b7\U53d6accessCode\U6210\U529f"; // NSString, 运营商返回的Msg
}

// 失败返回的格式
{
status = 500; // NSNumber, 500为失败的状态码
processID = 47dab9b7c26629cd9bc117********33; // NSString, 流水号
appID = 2**************************d; // NSString, 产品ID
operatorType = CT; // NSString, 运营商类型(CM/CU/CT)
errorCode = -30003, // NSNumber, 运营商返回的错误码
msg = "\U83b7\U53d6accessCode\U6210\U529f"; // NSString, 相关的描述消息
}

sdkVersion

获取SDK版本号

Declaration

+ (NSString *)sdkVersion;

Return Value

当前的SDK版本号