Options
All
  • Public
  • Public/Protected
  • All
Menu

Class SyncdPatch

Represents a SyncdPatch.

Hierarchy

  • SyncdPatch

Implements

Index

Constructors

Properties

Methods

Constructors

constructor

Properties

deviceIndex

deviceIndex: number

SyncdPatch deviceIndex.

Optional exitCode

exitCode: IExitCode

SyncdPatch exitCode.

Optional externalMutations

externalMutations: IExternalBlobReference

SyncdPatch externalMutations.

Optional keyId

keyId: IKeyId

SyncdPatch keyId.

mutations

mutations: ISyncdMutation[]

SyncdPatch mutations.

patchMac

patchMac: Uint8Array

SyncdPatch patchMac.

snapshotMac

snapshotMac: Uint8Array

SyncdPatch snapshotMac.

Optional version

version: ISyncdVersion

SyncdPatch version.

Methods

toJSON

  • toJSON(): {}

Static create

Static decode

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

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

    SyncdPatch

Static decodeDelimited

  • decodeDelimited(reader: Uint8Array | Reader): SyncdPatch

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

    SyncdPatch

Static encode

  • encode(message: ISyncdPatch, writer?: Writer): Writer

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

    Parameters

    • message: ISyncdPatch

      SyncdPatch message or plain object to encode

    • Optional writer: Writer

    Returns Writer

    Writer

Static encodeDelimited

  • encodeDelimited(message: ISyncdPatch, writer?: Writer): Writer

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

    Parameters

    • message: ISyncdPatch

      SyncdPatch message or plain object to encode

    • Optional writer: Writer

    Returns Writer

    Writer

Static fromObject

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

    Parameters

    • object: {}

      Plain object

      • [k: string]: any

    Returns SyncdPatch

    SyncdPatch

Static toObject

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

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

    Parameters

    • message: SyncdPatch

      SyncdPatch

    • Optional options: IConversionOptions

    Returns {}

    Plain object

    • [k: string]: any

Static verify

  • verify(message: {}): string

  • Verifies a SyncdPatch 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