GroupChannel (Sendbird Chat SDK for Android reference)

java.lang.Object
- com.sendbird.android.BaseChannel
- - com.sendbird.android.GroupChannel

public final class GroupChannel
extends BaseChannel

Represents a group channel.

Nested Class Summary

Nested Classes
Modifier and Type	Class and Description
`static class`	`GroupChannel.CountPreference` The count preference.
`static interface`	`GroupChannel.GroupChannelAcceptInvitationHandler` GroupChannelAcceptInvitation handler.
`static interface`	`GroupChannel.GroupChannelBanHandler` GroupChannelBan handler.
`static interface`	`GroupChannel.GroupChannelChannelCountHandler` GroupChannelChannelCount handler.
`static interface`	`GroupChannel.GroupChannelCreateDistinctChannelIfNotExistHandler` GroupChannelCreateDistinctChannelIfNotExist handler.
`static interface`	`GroupChannel.GroupChannelCreateHandler` GroupChannelCreate handler.
`static interface`	`GroupChannel.GroupChannelDeclineInvitationHandler` GroupChannelDeclineInvitation handler.
`static interface`	`GroupChannel.GroupChannelDeleteHandler` GroupChannelDelete handler.
`static interface`	`GroupChannel.GroupChannelFreezeHandler` GroupChannelFreeze handler.
`static interface`	`GroupChannel.GroupChannelGetHandler` GroupChannelGet handler.
`static interface`	`GroupChannel.GroupChannelGetMyPushTriggerOptionHandler` GroupChannelGetMyPushTriggerOptionHandler handler.
`static interface`	`GroupChannel.GroupChannelGetPushPreferenceHandler` Deprecated. As of 3.0.10, refer to `isPushEnabled()`.
`static interface`	`GroupChannel.GroupChannelGetUnreadItemCountHandler` GroupChannelGetUnreadItemCountHandler handler.
`static interface`	`GroupChannel.GroupChannelHideHandler` GroupChannelHide handler.
`static interface`	`GroupChannel.GroupChannelInviteHandler` GroupChannelInvite handler.
`static interface`	`GroupChannel.GroupChannelJoinHandler` GroupChannelJoin handler.
`static interface`	`GroupChannel.GroupChannelLeaveHandler` GroupChannelLeave handler.
`static interface`	`GroupChannel.GroupChannelMarkAsReadHandler` Deprecated. As of 3.0.48, replaced by `SendBird.MarkAsReadHandler`.
`static interface`	`GroupChannel.GroupChannelMuteHandler` GroupChannelMute handler.
`static interface`	`GroupChannel.GroupChannelRefreshHandler` GroupChannelRefresh handler.
`static interface`	`GroupChannel.GroupChannelResetMyHistoryHandler` GroupChannelResetMyHistory handler.
`static interface`	`GroupChannel.GroupChannelSetMyCountPreferenceHandler` GroupChannelSetMyCountPreference handler.
`static interface`	`GroupChannel.GroupChannelSetMyPushTriggerOptionHandler` GroupChannelSetMyPushTriggerOptionHandler handler.
`static interface`	`GroupChannel.GroupChannelSetPushPreferenceHandler` GroupChannelSetPushPreference handler.
`static interface`	`GroupChannel.GroupChannelTotalUnreadChannelCountHandler` GroupChannelTotalUnreadChannelCount handler.
`static interface`	`GroupChannel.GroupChannelTotalUnreadMessageCountHandler` GroupChannelTotalUnreadMessageCount handler.
`static interface`	`GroupChannel.GroupChannelUnbanHandler` GroupChannelUnban handler.
`static interface`	`GroupChannel.GroupChannelUnfreezeHandler` GroupChannelUnfreeze handler.
`static interface`	`GroupChannel.GroupChannelUnhideHandler` GroupChannelUnhide handler.
`static interface`	`GroupChannel.GroupChannelUnmuteHandler` GroupChannelUnmute handler.
`static interface`	`GroupChannel.GroupChannelUpdateHandler` GroupChannelUpdate handler.
`static class`	`GroupChannel.HiddenState` The hidden state.
`static class`	`GroupChannel.MemberState` Deprecated. As of 3.0.52, replaced by `GroupChannelListQuery.MemberStateFilter`.
`static class`	`GroupChannel.PushTriggerOption` The push trigger option.
`static interface`	`GroupChannel.RegisterScheduledUserMessageHandler` RegisterScheduledUserMessage handler.
`static class`	`GroupChannel.UnreadItemKey` The unread item key.

Nested classes/interfaces inherited from class com.sendbird.android.BaseChannel
BaseChannel.BaseSendFileMessageHandler, BaseChannel.ChannelType, BaseChannel.CopyFileMessageHandler, BaseChannel.CopyUserMessageHandler, BaseChannel.DeleteMessageHandler, BaseChannel.DeleteMetaCounterHandler, BaseChannel.DeleteMetaDataHandler, BaseChannel.GetMessageChangeLogsByTokenHandler, BaseChannel.GetMessageChangeLogsHandler, BaseChannel.GetMessagesHandler, BaseChannel.GetMyMutedInfoHandler, BaseChannel.MessageMetaArrayHandler, BaseChannel.MessageTypeFilter, BaseChannel.MetaCounterHandler, BaseChannel.MetaDataHandler, BaseChannel.ReactionHandler, BaseChannel.ReportCategory, BaseChannel.ReportHandler, BaseChannel.ReportMessageHandler, BaseChannel.ReportUserHandler, BaseChannel.ResendFileMessageHandler, BaseChannel.ResendFileMessageWithProgressHandler, BaseChannel.ResendUserMessageHandler, BaseChannel.SendFileMessageHandler, BaseChannel.SendFileMessagesHandler, BaseChannel.SendFileMessagesWithProgressHandler, BaseChannel.SendFileMessageWithProgressHandler, BaseChannel.SendUserMessageHandler, BaseChannel.TranslateUserMessageHandler, BaseChannel.UpdateFileMessageHandler, BaseChannel.UpdateUserMessageHandler

Method Summary

