Method

GT3GeetestUtilsBind(Context)

获取管理类GT3GeetestUtilsBind的实例对象

Declaration

public GT3GeetestUtilsBind(Context context)

Parameters

Param Type Description
context Context 上下文

getGeetest(Context,String,String,String,GT3GeetestBindListener)

开启验证码

Declaration

public void getGeetest(final Context context, String api1, String api2, String lang, GT3GeetestBindListener listener)

Parameters

Param Type Description
context Context 上下文
api1 String 客户后台服务器配置,用来获取gt,challenge参数的api接口
api2 String 客户后台服务器配置,用于二次验证的api接口
lang String 验证码语言,默认传null跟随系统语言
listener GT3GeetestBindListener 验证码外部接口实例

gt3Dismiss()

关闭正在运行的Dialog

Declaration

public void gt3Dismiss()

gt3TestFinish()

弹出验证成功的弹框

Declaration

public void gt3TestFinish()

Discussion

该方法在拿到二次验证结果后,如果验证结果中status字段为success则调用该方法

gt3TestClose()

弹出验证失败的弹框

Declaration

public void gt3TestClose()

Discussion

该方法在拿到二次验证结果后,如果验证结果中status字段为fail则调用该方法

getVersion()

获取当前SDK的版本号

Declaration

public String getVersion()

Return Value

返回版本号,类型为String

setTimeout(int)

设置加载验证码的webview的超时时间,默认10秒

Declaration

public void setTimeout(int time)

Parameters

Param Type Description
time int 毫秒数 如:15000

cancelUtils()

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

Declaration

public void cancelUtils()

Discussion

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

showLoadingDialog(Context, String)

弹出极验加载框

Declaration

public void showLoadingDialog(Context context, String lang)

Parameters

Param Type Description
context Context 上下文
lang String 验证码语言,默认传null跟随系统语言

Discussion

该方法很少用到,仅用于自定义api1时考虑使用

gtSetApi1Json(JSONObject)

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

Declaration

public void gtSetApi1Json(JSONObject json)

Parameters

Param Type Description
json JSONObject 客户请求api1返回的的数据

Discussion

该方法用于自定义api1时必定使用,注意参数json格式:

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

以上successchallengegtnew_captcha这4个参数为必须参数,客户可以添加新参数,但是不能删减,以免导致无法加载验证码

setDialogTouch(boolean)

设置点击弹出框周围,弹出框是否消失

Declaration

public void setDialogTouch(boolean bol)

Parameters

Param Type Description
bol boolean true 是 false 否

Discussion

该方法比较常用,建议设置成false

cancelAllTask()

关闭所有异步加载

Declaration

public void cancelAllTask()

Listener

gt3DialogReady()

监听弹框是否正常弹出

Declaration

public void gt3DialogReady()

Discussion

验证码正常弹出会进该接口 反之不进

gt3CloseDialog(int)

用于监听弹框消失

Declaration

public void gt3CloseDialog(int  num)

Parameters

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

gt3FirstResult(JSONObject)

用于获取客户api1返回的数据

Declaration

public void gt3FirstResult(JSONObject jsonObject)

Parameters

Param Type Description
jsonObject JSONObject 客户api1返回的数据

gt3GetDialogResult(String)

用于获取客户api2返回的数据

Declaration

public void gt3GetDialogResult(String result)

Parameters

Param Type Description
result String 客户api2返回的数据

gt3GetDialogResult(boolean, String)

用于获取客户api2返回的数据

Declaration

public void gt3GetDialogResult(boolean stu, String result)

Parameters

Param Type Description
result String 客户api2返回的数据
stu boolean 判断是否获取到返回值 true:有 false:没有

Discussion

该方法用于自定义api1时使用,当stu为true,result会携带二次验证需要的三个参数geetest_challenge,geetest_validate,geetest_seccode,以上三个参数为必传参数,客户可以自行添加数据但不得删减,提交这些从参数到api2服务器即可

gt3DialogSuccessResult(String)

用户操作验证码后的结果数据

Declaration

public void gt3DialogSuccessResult(String result)

Parameters

Param Type Description
result String 用户操作验证码后的结果数据

gt3DialogOnError(String)

用户操作验证码后的结果数据

Declaration

public void gt3DialogOnError(String error)

Parameters

Param Type Description
error String 用户操作验证码后的结果数据

Seealso

错误码清单

gt3SetIsCustom()

用户是否使用自定义二次验证

Declaration

public boolean gt3SetIsCustom()

Discussion
使用自定义二次验证必须设置的接口

Return Value

返回给gt3geetestutils告知使用自定义二次验证, 类型为boolean true:是 false:不是(默认)

gt3CaptchaApi1()

用于往api1里面添加提交参数

Declaration

public Map<String, String> gt3CaptchaApi1()

Discussion

在不自定义api1的情况下,客户想往api1里面添加提交参数可以使用该方法,该方法为get提交

Return Value

返回给gt3geetestutils用于提交api1的参数, 类型为Map<String, String>

gt3SecondResult()

用于往api2里面添加提交参数

Declaration

public Map<String, String> gt3SecondResult()

Discussion

在不自定义api2的情况下,客户想往api2里面添加提交参数可以使用该方法,该方法为post提交

Return Value

返回给gt3geetestutils用于提交api2的参数, 类型为Map<String, String>

GT3GeetestUtils

GTTestButton的主要外部调用接口(button模式)

Method

