iOS

产品依赖DeepKnowSDK.framwork,部署前请引入deepknow相关服务,请参考[深知部署文档]。

Protocol

SenseBotDelegate

SenseBot相关操作, 操作验证过程中的请求行为

senseBot:didReceiveResponse:withError:

处理SenseBot校验结果

Declaration

- (void)senseBot:(SenseBot *)senseBot didReceiveResponse:(SEResponse *)response withError:(SEError *)error;

Parameters

Param Description
response 验证结果
error 错误描述对象

Parameters

Param Description
senseBot 验证管理器

senseBotUserDidClose:

用户关闭了验证

Declaration

- (void)senseBotUserDidClose:(SenseBot *)senseBot;

Parameters

Param Description
senseBot 验证管理器

SenseBotViewDelegate

senseBotWillShow:

验证加载完成, 即将弹出

Declaration

- (void)senseBotWillShow:(SenseBot *)senseBot;

Parameters

Param Description
senseBot 验证管理器

SenseBot

SenseBot的外部调用接口及属性

Enum

SELanguageType

图形验证的语言选项

Declaration

typedef NS_ENUM(NSInteger, SELanguageType) {
/** Simplified Chinese */
SELANGTYPE_ZH_CN = 0,
/** Traditional Chinese */
SELANGTYPE_ZH_TW,
/** Traditional Chinese */
SELANGTYPE_ZH_HK,
/** Korean */
SELANGTYPE_KO_KR,// 暂不支持
/** Japenese */
SELANGTYPE_JA_JP,
/** English */
SELANGTYPE_EN_US,
/** Indonesian */
SELANGTYPE_ID,
/** System language*/
SELANGTYPE_AUTO
};

Property

delegate

SenseBot生命周期代理

Declaration

@property (nonatomic, weak) id<SenseBotDelegate> delegate;

viewDelegate

SenseBot视图相关的代理

Declaration

@property (nonatomic, weak) id<SenseBotViewDelegate> viewDelegate;

maskColor

背景遮罩的颜色

Declaration

@property (nonatomic, strong) UIColor *maskColor;

Method

showWithIntent:animated:

调起通过一个SEIntent调起一次验证

Declaration

- (void)showWithIntent:(SEIntent *)intent animated:(BOOL)animated;

Parameters

Param Description
intent 调起验证的数据对象
animated 是否使用动画

close

关闭验证视图, 同时取消验证回话

Declaration

- (void)close;

useSenseBotWithLanguage:

设置语言选项, 默认跟随系统

Declaration

- (void)useSenseBotWithLanguage:(SELanguageType)langOption;

Parameters

Param Description
langOption 设置语言

Discussion

在开启验证之前调用此方法

useSenseBotWithTimeout:

设置超时时长, 默认15秒

Declaration

- (void)useSenseBotWithTimeout:(NSTimeInterval)timeout;

Parameters

Param Description
timeout 设置超时时长

Discussion

在开启验证之前调用此方法

useAnimatedAcitvityIndicator:withInitialSize:indicatorType:

配置状态指示器动画

Declaration

- (void)useAnimatedAcitvityIndicator:(SEIndicatorAnimationViewBlock)animationBlock
withInitialSize:(CGSize)size
indicatorType:(SEActivityIndicatorType)type;

Parameters

Param Description
animationBlock 动画执行的block
size 指示器的尺寸
type 指示器类型, 只有当为SEIndicatorTypeCustom, 参数animationBlock, size生效

Discussion

在开启验证之前调用此方法

useVisualViewWithEffect:

使用背景虚化, 默认不开启

Declaration

- (void)useVisualViewWithEffect:(UIBlurEffect *)blurEffect;

Discussion

仅iOS8以上生效, 在开启验证之前调用此方法

disableBackgroundUserInteraction:

禁止背景交互, 默认不禁止

Declaration

- (void)disableBackgroundUserInteraction:(BOOL)disable;

Parameters

Param Description
disable YES忽略交互事件/NO接受交互事件

Discussion

在开启验证之前调用此方法

enableDebugMode:

开启debug模式, 默认不开启

Declaration

- (void)enableDebugMode:(BOOL)enable;

Parameters

Param Description
enable YES开启,NO关闭

Discussion

开启debugMode,在开启验证之前调用此方法

SEUtils

SEActivityIndicatorType

指示器类型

typedef NS_ENUM(NSInteger, SEActivityIndicatorType) {
/** Geetest Defualt Indicator Type */
SEIndicatorTypeDefault = 0,
/** System Indicator Type */
SEIndicatorTypeSystem,
/** Custom Indicator Type */
SEIndicatorTypeCustom
};

SEIndicatorAnimationViewBlock

自定义的状态指示器动画回调

typedef void(^SEIndicatorAnimationViewBlock)(CALayer *layer, CGSize size, UIColor *color);

Parameters

Param Description
layer 画布图层对象
size 图层大小
color 颜色