Skip to main content

Class: MessageAddOn

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

Represents a MessageAddOn.

Implements​

Constructors​

new MessageAddOn()​

new MessageAddOn(properties?): MessageAddOn

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

Constructs a new MessageAddOn.

Parameters​

properties?​

IMessageAddOn

Properties to set

Returns​

MessageAddOn

Properties​

addOnContextInfo?​

optional addOnContextInfo: null | IMessageAddOnContextInfo

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

MessageAddOn addOnContextInfo.

Implementation of​

IMessageAddOn.addOnContextInfo

legacyMessage?​

optional legacyMessage: null | ILegacyMessage

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

MessageAddOn legacyMessage.

Implementation of​

IMessageAddOn.legacyMessage

messageAddOn?​

optional messageAddOn: null | IMessage

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

MessageAddOn messageAddOn.

Implementation of​

IMessageAddOn.messageAddOn

messageAddOnKey?​

optional messageAddOnKey: null | IMessageKey

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

MessageAddOn messageAddOnKey.

Implementation of​

IMessageAddOn.messageAddOnKey

messageAddOnType?​

optional messageAddOnType: null | MessageAddOnType

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

MessageAddOn messageAddOnType.

Implementation of​

IMessageAddOn.messageAddOnType

senderTimestampMs?​

optional senderTimestampMs: null | number | Long

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

MessageAddOn senderTimestampMs.

Implementation of​

IMessageAddOn.senderTimestampMs

serverTimestampMs?​

optional serverTimestampMs: null | number | Long

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

MessageAddOn serverTimestampMs.

Implementation of​

IMessageAddOn.serverTimestampMs

status?​

optional status: null | Status

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

MessageAddOn status.

Implementation of​

IMessageAddOn.status

Methods​

toJSON()​

toJSON(): object

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

Converts this MessageAddOn to JSON.

Returns​

object

JSON object

create()​

static create(properties?): MessageAddOn

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

Creates a new MessageAddOn instance using the specified properties.

Parameters​

properties?​

IMessageAddOn

Properties to set

Returns​

MessageAddOn

MessageAddOn instance

decode()​

static decode(reader, length?): MessageAddOn

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

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

MessageAddOn

MessageAddOn

Throws​

If the payload is not a reader or valid buffer

Throws​

If required fields are missing

decodeDelimited()​

static decodeDelimited(reader): MessageAddOn

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

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

Parameters​

reader​

Reader or buffer to decode from

Uint8Array<ArrayBufferLike> | Reader

Returns​

MessageAddOn

MessageAddOn

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

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

Parameters​

message​

IMessageAddOn

MessageAddOn 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:32940

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

Parameters​

message​

IMessageAddOn

MessageAddOn message or plain object to encode

writer?​

Writer

Writer to encode to

Returns​

Writer

Writer

fromObject()​

static fromObject(object): MessageAddOn

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

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

Parameters​

object​

Plain object

Returns​

MessageAddOn

MessageAddOn

getTypeUrl()​

static getTypeUrl(typeUrlPrefix?): string

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

Gets the default type url for MessageAddOn

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

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

Parameters​

message​

MessageAddOn

MessageAddOn

options?​

IConversionOptions

Conversion options

Returns​

object

Plain object

verify()​

static verify(message): null | string

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

Verifies a MessageAddOn message.

Parameters​

message​

Plain object to verify

Returns​

null | string

null if valid, otherwise the reason why it is not