Google Cloud reCAPTCHA Enterprise v1 API - Class WebKeySettings (2.2.0)

public sealed class WebKeySettings : IMessage<WebKeySettings>, IEquatable<WebKeySettings>, IDeepCloneable<WebKeySettings>, IBufferMessage, IMessage

Reference documentation and code samples for the Google Cloud reCAPTCHA Enterprise v1 API class WebKeySettings.

Settings specific to keys that can be used by websites.

Inheritance

Object > WebKeySettings

Implements

IMessage<WebKeySettings>, IEquatable<WebKeySettings>, IDeepCloneable<WebKeySettings>, IBufferMessage, IMessage

Inherited Members

Object.GetHashCode()

Object.GetType()

Object.MemberwiseClone()

Object.ToString()

Namespace

Google.Cloud.RecaptchaEnterprise.V1

Assembly

Google.Cloud.RecaptchaEnterprise.V1.dll

Constructors

WebKeySettings()

public WebKeySettings()

WebKeySettings(WebKeySettings)

public WebKeySettings(WebKeySettings other)

Parameter
Name	Description
`other`	`WebKeySettings`

Properties

AllowAllDomains

public bool AllowAllDomains { get; set; }

If set to true, it means allowed_domains will not be enforced.

Property Value
Type	Description
`Boolean`

AllowAmpTraffic

public bool AllowAmpTraffic { get; set; }

If set to true, the key can be used on AMP (Accelerated Mobile Pages) websites. This is supported only for the SCORE integration type.

Property Value
Type	Description
`Boolean`

AllowedDomains

public RepeatedField<string> AllowedDomains { get; }

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'

Property Value
Type	Description
`RepeatedField<String>`

ChallengeSecurityPreference

public WebKeySettings.Types.ChallengeSecurityPreference ChallengeSecurityPreference { get; set; }

Settings for the frequency and difficulty at which this key triggers captcha challenges. This should only be specified for IntegrationTypes CHECKBOX and INVISIBLE.

Property Value
Type	Description
`WebKeySettings.Types.ChallengeSecurityPreference`

IntegrationType

public WebKeySettings.Types.IntegrationType IntegrationType { get; set; }

Required. Describes how this key is integrated with the website.

Property Value
Type	Description
`WebKeySettings.Types.IntegrationType`