commonMain.com.pubnub.api.v2.entities.Subscribable.kt Maven / Gradle / Ivy

Go to download

Show more of this group Show more artifacts with this name
Show all versions of pubnub-kotlin-api-jvm Show documentation

PubNub is a cross-platform client-to-client (1:1 and 1:many) push service in the cloud, capable of broadcasting real-time messages to millions of web and mobile clients simultaneously, in less than a quarter second!

The newest version!

package com.pubnub.api.v2.entities

import com.pubnub.api.v2.subscriptions.EmptyOptions
import com.pubnub.api.v2.subscriptions.Subscription
import com.pubnub.api.v2.subscriptions.SubscriptionOptions

/**
 * This interface is implemented by entities that can be subscribed to, such as channels, channel groups, and user and
 * channel metadata.
 */
interface Subscribable {
    /**
     * Returns a [com.pubnub.api.v2.subscriptions.Subscription] that can be used to subscribe to this `Subscribable`.
     *
     * @param options optional [SubscriptionOptions].
     * @return an inactive [Subscription] to this `Subscribable`. You must call [Subscription.subscribe] to start receiving events.
     */
    fun subscription(options: SubscriptionOptions = EmptyOptions): Subscription
}