Google Cloud Recaptcha Enterprise V1 Client - Class TokenProperties (1.3.2)

Reference documentation and code samples for the Google Cloud Recaptcha Enterprise V1 Client class TokenProperties.

Properties of the provided event token.

Generated from protobuf message google.cloud.recaptchaenterprise.v1.TokenProperties

Methods

__construct

Constructor.

Parameters
NameDescription
data array

Optional. Data for populating the Message object.

↳ valid bool

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

↳ invalid_reason int

Reason associated with the response when valid = false.

↳ create_time Google\Protobuf\Timestamp

The timestamp corresponding to the generation of the token.

↳ hostname string

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

↳ android_package_name string

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

↳ ios_bundle_id string

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

↳ action string

Action name provided at token generation.

getValid

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

Returns
TypeDescription
bool

setValid

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

Parameter
NameDescription
var bool
Returns
TypeDescription
$this

getInvalidReason

Reason associated with the response when valid = false.

Returns
TypeDescription
int

setInvalidReason

Reason associated with the response when valid = false.

Parameter
NameDescription
var int
Returns
TypeDescription
$this

getCreateTime

The timestamp corresponding to the generation of the token.

Returns
TypeDescription
Google\Protobuf\Timestamp|null

hasCreateTime

clearCreateTime

setCreateTime

The timestamp corresponding to the generation of the token.

Parameter
NameDescription
var Google\Protobuf\Timestamp
Returns
TypeDescription
$this

getHostname

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

Returns
TypeDescription
string

setHostname

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

Parameter
NameDescription
var string
Returns
TypeDescription
$this

getAndroidPackageName

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

Returns
TypeDescription
string

setAndroidPackageName

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

Parameter
NameDescription
var string
Returns
TypeDescription
$this

getIosBundleId

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

Returns
TypeDescription
string

setIosBundleId

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

Parameter
NameDescription
var string
Returns
TypeDescription
$this

getAction

Action name provided at token generation.

Returns
TypeDescription
string

setAction

Action name provided at token generation.

Parameter
NameDescription
var string
Returns
TypeDescription
$this