A group channel is a chat that allows close interactions among a limited number of users. It can be private or public. A private group channel can let a user join the chat through an invitation by another user who is already a member of the chatroom. For 1-to-1 messaging, you can create a private group channel with two members. A public group chat can let a user join the chat without invitation from others. A group channel can consist of one to one hundred members by default setting. This default number of members can increase per request.
A user can receive all messages from the group channels that they are a member of, and sends a message to those channels. They can also receive push notifications, typing indicators, unread counts and read receipts from the joined channels when they go offline. For more information, see the Push notifications page which describes how to turn on and manage the push preference.
Note: To learn about differences between open channels and group channels, see Channel types.
With our Chat SDK for iOS, you can use a variety of behavior related properties when creating different types of group channels. You can create a group channel after configuring these properties.
A private group channel can be joined only by users that have accepted an invitation from an existing channel member by default. On the other hand, a public group channel can be joined by any user without an invitation, like an open channel.
A private channel can be used for 1-on-1 conversations, such as clinical consultations and Instagram-style Direct Messages, while a public channel for 1-to-N conversations, such as small group discussions among students.
The distinct property determines whether to resume an old channel or to create a new one when someone attempts to open a channel with the same members. For a 1-to-1 chat, it is highly recommended that you turn on the distinct property to continuously use the existing channel.
Let's say there is a distinct group channel with user A, B, and C. If you attempt to create a new channel with the same members, the existing channel will be used. This is similar to Twitter-style 1-to-1 direct messaging. If the distinct property of the channel is set to false, a new channel will be created.
Note: The default value of this option is false. When a new member is invited or an existing member leaves the channel, then the distinct property of the channel is automatically turned off as well.
For occasions that demand engagement among a high volume of members, you can create a Supergroup channel, an expanded version of a group channel. It can be used for midsize conferences or large group discussion, such as company-wide stand-ups.
When the super option is set to true, a Supergroup channel will be created and up to tens of thousands of members can gather in the channel. The maximum number of members for a Supergroup channel can be adjusted depending on your Chat subscription plan.
Note: When super is set to YES or true, distinct can't be supported.
Messages sent in an ephemeral group channel are not saved in Sendbird's database. As such, old messages that are pushed out of a user's chat view due to new messages can't be retrieved. On the other hand, messages sent in a persistent group channel are stored permanently in the database by default.
A user can create a group channel from inviting other users anytime in their client app. At the implementation level, you just need to write your code which passes the IDs of users to invite as an argument to a parameter in the creation method.
Before you write the code for creating a group channel for a typical 1-to-1 chat, you should make sure that you turn on the distinct property of the channel. Otherwise, if you turn off the distinct property, a new channel will be created with the same partner user even if there is already an existing channel between them. In this case, multiple 1-to-1 channels between the same two users can exist, each with its own chat history and data.
However, if you plan to create a Supergroup channel, the distinct property should be turned off.
Note: If you want to retrieve a list of group channels, which also includes the current user's empty channels without any chat, you should set the includeEmptyChannel option of a SBDGroupChannelListQuery instance to YES for the retrieval.
SwiftObjective-C
SBDGroupChannel.createChannel(withUserIds: USER_IDS, isDistinct: IS_DISTINCT, completionHandler: { (groupChannel, error) in
guard error == nil else {
// Handle error.
}
// A group channel of the specified users is successfully created.
// Through the "groupChannel" parameter of the callback method,
// you can get the group channel's data from the result object that Sendbird server has passed to the callback method.
let channelUrl = groupChannel?.channelUrl
...
})
When creating a channel, you can also append additional information like cover image and description by passing several arguments to the corresponding parameters.
SwiftObjective-C
SBDGroupChannel.createChannel(withName: NAME, isDistinct: IS_DISTINCT, userIds: USER_IDS, coverUrl: COVER_IMAGE_URL, data: DATA, customType: CUSTOM_TYPE, completionHandler: { (groupChannel, error) in
guard error == nil else {
// Handle error.
}
// A group channel with additional information is successfully created.
let channelUrl = groupChannel?.channelUrl
...
})
Type: NSString Specifies the channel topic, or the name of the channel.
IS_DISTINCT
Type: BOOL Determines whether to reuse an existing channel or create a new channel. If set to YES, returns a channel with the same users in the USER_IDS or creates a new channel if no match is found.
* You can also use this property in conjunction with CUSTOM_TYPE and USER_IDS to create distinct channels for a specified channel custom type and a set of specified users. In order to enable the functionality, contact support on the Sendbird Dashboard.
IS_SUPER
Type: BOOL Determines whether a new channel will be a Supergroup channel or a group channel. If set to true, the new channel can accommodate more than 2,000 members. When this argument is true, IS_DISTINCT is not supported and should be set to false.
USER_IDS
Type: NSArray Specifies a list of one or more IDs of the users to invite to the channel.
COVER_IMAGE_URL
Type: NSString Specifies the cover image URL of the channel.
DATA
Type: NSString Specifies additional channel information such as a long description of the channel or JSON formatted string.
CUSTOM_TYPE
Type: NSString Specifies the custom channel type which is used for channel grouping.
Note: You can also create a group channel using Chat Platform API which helps you control channel creations and member invitations on your server-side.
Otherwise, you can configure SBDGroupChannelParams and create a new channel with that like below.
SwiftObjective-C
var users: [String] = []
users.append("John")
users.append("Harry")
users.append("Jay")
var ops: [String] = []
ops.append("Jeff")
var params = SBDGroupChannelParams()
params.isPublic = false
params.isEphemeral = false
params.isDistinct = false
params.isSuper = false
params.addUserIds(users)
params.operatorUserIds = ops // Or .operators
params.name = NAME
params.channelUrl = UNIQUE_CHANNEL_URL // In a group channel, you can create a new channel by specifying its unique channel URL in a 'GroupChannelParams' object.
params.coverImage = FILE // Or .coverUrl
params.data = DATA
params.customType = CUSTOM_TYPE
SBDGroupChannel.createChannel(with: params, completionHandler: { (groupChannel, error) in
guard error == nil else {
// Handle error.
}
// A group channel with detailed configuration is successfully created.
// By using groupChannel.channelUrl, groupChannel.members, groupChannel.data, groupChannel.customType, and so on,
// you can access the result object from Sendbird server to check your SBDGroupChannelParams configuration.
let channelUrl = groupChannel?.channelUrl
})
Note: By default, the Allow creating group channels option is turned on which means that group channels can be created by any user with Sendbird Chat SDK. This may grant access to unwanted data or operations, leading to potential security concerns. To manage your access control settings, you can turn on or off each option in Settings > Application > Security > Access control list on Sendbird Dashboard.
Only members of a group channel can invite new users to the channel. You can also determine whether the newly invited user sees the past messages in the channel or not.
Note: In your dashboard, go to the Settings > Chat > Channels > Group channels, and there is the Chat history option. If the option is turned on, new users can view all messages sent before they have joined the channel. If turned off, new users only see messages sent after they have been invited. By default, this option is turned on.
A user who is invited to a group channel can accept or decline the invitation. If a user accepts an invitation, they join the channel as a new member and can start chatting with other members. Otherwise, the invitation will be canceled if a user declines it. Since a user is allowed to join up to 2,000 group channels, the invitation to a user who already belongs to a maximum number of group channels will be canceled automatically.
SwiftObjective-C
// Accepting an invitation
groupChannel.acceptInvitation(completionHandler: { (error) in
guard error == nil else {
// Handle error.
}
...
})
// Declining an invitation
groupChannel.declineInvitation(completionHandler: { (error) in
guard error == nil else {
// Handle error.
}
...
})
By implementing the channel:didReceiveInvitation: and channel:didDeclineInvitation: in the channel delegate, you can make the client apps of other members in the foreground to be notified of the results of two actions above. If you want more information, see the Event delegate page.
Note: By using the setChannelInvitationAutoAccept:completionHandler:, you can determine for users within an application whether or not to automatically join a private group channel promptly from an invitation without having to accept it. By default, the value of channel invitation preference is YES. If you want to give them the option to decide whether to accept or decline an invitation, you should set the value of the preference to NO through the setChannelInvitationAutoAccept:completionHandler: like the following sample code.
SwiftObjective-C
var autoAccept = false // The value of true (default) means that a user will automatically join a group channel with no choice of accepting and declining an invitation.
SBDMain.setChannelInvitationPreferenceAutoAccept(autoAccept, completionHandler: { (error) in
guard error == nil else {
// Handle error.
}
...
})
This is only for public group channels. Any user can join a public group channel as a member without an invitation and chat with other members in the channel. Since a user is allowed to join up to 2,000 group channels, a user who already belongs to a maximum number of group channels can't join a new channel.
SwiftObjective-C
if groupChannel.isPublic {
groupChannel.join(completionHandler: { (error) in
guard error == nil else {
// Handle error.
}
// The current user successfully joins the group channel
...
})
})
A user can leave group channels as shown below. After leaving, the user can't receive messages from the channel, and this method can't be called for deactivated users.
You can temporarily disable various functions of a group channel to stop members from chatting in the channel, and enable the functions so that the members chat with each other. Note that in a frozen channel, normal members can't chat with each other but the operators can send a message to the channel.
SwiftObjective-C
// Freezing a channel
groupChannel.freeze(completionHandler: { (error) in
guard error == nil else {
// Handle error.
}
// The channel gets frozen.
// You could display a message telling that chatting in the channel is unavailable, or do something in response to a successful operation.
})
// Unfreezing a channel
groupChannel.unfreeze(completionHandler: { (error) in
guard error == nil else {
// Handle error.
}
// The channel gets unfrozen.
// You could display a message telling that chatting in the channel is available again, or do something in response to a successful operation.
})
You can retrieve a list of the current user's private group channels using the loadNextPageWithCompletionHandler: method of a SBDGroupChannelListQuery instance, which returns a list of SBDGroupChannel objects.
Note: Using the includeEmptyChannel option of a SBDGroupChannelListQuery instance, you can determine whether to include empty channels in the result. Empty channels are group channels that have been created but do not contain any messages, and are not included by default. However, if you turn off the Chat history option in your dashboard, you may retrieve empty channels in the result.
SwiftObjective-C
let listQuery = SBDGroupChannel.createMyGroupChannelListQuery()
listQuery?.includeEmptyChannel = true
listQuery?.memberStateFilter = SBDMemberStateFilterJoinedOnly // SBDMemberStateFilterAll, SBDMemberStateFilterJoinedOnly, SBDMemberStateFilterInvitedOnly
listQuery?.order = SBDGroupChannelListOrderLatestLastMessage // SBDGroupChannelListOrderChronological, SBDGroupChannelListOrderLatestLastMessage, SBDGroupChannelListOrderChannelNameAlphabetical, and SBDGroupChannelListOrderChannelMetaDataValueAlphabetical
listQuery?.limit = 15
listQuery?.loadNextPage(completionHandler: { (groupChannels, error) in
guard error == nil else {
// Handle error.
}
// A list of matching group channels is successfully retrieved.
// Through the "groupChannels" parameter of the callback method,
// you can access the data of each group channel from the result list that Sendbird server has passed to the callback method.
self.channels += groupChannels!
})
You can also retrieve a list of the current user's public group channels using the loadNextPageWithCompletionHandler: method of a SBDPublicGroupChannelListQuery instance, which returns a list of SBDGroupChannel objects.
Note: Using the includeEmptyChannel option of a SBDPublicGroupChannelListQuery instance, you can determine whether to include empty channels in the result. Empty channels are group channels that have been created but do not contain any messages, and are not included by default. However, if you turn off the Chat history option in your dashboard, you may retrieve empty channels in the result.
SwiftObjective-C
let listQuery = SBDGroupChannel.createPublicGroupChannelListQuery()
listQuery?.includeEmptyChannel = true
listQuery?.publicMembershipFilter = SBDPublicGroupChannelMembershipFilterJoined // SBDPublicGroupChannelMembershipFilterAll, SBDPublicGroupChannelMembershipFilterJoined
listQuery?.order = SBDPublicGroupChannelListOrderChannelNameAlphabetical // SBDPublicGroupChannelListOrderChronological, SBDPublicGroupChannelListOrderChannelNameAlphabetical, SBDPublicGroupChannelListOrderChannelMetaDataValueAlphabetical
listQuery?.limit = 15
listQuery?.loadNextPage(completionHandler: { (groupChannels, error) in
guard error == nil else {
// Handle error.
}
// A list of public group channels matching search criteria is successfully retrieved.
// Through the "groupChannels" parameter of the callback method,
// you can access the data of each group channel from the result list that Sendbird server has passed to the callback method.
self.channels += groupChannels!
})
Note: Refer to this section in the Advanced page for information on how to search for specific group channels with keywords and filters.
Since a channel URL is a unique identifier of a group channel, you can use a URL when retrieving a channel object.
SwiftObjective-C
SBDGroupChannel.getWithUrl(CHANNEL_URL), completionHandler: { (groupChannel, error) in
guard error == nil else {
// Handle error.
}
// Through the "groupChannel" parameter of the callback method,
// the group channel object identified with the CHANNEL_URL is returned by Sendbird server,
// and you can get the group channel's data from the result object.
let channelName = groupChannel?.name
...
}
Note: We recommend that you store a user's channel URLs to handle the lifecycle or state changes of your client app, or other unexpected situations. For example, when a user is disconnected from Sendbird server due to switching to another app temporarily, you can provide a smooth restoration of the user's state using a stored URL to fetch the appropriate channel instance.
The following code will allow you to hide or archive a specific group channel from a list of the channels.
SwiftObjective-C
// Hiding (archiving) a group channel.
groupChannel.hideChannel(withHidePreviousMessages:IS_HIDE_PREVIOUS_MESSAGES, allowAutoUnhide:IS_ALLOW_AUTO_UNHIDE, completionHandler: { (error) in
guard error == nil else {
// Handle error.
}
// The channel successfully gets hidden from the list.
// The current user's channel view should be refreshed to reflect the change.
...
})
// Unhiding a group channel.
groupChannel.unhideChannel(completionHandler: { (error) in
guard error == nil else {
// Handle error.
}
// The channel successfully gets unhidden from the list.
// The current user's channel view should be refreshed to reflect the change.
...
})
Type: BOOL When the channel gets appeared back in the list, determines whether to conceal the messages sent and received before hiding or archiving the channel. If set to YES, the previous messages aren't displayed in the channel. (Default: NO)
IS_ALLOW_AUTO_UNHIDE
Type: BOOL Determines the state and operating behavior of the channel in the list. If set to YES, the channel is hidden from the list, automatically gets unhidden when receiving a new message from other members, and appears back. If set to NO, the channel is archived and disappeared from the list, and never appears back unless the unhideChannelWithCompletionHandler: is called for unarchiving. (Default: YES)
Using the channel.hiddenState, you can check the channel state with regard to the list.
SwiftObjective-C
if channel.hiddenState == SBDChannelHiddenStateFilter.hiddenStateUnhidden {
// Display the channel in the list.
} else if channel.hiddenState == SBDChannelHiddenStateFilter.hiddenAllowAutoUnhide {
// Hide the channel from the list, and get it appeared back on condition.
} else if channel.hiddenState == SBDChannelHiddenStateFilter.hiddenPreventAutoUnhide {
// Archive the channel, and get it appeared back in the list only when the unhideChannel() is called.
}
You can also filter channels by their state like the following:
SwiftObjective-C
let listQuery = SBDGroupChannel.createMyGroupChannelListQuery()
// The filter options are limited to 'SBDChannelHiddenStateFilter.unhiddenOnly', 'SBDChannelHiddenStateFilter.hiddenOnly', 'SBDChannelHiddenStateFilter.hiddenAllowAutoUnhide', or 'SBDChannelHiddenStateFilter.hiddenPreventAutoUnhide'.
// If set to 'SBDChannelHiddenStateFilter.hiddenOnly', hidden and archived channels are returned.
listQuery?.channelHiddenStateFilter = SBDChannelHiddenStateFilter.hiddenPreventAutoUnhide
listQuery?.loadNextPage(completionHandler: { (groupChannels, error) in
guard error == nil else {
// Handle error.
}
// Only archived channels are returned in a result list through the "groupChannels" parameter of the callback method.
})
Using the SBDGroupChannelListQuery's userIdsExactFilter or userIdsIncludeFilter, you can filter group channels by user IDs. Let's assume the ID of the current user is Harry and the user is a member of two group channels:
channelA consists of Harry, John, and Jay.
channelB consists of Harry, John, Jay, and Jin.
A userIdsExactFilter returns a list of the current user's group channels containing exactly the queried user IDs. In case you specify only one user ID in the filter, the filter returns a list of the current user's one (distinct) or more 1-to-1 group channels with the specified user.
SwiftObjective-C
let listQuery = SBDGroupChannel.createMyGroupChannelListQuery()
listQuery?.userIdsExactFilter = ["John", "Jay"]
listQuery?.loadNextPage(completionHandler: { (groupChannels, error) in
guard error == nil else {
// Handle error.
}
// Only channelA is returned in a result list through the "list" parameter of the callback method.
})
A userIdsIncludeFilter returns a list of the current user's group channels including the queried user IDs partially and exactly. Two different results can be returned according to the value of the queryType parameter.
SwiftObjective-C
let listQuery = SBDGroupChannel.createMyGroupChannelListQuery()
listQuery?.setUserIdsIncludeFilter(["John", "Jay", "Jin"], queryType: SBDGroupChannelListQueryType.and)
listQuery?.loadNextPage(completionHandler: { (groupChannels, error) in
guard error == nil else {
// Handle error.
}
// channelA and channelB including {'John'}, channelA and channelB including {'Jay'}, channelB that including {'Jin'}.
// Actually, channelA and channelB are returned in a result list.
})
listQuery?.setUserIdsIncludeFilter(["John", "Jay", "Jin"], queryType: SBDGroupChannelListQueryType.or)
listQuery?.loadNextPage(completionHandler: { (groupChannels, error) in
guard error == nil else {
// Handle error.
}
// channelA and channelB that include {'John'}, plus channelA and channelB that include {'Jay'}, plus channelB that includes {'Jin'}.
// Actually channelA and channelB are returned.
})
In addition to these message types, you can further subclassify a message by specifying its custom type. This custom type takes on the form of a NSString and can be used to search or filter messages. It allows you to append information to your message and customize message categorization.
The following code shows several types of parameters that you can configure to customize text messages by using SBDUserMessageParams. Under the SBDUserMessageParams object, you can assign values to message, data and other properties. By assigning arbitrary string to the data property, you can set custom font size, font type or JSON object. To send your messages, you need to pass the SBDUserMessageParams object as an argument to the parameter in the sendUserMessageWithParams:completionHandler: method.
Through the completionHandler of the sendUserMessageWithParams:completionHandler: method, Sendbird server always notifies whether your message has been successfully sent to the channel. When there is a delivery failure due to network issues, an exception is returned through the callback method.
SwiftObjective-C
var params = SBDUserMessageParams()
params.message = MESSAGE
params.customType = CUSTOM_TYPE
params.data = DATA
params.mentionType = SBDMentionTypeUsers // Either SBDMentionTypeUsers or SBDMentionTypeChannel
params.mentionedUserIds = ["Jeff", "Julia"] // Or .mentionedUsers = LIST_OF_USERS_TO_MENTION
params.metaArrays = ["itemType": ["tablet"], "quality": ["best", "good"]] // A key-value pair
params.targetLanguages = ["fr", "de"] // French and German
params.pushNotificationDeliveryOption = .default
groupChannel.sendUserMessage(with: params, completionHandler: { (userMessage, error) in
guard error == nil else {
// Handle error.
}
// A text message with detailed configuration is successfully sent to the channel.
// By using userMessage.messageId, userMessage.message, userMessage.customType, and so on,
// you can access the result object from Sendbird server to check your SBDUserMessageParams configuration.
// The current user can receive messages from other users through the didReceiveMessage() method of an event delegate.
long long messageId = fileMessage.messageId;
})
A user can also send binary files through the Chat SDK. The two ways to send a binary file are: sending the file itself, or sending a URL.
Sending a raw file means you're uploading it to Sendbird server where it can be downloaded in client apps. When you upload a file directly to the server, there is a size limit imposed on the file depending on your plan. You can see the limit in your dashboard and adjust it with our sales team.
The other option is to send a file hosted on your server. You can pass the file's URL, which represents its location, as an argument to a parameter. In this case, your file is not hosted on Sendbird server and it can only be downloaded from your own server. When you send a file message with a URL, there is no limit on the file size since it's not directly uploaded to Sendbird server.
Note: You can use sendFileMessagesWithParams:progressHandler:sentMessageHandler:completionHandler:, which is another method that allows you to send up to 20 file messages per one method call. Refer to our API Reference to learn more about it.
The following code shows several types of parameters that you can configure to customize your file messages by using SBDFileMessageParams. Under the SBDFileMessageParams object, you can assign specific values to customType and other properties. To send your messages, you need to pass the SBDFileMessageParams object as an argument to the parameter in the sendFileMessageWithParams:completionHandler: method.
Through the completionHandler of the sendFileMessageWithParams:completionHandler: method, Sendbird server always notifies whether your message has been successfully sent to the channel. When there is a delivery failure due to network issues, an exception is returned through the callback method.
SwiftObjective-C
// Sending a file message with a raw file
var thumbnailSizes = [SBDThumbnailSize]()
thumbnailSizes.append(SBDThumbnailSize.make(withMaxCGSize: CGSize(width: 100.0, height: 100.0))!) // Allowed number of thumbnail images: 3
thumbnailSizes.append(SBDThumbnailSize.make(withMaxWidth: 200.0, maxHeight: 200.0)!)
var params = SBDFileMessageParams()
params.file = FILE // Or .fileUrl = FILE_URL (You can also send a file message with a file URL.)
params.fileName = FILE_NAME
params.fileSize = FILE_SIZE
params.mimeType = MIME_TYPE
params.thumbnailSizes = thumbnailSizes
params.customType = CUSTOM_TYPE
params.mentionType = SBDMentionTypeUsers // Either SBDMentionTypeUsers or SBDMentionTypeChannel
params.mentionedUserIds = ["Jeff", "Julia"] // Or .mentionedUsers = LIST_OF_USERS_TO_MENTION
params.pushNotificationDeliveryOption = SBDPushNotificationDeliveryOptionDefault
groupChannel.sendFileMessage(with: params, completionHandler: { (fileMessage, error) in
guard error == nil else {
// Handle error.
}
// A file message with detailed configuration is successfully sent to the channel.
// By using fileMessage.messageId, fileMessage.fileName, fileMessage.customType, and so on,
// you can access the result object from Sendbird server to check your SBDFileMessageParams configuration.
// The current user can receive messages from other users through the didReceiveMessage() method of an event delegate.
...
})
If an app goes to the background while uploading a file such as a profile image or a picture, the app can complete the uploading process by using application:handleEventsForBackgroundURLSession:completionHandler: method in your AppDelegate. To complete the uploading, a background event delegate should be added and implemented in the following delegation. If you don't want to upload the file on the background mode, remove the following delegation in the AppDelegate.
SwiftObjective-C
// AppDelegate.swift
class AppDelegate: UIResponder, UIApplicationDelegate {
func application(_ application: UIApplication, handleEventsForBackgroundURLSession identifier: String, completionHandler: @escaping () -> Void) {
debugPrint("method for handling events for background URL session is waiting to be process. background session id: \(identifier)")
completionHandler()
}
}
A critical alert is a notification that can be sent to iOS devices even when mute or Do Not Disturb is turned on. Critical alert messages can be sent to iOS devices through the sendUserMessageWithParams:completionHandler: and sendFileMessageWithParams:completionHandler: methods. To do so, create an SBDAppleCriticalAlertOptions instance and set it as an attribute of a SBDUserMessageParams instance. Then pass the created SBDUserMessageParams instance as an argument to a parameter in the sendUserMessageWithParams:completionHandler: or sendFileMessageWithParams:completionHandler: method.
Messages sent from other members can be received through the channel:didReceiveMessage: method in the channel delegate. A SBDBaseMessage object for each received message is one of the following three message types.
A text message sent by an admin through the Platform API
The UNIQUE_DELEGATE_ID is a unique identifier to register multiple concurrent delegates.
SwiftObjective-C
class GroupChannelChattingViewController: UIViewController, SBDChannelDelegate {
SBDMain.add(self, identifier: self.delegateIdentifier)
func channel(_ sender: SBDBaseChannel, didReceive message: SBDBaseMessage) {
// You can customize how to display the different types of messages with the result object in the "message" parameter.
if message is SBDUserMessage {
...
}
else if message is SBDFileMessage {
...
}
else if message is SBDAdminMessage {
...
}
}
}
If the UI isn't valid anymore, remove the channel delegate.
When replying to a message through the sendUserMessageWithParams:completionHandler: method, you should specify and pass a SBDUserMessageParams object to the method as a parameter.
SwiftObjective-C
// Create a `SBDUserMessageParams` object.
let params = SBDUserMessageParams(message: MESSAGE_TEXT)
params?.parentMessageId = PARENT_MESSAGE_ID
// Pass the params to the parameter in the `sendUserMessageWithParams:completionHandler:` method.
groupChannel?.sendUserMessage(with: params!, completionHandler: { (message, error) in
if error != nil {
// Handle error.
}
// A reply to a specific message in the form of a text message is successfully sent.
...
})
Type: long long Specifies the unique ID of a parent message which has a thread of replies. If the message sent through the sendUserMessageWithParams:completionHandler: method is a parent message, the value of this property is 0. If the message is a reply to a parent message, the value is the message ID of the parent message.
When replying with a file message through the sendFileMessageWithParams:completionHandler: method, you should specify and pass a SBDFileMessageParams object to the method as a parameter.
SwiftObjective-C
// Create a `SBDFileMessageParams` object.
let params = SBDFileMessageParams(file: FILE!)
params?.parentMessageId = PARENT_MESSAGE_ID
...
// Pass the params to the parameter in the `sendFileMessageWithParams:completionHandler:` method.
groupChannel?.sendFileMessage(with: params!, completionHandler: { (message, error) in
if error != nil {
// Handle error.
}
// A reply to a specific message in the form of a file message is successfully sent.
...
})
Type: long long Specifies the unique ID of a parent message which has a thread of replies. If the message sent through the sendFileMessageWithParams:completionHandler: method is a parent message, the value of this property is 0. If the message is a reply to a parent message, the value is the message ID of the parent message.
Message reactions will help you build a more engaging chat experience that goes beyond text messages. They are a quick and easy way for users to respond to a message. Users can express their acknowledgement of or feelings about a message without written text by simply adding reactions. They can also view and delete their reactions to the message.
Note: Currently, message reactions are only available in group channels.
SwiftObjective-C
let emojiKey = "smile"
// The BASE_MESSAGE below indicates an SBDBaseMessage object to add a reaction to.
groupChannel.addReaction(with: BASE_MESSAGE, key: emojiKey, completionHandler: { (reactionEvent, error) in
guard error == nil else {
// Handle error.
}
...
})
// The BASE_MESSAGE below indicates an SBDBaseMessage object to delete a reaction from.
groupChannel.deleteReaction(with: BASE_MESSAGE, key: emojiKey, completionHandler: { (reactionEvent, error) in
guard error == nil else {
// Handle error.
}
...
})
// Note: To add or remove the emoji of which key matches 'smile' below the message on the current user's chat view,
// the apply() method should be called in the channel event delegate's updatedReaction() method.
You can decide how to display reactions that were added to messages in the current user’s chat view.
var params = SBDMessageListParams()
params.includeReactions = INCLUDE_REACTIONS
...
groupChannel.getMessagesByTimestamp(TIMESTAMP, params: params, completionHandler: { (messages, error) in
guard error == nil else {
// Handle error.
}
for message in messages! {
for reaction in message.reactions {
// Check if this emoji has been used when the current user reacted to the message.
if reaction.userIds.firstIndex(of: SBDMain.getCurrentUser()!.userId) != nil {
let key = reaction.key
let updatedAt = reaction.updatedAt
// Show the emoji however you want on the current user's chat view.
}
}
}
})
Note: By using the SBDPreviousMessageListQuery's loadPreviousMessagesWithLimit:reverse:completionHandler: method, messages along with their reactions can also be retrieved. To learn more, refer to the Load previous messages section below.
If one of the channel members reacts to a message, the channel:updatedReaction: method in the channel event delegate will be invoked on all channel members’ devices including the one that belongs to the current user. The applyReactionEvent: method will reflect the reaction change to the message in real time.
SwiftObjective-C
func channel(_ sender: SBDBaseChannel, updatedReaction reactionEvent: SBDReactionEvent) {
...
// If there is a message with the reactionEvent.messageId,
// you can apply the reaction change to the message by calling the apply() method.
message.apply(reactionEvent)
// Add or remove an emoji below the message on the current user's chat view.
}
By using the loadPreviousMessagesWithLimit:reverse:completionHandler: method of a SBDPreviousMessageListQuery instance which returns a list of SBDBaseMessage objects, you can retrieve a set number of previous messages in a group channel. With a returned list, you can display the past messages in your UI once they have loaded.
Note: You can decide whether a user can see the messages sent prior to the user joining a group channel. In your dashboard, go to the Settings > Chat > Channels > Group channels, there is the Chat history option. If turned on, new users are allowed to view a message history in joined group channels. If turned off, new users aren't allowed to see the messages prior to joining a group channel.
SwiftObjective-C
// There should be only one single instance per channel.
let listQuery = groupChannel.createPreviousMessageListQuery()
listQuery?.includeMetaArray = true // Retrieve a list of messages along with their metaarrays.
listQuery?.includeReactions = true // Retrieve a list of messages along with their reactions.
...
// Retrieving previous messages.
listQuery?.loadPreviousMessages(withLimit: LIMIT, reverse: REVERSE, completionHandler: { (messages, error) in
guard error == nil else {
// Handle error.
}
...
})
Type: NSInteger Specifies the number of results to return per call. Acceptable values are 1 to 100, inclusive. The recommended value for this parameter is 30.
REVERSE
Type: BOOL Determines whether to sort the retrieved messages in reverse order. If set to YES, returns a list of messages which the latest comes at first and the earliest at last. the results are sorted in reverse order. If set to *NO, returns a list of messages which the earliest comes at first and the latest at last.
A LIMIT parameter indicates how many messages to be included in a returned list. A SBDPreviousMessageListQuery instance itself does pagination of a result set according to the value of the LIMIT parameter, and internally manages a token to retrieve the next page in the result set.
Each time the loadPreviousMessagesWithLimit:reverse:completionHandler: method is called, the instance retrieves a set number of messages in the next page and then updates the token's value to complete the current call and prepare a next call.
If you create a new query instance and call the loadPreviousMessagesWithLimit:reverse:completionHandler: method, a set number of the most recent messages are retrieved because its token has nothing to do with the previously created instance. So we recommend that you create a single query instance and store it as a member variable for traversing through the entire message history.
Note: Before calling loadPreviousMessagesWithLimit:reverse:completionHandler: method again, you should receive a success callback through the completionHandler first.
The following table shows all the supported filters for SBDPreviousMessageListQuery to search for messages you want to retrieve. You can use any filters in a similar fashion with the sample code above.
The following code shows several types of parameters that you can configure to customize a message query by using SBDMessageListParams. Under the SBDMessageListParams object, you can assign specific values to previousResultSize, messageType, and other properties. To retrieve messages in a channel, you need to pass the SBDMessageListParams object as an argument to the parameter in the getMessagesByTimestamp:params:completionHandler: method.
Objective-CSwift
SBDMessageListParams *params = [[SBDMessageListParams alloc] init];
[params setIsInclusive:IS_INCLUSIVE];
[params setPreviousResultSize:PREVIOUS_RESULT_SIZE];
[params setNextResultSize:NEXT_RESULT_SIZE];
[params setReverse:REVERSE];
[params setMessageType:MESSAGE_TYPE];
[params setCustomType:CUSTOM_TYPE];
[groupChannel getMessagesByTimestamp:TIMESTAMP params:params completionHandler:^(NSArray<SBDBaseMessage *> * _Nullable messages, SBDError * _Nullable error) {
if (error != nil) {
// Handle error.
}
// A list of previous and next messages on both sides of a specified timestamp is successfully retrieved.
// Through the "messages" parameter of the callback method,
// you can access and display the data of each message from the result list that Sendbird server has passed to the callback method.
[self.messages addObjectsFromArray:messages];
}];
Type: long long Specifies the timestamp to be the reference point of a retrieval, in Unix milliseconds.
IS_INCLUSIVE
Type: BOOL Determines whether to include the messages sent exactly on the TIMESTAMP.
PREVIOUS_RESULT_SIZE
Type: NSInteger Specifies the number of messages to retrieve, which are sent previously before a specified timestamp. Note that the actual number of results may be larger than the set value when there are multiple messages with the same timestamp as the earliest message.
NEXT_RESULT_SIZE
Type: NSInteger Specifies the number of messages to retrieve, which are sent later after a specified timestamp. Note that the actual number of results may be larger than the set value when there are multiple messages with the same timestamp as the latest message.
REVERSE
Type: BOOL Determines whether to sort the retrieved messages in reverse order.
MESSAGE_TYPE
Type: SBDMessageTypeFilter Specifies the message type to filter the messages with the corresponding type. Acceptable values are SBDMessageTypeFilterAll, SBDMessageTypeFilterUser, SBDMessageTypeFilterFile, and SBDMessageTypeFilterAdmin.
CUSTOM_TYPE
Type: NSString Specifies the custom message type to filter the messages with the corresponding custom type.
var params = SBDMessageListParams()
params.isInclusive = IS_INCLUSIVE
params.previousResultSize = PREVIOUS_RESULT_SIZE
params.nextResultSize = NEXT_RESULT_SIZE
params.reverse = REVERSE
params.messageType = MESSAGE_TYPE
params.customType = CUSTOM_TYPE
groupChannel.getMessages(byMessageId: MESSAGE_ID, params: params, completionHandler: { (messages, error) in
guard error == nil else {
// Handle error.
}
// A list of previous and next messages on both sides of a specified message ID is successfully retrieved.
// Through the "messages" parameter of the callback method,
// you can access and display the data of each message from the result list that Sendbird server has passed to the callback method.
self.messages += messages!
})
Type: long long Specifies the unique ID of the message to be the reference point of a retrieval.
IS_INCLUSIVE
Type: BOOL Determines whether to include the message identified with a specified message ID.
PREVIOUS_RESULT_SIZE
Type: NSInteger Specifies the number of messages to retrieve, which are sent previously before a specified message ID.
NEXT_RESULT_SIZE
Type: NSInteger Specifies the number of messages to retrieve, which are sent later after a specified timestamp.
REVERSE
Type: BOOL Determines whether to sort the retrieved messages in reverse order.
MESSAGE_TYPE
Type: SBDMessageTypeFilter Specifies the message type to filter the messages with the corresponding type. Acceptable values are SBDMessageTypeFilterAll, SBDMessageTypeFilterUser, SBDMessageTypeFilterFile, and SBDMessageTypeFilterAdmin.
CUSTOM_TYPE
Type: NSString Specifies the custom message type to filter the messages with the corresponding custom type.
Type: NSInteger Specifies the number of results to return per call. Acceptable values are 1 to 100, inclusive. The recommended value for this parameter is 30.
REVERSE
Type: BOOL Determines whether to sort the retrieved messages in reverse order. If false, the results are in ascending order.
INCLUDE_THREAD_INFO
Type: BOOL Determines whether to include the thread information of the messages in the results when the results contain parent messages.
REPLY_TYPE
Type: ENUM
Specifies the type of message to include in the results. - NONE (default): All messages that are not replies. These message may or may not have replies in its thread. - ALL: All messages including threaded and non-threaded parent messages as well as its replies. - ONLY_REPLY_TO_CHANNEL: Messages that are not threaded. It only includes the parent messages and replies that were sent to the channel.
INCLUDE_PARENT_MESSAGE_INFO
Type: BOOL
Determines whether to include the information of the parent messages in the result. (Default: false)
INCLUDE_REPLIES
(Deprecated) Type: BOOL** Determines whether to include replies in the results.*
INCLUDE_PARENT_MESSAGE_TEXT
Type: BOOL Determines whether to include the parent message text in the results when the retrieved messages are replies in a thread. If the type of the parent message is SBDUserMessage, the value is a message property. If it is a SBDFileMessage, the value is the name of the uploaded file.
Type: NSInteger Specifies the number of messages to retrieve that were sent before the specified timestamp or message ID.
nextResultSize
Type: NSInteger Specifies the number of messages to retrieve that were sent after the specified timestamp or message ID.
isInclusive
Type: BOOL Determines whether to include the messages with the matching timestamp or message ID in the results.
reverse
Type: BOOL Determines whether to sort the retrieved messages in reverse order. If false, the results are in ascending order.
includeThreadInfo
Type: BOOL Determines whether to include the thread information of the messages in the results when the results contain parent messages.
replyType
Type: ENUM
Specifies the type of message to include in the results. - NONE (default): All messages that are not replies. These message may or may not have replies in its thread. - ALL: All messages including threaded and non-threaded parent messages as well as its replies. - ONLY_REPLY_TO_CHANNEL: Messages that are not threaded. It only includes the parent messages and replies that were sent to the channel.
includeParentMessageInfo
Type: BOOL
Determines whether to include the information of the parent messages in the result. (Default: false)
includeReplies
(Deprecated)Type: BOOL Determines whether to include replies in the results.
includeParentMessageText
(Deprecated)Type: BOOL Determines whether to include the parent message text in the results when the messages are replies in a thread. If the type of the parent message is SBDUserMessage, the value is a message property. If it is SBDFileMessage, the value is the name of the uploaded file.
The getMessagesByTimestamp:params:completionHandler: method returns a set number of messages of previous and next messages on both sides of a specific timestamp in a channel.
SwiftObjective-C
groupChannel?.getMessagesByTimestamp(TIMESTAMP, params: params, completionHandler: { (messages, error) in
if error != nil {
// Handle error.
}
// A list of previous and next messages on both sides of a specified timestamp is successfully retrieved.
// Through the "messages" parameter of the callback method,
// you can access and display the data of each message from the result list that Sendbird server has passed to the callback method.
self.messages += messages!
...
})
Type: Long Specifies the timestamp to be the reference point for messages to retrieve, in Unix milliseconds format. Messages sent before or after the timestamp can be retrieved.
The getMessagesByMessageId:params:completionHandler: method returns a set number of previous and next messages on both sides of a specific message ID in a channel.
SwiftObjective-C
groupChannel?.getMessagesByMessageId(MESSAGE_ID, params: params, completionHandler: { (messages, error) in
if error != nil {
// Handle error.
}
// A list of previous and next messages on both sides of a specified message ID is successfully retrieved.
// Through the "messages" parameter of the callback method,
// you can access and display the data of each message from the result list that Sendbird server has passed to the callback method.
self.messages += messages!
...
})
Type: long long Specifies the message ID to be the reference point for messages to retrieve. Messages sent before or after the message with the matching message ID can be retrieved.
// Create a `SBDThreadedMessageListParams` object.
let params = SBDThreadedMessageListParams()
params.previousResultSize = PREV_RESULT_SIZE
params.nextResultSize = NEXT_RESULT_SIZE
params.isInclusive = INCLUSIVE
params.reverse = REVERSE
params.includeParentMessageInfo = INCLUDE_PARENT_MESSAGE_INFO
...
// Pass the params to the parameter in the `getThreadedMessagesByTimestamp:params:completionHandler:` method.
parentMessage.getThreadedMessages(byTimestamp: TIMESTAMP, params: params) { (parentMessage, threadedReplies, error) in
if error != nil {
// Handle error.
}
// A list of replies of the specified parent message timestamp is successfully retrieved.
// Through the "threadedReplies" parameter of the callback method,
// you can access and display the data of each message from the result list that Sendbird server has passed to the callback method.
...
}
Type: long long Specifies the timestamp to be the reference point of the retrieval, in Unix milliseconds format.
PREV_RESULT_SIZE
Type: NSInteger Specifies the number of messages to retrieve that were sent before the specified timestamp.
NEXT_RESULT_SIZE
Type: NSInteger Specifies the number of messages to retrieve that were sent after the specified timestamp.
INCLUSIVE
Type: BOOL Determines whether to include the messages with the matching timestamp in the results.
REVERSE
Type: BOOL Determines whether to sort the retrieved messages in reverse order. If false, the results are in ascending order.
INCLUDE_PARENT_MESSAGE_INFO
Type: BOOL
Determines whether to include the information of the parent messages in the result. (Default: false)
INCLUDE_PARENT_MESSAGE_TEXT
(Deprecated)Type: BOOL Determines whether to include the parent message text in the results when the messages are replies in a thread. If the type of the parent message is SBDUserMessage, the value is a message property. If it is SBDFileMessage, the value is the name of the uploaded file.
// Create a `SBDMessageRetrievalParams` object.
let params = SBDMessageRetrievalParams()
params.messageId = MESSAGE_ID
params.channelType = CHANNEL_TYPE
params.channelUrl = CHANNEL_URL
...
// Pass the params to the parameter of the `getMessageWithParams:completionHandler:` method.
SBDBaseMessage.getWith(params) { (message, error) in
if error != nil {
// Handle error.
}
// The specified message is successfully retrieved.
...
}
A user can update any of their own text and file messages sent. An error is returned if a user attempts to update another user's messages. In addition, channel operators can update any messages sent in a channel.
SwiftObjective-C
// For a text Message
var params = SBDUserMessageParams(message: NEW_TEXT_MESSAGE)
params.customType = NEW_CUSTOM_TYPE
params.data = NEW_DATA
// The USER_MESSAGE_ID below indicates the unique message ID of a UserMessage object to update.
groupChannel.updateUserMessage(withMessageId: USER_MESSAGE_ID, userMessageParams: params, completionHandler: { (userMessage, error) in
guard error == nil else {
// Handle error.
}
// The message is successfully updated.
// Through the "userMessage" parameter of the callback method,
// you could check if the update operation has been performed right.
let text = userMessage?.message
...
})
// For a file message
var params = SBDFileMessageParams(fileUrl: NEW_FILE_URL)
params.fileName = NEW_FILE_NAME
params.fileSize = NEW_FILE_SIZE
params.customType = NEW_CUSTOM_TYPE
// The FILE_MESSAGE_ID below indicates the unique message ID of a FileMessage object to update.
groupChannel.updateFileMessage(withMessageId: FILE_MESSAGE_ID, fileMessageParams: params, completionHandler: { (fileMessage, error) in
guard error == nil else {
// Handle error.
}
// The message is successfully updated.
// Through the "fileMessage" parameter of the callback method,
// you could check if the update operation has been performed right.
let customType = fileMessage?.customType
...
})
If a message is updated, the channel:didUpdateMessage: method in the channel delegate will be invoked on all channel participants' devices except the one that updated the message.
A user can delete any messages which were sent by themselves. An error is returned if a user attempts to delete the messages of other members. Also channel operators can delete any messages in a channel.
SwiftObjective-C
// The BASE_MESSAGE below indicates a BaseMessage object to delete.
groupChannel.delete(BASE_MESSAGE, completionHandler: { (error) in
guard error == nil else {
// Handle error.
}
// The message is successfully deleted from the channel.
...
})
If a message is deleted, the channel:messageWasDeleted: method in the channel delegate will be invoked on all channel participants' devices including the one that deleted the message.
By using the resetMyHistoryWithCompletionHandler: method, you can help the current user clear the chat history in a group channel and start a fresh conversation with other members in the same channel. As the method's name implies, the chat history will be cleared only from the channel view of the current user, and will no longer be shown in that view. But the messages are not deleted from the database of the Sendbird system, and other members can still see all the messages in their channel views.
This method simply clears the messages for the user by updating the lastMessage and readReceipts properties of a group channel object in addition to other internally managed data such as the number of the user’s unread message.
When a user is online, all data associated with the group channels they are a member of are automatically updated by the SBDMain instance. However, when a user is disconnected from Sendbird server and reconnects later, you should call the refreshWithCompletionHandler: method to update the channels with the latest information.
Note: If you want to make your users see the channels updated to the most recent when their client apps are in the foreground, we recommend you call the refreshWithCompletionHandler: in the didSucceedReconnection method which receives a callback from Sendbird server when successfully reconnected.
You can retrieve a list of members in a group channel using the members property of a SBDGroupChannel object.
SwiftObjective-C
let members = groupChannel?.members
Members of a group channel are automatically updated when a user is online. But when a user is disconnected from Sendbird server and then reconnected, you should use the refreshWithCompletionHandler: method to update their channels with the latest information. See the Refresh all data related to a group channel section for the sample code.
To stay updated on the online status of each member in a group channel, call the refreshWithCompletionHandler: method before using the members property of a SBDGroupChannel object to retrieve the members of the channel.
By checking the connectionStatus property of each SBDMember object in the members property, you can then retrieve the user's current connection status. The connectionStatus property has one of the following two values:
Note: If your client app needs to keep track of the connection status of users in real time, we recommend that you call periodically the loadNextPageWithCompletionHandler: method of a SBDApplicationUserListQuery instance after specifying its userIdsFilter filter, perhaps in intervals of one minute or more.
Retrieve a list of members and operators in a specific order
The members and operators of a group channel can be retrieved by using the loadNextPageWithCompletionHandler: method of a SBDGroupChannelMemberListQuery instance. For a specific order, set either option in the table below to the order property of SBDGroupChannelMemberListQuery.
Operators are sequenced before the members, both in an alphabetical order.
SwiftObjective-C
let listQuery = groupChannel.createOperatorListQuery()
listQuery?.limit = 10 // In an alphabetical order by default
listQuery?.order = SBDMemberListOrderOperatorThenMemberNicknameAlphabetical
listQuery?.loadNextPage(completionHandler: { (users, error) in
guard error == nil else {
// Handle error.
}
// A list of matching members and operators is successfully retrieved.
// Through the "users" parameter of the callback method,
// you can access the data of each item from the result list that Sendbird server has passed to the callback method.
for user in users! {
...
}
})
For filtering, set one of the options in the table below to the operatorFilter of SBDGroupChannelMemberListQuery.
Value
Description
SBDGroupChannelOperatorFilterAll
No filter is applied to the group channel list (Default).
SBDGroupChannelOperatorFilterOperator
Only operators are retrieved for the list.
SBDGroupChannelOperatorFilterNonOperator
All members, except for operators, are retrieved for the list.
SwiftObjective-C
let listQuery = groupChannel.createMemberListQuery()
listQuery?.limit = 10
listQuery.operatorFilter = SBDGroupChannelOperatorFilterOperator // In an alphabetical order by default
listQuery?.loadNextPage(completionHandler: { (users, error) in
guard error == nil else {
// Handle error.
}
// A list of matching members and operators is successfully retrieved.
// Through the "users" parameter of the callback method,
// you can access the data of each item from the result list that Sendbird server has passed to the callback method.
for user in users! {
...
}
})
You can create a SBDOperatorListQuery instance and use the loadNextPageWithCompletionHandler: method to retrieve a list of operators who monitor and control the activities in a group channel.
SwiftObjective-C
let listQuery = groupChannel.createOperatorListQuery()
listQuery?.loadNextPage(completionHandler: { (users, error) in
guard error == nil else {
// Handle error.
}
// Retrieving operators.
for operator in users! {
...
}
})
You can register members as an operator of a group channel.
SwiftObjective-C
groupChannel.addOperators(withUserIds: [USER_ID_1, USER_ID_2]) { (error) in
guard error == nil else {
// Handle error.
}
// The participants are successfully registered as operators of the channel.
...
}
You can cancel the registration of operators from a group channel but leave them as members.
SwiftObjective-C
groupChannel.removeOperators(withUserIds: [USER_ID_1, USER_ID_2]) { (error) in
guard error == nil else {
// Handle error.
}
// The cancel operation is succeeded,
// and you could display some message to those who are not operators anymore.
...
}
If you want to cancel the registration of all operators in a channel at once, use the following code.
SwiftObjective-C
groupChannel.removeAllOperators { (error) in
guard error == nil else {
// Handle error.
}
// The cancel operation is succeeded,
// and you could display some message to those who are not operators anymore.
...
}
You can create a query instance to get a list of banned or muted users from a group channel. This is only available for users who are registered as operators of a group channel.
Operators of a group channel can remove any users that behave inappropriately in the channel by using our Ban feature. Banned users are immediately expelled from a channel and allowed to join the channel again after the time period set by the operators. The operators can ban and unban users from group channels using the following code.
SwiftObjective-C
SBDGroupChannel.getWithUrl(CHANNEL_URL, completionHandler: { (groupChannel, error) in
guard error == nil else {
// Handle error.
}
if groupChannel?.myRole == SBDRole.operator {
groupChannel?.ban(USER, seconds: SECONDS, description: DESCRIPTION, completionHandler: { (error) in
guard error == nil else {
// Handle error.
}
// The user is successfully banned from the channel.
// You could notify the user of being banned by displaying a prompt.
...
})
groupChannel?.unbanUser(USER, completionHandler: { (error) in
guard error == nil else {
// Handle error.
}
// The user is successfully unbanned for the channel.
// You could notify the user of being unbanned by displaying a prompt.
...
})
}
})
Operators of a group channel can prohibit the selected users from sending messages using our Mute feature. Muted users remain in the channel and are allowed to view the messages, but can't send any messages until the operators unmute them. Operators can mute and unmute users in the channel using the following code:
SwiftObjective-C
SBDGroupChannel.getWithUrl(CHANNEL_URL, completionHandler: { (groupChannel, error) in
if groupChannel?.myRole == SBDRole.operator {
groupChannel?.muteUser(USER, completionHandler: { (error) in
guard error == nil else {
// Handle error.
}
// The user is successfully muted in the channel.
// You could notify the user of being muted by displaying a prompt.
...
})
groupChannel?.unmuteUser(USER, completionHandler: { (error) in
guard error == nil else {
// Handle error.
}
// The user is successfully unmuted in the channel.
// You could notify the user of being unmuted by displaying a prompt.
...
})
}
})
In a group channel, a user can report suspicious or harassing messages as well as the other users who use abusive language. The user can also report channels if there are any inappropriate content or activity within the channel. Based on this feature and our report API, you can build your own in-app system for managing objectionable content and subject.
Specifies the message to report for its suspicious, harassing, or inappropriate content.
OFFENDING_USER
object
Specifies the user who uses offensive or abusive language such as sending explicit messages or inappropriate comments.
REPORT_CATEGORY
enum
Specifies a report category which indicates the reason for reporting. Acceptable values are SBDReportCategorySuspicious, SBDReportCategoryHarassing, SBDReportCategoryInappropriate, and SBDReportCategorySpam.
DESCRIPTION
string
Specifies additional information to include in the report.