PHPFUI/InstaDoc

Properties of the provided event token.

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

CloneableInstantiable

Extends
Google\Protobuf\Internal\Message

Public
Protected

Methods

public __construct( $data = NULL)

Constructor.

param array $data { Optional. Data for populating the Message object.

@type bool $valid
      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).
@type int $invalid_reason
      Output only. Reason associated with the response when valid = false.
@type \Google\Protobuf\Timestamp $create_time
      Output only. The timestamp corresponding to the generation of the token.
@type string $hostname
      Output only. The hostname of the page on which the token was generated (Web
      keys only).
@type string $android_package_name
      Output only. The name of the Android package with which the token was
      generated (Android keys only).
@type string $ios_bundle_id
      Output only. The ID of the iOS bundle with which the token was generated
      (iOS keys only).
@type string $action
      Output only. Action name provided at token generation.

}

public Google\Protobuf\Internal\Message::__debugInfo()

public Google\Protobuf\Internal\Message::byteSize()

ignore

public Google\Protobuf\Internal\Message::clear()

Clear all containing fields.

return null

public clearCreateTime()

public Google\Protobuf\Internal\Message::discardUnknownFields()

Clear all unknown fields previously parsed.

return null

public getAction()

Output only. Action name provided at token generation.

Generated from protobuf field string action = 5 [(.google.api.field_behavior) = OUTPUT_ONLY];

return string

public getAndroidPackageName()

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

Generated from protobuf field string android_package_name = 8 [(.google.api.field_behavior) = OUTPUT_ONLY];

return string

public getCreateTime()

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

Generated from protobuf field .google.protobuf.Timestamp create_time = 3 [(.google.api.field_behavior) = OUTPUT_ONLY];

return \Google\Protobuf\Timestamp|null

public getHostname()

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

Generated from protobuf field string hostname = 4 [(.google.api.field_behavior) = OUTPUT_ONLY];

return string

public getInvalidReason()

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

Generated from protobuf field .google.cloud.recaptchaenterprise.v1.TokenProperties.InvalidReason invalid_reason = 2 [(.google.api.field_behavior) = OUTPUT_ONLY];

return int

public getIosBundleId()

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

Generated from protobuf field string ios_bundle_id = 9 [(.google.api.field_behavior) = OUTPUT_ONLY];

return string

public getValid()

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

Generated from protobuf field bool valid = 1 [(.google.api.field_behavior) = OUTPUT_ONLY];

return bool

public hasCreateTime()

public Google\Protobuf\Internal\Message::jsonByteSize( $options = 0)

ignore

public Google\Protobuf\Internal\Message::mergeFrom( $msg)

Merges the contents of the specified message into current message.

This method merges the contents of the specified message into the current message. Singular fields that are set in the specified message overwrite the corresponding fields in the current message. Repeated fields are appended. Map fields key-value pairs are overwritten. Singular/Oneof sub-messages are recursively merged. All overwritten sub-messages are deep-copied.

param object $msg Protobuf message to be merged from.
return null

public Google\Protobuf\Internal\Message::mergeFromJsonString( $data, $ignore_unknown = false)

Parses a json string to protobuf message.

This function takes a string in the json wire format, matching the encoding output by serializeToJsonString(). See mergeFrom() for merging behavior, if the field is already set in the specified message.

param string $data Json protobuf data.
param bool $ignore_unknown
return null
throws \Exception Invalid data.

public Google\Protobuf\Internal\Message::mergeFromString( $data)

Parses a protocol buffer contained in a string.

This function takes a string in the (non-human-readable) binary wire format, matching the encoding output by serializeToString(). See mergeFrom() for merging behavior, if the field is already set in the specified message.

param string $data Binary protobuf data.
return null
throws \Exception Invalid data.

public Google\Protobuf\Internal\Message::parseFromJsonStream( $input, $ignore_unknown)

ignore

public Google\Protobuf\Internal\Message::parseFromStream( $input)

ignore

public Google\Protobuf\Internal\Message::serializeToJsonStream( $output)

