-
public abstract class SendBird.ChannelHandler
Channel handler. This handler provides callbacks for events related
OpenChannel
orGroupChannel
.All callbacks are called only when the currently logged-inUser
is a participant or member ofOpenChannel
orGroupChannel
respectively.To add or remove this handler, refer to addChannelHandler and removeChannelHandler.
-
-
Method Summary
Modifier and Type Method Description abstract void
onMessageReceived(BaseChannel channel, BaseMessage message)
A callback for when a message is received. 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. void
onMessageUpdated(BaseChannel channel, BaseMessage message)
A callback for when a message is updated. void
onChannelChanged(BaseChannel channel)
A callback for when channel property is changed. void
onChannelDeleted(String channelUrl, BaseChannel.ChannelType channelType)
A callback for when channel is deleted. 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
.void
onDeliveryReceiptUpdated(GroupChannel channel)
A callback for when delivered receipts are updated on GroupChannel
.void
onTypingStatusUpdated(GroupChannel channel)
A callback for when User
s send typing status forGroupChannel
.void
onUserReceivedInvitation(GroupChannel channel, User inviter, List<User> invitees)
A callback for when a new member has been invited to GroupChannel
.void
onUserJoined(GroupChannel channel, User user)
A callback for when a new member has joined GroupChannel
.void
onUserDeclinedInvitation(GroupChannel channel, User inviter, User invitee)
A callback for when the newly invited member has declined the invitation for the GroupChannel
.void
onUserLeft(GroupChannel channel, User user)
A callback for when an existing member has left GroupChannel
.void
onUserEntered(OpenChannel channel, User user)
A callback for when a User
has enteredOpenChannel
.void
onUserExited(OpenChannel channel, User user)
A callback for when a User
has exitedOpenChannel
.void
onUserMuted(BaseChannel channel, User user)
A callback for when a User
is muted from channel.void
onUserUnmuted(BaseChannel channel, User user)
A callback for when User
is unmuted from channel.void
onUserBanned(BaseChannel channel, User user)
A callback for when user is banned from channel. void
onUserUnbanned(BaseChannel channel, User user)
A callback for when user is unbanned from channel. void
onChannelFrozen(BaseChannel channel)
A callback for when channel is frozen (Users can't send messages). void
onChannelUnfrozen(BaseChannel channel)
A callback for when channel is unfrozen (Users can send messages). void
onMetaDataCreated(BaseChannel channel, Map<String, String> metaDataMap)
A callback for when channel meta data is created. void
onMetaDataUpdated(BaseChannel channel, Map<String, String> metaDataMap)
A callback for when channel meta data is updated. void
onMetaDataDeleted(BaseChannel channel, List<String> keys)
A callback for when channel meta data is deleted. void
onMetaCountersCreated(BaseChannel channel, Map<String, Integer> metaCounterMap)
A callback for when channel meta counters is created. void
onMetaCountersUpdated(BaseChannel channel, Map<String, Integer> metaCounterMap)
A callback for when channel meta counters is updated. void
onMetaCountersDeleted(BaseChannel channel, List<String> keys)
A callback for when channel meta counters are deleted. void
onChannelHidden(GroupChannel channel)
A callback for when GroupChannel
is hidden.void
onOperatorUpdated(BaseChannel channel)
A callback for when operators change in channel void
onThreadInfoUpdated(BaseChannel channel, ThreadInfoUpdateEvent threadInfoUpdateEvent)
A callback for when the thread information is updated. void
onChannelMemberCountChanged(List<GroupChannel> groupChannels)
Called when one or more broadcast channel's member counts are changed. void
onChannelParticipantCountChanged(List<OpenChannel> openChannels)
Called when one or more open channel's member counts are changed. void
onPollUpdated(PollUpdateEvent event)
Called when a poll is updated. void
onPollVoted(PollVoteEvent event)
Called when one or more vote is cast/canceled on a poll. -
-
Method Detail
-
onMessageReceived
abstract void onMessageReceived(BaseChannel channel, BaseMessage message)
A callback for when a message is received.
- Parameters:
channel
- The channel message has come from.message
- The message received.
-
onMentionReceived
void onMentionReceived(BaseChannel channel, BaseMessage message)
A callback for when a mention is received.
- Parameters:
channel
- The channel message has come from.message
- The message received.
-
onMessageDeleted
void onMessageDeleted(BaseChannel channel, long msgId)
A callback for when a message is deleted.
- Parameters:
channel
- The channel the deleted message belongs to.msgId
- The ID of the deleted message.
-
onMessageUpdated
void onMessageUpdated(BaseChannel channel, BaseMessage message)
A callback for when a message is updated.
- Parameters:
channel
- The channel the updated message belongs to.message
- The updated message.
-
onChannelChanged
void onChannelChanged(BaseChannel channel)
A callback for when channel property is changed.
- Parameters:
channel
- The channel the property is changed of.
-
onChannelDeleted
void onChannelDeleted(String channelUrl, BaseChannel.ChannelType channelType)
A callback for when channel is deleted.
- Parameters:
channelUrl
- URL of deleted channel.channelType
- Channel type.
-
onReactionUpdated
void onReactionUpdated(BaseChannel channel, ReactionEvent reactionEvent)
A callback for when a reactionEvent is updated.
- Parameters:
channel
- The channel the updated message belongs to.reactionEvent
- The updated reactionEvent.
-
onReadReceiptUpdated
void onReadReceiptUpdated(GroupChannel channel)
A callback for when read receipts are updated on
GroupChannel
.To use the updated read receipt, refer togetReadReceipt,getReadStatus,getReadMembers,getUnreadMembers,getLastSeenAtBy,getLastSeenAtByWithUserId.- Parameters:
channel
- TheGroupChannel
where the read receipt is updated.
-
onDeliveryReceiptUpdated
void onDeliveryReceiptUpdated(GroupChannel channel)
A callback for when delivered receipts are updated on
GroupChannel
.To use the updated delivered receipt, refer togetDeliveryReceipt- Parameters:
channel
- TheGroupChannel
where the read receipt is updated.
-
onTypingStatusUpdated
void onTypingStatusUpdated(GroupChannel channel)
A callback for when
User
s send typing status forGroupChannel
.To use the typing status, refer to isTyping and getTypingMembers.- Parameters:
channel
- TheGroupChannel
where the typing status is updated.
-
onUserReceivedInvitation
void onUserReceivedInvitation(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 acceptInvitation, onUserJoined will be called.Or, the member can also decline the invitation (refer to declineInvitation to cause onUserDeclinedInvitation.- Parameters:
channel
- TheGroupChannel
the new member has been invited.inviter
- The member who invited the invitees.invitees
- Invitees list.
-
onUserJoined
void onUserJoined(GroupChannel channel, User user)
A callback for when a new member has joined
GroupChannel
.To use the updated member list, refer to getMembers and getMemberCount.- Parameters:
channel
- TheGroupChannel
the new member has joined.user
- The newly joined member (User
).
-
onUserDeclinedInvitation
void onUserDeclinedInvitation(GroupChannel channel, User inviter, User invitee)
A callback for when the newly invited member has declined the invitation for the
GroupChannel
.- Parameters:
channel
- TheGroupChannel
the invitee has declined to join.inviter
- The member who invited the invitee.invitee
- Invitee who declined the invitation.
-
onUserLeft
void onUserLeft(GroupChannel channel, User user)
A callback for when an existing member has left
GroupChannel
.To use the updated member list and count, refer to getMembers and getMemberCount.- Parameters:
channel
- TheGroupChannel
the member has left from.user
- The left member (User
).
-
onUserEntered
void onUserEntered(OpenChannel channel, User user)
A callback for when a
User
has enteredOpenChannel
.To use the updated participant count, refer to getParticipantCount.- Parameters:
channel
- TheOpenChannel
theUser
has entered.user
- The new participant (User
).
-
onUserExited
void onUserExited(OpenChannel channel, User user)
A callback for when a
User
has exitedOpenChannel
.To use the updated participant count, refer to getParticipantCount.- Parameters:
channel
- TheOpenChannel
theUser
has exited.user
- The ex-participant (User
).
-
onUserMuted
void onUserMuted(BaseChannel channel, User user)
A callback for when a
User
is muted from channel.- Parameters:
channel
- The channel theUser
is muted from.user
- The mutedUser
.
-
onUserUnmuted
void onUserUnmuted(BaseChannel channel, User user)
A callback for when
User
is unmuted from channel.- Parameters:
channel
- The channel theUser
is unmuted from.user
- The unmutedUser
.
-
onUserBanned
void onUserBanned(BaseChannel channel, User user)
A callback for when user is banned from channel.
- Parameters:
channel
- The channel theUser
is banned from.user
- The bannedUser
.
-
onUserUnbanned
void onUserUnbanned(BaseChannel channel, User user)
A callback for when user is unbanned from channel.
- Parameters:
channel
- The channel theUser
is unbanned from.user
- The bannedUser
.
-
onChannelFrozen
void onChannelFrozen(BaseChannel channel)
A callback for when channel is frozen (Users can't send messages).
- Parameters:
channel
- The frozen channel.
-
onChannelUnfrozen
void onChannelUnfrozen(BaseChannel channel)
A callback for when channel is unfrozen (Users can send messages).
- Parameters:
channel
- The unfrozen channel.
-
onMetaDataCreated
void onMetaDataCreated(BaseChannel channel, Map<String, String> metaDataMap)
A callback for when channel meta data is created.
- Parameters:
channel
- The channel the meta data is created of.metaDataMap
- The created meta data key-value map.
-
onMetaDataUpdated
void onMetaDataUpdated(BaseChannel channel, Map<String, String> metaDataMap)
A callback for when channel meta data is updated.
- Parameters:
channel
- The channel the meta data is updated of.metaDataMap
- The updated meta data key-value map.
-
onMetaDataDeleted
void onMetaDataDeleted(BaseChannel channel, List<String> keys)
A callback for when channel meta data is deleted.
- Parameters:
channel
- The channel the meta data is deleted of.keys
- The deleted meta data keys.
-
onMetaCountersCreated
void onMetaCountersCreated(BaseChannel channel, Map<String, Integer> metaCounterMap)
A callback for when channel meta counters is created.
- Parameters:
channel
- The channel the meta counters are created of.metaCounterMap
- The created meta counters key-value map.
-
onMetaCountersUpdated
void onMetaCountersUpdated(BaseChannel channel, Map<String, Integer> metaCounterMap)
A callback for when channel meta counters is updated.
- Parameters:
channel
- The channel the meta counters are updated of.metaCounterMap
- The updated meta counters key-value map.
-
onMetaCountersDeleted
void onMetaCountersDeleted(BaseChannel channel, List<String> keys)
A callback for when channel meta counters are deleted.
- Parameters:
channel
- The channel the meta counters are deleted of.keys
- The deleted meta counters keys.
-
onChannelHidden
void onChannelHidden(GroupChannel channel)
A callback for when
GroupChannel
is hidden.- Parameters:
channel
- The hiddenGroupChannel
.
-
onOperatorUpdated
void onOperatorUpdated(BaseChannel channel)
A callback for when operators change in channel
- Parameters:
channel
- TheBaseChannel
the change has occurred.
-
onThreadInfoUpdated
void onThreadInfoUpdated(BaseChannel channel, ThreadInfoUpdateEvent threadInfoUpdateEvent)
A callback for when the thread information is updated.
- Parameters:
channel
- The channel message has come from.threadInfoUpdateEvent
- The updated thread info event.
-
onChannelMemberCountChanged
void onChannelMemberCountChanged(List<GroupChannel> groupChannels)
Called when one or more broadcast channel's member counts are changed.
- Parameters:
groupChannels
- channels which had a change in the member count.
-
onChannelParticipantCountChanged
void onChannelParticipantCountChanged(List<OpenChannel> openChannels)
Called when one or more open channel's member counts are changed.
- Parameters:
openChannels
- channels which had a change in the member count.
-
onPollUpdated
void onPollUpdated(PollUpdateEvent event)
Called when a poll is updated. The user should search for cached messages that containthis event's poll (getPoll) and call applyPollUpdateEvent on those messages.
-
onPollVoted
void onPollVoted(PollVoteEvent event)
Called when one or more vote is cast/canceled on a poll. The user should search forcached messages that contain this event's poll (getPollId) andcall applyPollVoteEvent on those messages.
-
-
-
-