iOS 客户端 API

最近更新时间:2019-02-27 17:17:57

概述

  • SDK 工具包目录结构说明:
    • TCWebCodesSDK.framework:包含 TCWebCodesSDK.framework。
    • TCWebCodesSDKDemo:示例工程,演示了如何使用 TCWebCodesSDK.framework。
  • 本 SDK 运行环境与项目要求:

接口说明

主要函数,设置验证结果的 callback 回调:

/**
 设置回调
 @note 成功/失败可以通过 resultJSON[@"ret"] 判断,0为成功,非0为失败
 @warning 为了避免引用,内部再回调完成后会重置回调为空,请记得每次都需要设置回调
 */
@property (nonatomic, copy) void (^callback)(NSDictionary *resultJSON, UIView *webView);

主要函数,通过腾讯云返回的验证码 URL 创建一个用于显示的 webView 控件:

/**
 开始加载H5
 @param url,业务服务器通过腾讯云拉取的验证码URL
 @param frame, webView控件大小
 @return 返回H5的webView控件
 @note 该函数用于开始加载,并且返回H5的webView控件,用于显示
 @warning 请不要设置返回webView控件的回调
 */
- (UIView*)startLoad:(NSString*)url webFrame:(CGRect)frame;

返回 TCWebCodesBridge 全局对象:

/**
返回单例
*/
+ (instancetype)sharedBridge;  

配置函数,设置是否显示 H5 页面的头部,默认不显示:

/**
设置是否显示H5的内部导航头部
*/
@property (nonatomic) BOOL showHeader;

可扩展函数,用于设置后续显示 H5 界面的一些样式:

/**
设置其余属性
@note 该接口是为了后续扩展
@warning 请设置value为基本类型: string, number
*/
- (void)setCapValue:(id)aValue forKey:(id<NSCopying>)aKey;