Sendbird Chat SDK for .NET  3.0.29
SendBird.GroupChannel Class Reference
Inheritance diagram for SendBird.GroupChannel:
SendBird.BaseChannel

Public Types

enum  CountPreference { ALL, UNREAD_MESSAGE_COUNT_ONLY, UNREAD_MENTION_COUNT_ONLY, OFF }
 
enum  HiddenState { UNHIDDEN, HIDDEN_ALLOW_AUTO_UNHIDE, HIDDEN_PREVENT_AUTO_UNHIDE }
 
- Public Types inherited from SendBird.BaseChannel
enum  ReportCategory { SUSPICIOUS, HARASSING, SPAM, INAPPROPRIATE }
 

Public Member Functions

void Refresh (GroupChannelRefreshHandler handler)
 
CountPreference getMyCountPreference ()
 
GroupChannelMemberListQuery CreateMemberListQuery ()
 
bool IsDistinct ()
 
void UpdateChannel (string name, object coverUrlOrImage, string data, GroupChannelUpdateHandler handler)
 
void UpdateChannel (bool isDistinct, string name, object coverUrlOrImage, string data, GroupChannelUpdateHandler handler)
 
void UpdateChannel (bool isDistinct, string name, object coverUrlOrImage, string data, string customType, GroupChannelUpdateHandler handler)
 
void DeleteChannel (string channelUrl, GroupChannelLeaveHandler handler)
 
void UpdateChannel (bool isDistinct, string name, object coverUrlOrImage, string data, string customType, List< string > operatorIds, GroupChannelUpdateHandler handler)
 
void UpdateChannel (GroupChannelParams param, GroupChannelUpdateHandler handler)
 
void Invite (User user, GroupChannelInviteHandler handler)
 
void Invite (List< User > users, GroupChannelInviteHandler handler)
 
void InviteWithUserId (string userId, GroupChannelInviteHandler handler)
 
void InviteWithUserIds (List< string > userIds, GroupChannelInviteHandler handler)
 
void AcceptInvitation (GroupChannelInviteHandler handler)
 
void AcceptInvitation (string accessCode, string userId, GroupChannelInviteHandler handler)
 
void DeclineInvitation (GroupChannelInviteHandler handler)
 
void Join (GroupChannelJoinHandler handler)
 
void Join (string accessCode, GroupChannelJoinHandler handler)
 
void Hide (GroupChannelHideHandler handler)
 
void Hide (bool hidePreviousMessages, GroupChannelHideHandler handler)
 
void Hide (bool hidePreviousMessages, bool allowAutoUnhide, GroupChannelHideHandler handler)
 
void UnHide (GroupChannelUnhideHandler handler)
 
void Leave (GroupChannelLeaveHandler handler)
 
void SetPushPreference (bool pushOn, GroupChannelSetPushPreferenceHandler handler)
 
void GetPushPreference (GroupChannelGetPushPreferenceHandler handler)
 
void MarkAsRead ()
 
long GetLastSeenAtBy (User user)
 
long GetLastSeenAtByWithUserId (string userId)
 
long GetMyReadTs ()
 
List< UserGetReadMembers (BaseMessage message)
 
List< UserGetUnreadMembers (BaseMessage message)
 
Dictionary< string, ReadStatusGetReadStatus ()
 
int GetReadReceipt (BaseMessage message)
 
void StartTyping ()
 
void EndTyping ()
 
bool IsTyping ()
 
void BanUser (User user, string description, int seconds, GroupChannelBanHandler handler)
 
void BanUserWithUserId (string userId, string description, int seconds, GroupChannelBanHandler handler)
 
void UnbanUser (User user, GroupChannelUnbanHandler handler)
 
void UnbanUserWithUserId (string userId, GroupChannelUnbanHandler handler)
 
Member.Role GetMyRole ()
 
void SetMyRole (Member.Role role)
 
void SetMyMemberState (Member.MemberState myMemberState)
 
void SetInvitedAt (long invitedAt)
 
bool IsSuper ()
 
bool IsPublic ()
 
UserListQuery CreateBannedUserListQuery ()
 
Member.MutedState GetMyMutedState ()
 
void MuteUserWithUserId (string userId, GroupChannelMuteHandler handler)
 
void MuteUserWithUserId (string userId, string description, int seconds, GroupChannelMuteHandler handler)
 
void UnmuteUserWithUserId (string userId, GroupChannelUnmuteHandler handler)
 
void MuteUser (User user, GroupChannelMuteHandler handler)
 
void UnmuteUser (User user, GroupChannelUnmuteHandler handler)
 
void ResetMyHistory (GroupChannelResetMyHistoryHandler handler)
 
long GetMessageOffsetTimestamp ()
 
delegate void GroupChannelRefreshHandler (SendBirdException e)
 
delegate void GroupChannelCreateHandler (GroupChannel channel, SendBirdException e)
 
delegate void GroupChannelUpdateHandler (GroupChannel channel, SendBirdException e)
 
delegate void GroupChannelHideHandler (SendBirdException e)
 
delegate void GroupChannelJoinHandler (SendBirdException e)
 
delegate void GroupChannelInviteHandler (SendBirdException e)
 
delegate void GroupChannelLeaveHandler (SendBirdException e)
 
delegate void GroupChannelMarkAsReadHandler (SendBirdException e)
 
delegate void GroupChannelGetHandler (GroupChannel channel, SendBirdException e)
 
delegate void GroupChannelTotalUnreadMessageCountHandler (int unreadMessageCount, SendBirdException e)
 
delegate void GroupChannelSetPushPreferenceHandler (SendBirdException e)
 
delegate void GroupChannelGetPushPreferenceHandler (bool isPushOn, SendBirdException e)
 
delegate void GroupChannelBanHandler (SendBirdException e)
 
