Presence API for Kotlin SDK

Breaking changes in v9.0.0

PubNub Kotlin SDK version 9.0.0 unifies the codebases for Kotlin and Java SDKs, introduces a new way of instantiating the PubNub client, and changes asynchronous API callbacks and emitted status events. These changes can impact applications built with previous versions (< 9.0.0 ) of the Kotlin SDK.

For more details about what has changed, refer to Java/Kotlin SDK migration guide.

Presence enables you to track the online and offline status of users and devices in real time and store custom state information. Presence provides authoritative information on:

When a user has joined or left a channel
Who, and how many, users are subscribed to a particular channel
Which channel(s) an individual user is subscribed to
Associated state information for these users

Learn more about our Presence feature here.

Request execution

Most PubNub Kotlin SDK method invocations return an Endpoint object, which allows you to decide whether to perform the operation synchronously or asynchronously.

You must invoke the .sync() or .async() method on the Endpoint to execute the request, or the operation will not be performed.

val channel = pubnub.channel("channelName")

channel.publish("This SDK rules!").async { result ->
    result.onFailure { exception ->
        // Handle error
    }.onSuccess { value ->
        // Handle successful method result
    }
}

Here Now

Requires Presence

This method requires that the Presence add-on is enabled for your key in the Admin Portal.

You can 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 by calling the hereNow() function in your application.

Cache

This method has a 3 second response cache time.

Method(s)

To call Here Now you can use the following methods in the Kotlin SDK:

pubnub.hereNow(
    channels: List<String>,
    channelGroups: List<String>,
    includeState: Boolean,
    includeUUIDs: Boolean
).async { result -> }

* required

Parameter	Description
`channels` Type: `List<String>` Default: n/a	The `channels` to get the 'here now' details of.
`channelGroups` Type: `List<String>` Default: n/a	The `channelGroups` to get the 'here now' details of.
`includeState` Type: `Boolean` Default: `false`	If `true`, the response will include the presence states of the users for `channels`/`channelGroups`.
`includeUUIDs` Type: `Boolean` Default: `true`	If true, the response will include the `UUIDs` of the connected clients.

Basic Usage

Reference code

This example is a self-contained code snippet ready to be run. It includes necessary imports and executes methods with console logging. Use it as a reference when working with other examples in this document.

Get a list of UUIDs subscribed to channel

import com.pubnub.api.PubNub
import com.pubnub.api.UserId
import com.pubnub.api.v2.PNConfiguration
import com.pubnub.api.enums.PNLogVerbosity

