Class protos.google.cloud.recaptchaenterprise.v1.AndroidKeySettings (5.13.0)

Represents an AndroidKeySettings.

Package

@google-cloud/recaptcha-enterprise

Constructors

(constructor)(properties)

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

Constructs a new AndroidKeySettings.

Parameter
Name Description
properties IAndroidKeySettings

Properties to set

Properties

allowAllPackageNames

public allowAllPackageNames: boolean;

AndroidKeySettings allowAllPackageNames.

allowedPackageNames

public allowedPackageNames: string[];

AndroidKeySettings allowedPackageNames.

supportNonGoogleAppStoreDistribution

public supportNonGoogleAppStoreDistribution: boolean;

AndroidKeySettings supportNonGoogleAppStoreDistribution.

Methods

create(properties)

public static create(properties?: google.cloud.recaptchaenterprise.v1.IAndroidKeySettings): google.cloud.recaptchaenterprise.v1.AndroidKeySettings;

Creates a new AndroidKeySettings instance using the specified properties.

Parameter
Name Description
properties IAndroidKeySettings

Properties to set

Returns
Type Description
AndroidKeySettings

AndroidKeySettings instance

decode(reader, length)

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

Decodes an AndroidKeySettings message from the specified reader or buffer.

Parameters
Name Description
reader (Reader|Uint8Array)

Reader or buffer to decode from

length number

Message length if known beforehand

Returns
Type Description
AndroidKeySettings

AndroidKeySettings

decodeDelimited(reader)

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

Decodes an AndroidKeySettings message from the specified reader or buffer, length delimited.

Parameter
Name Description
reader (Reader|Uint8Array)

Reader or buffer to decode from

Returns
Type Description
AndroidKeySettings

AndroidKeySettings

encode(message, writer)

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

Encodes the specified AndroidKeySettings message. Does not implicitly messages.

Parameters
Name Description
message IAndroidKeySettings

AndroidKeySettings message or plain object to encode

writer $protobuf.Writer

Writer to encode to

Returns
Type Description
$protobuf.Writer

Writer

encodeDelimited(message, writer)

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

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

Parameters
Name Description
message IAndroidKeySettings

AndroidKeySettings message or plain object to encode

writer $protobuf.Writer

Writer to encode to

Returns
Type Description
$protobuf.Writer

Writer

fromObject(object)

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

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

Parameter
Name Description
object { [k: string]: any }

Plain object

Returns
Type Description
AndroidKeySettings

AndroidKeySettings

getTypeUrl(typeUrlPrefix)

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

Gets the default type url for AndroidKeySettings

Parameter
Name Description
typeUrlPrefix string

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

Returns
Type Description
string

The default type url

toJSON()

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

Converts this AndroidKeySettings to JSON.

Returns
Type Description
{ [k: string]: any }

JSON object

toObject(message, options)

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

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

Parameters
Name Description
message AndroidKeySettings

AndroidKeySettings

options $protobuf.IConversionOptions

Conversion options

Returns
Type Description
{ [k: string]: any }

Plain object

verify(message)

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

Verifies an AndroidKeySettings message.

Parameter
Name Description
message { [k: string]: any }

Plain object to verify

Returns
Type Description
(string|null)

null if valid, otherwise the reason why it is not