All Methods Static Methods Instance Methods Concrete Methods Deprecated Methods
Modifier and Type	Method and Description
`void`	`acceptInvitation(GroupChannel.GroupChannelAcceptInvitationHandler handler)` Accepts the invitation sent to the current `User`.
`void`	`acceptInvitation(java.lang.String accessCode, GroupChannel.GroupChannelAcceptInvitationHandler handler)` Accepts the invitation sent to the current `User`.
`void`	`banUser(User user, java.lang.String description, int seconds, GroupChannel.GroupChannelBanHandler handler)` Bans a member.
`void`	`banUserWithUserId(java.lang.String userId, java.lang.String description, int seconds, GroupChannel.GroupChannelBanHandler handler)` Bans a member.
`static GroupChannel`	`clone(GroupChannel channel)` Clones and returns a new instance of given GroupChannel
`static int`	`compareTo(GroupChannel c1, GroupChannel c2, GroupChannelListQuery.Order order)` Deprecated. As of 3.0.173, replaced by `compareTo(GroupChannel, GroupChannel, GroupChannelListQuery.Order, SortOrder)`.
`static int`	`compareTo(GroupChannel c1, GroupChannel c2, GroupChannelListQuery.Order queryOrder, SortOrder sortOrder)` Compares two given channels and returns 0, -1 or 1 depending on their comparison results.
`BannedUserListQuery`	`createBannedUserListQuery()` Creates a query instance to get the banned user list from this channel.
`static void`	`createChannel(GroupChannelParams params, GroupChannel.GroupChannelCreateHandler handler)` Creates `GroupChannel` with GroupChannelParams.
`static void`	`createChannel(java.util.List<User> users, boolean isDistinct, GroupChannel.GroupChannelCreateHandler handler)` Creates `GroupChannel` with given `User`s.
`static void`	`createChannel(java.util.List<User> users, boolean isDistinct, java.lang.String name, java.lang.Object coverUrlOrImage, java.lang.String data, GroupChannel.GroupChannelCreateHandler handler)` Deprecated. As of 3.0.75, replaced by `createChannel(GroupChannelParams, GroupChannelCreateHandler)`
`static void`	`createChannel(java.util.List<User> users, boolean isDistinct, java.lang.String name, java.lang.Object coverUrlOrImage, java.lang.String data, java.lang.String customType, GroupChannel.GroupChannelCreateHandler handler)` Creates `GroupChannel` with given `User`s.
`static void`	`createChannelWithUserIds(java.util.List<java.lang.String> userIds, boolean isDistinct, GroupChannel.GroupChannelCreateHandler handler)` Creates `GroupChannel` with given `User` IDs.
`static void`	`createChannelWithUserIds(java.util.List<java.lang.String> userIds, boolean isDistinct, java.lang.String name, java.lang.Object coverUrlOrImage, java.lang.String data, GroupChannel.GroupChannelCreateHandler handler)` Deprecated. As of 3.0.75, replaced by `createChannel(GroupChannelParams, GroupChannelCreateHandler)`
`static void`	`createChannelWithUserIds(java.util.List<java.lang.String> userIds, boolean isDistinct, java.lang.String name, java.lang.Object coverUrlOrImage, java.lang.String data, java.lang.String customType, GroupChannel.GroupChannelCreateHandler handler)` Creates `GroupChannel` with given `User` IDs.
`static void`	`createDistinctChannelIfNotExist(GroupChannelParams params, GroupChannel.GroupChannelCreateDistinctChannelIfNotExistHandler handler)` Creates distinct `GroupChannel` with GroupChannelParams.
`GroupChannelMemberListQuery`	`createMemberListQuery()` Creates a query instance to get members.
`static GroupChannelListQuery`	`createMyGroupChannelListQuery()` Creates a query instance to get `GroupChannel`s the current `User` has joined.
`static PublicGroupChannelListQuery`	`createPublicGroupChannelListQuery()` Creates a query instance to get public `GroupChannel`s.
`void`	`declineInvitation(GroupChannel.GroupChannelDeclineInvitationHandler handler)` Declines the invitation sent to the current `User`.
`void`	`delete(GroupChannel.GroupChannelDeleteHandler handler)` Deletes this `GroupChannel`.
`void`	`endTyping()` Sends end typing event.
`void`	`freeze(GroupChannel.GroupChannelFreezeHandler handler)` Freeze this `GroupChannel`.
`static void`	`getChannel(java.lang.String channelUrl, GroupChannel.GroupChannelGetHandler handler)` Gets a `GroupChannel` with given channel URL.
`static void`	`getChannelCount(GroupChannel.MemberState memberState, GroupChannel.GroupChannelChannelCountHandler handler)` Deprecated. As of 3.0.52, replaced by `getChannelCount(GroupChannelListQuery.MemberStateFilter, GroupChannelChannelCountHandler)`.
`static void`	`getChannelCount(GroupChannelListQuery.MemberStateFilter memberStateFilter, GroupChannel.GroupChannelChannelCountHandler handler)` Deprecated. As of 3.0.75, replaced by `SendBird.getGroupChannelCount(GroupChannelListQuery.MemberStateFilter, GroupChannel.GroupChannelChannelCountHandler)`.
`User`	`getCreator()` Retrieves the creator of this channel.
`java.lang.String`	`getCustomType()` Gets the channel custom type.
`int`	`getDeliveryReceipt(BaseMessage message)` Deprecated. As of 3.0.136, replaced by `getUndeliveredMemberCount(BaseMessage)`.
`GroupChannel.HiddenState`	`getHiddenState()` Gets hidden state of this channel.
`long`	`getInvitedAt()` Gets my invitation timestamp.
`User`	`getInviter()` Gets the inviter of the current `User` to this channel.
`long`	`getJoinedAt()` Gets the timestamp when the current user joined.
`int`	`getJoinedMemberCount()` Gets the total joined member count for this channel.
`BaseMessage`	`getLastMessage()` Gets the last message.
`long`	`getLastSeenAtBy(User user)` Deprecated. As of 3.0.49, this method is deprecated.
`long`	`getLastSeenAtByWithUserId(java.lang.String userId)` Deprecated. As of 3.0.49, this method is deprecated.
`BaseMessage`	`getLatestPinnedMessage()`
`int`	`getMemberCount()` Gets the total member count for this channel.
`java.util.List<Member>`	`getMembers()` Gets member list for this channel.
`long`	`getMessageOffsetTimestamp()` This property is set when `resetMyHistory(GroupChannelResetMyHistoryHandler)` ()} and `hide(boolean, GroupChannelHideHandler)` ()} is called.
`int`	`getMessageSurvivalSeconds()` Gets the message survival seconds in this channel.
`GroupChannel.CountPreference`	`getMyCountPreference()` Checks if unread message count is enabled for this channel.
`long`	`getMyLastRead()` Returns current user's last read receipt timestamp in channel.
`Member.MemberState`	`getMyMemberState()` Gets my member state.
`Member.MutedState`	`getMyMutedState()` Gets my muted state in this channel.
`GroupChannel.PushTriggerOption`	`getMyPushTriggerOption()` Gets my push trigger option.
`void`	`getMyPushTriggerOption(GroupChannel.GroupChannelGetMyPushTriggerOptionHandler handler)` Gets push trigger option of this channel.
`Member.Role`	`getMyRole()` Gets my role in this channel.
`java.util.List<java.lang.Long>`	`getPinnedMessageIds()`
`void`	`getPushPreference(GroupChannel.GroupChannelGetPushPreferenceHandler handler)` Deprecated. As of 3.0.10, replaced by `isPushEnabled()`.
`java.util.List<Member>`	`getReadMembers(BaseMessage message)` Deprecated. As of 3.0.75, replaced by `getReadMembers(BaseMessage, boolean)`.
`java.util.List<Member>`	`getReadMembers(BaseMessage message, boolean includeAllMembers)` Gets the member list who have read the given message.
`int`	`getReadReceipt(BaseMessage message)` Deprecated. As of 3.0.136, replaced by `getUnreadMemberCount(BaseMessage)`.
`java.util.Map<java.lang.String,ReadStatus>`	`getReadStatus()` Deprecated. As of 3.0.75, replaced by `getReadStatus(boolean)`.
`java.util.Map<java.lang.String,ReadStatus>`	`getReadStatus(boolean includeAllMembers)` Gets `ReadStatus` for all members in this `GroupChannel`.
`static void`	`getTotalUnreadChannelCount(GroupChannel.GroupChannelTotalUnreadChannelCountHandler handler)` Deprecated. As of 3.0.75, replaced by `SendBird.getTotalUnreadChannelCount(GroupChannel.GroupChannelTotalUnreadChannelCountHandler)`.
`static void`	`getTotalUnreadMessageCount(GroupChannel.GroupChannelTotalUnreadMessageCountHandler handler)` Deprecated. As of 3.0.75, replaced by `SendBird.getTotalUnreadMessageCount(GroupChannel.GroupChannelTotalUnreadMessageCountHandler)`.
`static void`	`getTotalUnreadMessageCount(GroupChannelTotalUnreadMessageCountParams params, GroupChannel.GroupChannelTotalUnreadMessageCountHandler handler)` Deprecated. As of 3.0.75, replaced by `SendBird.getTotalUnreadMessageCount(GroupChannelTotalUnreadMessageCountParams, GroupChannel.GroupChannelTotalUnreadMessageCountHandler)`.
`static void`	`getTotalUnreadMessageCount(java.util.List<java.lang.String> channelCustomTypes, GroupChannel.GroupChannelTotalUnreadMessageCountHandler handler)` Deprecated. As of 3.0.75, replaced by `SendBird.getTotalUnreadMessageCount(List, GroupChannel.GroupChannelTotalUnreadMessageCountHandler)`.
`java.util.List<Member>`	`getTypingMembers()` Deprecated. As of 3.0.145, replaced by `getTypingUsers()`.
`java.util.List<User>`	`getTypingUsers()` Gets typing user list.
`int`	`getUndeliveredMemberCount(BaseMessage message)` Returns how many members haven't delivered the given message.
`static void`	`getUnreadItemCount(java.util.Collection<GroupChannel.UnreadItemKey> keys, GroupChannel.GroupChannelGetUnreadItemCountHandler handler)` Deprecated. As of 3.0.75, replaced by `SendBird.getUnreadItemCount(Collection, GroupChannel.GroupChannelGetUnreadItemCountHandler)`.
`int`	`getUnreadMemberCount(BaseMessage message)` Returns how many members haven't read the given message.
`java.util.List<Member>`	`getUnreadMembers(BaseMessage message)` Deprecated. As of 3.0.75, replaced by `getUnreadMembers(BaseMessage, boolean)`.
`java.util.List<Member>`	`getUnreadMembers(BaseMessage message, boolean includeAllMembers)` Gets the member list who haven't read the given message.
`int`	`getUnreadMentionCount()` Gets the unread mention count for this channel for the current `User`.
`int`	`getUnreadMessageCount()` Gets the unread message count for this channel for the current `User`.
`void`	`hide(boolean hidePreviousMessages, boolean allowAutoUnhide, GroupChannel.GroupChannelHideHandler handler)` Hides this channel from the current `User`'s `GroupChannel` list.
`void`	`hide(boolean hidePreviousMessages, GroupChannel.GroupChannelHideHandler handler)` Hides this channel from the current `User`'s `GroupChannel` list.
`void`	`hide(GroupChannel.GroupChannelHideHandler handler)` Hides this channel from the current `User`'s `GroupChannel` list.
`void`	`invite(java.util.List<User> users, GroupChannel.GroupChannelInviteHandler handler)` Invites `User`s to this channel.
`void`	`invite(User user, GroupChannel.GroupChannelInviteHandler handler)` Invites a `User` to this channel.
`void`	`inviteWithUserId(java.lang.String userId, GroupChannel.GroupChannelInviteHandler handler)` Invites a `User` to this channel.
`void`	`inviteWithUserIds(java.util.List<java.lang.String> userIds, GroupChannel.GroupChannelInviteHandler handler)` Invites `User`s top this channel.
`boolean`	`isAccessCodeRequired()` Checks if this channel requires access code to join.
`boolean`	`isBroadcast()` Checks this channel is a broadcast `GroupChannel`.
`boolean`	`isDiscoverable()` Checks this channel is discoverable in the result of `PublicGroupChannelListQuery`.
`boolean`	`isDistinct()` Checks this channel is a distinct `GroupChannel`.
`boolean`	`isHidden()` Checks if this channel is hidden.
`boolean`	`isPublic()` Checks this channel is a public `GroupChannel`.
`boolean`	`isPushEnabled()` Deprecated. As of 3.0.86, replaced by `getMyPushTriggerOption()`.
`boolean`	`isSuper()` Checks this channel is a super `GroupChannel`.
`boolean`	`isTyping()` Checks if one or more members are typing.
`void`	`join(GroupChannel.GroupChannelJoinHandler handler)` Joins this channel if this channel is public.
`void`	`join(java.lang.String accessCode, GroupChannel.GroupChannelJoinHandler handler)` Joins this channel if this channel is public.
`void`	`leave(GroupChannel.GroupChannelLeaveHandler handler)` Leaves this channel.
`void`	`markAsDelivered()` Deprecated. As of 3.0.150, replaced by `SendBird.markAsDelivered(Map)`.
`void`	`markAsRead()` Deprecated. As of 3.0.172, replaced by `markAsRead(SendBird.MarkAsReadHandler)`.
`void`	`markAsRead(SendBird.MarkAsReadHandler handler)` Sends mark as read to this channel with a `SendBird.MarkAsReadHandler`.
`static void`	`markAsReadAll(GroupChannel.GroupChannelMarkAsReadHandler handler)` Deprecated. As of 3.0.48, replaced by `SendBird.markAsReadAll(SendBird.MarkAsReadHandler)`.
`void`	`muteUser(User user, GroupChannel.GroupChannelMuteHandler handler)` Mutes `User`.
`void`	`muteUser(User user, java.lang.String description, int seconds, GroupChannel.GroupChannelMuteHandler handler)` Mutes `User`.
`void`	`muteUserWithUserId(java.lang.String userId, GroupChannel.GroupChannelMuteHandler handler)` Mutes `User`.
`void`	`muteUserWithUserId(java.lang.String userId, java.lang.String description, int seconds, GroupChannel.GroupChannelMuteHandler handler)` Mutes `User`.
`void`	`refresh(GroupChannel.GroupChannelRefreshHandler handler)` Refreshes all the data of this channel.
`void`	`registerScheduledUserMessage(ScheduledUserMessageParams params, GroupChannel.RegisterScheduledUserMessageHandler handler)` This method registers a user message to be sent at the specified time.
`void`	`resetMyHistory(GroupChannel.GroupChannelResetMyHistoryHandler handler)` Resets the chat history of this channel for the current User.
`void`	`setMyCountPreference(GroupChannel.CountPreference preference, GroupChannel.GroupChannelSetMyCountPreferenceHandler handler)` Sets my count preference for this channel.
`void`	`setMyPushTriggerOption(GroupChannel.PushTriggerOption pushTriggerOption, GroupChannel.GroupChannelSetMyPushTriggerOptionHandler handler)` Sets push trigger option of this channel.
`void`	`setPushPreference(boolean pushOn, GroupChannel.GroupChannelSetPushPreferenceHandler handler)` Deprecated. As of 3.0.151, replaced by `setMyPushTriggerOption(PushTriggerOption, GroupChannelSetMyPushTriggerOptionHandler)`.
`void`	`startTyping()` Sends start typing event.
`java.lang.String`	`toString()`
`void`	`unbanUser(User user, GroupChannel.GroupChannelUnbanHandler handler)` Unbans `User`.
`void`	`unbanUserWithUserId(java.lang.String userId, GroupChannel.GroupChannelUnbanHandler handler)` Unbans `User`.
`void`	`unfreeze(GroupChannel.GroupChannelUnfreezeHandler handler)` Unfreeze this `GroupChannel`.
`void`	`unhide(GroupChannel.GroupChannelUnhideHandler handler)` Unhides this channel from the current `User`'s `GroupChannel` list.
`void`	`unmuteUser(User user, GroupChannel.GroupChannelUnmuteHandler handler)` Unmutes `User`.
`void`	`unmuteUserWithUserId(java.lang.String userId, GroupChannel.GroupChannelUnmuteHandler handler)` Unmutes `User`.
`void`	`updateChannel(boolean isDistinct, java.lang.String name, java.lang.Object coverUrlOrImage, java.lang.String data, GroupChannel.GroupChannelUpdateHandler handler)` Deprecated. As of 3.0.75, replaced by `updateChannel(GroupChannelParams, GroupChannelUpdateHandler)`
`void`	`updateChannel(boolean isDistinct, java.lang.String name, java.lang.Object coverUrlOrImage, java.lang.String data, java.lang.String customType, GroupChannel.GroupChannelUpdateHandler handler)` Update this channel.
`void`	`updateChannel(GroupChannelParams params, GroupChannel.GroupChannelUpdateHandler handler)` Update this channel with GroupChannelParams.
`void`	`updateChannel(java.lang.String name, java.lang.Object coverUrlOrImage, java.lang.String data, GroupChannel.GroupChannelUpdateHandler handler)` Update this channel.

