Angular2 Channel Groups API Reference for Realtime Apps
Channel Groups allows PubNub developers to bundle thousands of channels into a group that can be identified by name. These Channel Groups can then be subscribed to, receiving data from the many backend-channels the channel group contains.
Adding Channels
Requires Stream Controller add-on Requires that the Stream Controller add-on is enabled for your key. See this page on enabling add-on features on your keys:
https://support.pubnub.com/hc/en-us/articles/360051974791-How-do-I-enable-add-on-features-for-my-keys-
Description
This function adds a channel to a channel group.
Method(s)
Adding Channels
is accomplished by using the following method(s) in the Angular2 V4 SDK:
Note
200 channels
can be added to the channel group
per API call.
pubnub.channelGroups.addChannels({Array channels, String channelGroup},Function callback)
Parameter Type Required Description Operation Arguments Hash Yes A hash of arguments. channels
Array Yes The channel
to add to the channel group.channelGroup
String Yes The channelGroup
to add the channels to.callback
Function Optional Executes on a successful/unsuccessful addChannels
.
Basic Usage
pubnub.channelGroups.addChannels(
{
channels: ['my_channel1', 'my_channel2'],
channelGroup: "my_channelGroup"
},
function(status) {
if (status.error) {
console.log("operation failed w/ status: ", status);
} else {
console.log("operation done!");
}
}
);
Response
{
error: false,
operation: "PNAddChannelsToGroupOperation",
statusCode: 200
}
Listing Channels
Requires Stream Controller add-on Requires that the Stream Controller add-on is enabled for your key. See this page on enabling add-on features on your keys:
https://support.pubnub.com/hc/en-us/articles/360051974791-How-do-I-enable-add-on-features-for-my-keys-
Description
This function lists all the channels of the channel group.
Method(s)
Listing Channels
is accomplished by using the following method(s) in the Angular2 V4 SDK:
pubnub.channelGroups.listChannels({String channelGroup},Function callback)
Parameter Type Required Description Operation Arguments Hash Yes A hash of arguments. channelGroup
String Yes Channel Group
to list the channel(s) of.callback
Function Optional Executes on a successful/unsuccessful listChannels
.
Basic Usage
// assuming an intialized Pubnub instance already exists
pubnub.channelGroups.listChannels(
{
channelGroup: "my_channelGroup"
},
function (status, response) {
if (status.error) {
console.log("operation failed w/ error:", status);
return;
}
console.log("listing push channel for device");
response.channels.forEach( function (channel) {
console.log(channel);
});
}
);
Response
// Example of Status
{
error: false,
operation: "PNChannelsForGroupOperation",
statusCode: 200
}
// Example of Response
{
channels: ["ch1", "ch2"]
}
Removing Channels
Requires Stream Controller add-on Requires that the Stream Controller add-on is enabled for your key. See this page on enabling add-on features on your keys:
https://support.pubnub.com/hc/en-us/articles/360051974791-How-do-I-enable-add-on-features-for-my-keys-
Description
This function removes the channels from the channel group.
Method(s)
Removing Channels
is accomplished by using the following method(s) in the Angular2 V4 SDK:
pubnub.channelGroups.removeChannels({Array channels, String channelGroup},Function callback)
Parameter Type Required Description Operation Arguments Hash Yes A hash of arguments. channels
Array Yes The channel
to remove from thechannel
group.channelGroup
String Yes The channelGroup
to remove the channels from.callback
Function Optional Executes on a successful/unsuccessful removeChannels
.
Basic Usage
pubnub.channelGroups.removeChannels(
{
channels: ["my_channel2"],
channelGroup: "my_channelGroup"
},
function (status) {
if (status.error) {
console.log("operation failed w/ error:", status);
} else {
console.log("operation done!");
}
}
);
Response
{
error: false,
operation: "PNRemoveChannelsFromGroupOperation",
statusCode: 200
}
Deleting Channel Group
Requires Stream Controller add-on Requires that the Stream Controller add-on is enabled for your key. See this page on enabling add-on features on your keys:
https://support.pubnub.com/hc/en-us/articles/360051974791-How-do-I-enable-add-on-features-for-my-keys-
Description
This function removes the channel group.
Method(s)
Deleting Channel Group
is accomplished by using the following method(s) in the Angular2 V4 SDK:
pubnub.channelGroups.deleteGroup({String channelGroup},Function callback)
Parameter Type Required Description Operation Arguments Hash Yes A hash of arguments. channelGroup
String Yes The channelGroup
to remove.callback
Function Optional Executes on a successful/unsuccessful deleteGroup
.
Basic Usage
pubnub.channelGroups.deleteGroup(
{
channelGroup: "my_channelGroup"
},
function (status) {
if (status.error) {
console.log("operation failed w/ error:", status);
} else {
console.log("operation done!");
}
}
);
Response
{
error: false,
operation: "PNRemoveGroupOperation",
statusCode: 200
}