iOSiOSCocoaSwiftiOS Swift 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 Swift SDK:
  1. ParameterTypeRequiredDescription
    channels [String]YesList of channel names which should be added to the group.
    group StringYesName of the group into which channels should be added.
    closurePNChannelGroupChangeCompletionBlockNoChannel(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).
let channelGroup = "family"
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 objects which is returned by client when Add Channels to Group API is used:
open class PNAcknowledgmentStatus : PNErrorStatus {

}
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 Swift SDK:
  1. ParameterTypeRequiredDescription
    groupStringYesChannel Group to list the channel(s) of.
    closurePNGroupChannelsAuditCompletionBlockYesThe 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 (errorDatacontains error information).
let channelGroup = "family"
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 objects which is returned by client when Add Channels to Group API is used:
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 }
}
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 Swift SDK:
  1. ParameterTypeRequiredDescription
    channels[String]YesList of channel names which should be removed from group. If empty list passed whole channel group will be removed.
    groupStringYesChannel group from which channels should be removed.
    closurePNChannelGroupChangeCompletionBlockNoThe completion closure which will be called when the processing is complete, has one argument: request processing status - in case of error while processing (errorDatacontains error information).
Removing channels :
let channelGroup = "family"
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 objects which is returned by client when Remove Channels to Group API is used:
open class PNAcknowledgmentStatus : PNErrorStatus {

}
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 Swift SDK:
  1. ParameterTypeRequiredDescription
    groupStringYesName of the group from which all channels should be removed.
    closurePNChannelGroupChangeCompletionBlockNoThe completion closure which will be called when the processing is complete, has one argument: request processing status - in case of error while processing (errorDatacontains error information).
Deleting Channel Group :
let channelGroup = "family"
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 objects which is returned by client when Remove Channel Group API is used:
open class PNAcknowledgmentStatus : PNErrorStatus {

}

Go to Storage and Playback