Methods inherited from class com.sendbird.android.BaseChannel
addMessageMetaArrayValues, addMessageMetaArrayValues, addOperators, addReaction, buildFromSerializedData, cancelFileMessageUpload, copyFileMessage, copyUserMessage, createMessageListQuery, createMessageMetaArrayKeys, createMetaCounters, createMetaData, createOperatorListQuery, createPreviousMessageListQuery, decreaseMetaCounters, deleteAllMetaCounters, deleteAllMetaData, deleteMessage, deleteMessageMetaArrayKeys, deleteMetaCounter, deleteMetaData, deleteReaction, equals, getAllMetaCounters, getAllMetaData, getCachedMetaData, getCoverUrl, getCreatedAt, getData, getMessageChangeLogsByTimestamp, getMessageChangeLogsByTimestamp, getMessageChangeLogsByTimestamp, getMessageChangeLogsByToken, getMessageChangeLogsByToken, getMessageChangeLogsByToken, getMessageChangeLogsSinceTimestamp, getMessageChangeLogsSinceToken, getMessagesByMessageId, getMessagesByTimestamp, getMetaCounters, getMetaData, getMyMutedInfo, getName, getNextMessagesById, getNextMessagesById, getNextMessagesById, getNextMessagesById, getNextMessagesByTimestamp, getNextMessagesByTimestamp, getNextMessagesByTimestamp, getNextMessagesByTimestamp, getPreviousAndNextMessagesById, getPreviousAndNextMessagesById, getPreviousAndNextMessagesById, getPreviousAndNextMessagesById, getPreviousAndNextMessagesByTimestamp, getPreviousAndNextMessagesByTimestamp, getPreviousAndNextMessagesByTimestamp, getPreviousAndNextMessagesByTimestamp, getPreviousMessagesById, getPreviousMessagesById, getPreviousMessagesById, getPreviousMessagesById, getPreviousMessagesByTimestamp, getPreviousMessagesByTimestamp, getPreviousMessagesByTimestamp, getPreviousMessagesByTimestamp, getUrl, hashCode, increaseMetaCounters, isEphemeral, isFrozen, isGroupChannel, isOpenChannel, removeAllOperators, removeMessageMetaArrayValues, removeMessageMetaArrayValues, removeOperators, report, reportMessage, reportUser, resendFileMessage, resendFileMessage, resendMessage, resendMessage, resendMessage, resendUserMessage, sendFileMessage, sendFileMessage, sendFileMessage, sendFileMessage, sendFileMessage, sendFileMessage, sendFileMessage, sendFileMessage, sendFileMessage, sendFileMessage, sendFileMessages, sendFileMessages, sendUserMessage, sendUserMessage, sendUserMessage, sendUserMessage, sendUserMessage, serialize, translateUserMessage, updateFileMessage, updateFileMessage, updateMetaCounters, updateMetaData, updateUserMessage, updateUserMessage

Methods inherited from class java.lang.Object
getClass, notify, notifyAll, wait, wait, wait

- Method Detail
  - refresh
```
public void refresh(GroupChannel.GroupChannelRefreshHandler handler)
```
    Refreshes all the data of this channel.
    
    Parameters:
    
    handler - Callback handler.
  - createMyGroupChannelListQuery
```
public static GroupChannelListQuery createMyGroupChannelListQuery()
```
    Creates a query instance to get GroupChannels the current User has joined.
    
    Returns:
    
    Query to use.
  - createPublicGroupChannelListQuery
```
public static PublicGroupChannelListQuery createPublicGroupChannelListQuery()
```
    Creates a query instance to get public GroupChannels.
    
    Returns:
    
    Query to use.
    
    Since:
    
    3.0.50
  - createChannel
```
public static void createChannel(java.util.List<User> users,
                                 boolean isDistinct,
                                 GroupChannel.GroupChannelCreateHandler handler)
```
    Creates GroupChannel with given Users.
    
    Parameters:
    
    users - Users to join.
    
    isDistinct - If set true, a distinct GroupChannel is created. So later when you create GroupChannel with same Users and this flag being true, the channel URL does not change, which means the messages between Users remain at the channel.
    If this flag is false, a new GroupChannel is created even though Users are same. As a result, you get a totally new channel URL (the old channel still remains), which means the Users start new conversation.
    
    handler - Callback handler.
  - createChannel
