ClassBaseChannel

channelType

coverUrl

creator

customType

data

isEphemeral

isFrozen

pinnedMessageIds

cachedMetaData

• get cachedMetaData(): object

• All locally cached metadata as a map.

  Returns object

createdAt

• get createdAt(): number

• The creation time of the channel in milliseconds.

  Returns number

messageCollectionLastAccessedAt

• get messageCollectionLastAccessedAt(): number

• The local timestamp of when this channel has been used in a MessageCollection.

  Returns number

name

• get name(): string

• The topic or name of the channel.

  Returns string
• set name(value): void

• Parameters

  • value: string

  Returns void

url

• get url(): string

• The unique channel URL.

  Returns string

addMessageMetaArrayValues

• addMessageMetaArrayValues(message, metaArrays): Promise<BaseMessage>

• Parameters

  • message: BaseMessage
  • metaArrays: MessageMetaArray[]

  Returns Promise<BaseMessage>

  Description

  Adds message meta array values.

addOperators

• addOperators(userIds): Promise<void>

• Parameters

  • userIds: string[]

  Returns Promise<void>

  Description

  Add operators to the channel.

addPollOption

• addPollOption(pollId, optionText): Promise<Poll>

• Parameters

  • pollId: number
  • optionText: string

  Returns Promise<Poll>

  Description

  Adds an option with optionText to this poll. Once added successfully, a non-null Poll instance will be passed to the result.

addReaction

• addReaction(message, key): Promise<ReactionEvent>

• Parameters

  • message: BaseMessage
  • key: string

  Returns Promise<ReactionEvent>

  Description

  Adds Reaction.

banUser

• banUser(user, duration?, description?): Promise<void>

• Parameters

  • user: User
  • Optionalduration: number
  • Optionaldescription: string

  Returns Promise<void>

  Description

  Bans a member. Operators can ban members from this channel. Banned member is kicked out of this channel and cannot enter during the specified seconds. If you want to ban the user indefinitely, pass -1 to seconds as the argument.

banUserWithUserId

• banUserWithUserId(userId, duration?, description?): Promise<void>

• Parameters

  • userId: string
  • Optionalduration: number
  • Optionaldescription: string

  Returns Promise<void>

  Description

  Bans a member with userId.

cancelUploadingFileMessage

• cancelUploadingFileMessage(requestId): Promise<boolean>

• Parameters

  • requestId: string

  Returns Promise<boolean>

  Description

  Cancels an ongoing FileMessage upload.

closePoll

• closePoll(pollId): Promise<Poll>

• Parameters

  • pollId: number

  Returns Promise<Poll>

  Description

  Closes this poll. Once closed successfully, a non-null Poll instance will be passed to the result.

copyFileMessage

• copyFileMessage(targetChannel, message): Promise<FileMessage>

• Parameters

  • targetChannel: BaseChannel
  • message: FileMessage

  Returns Promise<FileMessage>

  Deprecated

  since v4.9.8. Use copyMessage() instead.

  Description

  Copies a file message from this channel to the target channel.

copyMessage

• copyMessage(channel, message): MessageRequestHandler<FileMessage>

• Parameters

  • channel: BaseChannel
  • message: FileMessage

  Returns MessageRequestHandler<FileMessage>

  Description

  Copies a message from this channel to the target channel.

• copyMessage(channel, message): MessageRequestHandler<UserMessage>

• Parameters

  • channel: BaseChannel
  • message: UserMessage

  Returns MessageRequestHandler<UserMessage>

  Description

  Copies a message from this channel to the target channel.

copyUserMessage

• copyUserMessage(targetChannel, message): Promise<UserMessage>

• Parameters

  • targetChannel: BaseChannel
  • message: UserMessage

  Returns Promise<UserMessage>

  Deprecated

  since v4.9.8. Use copyMessage() instead.

  Description

  Copies a user message from this channel to the target channel.

createBannedUserListQuery

• createBannedUserListQuery(params?): BannedUserListQuery

