Warning: You are viewing an old version (1.0) of this documentation. We recommend you view the latest version 1.2.
REST Client Library API

Channel Status

Overview

Use cases

Having access to channel metadata can provide numerous benefits. In a scenario where the number of subscribers of a channel goes well beyond a hundred, usage of other options such as presence becomes less effective leading to an unexpected n-squared problem if all of the clients are subscribed to presence. You could instead make use of our channel metadata to check the number of active subscribers.

Equally, you may want to publish your data only if there is a subscriber for that data. The channel lifecycle events can notify you when a channel is opened, becomes active, or is no longer active thus giving your publisher clients an opportunity to know when the last subscriber leaves the channel.

If you need to be able to query channel metadata at any point, you can make use of the Channel Status API to inspect the state of individual channels, or enumerate all active channels in an app.

Tutorials

If you wish to see an example of how to use channel metadata, you can check out our Channel Lifecycle Events tutorial, Channel Occupancy Events tutorial, and the Channel Enumeration tutorial.

API Reference

View the Channel Status API Reference.


Need help?

If you need any help with your implementation or if you have encountered any problems, do get in touch. You can also quickly find answers from our knowledge base, and blog.