Rooms occupancy subscribe

Use the ably rooms occupancy subscribe command to subscribe to real-time occupancy metrics for a chat room.

Synopsis

ably rooms occupancy subscribe <room-name> [options]

Arguments

room-name

Required

The name of the chat room to subscribe to occupancy metrics for.

Options

--duration | -D

The duration in seconds to subscribe for before automatically unsubscribing.

--client-id

A client ID to use for the subscription.

--json

Output results as compact JSON. Mutually exclusive with --pretty-json.

--pretty-json

Output results in formatted JSON. Mutually exclusive with --json.

--verbose | -v

Enable verbose logging. Can be combined with --json or --pretty-json.

Examples

Subscribe to occupancy metrics for a room:

ably rooms occupancy subscribe my-room

Subscribe for a specific duration:

ably rooms occupancy subscribe my-room --duration 60

Subscribe to room occupancy in JSON format:

ably rooms occupancy subscribe my-room --json

See also

• Rooms — Explore all ably rooms commands.
• CLI reference — Full list of available commands.