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? onPollDeleted? onPollUpdated? onPollVoted? onReactionUpdated? onThreadInfoUpdated? onUserBanned? onUserEntered? onUserExited? onUserMuted? onUserUnbanned? onUserUnmuted?

Constructors

constructor

Properties

Optional onChannelChanged

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

Type declaration

    • (channel): void

    • A callback for when channel property is changed.

      Parameters

      Returns void

Optional onChannelDeleted

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

Type declaration

    • (channelUrl, channelType): void

    • A callback for when channel is deleted.

      Parameters

      Returns void

Optional onChannelFrozen

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

Type declaration

    • (channel): void

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

      Parameters

      Returns void

Optional onChannelMemberCountChanged

onChannelMemberCountChanged?: ((channels) => void) = noop

Type declaration

    • (channels): void

    • Parameters

      Returns void

Optional onChannelParticipantCountChanged

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

Type declaration

    • (channel): void

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

      Parameters

      Returns void

Optional onChannelUnfrozen

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

Type declaration

    • (channel): void

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

      Parameters

      Returns void

Optional onMentionReceived

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

Type declaration

    • (channel, message): void

    • A callback for when a mention is received.

      Parameters

      Returns void

Optional onMessageDeleted

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

Type declaration

    • (channel, messageId): void

    • A callback for when a message is deleted.

      Parameters

      Returns void

Optional onMessageReceived

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

Type declaration

    • (channel, message): void

    • A callback for when a message is received.

      Parameters

      Returns void

Optional onMessageUpdated

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

Type declaration

    • (channel, message): void

    • A callback for when a message is updated.

      Parameters

      Returns void

Optional onMetaCounterCreated

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

Type declaration

    • (channel, metaCounter): void

    • A callback for when channel meta counters is created.

      Parameters

      Returns void

Optional onMetaCounterDeleted

onMetaCounterDeleted?: ((channel, metaCounterKeys) => void) = noop

Type declaration

    • (channel, metaCounterKeys): void

    • A callback for when channel meta counters are deleted.

      Parameters

      Returns void

Optional onMetaCounterUpdated

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

Type declaration

    • (channel, metaCounter): void

    • A callback for when channel meta counters is updated.

      Parameters

      Returns void

Optional onMetaDataCreated

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

Type declaration

    • (channel, metaData): void

    • A callback for when channel meta data is created.

      Parameters

      Returns void

Optional onMetaDataDeleted

onMetaDataDeleted?: ((channel, metaDataKeys) => void) = noop

Type declaration

    • (channel, metaDataKeys): void

    • A callback for when channel meta data is deleted.

      Parameters

      Returns void

Optional onMetaDataUpdated

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

Type declaration

    • (channel, metaData): void

    • A callback for when channel meta data is updated.

      Parameters

      Returns void

Optional onOperatorUpdated

onOperatorUpdated?: ((channel, users) => void) = noop

Type declaration

    • (channel, users): void

    • A callback for when operators change in channel.

      Parameters

      Returns void

Optional onPollDeleted

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

Type declaration

    • (channel, id): void

    • Called when a poll is deleted.

      Parameters

      Returns void

Optional onPollUpdated

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

Type declaration

    • (channel, event): void

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

      Parameters

      Returns void

Optional onPollVoted

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

Type declaration

    • (channel, event): void

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

      Parameters

      Returns void

Optional onReactionUpdated

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

Type declaration

    • (channel, reactionEvent): void

    • A callback for when a reactionEvent is updated.

      Parameters

      Returns void

Optional onThreadInfoUpdated

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

Type declaration

    • (channel, threadInfoUpdateEvent): void

    • A callback for when the thread information is updated.

      Parameters

      Returns void

Optional onUserBanned

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

Type declaration

    • (channel, user): void

    • A callback for when user is banned from channel.

      Parameters

      Returns void

Optional onUserEntered

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

Type declaration

    • (channel, user): void

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

      Parameters

      Returns void

Optional onUserExited

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

Type declaration

    • (channel, user): void

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

      Parameters

      Returns void

Optional onUserMuted

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

Type declaration

    • (channel, user): void

    • A callback for when a User is muted from channel.

      Parameters

      Returns void

Optional onUserUnbanned

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

Type declaration

    • (channel, user): void

    • A callback for when user is unbanned from channel.

      Parameters

      Returns void

Optional onUserUnmuted

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

Type declaration

    • (channel, user): void

    • A callback for when User is unmuted from channel.

      Parameters

      Returns void

Settings

Member Visibility

Theme

On This Page

Generated using TypeDoc