pubnub-kotlin-core-api/com.pubnub.api.models.consumer.pubsub/PNPresenceEventResult

PNPresenceEventResult

class PNPresenceEventResult(val event: String? = null, val uuid: String? = null, val timestamp: Long? = null, val occupancy: Int? = null, val state: JsonElement? = null, val channel: String, val subscription: String? = null, val timetoken: Long? = null, val join: List<String>? = null, val leave: List<String>? = null, val timeout: List<String>? = null, val hereNowRefresh: Boolean? = null, val userMetadata: Any? = null) : PNEvent

Wrapper around a presence event.

Constructors

Link copied to clipboard
constructor(event: String? = null, uuid: String? = null, timestamp: Long? = null, occupancy: Int? = null, state: JsonElement? = null, channel: String, subscription: String? = null, timetoken: Long? = null, join: List<String>? = null, leave: List<String>? = null, timeout: List<String>? = null, hereNowRefresh: Boolean? = null, userMetadata: Any? = null)

Properties

Link copied to clipboard
open override val channel: String

The channel which the event is performed on.

Link copied to clipboard
val event: String? = null

The presence event. Could be join, leave, state-change or interval.

Link copied to clipboard
val hereNowRefresh: Boolean? = null

Indicates to the user that a manual HereNow should be called to get the complete list of users present in the channel.

Link copied to clipboard
val join: List<String>? = null

List of users that have joined the channel if the event is an interval. This needs to be enabled under presence_deltas at the Admin Dashboard.

Link copied to clipboard
val leave: List<String>? = null

List of users that have left the channel if the event is an interval. This needs to be enabled under presence_deltas at the Admin Dashboard.

Link copied to clipboard
val occupancy: Int? = null

Total number of users currently present in the channel in question.

Link copied to clipboard
val state: JsonElement? = null

Presence state of the related UUID, if any.

Link copied to clipboard
open override val subscription: String? = null

The related subscriptions.

Link copied to clipboard
val timeout: List<String>? = null

List of users that have timed out of the channel if the event is an interval. This needs to be enabled under presence_deltas at the Admin Dashboard.

Link copied to clipboard
val timestamp: Long? = null

The timestamp of the event.

Link copied to clipboard
open override val timetoken: Long? = null

The timetoken of the event.

Link copied to clipboard
val userMetadata: Any? = null

User metadata if any.

Link copied to clipboard
val uuid: String? = null

The UUID which the presence event is related to.

Functions

Link copied to clipboard
open operator override fun equals(other: Any?): Boolean
Link copied to clipboard
open override fun hashCode(): Int