Skip to main content

Class: LegacyMessage

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

Represents a LegacyMessage.

Implements​

Constructors​

new LegacyMessage()​

new LegacyMessage(properties?): LegacyMessage

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

Constructs a new LegacyMessage.

Parameters​

properties?​

ILegacyMessage

Properties to set

Returns​

LegacyMessage

Properties​

eventResponseMessage?​

optional eventResponseMessage: null | IEventResponseMessage

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

LegacyMessage eventResponseMessage.

Implementation of​

ILegacyMessage.eventResponseMessage

pollVote?​

optional pollVote: null | IPollVoteMessage

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

LegacyMessage pollVote.

Implementation of​

ILegacyMessage.pollVote

Methods​

toJSON()​

toJSON(): object

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

Converts this LegacyMessage to JSON.

Returns​

object

JSON object

create()​

static create(properties?): LegacyMessage

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

Creates a new LegacyMessage instance using the specified properties.

Parameters​

properties?​

ILegacyMessage

Properties to set

Returns​

LegacyMessage

LegacyMessage instance

decode()​

static decode(reader, length?): LegacyMessage

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

Decodes a LegacyMessage 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​

LegacyMessage

LegacyMessage

Throws​

If the payload is not a reader or valid buffer

Throws​

If required fields are missing

decodeDelimited()​

static decodeDelimited(reader): LegacyMessage

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

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

Parameters​

reader​

Reader or buffer to decode from

Uint8Array<ArrayBufferLike> | Reader

Returns​

LegacyMessage

LegacyMessage

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:16027

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

Parameters​

message​

ILegacyMessage

LegacyMessage 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:16035

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

Parameters​

message​

ILegacyMessage

LegacyMessage message or plain object to encode

writer?​

Writer

Writer to encode to

Returns​

Writer

Writer

fromObject()​

static fromObject(object): LegacyMessage

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

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

Parameters​

object​

Plain object

Returns​

LegacyMessage

LegacyMessage

getTypeUrl()​

static getTypeUrl(typeUrlPrefix?): string

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

Gets the default type url for LegacyMessage

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:16076

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

Parameters​

message​

LegacyMessage

LegacyMessage

options?​

IConversionOptions

Conversion options

Returns​

object

Plain object

verify()​

static verify(message): null | string

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

Verifies a LegacyMessage message.

Parameters​

message​

Plain object to verify

Returns​

null | string

null if valid, otherwise the reason why it is not