PresenceReferencePresence clientIndexClasses
PresenceClient
Class: PresenceClient
Defined in: index.ts:19
The client that manages sending local presence state to the remote server and listening for remote changes to presence state.
Constructors
Constructor
new PresenceClient(config: PresenceClientConfig): PresenceClient;Defined in: index.ts:28
Parameters
config
Returns
PresenceClient
Methods
listen()
listen(signal?: AbortSignal): Promise<void>;Defined in: index.ts:88
Start listening for remote presence changes. This function should only be called once.
Parameters
signal?
AbortSignal
Returns
Promise<void>
send()
send(editorState: EditorState): Promise<void>;Defined in: index.ts:39
Send updated presence state to the remote PresenceAuthority.
Parameters
editorState
EditorState
Returns
Promise<void>
update()
update(config: Partial<Omit<PresenceClientConfig, "listener">>): void;Defined in: index.ts:80
Updates the desired portion of the client's PresenceClientConfig. For example, this can be used to
update the auth headers used by send.
Parameters
config
Partial<Omit<PresenceClientConfig,
"listener">>
Returns
void