delegate void GroupChannelUnbanHandler (SendBirdException e)
 
delegate void GroupChannelSetInvitationPreferenceHandler (SendBirdException e)
 
delegate void GroupChannelGetInvitationPreferenceHandler (bool autoAccept, SendBirdException e)
 
delegate void GroupChannelMuteHandler (SendBirdException e)
 
delegate void GroupChannelUnmuteHandler (SendBirdException e)
 
delegate void GroupChannelUnhideHandler (SendBirdException e)
 
delegate void GroupChannelResetMyHistoryHandler (SendBirdException e)
 
- Public Member Functions inherited from SendBird.BaseChannel
bool IsOpenChannel ()
 
bool IsGroupChannel ()
 
PreviousMessageListQuery CreatePreviousMessageListQuery ()
 
MessageListQuery CreateMessageListQuery ()
 
OperatorListQuery CreateOperatorListQuery ()
 
virtual byte[] Serialize ()
 
FileMessage SendFileMessageWithURL (string fileUrl, string name, string type, int size, string data, SendFileMessageHandler handler)
 
FileMessage SendFileMessageWithURL (string fileUrl, string name, string type, int size, string data, string customType, SendFileMessageHandler handler)
 
FileMessage SendFileMessage (FileMessageParams param, SendFileMessageHandler handler)
 
void GetMessagesByTimestamp (long ts, MessageListParams param, GetMessagesHandler handler)
 
void GetPreviousMessagesByTimestamp (long ts, bool isInclusive, int prevResultSize, bool reverse, MessageTypeFilter messageType, string customType, GetMessagesHandler handler)
 
FileMessage SendFileMessage (SBFile file, string name, string type, int size, string data, SendFileMessageHandler handler)
 
FileMessage SendFileMessage (SBFile file, string name, string type, int size, string data, FileUploadWithProgressHandler handler)
 
FileMessage SendFileMessage (SBFile file, string name, string type, int size, string data, string customType, FileUploadWithProgressHandler handler)
 
FileMessage SendFileMessage (SBFile file, string name, string type, int size, string data, string customType, SendFileMessageHandler handler)
 
UserMessage SendUserMessage (string message, SendUserMessageHandler handler)
 
UserMessage SendUserMessage (string message, string data, SendUserMessageHandler handler)
 
UserMessage SendUserMessage (string message, string data, string customType, SendUserMessageHandler handler)
 
UserMessage SendUserMessage (string message, string data, string customType, List< string > targetLangs, SendUserMessageHandler handler)
 
UserMessage SendUserMessage (UserMessageParams param, SendUserMessageHandler handler)
 
void CreateMetaCounters (Dictionary< string, int > metaCounterMap, MetaCounterHandler handler)
 
void UpdateMetaCounters (Dictionary< string, int > metaCounterMap, MetaCounterHandler handler)
 
void IncreaseMetaCounters (Dictionary< string, int > metaCounterMap, MetaCounterHandler handler)
 
void DecreaseMetaCounters (Dictionary< string, int > metaCounterMap, MetaCounterHandler handler)
 
void GetMetaCounters (List< string > keys, MetaCounterHandler handler)
 
void GetAllMetaCounters (MetaCounterHandler handler)
 
void DeleteMetaCounter (string key, DeleteMetaCounterHandler handler)
 
void DeleteAllMetaCounters (DeleteMetaCounterHandler handler)
 
void CreateMetaData (Dictionary< string, string > metaDataMap, MetaDataHandler handler)
 
void UpdateMetaData (Dictionary< string, string > metaDataMap, MetaDataHandler handler)
 
void GetMetaData (List< string > keys, MetaDataHandler handler)
 
void GetAllMetaData (MetaDataHandler handler)
 
void DeleteMetaData (string key, DeleteMetaDataHandler handler)
 
void DeleteAllMetaData (DeleteMetaDataHandler handler)
 
void DeleteMessage (BaseMessage message, DeleteMessageHandler handler)
 
void UpdateUserMessage (long messageId, string message, string data, string customType, UpdateMessageHandler handler)
 
void UpdateUserMessage (long messageId, UserMessageParams param, UpdateUserMessageHandler handler)
 
void UpdateFileMessage (long messageId, FileMessageParams param, UpdateFileMessageHandler handler)
 
void Report (ReportCategory reportCategory, string reportDescription, ReportHandler handler)
 
void ReportUser (User offendingUser, ReportCategory reportCategory, string reportDescription, ReportUserHandler handler)
 
void ReportMessage (BaseMessage message, ReportCategory reportCategory, string reportDescription, ReportMessageHandler handler)
 
void AddOperators (List< string > userIds, AddOperatorsHandler handler)
 
void RemoveOperators (List< string > userIds, RemoveOperatorsHandler handler)
 
void RemoveAllOperators (RemoveAllOperatorsHandler handler)
 
void GetMyMutedInfo (GetMyMutedInfoHandler handler)
 
delegate void OnGetChannelHandler (BaseChannel baseChannel, SendBirdException e)
 
delegate void MetaCounterHandler (Dictionary< string, int > metaCounterMap, SendBirdException e)
 
delegate void DeleteMetaCounterHandler (SendBirdException e)
 
delegate void MetaDataHandler (Dictionary< string, string > metaDataMap, SendBirdException e)
 
delegate void DeleteMetaDataHandler (SendBirdException e)
 
delegate void SendUserMessageHandler (UserMessage message, SendBirdException e)
 
delegate void SendFileMessageHandler (FileMessage message, SendBirdException e)
 
delegate void DeleteMessageHandler (SendBirdException e)
 
delegate void UpdateMessageHandler (UserMessage message, SendBirdException e)
 
delegate void ReportHandler (SendBirdException e)
 
delegate void ReportUserHandler (SendBirdException e)
 
