Interface Occupancy

This interface is used to interact with occupancy in a chat room: subscribing to occupancy updates and fetching the current room occupancy metrics.

Get an instance via Room.occupancy.

interface Occupancy {
    current(): undefined | OccupancyData;
    get(): Promise<OccupancyData>;
    subscribe(listener: OccupancyListener): Subscription;
}

Index

Methods

current get subscribe

Methods

current

current(): undefined | OccupancyData
Get the latest occupancy data received from realtime events.

Returns undefined | OccupancyData
The latest occupancy data, or undefined if no realtime events have been received yet.

Throws
If occupancy events are not enabled for this room.
- Defined in src/core/occupancy.ts:44

get

get(): Promise<OccupancyData>
Get the current occupancy of the chat room.

Returns Promise<OccupancyData>
A promise that resolves to the current occupancy of the chat room.
- Defined in src/core/occupancy.ts:36

subscribe(listener: OccupancyListener): Subscription
Subscribe a given listener to occupancy updates of the chat room.

Note: This requires occupancy events to be enabled via the enableEvents option in the OccupancyOptions options provided to the room. If this is not enabled, an error will be thrown.
Parameters
- listener: OccupancyListener
  A listener to be called when the occupancy of the room changes.
Returns Subscription
A subscription object that can be used to unsubscribe the listener.

Throws
If occupancy events are not enabled for this room.
- Defined in src/core/occupancy.ts:29