Google Cloud reCAPTCHA Enterprise v1 API - Class TokenProperties (2.5.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

Implements

IMessage TokenProperties, IEquatable TokenProperties, IDeepCloneable TokenProperties, IBufferMessage, IMessage

Inherited Members

object.GetHashCode()

object.GetType()

object.ToString()

Namespace

Google.Cloud.RecaptchaEnterprise.V1

Assembly

Google.Cloud.RecaptchaEnterprise.V1.dll

Constructors

TokenProperties()

public TokenProperties()

TokenProperties(TokenProperties)

public TokenProperties(TokenProperties other)

Parameter
Name	Description
`other`	`TokenProperties`

Properties

Action

public string Action { get; set; }

Action name provided at token generation.

Property Value
Type	Description
`string`

AndroidPackageName

public string AndroidPackageName { get; set; }

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

Property Value
Type	Description
`string`

CreateTime

public Timestamp CreateTime { get; set; }

The timestamp corresponding to the generation of the token.

Property Value
Type	Description
`Timestamp`

Hostname

public string Hostname { get; set; }

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

Property Value
Type	Description
`string`

InvalidReason

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

Reason associated with the response when valid = false.

Property Value
Type	Description
`TokenPropertiesTypesInvalidReason`

IosBundleId

public string IosBundleId { get; set; }

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

Property Value
Type	Description
`string`

Valid

public bool Valid { get; set; }

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
Type	Description
`bool`