com.sendbird.android

Class SendBird.ChannelHandler

java.lang.Object

com.sendbird.android.SendBird.ChannelHandler

Enclosing class:

SendBird

public abstract static class SendBird.ChannelHandler
extends java.lang.Object

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 SendBird.addChannelHandler(String, ChannelHandler) and SendBird.removeChannelHandler(String).

Constructor Summary

Constructors

Constructor and Description
ChannelHandler()

Method Summary

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	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.
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 Users 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.

Methods inherited from class java.lang.Object

equals, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

Constructor Detail

ChannelHandler

public ChannelHandler()

Method Detail

onMessageReceived

public 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

public 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.

Since:

3.0.52

onMessageDeleted

public 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

public 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.

Since:

3.0.27

onChannelChanged

public void onChannelChanged(BaseChannel channel)

A callback for when channel property is changed.

Parameters:

channel - The channel the property is changed of.

onChannelDeleted

public void onChannelDeleted(java.lang.String channelUrl,
                             BaseChannel.ChannelType channelType)

A callback for when channel is deleted.

Parameters:

channelUrl - URL of deleted channel.

channelType - Channel type.
BaseChannel.ChannelType.OPEN represents OpenChannel.
BaseChannel.ChannelType.GROUP represents GroupChannel.

onReactionUpdated

public 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.

Since:

3.0.112

onReadReceiptUpdated

public 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).

Parameters:

channel - The GroupChannel where the read receipt is updated.

onDeliveryReceiptUpdated

public 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)

Parameters:

channel - The GroupChannel where the read receipt is updated.

onTypingStatusUpdated

public void onTypingStatusUpdated(GroupChannel channel)

A callback for when Users send typing status for GroupChannel.
To use the typing status, refer to GroupChannel.isTyping() and GroupChannel.getTypingMembers().

Parameters:

channel - The GroupChannel where the typing status is updated.

onUserReceivedInvitation

public void onUserReceivedInvitation(GroupChannel channel,
                                     User inviter,
                                     java.util.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:

channel - The GroupChannel the new member has been invited.

inviter - The member who invited the invitees.

invitees - Invitees list.

Since:

3.0.30

onUserJoined

public void onUserJoined(GroupChannel channel,
                         User user)

A callback for when a new member has joined GroupChannel. To use the updated member list, refer to GroupChannel.getMembers() and GroupChannel.getMemberCount().

Parameters:

channel - The GroupChannel the new member has joined.

user - The newly joined member (User).

onUserDeclinedInvitation

public 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 - The GroupChannel the invitee has declined to join.

inviter - The member who invited the invitee.

invitee - Invitee who declined the invitation.

Since:

3.0.30

onUserLeft

public 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 GroupChannel.getMembers() and GroupChannel.getMemberCount().

Parameters:

channel - The GroupChannel the member has left from.

user - The left member (User).

onUserEntered

public void onUserEntered(OpenChannel channel,
                          User user)

A callback for when a User has entered OpenChannel. To use the updated participant count, refer to OpenChannel.getParticipantCount().

Parameters:

channel - The OpenChannel the User has entered.

user - The new participant (User).

onUserExited

public void onUserExited(OpenChannel channel,
                         User user)

A callback for when a User has exited OpenChannel. To use the updated participant count, refer to OpenChannel.getParticipantCount().

Parameters:

channel - The OpenChannel the User has exited.

user - The ex-participant (User).

onUserMuted

public void onUserMuted(BaseChannel channel,
                        User user)

A callback for when a User is muted from channel.

Parameters:

channel - The channel the User is muted from.

user - The muted User.

onUserUnmuted

public void onUserUnmuted(BaseChannel channel,
                          User user)

A callback for when User is unmuted from channel.

Parameters:

channel - The channel the User is unmuted from.

user - The unmuted User.

onUserBanned

public void onUserBanned(BaseChannel channel,
                         User user)

A callback for when user is banned from channel.

Parameters:

channel - The channel the User is banned from.

user - The banned User.

onUserUnbanned

public void onUserUnbanned(BaseChannel channel,
                           User user)

A callback for when user is unbanned from channel.

Parameters:

channel - The channel the User is unbanned from.

user - The banned User.

onChannelFrozen

public void onChannelFrozen(BaseChannel channel)

A callback for when channel is frozen (Users can't send messages).

Parameters:

channel - The frozen channel.

onChannelUnfrozen

public void onChannelUnfrozen(BaseChannel channel)

A callback for when channel is unfrozen (Users can send messages).

Parameters:

channel - The unfrozen channel.

onMetaDataCreated

public void onMetaDataCreated(BaseChannel channel,
                              java.util.Map<java.lang.String,java.lang.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.

Since:

3.0.34

onMetaDataUpdated

public void onMetaDataUpdated(BaseChannel channel,
                              java.util.Map<java.lang.String,java.lang.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.

Since:

3.0.34

onMetaDataDeleted

public void onMetaDataDeleted(BaseChannel channel,
                              java.util.List<java.lang.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.

Since:

3.0.34

onMetaCountersCreated

public void onMetaCountersCreated(BaseChannel channel,
                                  java.util.Map<java.lang.String,java.lang.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.

Since:

3.0.34

onMetaCountersUpdated

public void onMetaCountersUpdated(BaseChannel channel,
                                  java.util.Map<java.lang.String,java.lang.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.

Since:

3.0.34

onMetaCountersDeleted

public void onMetaCountersDeleted(BaseChannel channel,
                                  java.util.List<java.lang.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.

Since:

3.0.34

onChannelHidden

public void onChannelHidden(GroupChannel channel)

A callback for when GroupChannel is hidden.

Parameters:

channel - The hidden GroupChannel.

Since:

3.0.41

onOperatorUpdated

public void onOperatorUpdated(BaseChannel channel)

A callback for when operators change in channel

Parameters:

channel - The BaseChannel the change has occurred.

Since:

3.0.124

onThreadInfoUpdated

public 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.

Since:

3.0.130

onChannelMemberCountChanged

public void onChannelMemberCountChanged(java.util.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.

Since:

3.0.158

onChannelParticipantCountChanged

public void onChannelParticipantCountChanged(java.util.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.

Since:

3.0.158

onPollUpdated

public void onPollUpdated(PollUpdateEvent event)

Called when a poll is updated. The user should search for cached messages that contain this event's poll (PollUpdateEvent#getPoll()) and call UserMessage.applyPollUpdateEvent(PollUpdateEvent) on those messages.

Since:

3.0.171

onPollVoted

public void onPollVoted(PollVoteEvent event)

Called when one or more vote is cast/canceled on a poll. The user should search for cached messages that contain this event's poll (PollVoteEvent#getPollId()) and call UserMessage.applyPollVoteEvent(PollVoteEvent) on those messages.

Since:

3.0.171