Class Presence<P>

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

Type Parameters

P extends Indexable

Index

Constructors

Properties

context presence

Methods

Constructors

constructor

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

Properties

`Private` context

context: ChangeContext<Indexable>

`Private` presence

presence: P

Methods

clear

clear(): void
Internal
clear clears the presence.

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

get

get<K>(key): 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:67

set

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