delegate void ReportMessageHandler (SendBirdException e)
 
delegate void SendFileMessagesHandler (FileMessage message, SendBirdException e)
 
delegate void SendFileMessageWithProgressHandler (FileMessage message, SendBirdException e)
 
delegate void SendFileMessagesWithProgressHandler (FileMessage message, SendBirdException e)
 
delegate void SendFileMessagesWithProgressHandlerOnProgress (string reqId, int bytesSent, int totalBytesSent, int totalBytesToSend)
 
delegate void UpdateUserMessageHandler (UserMessage message, SendBirdException e)
 
delegate void UpdateFileMessageHandler (FileMessage message, SendBirdException e)
 
delegate void GetMyMutedInfoHandler (bool isMuted, string description, long startAt, long endAt, long remainingDuration, SendBirdException e)
 
delegate void AddOperatorsHandler (SendBirdException e)
 
delegate void RemoveOperatorsHandler (SendBirdException e)
 
delegate void RemoveAllOperatorsHandler (SendBirdException e)
 
delegate void GetMessagesHandler (List< BaseMessage > message, SendBirdException e)
 

Static Public Member Functions

static GroupChannelListQuery CreateMyGroupChannelListQuery ()
 
static PublicGroupChannelListQuery CreatePublicGroupChannelListQuery ()
 
static void CreateChannel (GroupChannelParams param, GroupChannelCreateHandler handler)
 
static void CreateChannel (List< User > users, bool isDistinct, GroupChannelCreateHandler handler)
 
static void CreateChannel (List< User > users, bool isDistinct, string name, object coverUrlOrImage, string data, GroupChannelCreateHandler handler)
 
static void CreateChannel (List< User > users, bool isDistinct, string name, object coverUrlOrImage, string data, string customType, GroupChannelCreateHandler handler)
 
static void CreateChannel (List< User > users, bool isDistinct, string name, object coverUrlOrImage, string data, string customType, List< User > operators, GroupChannelCreateHandler handler)
 
static void CreateChannelWithUserIds (List< string > userIds, bool isDistinct, GroupChannelCreateHandler handler)
 
static void CreateChannelWithUserIds (List< string > userIds, bool isDistinct, string channelUrl, string name, GroupChannelCreateHandler handler)
 
static void CreateChannelWithUserIds (List< string > userIds, bool isDistinct, string name, object coverUrlOrImage, string data, GroupChannelCreateHandler handler)
 
static void CreateChannelWithUserIds (List< string > userIds, bool isDistinct, string name, object coverUrlOrImage, string data, string customType, GroupChannelCreateHandler handler)
 
static void CreateChannelWithUserIds (List< string > userIds, bool isDistinct, string channelUrl, string name, object coverUrlOrImage, string data, string customType, List< string > operatorIds, GroupChannelCreateHandler handler)
 
static void CreateChannelWithUserIds (List< string > userIds, bool isDistinct, string name, object coverUrlOrImage, string data, string customType, List< string > operatorIds, GroupChannelCreateHandler handler)
 
static void GetChannel (string channelUrl, GroupChannelGetHandler handler)
 
static void GetTotalUnreadMessageCount (GroupChannelTotalUnreadMessageCountHandler handler)
 
static void GetChannelInternal (string channelUrl, GroupChannelGetHandler handler)
 
static void GetChannel (bool isInternal, string channelUrl, GroupChannelGetHandler handler)
 
static void SetInvitionPreference (bool autoAccept, GroupChannelSetInvitationPreferenceHandler handler)
 
static void GetInvitionPreference (GroupChannelGetInvitationPreferenceHandler handler)
 
static void MarkAsReadAll (GroupChannelMarkAsReadHandler handler)
 
- Static Public Member Functions inherited from SendBird.BaseChannel
static string Base64Decode (string data)
 
static byte[] Base64Encode (string data)
 
static BaseChannel BuildFromSerializedData (byte[] data)
 

Properties

BaseMessage LastMessage [get, set]
 
int UnreadMessageCount [get, set]
 
int UnreadMentionCount [get]
 
List< MemberMembers [get]
 
int MemberCount [get]
 
bool IsExclusive [get]
 
List< MemberTypingMembers [get]
 
Member.MemberState MyMemberState [get]
 
Member.Role MyRole [get, set]
 
long InvitedAt [get]
 
bool IsHidden [get]
 
HiddenState GetHiddenState [get]
 
int JoinedMemberCount [get]
 
Member.MutedState MyMutedState [get]
 
- Properties inherited from SendBird.BaseChannel
string Data [get]
 
new string GetType [get]
 
string CustomType [get]
 
string Url [get]
 
long CreatedAt [get]
 
string Name [get]
 
string CoverUrl [get]
 
bool IsEphemeral [get]
 

Detailed Description

Represents a group channel.

Member Enumeration Documentation

◆ CountPreference

◆ HiddenState

The hidden state. Refer to hide(boolean, boolean, GroupChannelHideHandler).

Since
3.0.17

Member Function Documentation

◆ AcceptInvitation() [1/2]

void SendBird.GroupChannel.AcceptInvitation ( GroupChannelInviteHandler  handler)
inline

Accepts the invitation sent to the current User. After the acceptance, the User will be joined to this GroupChannel.

Parameters
handlerCallback handler.
Since
3.0.15

◆ AcceptInvitation() [2/2]

void SendBird.GroupChannel.AcceptInvitation ( string  accessCode,
string  userId,
GroupChannelInviteHandler  handler 
)
inline

Accepts the invitation sent to the current User. After the acceptance, the User will be joined to this GroupChannel.

Parameters
accessCodeAccess code for this channel.
useruser
handlerCallback handler.
Since
3.0.15

◆ BanUser()

