peekChannel

fun peekChannel(channelKey: String): Deferred<Result<Long>>

peekChannel reads the current session count of a channel without creating a session on the server. Use this when the caller only needs to display the count (e.g. "N people writing") without contributing to it and without receiving broadcasts.

Unlike attaching, this does not occupy a session entry on the server, does not generate heartbeat RPCs, and does not subscribe to channel events. Polling is the caller's responsibility.

Return

The current online session count of the channel.

Parameters

channelKey

The key of the channel to peek.