GT3GeetestUtils.getInstance(Context)

获取管理类GT3GeetestUtils的实例对象

Declaration

public GT3GeetestUtils.getInstance(Context context)

Parameters

Param Type Description
context Context 上下文

getGeetest(final Context, String, String, String, GT3GeetestListener)

开启验证码

Declaration

public void getGeetest(final Context context,String api1,String api2,String lang,GT3GeetestListener listener)

Parameters

Param Type Description
context Context 上下文
api1 String 客户后台服务器配置,用来获取gt,challenge参数的api接口
api2 String 客户后台服务器配置,用于二次验证的api接口
lang String 验证码语言,默认传null跟随系统语言
listener GT3GeetestBindListener 验证码外部接口实例

gt3Dismiss()

关闭正在运行的Dialog

Declaration

public void gt3Dismiss()

gt3TestFinish()

弹出验证成功的弹框

Declaration

public void gt3TestFinish()

Discussion

该方法在拿到二次验证结果后,如果验证结果中status字段为success则调用该方法

gt3CloseButton()

弹出验证失败的弹框

Declaration

public void gt3CloseButton()

Discussion

该方法在拿到二次验证结果后,如果验证结果中status字段为fail则调用该方法

getVersion()

获取当前SDK的版本号

Declaration

public String getVersion()

Return Value

返回版本号,类型为String

setTimeout(int)

设置加载验证码的webview的超时时间,默认10秒

Declaration

public void setTimeout(int time)

Parameters

Param Type Description
time int 毫秒数 如:15000

cancelUtils()

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

Declaration

public void cancelUtils()

Discussion

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

getISonto()

调用该方法提示SDK使用自定义api1模式

Declaration

public void getISonto()

Discussion

该方法在客户使用自定义api1时调用,且必须是在onCreate生命周期中调用

gtSetApi1Json(JSONObject)

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

Declaration

public void gtSetApi1Json(JSONObject json)

Parameters

Param Type Description
json JSONObject 客户请求api1返回的的数据

Discussion

该方法用于自定义api1时必定使用,注意参数json格式:

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

以上successchallengegtnew_captcha这4个参数为必须参数,客户可以添加新参数,但是不能删减,以免导致无法加载验证码

setDialogTouch(boolean)

设置点击弹出框周围,弹出框是否消失

Declaration

public void setDialogTouch(boolean bol)

Parameters

Param Type Description
bol boolean true 是/false 否

Discussion

该方法比较常用,建议设置成false

cancelAllTask()

关闭所有异步加载

Declaration

public void cancelAllTask()

Listener

gt3DialogReady()

监听弹框是否正常弹出

Declaration

public void gt3DialogReady()

Discussion

验证码正常弹出会进该接口 反之不进

gt3CloseDialog(int)

用于监听弹框消失

Declaration

public void gt3CloseDialog(int  num)

Parameters

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

gt3FirstResult(JSONObject)

用于获取客户api1返回的数据

Declaration

public void gt3FirstResult(JSONObject jsonObject)

Parameters

Param Type Description
jsonObject JSONObject 客户api1返回的数据

gt3GetDialogResult(String)

用于获取客户api2返回的数据

Declaration

public void gt3GetDialogResult(String result)

Parameters

Param Type Description
result String 客户api2返回的数据

gt3GetDialogResult(boolean, String)

用于获取客户api2返回的数据

Declaration

public void gt3GetDialogResult(boolean status, String result)

Parameters

Param Type Description
status boolean 判断是否获取到返回值 true:有 false:没有
result String 客户api2返回的数据

Discussion

该方法用于自定义api1时使用,当stu为true,result会携带二次验证需要的三个参数geetest_challengegeetest_validategeetest_seccode,以上三个参数为必传参数,客户可以自行添加数据但不得删减,提交这些从参数到api2服务器即可

gt3DialogSuccessResult(String)

用户操作验证码后的结果数据

Declaration

public void gt3DialogSuccessResult(String result)

Parameters

Param Type Description
result String 用户操作验证码后的结果数据

gt3DialogOnError(String)

用户操作验证码后的结果数据

Declaration

public void gt3DialogOnError(String error)

Parameters

Param Type Description
error String 用户操作验证码后的结果数据

Seealso

错误码清单

gt3SetIsCustom()

用户是否使用自定义二次验证

Declaration

public boolean gt3SetIsCustom()

Discussion
使用自定义二次验证必须设置的接口

Return Value

返回给gt3geetestutils告知使用自定义二次验证, 类型为boolean true:是 false:不是(默认)

gt3CaptchaApi1()

用于往api1里面添加提交参数

Declaration

public Map<String, String> gt3CaptchaApi1()

Discussion

在不自定义api1的情况下,客户想往api1里面添加提交参数可以使用该方法,该方法为get提交

Return Value

返回给gt3geetestutils用于提交api1的参数, 类型为Map<String, String>

gt3SecondResult()

用于往api2里面添加提交参数

Declaration

public Map<String, String> gt3SecondResult()

Discussion

在不自定义api2的情况下,客户想往api2里面添加提交参数可以使用该方法,该方法为post提交

Return Value

返回给gt3geetestutils用于提交api2的参数, 类型为Map<String, String>

gtOnClick(boolean)

用于判断自定义button是否被点击

Declaration

public void gtOnClick(boolean onclick)

Parameters

Type Description
boolean true 表示button被点击

Discussion

用于监听button按键是否被点击