void SendBird.GroupChannel.BanUser ( User  user,
string  description,
int  seconds,
GroupChannelBanHandler  handler 
)
inline

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
userMember to ban.
descriptionDescription.
secondsDuration the banned User cannot join this channel again.
handlerCallback handler.

◆ BanUserWithUserId()

void SendBird.GroupChannel.BanUserWithUserId ( string  userId,
string  description,
int  seconds,
GroupChannelBanHandler  handler 
)
inline

Bans a member. Operators can 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
userIdMember Id (User ID) to ban.
descriptionDescription.
secondsDuration the banned User cannot enter this channel again.
handlerCallback handler.

◆ CreateBannedUserListQuery()

UserListQuery SendBird.GroupChannel.CreateBannedUserListQuery ( )
inline

Create a query instance to get the banned user list from this channel.

Returns
Query to use.

◆ CreateChannel() [1/5]

static void SendBird.GroupChannel.CreateChannel ( GroupChannelParams  param,
GroupChannelCreateHandler  handler 
)
inlinestatic

Creates GroupChannel with GroupChannelParams.

Parameters
paramsParams of channel. Refer to GroupChannelParams.
handlerCallback handler.
Since
3.0.15

◆ CreateChannel() [2/5]

static void SendBird.GroupChannel.CreateChannel ( List< User users,
bool  isDistinct,
GroupChannelCreateHandler  handler 
)
inlinestatic

Creates GroupChannel with given Users.

Parameters
usersUsers to join.
isDistinctIf 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.
handlerCallback handler.

◆ CreateChannel() [3/5]

static void SendBird.GroupChannel.CreateChannel ( List< User users,
bool  isDistinct,
string  name,
object  coverUrlOrImage,
string  data,
GroupChannelCreateHandler  handler 
)
inlinestatic

Creates GroupChannel with given Users.

Parameters
usersUsers to join.
isDistinctIf 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.
nameName of channel.
coverUrlOrImageCover URL or image file of channel. Pass String, SBFile or null only, throws exception otherwise. This can be used as thumbnail of channel for instance.
dataCustom data for channel.
handlerCallback handler.

◆ CreateChannel() [4/5]

static void SendBird.GroupChannel.CreateChannel ( List< User users,
bool  isDistinct,
string  name,
object  coverUrlOrImage,
string  data,
string  customType,
GroupChannelCreateHandler  handler 
)
inlinestatic

Creates GroupChannel with given Users.

Parameters
usersUsers to join.
isDistinctIf 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.
nameName of channel.
coverUrlOrImageCover URL or image file of channel. Pass String, SBFile or null only, throws exception otherwise. This can be used as thumbnail of channel for instance.
dataCustom data for channel.
customTypeCustom type for channel.
handlerCallback handler.

◆ CreateChannel() [5/5]

static void SendBird.GroupChannel.CreateChannel ( List< User users,
bool  isDistinct,
string  name,
object  coverUrlOrImage,
string  data,
string  customType,
List< User operators,
GroupChannelCreateHandler  handler 
)
inlinestatic

Creates GroupChannel with given Users.

