Table of Contents

Class RecaptchaResponse

Namespace
CMS.FormEngine
Assembly
CMS.FormEngine.dll

Encapsulates a response from reCAPTCHA web service.

public class RecaptchaResponse
Inheritance
object
RecaptchaResponse
Extension Methods

Properties

Action

Name of the action for which the reCAPTCHA v3 challenge was issued.

[JsonProperty("action")]
public string Action { get; set; }

Property Value

string

ErrorCodes

Error codes explaining why reCAPTCHA validation failed.

[JsonProperty("error-codes")]
public IEnumerable<string> ErrorCodes { get; set; }

Property Value

IEnumerable<string>

ErrorMessage

Aggregated error message from all the error codes.

[JsonIgnore]
public string ErrorMessage { get; }

Property Value

string

HostName

The hostname of the site where the reCAPTCHA was solved.

[JsonProperty("hostname")]
public string HostName { get; set; }

Property Value

string

IsValid

Indicates whether the reCAPTCHA validation was successful.

[JsonProperty("success")]
public bool IsValid { get; set; }

Property Value

bool

Score

Score (a number from 0.0 to 1.0) of a reCAPTCHA v3 request.

[JsonProperty("score")]
public double Score { get; set; }

Property Value

double

TimeStamp

Timestamp of the challenge load.

[JsonProperty("challenge_ts")]
public DateTime TimeStamp { get; set; }

Property Value

DateTime