Reference documentation and code samples for the reCAPTCHA Enterprise V1beta1 API class Google::Cloud::RecaptchaEnterprise::V1beta1::WebKeySettings.
Settings specific to keys that can be used by websites.
Inherits
- Object
Extended By
- Google::Protobuf::MessageExts::ClassMethods
Includes
- Google::Protobuf::MessageExts
Methods
#allow_amp_traffic
def allow_amp_traffic() -> ::Boolean
Returns
- (::Boolean) — Whether this key can be used on AMP (Accelerated Mobile Pages) websites.
#allow_amp_traffic=
def allow_amp_traffic=(value) -> ::Boolean
Parameter
- value (::Boolean) — Whether this key can be used on AMP (Accelerated Mobile Pages) websites.
Returns
- (::Boolean) — Whether this key can be used on AMP (Accelerated Mobile Pages) websites.
#allowed_domains
def allowed_domains() -> ::Array<::String>
Returns
- (::Array<::String>) — Domains or subdomains of websites allowed to use the key. All subdomains of an allowed domain are automatically allowed. A valid domain requires a host and must not include any path, port, query or fragment. Examples: 'example.com' or 'subdomain.example.com'
#allowed_domains=
def allowed_domains=(value) -> ::Array<::String>
Parameter
- value (::Array<::String>) — Domains or subdomains of websites allowed to use the key. All subdomains of an allowed domain are automatically allowed. A valid domain requires a host and must not include any path, port, query or fragment. Examples: 'example.com' or 'subdomain.example.com'
Returns
- (::Array<::String>) — Domains or subdomains of websites allowed to use the key. All subdomains of an allowed domain are automatically allowed. A valid domain requires a host and must not include any path, port, query or fragment. Examples: 'example.com' or 'subdomain.example.com'
#challenge_security_preference
def challenge_security_preference() -> ::Google::Cloud::RecaptchaEnterprise::V1beta1::WebKeySettings::ChallengeSecurityPreference
Returns
- (::Google::Cloud::RecaptchaEnterprise::V1beta1::WebKeySettings::ChallengeSecurityPreference) — Settings for the frequency and difficulty at which this key triggers captcha challenges. This should only be specified for IntegrationTypes CHECKBOX_CHALLENGE and INVISIBLE_CHALLENGE.
#challenge_security_preference=
def challenge_security_preference=(value) -> ::Google::Cloud::RecaptchaEnterprise::V1beta1::WebKeySettings::ChallengeSecurityPreference
Parameter
- value (::Google::Cloud::RecaptchaEnterprise::V1beta1::WebKeySettings::ChallengeSecurityPreference) — Settings for the frequency and difficulty at which this key triggers captcha challenges. This should only be specified for IntegrationTypes CHECKBOX_CHALLENGE and INVISIBLE_CHALLENGE.
Returns
- (::Google::Cloud::RecaptchaEnterprise::V1beta1::WebKeySettings::ChallengeSecurityPreference) — Settings for the frequency and difficulty at which this key triggers captcha challenges. This should only be specified for IntegrationTypes CHECKBOX_CHALLENGE and INVISIBLE_CHALLENGE.
#enforce_allowed_domains
def enforce_allowed_domains() -> ::Boolean
Returns
- (::Boolean) — Whether allowed_domains is enforced or not.
#enforce_allowed_domains=
def enforce_allowed_domains=(value) -> ::Boolean
Parameter
- value (::Boolean) — Whether allowed_domains is enforced or not.
Returns
- (::Boolean) — Whether allowed_domains is enforced or not.
#integration_type
def integration_type() -> ::Google::Cloud::RecaptchaEnterprise::V1beta1::WebKeySettings::IntegrationType
Returns
- (::Google::Cloud::RecaptchaEnterprise::V1beta1::WebKeySettings::IntegrationType) — Required. Describes how this key is integrated with the website.
#integration_type=
def integration_type=(value) -> ::Google::Cloud::RecaptchaEnterprise::V1beta1::WebKeySettings::IntegrationType
Parameter
- value (::Google::Cloud::RecaptchaEnterprise::V1beta1::WebKeySettings::IntegrationType) — Required. Describes how this key is integrated with the website.
Returns
- (::Google::Cloud::RecaptchaEnterprise::V1beta1::WebKeySettings::IntegrationType) — Required. Describes how this key is integrated with the website.