Class OpenChannelHandler

Hierarchy

  • OpenChannelHandlerParams
    • OpenChannelHandler

Constructors

constructor

Properties

onChannelChanged? onChannelDeleted? onChannelFrozen? onChannelMemberCountChanged? onChannelParticipantCountChanged? onChannelUnfrozen? onMentionReceived? onMessageDeleted? onMessageReceived? onMessageUpdated? onMetaCounterCreated? onMetaCounterDeleted? onMetaCounterUpdated? onMetaDataCreated? onMetaDataDeleted? onMetaDataUpdated? onOperatorUpdated? onPinnedMessageUpdated? onPollDeleted? onPollUpdated? onPollVoted? onReactionUpdated? onThreadInfoUpdated? onUserBanned? onUserEntered? onUserExited? onUserMuted? 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).

OptionalonChannelMemberCountChanged

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

OptionalonChannelParticipantCountChanged

onChannelParticipantCountChanged?: ((channel: OpenChannel) => void) = noop

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

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: OpenChannel) => void) = noop

A callback for when pinned message is changed.

OptionalonPollDeleted

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

Called when a poll is deleted.

OptionalonPollUpdated

onPollUpdated?: ((channel: OpenChannel, 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: OpenChannel, 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.

OptionalonUserBanned

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

A callback for when user is banned from channel.

OptionalonUserEntered

onUserEntered?: ((channel: OpenChannel, user: User) => void) = noop

A callback for when a User has entered OpenChannel. To use the updated participant count, refer to openChannel.participantCount.

OptionalonUserExited

onUserExited?: ((channel: OpenChannel, user: User) => void) = noop

A callback for when a User has exited OpenChannel. To use the updated participant count, refer to openChannel.participantCount.

OptionalonUserMuted

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

A callback for when a User is muted from channel.

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