Skip to main content

Class: KeyId

Defined in: WAProto/index.d.ts:15597

Represents a KeyId.

Implements​

Constructors​

new KeyId()​

new KeyId(properties?): KeyId

Defined in: WAProto/index.d.ts:15603

Constructs a new KeyId.

Parameters​

properties?​

IKeyId

Properties to set

Returns​

KeyId

Properties​

id?​

optional id: null | Uint8Array<ArrayBufferLike>

Defined in: WAProto/index.d.ts:15606

KeyId id.

Implementation of​

IKeyId.id

Methods​

toJSON()​

toJSON(): object

Defined in: WAProto/index.d.ts:15676

Converts this KeyId to JSON.

Returns​

object

JSON object

create()​

static create(properties?): KeyId

Defined in: WAProto/index.d.ts:15613

Creates a new KeyId instance using the specified properties.

Parameters​

properties?​

IKeyId

Properties to set

Returns​

KeyId

KeyId instance

decode()​

static decode(reader, length?): KeyId

Defined in: WAProto/index.d.ts:15639

Decodes a KeyId message from the specified reader or buffer.

Parameters​

reader​

Reader or buffer to decode from

Uint8Array<ArrayBufferLike> | Reader

length?​

number

Message length if known beforehand

Returns​

KeyId

KeyId

Throws​

If the payload is not a reader or valid buffer

Throws​

If required fields are missing

decodeDelimited()​

static decodeDelimited(reader): KeyId

Defined in: WAProto/index.d.ts:15648

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

Parameters​

reader​

Reader or buffer to decode from

Uint8Array<ArrayBufferLike> | Reader

Returns​

KeyId

KeyId

Throws​

If the payload is not a reader or valid buffer

Throws​

If required fields are missing

encode()​

static encode(message, writer?): Writer

Defined in: WAProto/index.d.ts:15621

Encodes the specified KeyId message. Does not implicitly verify messages.

Parameters​

message​

IKeyId

KeyId message or plain object to encode

writer?​

Writer

Writer to encode to

Returns​

Writer

Writer

encodeDelimited()​

static encodeDelimited(message, writer?): Writer

Defined in: WAProto/index.d.ts:15629

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

Parameters​

message​

IKeyId

KeyId message or plain object to encode

writer?​

Writer

Writer to encode to

Returns​

Writer

Writer

fromObject()​

static fromObject(object): KeyId

Defined in: WAProto/index.d.ts:15662

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

Parameters​

object​

Plain object

Returns​

KeyId

KeyId

getTypeUrl()​

static getTypeUrl(typeUrlPrefix?): string

Defined in: WAProto/index.d.ts:15683

Gets the default type url for KeyId

Parameters​

typeUrlPrefix?​

string

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

Returns​

string

The default type url

toObject()​

static toObject(message, options?): object

Defined in: WAProto/index.d.ts:15670

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

Parameters​

message​

KeyId

KeyId

options?​

IConversionOptions

Conversion options

Returns​

object

Plain object

verify()​

static verify(message): null | string

Defined in: WAProto/index.d.ts:15655

Verifies a KeyId message.

Parameters​

message​

Plain object to verify

Returns​

null | string

null if valid, otherwise the reason why it is not