• Parameters

  • params: BannedUserListQueryParams = {}

  Returns BannedUserListQuery

  Description

  Creates a query instance to get the banned user list from this channel.

createMessageMetaArrayKeys

• createMessageMetaArrayKeys(message, keys): Promise<BaseMessage>

• Parameters

  • message: BaseMessage
  • keys: string[]

  Returns Promise<BaseMessage>

  Description

  Creates message meta array keys.

createMetaCounters

• createMetaCounters(data): Promise<MetaCounter>

• Parameters

  • data: MetaCounter

  Returns Promise<MetaCounter>

  Description

  Creates meta counters. This can be used to customize the channel.

createMetaData

• createMetaData(data): Promise<MetaData>

• Parameters

  • data: MetaData

  Returns Promise<MetaData>

  Description

  Creates meta data. This can be used to customize the channel.

createMutedUserListQuery

• createMutedUserListQuery(params?): MutedUserListQuery

• Parameters

  • params: MutedUserListQueryParams = {}

  Returns MutedUserListQuery

  Description

  Creates a query instance to get the muted user (online and offline both) list of this channel.

createOperatorListQuery

• createOperatorListQuery(params?): OperatorListQuery

• Parameters

  • params: OperatorListQueryParams = {}

  Returns OperatorListQuery

  Description

  Creates a query instance to get the operator list from this channel.

createPinnedMessageListQuery

• createPinnedMessageListQuery(params?): PinnedMessageListQuery

• Parameters

  • params: PinnedMessageListQueryParams = {}

  Returns PinnedMessageListQuery

  Description

  Creates a query instance to get pinned messages.

createPollListQuery

• createPollListQuery(limit?): PollListQuery

• Parameters

  • limit: number = DEFAULT_POLLS_LIMIT

  Returns PollListQuery

  Description

  Creates a query instance to get the poll list from this channel.

createPollVoterListQuery

• createPollVoterListQuery(pollId, pollOptionId, limit?): PollVoterListQuery

• Parameters

  • pollId: number
  • pollOptionId: number
  • limit: number = DEFAULT_POLL_VOTER_LIST_LIMIT

  Returns PollVoterListQuery

  Description

  Creates a query instance to get the voters of a poll option.

createPreviousMessageListQuery

• createPreviousMessageListQuery(params?): PreviousMessageListQuery

• Parameters

  • params: PreviousMessageListQueryParams = {}

  Returns PreviousMessageListQuery

  Description

  Creates previous message list query for this channel.

decreaseMetaCounters

• decreaseMetaCounters(data): Promise<MetaCounter>

• Parameters

  • data: MetaCounter

  Returns Promise<MetaCounter>

  Description

  Decreases meta counters. This decreases atomically the keyed meta counter by the specified value.

deleteAllMetaCounters

• deleteAllMetaCounters(): Promise<void>

• Returns Promise<void>

  Description

  Deletes all meta counters.

deleteAllMetaData

• deleteAllMetaData(): Promise<void>

• Returns Promise<void>

  Description

  Deletes all meta data.

deleteMessage

• deleteMessage(message): Promise<void>

• Parameters

  • message: BaseMessage

  Returns Promise<void>

  Description

  Deletes a message.

deleteMessageMetaArrayKeys

• deleteMessageMetaArrayKeys(message, keys): Promise<BaseMessage>

• Parameters

  • message: BaseMessage
  • keys: string[]

  Returns Promise<BaseMessage>

  Description

  Deletes message meta array keys.

deleteMetaCounter

• deleteMetaCounter(key): Promise<void>

• Parameters

  • key: string

  Returns Promise<void>

  Description

  Deletes a meta counter.

deleteMetaData

• deleteMetaData(key): Promise<void>

• Parameters

  • key: string

  Returns Promise<void>

  Description

  Deletes a meta data.

deletePoll

• deletePoll(pollId): Promise<void>

• Parameters

  • pollId: number

  Returns Promise<void>

  Description

  Deletes this poll. Once deleted successfully, null will be passed to the result.

