PresenceReferencePresence serverInterfaces
PresenceAuthorityConfig
Interface: PresenceAuthorityConfig
Defined in: index.ts:22
Properties
broadcastManager
broadcastManager: {
broadcastIndicator: (docId: string, indicator: PresenceIndicator) => Promise<void>;
listenForPresence: (docId: string, clientId: string, refs: Record<string, string>) =>
Promise<void>;
}Defined in: index.ts:33
Creates listeners for updates to presence state and sends notifications to listeners when presence state is updated. See RedisPresenceBroadcastManager
broadcastIndicator
broadcastIndicator: (docId: string, indicator: PresenceIndicator) => Promise<void>;Parameters
docId
string
indicator
Returns
Promise<void>
listenForPresence
listenForPresence: (docId: string, clientId: string, refs: Record<string, string>) => Promise<void>;Parameters
docId
string
clientId
string
refs
Record<string, string>
Returns
Promise<void>
persistenceManager
persistenceManager: {
getIndicators: (docId: string) => Promise<Record<string, PresenceIndicator>>;
saveIndicator: (docId: string, indicator: PresenceIndicator) => Promise<void>;
}Defined in: index.ts:26
Saves and retrieves presence state. For example, see the RedisPresencePersistenceManager
getIndicators
getIndicators: (docId: string) => Promise<Record<string, PresenceIndicator>>;Parameters
docId
string
Returns
Promise<Record<string,
PresenceIndicator>>
saveIndicator
saveIndicator: (docId: string, indicator: PresenceIndicator) => Promise<void>;Parameters
docId
string
indicator
Returns
Promise<void>