Options
All
  • Public
  • Public/Protected
  • All
Menu

Class PeerClient

Details about a remote WebSync instance.

Hierarchy

  • PeerClient

Index

Constructors

Properties

Methods

Constructors

constructor

  • new PeerClient(instanceId: string, boundRecords: Hash<string, Record>): PeerClient
  • Initializes a new instance of the fm.icelink.websync4.peerClient class.

    Parameters

    • instanceId: string

      The WebSync instance ID.

    • boundRecords: Hash<string, Record>

      The WebSync bound records.

    Returns PeerClient

Properties

Private _boundRecords

_boundRecords: Hash<string, Record>
internal

Private _instanceId

_instanceId: string
internal

Private _state

_state: State
internal

Methods

getBoundRecords

  • getBoundRecords(): Hash<string, Record>
  • Gets the WebSync bound records.

    Returns Hash<string, Record>

getInstanceId

  • getInstanceId(): string
  • Gets the WebSync instance ID.

    Returns string

getState

  • internal

    Returns State

getTypeString

  • getTypeString(): string

  • Returns string

setBoundRecords

  • setBoundRecords(value: Hash<string, Record>): void
  • Sets the WebSync bound records.

    Parameters

    • value: Hash<string, Record>

    Returns void

setInstanceId

  • setInstanceId(value: string): void
  • Sets the WebSync instance ID.

    Parameters

    • value: string

    Returns void

Private setState

  • setState(value: State): void
  • internal

    Parameters

    Returns void

Static createPeerClient

  • createPeerClient(instanceId: string, boundRecords: Hash<string, Record>, state: State): PeerClient
  • internal

    Parameters

    • instanceId: string
    • boundRecords: Hash<string, Record>
    • state: State

    Returns PeerClient