deletePollOption

• deletePollOption(pollId, pollOptionId): Promise<void>

• Parameters

  • pollId: number
  • pollOptionId: number

  Returns Promise<void>

  Description

  Deletes this poll option.

deleteReaction

• deleteReaction(message, key): Promise<ReactionEvent>

• Parameters

  • message: BaseMessage
  • key: string

  Returns Promise<ReactionEvent>

  Description

  Deletes Reaction.

freeze

• freeze(): Promise<void>

• Returns Promise<void>

  Description

  Freezes the channel. No one could send a message in a frozen channel.

getAllMetaCounters

• getAllMetaCounters(): Promise<MetaCounter>

• Returns Promise<MetaCounter>

  Description

  Get all meta counters.

getAllMetaData

• getAllMetaData(): Promise<MetaData>

• Returns Promise<MetaData>

  Description

  Gets all meta data.

getMessageChangeLogsSinceTimestamp

• getMessageChangeLogsSinceTimestamp(ts, params?): Promise<MessageChangelogs>

• Parameters

  • ts: number
  • params: MessageChangeLogsParams = {}

  Returns Promise<MessageChangelogs>

  Description

  Requests message change logs after given timestamp.

getMessageChangeLogsSinceToken

• getMessageChangeLogsSinceToken(token, params?): Promise<MessageChangelogs>

• Parameters

  • token: string
  • params: MessageChangeLogsParams = {}

  Returns Promise<MessageChangelogs>

  Description

  Requests message change logs after given token.

getMessagesByMessageId

• getMessagesByMessageId(messageId, params): Promise<BaseMessage[]>

• Parameters

  • messageId: number
  • params: MessageListParams

  Returns Promise<BaseMessage[]>

  Description

  Retrieves previous or next messages based on the message ID in a specific channel.

getMessagesByTimestamp

• getMessagesByTimestamp(ts, params): Promise<BaseMessage[]>

• Parameters

  • ts: number
  • params: MessageListParams

  Returns Promise<BaseMessage[]>

  Description

  Retrieves previous or next messages based on the timestamp in a specific channel.

getMetaCounters

• getMetaCounters(keys): Promise<MetaCounter>

• Parameters

  • keys: string[]

  Returns Promise<MetaCounter>

  Description

  Gets meta counters.

getMetaData

• getMetaData(keys): Promise<MetaData>

• Parameters

  • keys: string[]

  Returns Promise<MetaData>

  Description

  Gets meta data.

getMyMutedInfo

• getMyMutedInfo(): Promise<MutedInfo>

• Returns Promise<MutedInfo>

  Description

  Gets my muted information in this channel.

getPollChangeLogsSinceTimestamp

• getPollChangeLogsSinceTimestamp(ts): Promise<PollChangelogs>

• Parameters

  • ts: number

  Returns Promise<PollChangelogs>

  Description

  Requests poll change logs after given timestamp.

getPollChangeLogsSinceToken

• getPollChangeLogsSinceToken(token): Promise<PollChangelogs>

• Parameters

  • token: null | string

  Returns Promise<PollChangelogs>

  Description

  Requests poll change logs after given token.

increaseMetaCounters

• increaseMetaCounters(data): Promise<MetaCounter>

• Parameters

  • data: MetaCounter

  Returns Promise<MetaCounter>

  Description

  Increases meta counters. This increases atomically the keyed meta counter by the specified value.

isEqual

• isEqual(channel): boolean

• Parameters

  • channel: BaseChannel

  Returns boolean

  Description

  Whether the given channel is equal in all the values of this channel.

isFeedChannel

• isFeedChannel(): this is FeedChannel

• Returns this is FeedChannel

  Description

  Whether the instance is FeedChannel type.

isGroupChannel

• isGroupChannel(): this is GroupChannel

• Returns this is GroupChannel

  Description

  Whether the instance is GroupChannel type.

isIdentical

• isIdentical(channel): boolean

• Parameters

  • channel: BaseChannel

  Returns boolean

  Description

  Whether the given channel is identical to this channel.

