GroupChannel
The GroupChannel
class represents a group channel which is a private chat.
The user who wants to join the group channel has to be invited by another user who is already joined
the channel. This class is derived from BaseChannel
. If the BaseChannelDelegate
is added,
the user will automatically receive all messages from the group channels where the user belongs after
connection. The GroupChannel
provides the features of general messaging apps.
- Typing indicator.
- Read status for each message.
- Unread message count in the channel.
- Lastest message in the channel.
The GroupChannel
has a special property, isDistinct
. The distinct property enabled group
channel is always reuesd for same channel members. If a new member gets invited or the member
left from the channel, then the distinct property disabled automatically. If you don’t set distinct property
on the channel, it always create new channel for the same members.
For more information, see Group Channel.
-
Last message of the channel.
-
Represents the channel is super channel or not.
-
Represents the channel is broadcast channel or not.
Since
3.0.171 -
Represents the channel is exclusive channel or not.
Since
4.0.0 -
Represents the channel is public channel or private one.
-
Represents that the channel has access code to enter.
Since
3.0.116 -
Represents the channel is distinct or not.
-
Represents a boolean whether the public group channel is discoverable. It is only for a public group channel. The default value is
true
if the channel is a public group channel. If the channel is not a public group channel, the default value isfalse
.Since
3.0.136 -
Since
4.6.0 -
Since
4.6.0 -
Unread message count of the channel.
-
The number of mentions that user does not read yet in the channel.
Since
3.0.103 -
Channel members
Note
Number of member for Super GroupChannel is limited to 10 -
The number of members.
-
The number of joined members.
-
Timestamp when current user joined
Since
3.0.224 -
Represents which push notification for the current user to receive in a group channel.
Since
3.0.128 -
Represents this channel is hidden or not.
-
Current member’s state in the channel.
-
The role of current user in the channel.
-
The muted state of the current user in the channel.
-
The preference lets to know counts in the channel. The default value is
.all
.Since
3.0.102 -
The time stamp when the current user got a invitation from other user in the channel.
Since
3.0.107 -
The hidden state of the channel.
Since
3.0.122 -
A last read information for the current user.
Since
3.0.138 -
Message offset of a channel. User can only see messages after this offset.
Since
3.0.157 -
A value that sets the message survival time in seconds. In the channel that is created or updated with this option, the read messages are automatically deleted after a determined amount of time. The default value is
-1
that represents the disappearing message is disabled.Note
This feature is available in a 1-on-1 group channel.Since
3.0.172 -
Checks if the channel has a member that has
userId
. -
Gets member in the channel.
-
Gets a user who invites current user to this channel
-
Gets my delivery status in UTC timestamp
-
A list of messageIds of pinned messages.
Since
4.2.0 -
The message that was pinned the last.
Since
4.2.0 -
Compares two channel objects with the channel list order.
Since
3.0.227 -
Default constructor.
-
Encodes this object.
-
Compares this object with given other object.
-
Refreshes this channel instance.
-
Creates a group channel with
GroupChannelCreateParams
class. -
Creates a group channel with
GroupChannelCreateParams
class.Since
3.0.215 -
Creates a group channel with
GroupChannelCreateParams
class.The
completionHandler
ReturnsisCreated
, which notifies thechannel
instance is created now.Since
3.0.122 -
Creates a group channel with
GroupChannelCreateParams
class.The
completionHandler
ReturnsisCreated
, which notifies thechannel
instance is created now.Since
3.0.215
-
Update a group channel with
GroupChannelUpdateParams
class. -
Update a group channel with
GroupChannelUpdateParams
class.Since
3.0.215 -
Gets a group channel instance from channel URL asynchronously.
-
Deletes the group channel. The user has to be an operator of the channel.
Since
3.0.137 -
Resets the history in this channel.
-
Changes a setting that decides which push notification for the current user to receive in the group channel.
If a value of option is
.default
, a push trigger option in this group channel follows a push trigger option of the current user. It is related withSendbirdChat setPushTriggerOption(_:completionHandler:)
.Since
3.0.128 -
Requests a setting that decides which push notification for the current user to receive in the group channel.
Since
3.0.128 -
Sets count preference of current user.
Since
3.0.102 -
Freeze the channel. If channel is frozen, only operators can send messages to the channel.
Since
3.0.89 -
Stop to freeze the channel. If It is not frozen channel, this will be ignored.
Since
3.0.89 -
Invites a single user to the group channel.
-
Invites a single user to the group channel.
-
Invites multiple users to the group channel.
-
Invites multiple users to the group channel.
-
Accpets the invitation.
-
Accpets the invitation from a public group channel that has access code.
Since
3.0.116 -
Declines the invitation.
-
Join a group channel
-
Join a public group channel that has access code.
Since
3.0.116 -
Leaves the group channel. The channel will be disappeared from the channel list. If join the channel, the invitation is required.
-
Leaves the group channel. The channel will be disappeared from the channel list. If join the channel, the invitation is required.
Since
4.0.9 -
Hides the group channel. The channel will be hid from the channel list, but it will be appeared again when the other user send a message in the channel.
-
Hides the group channel with the auto unhide option. The channel will be hid from the channel list. If the
allowAutoUnhide
istrue
, the channel will be appeared again when the other user send a message in the channel. However, if theallowAutoUnhide
isfalse
, the channel will be appeared byunhideChannel(completionHandler:)
method.Since
3.0.122 -
Unhides the group channel.
Since
3.0.122 -
Sends mark as read. The other members in the channel will receive an event. The event will be received in
channelDidUpdateReadStatus:
ofGroupChannelDelegate
. -
Notifies the current user took a screenshot in this channel. The server is going to send an admin message to notify this in the group channel.
Since
3.0.172 -
Pins the message to the channel.
Since
4.2.0 -
Unpins the message from the channel.
Since
4.2.0 -
Creates a query for my group channel list with default params.
-
Creates a query for my group channel list with paramsBuilder.
-
Creates a query for my group channel list.
-
Creates a query for public group channel list.
-
Creates a query for public group channel list.
-
Creates a query for public group channel list.
-
Creates a query for members in group channel.
-
Creates a query for members in group channel.
-
Creates a query for members in group channel.
-
Creates a query for members in group channel.
-
Creates a query for members in group channel.
-
Creates a
PinnedMessageListQuery
object that can be used to retrieve a list of pinned messages in the group channel.Since
4.8.0 -
Creates a
PinnedMessageListQuery
object that can be used to retrieve a list of pinned messages in the group channel.Since
4.8.0 -
Creates a
PinnedMessageListQuery
object that can be used to retrieve a list of pinned messages in the group channel.Since
4.8.0 -
Returns how many members haven’t been read the given message yet.
Since
3.0.185 -
Returns the members who read the given message.
Since
3.0.115 -
Returns the members who didn’t read the given message.
Since
3.0.115 -
Returns how many members haven’t been delivery the given message yet.
Since
3.0.185 -
Creates a file message to be sent at the specified time.
Note
If a user leaves before sending scheduled messages, the scheduled messages will be removed.Since
4.0.0 -
Updates a scheduled file message.
Note
If a user leaves before sending scheduled messages, the scheduled messages will be removed.Since
4.0.0 -
Sends the scheduled message now.
Since
4.0.0 -
Cancels the scheduled message.
Since
4.0.0 -
Creates a user message to be sent at the specified time.
Note
If a user leaves before sending scheduled messages, the scheduled messages will be removed.Since
4.0.2 -
Updates a user message to be sent at the specified time.
Note
If a user leaves before sending scheduled messages, the scheduled messages will be removed.Since
4.0.0 -
Starts typing. The other members in the channel will receive an event.
The event will be received in
channelDidUpdateTypingStatus(_:)
ofGroupChannelDelegate
. -
Ends typing. The other members in the channel will receive an event.
The event will be received in
channelDidUpdateTypingStatus(_:)
ofGroupChannelDelegate
. -
Checks any members in the channel has been typing
-
Returns the users who are typing now.
Since
3.0.202 -
Deserializes and reconstructs the object