ChannelMetadata Entity

Since version 9.0.0, the Kotlin SDK supports entities, which are SDK objects that provide operations on endpoints associated with their type. They are designed as first-class citizens to facilitate working with various PubNub APIs.

Certain PubNub API functionality is already exposed via entities, while other may still be available using the pubnub object.

Create ChannelMetadata

This method returns one local ChannelMetadata entity.

pubnub.channelMetadata(id: String): ChannelMetadata
ParameterTypeRequiredDescription
idStringYesThe String identifier for a single channel metadata object to create a subscription of.

Basic usage

val metadata = pubnub.channelMetadata("myChannel")

Available operations

The ChannelMetadata entity provides operations performed on PubNub App Context's channel metadata.

Operation (click for more information)Description
subscription(subscriptionOptions)Returns a local channel metadata subscription object with optional parameters to which you can subscribe and start receiving real-time updates for that channel metadata.
Last updated on