isOpenChannel

• isOpenChannel(): this is OpenChannel

• Returns this is OpenChannel

  Description

  Whether the instance is OpenChannel type.

muteUser

• muteUser(user, duration?, description?): Promise<void>

• Parameters

  • user: User
  • Optionalduration: number
  • Optionaldescription: string

  Returns Promise<void>

  Description

  Mutes a User. A muted user cannot send a message.

muteUserWithUserId

• muteUserWithUserId(userId, duration?, description?): Promise<void>

• Parameters

  • userId: string
  • Optionalduration: number
  • Optionaldescription: string

  Returns Promise<void>

  Description

  Mutes a User with userId. A muted user cannot send a message.

pinMessage

• pinMessage(messageId): Promise<void>

• Parameters

  • messageId: number

  Returns Promise<void>

  Description

  Pins a message to the channel.

removeMessageMetaArrayValues

• removeMessageMetaArrayValues(message, metaArrays): Promise<BaseMessage>

• Parameters

  • message: BaseMessage
  • metaArrays: MessageMetaArray[]

  Returns Promise<BaseMessage>

  Description

  Removes message meta array values.

removeOperators

• removeOperators(userIds): Promise<void>

• Parameters

  • userIds: string[]

  Returns Promise<void>

  Description

  Remove operators from the channel.

report

• report(category, description): Promise<void>

• Parameters

  • category: ReportCategory
  • description: string

  Returns Promise<void>

  Description

  Reports this channel of inappropriate activities.

reportMessage

• reportMessage(message, category, description): Promise<void>

• Parameters

  • message: UserMessage | FileMessage | MultipleFilesMessage

    [UserMessage], [FileMessage] or [MultipleMessage]
  • category: ReportCategory
  • description: string

  Returns Promise<void>

  Description

  Reports a malicious message.

reportUser

• reportUser(user, category, description): Promise<void>

• Parameters

  • user: User
  • category: ReportCategory
  • description: string

  Returns Promise<void>

  Description

  Reports a user of suspicious activities.

resendFileMessage

• resendFileMessage(failedMessage, file?): Promise<FileMessage>

• Parameters

  • failedMessage: FileMessage
  • Optionalfile: FileCompat

  Returns Promise<FileMessage>

  Deprecated

  since v4.9.8. Use resendMessage() instead.

  Description

  Resends a file with given file information.

resendMessage

• resendMessage(failedMessage, file?): MessageRequestHandler<FileMessage>

• Parameters

  • failedMessage: FileMessage
  • Optionalfile: FileCompat

  Returns MessageRequestHandler<FileMessage>

  Description

  Resends a failed message.

• resendMessage(failedMessage): MessageRequestHandler<UserMessage>

• Parameters

  • failedMessage: UserMessage

  Returns MessageRequestHandler<UserMessage>

  Description

  Resends a failed message.

resendUserMessage

• resendUserMessage(failedMessage): Promise<UserMessage>

• Parameters

  • failedMessage: UserMessage

  Returns Promise<UserMessage>

  Deprecated

  since v4.9.8. Use resendMessage() instead.

  Description

  Resends a failed user message.

sendFileMessage

• sendFileMessage(params): MessageRequestHandler<SendableMessage>

• Parameters

  • params: FileMessageCreateParams

  Returns MessageRequestHandler<SendableMessage>

  Description

  Sends a file with given file information.

sendFileMessages

• sendFileMessages(paramsList): MessageRequestHandler<SendableMessage>

• Parameters

  • paramsList: FileMessageCreateParams[]

  Returns MessageRequestHandler<SendableMessage>

  Description

  Sends files with given files information. The maximum number of files is 20. This method handles FileMessageCreateParams only which have set binary file not URL.

sendMultipleFilesMessage

• sendMultipleFilesMessage(params): MultipleFilesMessageRequestHandler<SendableMessage>

• Parameters

  • params: MultipleFilesMessageCreateParams

  Returns MultipleFilesMessageRequestHandler<SendableMessage>

  Description

  Sends a multiple files or file URLs as a single MultipleFilesMessage.

