Options
All
  • Public
  • Public/Protected
  • All
Menu

Namespace Captcha

The settings of the CAPTCHA challenge. If a specific URL should be accessed only by a human, a CAPTCHA challenge can be placed at the URL to protect the web application from bots.

Warning:* Oracle recommends that you avoid using any confidential information when you supply string values using the API.

Properties

failureMessage

failureMessage: string

The text to show when incorrect CAPTCHA text is entered. If unspecified, defaults to {@code The CAPTCHA was incorrect. Try again.}

Optional footerText

footerText: undefined | string

The text to show in the footer when showing a CAPTCHA challenge. If unspecified, defaults to 'Enter the letters and numbers as they are shown in the image above.'

Optional headerText

headerText: undefined | string

The text to show in the header when showing a CAPTCHA challenge. If unspecified, defaults to 'We have detected an increased number of attempts to access this website. To help us keep this site secure, please let us know that you are not a robot by entering the text from the image below.'

sessionExpirationInSeconds

sessionExpirationInSeconds: number

The amount of time before the CAPTCHA expires, in seconds. If unspecified, defaults to {@code 300}. Note: Numbers greater than Number.MAX_SAFE_INTEGER will result in rounding issues.

submitLabel

submitLabel: string

The text to show on the label of the CAPTCHA challenge submit button. If unspecified, defaults to {@code Yes, I am human}.

title

title: string

The title used when displaying a CAPTCHA challenge. If unspecified, defaults to {@code Are you human?}

url

url: string

The unique URL path at which to show the CAPTCHA challenge.

Functions

getDeserializedJsonObj

  • getDeserializedJsonObj(obj: Captcha): object

getJsonObj