Skip to main content

Class: SyncActionData

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

Represents a SyncActionData.

Implements

Constructors

new SyncActionData()

new SyncActionData(properties?): SyncActionData

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

Constructs a new SyncActionData.

Parameters

properties?

ISyncActionData

Properties to set

Returns

SyncActionData

Properties

index?

optional index: null | Uint8Array<ArrayBufferLike>

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

SyncActionData index.

Implementation of

ISyncActionData.index


padding?

optional padding: null | Uint8Array<ArrayBufferLike>

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

SyncActionData padding.

Implementation of

ISyncActionData.padding


value?

optional value: null | ISyncActionValue

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

SyncActionData value.

Implementation of

ISyncActionData.value


version?

optional version: null | number

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

SyncActionData version.

Implementation of

ISyncActionData.version

Methods

toJSON()

toJSON(): object

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

Converts this SyncActionData to JSON.

Returns

object

JSON object


create()

static create(properties?): SyncActionData

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

Creates a new SyncActionData instance using the specified properties.

Parameters

properties?

ISyncActionData

Properties to set

Returns

SyncActionData

SyncActionData instance


decode()

static decode(reader, length?): SyncActionData

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

Decodes a SyncActionData 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

SyncActionData

SyncActionData

Throws

If the payload is not a reader or valid buffer

Throws

If required fields are missing


decodeDelimited()

static decodeDelimited(reader): SyncActionData

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

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

Parameters

reader

Reader or buffer to decode from

Uint8Array<ArrayBufferLike> | Reader

Returns

SyncActionData

SyncActionData

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

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

Parameters

message

ISyncActionData

SyncActionData 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:40459

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

Parameters

message

ISyncActionData

SyncActionData message or plain object to encode

writer?

Writer

Writer to encode to

Returns

Writer

Writer


fromObject()

static fromObject(object): SyncActionData

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

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

Parameters

object

Plain object

Returns

SyncActionData

SyncActionData


getTypeUrl()

static getTypeUrl(typeUrlPrefix?): string

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

Gets the default type url for SyncActionData

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

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

Parameters

message

SyncActionData

SyncActionData

options?

IConversionOptions

Conversion options

Returns

object

Plain object


verify()

static verify(message): null | string

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

Verifies a SyncActionData message.

Parameters

message

Plain object to verify

Returns

null | string

null if valid, otherwise the reason why it is not