iOS SDK接入指南

注意事项

使用一键登录服务用户须打开蜂窝数据流量，取号过程中会消耗用户少量的流量。
sdk 中自带有授权页面的 UI 逻辑，开发者可通过 SDK 接口暴露参数修改部分 UI 界面样式。
如果用户使用双卡手机，sdk 会使用当前设备上网的流量进行预取号操作。
sdk 支持版本:iOS9.0 及以上。
请在天翼云官网-一键登录产品帮助中心-开发指南-SDK版本发布中下载最新版本SDK。

iOS SDK使用方法

环境配置

1.把 ability_login_ios_sdk.framework 拖入工程中，勾选 Copy item if needed。

2.把 AbilityResource.bundle资源包拖入工程，勾选 Copy item if needed。

3.info.plist 文件中添加 App Transport Security Settings / Allow Arbitrary Loads 子项设置为 YES。

4.build phases 里添加 Copy Files, Destination 设置为 Frameworks，点击+，添加 ability_login_ios_sdk.framework。

5.build settings 里设置 Header Search Paths 设置 ability_login_ios_sdk.framework文件的路径，设置为 "$(SRCROOT)/ability_login_ios_demo_oc/ability_login_ios_sdk.framework"。

6.build settings 例设置 Other Linker Flags 添加 “-ObjC”。

如果项目是 swift 需要添加如下步骤。

7.创建 OCBridgeHeader.h 桥接文件。

。

桥接文件中添加如下引用。

build settings 里设置 Objective-C Bridging Header 设置为 $(PROJECT_DIR)/ability_login_ios_demo_swift/OCBridgeHeader.h。

Precompile Bridging Header 设置为 No。

初始化接口

应用调用此方法初始化sdk，初始化会校验应用标识是否存在，回调成功后进行下一步预取号操作。

1.0.3及以上版本使用

-( void )initLogin:(NSString *)lxId secret:(NSString *)lxscecret isCompletion:( void (^)(NSDictionary *_Nonnull result))completion

参数定义

参数名称	含义
lxid	用户申请应用的id
lxscecret	用户申请应用的secret（1.0.3及版本以上）
completion	初始化结果回调

成功响应

参数名称	类型	含义
code	NSString	200
msg	NSString	success
userId	NSString	用户userId
operatorType	NSString	运营商类型

代码示例：

[[AbilityLoginManage instance] initLogin:appId secret:appsecret isCompletion:^(NSDictionary * _Nonnull result) {    NSString *success = [NSString stringWithFormat:@"%@", [result objectForKey:@"code"]];
    if ([success isEqualToString:@"200"]) {NSLog(@"初始化成功");}}];

预取号接口

应用调用预取号接口校验应用签名，校验成功后接口会返回运营商类型和状态信息，回调成功后进行调起授权页面操作。

-(void)preLogin:(double)timeout isCompletion:(void(^)(NSDictionary *_Nonnull result))completion

参数定义

参数名称	含义
timeout	超时时间，单位秒
completion	预取号结果回调

成功响应

参数名称	类型	含义
resultCode	NSString	0
resultMsg	NSString	获取accessCode成功
operatorType	NSString	运营商类型

代码示例

[[AbilityLoginManage instance] preLogin:8 isCompletion:^(NSDictionary * _Nonnull result) {
        if ([result[@"resultCode"] isEqualToString:@"0"]) {
            NSLog(@"初始化成功");}}];

调取授权页接口

应用调用该方法会拉起用户授权页面，当用户点击确认授权后接口会返回运营商类型和token;用户授权页支持部分页面样式自定义，开发者可以通过实例化 ClickLogConfig 类，设置响应的参数调整页面样式。

-(void)loginToken:(nonnull UIViewController *)controller clickConfig:(nonnull ClickLogConfig *)config getTokenTimeout:(double)timeout isCompletion:(void(^)(NSDictionary *_Nonnull result))completion

参数定义

参数名称	含义
controller	当前页面
config	ClickLogConfig实例，自定义授权页
timeout	超时时间（单位：秒）
completion	授权页结果回调

成功响应

参数名称	类型	含义
resultCode	NSString	0
resultMsg	NSString	登录成功
operatorType	NSString	运营商类型
encrypt	NSString	返回登录加密串

代码示例

[[AbilityLoginManage instance] loginToken:self clickConfig:config getTokenTimeout:8 isCompletion:^(NSDictionary * _Nonnull result) {
     NSLog(@"~ %@" ,result);
     //请求客户服务器取号代码
}];

点击其它登录方式

当用户在授权页面点击其他登录方式后，sdk 回调该方法。

-(void)otherLogclick;

代码示例：

