Skip to main content

Class: SyncdPatch

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

Represents a SyncdPatch.

Implements​

Constructors​

new SyncdPatch()​

new SyncdPatch(properties?): SyncdPatch

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

Constructs a new SyncdPatch.

Parameters​

properties?​

ISyncdPatch

Properties to set

Returns​

SyncdPatch

Properties​

clientDebugData?​

optional clientDebugData: null | Uint8Array<ArrayBufferLike>

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

SyncdPatch clientDebugData.

Implementation of​

ISyncdPatch.clientDebugData

deviceIndex?​

optional deviceIndex: null | number

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

SyncdPatch deviceIndex.

Implementation of​

ISyncdPatch.deviceIndex

exitCode?​

optional exitCode: null | IExitCode

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

SyncdPatch exitCode.

Implementation of​

ISyncdPatch.exitCode

externalMutations?​

optional externalMutations: null | IExternalBlobReference

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

SyncdPatch externalMutations.

Implementation of​

ISyncdPatch.externalMutations

keyId?​

optional keyId: null | IKeyId

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

SyncdPatch keyId.

Implementation of​

ISyncdPatch.keyId

mutations​

mutations: ISyncdMutation[]

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

SyncdPatch mutations.

Implementation of​

ISyncdPatch.mutations

patchMac?​

optional patchMac: null | Uint8Array<ArrayBufferLike>

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

SyncdPatch patchMac.

Implementation of​

ISyncdPatch.patchMac

snapshotMac?​

optional snapshotMac: null | Uint8Array<ArrayBufferLike>

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

SyncdPatch snapshotMac.

Implementation of​

ISyncdPatch.snapshotMac

version?​

optional version: null | ISyncdVersion

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

SyncdPatch version.

Implementation of​

ISyncdPatch.version

Methods​

toJSON()​

toJSON(): object

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

Converts this SyncdPatch to JSON.

Returns​

object

JSON object

create()​

static create(properties?): SyncdPatch

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

Creates a new SyncdPatch instance using the specified properties.

Parameters​

properties?​

ISyncdPatch

Properties to set

Returns​

SyncdPatch

SyncdPatch instance

decode()​

static decode(reader, length?): SyncdPatch

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

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

SyncdPatch

SyncdPatch

Throws​

If the payload is not a reader or valid buffer

Throws​

If required fields are missing

decodeDelimited()​

static decodeDelimited(reader): SyncdPatch

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

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

Parameters​

reader​

Reader or buffer to decode from

Uint8Array<ArrayBufferLike> | Reader

Returns​

SyncdPatch

SyncdPatch

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

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

Parameters​

message​

ISyncdPatch

SyncdPatch 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:47164

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

Parameters​

message​

ISyncdPatch

SyncdPatch message or plain object to encode

writer?​

Writer

Writer to encode to

Returns​

Writer

Writer

fromObject()​

static fromObject(object): SyncdPatch

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

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

Parameters​

object​

Plain object

Returns​

SyncdPatch

SyncdPatch

getTypeUrl()​

static getTypeUrl(typeUrlPrefix?): string

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

Gets the default type url for SyncdPatch

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

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

Parameters​

message​

SyncdPatch

SyncdPatch

options?​

IConversionOptions

Conversion options

Returns​

object

Plain object

verify()​

static verify(message): null | string

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

Verifies a SyncdPatch message.

Parameters​

message​

Plain object to verify

Returns​

null | string

null if valid, otherwise the reason why it is not