Class: SyncdSnapshot

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

Represents a SyncdSnapshot.

Implements

• ISyncdSnapshot

Constructors

new SyncdSnapshot()

new SyncdSnapshot(properties?): SyncdSnapshot

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

Constructs a new SyncdSnapshot.

Parameters

properties?

ISyncdSnapshot

Properties to set

Returns

SyncdSnapshot

Properties

keyId?

optional keyId: null | IKeyId

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

SyncdSnapshot keyId.

Implementation of

ISyncdSnapshot.keyId

---

mac?

optional mac: null | Uint8Array<ArrayBufferLike>

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

SyncdSnapshot mac.

Implementation of

ISyncdSnapshot.mac

---

records

records: ISyncdRecord[]

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

SyncdSnapshot records.

Implementation of

ISyncdSnapshot.records

---

version?

optional version: null | ISyncdVersion

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

SyncdSnapshot version.

Implementation of

ISyncdSnapshot.version

Methods

toJSON()

toJSON(): object

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

Converts this SyncdSnapshot to JSON.

Returns

object

JSON object

---

create()

static create(properties?): SyncdSnapshot

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

Creates a new SyncdSnapshot instance using the specified properties.

Parameters

properties?

ISyncdSnapshot

Properties to set

Returns

SyncdSnapshot

SyncdSnapshot instance

---

decode()

static decode(reader, length?): SyncdSnapshot

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

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

SyncdSnapshot

SyncdSnapshot

Throws

If the payload is not a reader or valid buffer

Throws

If required fields are missing

---

decodeDelimited()

static decodeDelimited(reader): SyncdSnapshot

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

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

Parameters

reader

Reader or buffer to decode from

Uint8Array<ArrayBufferLike> | Reader

Returns

SyncdSnapshot

SyncdSnapshot

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

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

Parameters

message

ISyncdSnapshot

SyncdSnapshot 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:50475

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

Parameters

message

ISyncdSnapshot

SyncdSnapshot message or plain object to encode

writer?

Writer

Writer to encode to

Returns

Writer

Writer

---

fromObject()

static fromObject(object): SyncdSnapshot

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

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

Parameters

object

Plain object

Returns

SyncdSnapshot

SyncdSnapshot

---

getTypeUrl()

static getTypeUrl(typeUrlPrefix?): string

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

Gets the default type url for SyncdSnapshot

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

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

Parameters

message

SyncdSnapshot

SyncdSnapshot

options?

IConversionOptions

Conversion options

Returns

object

Plain object

---

verify()

static verify(message): null | string

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

Verifies a SyncdSnapshot message.

Parameters

message

Plain object to verify

Returns

null | string

null if valid, otherwise the reason why it is not