Occupancy

Occupancy enables you to view the number of users currently online in a room. This feature can be used to display user counts to highlight popular, or trending chat rooms.

Subscribe to a room’s occupancy by registering a listener. Occupancy events are emitted whenever the number of online users within a room changes. Use the occupancy.subscribe() method in a room to receive updates:

JavaScript
Select...

const {unsubscribe} = room.occupancy.subscribe((event) => {
  console.log(event);
});

Copy
Copied!

The following is the structure of an occupancy event:

{
  "connections": 103;
  "presenceMembers": 95;
}

Copy
Copied!

The following are the properties of an occupancy event:

Unsubscribe from room occupancy to remove previously registered listeners.

Use the unsubscribe() function returned in the subscribe() response to remove a listener:

JavaScript
Select...

// Initial subscription
const { unsubscribe } = room.occupancy.subscribe((event) => {
  console.log(event);
});


// To remove the listener
unsubscribe();

Copy
Copied!

Use the occupancy.unsubscribeAll() method to remove all occupancy listeners in a room:

JavaScript
Select...

await room.occupancy.unsubscribeAll();

Copy
Copied!

The occupancy of a room can be retrieved in one-off calls instead of subscribing to updates.

Use the occupancy.get() method to retrieve the occupancy of a room:

JavaScript
Select...

const occupancy = await room.occupancy.get();

Copy
Copied!

The following is the structure of an occupancy event:

{
  "connections": 103;
  "presenceMembers": 95;
}

Copy
Copied!

The following are the properties of an occupancy event: