Sendbird Chat SDK for .NET  3.0.29
SendBird.SendBirdClient.ChannelHandler Class Reference

Public Member Functions

delegate void OnMessageReceivedDelegate (BaseChannel channel, BaseMessage message)
 
delegate void OnMessageUpdatedDelegate (BaseChannel channel, BaseMessage message)
 
delegate void OnDeliveryReceiptUpdatedDelegate (GroupChannel channel)
 
delegate void OnMessageDeletedDelegate (BaseChannel channel, long msgId)
 
delegate void OnChannelChangedDelegate (BaseChannel channel)
 
delegate void OnChannelDeletedDelegate (string channelUrl, BaseChannel.ChannelType channelType)
 
delegate void OnReadReceiptUpdatedDelegate (GroupChannel channel)
 
delegate void OnTypingStatusUpdatedDelegate (GroupChannel channel)
 
delegate void OnUserJoinedDelegate (GroupChannel channel, User user)
 
delegate void OnUserReceivedInvitationDelegate (GroupChannel channel, User inviter, List< User > invitees)
 
delegate void OnUserDeclinedInvitationDelegate (GroupChannel channel, User inviter, User invitee)
 
delegate void OnUserLeftDelegate (GroupChannel channel, User user)
 
delegate void OnUserEnteredDelegate (OpenChannel channel, User user)
 
delegate void OnUserExitedDelegate (OpenChannel channel, User user)
 
delegate void OnUserMutedDelegate (BaseChannel channel, User user)
 
delegate void OnUserUnmutedDelegate (BaseChannel channel, User user)
 
delegate void OnUserBannedDelegate (BaseChannel channel, User user)
 
delegate void OnUserUnbannedDelegate (BaseChannel channel, User user)
 
delegate void OnChannelFrozenDelegate (OpenChannel channel)
 
delegate void OnChannelUnfrozenDelegate (OpenChannel channel)
 
delegate void OnChannelHiddenDelegate (GroupChannel channel)
 
delegate void OnMentionReceivedDelegate (BaseChannel channel, BaseMessage message)
 
delegate void OnOperatorUpdatedDelegate (BaseChannel channel)
 

Public Attributes

OnMessageReceivedDelegate OnMessageReceived = delegate { }
 
OnMessageUpdatedDelegate OnMessageUpdated = delegate { }
 
OnDeliveryReceiptUpdatedDelegate OnDeliveryReceiptUpdated = delegate { }
 
OnMessageDeletedDelegate OnMessageDeleted = delegate { }
 
OnChannelChangedDelegate OnChannelChanged = delegate { }
 
OnChannelDeletedDelegate OnChannelDeleted = delegate { }
 
OnReadReceiptUpdatedDelegate OnReadReceiptUpdated = delegate { }
 
OnTypingStatusUpdatedDelegate OnTypingStatusUpdated = delegate { }
 
OnUserJoinedDelegate OnUserJoined = delegate { }
 
OnUserReceivedInvitationDelegate OnUserReceivedInvitation = delegate { }
 
OnUserDeclinedInvitationDelegate OnUserDeclinedInvitation = delegate { }
 
OnUserLeftDelegate OnUserLeft = delegate { }
 
OnUserEnteredDelegate OnUserEntered = delegate { }
 
OnUserExitedDelegate OnUserExited = delegate { }
 
OnUserMutedDelegate OnUserMuted = delegate { }
 
OnUserUnmutedDelegate OnUserUnmuted = delegate { }
 
OnUserBannedDelegate OnUserBanned = delegate { }
 
OnUserUnbannedDelegate OnUserUnbanned = delegate { }
 
OnChannelFrozenDelegate OnChannelFrozen = delegate { }
 
OnChannelUnfrozenDelegate OnChannelUnfrozen = delegate { }
 
OnChannelHiddenDelegate OnChannelHidden = delegate { }
 
OnMentionReceivedDelegate OnMentionReceived = delegate { }
 
OnOperatorUpdatedDelegate OnOperatorUpdated = delegate { }
 

Detailed Description

Channel handler. This handler provides callbacks for events related OpenChannel or GroupChannel. All callbacks are called only when the currently logged-in User is a participant or member of OpenChannel or GroupChannel respectively. To add or remove this handler, refer to addChannelHandler(string, ChannelHandler) and RemoveChannelHandler(string).

Member Function Documentation

◆ OnChannelChangedDelegate()

delegate void SendBird.SendBirdClient.ChannelHandler.OnChannelChangedDelegate ( BaseChannel  channel)

A callback for when channel property is changed.

Parameters
channelThe channel the property is changed of.

◆ OnChannelDeletedDelegate()

delegate void SendBird.SendBirdClient.ChannelHandler.OnChannelDeletedDelegate ( string  channelUrl,
BaseChannel.ChannelType  channelType 
)

A callback for when channel is deleted.

Parameters
channelUrlURL of deleted channel.
channelTypeChannel type.
com.sendbird.android.BaseChannel.ChannelType#OPEN represents OpenChannel.
com.sendbird.android.BaseChannel.ChannelType#GROUP represents GroupChannel.

◆ OnChannelFrozenDelegate()

delegate void SendBird.SendBirdClient.ChannelHandler.OnChannelFrozenDelegate ( OpenChannel  channel)

A callback for when OpenChannel is frozen (Participants can't send messages).

Parameters
channelThe frozen OpenChannel.

◆ OnChannelHiddenDelegate()

delegate void SendBird.SendBirdClient.ChannelHandler.OnChannelHiddenDelegate ( GroupChannel  channel)

A callback for when GroupChannel is hidden.

Parameters
channelThe hidden GroupChannel.

◆ OnChannelUnfrozenDelegate()

delegate void SendBird.SendBirdClient.ChannelHandler.OnChannelUnfrozenDelegate ( OpenChannel  channel)

A callback for when OpenChannel is unfrozen (Participants can send messages).

Parameters
channelThe unfrozen OpenChannel.

◆ OnDeliveryReceiptUpdatedDelegate()

delegate void SendBird.SendBirdClient.ChannelHandler.OnDeliveryReceiptUpdatedDelegate ( GroupChannel  channel)

A callback for when delivered receipts are updated on GroupChannel.
To use the updated delivered receipt, refer to
GroupChannel#getDeliveryReceipt(BaseMessage)

Parameters
channelThe GroupChannel where the read receipt is updated. 2020.5

◆ OnMessageDeletedDelegate()

delegate void SendBird.SendBirdClient.ChannelHandler.OnMessageDeletedDelegate ( BaseChannel  channel,
long  msgId 
)

A callback for when a message is deleted.

Parameters
channelThe channel the deleted message belongs to.
msgIdThe ID of the deleted message.

◆ OnMessageReceivedDelegate()

delegate void SendBird.SendBirdClient.ChannelHandler.OnMessageReceivedDelegate ( BaseChannel  channel,
BaseMessage  message 
)

A callback for when a message is received.

Parameters
channelThe channel message has come from.
messageThe message received.

◆ OnMessageUpdatedDelegate()

delegate void SendBird.SendBirdClient.ChannelHandler.OnMessageUpdatedDelegate ( BaseChannel  channel,
BaseMessage  message 
)

A callback for when a message is updated.

Parameters
channelThe channel message has come from.
messageThe message received.
Since
3.0.15

◆ OnReadReceiptUpdatedDelegate()

delegate void SendBird.SendBirdClient.ChannelHandler.OnReadReceiptUpdatedDelegate ( GroupChannel  channel)

◆ OnTypingStatusUpdatedDelegate()

delegate void SendBird.SendBirdClient.ChannelHandler.OnTypingStatusUpdatedDelegate ( GroupChannel  channel)

A callback for when Users send typing status for GroupChannel.
To use the typing status, refer to GroupChannel#IsTyping() and GroupChannel#TypingMembers.

Parameters
channelThe GroupChannel where the typing status is updated.

◆ OnUserBannedDelegate()

delegate void SendBird.SendBirdClient.ChannelHandler.OnUserBannedDelegate ( BaseChannel  channel,
User  user 
)

A callback for when user is banned from channel

Parameters
channelThe channel the User is banned from.
userThe banned User.

◆ OnUserDeclinedInvitationDelegate()

delegate void SendBird.SendBirdClient.ChannelHandler.OnUserDeclinedInvitationDelegate ( GroupChannel  channel,
User  inviter,
User  invitee 
)

A callback for when the newly invited member has declined the invitation for the GroupChannel.

Parameters
channelThe GroupChannel the invitee has declined to join.
inviterThe member who invited the invitee.
inviteeInvitee who declined the invitation.
Since
3.0.15

◆ OnUserEnteredDelegate()

delegate void SendBird.SendBirdClient.ChannelHandler.OnUserEnteredDelegate ( OpenChannel  channel,
User  user 
)

A callback for when a User has entered OpenChannel. To use the updated participant count, refer to OpenChannel#ParticipantCount.

Parameters
channelThe OpenChannel the User has entered.
userThe new participant (User).

◆ OnUserExitedDelegate()

delegate void SendBird.SendBirdClient.ChannelHandler.OnUserExitedDelegate ( OpenChannel  channel,
User  user 
)

A callback for when a User has exited OpenChannel. To use the updated participant count, refer to OpenChannel#ParticipantCount.

Parameters
channelThe OpenChannel the User has exited.
userThe ex-participant (User).

◆ OnUserJoinedDelegate()

delegate void SendBird.SendBirdClient.ChannelHandler.OnUserJoinedDelegate ( GroupChannel  channel,
User  user 
)

A callback for when a new member has joined GroupChannel. To use the updated member list, refer to GroupChannel#Members and GroupChannel#MemberCount.

Parameters
channelThe GroupChannel the new member has joined.
userThe newly joined member (User).

◆ OnUserLeftDelegate()

delegate void SendBird.SendBirdClient.ChannelHandler.OnUserLeftDelegate ( GroupChannel  channel,
User  user 
)

A callback for when an existing member has left GroupChannel. To use the updated member list and count, refer to GroupChannel#Members and GroupChannel#MemberCount.

Parameters
channelThe GroupChannel the member has left from.
userThe left member (User).

◆ OnUserMutedDelegate()

delegate void SendBird.SendBirdClient.ChannelHandler.OnUserMutedDelegate ( BaseChannel  channel,
User  user 
)

A callback for when a User is muted from OpenChannel.

Parameters
channelThe OpenChannel the User is muted from.
userThe muted User.

◆ OnUserReceivedInvitationDelegate()

delegate void SendBird.SendBirdClient.ChannelHandler.OnUserReceivedInvitationDelegate ( GroupChannel  channel,
User  inviter,
List< User invitees 
)

A callback for when a new member has been invited to GroupChannel. If the member accepts the invitation (refer to GroupChannel#acceptInvitation(GroupChannel.GroupChannelAcceptInvitationHandler), onUserJoined(GroupChannel, User) will be called. Or, the member can also decline the invitation (refer to GroupChannel#declineInvitation(GroupChannel.GroupChannelDeclineInvitationHandler) to cause onUserDeclinedInvitation(GroupChannel, User, User).

Parameters
channelThe GroupChannel the new member has been invited.
inviterThe member who invited the invitees.
inviteesInvitees list.
Since
3.0.15

◆ OnUserUnbannedDelegate()

delegate void SendBird.SendBirdClient.ChannelHandler.OnUserUnbannedDelegate ( BaseChannel  channel,
User  user 
)

A callback for when user is unbanned from channel

Parameters
channelThe channel the User is unbanned from.
userThe banned User.

◆ OnUserUnmutedDelegate()

delegate void SendBird.SendBirdClient.ChannelHandler.OnUserUnmutedDelegate ( BaseChannel  channel,
User  user 
)

A callback for when User is unmuted from OpenChannel.

Parameters
channelThe OpenChannel the User is unmuted from.
userThe unmuted User.

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