Parameters
usersUsers to join.
isDistinctIf 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.
nameName of channel.
coverUrlOrImageCover URL or image file of channel. Pass String, SBFile or null only, throws exception otherwise. This can be used as thumbnail of channel for instance.
dataCustom data for channel.
customTypeCustom type for channel.
operatorsOperators. Operators can ban or unban other members (refer to BanUser(User, string, int, GroupChannelBanHandler) and {@linke #UnbanUser(User, GroupChannelUnbanHander)}).
handlerCallback handler.

◆ CreateChannelWithUserIds() [1/5]

static void SendBird.GroupChannel.CreateChannelWithUserIds ( List< string >  userIds,
bool  isDistinct,
GroupChannelCreateHandler  handler 
)
inlinestatic

Creates GroupChannel with given User IDs.

Parameters
userIdsUser IDs to join.
isDistinctIf 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.
handlerCallback handler.

◆ CreateChannelWithUserIds() [2/5]

static void SendBird.GroupChannel.CreateChannelWithUserIds ( List< string >  userIds,
bool  isDistinct,
string  channelUrl,
string  name,
GroupChannelCreateHandler  handler 
)
inlinestatic

Creates GroupChannel with given User IDs.

Parameters
userIdsUser IDs to join.
isDistinctIf 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.
channelUrlURL of channel. Refer to Url.
nameName of channel.
handlerCallback handler.
Exceptions
ClassCastExceptionIf coverUrlOrImage is none of String, File or null, exception occurs.
Since
3.0.15

◆ CreateChannelWithUserIds() [3/5]

static void SendBird.GroupChannel.CreateChannelWithUserIds ( List< string >  userIds,
bool  isDistinct,
string  channelUrl,
string  name,
object  coverUrlOrImage,
string  data,
string  customType,
List< string >  operatorIds,
GroupChannelCreateHandler  handler 
)
inlinestatic

Creates GroupChannel with given User IDs.

Parameters
userIdsUser IDs to join.
isDistinctIf 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.
channelUrlURL of channel. Refer to Url.
nameName of channel.
coverUrlOrImageCover URL or image file of channel. Pass String, SBFile or null only, throws exception otherwise. This can be used as thumbnail of channel for instance.
dataCustom data for channel.
customTypeCustom type for channel.
operatorIdsOperator IDs (User IDs). Operator can ban or unban other members (refer to BanUser(User, string, int, GroupChannelBanHandler) and UnbanUser(User, GroupChannelUnbanHandler)).
handlerCallback handler.
Since
3.0.15

◆ CreateChannelWithUserIds() [4/5]

static void SendBird.GroupChannel.CreateChannelWithUserIds ( List< string >  userIds,
bool  isDistinct,
string  name,
object  coverUrlOrImage,
string  data,
GroupChannelCreateHandler  handler 
)
inlinestatic

Creates GroupChannel with given User IDs.

Parameters
userIdsUser IDs to join.
isDistinctIf 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.
nameName of channel.
coverUrlOrImageCover URL or image file of channel. Pass String, SBFile or null only, throws exception otherwise. This can be used as thumbnail of channel for instance.
dataCustom data for channel.
handlerCallback handler.

◆ CreateChannelWithUserIds() [5/5]

static void SendBird.GroupChannel.CreateChannelWithUserIds ( List< string >  userIds,
bool  isDistinct,
string  name,
object  coverUrlOrImage,
string  data,
string  customType,
GroupChannelCreateHandler  handler 
)
inlinestatic

Creates GroupChannel with given User IDs.

Parameters
userIdsUser IDs to join.
isDistinctIf 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.
nameName of channel.
coverUrlOrImageCover URL or image file of channel. Pass String, SBFile or null only, throws exception otherwise. This can be used as thumbnail of channel for instance.
dataCustom data for channel.
customTypeCustom type for channel.
handlerCallback handler.

◆ CreateMemberListQuery()

GroupChannelMemberListQuery SendBird.GroupChannel.CreateMemberListQuery ( )
inline

Creates a query instance to get members.

Returns
Query to use.
Since
3.0.15

◆ CreateMyGroupChannelListQuery()

static GroupChannelListQuery SendBird.GroupChannel.CreateMyGroupChannelListQuery ( )
inlinestatic

Creates a query instance to get GroupChannels the current User has joined.

Returns
Query to use.

◆ CreatePublicGroupChannelListQuery()

static PublicGroupChannelListQuery SendBird.GroupChannel.CreatePublicGroupChannelListQuery ( )
inlinestatic

Creates a query instance to get public GroupChannels.

Returns
Query to use.
Since
3.0.25

◆ DeclineInvitation()

void SendBird.GroupChannel.DeclineInvitation ( GroupChannelInviteHandler  handler)
inline

Declines the invitation sent to the current User.

Parameters
handlerCallback handler.
Since
3.0.15

◆ DeleteChannel()

void SendBird.GroupChannel.DeleteChannel ( string  channelUrl,
GroupChannelLeaveHandler  handler 
)
inline

Delete this channel. If null is passed for each parameter, the current value of each is maintained.

Parameters
channelUrlURL of channel. Refer to Url.
handlerCallback handler.
Since
3.0.15

◆ EndTyping()

void SendBird.GroupChannel.EndTyping ( )
inline

Sends end typing event.

◆ GetChannel() [1/2]

static void SendBird.GroupChannel.GetChannel ( bool  isInternal,
string  channelUrl,
GroupChannelGetHandler  handler 
)
inlinestatic

Gets a GroupChannel with given channel URL.

Parameters
channelUrlURL of channel. Refer to Url.
handlerCallback handler.

◆ GetChannel() [2/2]

static void SendBird.GroupChannel.GetChannel ( string  channelUrl,
GroupChannelGetHandler  handler 
)
inlinestatic

Gets a GroupChannel with given channel URL.

Parameters
channelUrlURL of channel. Refer to Url.
handlerCallback handler.

◆ GetInvitionPreference()

static void SendBird.GroupChannel.GetInvitionPreference ( GroupChannelGetInvitationPreferenceHandler  handler)
inlinestatic

Gets auto_accept setting for all channel.

Parameters
handlerCallback handler.
Since
3.0.15

◆ GetLastSeenAtBy()

long SendBird.GroupChannel.GetLastSeenAtBy ( User  user)
inline

Gets the timestamp of which time the given User last saw this GroupChannel.

Parameters
userUser among members.
Returns
Timestamp in milliseconds.

◆ GetLastSeenAtByWithUserId()

long SendBird.GroupChannel.GetLastSeenAtByWithUserId ( string  userId)
inline

Gets the timestamp of which time the User with the given ID last saw this GroupChannel.

Parameters
userIdUser ID among members.
Returns
Timestamp in milliseconds.

◆ GetMessageOffsetTimestamp()

long SendBird.GroupChannel.GetMessageOffsetTimestamp ( )
inline

This property is set when resetMyHistory(GroupChannelResetMyHistoryHandler) ()} and hide(boolean, GroupChannelHideHandler) ()} is called.

Returns
Message offset timestamp on this channel.
Since
3.0.17

◆ getMyCountPreference()

CountPreference SendBird.GroupChannel.getMyCountPreference ( )
inline

Checks if unread message count is enabled for this channel. This count preference can be set by setMyCountPreference(CountPreference, GroupChannelSetMyCountPreferenceHandler).

Returns
CountPreference. Refer to CountPreference.
Since
3.0.16

◆ GetMyMutedState()

Member.MutedState SendBird.GroupChannel.GetMyMutedState ( )
inline

Gets my muted state in this channel.

Returns
My muted state in this channel. Refer to Member.MutedState.

◆ GetMyRole()

Member.Role SendBird.GroupChannel.GetMyRole ( )
inline

Gets my role in this channel.

Returns
My role in this channel. Refer to Member.Role.
Since
3.0.18

◆ GetPushPreference()

void SendBird.GroupChannel.GetPushPreference ( GroupChannelGetPushPreferenceHandler  handler)
inline

Gets push notification setting for this channel.

Parameters
handlerCallback handler.

◆ GetReadMembers()

List<User> SendBird.GroupChannel.GetReadMembers ( BaseMessage  message)
inline

Gets the member list who have read the given message. This list excludes the current User.

Parameters
messageMessage.
Returns
List of members who have read the message.

◆ GetReadReceipt()

int SendBird.GroupChannel.GetReadReceipt ( BaseMessage  message)
inline

Returns how many members haven't read the given message.

