> >

Sensebot harmonyOS API Document

GT3GeetestUtils

Sensebot的主要外部调用接口

Method

GT3GeetestUtils(UIContext,GT3ConfigBean)

管理类GT3GeetestUtils构造方法

Declaration

public GT3GeetestUtils(context: UIContext, bean: GT3ConfigBean)

Parameters

Param	Type	Description
context	UIContext	上下文
bean	GT3ConfigBean	配置bean

init()

初始化

Declaration

public init()

startCustomFlow()

开启验证

Declaration

public startCustomFlow()

getGeetest()

继续验证

Declaration

public getGeetest()

dismissGeetestDialog()

关闭正在运行的Dialog

Declaration

public dismissGeetestDialog()

showSuccessDialog()

弹出验证成功的弹框

Declaration

public showSuccessDialog()

Discussion

该方法在拿到二次验证结果后，如果验证成功则调用该方法

showFailedDialog()

弹出验证失败的弹框

Declaration

public showFailedDialog()

Discussion

该方法在拿到二次验证结果后，如果验证失败则调用该方法

getVersion()

获取当前SDK的版本号

Declaration

public static getVersion(): string

Return Value

返回版本号，类型为string

destory()

用于释放上下文以及各种资源

Declaration

public destory()

Discussion

该方法在客户使用的验证码界面的onDestroy生命周期中调用

changeDialogLayout()

横竖屏切换

Declaration

public changeDialogLayout()

Discussion

该方法在横竖屏切换生命周期windowSizeChange中调用

GT3ConfigBean

配置类

Method

GT3ConfigBean(GT3Listener)

管理类GT3ConfigBean构造方法

Declaration

public GT3ConfigBean(listener: GT3Listener)

Parameters

Param	Type	Description
listener	GT3Listener	监听类

setApi1Json(Record<string, Object>)

获取客户请求api1返回的的数据

Declaration

public setApi1Json(api1Json: Record<string, Object>)

Parameters

Param	Type	Description
json	Record<string, Object>	客户请求api1返回的的数据

Discussion

该方法用于设置api1获取数据，注意参数json格式：

{
	"success" : 1,
	"challenge" : "4a5cef77243baa51b2090f7258bf1368",
	"gt" : "019924a82c70bb123aae90d483087f94"
}

以上success，challenge，gt这3个参数为必须参数，客户可以添加新参数，但是不能删减，以免导致无法加载验证码

setTimeout(number)

设置加载webview超时时间，单位毫秒，默认10000

Declaration

public setTimeout(timeout: number)

Parameters

Param	Type	Description
time	number	毫秒数如:10000

setWebviewTimeout(number)

设置webview请求超时时间，单位毫秒，默认10000

Declaration

public setWebviewTimeout(time:number)

Parameters

Param	Type	Description
time	number	毫秒数如:10000

setLang(string)

设置语言，默认支持11种

Declaration

public setLang(lang:string)

Parameters

Param	Type	Description
lang	string	“zh”–简体中文, “zh-tw”–繁体中文, “zh-hk”–繁体中文, “en”–英语, “id”–印尼语, “ja”–日语, “ko”–韩语, “ru”–俄语, “ar”–阿拉伯语, “es”–西班牙语, “pt-pt”–葡萄牙语, “fr”–法语, “de”–德语, “th”–泰语, “tr”–土耳其语, “vi”–越南语, “ta”–泰米尔语, “it”–意大利语, “bn”–孟加拉语, “mr”–马拉地语。如果为null或者未设置，则使用系统默认语言；

setCanceledOnTouchOutside(boolean)

设置点击灰色区域是否消失，默认不消失

Declaration

public setCanceledOnTouchOutside(cancel:boolean)

Parameters

Param	Type	Description
cancel	boolean	true为消失

setUnCanceledOnTouchKeyCodeBack(boolean)

设置点击 back 返回键弹框是否消失，默认消失

Declaration

public setUnCanceledOnTouchKeyCodeBack(cancel:boolean)

Parameters

Param	Type	Description
cancel	boolean	true为不消失，false为消失

setGt3ServiceNode(GT3ServiceNode)

设置验证服务集群节点，默认为中国节点，使用其他节点需要相应配置，否则无法使用验证

Declaration

public setGt3ServiceNode(gt3ServiceNode:GT3ServiceNode)

Parameters

Param	Type	Description
gt3ServiceNode	GT3ServiceNode	为 enum 类型，可选择 NODE_CHINA 或 NODE_NORTH_AMERICA

setGTViewWithParams(Map<string,string>)

设置前端参数

Declaration

public setGTViewWithParams(map:Map<string,string>)

Parameters

Param	Type	Description
map	Map<string,string>	以map格式传入，SDK 解析为表单格式拼接在请求地址中

setReleaseLog(boolean)

设置是否关闭写日志功能，默认为 true

Declaration

public setReleaseLog(release:boolean)

Parameters

Param	Type	Description
release	boolean	true为验证码加载日志，默认为 fasle

GT3Listener

回调监听类

onDialogReady()

验证码加载完成

Declaration

onDialogReady: (duration: string) => void;

Parameters

Param	Type	Description
duration	string	加载时间和版本等信息，为json格式

onReceiveCaptchaCode()

图形验证结果回调

Declaration

onReceiveCaptchaCode: (code: number) => void;

Parameters

Param	Type	Description
code	number	1为正常 0为失败

onClosed(number)

验证码被关闭

Declaration

onClosed: (num: number) => void;

Parameters

Param	Type	Description
num	number	1 点击验证码的关闭按钮来关闭验证码, 2 点击屏幕关闭验证码, 3 点击返回键关闭验证码

onDialogResult(string)

验证结果回调

Declaration

onDialogResult: (result: string) => void;

Parameters

Param	Type	Description
result	string	验证结果

Discussion

二次验证需要的三个参数geetest_challenge，geetest_validate，geetest_seccode，以上三个参数为必传参数，客户可以自行添加数据但不得删减

onSuccess(string)

验证成功回调

Declaration

onSuccess: (result: string) => void;

Parameters

Param	Type	Description
result	string	验证成功回调数据

onFailed(GT3ErrorBean)

验证失败回调

Declaration

onFailed: (errorBean: GT3ErrorBean) => void;

Parameters

Param	Type	Description
errorBean	GT3ErrorBean	验证失败回调数据

Discussion

验证错误码后面详细说明

onButtonClick()

button被点击，验证开始

Declaration

onButtonClick: () => void;

Discussion

用于监听button按键被点击