Channel groups

Channel groups let you manage and subscribe to multiple channels as a single unit. Instead of subscribing to each channel individually, you can add channels to a group and receive messages from all of them with a single subscription.

This is useful when you need to:

• Subscribe to all channels a user is a member of with one call.
• Monitor presence across multiple channels simultaneously.
• Dynamically manage channel subscriptions without reconnecting.

You can't publish to a channel group. You can only subscribe to it. To publish within a channel group, you need to publish to each channel individually.

Requires Stream Controller add-on

This method requires that the Stream Controller add-on is enabled for your key in the Admin Portal. Read the support page on enabling add-on features on your keys.

Get channel group reference

Use the getChannelGroup() method on the Chat object to get a reference to a channel group. This method doesn't create the group on the server, but returns a handle you can use to manage the group.

If the group exists, the reference points to it. If the group doesn't exist, it serves as a handle to create and modify it by adding channels to it.

Method signature

This method takes the following parameters:

1chat.getChannelGroup(id: string): ChannelGroup

Input

* required

Parameter	Description
id * Type: string Default: n/a	Unique identifier for the channel group.

Output

Type	Description
ChannelGroup	A ChannelGroup object you can use to manage the group.

Sample code

Get a reference to a channel group named my-channel-group.

1const channelGroup = chat.getChannelGroup("my-channel-group")

Remove channel group

Use the removeChannelGroup() method to delete a channel group from the server.

Method signature

This method takes the following parameters:

1chat.removeChannelGroup(id: string): Promise<void>

Input

* required

Parameter	Description
id * Type: string Default: n/a	Unique identifier of the channel group to remove.

Output

Type	Description
Promise<void>	Returns an empty response when the channel group is successfully removed.

Sample code

Remove a channel group named my-channel-group.

1await chat.removeChannelGroup("my-channel-group")

List channels

Use the listChannels() method to get a paginated list of all channels in a channel group.

Method signature

This method takes the following parameters:

1channelGroup.listChannels({
2    filter?: string,
3    sort?: object,
4    limit?: number,
5    page?: {
6        next?: string,
7        prev?: string
8    }
9}): Promise<{
10    channels: Channel[],
11    page: {
12        next: string,
13        prev: string
14    },
15    total: number
16}>

show all 16 lines

Input

* required

Parameter	Description
filter Type: string Default: n/a	Expression used to filter the results. Returns only the channels whose properties satisfy the given expression. The filter language is defined here.
sort Type: object Default: n/a	An object to specify the sort order. Available options are id, name, and updated. Use asc or desc to specify the sorting direction. For example: { name: "asc" }.
limit Type: number Default: 100	Number of objects to return in response. The default (and maximum) value is 100.
page Type: object Default: n/a	Object used for pagination to define which previous or next result page you want to fetch.

Output

Type	Description
Promise<{ channels, page, total }>	Promise containing a set of channels with pagination information (next, prev, total).

Sample code

List all channels in a channel group.

1const channelGroup = chat.getChannelGroup("my-channel-group")
2

3const { channels, page, total } = await channelGroup.listChannels()
4

5channels.forEach(channel => {
6    console.log("Channel:", channel.id)
7})

Add channels

Use the addChannels() method to add Channel entities to a channel group.

Method signature

This method takes the following parameters:

1channelGroup.addChannels(channels: Channel[]): Promise<void>

Input

* required

Parameter	Description
channels * Type: Channel[] Default: n/a	Array of Channel entities to add to the group.

Output

Type	Description
Promise<void>	Returns an empty response when channels are successfully added.

Sample code

Add two channels to a channel group.

1const channelGroup = chat.getChannelGroup("my-channel-group")
2

3const supportChannel = await chat.getChannel("support-channel")
4const generalChannel = await chat.getChannel("general-channel")
5

6await channelGroup.addChannels([supportChannel, generalChannel])

Add channel identifiers

Use the addChannelIdentifiers() method to add channels to a group using only their IDs. This method reduces the overhead of fetching full Channel entities when you only know the IDs.

No validation

This method doesn't validate whether channels with the given IDs exist. Make sure the channel IDs are valid before adding them.

Method signature

This method takes the following parameters:

1channelGroup.addChannelIdentifiers(ids: string[]): Promise<void>

Input

* required

Parameter	Description
ids * Type: string[] Default: n/a	Array of channel IDs to add to the group.

Output

