Interface: PresenceClientConfig

Defined in: config.ts:10

Properties

listener

listener: IndicatorListener;

Defined in: config.ts:25

receiveIndicators

receiveIndicators: (indicators: Record<string, PresenceIndicator>) => void;

Defined in: config.ts:24

Receives an array of indicators and merges them into your local editor state. This function should use receivePresenceTransaction to merge the indicators into the local editor state.

Parameters

indicators

Record<string, PresenceIndicator>

Returns

void

sendIndicator

sendIndicator: (clientId: string, indicator: PresenceIndicator) => Promise<void>;

Defined in: config.ts:18

Sends local indicator state to a remote server to be merged into the remote presence state. The endpoint this function hits is defined by you, and should call the PresenceAuthority's updatePresence function.

Parameters

clientId

string

indicator

PresenceIndicator

Returns

Promise<void>

userId

userId: string;

Defined in: config.ts:11