PHPFUI/InstaDoc

User information associated with a request protected by reCAPTCHA Enterprise.

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

CloneableInstantiable

Extends
Google\Protobuf\Internal\Message

Methods

public __construct( $data = NULL)

Constructor.

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

@type \Google\Protobuf\Timestamp $create_account_time
      Optional. Creation time for this account associated with this user. Leave
      blank for non logged-in actions, guest checkout, or when there is no
      account associated with the current user.
@type string $account_id
      Optional. For logged-in requests or login/registration requests, the unique
      account identifier associated with this user. You can use the username if
      it is stable (meaning it is the same for every request associated with the
      same user), or any stable user ID of your choice. Leave blank for non
      logged-in actions or guest checkout.
@type array<\Google\Cloud\RecaptchaEnterprise\V1\UserId>|\Google\Protobuf\Internal\RepeatedField $user_ids
      Optional. Identifiers associated with this user or request.

}

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 clearCreateAccountTime()

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

Clear all unknown fields previously parsed.

return null

public getAccountId()

Optional. For logged-in requests or login/registration requests, the unique account identifier associated with this user. You can use the username if it is stable (meaning it is the same for every request associated with the same user), or any stable user ID of your choice. Leave blank for non logged-in actions or guest checkout.

Generated from protobuf field string account_id = 2 [(.google.api.field_behavior) = OPTIONAL];

return string

public getCreateAccountTime()

Optional. Creation time for this account associated with this user. Leave blank for non logged-in actions, guest checkout, or when there is no account associated with the current user.

Generated from protobuf field .google.protobuf.Timestamp create_account_time = 1 [(.google.api.field_behavior) = OPTIONAL];

return \Google\Protobuf\Timestamp|null

public getUserIds()

Optional. Identifiers associated with this user or request.

Generated from protobuf field repeated .google.cloud.recaptchaenterprise.v1.UserId user_ids = 3 [(.google.api.field_behavior) = OPTIONAL];

return \Google\Protobuf\Internal\RepeatedField

public hasCreateAccountTime()

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 setAccountId( $var)

Generated from protobuf field string account_id = 2 [(.google.api.field_behavior) = OPTIONAL];

param string $var
return $this

public setCreateAccountTime( $var)

Optional. Creation time for this account associated with this user. Leave blank for non logged-in actions, guest checkout, or when there is no account associated with the current user.

Generated from protobuf field .google.protobuf.Timestamp create_account_time = 1 [(.google.api.field_behavior) = OPTIONAL];

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

public setUserIds( $var)

Optional. Identifiers associated with this user or request.

Generated from protobuf field repeated .google.cloud.recaptchaenterprise.v1.UserId user_ids = 3 [(.google.api.field_behavior) = OPTIONAL];

param \Google\Cloud\RecaptchaEnterprise\V1\UserId[]|\Google\Protobuf\Internal\RepeatedField $var
return $this

Properties

protected $account_id = ''

Generated from protobuf field string account_id = 2 [(.google.api.field_behavior) = OPTIONAL];

protected $create_account_time = NULL

Optional. Creation time for this account associated with this user. Leave blank for non logged-in actions, guest checkout, or when there is no account associated with the current user.

Generated from protobuf field .google.protobuf.Timestamp create_account_time = 1 [(.google.api.field_behavior) = OPTIONAL];

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)

Properties

private $user_ids = NULL

Optional. Identifiers associated with this user or request.

Generated from protobuf field repeated .google.cloud.recaptchaenterprise.v1.UserId user_ids = 3 [(.google.api.field_behavior) = OPTIONAL];