Class RealtimePresence

Hierarchy

  • RealtimePresence

Constructors

constructor

Properties

caller channel enabled joinRef pendingDiffs state

Constructors

constructor

  • Initializes the Presence.

    Parameters

    • channel: RealtimeChannel

      The RealtimeChannel

    • Optional opts: PresenceOpts

      The options, for example {events: {state: 'state', diff: 'diff'}}

    Returns RealtimePresence

Properties

caller

caller: {
    onJoin: PresenceOnJoinCallback;
    onLeave: PresenceOnLeaveCallback;
    onSync: (() => void);
}

Type declaration

  • onJoin: PresenceOnJoinCallback
  • onLeave: PresenceOnLeaveCallback
  • onSync: (() => void)
      • (): void

      • Returns void

channel

channel: RealtimeChannel

enabled

enabled: boolean

joinRef

joinRef: null | string

pendingDiffs

pendingDiffs: RawPresenceDiff[]

state

state: RealtimePresenceState<{}>

Settings

Member Visibility

Theme

Generated using TypeDoc