[AbilityLoginManage instance].delegate = self; //添加代理abilityManageDelegate-( void )otherLogclick{NSLog(@"点击了其他登录方式");}

点击关闭授权页按钮回调

添加代理参考上一步。

-(void) closeButtonClick

点击授权登录未同意隐私协议回调

-(void)uncheckPrivacy;

代码示例

-( void )uncheckPrivacy{[WHToast showMessage:@"自定义-请同意服务条款" originY: self .view.frame.size.height-100.0 duration:1 finishHandler: nil ];}

点击隐私协议勾选框回调

-(void)privacyAgreementBoxStatus:( BOOL )boxStatuss；

开启二次弹窗后，未勾选隐私协议时点击登录按钮的回调

-(void)secondPUPUPAbilityLogclick:(NSDictionary *)privacyAndUrl;

注意
用户可在此回调中自定义二次弹窗视图

点击登录按钮回调

-(void)abilityLogclick;


                    注意
                    用户可在此回调中自定义加载动画。

授权页关闭完成回调

-(void)closeAuthViewControllerCompleted;

二次弹窗获取token，仅在开启二次弹窗后生效

-(void)secondPUPUPGetToken:(BOOL)status;

获取手机号能力

详见服务端接入。

本机号码校验

-(void)verificationPhoneNumber:(NSString *)phoneNumber verificatTimeout:(double)timeout isCompletion:(void(^)(NSDictionary *_Nonnull result))completion;

参数定义

参数名称	含义
phoneNumber	手机号
timeout	超时时间（单位：秒）
completion	授权页结果回调

成功响应

参数名称	类型	含义
resultCode	NSString	0
resultMsg	NSString	校验成功
operatorType	NSString	运营商类型
encrypt	NSString	返回校验加密串

代码示例

[[AbilityLoginManage instance] verificationPhoneNumber:_phoneTextStr verificatTimeout:8 isCompletion:^(NSDictionary * _Nonnull result) {
    NSLog(@"result%@", result);
    //请求客户服务器号码校验代码
}];

判断设备移动数据网络是否开启

-(BOOL)checkDeviceCellularDataEnable ;

控制台日志输出开关

-(void)setPrintLoggerEnable:(BOOL)enable；

获取sdk版本号

-(NSString *)getVersion ;

删除预取号信息

-(void)clearLoginCache;

获取运营商类型

-(NSString *)getOperatorType;

授权页面自定义UI参数

ClickLogConfig属性

#pragma mark VC属性

授权登录页面是否全屏，默认全屏no

@property (nonatomic,assign) BOOL logIsPopup;

#pragma mark 状态栏

状态栏样式

@property (nonatomic,assign) UIStatusBarStyle statusBarStyle;

#pragma mark 授权页导航栏

导航栏背景颜色

@property (nonatomic,strong) UIColor *navBackColor;

导航栏标题文本内容

@property (nonatomic,strong) NSString *navText;

导航栏标题字体大小

@property (nonatomic,assign) int navTextSize;

导航栏标题字体是否加粗

@property (nonatomic,assign) BOOL navFontBold;

导航栏标题字体样式

@property (nonatomic,copy) NSString *navTextStyle;

导航栏标题字体颜色

@property (nonatomic,strong) UIColor *navTextColor;

导航栏标题是否隐藏，默认隐藏

@property (nonatomic,assign) BOOL navIsHide;

返回按钮图片

@property (nonatomic,strong) UIImage *navReturnImg;

返回按钮图片上下位置

@property (nonatomic,assign) float navReturnOffsetX;

全屏时：按钮左侧距离屏幕左侧的偏移量弹框时：按钮左侧距离弹框右侧的偏移量

@property (nonatomic,assign) float navReturnOffsetY;

返回按钮图片宽高

@property ( nonatomic,assign) float navReturnWidth;@property (nonatomic,assign) float navReturnHeight;

返回按钮图片缩放类型

@property (nonatomic,assign) UIViewContentMode navReturnContentMode;

返回按钮是否隐藏

@property (nonatomic,assign) BOOL navReturnHide;

#pragma mark 隐私协议导航栏

进入隐私协议导航栏背景颜色，不设置则与授权页一致

@property (nonatomic,strong) UIColor *navPruvacyBackColor;

进入隐私协议导航栏标题字体大小，不设置则与授权页一致

@property (nonatomic,assign) int navPruvacyTextSize;

进入隐私协议导航栏标题字体颜色，不设置则与授权页一致

@property (nonatomic,strong) UIColor *navPruvacyTextColor;

进入隐私协议导航栏返回图片，不设置则与授权页一致

@property (nonatomic,strong) UIImage *navPruvacyReturnImg;

#pragma mark LOGO

LOGO图片