Parameters
messageThe message.
Returns
Number of unread member count. Zero if all members have read the message.

◆ GetReadStatus()

Dictionary<string, ReadStatus> SendBird.GroupChannel.GetReadStatus ( )
inline

Gets ReadStatus for all members in this GroupChannel. This excludes the current User.

Returns
Map with User ID keys.

◆ GetTotalUnreadMessageCount()

static void SendBird.GroupChannel.GetTotalUnreadMessageCount ( GroupChannelTotalUnreadMessageCountHandler  handler)
inlinestatic

Gets the total number of unread message of all GroupChannels the current user has joined.

Parameters
handlerCallback handler.

◆ GetUnreadMembers()

List<User> SendBird.GroupChannel.GetUnreadMembers ( BaseMessage  message)
inline

Gets the member list who haven't read the given message. This list excludes the current User.

Parameters
messageMessage.
Returns
List of members who haven't read the message.

◆ GroupChannelBanHandler()

delegate void SendBird.GroupChannel.GroupChannelBanHandler ( SendBirdException  e)

◆ GroupChannelCreateHandler()

◆ GroupChannelGetHandler()

delegate void SendBird.GroupChannel.GroupChannelGetHandler ( GroupChannel  channel,
SendBirdException  e 
)

GroupChannelGet handler. This handler provides callback for GetChannel(string, GroupChannelGetHandler).

◆ GroupChannelGetPushPreferenceHandler()

delegate void SendBird.GroupChannel.GroupChannelGetPushPreferenceHandler ( bool  isPushOn,
SendBirdException  e 
)

GroupChannelGetPushPreference handler. This handler provides callback for GetPushPreference(GroupChannelGetPushPreferenceHandler).

◆ GroupChannelHideHandler()

delegate void SendBird.GroupChannel.GroupChannelHideHandler ( SendBirdException  e)

GroupChannelHide handler. This handler provides callback for Hide(GroupChannelHideHandler).

◆ GroupChannelInviteHandler()

delegate void SendBird.GroupChannel.GroupChannelInviteHandler ( SendBirdException  e)

◆ GroupChannelJoinHandler()

delegate void SendBird.GroupChannel.GroupChannelJoinHandler ( SendBirdException  e)

GroupChannelJoin handler. This handler provides callback for join(GroupChannelJoinHandler).

Since
3.0.15

◆ GroupChannelLeaveHandler()

delegate void SendBird.GroupChannel.GroupChannelLeaveHandler ( SendBirdException  e)

GroupChannelLeave handler. This handler provides callback for Leave(GroupChannelLeaveHandler).

◆ GroupChannelMarkAsReadHandler()

delegate void SendBird.GroupChannel.GroupChannelMarkAsReadHandler ( SendBirdException  e)

GroupChannelMarkAsRead handler. This handler provides callback for MarkAsReadAll(GroupChannelMarkAsReadHandler).

◆ GroupChannelMuteHandler()

delegate void SendBird.GroupChannel.GroupChannelMuteHandler ( SendBirdException  e)

GroupChannelMute handler. This handler provides callback for muteUser(User, GroupChannelMuteHandler) and MuteUserWithUserId(String, GroupChannelMuteHandler).

Since
3.0.15

◆ GroupChannelRefreshHandler()

delegate void SendBird.GroupChannel.GroupChannelRefreshHandler ( SendBirdException  e)

GroupChannelRefresh handler. This handler provides callback for Refresh(GroupChannelRefreshHandler).

◆ GroupChannelSetInvitationPreferenceHandler()

delegate void SendBird.GroupChannel.GroupChannelSetInvitationPreferenceHandler ( SendBirdException  e)

GroupChannelSetInvitationPreferenceHandler handler. This handler provides callback for SetInvitionPreference(bool, GroupChannelSetInvitationPreferenceHandler).

Since
3.0.15

◆ GroupChannelSetPushPreferenceHandler()

delegate void SendBird.GroupChannel.GroupChannelSetPushPreferenceHandler ( SendBirdException  e)

GroupChannelSetPushPreference handler. This handler provides callback for SetPushPreference(bool, GroupChannelSetPushPreferenceHandler).

◆ GroupChannelTotalUnreadMessageCountHandler()

delegate void SendBird.GroupChannel.GroupChannelTotalUnreadMessageCountHandler ( int  unreadMessageCount,
SendBirdException  e 
)

GroupChannelTotalUnreadMessageCount handler. This handler provides callback for GetTotalUnreadMessageCount(GroupChannelTotalUnreadMessageCountHandler).

◆ GroupChannelUnbanHandler()

delegate void SendBird.GroupChannel.GroupChannelUnbanHandler ( SendBirdException  e)

GroupChannelUnban handler. This handler provies callback for UnbanUser(User, GroupChannelUnbanHandler) and UnbanUserWithUserId(string, GroupChannelUnbanHandler).

◆ GroupChannelUnmuteHandler()

delegate void SendBird.GroupChannel.GroupChannelUnmuteHandler ( SendBirdException  e)

GroupChannelUnmute handler. This handler provides callback for muteUser(User, GroupChannelUnmuteHandler) and UnmuteUserWithUserId(String, GroupChannelUnmuteHandler).

Since
3.0.15

◆ GroupChannelUpdateHandler()

delegate void SendBird.GroupChannel.GroupChannelUpdateHandler ( GroupChannel  channel,
SendBirdException  e 
)

◆ Hide() [1/2]

void SendBird.GroupChannel.Hide ( bool  hidePreviousMessages,
bool  allowAutoUnhide,
GroupChannelHideHandler  handler 
)
inline

Hides this channel from the current User's GroupChannel list. If the channel is hidden, it is not queried with CreateMyGroupChannelListQuery(). When a new message is received from the channel, it appears again.