sendUserMessage

• sendUserMessage(params): MessageRequestHandler<SendableMessage>

• Parameters

  • params: UserMessageCreateParams

  Returns MessageRequestHandler<SendableMessage>

  Description

  Sends a user message.

translateUserMessage

• translateUserMessage(targetMessage, languages): Promise<UserMessage>

• Parameters

  • targetMessage: UserMessage
  • languages: string[]

  Returns Promise<UserMessage>

  Description

  Translates a user message.

unbanUser

• unbanUser(user): Promise<void>

• Parameters

  • user: User

  Returns Promise<void>

  Description

  Unbans User. Operators can unban User who has been banned from this channel.

unbanUserWithUserId

• unbanUserWithUserId(userId): Promise<void>

• Parameters

  • userId: string

  Returns Promise<void>

  Description

  Unbans User with userId.

unfreeze

• unfreeze(): Promise<void>

• Returns Promise<void>

  Description

  Unfreezes the channel.

unmuteUser

• unmuteUser(user): Promise<void>

• Parameters

  • user: User

  Returns Promise<void>

  Description

  Unmutes User. The unmuted user could send a message again.

unmuteUserWithUserId

• unmuteUserWithUserId(userId): Promise<void>

• Parameters

  • userId: string

  Returns Promise<void>

  Description

  Unmutes User with userId. The unmuted user could send a message again.

unpinMessage

• unpinMessage(messageId): Promise<void>

• Parameters

  • messageId: number

  Returns Promise<void>

  Description

  Removes the message from the channel's pinned messages.

updateFileMessage

• updateFileMessage(messageId, params): Promise<FileMessage>

• Parameters

  • messageId: number
  • params: FileMessageUpdateParams

  Returns Promise<FileMessage>

  Description

  Updates a FileMessage that was previously sent in the channel. Note that the file itself cannot be changed; only the fields stored within the message can be modified.

updateMetaCounters

• updateMetaCounters(data, upsert?): Promise<MetaCounter>

• Parameters

  • data: MetaCounter
  • upsert: boolean = false

  Returns Promise<MetaCounter>

  Description

  Updates meta counters.

updateMetaData

• updateMetaData(data, upsert?): Promise<MetaData>

• Parameters

  • data: MetaData
  • upsert: boolean = false

  Returns Promise<MetaData>

  Description

  Updates meta data.

updatePoll

• updatePoll(pollId, params): Promise<Poll>

• Parameters

  • pollId: number
  • params: PollUpdateParams

  Returns Promise<Poll>

  Description

  Updates fields of this poll with given params. Once updated successfully, a non-null Poll instance will be passed to the result.

updatePollOption

• updatePollOption(pollId, pollOptionId, optionText): Promise<Poll>

• Parameters

  • pollId: number
  • pollOptionId: number
  • optionText: string

  Returns Promise<Poll>

  Description

  Updates optionText fields of this poll option. Once updated successfully, a non-null Poll instance will be passed to the result.

updateUserMessage

• updateUserMessage(messageId, params): Promise<UserMessage>

• Parameters

  • messageId: number
  • params: UserMessageUpdateParams

  Returns Promise<UserMessage>

  Description

  Updates a UserMessage that was previously sent in the channel.

uploadFile

• uploadFile(params): Promise<FileUploadResult>

• Parameters

  • params: FileUploadParams

  Returns Promise<FileUploadResult>

  Description

  Uploads a file and gets the URL and thumbnails. It takes progressHandler as a parameter to keep track of upload progress.

votePoll

• votePoll(pollId, pollOptionIds): Promise<PollVoteEvent>

• Parameters

  • pollId: number
  • pollOptionIds: number[]

  Returns Promise<PollVoteEvent>

  Description

  Vote on pollOptionIds. This operation overrides previous vote actions, so to update previous vote, pass new pollOptionIds as parameter. To cancel votes, pass an empty list as pollOptionIds.