@property (nonatomic,strong  UIImage *logoImg;

LOGO的上下左右位置

@property (nonatomic,assign) float logoOffsetX;@property (nonatomic,assign) float logoOffsetY;

LOGO的宽高

@property (nonatomic,assign) float logoWidth;@property (nonatomic,assign) float logoHeight;

LOGO是否隐藏

@property (nonatomic,assign) BOOL logoIsHiddle;

LOGO图片缩放类型

@property (nonatomic,assign) UIViewContentMode logoContentMode;

#pragma mark 手机掩码

手机号码字体颜色

@property (nonatomic,strong) UIColor *numberColor;

手机号码字体大小

@property (nonatomic,assign) int numberTextSize;

手机号码字体加粗，默认不加粗

@property (nonatomic,assign) int numberTextBold;

手机号码MidX距离视图MidX轴的偏移 *注意不要超出屏幕，超出屏幕移动会错位

@property (nonatomic,assign) float numFieldOffsetX;

手机号码Y轴距离顶部偏移

@property (nonatomic,assign) float numFieldOffsetY;

手机号码文本字体样式，设置后字体加粗属性失效

@property (nonatomic,strong) NSString *numberTextStyle;

设置手机号码框的高度，暂不支持

#pragma mark 认证品牌

认证品牌字体大小

@property (nonatomic,assign) int brandLabelTextSize;

认证品牌字体颜色

@property (nonatomic,strong) UIColor *brandLabelTextColor;

认证品牌X轴距离屏幕左侧的偏移

@property (nonatomic,assign) float brandLabelOffsetX;

认证品牌Y轴距离顶部偏移

@property (nonatomic,assign) float brandLabelOffsetY;

认证品牌是否加粗

@property (nonatomic,assign) BOOL brandFontBold;

认证品牌文本字体样式，设置后字体加粗属性失效

@property (nonatomic,strong) NSString *brandTextStyle;

认证品牌文本自定义数组，固定顺序：移动，联通，电信

@property (nonatomic,strong) NSArray *brandTextArray;

#pragma mark 登录按钮

登录按钮文本内容

@property (nonatomic,strong) NSString *logBtnText;

登录按钮字体大小

@property (nonatomic,assign) int logBtnTextSize;

登录按钮文本颜色

@property (nonatomic,strong) UIColor *logBtnTextColor;

登录按钮的左右边距注意:按钮呈现的宽度在竖屏时必须大于屏幕的一半,横屏时必须大于屏幕的三分之一,默认左右是20

@property (nonatomic,assign) CGFloat logBtnOriginL;@property (nonatomic,assign) CGFloat logBtnOriginR;

登录按钮高注意：必须大于40

@property (nonatomic,assign) float logBtnHeight;

登录按钮Y轴位置

@property (nonatomic,assign) float logBtnOffsetY;

登录按钮背景图片数组

@property (nonatomic,strong) NSArray *logBtnImgs;

登录按钮字体是否加粗

@property (nonatomic,assign) BOOL logBtnFontBold;

登录按钮文本字体样式，设置后字体加粗属性失效

@property (nonatomic,strong) NSString *logBtnTextStyle;

#pragma mark 其他登录按钮

其他登录方式是否隐藏

@property (nonatomic,assign) BOOL otherWayLogBtnHidden;

其他登录方式文本内容

@property (nonatomic,strong) NSString *otherWayLogBtnText;

其他登录方式字体颜色

@property (nonatomic,strong) UIColor *otherWayLogBtnTextColor;

其他登录方式文本字体样式，默认 Helvetica

@property (nonatomic,strong) NSString *otherWayLogBtnTextStyle;

其他登录方式字体大小

@property (nonatomic,assign) int otherWayLogBtnTextSize;

其他登录方式上下左右位置

@property (nonatomic,assign) float otherWayLogBtnOffsetX;@property ( nonatomic , assign ) float otherWayLogBtnOffsetY;

其他登录方式宽高

@property (nonatomic,assign) float otherWayLogBtnOffWidth;@property ( nonatomic , assign ) float otherWayLogBtnOffHeight;

#pragma mark 隐私协议

勾选框未勾选图片

@property (nonatomic,strong) UIImage *uncheckedImg;

勾选框已勾选图片

@property (nonatomic,strong) UIImage *checkedImg;

勾选框是否勾选

@property (nonatomic,assign) BOOL checkedStatus;

勾选框宽高

@property (nonatomic,assign) float checkedWH;

隐私条款上左右边距

@property (nonatomic,assign) float pruvacyOffsetL;
@property (nonatomic,assign) float pruvacyOffsetR;

隐私条款顶部距离屏幕顶部偏移量，注意：若设置值超出屏幕边界会错位显示

@property (nonatomic,assign) float pruvacyOffsetY;

隐私条款字体大小

@property (nonatomic,assign) int pruvacyTextSize;

隐私条款最前面的文字

@property (nonatomic,strong) NSString *pruvacyBeforText;

第二个协议和第三个协议之间连接文字

@property (nonatomic,strong) NSString *pruvacyLinksText;

隐私条款最后面的文字

@property (nonatomic,strong) NSString *pruvacyAfterText;

自定义隐私条款标题和url数组

@property (nonatomic,strong) NSArray *pruvacyTitleAndUrlArr;

运营商默认隐私协议显示位置，第一个或最后一个

@property (nonatomic,assign) DefaultPruvacyPosition defaultPruvacyPosition;

隐私条款正常文字颜色

@property (nonatomic,strong) UIColor *norTruvacyTextColor;

隐私条款协议文字颜色

@property (nonatomic,strong) UIColor *pruTruvacyTextColor;

运营商隐私条款是否带书名号，默认不带书名号

@property (nonatomic,assign) BOOL pruvacyBookMark;

运营商隐私条款行距

@property (nonatomic,assign) float pruvacyLineSpacing;

运营商隐私条款文本对齐方式

@property (nonatomic,assign) NSTextAlignment pruvacyAlignment;

运营商隐私条款文本字体样式，设置后字体加粗属性失效

@property (nonatomic,strong) NSString *pruvacyTextStyle;

运营商隐私条款文本加粗

@property (nonatomic,assign) BOOL pruvacyFontBold;

#pragma mark 授权页面

授权页弹出和消失方向（仅支持全屏授权页）

@property (nonatomic,assign) PresentDismissDirection presentDismissDirection;

背景颜色

@property (nonatomic,strong) UIColor *backgroundColor;

背景图片

@property (nonatomic,strong) UIImage *backgroundImage;

#pragma mark 弹窗授权页

弹窗的宽高比例，底部弹窗时popupScaleW设置无效

@property (nonatomic,assign) float popupScaleW;
@property (nonatomic,assign) float popupScaleH;

弹窗的圆角，底部弹窗时只对弹窗左上角和右上角生效

@property (nonatomic,assign) float popupCornerRadius;

是否底部弹窗，true 底部弹窗，false 居中弹窗

@property (nonatomic,assign) BOOL isBottom;

弹窗授权页背景透明度，仅支持居中弹窗

@property (nonatomic,assign) float popupAlpha;

弹框授权页上下左右位置，暂不支持

#pragma mark 全屏页二次弹窗，仅在全屏时可用

全屏页面是否开启自定义二次弹窗

@property (nonatomic,assign) BOOL secondPOPUP;

#pragma mark 自定义控件

typedef  void (^myCustomUIHandler)(UIView *customAreaView);

添加自定义控件的，三方入口

@property (nullable ,nonatomic ,copy) myCustomUIHandler customUIHandler;

#pragma mark - 多语言配置（0-简体中文 1-繁体中文 2-英文）

@property (nonatomic, assign) int abilityLanguageType;

应用商城

合作伙伴

开发者

支持与服务

了解天翼云

查看所有产品

一键登录（文档停止维护）

一键登录（文档停止维护）

iOS SDK接入指南

注意事项

iOS SDK使用方法

环境配置

初始化接口

预取号接口

调取授权页接口

点击其它登录方式

点击关闭授权页按钮回调

点击授权登录未同意隐私协议回调

点击隐私协议勾选框回调

开启二次弹窗后，未勾选隐私协议时点击登录按钮的回调

点击登录按钮回调

授权页关闭完成回调

二次弹窗获取token，仅在开启二次弹窗后生效

获取手机号能力

本机号码校验

判断设备移动数据网络是否开启

控制台日志输出开关

获取sdk版本号

删除预取号信息

获取运营商类型

授权页面自定义UI参数

活动

应用商城

合作伙伴

开发者

支持与服务

了解天翼云

查看所有产品

一键登录（文档停止维护）

一键登录（文档停止维护）

iOS SDK接入指南

注意事项

iOS SDK使用方法

环境配置

初始化接口

预取号接口

调取授权页接口

点击其它登录方式

点击关闭授权页按钮回调

点击授权登录未同意隐私协议回调

点击隐私协议勾选框回调

开启二次弹窗后，未勾选隐私协议时点击登录按钮的回调

点击登录按钮回调

授权页关闭完成回调

二次弹窗获取token，仅在开启二次弹窗后生效

获取手机号能力

本机号码校验

判断设备移动数据网络是否开启

控制台日志输出开关

获取sdk版本号

删除预取号信息

获取运营商类型

授权页面自定义UI参数