Class Presence<P>

Presence represents a proxy for the Presence to be manipulated from the outside.

Type Parameters

P extends Indexable

Index

Constructors

Methods

Constructors

constructor

new Presence<P extends Indexable>(
changeContext: ChangeContext,
presence: P,
): Presence<P>
Type Parameters
- P extends Indexable
Parameters
- changeContext: ChangeContext
- presence: P
Returns Presence<P>
- Defined in document/presence/presence.ts:28

Methods

clear

clear(): void
clear clears the presence.

Returns void
- Defined in document/presence/presence.ts:59

get

get<K extends string | number | symbol>(key: K): P[K]
get returns the presence value of the given key.
Type Parameters
- K extends string | number | symbol
Parameters
- key: K
Returns P[K]
- Defined in document/presence/presence.ts:52

set

set(presence: Partial<P>, option?: { addToHistory: boolean }): void
set updates the presence based on the partial presence.
Parameters
- presence: Partial<P>
- Optionaloption: { addToHistory: boolean }
Returns void
- Defined in document/presence/presence.ts:36