PubNub LogoDocs
SupportContact SalesLoginTry Our APIs

›API Reference

java

  • Getting Started
  • API Reference

    • Configuration
    • Publish & Subscribe
    • Presence
    • Access Manager
    • Channel Groups
    • Message Persistence
    • Mobile Push
    • Objects
    • Files
    • Message Actions
    • Miscellaneous
  • Status Events
  • Troubleshooting
  • Change Log
  • Feature Support
  • Platform Support

Channel Groups API for PubNub Java SDK

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.

Learn more about our Channel Groups here.

Adding Channels

Requires Stream Controller add-onRequires 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 Java V4 SDK:

Note

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

  1. this.pubnub.addChannelsToChannelGroup().channelGroup(String).channels(Array)
    
    ParameterTypeRequiredDescription
    channelGroupStringYesThe channelGroup to add the channels to.
    channelsArrayYesThe channel to add to the channel group.
    asyncPNCallbackYesPNCallback of type PNChannelGroupsAddChannelResult

Basic Usage

Adding Channels :

pubnub.addChannelsToChannelGroup()
    .channelGroup("cg1")
    .channels(Arrays.asList("ch1", "ch2", "ch3"))
    .async(new PNCallback<PNChannelGroupsAddChannelResult>() {
        @Override
        public void onResponse(PNChannelGroupsAddChannelResult result, PNStatus status) {

        }
    });

Response

The addChannelsToChannelGroup() does not return actionable data, be sure to check the status object on the outcome of the operation by checking the status.isError().

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

Listing Channels

Requires Stream Controller add-onRequires 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 Java V4 SDK:

  1. pubnub.listChannelsForChannelGroup().channelGroup(String)
    
    ParameterTypeRequiredDescription
    channelGroupStringYesChannel group to fetch the channels.
    asyncPNCallbackYesPNCallback of type PNChannelGroupsAllChannelsResult.

Basic Usage

Listing Channels:

pubnub.listChannelsForChannelGroup()
    .channelGroup("cg1")
    .async(new PNCallback<PNChannelGroupsAllChannelsResult>() {
        @Override
        public void onResponse(PNChannelGroupsAllChannelsResult result, PNStatus status) {

        }
    });

Returns

The listChannelsForChannelGroup() operation returns a PNChannelGroupsAllChannelsResult which contains the following operations:

MethodTypeDescription
getChannels()ListList of channels of a channel group.

Removing Channels

Requires Stream Controller add-onRequires 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 Java V4 SDK:

  1. pubnub.removeChannelsFromChannelGroup().channelGroup(String).channels(Array)
    
    ParameterTypeRequiredDescription
    channelsArrayYesThe channels to remove from the channel group.
    channelGroupStringYesSpecifies channelGroup to remove the channels from.
    asyncPNCallbackOptionalPNCallback of type PNChannelGroupsRemoveChannelResult.

Basic Usage

Removing channels:

pubnub.removeChannelsFromChannelGroup()
    .channelGroup("family")
    .channels(Arrays.asList("son"))
    .async(new PNCallback<PNChannelGroupsRemoveChannelResult>() {
        @Override
        public void onResponse(PNChannelGroupsRemoveChannelResult result, PNStatus status) {

        }
    });

Response

The removeChannelsFromChannelGroup() does not return actionable data, be sure to check the status object on the outcome of the operation by checking the status.isError().

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

Deleting Channel Group

Requires Stream Controller add-onRequires 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 Java V4 SDK:

  1. pubnub.deleteChannelGroup().channelGroup(String)
    
    ParameterTypeRequiredDescription
    channelGroupStringYesSpecifies channelGroup to remove.
    asyncPNCallbackOptionalPNCallback of type PNChannelGroupsDeleteGroupResult.

Basic Usage

Deleting Channel Group:

pubnub.deleteChannelGroup()
    .channelGroup("family")
    .async(new PNCallback<PNChannelGroupsDeleteGroupResult>() {
        @Override
        public void onResponse(PNChannelGroupsDeleteGroupResult result, PNStatus status) {

        }
    });

Response

The deleteChannelGroup() does not return actionable data, be sure to check the status object on the outcome of the operation by checking the status.isError().

{
    "status" : 200,
    "message" : "OK",
    "service" : "channel-registry",
    "error" : False
}
← Access ManagerMessage Persistence →
  • Adding Channels
    • Description
    • Method(s)
    • Basic Usage
    • Response
  • Listing Channels
    • Description
    • Method(s)
    • Basic Usage
    • Returns
  • Removing Channels
    • Description
    • Method(s)
    • Basic Usage
    • Response
  • Deleting Channel Group
    • Description
    • Method(s)
    • Basic Usage
    • Response
© PubNub Inc. - Privacy Policy