This is the official PubNub Kotlin SDK repository.
PubNub takes care of the infrastructure and APIs needed for the realtime communication layer of your application. Work on your app's logic and let PubNub handle sending and receiving data across the world in less than 100ms.
You will need the publish and subscribe keys to authenticate your app. Get your keys from the Admin Portal.
-
Integrate the Kotlin SDK into your project:
-
for Maven, add the following dependency in your
pom.xml:<dependency> <groupId>com.pubnub</groupId> <artifactId>pubnub-kotlin</artifactId> <version>10.1.0</version> </dependency>
-
for Gradle, add the following dependency in your
gradle.build:implementation ("com.pubnub:pubnub-kotlin:10.0.0")
-
-
Configure your keys and create PubNub instance:
val config = PNConfiguration.builder(UserId("myUserId"), "mySubKey") { publishKey = "myPubKey" } val pubnub = PubNub.create(config.build())
pubnub.addListener(object : SubscribeCallback() {
override fun status(pubnub: PubNub, status: PNStatus) {
println("Status category: ${status.category}")
// PNConnectedCategory, PNReconnectedCategory, PNDisconnectedCategory
println("Status operation: ${status.operation}")
// PNSubscribeOperation, PNHeartbeatOperation
println("Status error: ${status.error}")
// true or false
}
override fun presence(pubnub: PubNub, pnPresenceEventResult: PNPresenceEventResult) {
println("Presence event: ${pnPresenceEventResult.event}")
println("Presence channel: ${pnPresenceEventResult.channel}")
println("Presence uuid: ${pnPresenceEventResult.uuid}")
println("Presence timetoken: ${pnPresenceEventResult.timetoken}")
println("Presence occupancy: ${pnPresenceEventResult.occupancy}")
}
override fun message(pubnub: PubNub, pnMessageResult: PNMessageResult) {
println("Message payload: ${pnMessageResult.message}")
println("Message channel: ${pnMessageResult.channel}")
println("Message publisher: ${pnMessageResult.publisher}")
println("Message timetoken: ${pnMessageResult.timetoken}")
}
override fun signal(pubnub: PubNub, pnSignalResult: PNSignalResult) {
println("Signal payload: ${pnSignalResult.message}")
println("Signal channel: ${pnSignalResult.channel}")
println("Signal publisher: ${pnSignalResult.publisher}")
println("Signal timetoken: ${pnSignalResult.timetoken}")
}
override fun messageAction(pubnub: PubNub, pnMessageActionResult: PNMessageActionResult) {
with(pnMessageActionResult.messageAction) {
println("Message action type: $type")
println("Message action value: $value")
println("Message action uuid: $uuid")
println("Message action actionTimetoken: $actionTimetoken")
println("Message action messageTimetoken: $messageTimetoken")
}
println("Message action subscriptions: ${pnMessageActionResult.subscription}")
println("Message action channel: ${pnMessageActionResult.channel}")
println("Message action timetoken: ${pnMessageActionResult.timetoken}")
}
})pubnub.publish(channel = "my_channel", message = "hello")
.async { result ->
// the result is always of a nullable type
// it's null if there were errors (status.error)
// otherwise it's usable
// handle publish result
result.onSuccess { res ->
println("Message timetoken: ${res!!.timetoken}")
}.onFailure { exception ->
// handle error
exception.printStackTrace()
}
}
pubnub.subscribe(channels = listOf("my_channel"))If you need help or have a general question, contact [email protected].