```
@Deprecated
public static void createChannel(java.util.List<User> users,
                                             boolean isDistinct,
                                             java.lang.String name,
                                             java.lang.Object coverUrlOrImage,
                                             java.lang.String data,
                                             GroupChannel.GroupChannelCreateHandler handler)
                                      throws java.lang.ClassCastException
```
    Deprecated. As of 3.0.75, replaced by createChannel(GroupChannelParams, GroupChannelCreateHandler)
    
    Creates GroupChannel with given Users.
    
    Parameters:
    
    users - Users to join.
    
    isDistinct - If set true, a distinct GroupChannel is created. So later when you create GroupChannel with same Users and this flag being true, the channel URL does not change, which means the messages between Users remain at the channel.
    If this flag is false, a new GroupChannel is created even though Users are same. As a result, you get a totally new channel URL (the old channel still remains), which means the Users start new conversation.
    
    name - Name of channel.
    
    coverUrlOrImage - Cover URL or image file of channel. Pass String, File or null only, throws exception otherwise. This can be used as thumbnail of channel for instance.
    
    data - Custom data for channel.
    
    handler - Callback handler.
    
    Throws:
    
    java.lang.ClassCastException - If coverUrlOrImage is none of String, File or null, exception occurs.
    
    Since:
    
    3.0.5
  - createChannel
```
public static void createChannel(java.util.List<User> users,
                                 boolean isDistinct,
                                 java.lang.String name,
                                 java.lang.Object coverUrlOrImage,
                                 java.lang.String data,
                                 java.lang.String customType,
                                 GroupChannel.GroupChannelCreateHandler handler)
                          throws java.lang.ClassCastException
```
    Creates GroupChannel with given Users.
    
    Parameters:
    
    users - Users to join.
    
    isDistinct - If set true, a distinct GroupChannel is created. So later when you create GroupChannel with same Users and this flag being true, the channel URL does not change, which means the messages between Users remain at the channel.
    If this flag is false, a new GroupChannel is created even though Users are same. As a result, you get a totally new channel URL (the old channel still remains), which means the Users start new conversation.
    
    name - Name of channel.
    
    coverUrlOrImage - Cover URL or image file of channel. Pass String, File or null only, throws exception otherwise. This can be used as thumbnail of channel for instance.
    
    data - Custom data for channel.
    
    customType - Custom type for channel.
    
    handler - Callback handler.
    
    Throws:
    
    java.lang.ClassCastException - If coverUrlOrImage is none of String, File or null, exception occurs.
    
    Since:
    
    3.0.9
  - createChannelWithUserIds
```
public static void createChannelWithUserIds(java.util.List<java.lang.String> userIds,
                                            boolean isDistinct,
                                            GroupChannel.GroupChannelCreateHandler handler)
```
    Creates GroupChannel with given User IDs.
    
    Parameters:
    
    userIds - User IDs to join.
    
    isDistinct - If set true, a distinct GroupChannel is created. So later when you create GroupChannel with same Users and this flag being true, the channel URL does not change, which means the messages between Users remain at the channel.
    If this flag is false, a new GroupChannel is created even though Users are same. As a result, you get a totally new channel URL (the old channel still remains), which means the Users start new conversation.
    
    handler - Callback handler.
  - createChannelWithUserIds
```
@Deprecated
public static void createChannelWithUserIds(java.util.List<java.lang.String> userIds,
                                                        boolean isDistinct,
                                                        java.lang.String name,
                                                        java.lang.Object coverUrlOrImage,
                                                        java.lang.String data,
                                                        GroupChannel.GroupChannelCreateHandler handler)
                                                 throws java.lang.ClassCastException
```
    Deprecated. As of 3.0.75, replaced by createChannel(GroupChannelParams, GroupChannelCreateHandler)
    
    Creates GroupChannel with given User IDs.
    
    Parameters:
    
    userIds - User IDs to join.
    
    isDistinct - If set true, a distinct GroupChannel is created. So later when you create GroupChannel with same Users and this flag being true, the channel URL does not change, which means the messages between Users remain at the channel.
    If this flag is false, a new GroupChannel is created even though Users are same. As a result, you get a totally new channel URL (the old channel still remains), which means the Users start new conversation.
    
    name - Name of channel.
    
    coverUrlOrImage - Cover URL or image file of channel. Pass String, File or null only, throws exception otherwise. This can be used as thumbnail of channel for instance.
    
    data - Custom data for channel.
    
    handler - Callback handler.
    
    Throws:
    
    java.lang.ClassCastException - If coverUrlOrImage is none of String, File or null, exception occurs.
    
    Since:
    
    3.0.5
  - createChannelWithUserIds
```
public static void createChannelWithUserIds(java.util.List<java.lang.String> userIds,
                                            boolean isDistinct,
                                            java.lang.String name,
                                            java.lang.Object coverUrlOrImage,
                                            java.lang.String data,
                                            java.lang.String customType,
                                            GroupChannel.GroupChannelCreateHandler handler)
                                     throws java.lang.ClassCastException
```
    Creates GroupChannel with given User IDs.
    
    Parameters:
    
    userIds - User IDs to join.
    
    isDistinct - If set true, a distinct GroupChannel is created. So later when you create GroupChannel with same Users and this flag being true, the channel URL does not change, which means the messages between Users remain at the channel.
    If this flag is false, a new GroupChannel is created even though Users are same. As a result, you get a totally new channel URL (the old channel still remains), which means the Users start new conversation.
    
    name - Name of channel.
    
    coverUrlOrImage - Cover URL or image file of channel. Pass String, File or null only, throws exception otherwise. This can be used as thumbnail of channel for instance.
    
    data - Custom data for channel.
    
    customType - Custom type for channel.
    
    handler - Callback handler.
    
    Throws:
    
    java.lang.ClassCastException - If coverUrlOrImage is none of String, File or null, exception occurs.
    
    Since:
    
    3.0.9
  - createChannel
```
public static void createChannel(GroupChannelParams params,
                                 GroupChannel.GroupChannelCreateHandler handler)
                          throws java.lang.ClassCastException
```
    Creates GroupChannel with GroupChannelParams.
    
    Parameters:
    
    params - Params of channel. Refer to GroupChannelParams.
    
    handler - Callback handler.
    
    Throws:
    
    java.lang.ClassCastException
    
    Since:
    
    3.0.49
  - createDistinctChannelIfNotExist
```
public static void createDistinctChannelIfNotExist(GroupChannelParams params,
                                                   GroupChannel.GroupChannelCreateDistinctChannelIfNotExistHandler handler)
                                            throws java.lang.ClassCastException
```
    Creates distinct GroupChannel with GroupChannelParams. When this method is executed, GroupChannelParams.setDistinct(boolean) will be ignored.
    
    Parameters:
    
    params - Params of channel. Refer to GroupChannelParams.
    
    handler - Callback handler.
    
    Throws:
    
    java.lang.ClassCastException
    
    Since:
    
    3.0.83
  - getChannel
```
public static void getChannel(java.lang.String channelUrl,
                              GroupChannel.GroupChannelGetHandler handler)
```
    Gets a GroupChannel with given channel URL.
    
    Parameters:
    
    channelUrl - URL of channel. Refer to BaseChannel.getUrl().
    
    handler - Callback handler.
  - getTotalUnreadMessageCount
```
@Deprecated
public static void getTotalUnreadMessageCount(GroupChannel.GroupChannelTotalUnreadMessageCountHandler handler)
```
    Deprecated. As of 3.0.75, replaced by SendBird.getTotalUnreadMessageCount(GroupChannel.GroupChannelTotalUnreadMessageCountHandler).
    
    Gets the total number of unread message of all GroupChannels the current user has joined.
    
    Parameters:
    
    handler - Callback handler.
    
    Since:
    
    3.0.2
  - getTotalUnreadMessageCount
```
@Deprecated
public static void getTotalUnreadMessageCount(java.util.List<java.lang.String> channelCustomTypes,
                                                          GroupChannel.GroupChannelTotalUnreadMessageCountHandler handler)
```
    Deprecated. As of 3.0.75, replaced by SendBird.getTotalUnreadMessageCount(List, GroupChannel.GroupChannelTotalUnreadMessageCountHandler).
    
    Gets the total number of unread message of GroupChannels with channel custom types filter.
    
    Parameters:
    
    channelCustomTypes - GroupChannel custom type list.
    
    handler - Callback handler.
    
    Since:
    
    3.0.56
  - getTotalUnreadMessageCount