Parameters
handlerCallback handler.

◆ Hide() [2/2]

void SendBird.GroupChannel.Hide ( GroupChannelHideHandler  handler)
inline

Hides this channel from the current User's GroupChannel list. When a new message is received from the channel, it appears again.

Parameters
hidePreviousMessagesIf set true, the messages created before the hide will not be loaded anymore when the channel reappears.
handlerCallback handler.
Since
3.0.16

◆ Invite() [1/2]

void SendBird.GroupChannel.Invite ( List< User users,
GroupChannelInviteHandler  handler 
)
inline

Invites Users to this channel.

Parameters
usersUsers to invite.
handlerCallback handler.

◆ Invite() [2/2]

void SendBird.GroupChannel.Invite ( User  user,
GroupChannelInviteHandler  handler 
)
inline

Invites a User to this channel.

Parameters
userUser to invite.
handlerCallback handler.

◆ InviteWithUserId()

void SendBird.GroupChannel.InviteWithUserId ( string  userId,
GroupChannelInviteHandler  handler 
)
inline

Invites a User to this channel.

Parameters
userIdUser ID to invite.
handlerCallback handler.

◆ InviteWithUserIds()

void SendBird.GroupChannel.InviteWithUserIds ( List< string >  userIds,
GroupChannelInviteHandler  handler 
)
inline

Invites Users top this channel.

Parameters
userIdsUser IDs to invite.
handlerCallback handler.

◆ IsDistinct()

bool SendBird.GroupChannel.IsDistinct ( )
inline

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, bool, GroupChannelCreateHandler) or CreateChannelWithUserIds(List, bool, 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.

◆ IsPublic()

bool SendBird.GroupChannel.IsPublic ( )
inline

Checks this channel is a public GroupChannel.

Returns
Boolean true if the channel is public.
Since
3.0.15

◆ IsSuper()

bool SendBird.GroupChannel.IsSuper ( )
inline

Checks this channel is a super GroupChannel.

Returns
Boolean true if the channel is super.
Since
3.0.15

◆ IsTyping()

bool SendBird.GroupChannel.IsTyping ( )
inline

Checks if one or more members are typing.

Returns
true if one or members are typing.

◆ Join() [1/2]

void SendBird.GroupChannel.Join ( GroupChannelJoinHandler  handler)
inline

Joins this channel if this channel is public.

Parameters
handlerCallback handler.
Since
3.0.15

◆ Join() [2/2]

void SendBird.GroupChannel.Join ( string  accessCode,
GroupChannelJoinHandler  handler 
)
inline

Joins this channel if this channel is public.

Parameters
accessCodeAccess code for this channel.
handlerCallback handler.
Since
3.0.15

◆ Leave()

void SendBird.GroupChannel.Leave ( GroupChannelLeaveHandler  handler)
inline

Leaves this channel.

Parameters
handlerCallback handler.

◆ MarkAsRead()

void SendBird.GroupChannel.MarkAsRead ( )
inline

Sends mark as read to this channel. This method has rate limit. You can send on request per second. The limit ins considered on per-channel basis. It returns SendBirdException if you exceed the rate limit.

Parameters
handlerCallback handler.

◆ MarkAsReadAll()

static void SendBird.GroupChannel.MarkAsReadAll ( GroupChannelMarkAsReadHandler  handler)
inlinestatic

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
handlerCallback handler.

◆ MuteUser()

void SendBird.GroupChannel.MuteUser ( User  user,
GroupChannelMuteHandler  handler 
)
inline

Mutes User. Muted User's messages are no longer delivered to current User.

Parameters
userUser to mute.
handlerCallback handler.
Since
3.0.15

◆ MuteUserWithUserId() [1/2]

void SendBird.GroupChannel.MuteUserWithUserId ( string  userId,
GroupChannelMuteHandler  handler 
)
inline

Mutes User. Muted User's messages are no longer delivered to current User.

Parameters
userIdUser ID to mute.
handlerCallback handler.
Since
3.0.15

◆ MuteUserWithUserId() [2/2]

void SendBird.GroupChannel.MuteUserWithUserId ( string  userId,
string  description,
int  seconds,
GroupChannelMuteHandler  handler 
)
inline

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, OpenChannelMuteHandler).

Parameters
userIdUser ID to mute.
descriptionDescription.
secondsDuration for the mute.
handlerCallback handler.
Since
3.0.20

◆ Refresh()

void SendBird.GroupChannel.Refresh ( GroupChannelRefreshHandler  handler)
inline

Refreshes all the data of this channel.

Parameters
handlerCallback handler.
Since
3.0.15

◆ ResetMyHistory()

void SendBird.GroupChannel.ResetMyHistory ( GroupChannelResetMyHistoryHandler  handler)
inline

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
handlerCallback handler.
Since
3.0.17

◆ SetInvitionPreference()

static void SendBird.GroupChannel.SetInvitionPreference ( bool  autoAccept,
GroupChannelSetInvitationPreferenceHandler  handler 
)
inlinestatic

Sets auto_accept on/off setting for all channel. Determines for users within an application whether or not to automatically join a private group channel promptly from an invitation without having to accept it. (Default: true)

Parameters
autoAcceptauto_accept on or off flag.
handlerCallback handler.
Since
3.0.15

◆ SetPushPreference()

void SendBird.GroupChannel.SetPushPreference ( bool  pushOn,
GroupChannelSetPushPreferenceHandler  handler 
)
inline

Sets push notification on/off setting for this channel.

Parameters
pushOnPush on or off flag.
handlerCallback handler.

◆ StartTyping()

void SendBird.GroupChannel.StartTyping ( )
inline

Sends start typing event.

◆ UnbanUser()

void SendBird.GroupChannel.UnbanUser ( User  user,
GroupChannelUnbanHandler  handler 
)
inline

