public abstract static class SendBird.ChannelHandler
extends java.lang.Object
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 SendBird.addChannelHandler(String, ChannelHandler)
and SendBird.removeChannelHandler(String)
.Constructor and Description |
---|
ChannelHandler() |
Modifier and Type | Method and Description |
---|---|
void |
onChannelChanged(BaseChannel channel)
A callback for when channel property is changed.
|
void |
onChannelDeleted(java.lang.String channelUrl,
BaseChannel.ChannelType channelType)
A callback for when channel is deleted.
|
void |
onChannelFrozen(BaseChannel channel)
A callback for when channel is frozen (Users can't send messages).
|
void |
onChannelHidden(GroupChannel channel)
A callback for when
GroupChannel is hidden. |
void |
onChannelMemberCountChanged(java.util.List<GroupChannel> groupChannels)
Called when one or more broadcast channel's member counts are changed.
|
void |
onChannelParticipantCountChanged(java.util.List<OpenChannel> openChannels)
Called when one or more open channel's member counts are changed.
|
void |
onChannelUnfrozen(BaseChannel channel)
A callback for when channel is unfrozen (Users can send messages).
|
void |
onDeliveryReceiptUpdated(GroupChannel channel)
A callback for when delivered receipts are updated on
GroupChannel .To use the updated delivered receipt, refer to GroupChannel.getDeliveryReceipt(BaseMessage) |
void |
onMentionReceived(BaseChannel channel,
BaseMessage message)
A callback for when a mention is received.
|
void |
onMessageDeleted(BaseChannel channel,
long msgId)
A callback for when a message is deleted.
|
abstract void |
onMessageReceived(BaseChannel channel,
BaseMessage message)
A callback for when a message is received.
|
void |
onMessageUpdated(BaseChannel channel,
BaseMessage message)
A callback for when a message is updated.
|
void |
onMetaCountersCreated(BaseChannel channel,
java.util.Map<java.lang.String,java.lang.Integer> metaCounterMap)
A callback for when channel meta counters is created.
|
void |
onMetaCountersDeleted(BaseChannel channel,
java.util.List<java.lang.String> keys)
A callback for when channel meta counters are deleted.
|
void |
onMetaCountersUpdated(BaseChannel channel,
java.util.Map<java.lang.String,java.lang.Integer> metaCounterMap)
A callback for when channel meta counters is updated.
|
void |
onMetaDataCreated(BaseChannel channel,
java.util.Map<java.lang.String,java.lang.String> metaDataMap)
A callback for when channel meta data is created.
|
void |
onMetaDataDeleted(BaseChannel channel,
java.util.List<java.lang.String> keys)
A callback for when channel meta data is deleted.
|
void |
onMetaDataUpdated(BaseChannel channel,
java.util.Map<java.lang.String,java.lang.String> metaDataMap)
A callback for when channel meta data is updated.
|
void |
onOperatorUpdated(BaseChannel channel)
A callback for when operators change in channel
|
void |
onPinnedMessageUpdated(GroupChannel channel)
A callback for when pinned message is changed.
|
void |
onReactionUpdated(BaseChannel channel,
ReactionEvent reactionEvent)
A callback for when a reactionEvent is updated.
|
void |
onReadReceiptUpdated(GroupChannel channel)
A callback for when read receipts are updated on
GroupChannel .To use the updated read receipt, refer to GroupChannel.getReadReceipt(BaseMessage) ,GroupChannel.getReadStatus() ,GroupChannel.getReadMembers(BaseMessage) ,GroupChannel.getUnreadMembers(BaseMessage) ,GroupChannel.getLastSeenAtBy(User) ,GroupChannel.getLastSeenAtByWithUserId(String) . |
void |
onThreadInfoUpdated(BaseChannel channel,
ThreadInfoUpdateEvent threadInfoUpdateEvent)
A callback for when the thread information is updated.
|
void |
onTypingStatusUpdated(GroupChannel channel)
A callback for when
User s send typing status for GroupChannel .To use the typing status, refer to GroupChannel.isTyping() and GroupChannel.getTypingMembers() . |
void |
onUserBanned(BaseChannel channel,
User user)
A callback for when user is banned from channel.
|
void |
onUserDeclinedInvitation(GroupChannel channel,
User inviter,
User invitee)
A callback for when the newly invited member has declined the invitation for the
GroupChannel . |
void |
onUserEntered(OpenChannel channel,
User user)
A callback for when a
User has entered OpenChannel . |
void |
onUserExited(OpenChannel channel,
User user)
A callback for when a
User has exited OpenChannel . |
void |
onUserJoined(GroupChannel channel,
User user)
A callback for when a new member has joined
GroupChannel . |
void |
onUserLeft(GroupChannel channel,
User user)
A callback for when an existing member has left
GroupChannel . |
void |
onUserMuted(BaseChannel channel,
User user)
A callback for when a
User is muted from channel. |
void |
onUserReceivedInvitation(GroupChannel channel,
User inviter,
java.util.List<User> invitees)
A callback for when a new member has been invited to
GroupChannel . |
void |
onUserUnbanned(BaseChannel channel,
User user)
A callback for when user is unbanned from channel.
|
void |
onUserUnmuted(BaseChannel channel,
User user)
A callback for when
User is unmuted from channel. |
public abstract void onMessageReceived(BaseChannel channel, BaseMessage message)
channel
- The channel message has come from.message
- The message received.public void onMentionReceived(BaseChannel channel, BaseMessage message)
channel
- The channel message has come from.message
- The message received.public void onMessageDeleted(BaseChannel channel, long msgId)
channel
- The channel the deleted message belongs to.msgId
- The ID of the deleted message.public void onMessageUpdated(BaseChannel channel, BaseMessage message)
channel
- The channel the updated message belongs to.message
- The updated message.public void onChannelChanged(BaseChannel channel)
channel
- The channel the property is changed of.public void onChannelDeleted(java.lang.String channelUrl, BaseChannel.ChannelType channelType)
channelUrl
- URL of deleted channel.channelType
- Channel type.BaseChannel.ChannelType.OPEN
represents OpenChannel
.BaseChannel.ChannelType.GROUP
represents GroupChannel
.public void onReactionUpdated(BaseChannel channel, ReactionEvent reactionEvent)
channel
- The channel the updated message belongs to.reactionEvent
- The updated reactionEvent.public void onReadReceiptUpdated(GroupChannel channel)
GroupChannel
.GroupChannel.getReadReceipt(BaseMessage)
,GroupChannel.getReadStatus()
,GroupChannel.getReadMembers(BaseMessage)
,GroupChannel.getUnreadMembers(BaseMessage)
,GroupChannel.getLastSeenAtBy(User)
,GroupChannel.getLastSeenAtByWithUserId(String)
.channel
- The GroupChannel
where the read receipt is updated.public void onDeliveryReceiptUpdated(GroupChannel channel)
GroupChannel
.GroupChannel.getDeliveryReceipt(BaseMessage)
channel
- The GroupChannel
where the read receipt is updated.public void onTypingStatusUpdated(GroupChannel channel)
User
s send typing status for GroupChannel
.GroupChannel.isTyping()
and GroupChannel.getTypingMembers()
.channel
- The GroupChannel
where the typing status is updated.public void onUserReceivedInvitation(GroupChannel channel, User inviter, java.util.List<User> invitees)
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)
.channel
- The GroupChannel
the new member has been invited.inviter
- The member who invited the invitees.invitees
- Invitees list.public void onUserJoined(GroupChannel channel, User user)
GroupChannel
.
To use the updated member list, refer to GroupChannel.getMembers()
and GroupChannel.getMemberCount()
.channel
- The GroupChannel
the new member has joined.user
- The newly joined member (User
).public void onUserDeclinedInvitation(GroupChannel channel, User inviter, User invitee)
GroupChannel
.channel
- The GroupChannel
the invitee has declined to join.inviter
- The member who invited the invitee.invitee
- Invitee who declined the invitation.public void onUserLeft(GroupChannel channel, User user)
GroupChannel
.
To use the updated member list and count, refer to GroupChannel.getMembers()
and GroupChannel.getMemberCount()
.channel
- The GroupChannel
the member has left from.user
- The left member (User
).public void onUserEntered(OpenChannel channel, User user)
User
has entered OpenChannel
.
To use the updated participant count, refer to OpenChannel.getParticipantCount()
.channel
- The OpenChannel
the User
has entered.user
- The new participant (User
).public void onUserExited(OpenChannel channel, User user)
User
has exited OpenChannel
.
To use the updated participant count, refer to OpenChannel.getParticipantCount()
.channel
- The OpenChannel
the User
has exited.user
- The ex-participant (User
).public void onUserMuted(BaseChannel channel, User user)
User
is muted from channel.channel
- The channel the User
is muted from.user
- The muted User
.public void onUserUnmuted(BaseChannel channel, User user)
User
is unmuted from channel.channel
- The channel the User
is unmuted from.user
- The unmuted User
.public void onUserBanned(BaseChannel channel, User user)
channel
- The channel the User
is banned from.user
- The banned User
.public void onUserUnbanned(BaseChannel channel, User user)
channel
- The channel the User
is unbanned from.user
- The banned User
.public void onChannelFrozen(BaseChannel channel)
channel
- The frozen channel.public void onChannelUnfrozen(BaseChannel channel)
channel
- The unfrozen channel.public void onMetaDataCreated(BaseChannel channel, java.util.Map<java.lang.String,java.lang.String> metaDataMap)
channel
- The channel the meta data is created of.metaDataMap
- The created meta data key-value map.public void onMetaDataUpdated(BaseChannel channel, java.util.Map<java.lang.String,java.lang.String> metaDataMap)
channel
- The channel the meta data is updated of.metaDataMap
- The updated meta data key-value map.public void onMetaDataDeleted(BaseChannel channel, java.util.List<java.lang.String> keys)
channel
- The channel the meta data is deleted of.keys
- The deleted meta data keys.public void onMetaCountersCreated(BaseChannel channel, java.util.Map<java.lang.String,java.lang.Integer> metaCounterMap)
channel
- The channel the meta counters are created of.metaCounterMap
- The created meta counters key-value map.public void onMetaCountersUpdated(BaseChannel channel, java.util.Map<java.lang.String,java.lang.Integer> metaCounterMap)
channel
- The channel the meta counters are updated of.metaCounterMap
- The updated meta counters key-value map.public void onMetaCountersDeleted(BaseChannel channel, java.util.List<java.lang.String> keys)
channel
- The channel the meta counters are deleted of.keys
- The deleted meta counters keys.public void onChannelHidden(GroupChannel channel)
GroupChannel
is hidden.channel
- The hidden GroupChannel
.public void onOperatorUpdated(BaseChannel channel)
channel
- The BaseChannel
the change has occurred.public void onThreadInfoUpdated(BaseChannel channel, ThreadInfoUpdateEvent threadInfoUpdateEvent)
channel
- The channel message has come from.threadInfoUpdateEvent
- The updated thread info event.public void onChannelMemberCountChanged(java.util.List<GroupChannel> groupChannels)
groupChannels
- channels which had a change in the member count.public void onChannelParticipantCountChanged(java.util.List<OpenChannel> openChannels)
openChannels
- channels which had a change in the member count.public void onPinnedMessageUpdated(GroupChannel channel)
channel
- The channel the pinned message is changed of. Copyright © 2021, Sendbird or its affiliates. All rights reserved.
Report a bug or request a feature
For further developer documentation, see Chat SDK Documentation. That documentation contains more detailed descriptions, conceptual overviews, definitions of terms, and code examples.