Show / Hide Table of Contents

Class 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.

Inheritance
object
Captcha
Inherited Members
object.Equals(object)
object.Equals(object, object)
object.GetHashCode()
object.GetType()
object.MemberwiseClone()
object.ReferenceEquals(object, object)
object.ToString()
Namespace: Oci.WaasService.Models
Assembly: OCI.DotNetSDK.Waas.dll
Syntax
public class Captcha

Properties

FailureMessage

Declaration
[Required(ErrorMessage = "FailureMessage is required.")]
[JsonProperty(PropertyName = "failureMessage")]
public string FailureMessage { get; set; }
Property Value
Type Description
string

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

Remarks

Required

FooterText

Declaration
[JsonProperty(PropertyName = "footerText")]
public string FooterText { get; set; }
Property Value
Type Description
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.'

HeaderText

Declaration
[JsonProperty(PropertyName = "headerText")]
public string HeaderText { get; set; }
Property Value
Type Description
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

Declaration
[Required(ErrorMessage = "SessionExpirationInSeconds is required.")]
[JsonProperty(PropertyName = "sessionExpirationInSeconds")]
public int? SessionExpirationInSeconds { get; set; }
Property Value
Type Description
int?

The amount of time before the CAPTCHA expires, in seconds. If unspecified, defaults to 300.

Remarks

Required

SubmitLabel

Declaration
[Required(ErrorMessage = "SubmitLabel is required.")]
[JsonProperty(PropertyName = "submitLabel")]
public string SubmitLabel { get; set; }
Property Value
Type Description
string

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

Remarks

Required

Title

Declaration
[Required(ErrorMessage = "Title is required.")]
[JsonProperty(PropertyName = "title")]
public string Title { get; set; }
Property Value
Type Description
string

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

Remarks

Required

Url

Declaration
[Required(ErrorMessage = "Url is required.")]
[JsonProperty(PropertyName = "url")]
public string Url { get; set; }
Property Value
Type Description
string

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

Remarks

Required

In this article
Back to top