Class protos.google.cloud.recaptchaenterprise.v1.UserId (5.4.0)

Represents a UserId.

Package

@google-cloud/recaptcha-enterprise

Constructors

(constructor)(properties)

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

Constructs a new UserId.

Parameter
NameDescription
properties IUserId

Properties to set

Properties

email

public email?: (string|null);

UserId email.

idOneof

public idOneof?: ("email"|"phoneNumber"|"username");

UserId idOneof.

phoneNumber

public phoneNumber?: (string|null);

UserId phoneNumber.

username

public username?: (string|null);

UserId username.

Methods

create(properties)

public static create(properties?: google.cloud.recaptchaenterprise.v1.IUserId): google.cloud.recaptchaenterprise.v1.UserId;

Creates a new UserId instance using the specified properties.

Parameter
NameDescription
properties IUserId

Properties to set

Returns
TypeDescription
UserId

UserId instance

decode(reader, length)

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

Decodes a UserId 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
UserId

UserId

decodeDelimited(reader)

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

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

Parameter
NameDescription
reader (Reader|Uint8Array)

Reader or buffer to decode from

Returns
TypeDescription
UserId

UserId

encode(message, writer)

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

Encodes the specified UserId message. Does not implicitly messages.

Parameters
NameDescription
message IUserId

UserId 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.IUserId, writer?: $protobuf.Writer): $protobuf.Writer;

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

Parameters
NameDescription
message IUserId

UserId 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.UserId;

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

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

Plain object

Returns
TypeDescription
UserId

UserId

getTypeUrl(typeUrlPrefix)

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

Gets the default type url for UserId

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 UserId to JSON.

Returns
TypeDescription
{ [k: string]: any }

JSON object

toObject(message, options)

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

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

Parameters
NameDescription
message UserId

UserId

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 UserId 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