fun main() {
    println("PubNub hereNow() Example")
    println("========================")
    
    // Configure PubNub
    val userId = UserId("here-now-demo-user")
    val config = PNConfiguration.builder(userId, "demo").apply {
        publishKey = "demo"
        logVerbosity = PNLogVerbosity.BODY // Enable debug logging
    }.build()
show all 150 lines

Returns

The hereNow() operation returns a PNHereNowResult? which contains the following operations:

Method	Description
`totalChannels` Type: `Int`	Total channels
`totalOccupancy` Type: `Int`	Total occupancy
`channels` Type: `Map<String, PNHereNowChannelData>`	A map with values of `PNHereNowChannelData` for each channel. See PNHereNowChannelData for more details.

PNHereNowChannelData

Method	Description
`channelName` Type: `String`	Channel name
`occupancy` Type: `Int`	Occupancy of the channel
`occupants` Type: `List<PNHereNowOccupantData>`	A list of `PNHereNowOccupantData`, see PNHereNowOccupantData for more details.

PNHereNowOccupantData

Method	Description
`uuid` Type: `String`	UUID of the user
`state` Type: `JsonElement?`	State of the user

Other Examples

Returning State

Requires Presence

This method requires that the Presence add-on is enabled for your key in the Admin Portal.

pubnub.hereNow(
    channels = listOf("ch1", "ch2"),
    includeState = true
).async { result ->  }

Example response:

.async { result: Result<PNHereNowResult> ->
    result.onSuccess { res: PNHereNowResult ->
        res.channels.values.forEach { channelData ->
            channelData.channelName // ch1
            channelData.occupancy // 3
            channelData.occupants.forEach { o ->
                o.uuid // some_uuid, returned by default
                o.state // {"data":{"isTyping":true}}, requested
            }
        }
    }.onFailure { e ->
        // handle error
        e.message
        e.statusCode
        e.pubnubError
show all 17 lines

Return Occupancy Only

Requires Presence

This method requires that the Presence add-on is enabled for your key in the Admin Portal.

You can return only the occupancy information for a single channel by specifying the channel and setting UUIDs to false:

pubnub.hereNow(
    channels = listOf("my_channel"), // who is present on those channels?
    includeUUIDs = false, // if false, only shows occupancy count
    includeState = false // include state with request (false by default)
).async { result -> }

Example response:

.async { result: Result<PNHereNowResult> ->
    result.onSuccess { res: PNHereNowResult ->
        res.channels.values.forEach { channelData ->
            channelData.channelName // ch1
            channelData.occupancy // 3
        }
    }.onFailure { e ->
        // handle error
        e.message
        e.statusCode
        e.pubnubError
    }
}

Here Now for Channel Groups

pubnub.hereNow(
    channelGroups = listOf("cg1", "cg2", "cg3"),  // who is present on those channels groups
    includeState = true, // include state with request (false by default)
    includeUUIDs = true // if false, only shows occupancy count
).async { result -> }

Example response:

.async { result: Result<PNHereNowResult> ->
    result.onSuccess { res: PNHereNowResult ->
        res.totalOccupancy
    }.onFailure { e ->
        // handle error
        e.message
        e.statusCode
        e.pubnubError
    }
}

Where Now

Requires Presence

This method requires that the Presence add-on is enabled for your key in the Admin Portal.

You can obtain information about the current list of channels to which a UUID is subscribed to by calling the whereNow() function in your application.

Timeout events

If the app is killed/crashes and restarted (or the page containing the PubNub instance is refreshed on the browser) within the heartbeat window no timeout event is generated.

Method(s)

To call whereNow() you can use the following method(s) in the Kotlin SDK:

pubnub.whereNow(
    uuid: String
).async { result -> }

* required

Parameter	Description
`uuid` Type: `String` Default: n/a	UUID of the user to get its current channel subscriptions.

Basic Usage

You simply need to define the uuid and the callback function to be used to send the data to as in the example below.

Get a list of channels a UUID is subscribed to

pubnub.whereNow()
    .async { result ->
        result.onFailure { exception ->
            // Handle error
        }.onSuccess { value ->
            // Handle successful method result
        }

Returns

The whereNow() operation returns a PNWhereNowResult? which contains the following operations:

Method	Description
`channels` Type: `List<String>`	List of channels where the `uuid` is present.

Other Examples

Obtain information about the current list of channels of some other UUID

pubnub.whereNow(
    uuid = "someUuid"
).async { result ->
    result.onFailure { exception ->
        // Handle error
    }.onSuccess { value ->
        // Handle successful method result
    }

User State

Requires Presence

This method requires that the Presence add-on is enabled for your key in the Admin Portal.

Clients can set a dynamic custom state (score, game state, location) for their users on one or more channels and store it on a channel as long as the user stays subscribed.

The state is not persisted, and when the client disconnects, the state data is lost. For more information, refer to Presence State.

Presence state format

Presence state must be expressed as a JsonObject. When calling setState, be sure to supply an initialized JsonObject or POJO which can be serialized to a JsonObject.

Method(s)

To set the state, call setPresenceState() you can use the following method(s) in the Kotlin SDK:

Set State

pubnub.setPresenceState(
    channels: List<String>,
    channelGroups: List<String>,
    state: Any,
    uuid: String
).async { result -> }

* required

Parameter	Description
`channels` Type: `List<String>` Default: n/a	Channels to set state to.
`channelGroups` Type: `List<String>` Default: n/a	Channel groups to set state to.
`state` Type: `Any` Default: n/a	The state to set.
`uuid` Type: `String` Default: n/a	The UUID to set state for.

Get State

pubnub.getPresenceState(
    channels: List<String>,
    channelGroups: List<String>,
    uuid: String
).async { result -> }

To get the state, call getPresenceState() you can use the following method(s) in the Kotlin SDK:

* required

Parameter	Description
`channels` Type: `List<String>` Default: n/a	Channels to get state of.
`channelGroups` Type: `List<String>` Default: n/a	Channel groups to get state of.
`uuid` Type: `String` Default: n/a	The UUID to get state for.

Basic Usage

//set state
pubnub.setPresenceState(
    channels = listOf("my_channel"),
    state = mapOf("is_typing" to "true")
    // if no uuid supplied, own is used
).async { result -> }


// get state
pubnub.getPresenceState(
    channels = listOf("ch1", "ch2", "ch3"), // channels to fetch state for
    uuid = "such_uuid" // uuid of user to fetch, or own uuid by default
).async { result -> }

Returns

The setPresenceState() operation returns a PNSetStateResult? which contains the following operations:

Method	Description
`state` Type: `JsonElement`	The actual state object

The getPresenceState() operation returns a PNSetStateResult? which contains the following operations:

Method	Description
`stateByUUID` Type: `Map<String, JsonElement>`	Map of UUIDs and the user states.

Other Examples

Set state for channels in channel group

pubnub.setPresenceState(
    channels = listOf("ch1", "ch2", "ch3"), // apply on those channels
    channelGroups = listOf("cg1", "cg2", "cg3"), // apply on those channel groups
    state = JsonObject().apply { addProperty("is_typing", true) }
).async { result ->}

.async { result ->
    result.onSuccess { res ->
        res.state // {"data":{"is_typing":true}}
    }.onFailure { e ->
        // handle error
        e.message
        e.statusCode
        e.pubnubError
        
    }
}if (!status.error) {
result!!.state // {"data":{"isTyping":true}}
} else {
// handle error
status.exception?.printStackTrace()
show all 16 lines

Get state for UUID

pubnub.getPresenceState(
    channels = listOf("ch1", "ch2"), // channels to fetch state for
    uuid = "such_uuid" // uuid of user to fetch, or own uuid by default
).async { result ->
    result.onFailure { exception ->
        exception.printStackTrace()
    }.onSuccess { value ->
        value!!.stateByUUID.forEach { (channel, state) ->
            println("Channel: $channel, state: $state")
        }
    }
}

Breaking changes in v9.0.0

Request execution

Here Now​

Requires Presence

Cache

Method(s)​

Basic Usage​

Reference code

Get a list of UUIDs subscribed to channel​

Returns​

PNHereNowChannelData​

PNHereNowOccupantData​

Other Examples​

Returning State​

Requires Presence

Return Occupancy Only​

Requires Presence

Here Now for Channel Groups​

Where Now​

Requires Presence

Timeout events

Method(s)​

Basic Usage​

Get a list of channels a UUID is subscribed to​

Returns​

Other Examples​

Obtain information about the current list of channels of some other UUID​

User State​

Requires Presence

Presence state format

Method(s)​

Set State​

Get State​

Basic Usage​

Returns​

Other Examples​

Set state for channels in channel group​

Get state for UUID​

Here Now

Method(s)

Basic Usage

Get a list of UUIDs subscribed to channel

Returns

PNHereNowChannelData

PNHereNowOccupantData

Other Examples

Returning State

Return Occupancy Only

Here Now for Channel Groups

Where Now

Method(s)

Basic Usage

Get a list of channels a UUID is subscribed to

Returns

Other Examples

Obtain information about the current list of channels of some other UUID

User State

Method(s)

Set State

Get State

Basic Usage

Returns

Other Examples

Set state for channels in channel group

Get state for UUID