Class GroupChannelHandler

Hierarchy

  • GroupChannelHandlerParams
    • GroupChannelHandler

Constructors

constructor

Properties

onChannelChanged? onChannelDeleted? onChannelFrozen? onChannelHidden? onChannelMemberCountChanged? onChannelUnfrozen? onMentionReceived? onMessageDeleted? onMessageReceived? onMessageUpdated? onMetaCounterCreated? onMetaCounterDeleted? onMetaCounterUpdated? onMetaDataCreated? onMetaDataDeleted? onMetaDataUpdated? onOperatorUpdated? onPinnedMessageUpdated? onPollDeleted? onPollUpdated? onPollVoted? onReactionUpdated? onThreadInfoUpdated? onTypingStatusUpdated? onUndeliveredMemberStatusUpdated? onUnreadMemberStatusUpdated? onUserBanned? onUserDeclinedInvitation? onUserJoined? onUserLeft? onUserMarkedRead? onUserMarkedUnread? onUserMuted? onUserReceivedInvitation? onUserUnbanned? onUserUnmuted?

Constructors

constructor

Properties

OptionalonChannelChanged

onChannelChanged?: ((channel: BaseChannel) => void) = noop

A callback for when channel property is changed.

OptionalonChannelDeleted

onChannelDeleted?: ((channelUrl: string, channelType: ChannelType) => void) = noop

A callback for when channel is deleted.

OptionalonChannelFrozen

onChannelFrozen?: ((channel: BaseChannel) => void) = noop

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

OptionalonChannelHidden

onChannelHidden?: ((channel: GroupChannel) => void) = noop

A callback for when GroupChannel is hidden.

OptionalonChannelMemberCountChanged

onChannelMemberCountChanged?: ((channels: BaseChannel[]) => void) = noop

OptionalonChannelUnfrozen

onChannelUnfrozen?: ((channel: BaseChannel) => void) = noop

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

OptionalonMentionReceived

onMentionReceived?: ((channel: BaseChannel, message: BaseMessage) => void) = noop

A callback for when a mention is received.

OptionalonMessageDeleted

onMessageDeleted?: ((channel: BaseChannel, messageId: number) => void) = noop

A callback for when a message is deleted.

OptionalonMessageReceived

onMessageReceived?: ((channel: BaseChannel, message: BaseMessage) => void) = noop

A callback for when a message is received.

OptionalonMessageUpdated

onMessageUpdated?: ((channel: BaseChannel, message: BaseMessage) => void) = noop

A callback for when a message is updated.

OptionalonMetaCounterCreated

onMetaCounterCreated?: ((channel: BaseChannel, metaCounter: MetaCounter) => void) = noop

A callback for when channel meta counters is created.

OptionalonMetaCounterDeleted

onMetaCounterDeleted?: ((channel: BaseChannel, metaCounterKeys: string[]) => void) = noop

A callback for when channel meta counters are deleted.

OptionalonMetaCounterUpdated

onMetaCounterUpdated?: ((channel: BaseChannel, metaCounter: MetaCounter) => void) = noop

A callback for when channel meta counters is updated.

OptionalonMetaDataCreated

onMetaDataCreated?: ((channel: BaseChannel, metaData: MetaData) => void) = noop

A callback for when channel meta data is created.

OptionalonMetaDataDeleted

onMetaDataDeleted?: ((channel: BaseChannel, metaDataKeys: string[]) => void) = noop

A callback for when channel meta data is deleted.

OptionalonMetaDataUpdated

onMetaDataUpdated?: ((channel: BaseChannel, metaData: MetaData) => void) = noop

A callback for when channel meta data is updated.

OptionalonOperatorUpdated

onOperatorUpdated?: ((channel: BaseChannel, users: User[]) => void) = noop

A callback for when operators change in channel.

OptionalonPinnedMessageUpdated

onPinnedMessageUpdated?: ((channel: GroupChannel) => void) = noop

A callback for when pinned message is changed.

OptionalonPollDeleted

onPollDeleted?: ((channel: GroupChannel, id: number) => void) = noop

Called when a poll is deleted.

OptionalonPollUpdated

onPollUpdated?: ((channel: GroupChannel, event: PollUpdateEvent) => void) = noop

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.

OptionalonPollVoted

onPollVoted?: ((channel: GroupChannel, event: PollVoteEvent) => void) = noop

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.

OptionalonReactionUpdated

onReactionUpdated?: ((channel: BaseChannel, reactionEvent: ReactionEvent) => void) = noop

A callback for when a reactionEvent is updated.

OptionalonThreadInfoUpdated

onThreadInfoUpdated?: ((channel: BaseChannel, threadInfoUpdateEvent: ThreadInfoUpdateEvent) => void) = noop

A callback for when the thread information is updated.

OptionalonTypingStatusUpdated

onTypingStatusUpdated?: ((channel: GroupChannel) => void) = noop

A callback for when Users send typing status for GroupChannel. To use the typing status, refer to groupChannel.isTyping and groupChannel.typingUsers.

OptionalonUndeliveredMemberStatusUpdated

onUndeliveredMemberStatusUpdated?: ((channel: GroupChannel) => void) = noop

A callback for when delivered receipts are updated on GroupChannel. To use the updated delivered receipt, refer to groupChannel.getUndeliveredMemberCount

OptionalonUnreadMemberStatusUpdated

onUnreadMemberStatusUpdated?: ((channel: GroupChannel) => void) = noop

Deprecated

since v4.18.2 Please use onUserMarkedRead instead. A callback for when read receipts are updated on GroupChannel. To use the updated read receipt, refer to GroupChannel.getReadStatus, GroupChannel.getReadMembers, GroupChannel.getUnreadMembers.

OptionalonUserBanned

onUserBanned?: ((channel: BaseChannel, user: RestrictedUser) => void) = noop

A callback for when user is banned from channel.

OptionalonUserDeclinedInvitation

onUserDeclinedInvitation?: ((channel: GroupChannel, inviter: User, invitee: User) => void) = noop

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

OptionalonUserJoined

onUserJoined?: ((channel: GroupChannel, user: User) => void) = noop

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

OptionalonUserLeft

onUserLeft?: ((channel: GroupChannel, user: User) => void) = noop

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.

OptionalonUserMarkedRead

onUserMarkedRead?: ((channel: GroupChannel, userIds: string[]) => void) = noop

A callback for when a user marks a message as read.

OptionalonUserMarkedUnread

onUserMarkedUnread?: ((channel: GroupChannel, userIds: string[]) => void) = noop

A callback for when a user marks a message as unread.

OptionalonUserMuted

onUserMuted?: ((channel: BaseChannel, user: RestrictedUser) => void) = noop

A callback for when a User is muted from channel.

OptionalonUserReceivedInvitation

onUserReceivedInvitation?: ((channel: GroupChannel, inviter: null | User, invitees: User[]) => void) = noop

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.

OptionalonUserUnbanned

onUserUnbanned?: ((channel: BaseChannel, user: User) => void) = noop

A callback for when user is unbanned from channel.

OptionalonUserUnmuted

onUserUnmuted?: ((channel: BaseChannel, user: User) => void) = noop

A callback for when User is unmuted from channel.

Settings

Member Visibility

On This Page

Constructors
Properties