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 | |
|---|---|
| Name | Description |
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 | |
|---|---|
| Type | Description |
string | |
setToken
Optional. The user response token provided by the reCAPTCHA Enterprise client-side integration on your site.
| Parameter | |
|---|---|
| Name | Description |
var |
string
|
| Returns | |
|---|---|
| Type | Description |
$this | |
getSiteKey
Optional. The site key that was used to invoke reCAPTCHA Enterprise on your site and generate the token.
| Returns | |
|---|---|
| Type | Description |
string | |
setSiteKey
Optional. The site key that was used to invoke reCAPTCHA Enterprise on your site and generate the token.
| Parameter | |
|---|---|
| Name | Description |
var |
string
|
| Returns | |
|---|---|
| Type | Description |
$this | |
getUserAgent
Optional. The user agent present in the request from the user's device related to this event.
| Returns | |
|---|---|
| Type | Description |
string | |
setUserAgent
Optional. The user agent present in the request from the user's device related to this event.
| Parameter | |
|---|---|
| Name | Description |
var |
string
|
| Returns | |
|---|---|
| Type | Description |
$this | |
getUserIpAddress
Optional. The IP address in the request from the user's device related to this event.
| Returns | |
|---|---|
| Type | Description |
string | |
setUserIpAddress
Optional. The IP address in the request from the user's device related to this event.
| Parameter | |
|---|---|
| Name | Description |
var |
string
|
| Returns | |
|---|---|
| Type | Description |
$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 | |
|---|---|
| Type | Description |
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 | |
|---|---|
| Name | Description |
var |
string
|
| Returns | |
|---|---|
| Type | Description |
$this | |
getHashedAccountId
Optional. Unique stable hashed user identifier for the request. The identifier must be hashed using hmac-sha256 with stable secret.
| Returns | |
|---|---|
| Type | Description |
string | |
setHashedAccountId
Optional. Unique stable hashed user identifier for the request. The identifier must be hashed using hmac-sha256 with stable secret.
| Parameter | |
|---|---|
| Name | Description |
var |
string
|
| Returns | |
|---|---|
| Type | Description |
$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 | |
|---|---|
| Type | Description |
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 | |
|---|---|
| Name | Description |
var |
Google\Cloud\RecaptchaEnterprise\V1\TransactionData
|
| Returns | |
|---|---|
| Type | Description |
$this | |