cordova-plugin-hcaptcha

Cordova plugin for integrating the hCaptcha challenge Android SDK and web component API.

Platforms

• Android
• Browser

Installation

Plugin Versions

| Plugin version | Cordova | Cordova Android | hCaptcha | | --- | --- | --- | --- | | 1.0.0 | >= 10.0.0 | >= 10.0.0 | 4.0.0 |

Install latest version from NPM

  cordova plugin add cordova-plugin-hcaptcha

Install latest with custom SDK version

  cordova plugin add cordova-plugin-hcaptcha --variable HCAPTCHA_VERSION=4.0.0

Install latest version from master

  cordova plugin add https://github.com/andreszs/cordova-plugin-hcaptcha

Methods

verify

To invoke the hCaptcha API, you call the verify() method. Usually, this method corresponds to the user's selecting a UI element, such as a button, in your activity.

cordova.plugins.Hcaptcha.verify(onSuccess, onFailure, [args])

args parameters object

The following list contains configuration properties to allow customization of the hCaptcha verification flow.

| parameter | type | default | description | | --- | --- | --- | --- | | siteKey | String | | A site key from the hCaptcha dashboard, valid for any platform. | | locale | String | AUTO | An ISO 639-1 language code to enforce a specific language. | | loading | Boolean | true | Show or hide the loading dialog. Android only. | | tokenExpiration | long | 120 | hCaptcha token expiration timeout in seconds. |

onSuccess callback return values

• hCaptcha response token

When the hCaptcha API executes the onSuccess() method, the user has successfully completed the CAPTCHA challenge. However, this method only indicates that the user has solved the CAPTCHA correctly. You still need to validate the user's response token from your backend server.

To learn how to validate the user's response token, see Verify the User Response Server Side.

onFailure callback return values

• When challenge is dismissed: "hCaptcha failed: Challenge Closed(30)"
• When challenge expires: "hCaptcha failed: Session Timeout(15)"
• When error occurs: The relevant error description is returned.

Example

var onSuccess = function (strToken) {
   console.log(strToken);
};
var onFailure = function (strError) {
   console.warn(strError);
};
var args = {
   siteKey: 'YOUR_SITE_KEY',
   locale: 'es',
   loading: true,
   tokenExpiration: 120
};
cordova.plugins.Hcaptcha.verify(onSuccess, onFailure, args);

Remarks

• You must verify the generated tokens from the server side to complete the verification correctly.
• The hCaptcha params size and theme are not configurable since they are valid for the checkbox only.
• The plugin will not render the checkbox and instead jump directly to the CAPTCHA challenge.
• The plugin does not work on Android 4.4 because the SDK has dependencies not available in API 19.
• On cordova-android 9.X.X and earlier the plugin requires cordova-plugin-android-fragmentactivity.

Plugin demo app

• Compiled APK
• Source code for www folder

Changelog

1.0.0

• First version
• Tested on Android 5.1 and up
• Tested on browser platform