---
source_url: https://www.pubnub.com/docs/sdks/cocoa-swift/api-reference/channel-groups
title: Channel Groups API for Cocoa Swift SDK
updated_at: 2026-05-28T08:24:00.616Z
---

> Documentation Index
> For a curated overview of PubNub documentation, see: https://www.pubnub.com/docs/llms.txt
> For the full list of all documentation pages, see: https://www.pubnub.com/docs/llms-full.txt


# Channel Groups API for Cocoa Swift SDK

This SDK has been replaced by a new PubNub Swift SDK written purely in Swift. Check it out [here](https://www.pubnub.com/docs/sdks/swift)

[Channel groups](https://www.pubnub.com/docs/general/channels/subscribe#channel-groups) allow PubNub developers to bundle thousands of [channels](https://www.pubnub.com/docs/general/channels/overview) into a group that can be identified by a name. These channel groups can then be subscribed to, receiving data from the many back-end channels the channel group contains.

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

## Add channels to a channel group

:::note Requires Stream Controller add-on
This method requires that the *Stream Controller* add-on is enabled for your key in the PubNub [Admin Portal](https://admin.pubnub.com/). Read the [support page](https://support.pubnub.com/hc/en-us/articles/360051974791-How-do-I-enable-add-on-features-for-my-keys-) on enabling add-on features on your keys.
:::

This function adds channels to a channel group.

### Method(s)

Use the following method in the Swift SDK:

```swift
open func addChannels(
    _ channels: [String],
    toGroup group: String,
    withCompletion closure: PubNub.PNChannelGroupChangeCompletionBlock? = nil
)
```

| Parameter | Type | Required | Default | Description |
| --- | --- | --- | --- | --- |
| channels | [String] | Yes |  | The channels to add to the channel group. |
| group | String | Yes |  | The channel group to add the channels to. |
| closure | PNChannelGroupChangeCompletionBlock | Optional |  | Channel(s) addition completion closure, has one argument - request processing status to report whether data push was successful or not (errorData contains error information in case of failure). |

### Sample code

#### Add channels

```swift
let channelGroup = "family"
```

```swift
self.client.addChannels(["wife"], toGroup: channelGroup, withCompletion: { (status) in

    if !status.isError {

        // Handle successful channels list modification for group.
    }
    else {

        /**
         Handle channels list modification for group error. Check 'category' property
         to find out possible reason because of which request did fail.
         Review 'errorData' property (which has PNErrorData data type) of status
         object to get additional information about issue.

         Request can be resent using: status.retry()
         */
    }
})
```

### Response

Response objects which is returned by client when Add Channels to Group API is used:

```swift
open class PNAcknowledgmentStatus : PNErrorStatus {

}
```

## List channels in a channel group

:::note Requires Stream Controller add-on
This method requires that the *Stream Controller* add-on is enabled for your key in the [Admin Portal](https://admin.pubnub.com/). Read the [support page](https://support.pubnub.com/hc/en-us/articles/360051974791-How-do-I-enable-add-on-features-for-my-keys-) on enabling add-on features on your keys.
:::

This function lists all channels in a channel group.

### Method(s)

Use the following method in the Swift SDK:

```swift
open func channelsForGroup(
    _ group: String,
    withCompletion closure: PubNub.PNGroupChannelsAuditCompletionBlock
)
```

| Parameter | Description |
| --- | --- |
| `group` *Type: String | The channel group for which to list channels. |
| `closure` *Type: PNGroupChannelsAuditCompletionBlock | The completion `closure` which will be called when the processing is complete, has two arguments: `result` - in case of successful processing (data field will contain results of channel groups audit operation); `status` - in case of error while processing (`errorData`contains error information). |

### Sample code

#### List channels

```swift
let channelGroup = "family"
```

```swift
self.client.channelsForGroup(channelGroup, withCompletion: { (result, status) in

    if status == nil {

        // Handle downloaded list of chanels using: result.data.channels
    }
    else {

        /**
         Handle channels for group audition error. Check 'category' property
         to find out possible reason because of which request did fail.
         Review 'errorData' property (which has PNErrorData data type) of status
         object to get additional information about issue.

         Request can be resent using: status.retry()
         */
    }
})
```

### Response

Response objects which is returned by client when Add Channels to Group API is used:

```swift
open class PNChannelGroupChannelsData : PNServiceData {

    // Registered channels within channel group.
    open var channels: [String] { get }
}

open class PNChannelGroupChannelsResult : PNResult {

    // Stores reference on channel group's channels list audit request processing information.
    open var data: PNChannelGroupChannelsData { get }
}
```

## Remove channels from a channel group

:::note Requires Stream Controller add-on
This method requires that the *Stream Controller* add-on is enabled for your key in the [Admin Portal](https://admin.pubnub.com/). Read the [support page](https://support.pubnub.com/hc/en-us/articles/360051974791-How-do-I-enable-add-on-features-for-my-keys-) on enabling add-on features on your keys.
:::

This function removes channels from a channel group.

### Method(s)

Use the following method in the Swift SDK:

```swift
open func removeChannels(
    _ channels: [String],
    fromGroup group: String,
    withCompletion closure: PubNub.PNChannelGroupChangeCompletionBlock? = nil
)
```

| Parameter | Description |
| --- | --- |
| `channels` *Type: [String] | The channels to remove from the channel group. If you pass an empty list, the channel group will be removed. |
| `group` *Type: String | The channel group from which to remove the channels. |
| `closure`Type: PNChannelGroupChangeCompletionBlock | The completion `closure` which will be called when the processing is complete, has one argument: request processing `status` - in case of error while processing (`errorData`contains error information). |

### Sample code

Removing channels :

```swift
let channelGroup = "family"
```

```swift
self.client.removeChannels(["son"], fromGroup: channelGroup, withCompletion: { (status) in

    if !status.isError {

        // Handle successful channels list modification for group.
    }
    else {

        /**
         Handle channels list modification for group error. Check 'category' property
         to find out possible reason because of which request did fail.
         Review 'errorData' property (which has PNErrorData data type) of status
         object to get additional information about issue.

         Request can be resent using: status.retry();
         */
    }
})
```

### Response

Response objects which is returned by client when Remove Channels to Group API is used:

```swift
open class PNAcknowledgmentStatus : PNErrorStatus {

}
```

## Delete a channel group

:::note Requires Stream Controller add-on
This method requires that the *Stream Controller* add-on is enabled for your key in the [Admin Portal](https://admin.pubnub.com/). Read the [support page](https://support.pubnub.com/hc/en-us/articles/360051974791-How-do-I-enable-add-on-features-for-my-keys-) on enabling add-on features on your keys.
:::

This function deletes a channel group.

### Method(s)

Use the following method in the Swift SDK:

```swift
open func removeChannelsFromGroup(
    _ group: String,
    withCompletion closure: PubNub.PNChannelGroupChangeCompletionBlock? = nil
)
```

| Parameter | Description |
| --- | --- |
| `group` *Type: String | The channel group to delete. |
| `closure`Type: PNChannelGroupChangeCompletionBlock | The completion `closure` which will be called when the processing is complete, has one argument: request processing `status` - in case of error while processing (`errorData`contains error information). |

### Sample code

Deleting Channel Group :

```swift
let channelGroup = "family"
```

```swift
self.client.removeChannelsFromGroup(channelGroup, withCompletion: { (status) in

    if !status.isError {

        // Handle successful channel group removal.
    }
    else {

        /**
         Handle channel group removal error. Check 'category' property
         to find out possible reason because of which request did fail.
         Review 'errorData' property (which has PNErrorData data type) of status
         object to get additional information about issue.

         Request can be resent using: status.retry();
         */
    }
})
```

### Response

Response objects which is returned by client when Remove Channel Group API is used:

```swift
open class PNAcknowledgmentStatus : PNErrorStatus {

}
```

## Terms in this document

* **Channel** - A pathway for sending and receiving messages between devices, created automatically when you first use it, that can handle any number of users and messages for different communication needs, like 1-1 text chats, group conversations, and other data streaming.
* **PubNub** - PubNub is a real-time messaging platform that provides APIs and SDKs for building scalable applications. It handles the complex infrastructure of real-time communication, including: Message delivery and persistence, Presence detection, Access control, Push notifications, File sharing, Serverless processing with Functions and Events & Actions, Analytics and monitoring with BizOps Workspace, AI-powered insights with Illuminate.