Skip to main content

Class: HistorySyncMsg

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

Represents a HistorySyncMsg.

Implements​

Constructors​

new HistorySyncMsg()​

new HistorySyncMsg(properties?): HistorySyncMsg

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

Constructs a new HistorySyncMsg.

Parameters​

properties?​

IHistorySyncMsg

Properties to set

Returns​

HistorySyncMsg

Properties​

message?​

optional message: null | IWebMessageInfo

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

HistorySyncMsg message.

Implementation of​

IHistorySyncMsg.message

msgOrderId?​

optional msgOrderId: null | number | Long

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

HistorySyncMsg msgOrderId.

Implementation of​

IHistorySyncMsg.msgOrderId

Methods​

toJSON()​

toJSON(): object

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

Converts this HistorySyncMsg to JSON.

Returns​

object

JSON object

create()​

static create(properties?): HistorySyncMsg

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

Creates a new HistorySyncMsg instance using the specified properties.

Parameters​

properties?​

IHistorySyncMsg

Properties to set

Returns​

HistorySyncMsg

HistorySyncMsg instance

decode()​

static decode(reader, length?): HistorySyncMsg

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

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

HistorySyncMsg

HistorySyncMsg

Throws​

If the payload is not a reader or valid buffer

Throws​

If required fields are missing

decodeDelimited()​

static decodeDelimited(reader): HistorySyncMsg

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

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

Parameters​

reader​

Reader or buffer to decode from

Uint8Array<ArrayBufferLike> | Reader

Returns​

HistorySyncMsg

HistorySyncMsg

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

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

Parameters​

message​

IHistorySyncMsg

HistorySyncMsg 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:14586

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

Parameters​

message​

IHistorySyncMsg

HistorySyncMsg message or plain object to encode

writer?​

Writer

Writer to encode to

Returns​

Writer

Writer

fromObject()​

static fromObject(object): HistorySyncMsg

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

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

Parameters​

object​

Plain object

Returns​

HistorySyncMsg

HistorySyncMsg

getTypeUrl()​

static getTypeUrl(typeUrlPrefix?): string

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

Gets the default type url for HistorySyncMsg

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

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

Parameters​

message​

HistorySyncMsg

HistorySyncMsg

options?​

IConversionOptions

Conversion options

Returns​

object

Plain object

verify()​

static verify(message): null | string

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

Verifies a HistorySyncMsg message.

Parameters​

message​

Plain object to verify

Returns​

null | string

null if valid, otherwise the reason why it is not