reCAPTCHA Enterprise V1 API - Class Google::Cloud::RecaptchaEnterprise::V1::TokenProperties (v0.11.0)

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

Inherits

  • Object

Extended By

  • Google::Protobuf::MessageExts::ClassMethods

Includes

  • Google::Protobuf::MessageExts

Methods

#action

def action() -> ::String
Returns
  • (::String) — Action name provided at token generation.

#action=

def action=(value) -> ::String
Parameter
  • value (::String) — Action name provided at token generation.
Returns
  • (::String) — Action name provided at token generation.

#create_time

def create_time() -> ::Google::Protobuf::Timestamp
Returns

#create_time=

def create_time=(value) -> ::Google::Protobuf::Timestamp
Parameter
Returns

#hostname

def hostname() -> ::String
Returns
  • (::String) — The hostname of the page on which the token was generated (Web keys only).

#hostname=

def hostname=(value) -> ::String
Parameter
  • value (::String) — The hostname of the page on which the token was generated (Web keys only).
Returns
  • (::String) — The hostname of the page on which the token was generated (Web keys only).

#invalid_reason

def invalid_reason() -> ::Google::Cloud::RecaptchaEnterprise::V1::TokenProperties::InvalidReason
Returns

#invalid_reason=

def invalid_reason=(value) -> ::Google::Cloud::RecaptchaEnterprise::V1::TokenProperties::InvalidReason
Parameter
Returns

#valid

def valid() -> ::Boolean
Returns
  • (::Boolean) — Whether the provided user response token is valid. When valid = false, the reason could be specified in invalid_reason or it could also be due to a user failing to solve a challenge or a sitekey mismatch (i.e the sitekey used to generate the token was different than the one specified in the assessment).

#valid=

def valid=(value) -> ::Boolean
Parameter
  • value (::Boolean) — Whether the provided user response token is valid. When valid = false, the reason could be specified in invalid_reason or it could also be due to a user failing to solve a challenge or a sitekey mismatch (i.e the sitekey used to generate the token was different than the one specified in the assessment).
Returns
  • (::Boolean) — Whether the provided user response token is valid. When valid = false, the reason could be specified in invalid_reason or it could also be due to a user failing to solve a challenge or a sitekey mismatch (i.e the sitekey used to generate the token was different than the one specified in the assessment).