```
@Deprecated
public static void getTotalUnreadMessageCount(GroupChannelTotalUnreadMessageCountParams params,
                                                          GroupChannel.GroupChannelTotalUnreadMessageCountHandler handler)
```
    Deprecated. As of 3.0.75, replaced by SendBird.getTotalUnreadMessageCount(GroupChannelTotalUnreadMessageCountParams, GroupChannel.GroupChannelTotalUnreadMessageCountHandler).
    
    Gets the total number of unread message of GroupChannels with GroupChannelTotalUnreadMessageCountParams filter.
    
    Parameters:
    
    params - GroupChannelTotalUnreadMessageCountParams
    
    handler - Callback handler.
    
    Since:
    
    3.0.59
  - getUnreadItemCount
```
@Deprecated
public static void getUnreadItemCount(java.util.Collection<GroupChannel.UnreadItemKey> keys,
                                                  GroupChannel.GroupChannelGetUnreadItemCountHandler handler)
```
    Deprecated. As of 3.0.75, replaced by SendBird.getUnreadItemCount(Collection, GroupChannel.GroupChannelGetUnreadItemCountHandler).
    
    Gets the unread item count of GroupChannels from keys.
    
    Parameters:
    
    keys - Unread item keys. Refer to GroupChannel.UnreadItemKey.
    
    handler - Callback handler.
    
    Since:
    
    3.0.62
  - getTotalUnreadChannelCount
```
@Deprecated
public static void getTotalUnreadChannelCount(GroupChannel.GroupChannelTotalUnreadChannelCountHandler handler)
```
    Deprecated. As of 3.0.75, replaced by SendBird.getTotalUnreadChannelCount(GroupChannel.GroupChannelTotalUnreadChannelCountHandler).
    
    Gets the total number of unread GroupChannels the current user has joined.
    
    Parameters:
    
    handler - Callback handler.
    
    Since:
    
    3.0.21
  - getChannelCount
```
@Deprecated
public static void getChannelCount(GroupChannel.MemberState memberState,
                                               GroupChannel.GroupChannelChannelCountHandler handler)
```
    Deprecated. As of 3.0.52, replaced by getChannelCount(GroupChannelListQuery.MemberStateFilter, GroupChannelChannelCountHandler).
    
    Gets the number of my GroupChannels.
    
    Parameters:
    
    memberState - GroupChannel.MemberState.
    
    handler - Callback handler.
    
    Since:
    
    3.0.37
  - getChannelCount
```
@Deprecated
public static void getChannelCount(GroupChannelListQuery.MemberStateFilter memberStateFilter,
                                               GroupChannel.GroupChannelChannelCountHandler handler)
```
    Deprecated. As of 3.0.75, replaced by SendBird.getGroupChannelCount(GroupChannelListQuery.MemberStateFilter, GroupChannel.GroupChannelChannelCountHandler).
    
    Gets the number of my GroupChannels.
    
    Parameters:
    
    memberStateFilter - GroupChannelListQuery.MemberStateFilter.
    
    handler - Callback handler.
    
    Since:
    
    3.0.52
  - createMemberListQuery
```
public GroupChannelMemberListQuery createMemberListQuery()
```
    Creates a query instance to get members.
    
    Returns:
    
    Query to use.
    
    Since:
    
    3.0.49
  - getLastMessage
```
public BaseMessage getLastMessage()
```
    Gets the last message.
    
    Returns:
    
    The last message. null if there is no message.
  - getInviter
```
public User getInviter()
```
    Gets the inviter of the current User to this channel.
    
    Returns:
    
    Inviter.
    
    Since:
    
    3.0.34
  - getUnreadMessageCount
```
public int getUnreadMessageCount()
```
    Gets the unread message count for this channel for the current User.
    
    Returns:
    
    Unread message count.
  - getUnreadMentionCount
```
public int getUnreadMentionCount()
```
    Gets the unread mention count for this channel for the current User.
    
    Returns:
    
    Unread mention count.
    
    Since:
    
    3.0.64
  - getMembers
```
public java.util.List<Member> getMembers()
```
    Gets member list for this channel.
    
    Returns:
    
    Member list.
  - getMemberCount
```
public int getMemberCount()
```
    Gets the total member count for this channel.
    
    Returns:
    
    Total member count.
  - getJoinedMemberCount
```
public int getJoinedMemberCount()
```
    Gets the total joined member count for this channel.
    
    Returns:
    
    Total joined member count.
    
    Since:
    
    3.0.62
  - getInvitedAt
```
public long getInvitedAt()
```
    Gets my invitation timestamp.
    
    Returns:
    
    My invitation timestamp.
    
    Since:
    
    3.0.68
  - getJoinedAt
```
public long getJoinedAt()
```
    Gets the timestamp when the current user joined.
    
    Returns:
    
    The timestamp when the current user joined.
    
    Since:
    
    3.0.165
  - isSuper
```
public boolean isSuper()
```
    Checks this channel is a super GroupChannel.
    
    Returns:
    
    Boolean true if the channel is super.
    
    Since:
    
    3.0.49
  - isPublic
```
public boolean isPublic()
```
    Checks this channel is a public GroupChannel.
    
    Returns:
    
    Boolean true if the channel is public.
    
    Since:
    
    3.0.50
  - isDistinct
```
public boolean isDistinct()
```
    Checks this channel is a distinct GroupChannel. For a distinct GroupChannel, later when you create GroupChannel with same Users and isDistinct flag being true (refer to createChannel(List, boolean, GroupChannelCreateHandler) or createChannelWithUserIds(List, boolean, String, Object, String, GroupChannelCreateHandler)), the channel URL does not change, which means the messages between Users remain at the channel. If the channel is not distinct one, a new GroupChannel is created even though Users are same. As a result, you get a totally new channel URL (the old channel still remains), which means the Users start new conversation.
    
    Returns:
    
    Boolean true if the channel is distinct.
  - isDiscoverable
```
public boolean isDiscoverable()
```
    Checks this channel is discoverable in the result of PublicGroupChannelListQuery. If it is false, it will not appear on the result of PublicGroupChannelListQuery.
    
    Returns:
    
    Boolean.
    
    Since:
    
    3.0.94
  - isPushEnabled
```
@Deprecated
public boolean isPushEnabled()
```
    Deprecated. As of 3.0.86, replaced by getMyPushTriggerOption().
    
    Checks if push is enabled for this channel. The push preference setting can be updated by setPushPreference(boolean, GroupChannelSetPushPreferenceHandler).
    
    Returns:
    
    true if push is enabled for this channel.
    
    Since:
    
    3.0.10
  - getMyPushTriggerOption
```
public GroupChannel.PushTriggerOption getMyPushTriggerOption()
```
    Gets my push trigger option. The push trigger setting can be updated by setMyPushTriggerOption(PushTriggerOption, GroupChannelSetMyPushTriggerOptionHandler).
    
    Returns:
    
    PushTriggerOption. Refer to GroupChannel.PushTriggerOption
    
    Since:
    
    3.0.86
  - isAccessCodeRequired
```
public boolean isAccessCodeRequired()
```
    Checks if this channel requires access code to join. This value is valid only if this channel is a public GroupChannel.
    
    Returns:
    
    true if this channel has an access code.
    
    Since:
    
    3.0.76
  - getMyCountPreference
```
public GroupChannel.CountPreference getMyCountPreference()
```
    Checks if unread message count is enabled for this channel. This count preference can be set by setMyCountPreference(CountPreference, GroupChannelSetMyCountPreferenceHandler).
    
    Returns:
    
    CountPreference. Refer to GroupChannel.CountPreference.
    
    Since:
    
    3.0.63
  - isHidden
```
public boolean isHidden()
```
    Checks if this channel is hidden.
    
    Returns:
    
    true if this channel is hidden.
    
    Since:
    
    3.0.39
  - getHiddenState
```
public GroupChannel.HiddenState getHiddenState()
```
    Gets hidden state of this channel.
    
    Returns:
    
    Hidden state of this channel. Refer to GroupChannel.HiddenState.
    
    Since:
    
    3.0.83
  - getMessageOffsetTimestamp
```
public long getMessageOffsetTimestamp()
```
    This property is set when resetMyHistory(GroupChannelResetMyHistoryHandler) ()} and hide(boolean, GroupChannelHideHandler) ()} is called.
    
    Returns:
    
    Message offset timestamp on this channel.
    
    Since:
    
    3.0.107
  - isBroadcast
```
public boolean isBroadcast()
```
    Checks this channel is a broadcast GroupChannel.
    
    Returns:
    
    true if the channel is broadcast channel.
    
    Since:
    
    3.0.119
  - updateChannel
```
public void updateChannel(java.lang.String name,
                          java.lang.Object coverUrlOrImage,
                          java.lang.String data,
                          GroupChannel.GroupChannelUpdateHandler handler)
                   throws java.lang.ClassCastException
```
    Update this channel. If null is passed for each parameter, the current value of each is maintained.
    
    Parameters:
    
    name - New name.
    
    coverUrlOrImage - New cover URL or image file of channel. Pass String, File or null only, throws exception otherwise.
    
    data - New custom data.
    
    handler - Callback handler.
    
    Throws:
    
    java.lang.ClassCastException - If coverUrlOrImage is none of String, File or null, exception occurs.
    
    Since:
    
    3.0.5
  - updateChannel
