pubnub-kotlin-api/com.pubnub.api/PubNub/hereNow

hereNow

expect abstract fun hereNow(channels: List<String> = emptyList(), channelGroups: List<String> = emptyList(), includeState: Boolean = false, includeUUIDs: Boolean = true, limit: Int = 1000, offset: Int? = null): HereNow

actual abstract fun hereNow(channels: List<String>, channelGroups: List<String>, includeState: Boolean, includeUUIDs: Boolean, limit: Int, offset: Int?): HereNow

Obtain information about the current state of a channel including a list of unique user IDs currently subscribed to the channel and the total occupancy count of the channel.

Parameters

channels

The channels to get the 'here now' details of. Leave empty for a 'global here now'.

channelGroups

The channel groups to get the 'here now' details of. Leave empty for a 'global here now'.

includeState

Whether the response should include presence state information, if available. Defaults to false.

includeUUIDs

Whether the response should include UUIDs od connected clients. Defaults to true.

limit

Maximum number of occupants to return per channel. Valid range: 0-1000. - Default: 1000 - Use 0 to get occupancy counts without user details

offset

Zero-based starting index for pagination. Returns occupants starting from this position in the list. Must be >= 0. - Default: null (no offset)

actual abstract fun hereNow(channels: List<String>, channelGroups: List<String>, includeState: Boolean, includeUUIDs: Boolean, limit: Int, offset: Int?): HereNow