Google Cloud Recaptcha Enterprise V1 Client - Class User (1.15.0)

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

Details about a user's account involved in the transaction.

Generated from protobuf message google.cloud.recaptchaenterprise.v1.TransactionData.User

Namespace

Google \ Cloud \ RecaptchaEnterprise \ V1 \ TransactionData

Methods

__construct

Constructor.

Parameters
Name Description
data array

Optional. Data for populating the Message object.

↳ account_id string

Optional. Unique account identifier for this user. If using account defender, this should match the hashed_account_id field. Otherwise, a unique and persistent identifier for this account.

↳ creation_ms int|string

Optional. The epoch milliseconds of the user's account creation.

↳ email string

Optional. The email address of the user.

↳ email_verified bool

Optional. Whether the email has been verified to be accessible by the user (OTP or similar).

↳ phone_number string

Optional. The phone number of the user, with country code.

↳ phone_verified bool

Optional. Whether the phone number has been verified to be accessible by the user (OTP or similar).

getAccountId

Optional. Unique account identifier for this user. If using account defender, this should match the hashed_account_id field. Otherwise, a unique and persistent identifier for this account.

Returns
Type Description
string

setAccountId

Optional. Unique account identifier for this user. If using account defender, this should match the hashed_account_id field. Otherwise, a unique and persistent identifier for this account.

Parameter
Name Description
var string
Returns
Type Description
$this

getCreationMs

Optional. The epoch milliseconds of the user's account creation.

Returns
Type Description
int|string

setCreationMs

Optional. The epoch milliseconds of the user's account creation.

Parameter
Name Description
var int|string
Returns
Type Description
$this

getEmail

Optional. The email address of the user.

Returns
Type Description
string

setEmail

Optional. The email address of the user.

Parameter
Name Description
var string
Returns
Type Description
$this

getEmailVerified

Optional. Whether the email has been verified to be accessible by the user (OTP or similar).

Returns
Type Description
bool

setEmailVerified

Optional. Whether the email has been verified to be accessible by the user (OTP or similar).

Parameter
Name Description
var bool
Returns
Type Description
$this

getPhoneNumber

Optional. The phone number of the user, with country code.

Returns
Type Description
string

setPhoneNumber

Optional. The phone number of the user, with country code.

Parameter
Name Description
var string
Returns
Type Description
$this

getPhoneVerified

Optional. Whether the phone number has been verified to be accessible by the user (OTP or similar).

Returns
Type Description
bool

setPhoneVerified

Optional. Whether the phone number has been verified to be accessible by the user (OTP or similar).

Parameter
Name Description
var bool
Returns
Type Description
$this