RealtimePresence

class RealtimePresence {

constructor(channel: RealtimeChannel, opts?: PresenceOpts);

caller: {

onJoin: PresenceOnJoinCallback;

onLeave: PresenceOnLeaveCallback;

onSync: () => void;

};

enabled: boolean;

joinRef: string | null;

pendingDiffs: RawPresenceDiff[];

}

§Constructors

new RealtimePresence(channel: RealtimeChannel, opts?: PresenceOpts)

Creates a Presence helper that keeps the local presence state in sync with the server.

@param channel

@param opts

Optional custom event names, e.g. { events: { state: 'state', diff: 'diff' } }.

@example

const presence = new RealtimePresence(channel)

channel.on('presence', ({ event, key }) => {
  console.log(`Presence ${event} on ${key}`)
})

caller: {

onJoin: PresenceOnJoinCallback;

onLeave: PresenceOnLeaveCallback;

onSync: () => void;

}

enabled: boolean

joinRef: string | null

pendingDiffs: RawPresenceDiff[]