Rooms presence get

Use the ably rooms presence get command to get all current presence members in a chat room.

Synopsis

ably rooms presence get <room-name> [options]

Arguments

room-name

Required

The name of the chat room to get presence members for.

Options

--limit

The maximum number of presence members to return. Defaults to 100.

--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

Get all presence members in a room:

ably rooms presence get my-room

Get presence members with a limit:

ably rooms presence get my-room --limit 10

Get room presence members in JSON format:

ably rooms presence get my-room --json

Get room presence members in formatted JSON output:

ably rooms presence get my-room --pretty-json

See also

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