Unbans User. Operators can Unban User who has been banned from this channel.

Parameters
userUser to unban.
handlerCallback handler.

◆ UnbanUserWithUserId()

void SendBird.GroupChannel.UnbanUserWithUserId ( string  userId,
GroupChannelUnbanHandler  handler 
)
inline

Unbans User. Operators can Unban User who has been banned from this channel.

Parameters
userIdUser to unban.
handlerCallback handler.

◆ UnHide()

void SendBird.GroupChannel.UnHide ( GroupChannelUnhideHandler  handler)
inline

Unhides this channel from the current User's GroupChannel list.

Parameters
handlerCallback handler.
Since
3.0.17

◆ UnmuteUser()

void SendBird.GroupChannel.UnmuteUser ( User  user,
GroupChannelUnmuteHandler  handler 
)
inline

Unmutes User. Unmuted User's messages are again shown to current User.

Parameters
userUser to unmute.
handlerCallback handler.
Since
3.0.15

◆ UnmuteUserWithUserId()

void SendBird.GroupChannel.UnmuteUserWithUserId ( string  userId,
GroupChannelUnmuteHandler  handler 
)
inline

Unmutes User. Unmuted User's messages are again shown to current User.

Parameters
userIdUser ID to unmute.
handlerCallback handler.
Since
3.0.15

◆ UpdateChannel() [1/5]

void SendBird.GroupChannel.UpdateChannel ( bool  isDistinct,
string  name,
object  coverUrlOrImage,
string  data,
GroupChannelUpdateHandler  handler 
)
inline

Update this channel. If null is passed for each parameter, the current value of each is maintained.

Parameters
isDistinctNew distinct channel option.
nameNew name.
coverUrlOrImageNew cover URL or image file of channel. Pass String, File or null only, throws exception otherwise.
dataNew custom data.
handlerCallback handler.

◆ UpdateChannel() [2/5]

void SendBird.GroupChannel.UpdateChannel ( bool  isDistinct,
string  name,
object  coverUrlOrImage,
string  data,
string  customType,
GroupChannelUpdateHandler  handler 
)
inline

Update this channel. If null is passed for each parameter, the current value of each is maintained.

Parameters
isDistinctNew distinct channel option.
nameNew name.
coverUrlOrImageNew cover URL or image file of channel. Pass String, File or null only, throws exception otherwise.
dataNew custom data.
customTypeNew custom type.
handlerCallback handler.

◆ UpdateChannel() [3/5]

void SendBird.GroupChannel.UpdateChannel ( bool  isDistinct,
string  name,
object  coverUrlOrImage,
string  data,
string  customType,
List< string >  operatorIds,
GroupChannelUpdateHandler  handler 
)
inline

Update this channel. If null is passed for each parameter, the current value of each is maintained.

Parameters
isDistinctNew distinct channel option.
nameNew name.
coverUrlOrImageNew cover URL or image file of channel. Pass String, File or null only, throws exception otherwise.
dataNew custom data.
customTypeNew custom type.
operatorIdsNew operator IDs.
handlerCallback handler.

◆ UpdateChannel() [4/5]

void SendBird.GroupChannel.UpdateChannel ( GroupChannelParams  param,
GroupChannelUpdateHandler  handler 
)
inline

Update this channel with GroupChannelParams.

Parameters
paramsParams of channel. Refer to GroupChannelParams.
handlerCallback handler.
Since
3.0.18

◆ UpdateChannel() [5/5]

void SendBird.GroupChannel.UpdateChannel ( string  name,
object  coverUrlOrImage,
string  data,
GroupChannelUpdateHandler  handler 
)
inline

Update this channel. If null is passed for each parameter, the current value of each is maintained.

Parameters
nameNew name.
coverUrlOrImageNew cover URL or image file of channel. Pass String, File or null only, throws exception otherwise.
dataNew custom data.
handlerCallback handler.

Property Documentation

◆ GetHiddenState

HiddenState SendBird.GroupChannel.GetHiddenState
get

Gets hidden state of this channel.

Returns
Hidden state of this channel. Refer to HiddenState.
Since
3.0.17

◆ InvitedAt

long SendBird.GroupChannel.InvitedAt
get

Gets my invitation timestamp.

Returns
My invitation timestamp.
Since
3.0.15

◆ IsHidden

bool SendBird.GroupChannel.IsHidden
get

Checks if this channel is hidden.

Returns
true if this channel is hidden.
Since
3.0.17

◆ JoinedMemberCount

int SendBird.GroupChannel.JoinedMemberCount
get

Gets the total joined member count for this channel.

Returns
Total joined member count.
Since
3.0.15

◆ LastMessage

BaseMessage SendBird.GroupChannel.LastMessage
getset

Gets the last message.

Returns
The last message. null if there is no message.

◆ MemberCount

int SendBird.GroupChannel.MemberCount
get

Gets the total member count for this channel.

Returns
Total member count.
Since
3.0.15

◆ Members

List<Member> SendBird.GroupChannel.Members
get

Gets member list for this channel.

Returns
Member list.

◆ MyMemberState

Member.MemberState SendBird.GroupChannel.MyMemberState
get

Gets my member state.

Returns
My member state of this channel.
Since
3.0.15

◆ TypingMembers

List<Member> SendBird.GroupChannel.TypingMembers
get

Gets typing member list.

Returns
Typing member list.

◆ UnreadMentionCount

int SendBird.GroupChannel.UnreadMentionCount
get

Gets the unread mention count for this channel for the current User.

Returns
Unread mention count.
Since
3.0.17

◆ UnreadMessageCount

int SendBird.GroupChannel.UnreadMessageCount
getset

Gets the unread message count for this channel for the current User.

Returns
Unread message count.

The documentation for this class was generated from the following file: