Class protos.google.cloud.recaptchaenterprise.v1.WebKeySettings (4.1.0)

Represents a WebKeySettings.

Package

@google-cloud/recaptcha-enterprise

Constructors

(constructor)(properties)

constructor(properties?: google.cloud.recaptchaenterprise.v1.IWebKeySettings);

Constructs a new WebKeySettings.

Parameter
NameDescription
properties IWebKeySettings

Properties to set

Properties

allowAllDomains

public allowAllDomains: boolean;

WebKeySettings allowAllDomains.

allowAmpTraffic

public allowAmpTraffic: boolean;

WebKeySettings allowAmpTraffic.

allowedDomains

public allowedDomains: string[];

WebKeySettings allowedDomains.

challengeSecurityPreference

public challengeSecurityPreference: (google.cloud.recaptchaenterprise.v1.WebKeySettings.ChallengeSecurityPreference|keyof typeof google.cloud.recaptchaenterprise.v1.WebKeySettings.ChallengeSecurityPreference);

WebKeySettings challengeSecurityPreference.

integrationType

public integrationType: (google.cloud.recaptchaenterprise.v1.WebKeySettings.IntegrationType|keyof typeof google.cloud.recaptchaenterprise.v1.WebKeySettings.IntegrationType);

WebKeySettings integrationType.

Methods

create(properties)

public static create(properties?: google.cloud.recaptchaenterprise.v1.IWebKeySettings): google.cloud.recaptchaenterprise.v1.WebKeySettings;

Creates a new WebKeySettings instance using the specified properties.

Parameter
NameDescription
properties IWebKeySettings

Properties to set

Returns
TypeDescription
WebKeySettings

WebKeySettings instance

decode(reader, length)

public static decode(reader: ($protobuf.Reader|Uint8Array), length?: number): google.cloud.recaptchaenterprise.v1.WebKeySettings;

Decodes a WebKeySettings message from the specified reader or buffer.

Parameters
NameDescription
reader (Reader|Uint8Array)

Reader or buffer to decode from

length number

Message length if known beforehand

Returns
TypeDescription
WebKeySettings

WebKeySettings

decodeDelimited(reader)

public static decodeDelimited(reader: ($protobuf.Reader|Uint8Array)): google.cloud.recaptchaenterprise.v1.WebKeySettings;

Decodes a WebKeySettings message from the specified reader or buffer, length delimited.

Parameter
NameDescription
reader (Reader|Uint8Array)

Reader or buffer to decode from

Returns
TypeDescription
WebKeySettings

WebKeySettings

encode(message, writer)

public static encode(message: google.cloud.recaptchaenterprise.v1.IWebKeySettings, writer?: $protobuf.Writer): $protobuf.Writer;

Encodes the specified WebKeySettings message. Does not implicitly messages.

Parameters
NameDescription
message IWebKeySettings

WebKeySettings message or plain object to encode

writer $protobuf.Writer

Writer to encode to

Returns
TypeDescription
$protobuf.Writer

Writer

encodeDelimited(message, writer)

public static encodeDelimited(message: google.cloud.recaptchaenterprise.v1.IWebKeySettings, writer?: $protobuf.Writer): $protobuf.Writer;

Encodes the specified WebKeySettings message, length delimited. Does not implicitly messages.

Parameters
NameDescription
message IWebKeySettings

WebKeySettings message or plain object to encode

writer $protobuf.Writer

Writer to encode to

Returns
TypeDescription
$protobuf.Writer

Writer

fromObject(object)

public static fromObject(object: { [k: string]: any }): google.cloud.recaptchaenterprise.v1.WebKeySettings;

Creates a WebKeySettings message from a plain object. Also converts values to their respective internal types.

Parameter
NameDescription
object { [k: string]: any }

Plain object

Returns
TypeDescription
WebKeySettings

WebKeySettings

getTypeUrl(typeUrlPrefix)

public static getTypeUrl(typeUrlPrefix?: string): string;

Gets the default type url for WebKeySettings

Parameter
NameDescription
typeUrlPrefix string

your custom typeUrlPrefix(default "type.googleapis.com")

Returns
TypeDescription
string

The default type url

toJSON()

public toJSON(): { [k: string]: any };

Converts this WebKeySettings to JSON.

Returns
TypeDescription
{ [k: string]: any }

JSON object

toObject(message, options)

public static toObject(message: google.cloud.recaptchaenterprise.v1.WebKeySettings, options?: $protobuf.IConversionOptions): { [k: string]: any };

Creates a plain object from a WebKeySettings message. Also converts values to other types if specified.

Parameters
NameDescription
message WebKeySettings

WebKeySettings

options $protobuf.IConversionOptions

Conversion options

Returns
TypeDescription
{ [k: string]: any }

Plain object

verify(message)

public static verify(message: { [k: string]: any }): (string|null);

Verifies a WebKeySettings message.

Parameter
NameDescription
message { [k: string]: any }

Plain object to verify

Returns
TypeDescription
(string|null)

null if valid, otherwise the reason why it is not