```
@Deprecated
public void updateChannel(boolean isDistinct,
                                      java.lang.String name,
                                      java.lang.Object coverUrlOrImage,
                                      java.lang.String data,
                                      GroupChannel.GroupChannelUpdateHandler handler)
                               throws java.lang.ClassCastException
```
    Deprecated. As of 3.0.75, replaced by updateChannel(GroupChannelParams, GroupChannelUpdateHandler)
    
    Update this channel. If null is passed for each parameter, the current value of each is maintained.
    
    Parameters:
    
    isDistinct - New distinct channel option.
    
    name - New name.
    
    coverUrlOrImage - New cover URL or image file of channel. Pass String, File or null only, throws exception otherwise.
    
    data - New custom data.
    
    handler - Callback handler.
    
    Throws:
    
    java.lang.ClassCastException - If coverUrlOrImage is none of String, File or null, exception occurs.
    
    Since:
    
    3.0.5
  - updateChannel
```
public void updateChannel(boolean isDistinct,
                          java.lang.String name,
                          java.lang.Object coverUrlOrImage,
                          java.lang.String data,
                          java.lang.String customType,
                          GroupChannel.GroupChannelUpdateHandler handler)
                   throws java.lang.ClassCastException
```
    Update this channel. If null is passed for each parameter, the current value of each is maintained.
    
    Parameters:
    
    isDistinct - New distinct channel option.
    
    name - New name.
    
    coverUrlOrImage - New cover URL or image file of channel. Pass String, File or null only, throws exception otherwise.
    
    data - New custom data.
    
    customType - New custom type.
    
    handler - Callback handler.
    
    Throws:
    
    java.lang.ClassCastException - If coverUrlOrImage is none of String, File or null, exception occurs.
    
    Since:
    
    3.0.9
  - updateChannel
```
public void updateChannel(GroupChannelParams params,
                          GroupChannel.GroupChannelUpdateHandler handler)
                   throws java.lang.ClassCastException
```
    Update this channel with GroupChannelParams.
    
    Parameters:
    
    params - Params of channel. Refer to GroupChannelParams.
    
    handler - Callback handler.
    
    Throws:
    
    java.lang.ClassCastException
    
    Since:
    
    3.0.49
  - invite
```
public void invite(User user,
                   GroupChannel.GroupChannelInviteHandler handler)
```
    Invites a User to this channel.
    
    Parameters:
    
    user - User to invite.
    
    handler - Callback handler.
  - invite
```
public void invite(java.util.List<User> users,
                   GroupChannel.GroupChannelInviteHandler handler)
```
    Invites Users to this channel.
    
    Parameters:
    
    users - Users to invite.
    
    handler - Callback handler.
  - inviteWithUserId
```
public void inviteWithUserId(java.lang.String userId,
                             GroupChannel.GroupChannelInviteHandler handler)
```
    Invites a User to this channel.
    
    Parameters:
    
    userId - User ID to invite.
    
    handler - Callback handler.
  - inviteWithUserIds
```
public void inviteWithUserIds(java.util.List<java.lang.String> userIds,
                              GroupChannel.GroupChannelInviteHandler handler)
```
    Invites Users top this channel.
    
    Parameters:
    
    userIds - User IDs to invite.
    
    handler - Callback handler.
  - join
```
public void join(GroupChannel.GroupChannelJoinHandler handler)
```
    Joins this channel if this channel is public.
    
    Parameters:
    
    handler - Callback handler.
    
    Since:
    
    3.0.50
  - join
```
public void join(java.lang.String accessCode,
                 GroupChannel.GroupChannelJoinHandler handler)
```
    Joins this channel if this channel is public.
    
    Parameters:
    
    accessCode - Access code for this channel.
    
    handler - Callback handler.
    
    Since:
    
    3.0.76
  - hide
```
public void hide(GroupChannel.GroupChannelHideHandler handler)
```
    Hides this channel from the current User's GroupChannel list. When a new message is received from the channel, it appears again.
    
    Parameters:
    
    handler - Callback handler.
  - hide
```
public void hide(boolean hidePreviousMessages,
                 GroupChannel.GroupChannelHideHandler handler)
```
    Hides this channel from the current User's GroupChannel list. When a new message is received from the channel, it appears again.
    
    Parameters:
    
    hidePreviousMessages - If set true, the messages created before the hide will not be loaded anymore when the channel reappears.
    
    handler - Callback handler.
    
    Since:
    
    3.0.35
  - hide
```
public void hide(boolean hidePreviousMessages,
                 boolean allowAutoUnhide,
                 GroupChannel.GroupChannelHideHandler handler)
```
    Hides this channel from the current User's GroupChannel list.
    
    Parameters:
    
    hidePreviousMessages - If set true, the messages created before the hide will not be loaded anymore when the channel reappears.
    
    allowAutoUnhide - If set true, when a new message is received from the channel, it appears again.
    
    handler - Callback handler.
    
    Since:
    
    3.0.83
  - unhide
```
public void unhide(GroupChannel.GroupChannelUnhideHandler handler)
```
    Unhides this channel from the current User's GroupChannel list.
    
    Parameters:
    
    handler - Callback handler.
    
    Since:
    
    3.0.83
  - leave
```
public void leave(GroupChannel.GroupChannelLeaveHandler handler)
```
    Leaves this channel.
    
    Parameters:
    
    handler - Callback handler.
  - acceptInvitation
```
public void acceptInvitation(GroupChannel.GroupChannelAcceptInvitationHandler handler)
```
    Accepts the invitation sent to the current User. After the acceptance, the User will be joined to this GroupChannel.
    
    Parameters:
    
    handler - Callback handler.
    
    Since:
    
    3.0.30
  - acceptInvitation
```
public void acceptInvitation(java.lang.String accessCode,
                             GroupChannel.GroupChannelAcceptInvitationHandler handler)
```
    Accepts the invitation sent to the current User. After the acceptance, the User will be joined to this GroupChannel.
    
    Parameters:
    
    accessCode - Access code for this channel.
    
    handler - Callback handler.
    
    Since:
    
    3.0.76
  - declineInvitation
```
public void declineInvitation(GroupChannel.GroupChannelDeclineInvitationHandler handler)
```
    Declines the invitation sent to the current User.
    
    Parameters:
    
    handler - Callback handler.
    
    Since:
    
    3.0.30
  - setPushPreference
```
@Deprecated
public void setPushPreference(boolean pushOn,
                                          GroupChannel.GroupChannelSetPushPreferenceHandler handler)
```
    Deprecated. As of 3.0.151, replaced by setMyPushTriggerOption(PushTriggerOption, GroupChannelSetMyPushTriggerOptionHandler).
    
    Sets push notification on/off setting for this channel.
    
    Parameters:
    
    pushOn - Push on or off flag.
    
    handler - Callback handler.
    
    Since:
    
    3.0.2
  - getPushPreference
```
@Deprecated
public void getPushPreference(GroupChannel.GroupChannelGetPushPreferenceHandler handler)
```
    Deprecated. As of 3.0.10, replaced by isPushEnabled().
    
    Gets push notification setting for this channel.
    
    Parameters:
    
    handler - Callback handler.
    
    Since:
    
    3.0.2
  - setMyPushTriggerOption
```
public void setMyPushTriggerOption(GroupChannel.PushTriggerOption pushTriggerOption,
                                   GroupChannel.GroupChannelSetMyPushTriggerOptionHandler handler)
```
    Sets push trigger option of this channel. If channel's push trigger option is set to GroupChannel.PushTriggerOption.DEFAULT, it works according to the state of SendBird.PushTriggerOption. If not, push messages will be triggered according to the state of GroupChannel.PushTriggerOption. Refer to SendBird.PushTriggerOption.
    
    Parameters:
    
    pushTriggerOption - PushTriggerOption. Refer to GroupChannel.PushTriggerOption.
    
    handler - Callback handler.
    
    Since:
    
    3.0.86
  - getMyPushTriggerOption
```
public void getMyPushTriggerOption(GroupChannel.GroupChannelGetMyPushTriggerOptionHandler handler)
```
    Gets push trigger option of this channel. Refer to GroupChannel.PushTriggerOption. For details of push trigger option, refer to setMyPushTriggerOption(PushTriggerOption, GroupChannelSetMyPushTriggerOptionHandler)
    
    Parameters:
    
    handler - Callback handler.
    
    Since:
    
    3.0.86
  - setMyCountPreference
```
public void setMyCountPreference(GroupChannel.CountPreference preference,
                                 GroupChannel.GroupChannelSetMyCountPreferenceHandler handler)
```
    Sets my count preference for this channel.
    
    Parameters:
    
    preference - My count preference. Refer to GroupChannel.CountPreference.
    
    handler - Callback handler.
    
    Since:
    
    3.0.63
  - markAsReadAll
```
@Deprecated
public static void markAsReadAll(GroupChannel.GroupChannelMarkAsReadHandler handler)
```
    Deprecated. As of 3.0.48, replaced by SendBird.markAsReadAll(SendBird.MarkAsReadHandler).
    
    Sends mark as read to all joined GroupChannels. This method has rate limit. You can send one request per second. It returns SendBirdException if you exceed the rate limit.
    
    Parameters:
    
    handler - Callback handler.
  - markAsDelivered
