subscribe

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

expect abstract fun subscribe(channels: List<String> = emptyList(), channelGroups: List<String> = emptyList(), withPresence: Boolean = false, withTimetoken: Long = 0)

actual abstract fun subscribe(channels: List<String>, channelGroups: List<String>, withPresence: Boolean, withTimetoken: Long)

Causes the client to create an open TCP socket to the PubNub Real-Time Network and begin listening for messages on a specified channel.

To subscribe to a channel the client must send the appropriate PNConfiguration.subscribeKey at initialization.

By default, a newly subscribed client will only receive messages published to the channel after the subscribe() call completes.

If a client gets disconnected from a channel, it can automatically attempt to reconnect to that channel and retrieve any available messages that were missed during that period. This can be achieved by setting PNConfiguration.retryConfiguration when initializing the client.

Parameters

channels

Channels to subscribe/unsubscribe. Either channel or channelGroups are required.

channelGroups

Channel groups to subscribe/unsubscribe. Either channelGroups or channels are required.

withPresence

Also subscribe to related presence channel.

withTimetoken

A timetoken to start the subscribe loop from.

actual abstract fun subscribe(channels: List<String>, channelGroups: List<String>, withPresence: Boolean, withTimetoken: Long)