Channel Groups API for PubNub Unity SDK

Channel groups allow PubNub developers to bundle thousands of channels 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.

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

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.

This function adds a channel to a channel group.

Method(s)

Adding Channels is accomplished by using the following method(s) in the Unity SDK:

Maximum number of channels

200 channels can be added to the channel group per API call.

pubnub.AddChannelsToChannelGroup()
    .ChannelGroup(string)
    .Channels(Array)
    .QueryParam(Dictionary<string,object>)
    .Execute(System.Action<PNChannelGroupsAddChannelResult, PNStatus>);

Parameter	Type	Required	Description
ChannelGroup	string	Yes	The ChannelGroup to add the channels to.
Channels	Array	Yes	The Channels to add to the channel group.
QueryParam	Dictionary<string, object>	Optional	Dictionary object to pass name/value pairs as query string params with PubNub URL request for debug purpose.
Async	PNCallback	Deprecated	PNCallback of type PNChannelGroupsAddChannelResult.
Execute	System.Action	Yes	System.Action of type PNChannelGroupsAddChannelResult.
ExecuteAsync	None	Optional	Returns Task<PNResult<PNChannelGroupsAddChannelResult>>.

Basic Usage

Adding Channels

PNResult<PNChannelGroupsAddChannelResult> cgAddChResponse = await pubnub.AddChannelsToChannelGroup()
    .ChannelGroup("cg1")
    .Channels(new string[] {
        "ch1",
        "ch2",
        "ch3"
    })
    .ExecuteAsync();

Returns

The AddChannelsToChannelGroup() operation returns a PNResult<PNChannelGroupsAddChannelResult> which contains the following properties:

Property Name	Type	Description
Result	PNChannelGroupsAddChannelResult	Returns a PNChannelGroupsAddChannelResult object.
Status	PNStatus	Returns a PNStatus object.

PNChannelGroupsAddChannelResult contains the following properties:

Property Name	Type	Description
PNChannelGroupsAddChannelResult	Object	Returns empty object.
PNStatus	Object	Returns status of request if error occurred or not.

List Channels

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.

This function lists all the channels of the channel group.

Method(s)

Listing Channels is accomplished by using the following method(s) in the Unity SDK:

pubnub.ListChannelsForChannelGroup()
    .ChannelGroup(string)
    .QueryParam(Dictionary<string,object>)
    .Execute(System.Action<PNChannelGroupsAllChannelsResult, PNStatus>);

Parameter	Type	Required	Description
ChannelGroup	string	Yes	Channel group to fetch the channels.
QueryParam	Dictionary<string, object>	Optional	Dictionary object to pass name/value pairs as query string params with PubNub URL request for debug purpose.
Async	PNCallback	Deprecated	PNCallback of type PNChannelGroupsAllChannelsResult.
Execute	System.Action	Yes	System.Action of type PNChannelGroupsAllChannelsResult.
ExecuteAsync	None	Optional	Returns Task<PNResult<PNChannelGroupsAllChannelsResult>>.

Basic Usage

List Channels

PNResult<PNChannelGroupsAllChannelsResult> cgListChResponse = await pubnub.ListChannelsForChannelGroup()
    .ChannelGroup("cg1")
    .ExecuteAsync();

Returns

The ListChannelsForChannelGroup() operation returns a PNChannelGroupsAllChannelsResult which contains the following properties:

Property Name	Type	Description
Result	PNChannelGroupsAllChannelsResult	Returns a PNChannelGroupsAllChannelsResult object.
Status	PNStatus	Returns a PNStatus object.

PNChannelGroupsAllChannelsResult contains the following property:

Property Name	Type	Description
Channels	List<string>	List of channels of a channel group.

Remove Channels

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.

This function removes the channels from the channel group.

Method(s)

Removing Channels is accomplished by using the following method(s) in the Unity SDK:

pubnub.RemoveChannelsFromChannelGroup()
    .ChannelGroup(string)
    .Channels(Array)
    .QueryParam(Dictionary<string,object>)
    .Execute((result, status) => {});

Parameter	Type	Required	Description
ChannelGroup	string	Yes	Specifies ChannelGroup to remove the channels from.
Channels	Array	Yes	The Channels to remove from the channel group.
QueryParam	Dictionary<string, object>	Optional	Dictionary object to pass name/value pairs as query string params with PubNub URL request for debug purpose.
Async	PNCallback	Deprecated	PNCallback of type PNChannelGroupsRemoveChannelResult.
Execute	System.Action	Yes	System.Action of type PNChannelGroupsRemoveChannelResult.
ExecuteAsync	None	Optional	Returns Task<PNResult<PNChannelGroupsRemoveChannelResult>>.

Basic Usage

Remove channels

PNResult<PNChannelGroupsRemoveChannelResult> rmChFromCgResponse = await pubnub.RemoveChannelsFromChannelGroup()
    .ChannelGroup("family")
    .Channels(new string[] {
        "son"
    })
    .Execute((result, status) => {});

Returns

The RemoveChannelsFromChannelGroup() operation returns a PNChannelGroupsAddChannelResult which contains the following properties:

Property Name	Type	Description
Result	PNChannelGroupsRemoveChannelResult	Returns a PNChannelGroupsRemoveChannelResult object.
Status	PNStatus	Returns a PNStatus object.

PNChannelGroupsRemoveChannelResult contains the following property:

Property Name	Type	Description
PNChannelGroupsRemoveChannelResult	Object	Returns empty object.

Delete Channel Group

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.

This function removes the channel group.

Method(s)

Deleting Channel Group is accomplished by using the following method(s) in the Unity SDK:

pubnub.DeleteChannelGroup()
    .ChannelGroup(string)
    .QueryParam(Dictionary<string,object>)
    .Execute(System.Action<PNChannelGroupsDeleteGroupResult, PNStatus>);

Parameter	Type	Required	Description
ChannelGroup	string	Yes	Specifies ChannelGroup to remove.
QueryParam	Dictionary<string, object>	Optional	Dictionary object to pass name/value pairs as query string params with PubNub URL request for debug purpose.
Async	PNCallback	Deprecated	PNCallback of type PNChannelGroupsDeleteGroupResult.
Execute	System.Action	Yes	System.Action of type PNChannelGroupsDeleteGroupResult.
ExecuteAsync	None	Optional	Returns Task<PNResult<PNChannelGroupsDeleteGroupResult>>.

Basic Usage

Delete Channel Group

PNResult<PNChannelGroupsDeleteGroupResult> delCgResponse = await pubnub.DeleteChannelGroup()
    .ChannelGroup("family")
    .ExecuteAsync();

Returns

The DeleteChannelGroup() operation returns a PNResult<PNChannelGroupsDeleteGroupResult> which contains the following properties:

Property Name	Type	Description
Status	int	HTTP response status code.
Error	bool	This is true if an error occurred in the execution of the operation.

{
    "status" : 200,
    "message" : "OK",
    "service" : "channel-registry",
    "error" : False
}