ignore

public Google\Protobuf\Internal\Message::serializeToJsonString( $options = 0)

Serialize the message to json string.

return string Serialized json protobuf data.

public Google\Protobuf\Internal\Message::serializeToStream( $output)

ignore

public Google\Protobuf\Internal\Message::serializeToString()

Serialize the message to string.

return string Serialized binary protobuf data.

public setAction( $var)

Output only. Action name provided at token generation.

Generated from protobuf field string action = 5 [(.google.api.field_behavior) = OUTPUT_ONLY];

param string $var
return $this

public setAndroidPackageName( $var)

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

Generated from protobuf field string android_package_name = 8 [(.google.api.field_behavior) = OUTPUT_ONLY];

param string $var
return $this

public setCreateTime( $var)

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

Generated from protobuf field .google.protobuf.Timestamp create_time = 3 [(.google.api.field_behavior) = OUTPUT_ONLY];

param \Google\Protobuf\Timestamp $var
return $this

public setHostname( $var)

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

Generated from protobuf field string hostname = 4 [(.google.api.field_behavior) = OUTPUT_ONLY];

param string $var
return $this

public setInvalidReason( $var)

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

Generated from protobuf field .google.cloud.recaptchaenterprise.v1.TokenProperties.InvalidReason invalid_reason = 2 [(.google.api.field_behavior) = OUTPUT_ONLY];

param int $var
return $this

public setIosBundleId( $var)

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

Generated from protobuf field string ios_bundle_id = 9 [(.google.api.field_behavior) = OUTPUT_ONLY];

param string $var
return $this

public setValid( $var)

Generated from protobuf field bool valid = 1 [(.google.api.field_behavior) = OUTPUT_ONLY];

param bool $var
return $this

Properties

protected $action = ''

Output only. Action name provided at token generation.

Generated from protobuf field string action = 5 [(.google.api.field_behavior) = OUTPUT_ONLY];

protected $android_package_name = ''

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

Generated from protobuf field string android_package_name = 8 [(.google.api.field_behavior) = OUTPUT_ONLY];

protected $create_time = NULL

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

Generated from protobuf field .google.protobuf.Timestamp create_time = 3 [(.google.api.field_behavior) = OUTPUT_ONLY];

protected $hostname = ''

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

Generated from protobuf field string hostname = 4 [(.google.api.field_behavior) = OUTPUT_ONLY];

protected $invalid_reason = 0

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

Generated from protobuf field .google.cloud.recaptchaenterprise.v1.TokenProperties.InvalidReason invalid_reason = 2 [(.google.api.field_behavior) = OUTPUT_ONLY];

protected $ios_bundle_id = ''

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

Generated from protobuf field string ios_bundle_id = 9 [(.google.api.field_behavior) = OUTPUT_ONLY];

protected $valid = false

Generated from protobuf field bool valid = 1 [(.google.api.field_behavior) = OUTPUT_ONLY];

Methods

protected Google\Protobuf\Internal\Message::hasOneof( $number)

protected Google\Protobuf\Internal\Message::mergeFromArray(array $array)

Populates the message from a user-supplied PHP array. Array keys correspond to Message properties and nested message properties.

Example:

$message->mergeFromArray([
    'name' => 'This is a message name',
    'interval' => [
         'startTime' => time() - 60,
         'endTime' => time(),
    ]
]);

This method will trigger an error if it is passed data that cannot be converted to the correct type. For example, a StringValue field must receive data that is either a string or a StringValue object.

param array $array An array containing message properties and values.
return null

protected Google\Protobuf\Internal\Message::mergeFromJsonArray( $array, $ignore_unknown)

protected Google\Protobuf\Internal\Message::readOneof( $number)

protected Google\Protobuf\Internal\Message::readWrapperValue( $member)

protected Google\Protobuf\Internal\Message::whichOneof( $oneof_name)

protected Google\Protobuf\Internal\Message::writeOneof( $number, $value)

protected Google\Protobuf\Internal\Message::writeWrapperValue( $member, $value)