Interface: PresenceEngine\<TPresence\>

@roomful/core

---

@roomful/core / PresenceEngine

Interface: PresenceEngine<TPresence>

Defined in: packages/core/src/types.ts:983

Exposes presence operations for a room.

Type Parameters

TPresence

TPresence extends PresenceData = PresenceData

The custom peer presence shape.

Methods

get()

get(peerId): Peer<TPresence> | null

Defined in: packages/core/src/types.ts:1014

Looks up a peer by identifier.

Parameters

peerId

string

The peer identifier to resolve.

Returns

Peer<TPresence> | null

The matching peer when present, otherwise null.

---

getAll()

getAll(): Peer<TPresence>[]

Defined in: packages/core/src/types.ts:1021

Returns every known peer, including the local peer.

Returns

Peer<TPresence>[]

A snapshot of all known peers.

---

getSelf()

getSelf(): Peer<TPresence>

Defined in: packages/core/src/types.ts:1028

Returns the local peer snapshot.

Returns

Peer<TPresence>

The local peer.

---

replace()

replace(this, data): void

Defined in: packages/core/src/types.ts:998

Replaces the local presence payload.

Parameters

this

void

data

Partial<TPresence>

The partial presence payload to publish for the local peer.

Returns

void

Nothing.

---

subscribe()

subscribe(cb): Unsubscribe

Defined in: packages/core/src/types.ts:1006

Subscribes to peer presence changes.

Parameters

cb

(peers) => void

The callback invoked with the full peer list.

Returns

Unsubscribe

A function that removes the listener.

---

update()

update(this, data): void

Defined in: packages/core/src/types.ts:990

Partially updates the local presence payload.

Parameters

this

void

data

Partial<TPresence>

The partial presence payload to merge into the local peer.

Returns

void

Nothing.