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

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

The event being assessed.

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

Methods

__construct

Constructor.

Parameters
NameDescription
data array

Optional. Data for populating the Message object.

↳ token string

Optional. The user response token provided by the reCAPTCHA Enterprise client-side integration on your site.

↳ site_key string

Optional. The site key that was used to invoke reCAPTCHA Enterprise on your site and generate the token.

↳ user_agent string

Optional. The user agent present in the request from the user's device related to this event.

↳ user_ip_address string

Optional. The IP address in the request from the user's device related to this event.

↳ expected_action string

Optional. The expected action for this type of event. This should be the same action provided at token generation time on client-side platforms already integrated with recaptcha enterprise.

↳ hashed_account_id string

Optional. Unique stable hashed user identifier for the request. The identifier must be hashed using hmac-sha256 with stable secret.

↳ transaction_data Google\Cloud\RecaptchaEnterprise\V1\TransactionData

Optional. Data describing a payment transaction to be assessed. Sending this data enables reCAPTCHA Enterprise Fraud Prevention and the FraudPreventionAssessment component in the response.

getToken

Optional. The user response token provided by the reCAPTCHA Enterprise client-side integration on your site.

Returns
TypeDescription
string

setToken

Optional. The user response token provided by the reCAPTCHA Enterprise client-side integration on your site.

Parameter
NameDescription
var string
Returns
TypeDescription
$this

getSiteKey

Optional. The site key that was used to invoke reCAPTCHA Enterprise on your site and generate the token.

Returns
TypeDescription
string

setSiteKey

Optional. The site key that was used to invoke reCAPTCHA Enterprise on your site and generate the token.

Parameter
NameDescription
var string
Returns
TypeDescription
$this

getUserAgent

Optional. The user agent present in the request from the user's device related to this event.

Returns
TypeDescription
string

setUserAgent

Optional. The user agent present in the request from the user's device related to this event.

Parameter
NameDescription
var string
Returns
TypeDescription
$this

getUserIpAddress

Optional. The IP address in the request from the user's device related to this event.

Returns
TypeDescription
string

setUserIpAddress

Optional. The IP address in the request from the user's device related to this event.

Parameter
NameDescription
var string
Returns
TypeDescription
$this

getExpectedAction

Optional. The expected action for this type of event. This should be the same action provided at token generation time on client-side platforms already integrated with recaptcha enterprise.

Returns
TypeDescription
string

setExpectedAction

Optional. The expected action for this type of event. This should be the same action provided at token generation time on client-side platforms already integrated with recaptcha enterprise.

Parameter
NameDescription
var string
Returns
TypeDescription
$this

getHashedAccountId

Optional. Unique stable hashed user identifier for the request. The identifier must be hashed using hmac-sha256 with stable secret.

Returns
TypeDescription
string

setHashedAccountId

Optional. Unique stable hashed user identifier for the request. The identifier must be hashed using hmac-sha256 with stable secret.

Parameter
NameDescription
var string
Returns
TypeDescription
$this

getTransactionData

Optional. Data describing a payment transaction to be assessed. Sending this data enables reCAPTCHA Enterprise Fraud Prevention and the FraudPreventionAssessment component in the response.

Returns
TypeDescription
Google\Cloud\RecaptchaEnterprise\V1\TransactionData|null

hasTransactionData

clearTransactionData

setTransactionData

Optional. Data describing a payment transaction to be assessed. Sending this data enables reCAPTCHA Enterprise Fraud Prevention and the FraudPreventionAssessment component in the response.

Parameter
NameDescription
var Google\Cloud\RecaptchaEnterprise\V1\TransactionData
Returns
TypeDescription
$this