ChannelGroup entity

ChannelGroup represents a collection of channels that can be subscribed to as a single unit. Subscribe to multiple channels with one call instead of managing individual subscriptions.

Publishing to a channel group is not supported - publish to each channel individually.

Requires Stream Controller add-on

Enable the Stream Controller add-on for your key in the Admin Portal. Refer to the support page for details.

Properties

The ChannelGroup interface has the following properties:

1interface ChannelGroup {
2    val id: String
3    val chat: Chat
4

5    ...
6}

Parameter	Description
id Type: String	Unique identifier for the channel group.
chat Type: Chat	Reference to the main Chat object.

Methods

The ChannelGroup object exposes the following methods.

• addChannelIdentifiers()
• addChannels()
• connect()
• listChannels()
• removeChannelIdentifiers()
• removeChannels()
• streamPresence()
• whoIsPresent()

Use case

ChannelGroup methods enable:

• Subscribing to messages from multiple channels at once
• Monitoring presence across all channels in the group
• Dynamically adding or removing channels as users join or leave conversations
• Simplified message handling for multi-chat apps