Skip to main content

Class: EmbeddedMessage

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

Represents an EmbeddedMessage.

Implements​

Constructors​

new EmbeddedMessage()​

new EmbeddedMessage(properties?): EmbeddedMessage

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

Constructs a new EmbeddedMessage.

Parameters​

properties?​

IEmbeddedMessage

Properties to set

Returns​

EmbeddedMessage

Properties​

message?​

optional message: null | IMessage

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

EmbeddedMessage message.

Implementation of​

IEmbeddedMessage.message

stanzaId?​

optional stanzaId: null | string

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

EmbeddedMessage stanzaId.

Implementation of​

IEmbeddedMessage.stanzaId

Methods​

toJSON()​

toJSON(): object

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

Converts this EmbeddedMessage to JSON.

Returns​

object

JSON object

create()​

static create(properties?): EmbeddedMessage

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

Creates a new EmbeddedMessage instance using the specified properties.

Parameters​

properties?​

IEmbeddedMessage

Properties to set

Returns​

EmbeddedMessage

EmbeddedMessage instance

decode()​

static decode(reader, length?): EmbeddedMessage

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

Decodes an EmbeddedMessage 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​

EmbeddedMessage

EmbeddedMessage

Throws​

If the payload is not a reader or valid buffer

Throws​

If required fields are missing

decodeDelimited()​

static decodeDelimited(reader): EmbeddedMessage

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

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

Parameters​

reader​

Reader or buffer to decode from

Uint8Array<ArrayBufferLike> | Reader

Returns​

EmbeddedMessage

EmbeddedMessage

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

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

Parameters​

message​

IEmbeddedMessage

EmbeddedMessage 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:12496

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

Parameters​

message​

IEmbeddedMessage

EmbeddedMessage message or plain object to encode

writer?​

Writer

Writer to encode to

Returns​

Writer

Writer

fromObject()​

static fromObject(object): EmbeddedMessage

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

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

Parameters​

object​

Plain object

Returns​

EmbeddedMessage

EmbeddedMessage

getTypeUrl()​

static getTypeUrl(typeUrlPrefix?): string

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

Gets the default type url for EmbeddedMessage

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

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

Parameters​

message​

EmbeddedMessage

EmbeddedMessage

options?​

IConversionOptions

Conversion options

Returns​

object

Plain object

verify()​

static verify(message): null | string

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

Verifies an EmbeddedMessage message.

Parameters​

message​

Plain object to verify

Returns​

null | string

null if valid, otherwise the reason why it is not