GroupChannelHandler

Constructors

Link copied to clipboard
constructor()

Functions

Link copied to clipboard
open fun onChannelChanged(channel: BaseChannel)

A callback for when channel property is changed.

Link copied to clipboard
open fun onChannelDeleted(channelUrl: String, channelType: ChannelType)

A callback for when channel is deleted.

Link copied to clipboard
open fun onChannelFrozen(channel: BaseChannel)

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

Link copied to clipboard
open fun onChannelHidden(channel: GroupChannel)

A callback for when GroupChannel is hidden.

Link copied to clipboard

Called when one or more broadcast channel's member counts are changed.

Link copied to clipboard
open fun onChannelUnfrozen(channel: BaseChannel)

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

Link copied to clipboard

A callback for when delivered receipts are updated on GroupChannel.

To use the updated delivered receipt, refer to

GroupChannel.getUndeliveredMemberCount

Link copied to clipboard
open fun onMentionReceived(channel: BaseChannel, message: BaseMessage)

A callback for when a mention is received.

Link copied to clipboard
open fun onMessageDeleted(channel: BaseChannel, msgId: Long)

A callback for when a message is deleted.

Link copied to clipboard
abstract fun onMessageReceived(channel: BaseChannel, message: BaseMessage)

A callback for when a message is received.

Link copied to clipboard
open fun onMessageUpdated(channel: BaseChannel, message: BaseMessage)

A callback for when a message is updated.

Link copied to clipboard
open fun onMetaCountersCreated(channel: BaseChannel, metaCounterMap: Map<String, Int>)

A callback for when channel meta counters is created.

Link copied to clipboard
open fun onMetaCountersDeleted(channel: BaseChannel, keys: List<String>)

A callback for when channel meta counters are deleted.

Link copied to clipboard
open fun onMetaCountersUpdated(channel: BaseChannel, metaCounterMap: Map<String, Int>)

A callback for when channel meta counters is updated.

Link copied to clipboard
open fun onMetaDataCreated(channel: BaseChannel, metaDataMap: Map<String, String>)

A callback for when channel meta data is created.

Link copied to clipboard
open fun onMetaDataDeleted(channel: BaseChannel, keys: List<String>)

A callback for when channel meta data is deleted.

Link copied to clipboard
open fun onMetaDataUpdated(channel: BaseChannel, metaDataMap: Map<String, String>)

A callback for when channel meta data is updated.

Link copied to clipboard
open fun onOperatorUpdated(channel: BaseChannel)

A callback for when operators change in channel

Link copied to clipboard

A callback for when pinned message is changed.

Link copied to clipboard
open fun onPollDeleted(channel: GroupChannel, pollId: Long)

Called when a poll is deleted.

Link copied to clipboard
open fun onPollUpdated(channel: GroupChannel, pollUpdateEvent: PollUpdateEvent)

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

Link copied to clipboard
open fun onPollVoted(channel: GroupChannel, pollVoteEvent: PollVoteEvent)

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.pollId, PollVoteEvent.messageId) and call Poll.applyPollVoteEvent on those messages.

Link copied to clipboard
open fun onReactionUpdated(channel: BaseChannel, reactionEvent: ReactionEvent)

A callback for when a reactionEvent is updated.

Link copied to clipboard

A callback for when read receipts are updated on GroupChannel.

To use the updated read receipt, refer to

GroupChannel.getReadStatus,

GroupChannel.getReadMembers,

GroupChannel.getUnreadMembers.

Link copied to clipboard
open fun onThreadInfoUpdated(channel: BaseChannel, threadInfoUpdateEvent: ThreadInfoUpdateEvent)

A callback for when the thread information is updated.

Link copied to clipboard

A callback for when Users send typing status for GroupChannel.

To use the typing status, refer to GroupChannel.isTyping and GroupChannel.typingUsers.

Link copied to clipboard
open fun onUserBanned(channel: BaseChannel, restrictedUser: RestrictedUser)

A callback for when user is banned from channel.

Link copied to clipboard
open fun onUserDeclinedInvitation(channel: GroupChannel, inviter: User?, invitee: User)

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

Link copied to clipboard
open fun onUserJoined(channel: GroupChannel, 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.

Link copied to clipboard
open fun onUserLeft(channel: GroupChannel, 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.

Link copied to clipboard
open fun onUserMuted(channel: BaseChannel, restrictedUser: RestrictedUser)

A callback for when a User is muted from channel.

Link copied to clipboard
open fun onUserReceivedInvitation(channel: GroupChannel, inviter: User?, invitees: List<User>)

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

Link copied to clipboard
open fun onUserUnbanned(channel: BaseChannel, user: User)

A callback for when user is unbanned from channel.

Link copied to clipboard
open fun onUserUnmuted(channel: BaseChannel, user: User)

A callback for when User is unmuted from channel.