```
@Deprecated
public void markAsDelivered()
```
    Deprecated. As of 3.0.150, replaced by SendBird.markAsDelivered(Map).
    
    Sends mark as delivered to this channel when you received push message from us.
    
    Since:
    
    3.0.112
  - markAsRead
```
@Deprecated
public void markAsRead()
```
    Deprecated. As of 3.0.172, replaced by markAsRead(SendBird.MarkAsReadHandler).
    
    Sends mark as read to this channel.
  - markAsRead
```
public void markAsRead(SendBird.MarkAsReadHandler handler)
```
    Sends mark as read to this channel with a SendBird.MarkAsReadHandler.
    
    Parameters:
    
    handler - SendBird.MarkAsReadHandler.
    
    Since:
    
    3.0.172
  - resetMyHistory
```
public void resetMyHistory(GroupChannel.GroupChannelResetMyHistoryHandler handler)
```
    Resets the chat history of this channel for the current User. After this call, the messages created before the call will not be loaded.
    
    Parameters:
    
    handler - Callback handler.
    
    Since:
    
    3.0.37
  - getLastSeenAtBy
```
@Deprecated
public long getLastSeenAtBy(User user)
```
    Deprecated. As of 3.0.49, this method is deprecated.
    
    Gets the timestamp of which time the given User last saw this GroupChannel.
    
    Parameters:
    
    user - User among members.
    
    Returns:
    
    Timestamp in milliseconds.
    
    Since:
    
    3.0.2
  - getLastSeenAtByWithUserId
```
@Deprecated
public long getLastSeenAtByWithUserId(java.lang.String userId)
```
    Deprecated. As of 3.0.49, this method is deprecated.
    
    Gets the timestamp of which time the User with the given ID last saw this GroupChannel.
    
    Parameters:
    
    userId - User ID among members.
    
    Returns:
    
    Timestamp in milliseconds.
    
    Since:
    
    3.0.2
  - getReadMembers
```
@Deprecated
public java.util.List<Member> getReadMembers(BaseMessage message)
```
    Deprecated. As of 3.0.75, replaced by getReadMembers(BaseMessage, boolean).
    
    Gets the member list who have read the given message. This list excludes the current logged-in User and the sender of the message.
    
    Parameters:
    
    message - Message.
    
    Returns:
    
    List of members who have read the message.
    
    Since:
    
    3.0.2
  - getReadMembers
```
public java.util.List<Member> getReadMembers(BaseMessage message,
                                             boolean includeAllMembers)
```
    Gets the member list who have read the given message.
    
    Parameters:
    
    message - Message.
    
    includeAllMembers - If set false, this list excludes the current logged-in User and the sender of the message.
    
    Returns:
    
    List of members who have read the message.
    
    Since:
    
    3.0.75
  - getUnreadMembers
```
@Deprecated
public java.util.List<Member> getUnreadMembers(BaseMessage message)
```
    Deprecated. As of 3.0.75, replaced by getUnreadMembers(BaseMessage, boolean).
    
    Gets the member list who haven't read the given message. This list excludes the current logged-in User and the sender of the message.
    
    Parameters:
    
    message - Message.
    
    Returns:
    
    List of members who haven't read the message.
    
    Since:
    
    3.0.2
  - getUnreadMembers
```
public java.util.List<Member> getUnreadMembers(BaseMessage message,
                                               boolean includeAllMembers)
```
    Gets the member list who haven't read the given message.
    
    Parameters:
    
    message - Message.
    
    includeAllMembers - If set false, this list excludes the current logged-in User and the sender of the message.
    
    Returns:
    
    List of members who haven't read the message.
    
    Since:
    
    3.0.75
  - getReadStatus
```
@Deprecated
public java.util.Map<java.lang.String,ReadStatus> getReadStatus()
```
    Deprecated. As of 3.0.75, replaced by getReadStatus(boolean).
    
    Gets ReadStatus for all members in this GroupChannel. This excludes the current User.
    
    Returns:
    
    Map with User ID keys.
    
    Since:
    
    3.0.2
  - getReadStatus
```
public java.util.Map<java.lang.String,ReadStatus> getReadStatus(boolean includeAllMembers)
```
    Gets ReadStatus for all members in this GroupChannel.
    
    Parameters:
    
    includeAllMembers - If set false, this excludes the current User.
    
    Returns:
    
    Map with User ID keys.
    
    Since:
    
    3.0.75
  - getMyLastRead
```
public long getMyLastRead()
```
    Returns current user's last read receipt timestamp in channel.
    
    Returns:
    
    timestamp of channel last read. Zero if not invited or member when create.
    
    Since:
    
    3.0.96
  - getReadReceipt
```
@Deprecated
public int getReadReceipt(BaseMessage message)
```
    Deprecated. As of 3.0.136, replaced by getUnreadMemberCount(BaseMessage).
    
    Returns how many members haven't read the given message. This excludes the current logged-in User and the sender of the message.
    
    Parameters:
    
    message - The message.
    
    Returns:
    
    Number of unread member count. Zero if all members have read the message.
  - getUnreadMemberCount
```
public int getUnreadMemberCount(BaseMessage message)
```
    Returns how many members haven't read the given message. This excludes the current logged-in User and the sender of the message.
    
    Parameters:
    
    message - The message.
    
    Returns:
    
    Number of unread member count. Zero if all members have read the message. It will always return zero if the passed on message is an admin message, or if this channel is a super group channel.
    
    Since:
    
    3.0.136
  - getDeliveryReceipt
```
@Deprecated
public int getDeliveryReceipt(BaseMessage message)
```
    Deprecated. As of 3.0.136, replaced by getUndeliveredMemberCount(BaseMessage).
    
    Returns how many members haven't delivered the given message. This excludes the current logged-in User and the sender of the message.
    
    Parameters:
    
    message - The message.
    
    Returns:
    
    Number of undelivered member count. Zero if it has delivered the message to all members.
    
    Since:
    
    3.0.112
  - getUndeliveredMemberCount
```
public int getUndeliveredMemberCount(BaseMessage message)
```
    Returns how many members haven't delivered the given message. This excludes the current logged-in User and the sender of the message.
    
    Parameters:
    
    message - The message.
    
    Returns:
    
    Number of undelivered member count. Zero if it has delivered the message to all members. It will always return zero if the passed on message is an admin message, or if this channel is a super group channel.
    
    Since:
    
    3.0.136
  - startTyping
```
public void startTyping()
```
    Sends start typing event.
  - endTyping
```
public void endTyping()
```
    Sends end typing event.
  - isTyping
```
public boolean isTyping()
```
    Checks if one or more members are typing.
    
    Returns:
    
    true if one or members are typing.
  - getTypingMembers
```
@Deprecated
public java.util.List<Member> getTypingMembers()
```
    Deprecated. As of 3.0.145, replaced by getTypingUsers().
    
    Gets typing member list.
    
    Returns:
    
    Typing member list.
  - getTypingUsers
```
public java.util.List<User> getTypingUsers()
```
    Gets typing user list.
    
    Returns:
    
    Typing user list.
    
    Since:
    
    3.0.145
  - getCustomType
```
public java.lang.String getCustomType()
```
    Gets the channel custom type. You can set custom type of this channel by createChannel(List, boolean, String, Object, String, String, GroupChannelCreateHandler) or createChannelWithUserIds(List, boolean, String, Object, String, String, GroupChannelCreateHandler), updateChannel(boolean, String, Object, String, String, GroupChannelUpdateHandler).
    
    Returns:
    
    Custom type of this channel.
    
    Since:
    
    3.0.9
  - getMyMemberState
```
public Member.MemberState getMyMemberState()
```
    Gets my member state.
    
    Returns:
    
    My member state of this channel.
    
    Since:
    
    3.0.52
  - getMyRole
```
public Member.Role getMyRole()
```
    Gets my role in this channel.
    
    Returns:
    
    My role in this channel. Refer to Member.Role.
    
    Since:
    
    3.0.59
  - getMyMutedState
```
public Member.MutedState getMyMutedState()
```
    Gets my muted state in this channel.
    
    Returns:
    
    My muted state in this channel. Refer to Member.MutedState.
    
    Since:
    
    3.0.62
  - getMessageSurvivalSeconds
```
public int getMessageSurvivalSeconds()
```
    Gets the message survival seconds in this channel.
    
    Returns:
    
    The message survival seconds.
    
    Since:
    
    3.0.120
  - createBannedUserListQuery
```
public BannedUserListQuery createBannedUserListQuery()
```
    Creates a query instance to get the banned user list from this channel.
    
    Returns:
    
    Query to use.
    
    Since:
    
    3.0.51
  - banUser
```
public void banUser(User user,
                    java.lang.String description,
                    int seconds,
                    GroupChannel.GroupChannelBanHandler handler)
```
    Bans a member. Operators can ban members from this channel. Banned member is kicked out of this channel and cannot enter during the specified seconds. If you want to ban the user indefinitely, pass -1 to seconds as the argument.
    
    Parameters:
    
    user - Member to ban.
    
    description - Description
    
    seconds - Duration the banned User cannot enter this channel again.
    
    handler - Callback handler.
    
    Since:
    
    3.0.51
  - banUserWithUserId