Type	Description
Promise<void>	Returns an empty response when channel identifiers are successfully added.

Sample code

Add channels by their IDs.

1const channelGroup = chat.getChannelGroup("my-channel-group")
2

3await channelGroup.addChannelIdentifiers(["support-channel", "general-channel"])

Remove channels

Use the removeChannels() method to remove Channel entities from a channel group.

Method signature

This method takes the following parameters:

1channelGroup.removeChannels(channels: Channel[]): Promise<void>

Input

* required

Parameter	Description
channels * Type: Channel[] Default: n/a	Array of Channel entities to remove from the group.

Output

Type	Description
Promise<void>	Returns an empty response when channels are successfully removed.

Sample code

Remove channels from a channel group.

1const channelGroup = chat.getChannelGroup("my-channel-group")
2

3// Assuming you have channel references
4await channelGroup.removeChannels([supportChannel, generalChannel])

Remove channel identifiers

Use the removeChannelIdentifiers() method to remove channels from a group using only their IDs.

No validation

This method doesn't validate whether channels with the given IDs exist in the group. Make sure the channel IDs are valid before removing them.

Method signature

This method takes the following parameters:

1channelGroup.removeChannelIdentifiers(ids: string[]): Promise<void>

Input

* required

Parameter	Description
ids * Type: string[] Default: n/a	Array of channel IDs to remove from the group.

Output

Type	Description
Promise<void>	Returns an empty response when channel identifiers are successfully removed.

Sample code

Remove channels by their IDs.

1const channelGroup = chat.getChannelGroup("my-channel-group")
2

3await channelGroup.removeChannelIdentifiers(["support-channel", "general-channel"])

Watch channel group

Use the connect() method to start receiving messages from all channels in the group. This subscribes to all channels in the group and invokes your callback whenever a message is received on any channel in the group.

Method signature

This method takes the following parameters:

1channelGroup.connect(callback: (message: Message) => void): () => void

Input

* required

Parameter	Description
callback * Type: (message: Message) => void Default: n/a	Callback function invoked whenever a message is received on any channel in the group.

Output

Type	Description
() => void	Function you can call to stop listening for new messages.

Sample code

Start receiving messages from all channels in a group.

1const channelGroup = chat.getChannelGroup("my-channel-group")
2

3const disconnect = channelGroup.connect((message) => {
4    console.log(`Received message on channel ${message.channelId}: ${message.text}`)
5})
6

7// Later, when you want to stop receiving messages
8disconnect()

Get present users

Use the whoIsPresent() method to get a list of users currently present on any channel within the channel group.

Requires Presence

This method requires that Presence is enabled for your app's keyset in the Admin Portal.

Method signature

This method has the following signature:

1channelGroup.whoIsPresent(): Promise<{ [channelId: string]: string[] }>

Input

This method doesn't take any parameters.

Output

Type	Description
Promise<{ [channelId: string]: string[] }>	A map where each key is a channel ID and the value is an array of user IDs present on that channel.

Sample code

Get all users present on channels in a group.

1const channelGroup = chat.getChannelGroup("my-channel-group")
2

3const presenceByChannel = await channelGroup.whoIsPresent()
4

5Object.entries(presenceByChannel).forEach(([channelId, userIds]) => {
6    console.log(`Channel ${channelId} has users:`, userIds)
7})

Stream presence

Use the streamPresence() method to receive real-time updates when users join or leave any channel in the group.

Requires Presence

This method requires that Presence is enabled for your app's keyset in the Admin Portal.

Method signature

This method takes the following parameters:

1channelGroup.streamPresence(
2    callback: (presenceByChannels: { [channelId: string]: string[] }) => void
3): () => void

Input

* required

Parameter	Description
callback * Type: ({ [channelId: string]: string[] }) => void Default: n/a	Callback function invoked when presence changes. Receives a map where each key is a channel ID and the value is an array of user IDs present on that channel.

Output

Type	Description
() => void	Function you can call to stop receiving presence updates.

Sample code

Stream presence updates for all channels in a group.

1const channelGroup = chat.getChannelGroup("my-channel-group")
2

3const stopPresenceStream = channelGroup.streamPresence((presenceByChannel) => {
4    Object.entries(presenceByChannel).forEach(([channelId, userIds]) => {
5        console.log(`Channel ${channelId} now has users:`, userIds)
6    })
7})
8

9// Later, when you want to stop receiving presence updates
10stopPresenceStream()