API reference

Get the AlicomCaptcha4Client utility class object

For non-singleton implementations, use getClient() to obtain an AlicomCaptcha4Client object and save it for use in a Page or other lifecycles.

public static getClient(context UIContext): AlicomCaptcha4Client

Initialize with a custom configuration

Initializes the client with a custom configuration.

public init(captchaId: string, config: AlicomCaptcha4Config): AlicomCaptcha4Client

Add a listener for verification results

Adds a listener object for verification results. The callback is invoked after the Captcha is loaded and the user completes the verification.

public addOnSuccessListener(response: OnSuccessListener): AlicomCaptcha4Client

Add a listener for Captcha loading failures

Adds a listener object for Captcha loading failures. This is triggered if an error occurs while the Captcha is loading.

public addOnFailureListener(listener: OnFailureListener): AlicomCaptcha4Client

Add a listener for successful frontend loading

Add a listener object to receive a callback after the verification frontend is successfully loaded. If preloading is complete, the callback is triggered immediately after you call verifyWithCaptcha.

public addOnWebViewShowListener(listener: OnWebViewShowListener): AlicomCaptcha4Client

Start the verification flow

Start the verification flow to load the Captcha. You must call init(), addOnSuccessListener(), and addOnFailureListener before you call verifyWithCaptcha(). Otherwise, an error may occur.

public verifyWithCaptcha(): AlicomCaptcha4Client

Cancel the verification

Cancels the validation and closes the validation window. Before you call verifyWithCaptcha(), you must first call init(), addOnSuccessListener(), and addOnFailureListener. Otherwise, an error may occur.

public cancel()

Enable or disable log printing for monitoring

public setLogEnable(enable: boolean): AlicomCaptcha4Client

Destroy long-lifecycle resources

Call this method during the destroy lifecycle of the Captcha interface that the user is using.

public void destroy()

Get the version number

Returns the version number. The type is String.

public static getVersion(): string

Set the request timeout period

setTimeOut(timeOut: number): AlicomCaptcha4Config

Set the resource address for WebView loading

setResourcePath(html: string): AlicomCaptcha4Config

Control the language of the loaded WebView

Specifies the language setting to pass to the JS. This interface controls only the language of the loaded webView. The SDK's multilingual support follows the language of the current application. If you do not set this parameter or set it to null, the default language short code of the application is sent to the frontend.

setLanguage(language: string): AlicomCaptcha4Config

The supported languages and their short codes are listed below.

Set whether the window disappears when the gray area is clicked

setIsCanceledOnTouchOutside(isCanceledOnTouchOutside: boolean): AlicomCaptcha4Config

Set whether to enable debug mode

Specifies whether to enable debug mode. When you publish the application, you must set this to false or leave it unconfigured.

setIsDebug(isDebug: boolean): AlicomCaptcha4Config

Set the WebView background color

Setting the webView background color controls the background color of the Harmony webView control, which is different from the background color of the frontend JS.

setBackgroundColor(backgroundColor: string): AlicomCaptcha4Config

Configure extra parameters - setParams(Map<string, Object>)

Additional parameter settings. These parameters are passed directly to the JS.

setParams(params: Map<string, Object>): AlicomCaptcha4Config

The supported key-value pairs are listed below.

Sample code:

let params = new Map<string, string>();
params.set("displayMode", 0);
params.set("protocol", "https://");
params.set("bgColor", "#CC0000FF");
...
let AlicomCaptcha4Config = new AlicomCaptcha4Config()
        .setParams(params);

Verification API callback

AlicomCaptcha4Client#OnSuccessListener: A callback listener class for verification results.

onSuccess: (status: boolean, response: string) => void;

Example of a successful verification:

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

Example of a failed verification:

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

Loading failure callback

AlicomCaptcha4Client#OnFailureListener: A callback listener class for load failures.

onFailure: (error: string) => void;

Example of a loading failure:

{
  "code":"-14460",
  "msg":"Verification session canceled",
  "desc":
       {"description":"User cancelled'Captcha'"}
}

Successful frontend loading

AlicomCaptcha4Client#OnWebViewShowListener: A listener class for the callback that is triggered when the frontend is loaded successfully.

This callback is invoked after the verification frontend is successfully loaded.

onWebViewShow: () => void;