capacitor-plugin-recaptcha/dist/docs.json

Capacitor plugin for reCAPTCHA Enterprise

{
  "api": {
    "name": "RecaptchaEnterprisePlugin",
    "slug": "recaptchaenterpriseplugin",
    "docs": "",
    "tags": [],
    "methods": [
      {
        "name": "load",
        "signature": "(options: { siteKey: string; }) => Promise<void>",
        "parameters": [
          {
            "name": "options",
            "docs": "",
            "type": "{ siteKey: string; }"
          }
        ],
        "returns": "Promise<void>",
        "tags": [
          {
            "name": "param",
            "text": "options.siteKey The site key to use for initialization"
          }
        ],
        "docs": "Loads the reCAPTCHA SDK or native client with the given siteKey. Must be called during app startup before any execute calls.",
        "complexTypes": [],
        "slug": "load"
      },
      {
        "name": "execute",
        "signature": "(options: { action: string; }) => Promise<{ token: string; siteKey: string; }>",
        "parameters": [
          {
            "name": "options",
            "docs": "",
            "type": "{ action: string; }"
          }
        ],
        "returns": "Promise<{ token: string; siteKey: string; }>",
        "tags": [
          {
            "name": "param",
            "text": "options.action The action name for reCAPTCHA (e.g. 'login')"
          },
          {
            "name": "returns",
            "text": "The resulting reCAPTCHA token"
          }
        ],
        "docs": "Executes reCAPTCHA Enterprise with the given action and returns a token.",
        "complexTypes": [],
        "slug": "execute"
      }
    ],
    "properties": []
  },
  "interfaces": [],
  "enums": [],
  "typeAliases": [],
  "pluginConfigs": []
}