reCAPTCHA Enterprise V1 API - Class Google::Cloud::RecaptchaEnterprise::V1::Event (v0.15.0)

Reference documentation and code samples for the reCAPTCHA Enterprise V1 API class Google::Cloud::RecaptchaEnterprise::V1::Event.

The event being assessed.

Inherits

  • Object

Extended By

  • Google::Protobuf::MessageExts::ClassMethods

Includes

  • Google::Protobuf::MessageExts

Methods

#expected_action

def expected_action() -> ::String
Returns
  • (::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.

#expected_action=

def expected_action=(value) -> ::String
Parameter
  • value (::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.
Returns
  • (::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

def hashed_account_id() -> ::String
Returns
  • (::String) — Optional. Unique stable hashed user identifier for the request. The identifier must be hashed using hmac-sha256 with stable secret.

#hashed_account_id=

def hashed_account_id=(value) -> ::String
Parameter
  • value (::String) — Optional. Unique stable hashed user identifier for the request. The identifier must be hashed using hmac-sha256 with stable secret.
Returns
  • (::String) — Optional. Unique stable hashed user identifier for the request. The identifier must be hashed using hmac-sha256 with stable secret.

#site_key

def site_key() -> ::String
Returns
  • (::String) — Optional. The site key that was used to invoke reCAPTCHA Enterprise on your site and generate the token.

#site_key=

def site_key=(value) -> ::String
Parameter
  • value (::String) — Optional. The site key that was used to invoke reCAPTCHA Enterprise on your site and generate the token.
Returns
  • (::String) — Optional. The site key that was used to invoke reCAPTCHA Enterprise on your site and generate the token.

#token

def token() -> ::String
Returns
  • (::String) — Optional. The user response token provided by the reCAPTCHA Enterprise client-side integration on your site.

#token=

def token=(value) -> ::String
Parameter
  • value (::String) — Optional. The user response token provided by the reCAPTCHA Enterprise client-side integration on your site.
Returns
  • (::String) — Optional. The user response token provided by the reCAPTCHA Enterprise client-side integration on your site.

#transaction_data

def transaction_data() -> ::Google::Cloud::RecaptchaEnterprise::V1::TransactionData
Returns

#transaction_data=

def transaction_data=(value) -> ::Google::Cloud::RecaptchaEnterprise::V1::TransactionData
Parameter
Returns

#user_agent

def user_agent() -> ::String
Returns
  • (::String) — Optional. The user agent present in the request from the user's device related to this event.

#user_agent=

def user_agent=(value) -> ::String
Parameter
  • value (::String) — Optional. The user agent present in the request from the user's device related to this event.
Returns
  • (::String) — Optional. The user agent present in the request from the user's device related to this event.

#user_ip_address

def user_ip_address() -> ::String
Returns
  • (::String) — Optional. The IP address in the request from the user's device related to this event.

#user_ip_address=

def user_ip_address=(value) -> ::String
Parameter
  • value (::String) — Optional. The IP address in the request from the user's device related to this event.
Returns
  • (::String) — Optional. The IP address in the request from the user's device related to this event.