Hierarchy

  • GroupChannelHandlerParams
    • GroupChannelHandler

Constructors

Properties

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

Type declaration

    • (channel): void
    • A callback for when channel property is changed.

      Parameters

      Returns void

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

Type declaration

    • (channelUrl, channelType): void
    • A callback for when channel is deleted.

      Parameters

      Returns void

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

Type declaration

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

      Parameters

      Returns void

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

Type declaration

    • (channel): void
    • A callback for when GroupChannel is hidden.

      Parameters

      Returns void

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

Type declaration

    • (channels): void
    • Parameters

      Returns void

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

Type declaration

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

      Parameters

      Returns void

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

Type declaration

    • (channel, message): void
    • A callback for when a mention is received.

      Parameters

      Returns void

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

Type declaration

    • (channel, messageId): void
    • A callback for when a message is deleted.

      Parameters

      Returns void

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

Type declaration

    • (channel, message): void
    • A callback for when a message is received.

      Parameters

      Returns void

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

Type declaration

    • (channel, message): void
    • A callback for when a message is updated.

      Parameters

      Returns void

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

Type declaration

    • (channel, metaCounter): void
    • A callback for when channel meta counters is created.

      Parameters

      Returns void

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

Type declaration

    • (channel, metaCounterKeys): void
    • A callback for when channel meta counters are deleted.

      Parameters

      Returns void

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

Type declaration

    • (channel, metaCounter): void
    • A callback for when channel meta counters is updated.

      Parameters

      Returns void

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

Type declaration

    • (channel, metaData): void
    • A callback for when channel meta data is created.

      Parameters

      Returns void

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

Type declaration

    • (channel, metaDataKeys): void
    • A callback for when channel meta data is deleted.

      Parameters

      Returns void

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

Type declaration

    • (channel, metaData): void
    • A callback for when channel meta data is updated.

      Parameters

      Returns void

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

Type declaration

    • (channel, users): void
    • A callback for when operators change in channel.

      Parameters

      Returns void

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

Type declaration

    • (channel): void
    • A callback for when pinned message is changed.

      Parameters

      Returns void

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

Type declaration

    • (channel, id): void
    • Called when a poll is deleted.

      Parameters

      Returns void

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

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

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

Type declaration

    • (channel, reactionEvent): void
    • A callback for when a reactionEvent is updated.

      Parameters

      Returns void

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

Type declaration

    • (channel, threadInfoUpdateEvent): void
    • A callback for when the thread information is updated.

      Parameters

      Returns void

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

Type declaration

    • (channel): void
    • A callback for when Users send typing status for GroupChannel. To use the typing status, refer to groupChannel.isTyping and groupChannel.typingUsers.

      Parameters

      Returns void

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

Type declaration

    • (channel): void
    • A callback for when delivered receipts are updated on GroupChannel. To use the updated delivered receipt, refer to groupChannel.getUndeliveredMemberCount

      Parameters

      Returns void

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

Type declaration

    • (channel): void
    • A callback for when read receipts are updated on GroupChannel. To use the updated read receipt, refer to GroupChannel.getReadStatus, GroupChannel.getReadMembers, GroupChannel.getUnreadMembers.

      Parameters

      Returns void

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

Type declaration

    • (channel, user): void
    • A callback for when user is banned from channel.

      Parameters

      Returns void

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

Type declaration

    • (channel, inviter, invitee): void
    • A callback for when the newly invited member has declined the invitation for the GroupChannel.

      Parameters

      Returns void

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

Type declaration

    • (channel, user): void
    • A callback for when a new member has joined GroupChannel. To use the updated member list, refer to GroupChannel.members and GroupChannel.memberCount.

      Parameters

      Returns void

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

Type declaration

    • (channel, user): void
    • 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.

      Parameters

      Returns void

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

Type declaration

    • (channel, user): void
    • A callback for when a User is muted from channel.

      Parameters

      Returns void

onUserReceivedInvitation?: ((channel, inviter, invitees) => void) = noop

Type declaration

    • (channel, inviter, invitees): void
    • 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.

      Parameters

      Returns void

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

Type declaration

    • (channel, user): void
    • A callback for when user is unbanned from channel.

      Parameters

      Returns void

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

Type declaration

    • (channel, user): void
    • A callback for when User is unmuted from channel.

      Parameters

      Returns void

Generated using TypeDoc