Google Cloud reCAPTCHA Enterprise v1 API - Class TokenProperties (2.11.0)

public sealed class TokenProperties : IMessage<TokenProperties>, IEquatable<TokenProperties>, IDeepCloneable<TokenProperties>, IBufferMessage, IMessage

Reference documentation and code samples for the Google Cloud reCAPTCHA Enterprise v1 API class TokenProperties.

Properties of the provided event token.

Inheritance

object > TokenProperties

Namespace

Google.Cloud.RecaptchaEnterprise.V1

Assembly

Google.Cloud.RecaptchaEnterprise.V1.dll

Constructors

TokenProperties()

public TokenProperties()

TokenProperties(TokenProperties)

public TokenProperties(TokenProperties other)
Parameter
NameDescription
otherTokenProperties

Properties

Action

public string Action { get; set; }

Output only. Action name provided at token generation.

Property Value
TypeDescription
string

AndroidPackageName

public string AndroidPackageName { get; set; }

Output only. The name of the Android package with which the token was generated (Android keys only).

Property Value
TypeDescription
string

CreateTime

public Timestamp CreateTime { get; set; }

Output only. The timestamp corresponding to the generation of the token.

Property Value
TypeDescription
Timestamp

Hostname

public string Hostname { get; set; }

Output only. The hostname of the page on which the token was generated (Web keys only).

Property Value
TypeDescription
string

InvalidReason

public TokenProperties.Types.InvalidReason InvalidReason { get; set; }

Output only. Reason associated with the response when valid = false.

Property Value
TypeDescription
TokenPropertiesTypesInvalidReason

IosBundleId

public string IosBundleId { get; set; }

Output only. The ID of the iOS bundle with which the token was generated (iOS keys only).

Property Value
TypeDescription
string

Valid

public bool Valid { get; set; }

Output only. Whether the provided user response token is valid. When valid = false, the reason could be specified in invalid_reason or it could also be due to a user failing to solve a challenge or a sitekey mismatch (i.e the sitekey used to generate the token was different than the one specified in the assessment).

Property Value
TypeDescription
bool