SiteSettings.saveCaptchaSettings (Method)
Saves the settings for captcha fields.
Returns:
Void
Arguments:
| Name | Type | Required | Description |
|---|---|---|---|
| useCaptcha | UseCaptcha | Required | Value indicating whether to use captcha or not. If yes, which version of captcha to use. |
| theme | CaptchaTheme | Optional. Defaults to 'Clean'. | The name of the theme to apply. |
| errorMessage | String_NonNull_NoCFML_255 | Optional. Defaults to 'Incorrect captcha response provided. Please try again.'. | The error message to be displayed when the captcha string fails to verify. You can specify HTML in the string. |
| verificationType | CaptchaVerificationType | Optional. Defaults to 'image'. | |
| publicKey | PlainText_100 | Optional. Defaults to an empty string. | Public key for the captcha settings. |
| privateKey | PlainText_100 | Optional. Defaults to an empty string. | Private key for the captcha settings. |
| defaultPassingScore | CaptchaScore | Optional. Defaults to '0.5'. | Default score for passing a form submission. Only valid for captcha version 3. |
Context:
| License Requirements | (none) |
| Permission Requirements | site:SiteAdmin |
| Deny Context | (none) |
| Require Context | AuthoringEnabled |
| Author Lock | (not required) |
| Transaction Logging | If transaction logging is enabled at the site level, calls to this method will be logged |
| Customization | Customization is not supported for this method. |
Error Codes:
| Code | Error Message |
|---|---|
| 48015 | |
| 48016 |
Notes:
None