```
public void banUserWithUserId(java.lang.String userId,
                              java.lang.String description,
                              int seconds,
                              GroupChannel.GroupChannelBanHandler handler)
```
    Bans a member. Operators can ban members from this channel. Banned member is kicked out of this channel and cannot enter during the specified seconds. If you want to ban the user indefinitely, pass -1 to seconds as the argument.
    
    Parameters:
    
    userId - Member ID (User ID) to ban.
    
    description - Description
    
    seconds - Duration the banned User cannot enter this channel again.
    
    handler - Callback handler.
    
    Since:
    
    3.0.51
  - unbanUser
```
public void unbanUser(User user,
                      GroupChannel.GroupChannelUnbanHandler handler)
```
    Unbans User. Operators can unban User who has been banned from this channel.
    
    Parameters:
    
    user - User to unban.
    
    handler - Callback handler.
    
    Since:
    
    3.0.51
  - unbanUserWithUserId
```
public void unbanUserWithUserId(java.lang.String userId,
                                GroupChannel.GroupChannelUnbanHandler handler)
```
    Unbans User. Operators can unban User who has been banned from this channel.
    
    Parameters:
    
    userId - User ID to unban.
    
    handler - Callback handler.
    
    Since:
    
    3.0.51
  - muteUser
```
public void muteUser(User user,
                     GroupChannel.GroupChannelMuteHandler handler)
```
    Mutes User. Muted User's messages are no longer delivered to current User.
    
    Parameters:
    
    user - User to mute.
    
    handler - Callback handler.
    
    Since:
    
    3.0.51
  - muteUserWithUserId
```
public void muteUserWithUserId(java.lang.String userId,
                               GroupChannel.GroupChannelMuteHandler handler)
```
    Mutes User. Muted User's messages are no longer delivered to current User.
    
    Parameters:
    
    userId - User ID to mute.
    
    handler - Callback handler.
    
    Since:
    
    3.0.51
  - muteUser
```
public void muteUser(User user,
                     java.lang.String description,
                     int seconds,
                     GroupChannel.GroupChannelMuteHandler handler)
```
    Mutes User. Muted User's messages are no longer delivered to current User. If you want to mute the user indefinitely, pass -1 to seconds as the argument. Or you can use muteUser(User, GroupChannelMuteHandler).
    
    Parameters:
    
    user - User to mute.
    
    description - Description.
    
    seconds - Duration for the mute.
    
    handler - Callback handler.
    
    Since:
    
    3.0.79
  - muteUserWithUserId
```
public void muteUserWithUserId(java.lang.String userId,
                               java.lang.String description,
                               int seconds,
                               GroupChannel.GroupChannelMuteHandler handler)
```
    Mutes User. Muted User's messages are no longer delivered to current User. If you want to mute the user indefinitely, pass -1 to seconds as the argument. Or you can use muteUser(User, GroupChannelMuteHandler).
    
    Parameters:
    
    userId - User ID to mute.
    
    description - Description.
    
    seconds - Duration for the mute.
    
    handler - Callback handler.
    
    Since:
    
    3.0.79
  - unmuteUser
```
public void unmuteUser(User user,
                       GroupChannel.GroupChannelUnmuteHandler handler)
```
    Unmutes User. Unmuted User's messages are again shown to current User.
    
    Parameters:
    
    user - User to unmute.
    
    handler - Callback handler.
  - unmuteUserWithUserId
```
public void unmuteUserWithUserId(java.lang.String userId,
                                 GroupChannel.GroupChannelUnmuteHandler handler)
```
    Unmutes User. Unmuted User's messages are again shown to current User.
    
    Parameters:
    
    userId - User ID to unmute.
    
    handler - Callback handler.
    
    Since:
    
    3.0.51
  - freeze
```
public void freeze(GroupChannel.GroupChannelFreezeHandler handler)
```
    Freeze this GroupChannel.
    
    Parameters:
    
    handler - Callback handler.
    
    Since:
    
    3.0.51
  - unfreeze
```
public void unfreeze(GroupChannel.GroupChannelUnfreezeHandler handler)
```
    Unfreeze this GroupChannel.
    
    Parameters:
    
    handler - Callback handler.
    
    Since:
    
    3.0.51
  - registerScheduledUserMessage
```
public void registerScheduledUserMessage(ScheduledUserMessageParams params,
                                         GroupChannel.RegisterScheduledUserMessageHandler handler)
```
    This method registers a user message to be sent at the specified time.
    
    Parameters:
    
    params - Params of scheduled user message. Refer to ScheduledUserMessageParams.
    
    handler - Callback handler.
    
    Since:
    
    3.0.80
  - delete
```
public void delete(GroupChannel.GroupChannelDeleteHandler handler)
```
    Deletes this GroupChannel. Note that only operators of a channel are able to delete it or else, an error will be returned to the handler.
    
    Parameters:
    
    handler - The callback handler.
    
    Since:
    
    3.0.95
  - getCreator
```
public User getCreator()
```
    Retrieves the creator of this channel.
    
    Returns:
    
    The User of this channel creator. Can be null.
    
    Since:
    
    3.0.142
  - getPinnedMessageIds
```
public java.util.List<java.lang.Long> getPinnedMessageIds()
```
  - getLatestPinnedMessage
```
public BaseMessage getLatestPinnedMessage()
```
  - toString
```
public java.lang.String toString()
```
    Overrides:
    
    toString in class BaseChannel
  - compareTo
```
@Deprecated
public static int compareTo(GroupChannel c1,
                                        GroupChannel c2,
                                        GroupChannelListQuery.Order order)
```
    Deprecated. As of 3.0.173, replaced by compareTo(GroupChannel, GroupChannel, GroupChannelListQuery.Order, SortOrder).
    
    If returned value is negative, it means that index of c1 is less than c2's If returned value is zero, it means that index of c1 and c2 is same. If returned value is positive, it means that index of c1 is larger than c2's
  - compareTo
```
public static int compareTo(GroupChannel c1,
                            GroupChannel c2,
                            GroupChannelListQuery.Order queryOrder,
                            SortOrder sortOrder)
```
    Compares two given channels and returns 0, -1 or 1 depending on their comparison results. Comparisons are done under the give GroupChannelListQuery.Order. - GroupChannelListQuery.Order.CHRONOLOGICAL: compares channel's createdAt. - GroupChannelListQuery.Order.LATEST_LAST_MESSAGE: compares channel's last message's createdAt. - GroupChannelListQuery.Order.CHANNEL_NAME_ALPHABETICAL: compares channel's name. - GroupChannelListQuery.Order.METADATA_VALUE_ALPHABETICAL: does not perform any comparison. Always returns 0.
    
    Parameters:
    
    c1 - GroupChannel object to compare.
    
    c2 - GroupChannel object to compare.
    
    queryOrder - GroupChannelListQuery.Order to compare the given channels by.
    
    sortOrder - SortOrder on which order to compare the channels to.
    
    Returns:
    
    the value 0 if c1 is equal to c2; a value less than 0 if c1 is less than c2; a value greater than 0 if c1 is greater than c2.
    
    Since:
    
    3.0.173
  - clone
```
public static GroupChannel clone(GroupChannel channel)
```
    Clones and returns a new instance of given GroupChannel
    
    Parameters:
    
    channel - GroupChannel to clone
    
    Returns:
    
    a cloned new instance of this GroupChannel
    
    Since:
    
    3.0.125

Class GroupChannel

Nested Class Summary

Nested classes/interfaces inherited from class com.sendbird.android.BaseChannel

Method Summary

Methods inherited from class com.sendbird.android.BaseChannel

Methods inherited from class java.lang.Object

Method Detail

refresh

createMyGroupChannelListQuery

createPublicGroupChannelListQuery

createChannel

createChannel

createChannel

createChannelWithUserIds

createChannelWithUserIds

createChannelWithUserIds

createChannel

createDistinctChannelIfNotExist

getChannel

getTotalUnreadMessageCount

getTotalUnreadMessageCount

getTotalUnreadMessageCount

getUnreadItemCount

getTotalUnreadChannelCount

getChannelCount

getChannelCount

createMemberListQuery

getLastMessage

getInviter

getUnreadMessageCount

getUnreadMentionCount

getMembers

getMemberCount

getJoinedMemberCount

getInvitedAt

getJoinedAt

isSuper

isPublic

isDistinct

isDiscoverable

isPushEnabled

getMyPushTriggerOption

isAccessCodeRequired

getMyCountPreference

isHidden

getHiddenState

getMessageOffsetTimestamp

isBroadcast

updateChannel

updateChannel

updateChannel

updateChannel

invite

invite

inviteWithUserId

inviteWithUserIds

join

join

hide

hide

hide

unhide

leave

acceptInvitation

acceptInvitation

declineInvitation

setPushPreference

getPushPreference

setMyPushTriggerOption

getMyPushTriggerOption

setMyCountPreference

markAsReadAll

markAsDelivered

markAsRead

markAsRead

resetMyHistory

getLastSeenAtBy

getLastSeenAtByWithUserId

getReadMembers

getReadMembers