Options
All
  • Public
  • Public/Protected
  • All
Menu

Class SyncdSnapshot

Represents a SyncdSnapshot.

Hierarchy

  • SyncdSnapshot

Implements

Index

Constructors

Properties

Methods

Constructors

constructor

Properties

Optional keyId

keyId: IKeyId

SyncdSnapshot keyId.

mac

mac: Uint8Array

SyncdSnapshot mac.

records

records: ISyncdRecord[]

SyncdSnapshot records.

Optional version

version: ISyncdVersion

SyncdSnapshot version.

Methods

toJSON

  • toJSON(): {}

Static create

Static decode

  • decode(reader: Uint8Array | Reader, length?: number): SyncdSnapshot

  • Decodes a SyncdSnapshot message from the specified reader or buffer.

    throws

    {Error} If the payload is not a reader or valid buffer

    throws

    {$protobuf.util.ProtocolError} If required fields are missing

    Parameters

    • reader: Uint8Array | Reader

      Reader or buffer to decode from

    • Optional length: number

    Returns SyncdSnapshot

    SyncdSnapshot

Static decodeDelimited

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

    throws

    {Error} If the payload is not a reader or valid buffer

    throws

    {$protobuf.util.ProtocolError} If required fields are missing

    Parameters

    • reader: Uint8Array | Reader

      Reader or buffer to decode from

    Returns SyncdSnapshot

    SyncdSnapshot

Static encode

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

    Parameters

    • message: ISyncdSnapshot

      SyncdSnapshot message or plain object to encode

    • Optional writer: Writer

    Returns Writer

    Writer

Static encodeDelimited

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

    Parameters

    • message: ISyncdSnapshot

      SyncdSnapshot message or plain object to encode

    • Optional writer: Writer

    Returns Writer

    Writer

Static fromObject

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

    Parameters

    • object: {}

      Plain object

      • [k: string]: any

    Returns SyncdSnapshot

    SyncdSnapshot

Static toObject

  • toObject(message: SyncdSnapshot, options?: IConversionOptions): {}

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

    Parameters

    • message: SyncdSnapshot

      SyncdSnapshot

    • Optional options: IConversionOptions

    Returns {}

    Plain object

    • [k: string]: any

Static verify

  • verify(message: {}): string

  • Verifies a SyncdSnapshot message.

    Parameters

    • message: {}

      Plain object to verify

      • [k: string]: any

    Returns string

    null if valid, otherwise the reason why it is not

Generated using TypeDoc