工具類接口

獲取AlicomCaptcha4Client工具類對象

非單例實現(xiàn)，通過getClient()獲取的AlicomCaptcha4Client對象需要保存，以方便在onDestory或其他生命周期使用。

public static AlicomCaptcha4Client getClient(Context context)

使用默認(rèn)配置初始化

調(diào)用init()方法后執(zhí)行了加載驗證碼操作，若在onResume()生命周期之前調(diào)用，就會預(yù)加載驗證碼；當(dāng)執(zhí)行verifyWithCaptcha()展示驗證碼時，就會展示驗證碼。

public AlicomCaptcha4Client init(String captchaId)

使用自定義配置初始化

public AlicomCaptcha4Client init(String captchaId, AlicomCaptcha4Config config)

添加驗證結(jié)果監(jiān)聽的對象

添加驗證結(jié)果監(jiān)聽的對象，當(dāng)驗證碼加載成功，用戶解答驗證碼結(jié)果回調(diào)。

public AlicomCaptcha AlicomCaptcha4Client
addOnSuccessListener(AlicomCaptcha4Client.OnSuccessListener response)

public AlicomCaptcha4Client
addOnWebViewShowListener(AlicomCaptcha4Client.OnWebViewShowListener listener)

public AlicomCaptcha AlicomCaptcha4Client
addOnFailureListener(AlicomCaptcha4Client.OnFailureListener listener)

開啟驗證流程

開啟驗證流程，加載驗證碼。調(diào)用verifyWithCaptcha()之前需要先調(diào)用init()、addOnSuccessListener()、addOnFailureListener否則可能報錯。

public AlicomCaptcha AlicomCaptcha4Client verifyWithCaptcha()

取消驗證

取消驗證，關(guān)閉驗證窗口。調(diào)用verifyWithCaptcha()之前需要先調(diào)用init()、addOnSuccessListener()、addOnFailureListener否則可能報錯。

public void cancel()

設(shè)置開啟/關(guān)閉打印日志監(jiān)控

public void setLogEnable(boolean enable)

銷毀生命周期長的資源

該方法在用戶使用的驗證碼界面的onDestroy生命周期中調(diào)用。

public AlicomCaptcha void destroy()

獲取版本號

返回的版本號，類型為String。

public static String getVersion()

檢測是否支持系統(tǒng)WebView

public static Pair<Boolean, String> isSupportWebView(Context context)

參數(shù)配置類接口

設(shè)置請求超時時間

public AlicomCaptcha Builder setTimeOut(int timeOut)

設(shè)置WebView加載資源地址

默認(rèn)加載assets目錄的gt4-index*.html文件，沒有特殊需求無需設(shè)置此接口。

public AlicomCaptcha Builder setResourcePath(String html)

控制加載WebView語言

傳輸JS的設(shè)置語言，此接口僅控制加載WebView的語言， SDK的多語言跟隨當(dāng)前應(yīng)用。如果設(shè)置為null或未設(shè)置，則使用應(yīng)用默認(rèn)語言短碼傳輸給前端。

public AlicomCaptcha Builder setLanguage(String language)

支持的語言及其語言短碼如下：

設(shè)置點擊灰色區(qū)域是否消失

public AlicomCaptcha Builder setCanceledOnTouchOutside(boolean canceledOnTouchOutside)

設(shè)置是否是debug模式

public AlicomCaptcha Builder setDebug(boolean debug)

設(shè)置WebView背景色

設(shè)置WebView背景色，控制的是Android WebView控件的背景色，和前端JS的背景色不同。

public AlicomCaptcha Builder setBackgroundColor(int backgroundColor)

設(shè)置驗證碼對話框的主題樣式

public Builder setDialogStyle(String dialogStyle)

默認(rèn)的主題樣式

<style name="gt4_captcha_dialog_style" parent="android:Theme.Dialog">
<!--Dialog的windowFrame框為無-->
<item name="android:windowFrame">@null</item>
<!--是否浮現(xiàn)在activity之上-->
<item name="android:windowIsFloating">true</item>
<!--是否半透明-->
<item name="android:windowIsTranslucent">true</item>
<!--除去title-->
<item name="android:windowNoTitle">true</item>
<item name="android:windowContentOverlay">@null</item>
<!--顯示區(qū)域以外是否使用黑色半透明背景-->
<item name="android:backgroundDimEnabled">true</item>
<!--設(shè)置dialog的背景-->
<item name="android:windowBackground">@android:color/transparent</item>
<item name="android:padding">0dp</item>
</style>

設(shè)置驗證窗口顯示的監(jiān)聽回調(diào)

public void setDialogShowListener(AlicomCaptcha4Client.OnDialogShowListener dialogShowListener)

額外參數(shù)配置

public Builder setParams(Map<String, Object> params)

支持的鍵值如下：

代碼示例

Map<String, Object> params = new HashMap<>();
params.put("displayMode", 0);
params.put("protocol", "https://");
params.put("bgColor", "#CC0000FF");
params.put("loading", "./loading_test.gif");
params.put("rem", 0.6);
JSONArray hideBar = new JSONArray()
         .put("close")
         .put("refresh");
params.put("hideBar", hideBar);
params.put("nextWidth", "300px");
params.put("hideSuccess", true);

AlicomCaptcha4Config.Builder builder = new AlicomCaptcha4Config.Builder()
        .setParams(params);

構(gòu)造AlicomCaptcha4Config對象

構(gòu)造AlicomCaptcha4Config對象，傳輸給init()接口使用。

public AlicomCaptcha AlicomCaptcha4Config build()

回調(diào)監(jiān)聽類接口

驗證接口回調(diào)

void onSuccess(Boolean status, String response)

驗證成功示例

{
  "lot_number":"b150e61198924eff9eaae121e9b67aa8",
  "pass_token":"6fcfba4c35cb57b873c99c5b3b02089c58a26244c18f7706aaa1e87aed3aa8f4",
  "gen_time":"1622020720",
  "captcha_output":"Tu6rW0dRNO0NLxMKftwdH00G5whF5HHddthoXSEA1G4="
}

驗證失敗示例

{
  "captchaId":"647f5ed2ed8acb4be36784e01556bb71",
  "captchaType":"slide",
  "challenge":"95ed53b4-95c6-4c6b-9aac-769b29ef74a0"
}

加載失敗回調(diào)

void onFailure(String error)

加載失敗示例

{
  "code":"-14460",
  "msg":"驗證會話已取消",
  "desc":
       {"description":"User cancelled'Captcha'"}
}

驗證前端加載成功

在驗證前端加載成功后回調(diào)。預(yù)加載已完成的情況下，調(diào)用verifyWithCaptcha后立即回調(diào)。

void onWebViewShow()

驗證窗口在顯示前回調(diào)

void actionBeforeDialogShow(Dialog dialog)

驗證窗口在顯示后回調(diào)

可在此處對系統(tǒng)樣式進(jìn)行改變，例如：隱藏導(dǎo)航欄、隱藏狀態(tài)欄等。

void actionAfterDialogShow(Dialog dialog)

驗證窗口在改變焦點時回調(diào)

void onDialogFocusChanged(Dialog dialog, boolean hasFocus)