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 {
    get channel(): RealtimeChannel;
    get(): Promise<OccupancyEvent>;
    onDiscontinuity(listener: DiscontinuityListener): OnDiscontinuitySubscriptionResponse;
    subscribe(listener: OccupancyListener): OccupancySubscriptionResponse;
    unsubscribeAll(): void;
}

Hierarchy

EmitsDiscontinuities
- Occupancy

Index

Accessors

Methods

get onDiscontinuity subscribe unsubscribeAll

Accessors

channel

get channel(): RealtimeChannel
Get underlying Ably channel for occupancy events.

Returns RealtimeChannel
The underlying Ably channel for occupancy events.
- Defined in src/core/occupancy.ts:52

Methods

get

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

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

onDiscontinuity

onDiscontinuity(listener): OnDiscontinuitySubscriptionResponse
Register a listener to be called when a discontinuity is detected.
Parameters
- listener: DiscontinuityListener
  The listener to be called when a discontinuity is detected.
Returns OnDiscontinuitySubscriptionResponse
A response that allows control of the subscription.
Inherited from EmitsDiscontinuities.onDiscontinuity
- Defined in src/core/discontinuity.ts:46

subscribe

subscribe(listener): OccupancySubscriptionResponse
Subscribe a given listener to occupancy updates of the chat room.
Parameters
- listener: OccupancyListener
  A listener to be called when the occupancy of the room changes.
Returns OccupancySubscriptionResponse
A promise resolves to the channel attachment state change event from the implicit channel attach operation.
- Defined in src/core/occupancy.ts:33

unsubscribeAll

unsubscribeAll(): void
Unsubscribe all listeners from the occupancy updates of the chat room.

Returns void
- Defined in src/core/occupancy.ts:38