CocoaCocoaiOSObjective-CCocoa Channel Groups API Reference for Realtime Apps

Go to Presence


Requires Stream Controller add-on XRequires that the Stream Controller add-on is enabled for your key. See this page on enabling add-on features on your keys:

http://www.pubnub.com/knowledge-base/discussion/644/how-do-i-enable-add-on-features-for-my-keys.
This function adds a channel to a channel group.
Adding Channels is accomplished by using the following method(s) in the Objective-C SDK:
  1. ParameterTypeRequiredDescription
    channels NSArrayYesList of channel names which should be added to the group.
    group NSStringYesName of the group into which channels should be added.
    blockPNChannelGroupChangeCompletionBlockNoChannels addition process completion block which pass only one argument - request processing status to report about how data pushing was successful or not.
NSString *channelGroup = @"family";
[self.client addChannels: @[@"wife"] toGroup:channelGroup
		  withCompletion:^(PNAcknowledgmentStatus *status) {

	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 objects which is returned by client when Add Channels to Group API is used:
@interface PNAcknowledgmentStatus : PNErrorStatus

@end
Requires Stream Controller add-on XRequires that the Stream Controller add-on is enabled for your key. See this page on enabling add-on features on your keys:

http://www.pubnub.com/knowledge-base/discussion/644/how-do-i-enable-add-on-features-for-my-keys.
This function lists all the channels of the channel group.
Listing Channels is accomplished by using the following method(s) in the Objective-C SDK:
  1. ParameterTypeRequiredDescription
    groupNSStringYesName of the group from which channels should be fetched.
    blockPNClientChannelsForGroupRequestHandlingBlockYesChannels audition process completion block which pass two arguments: result - in case of successful request processing data field will contain results of channel groups channels audition operation; status - in case if error occurred during request processing.
NSString *channelGroup = @"family";
[self.client channelsForGroup:channelGroup withCompletion:^(PNChannelGroupChannelsResult *result,
															PNErrorStatus *status) {

	if (!status) {

		// 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 objects which is returned by client when Add Channels to Group API is used:
@interface PNChannelGroupChannelsData : PNServiceData

// Registered channels within channel group.
@property (nonatomic, readonly, strong) NSArray<NSString *> *channels;

@end


@interface PNChannelGroupChannelsResult : PNResult

// Stores reference on channel group's channels list audit request processing information.
@property (nonatomic, nonnull, readonly, strong) PNChannelGroupChannelsData *data;

@end
Requires Stream Controller add-on XRequires that the Stream Controller add-on is enabled for your key. See this page on enabling add-on features on your keys:

http://www.pubnub.com/knowledge-base/discussion/644/how-do-i-enable-add-on-features-for-my-keys.
This function removes the channels from the channel group.
Removing Channels is accomplished by using the following method(s) in the Objective-C SDK:
  1. ParameterTypeRequiredDescription
    channelsNSArrayYesList of channel names which should be removed from group. If empty list passed whole channel group will be removed.
    groupNSStringYesChannel group from which channels should be removed.
    blockPNChannelGroupChangeCompletionBlockNoChannels removal process completion block which pass only one argument - request processing status to report about how data pushing was successful or not.
Removing channels :
NSString *channelGroup = @"family";
[self.client removeChannels:@[@"son"] fromGroup:channelGroup
			 withCompletion:^(PNAcknowledgmentStatus *status) {

	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 objects which is returned by client when Remove Channels to Group API is used:
@interface PNAcknowledgmentStatus : PNErrorStatus

@end
Requires Stream Controller add-on XRequires that the Stream Controller add-on is enabled for your key. See this page on enabling add-on features on your keys:

http://www.pubnub.com/knowledge-base/discussion/644/how-do-i-enable-add-on-features-for-my-keys.
This function removes the channel group.
Deleting Channel Group is accomplished by using the following method(s) in the Objective-C SDK:
  1. ParameterTypeRequiredDescription
    groupNSStringYesName of the group from which all channels should be removed.
    blockPNChannelGroupChangeCompletionBlockNoChannel group removal process completion block which pass only one argument - request processing status to report about how data pushing was successful or not.
Deleting Channel Group :
NSString *channelGroup = @"family";
[self.client removeChannelsFromGroup:channelGroup withCompletion:^(PNAcknowledgmentStatus *status) {

	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 objects which is returned by client when Remove Channel Group API is used:
@interface PNAcknowledgmentStatus : PNErrorStatus

@end

Go to Storage and Playback