Reference documentation and code samples for the Google Cloud Recaptcha Enterprise V1 Client class UserInfo.
User information associated with a request protected by reCAPTCHA Enterprise.
Generated from protobuf message google.cloud.recaptchaenterprise.v1.UserInfo
Namespace
Google \ Cloud \ RecaptchaEnterprise \ V1Methods
__construct
Constructor.
| Parameters | |
|---|---|
| Name | Description |
data |
array
Optional. Data for populating the Message object. |
↳ create_account_time |
Google\Protobuf\Timestamp
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. |
↳ account_id |
string
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. |
↳ user_ids |
array<Google\Cloud\RecaptchaEnterprise\V1\UserId>
Optional. Identifiers associated with this user or request. |
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.
| Returns | |
|---|---|
| Type | Description |
Google\Protobuf\Timestamp|null |
|
hasCreateAccountTime
clearCreateAccountTime
setCreateAccountTime
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.
| Parameter | |
|---|---|
| Name | Description |
var |
Google\Protobuf\Timestamp
|
| Returns | |
|---|---|
| Type | Description |
$this |
|
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.
| Returns | |
|---|---|
| Type | Description |
string |
|
setAccountId
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.
| Parameter | |
|---|---|
| Name | Description |
var |
string
|
| Returns | |
|---|---|
| Type | Description |
$this |
|
getUserIds
Optional. Identifiers associated with this user or request.
| Returns | |
|---|---|
| Type | Description |
Google\Protobuf\Internal\RepeatedField |
|
setUserIds
Optional. Identifiers associated with this user or request.
| Parameter | |
|---|---|
| Name | Description |
var |
array<Google\Cloud\RecaptchaEnterprise\V1\UserId>
|
| Returns | |
|---|---|
| Type | Description |
$this |
|