Class BaseChannel

channelType

coverUrl

creator

customType

data

isEphemeral

isFrozen

cachedMetaData

• get cachedMetaData(): object

• Returns object

createdAt

• get createdAt(): number

• Returns number

messageCollectionLastAccessedAt

• get messageCollectionLastAccessedAt(): number

• Returns number

name

• get name(): string

• Returns string

• set name(value): void

• Parameters

  • value: string

  Returns void

url

• get url(): string

• Returns string

addMessageMetaArrayValues

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

• Parameters

  • message: BaseMessage

  • metaArrays: MessageMetaArray[]

  Returns Promise<BaseMessage>

addOperators

• addOperators(userIds): Promise<void>

• Parameters

  • userIds: string[]

  Returns Promise<void>

addPollOption

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

• Parameters

  • pollId: number

  • optionText: string

  Returns Promise<Poll>

addReaction

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

• Parameters

  • message: BaseMessage

  • key: string

  Returns Promise<ReactionEvent>

banUser

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

• Parameters

  • user: User

  • Optional duration: number

  • Optional description: string

  Returns Promise<void>

banUserWithUserId

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

• Parameters

  • userId: string

  • Optional duration: number

  • Optional description: string

  Returns Promise<void>

cancelUploadingFileMessage

• cancelUploadingFileMessage(requestId): Promise<boolean>

• Parameters

  • requestId: string

  Returns Promise<boolean>

closePoll

• closePoll(pollId): Promise<Poll>

• Parameters

  • pollId: number

  Returns Promise<Poll>

copyFileMessage

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

• Parameters

  • targetChannel: BaseChannel

  • message: FileMessage

  Returns Promise<FileMessage>

  Deprecated

  since v4.9.8. Use copyMessage() instead.

copyMessage

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

• Parameters

  • channel: BaseChannel

  • message: FileMessage

  Returns MessageRequestHandler<FileMessage>

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

• Parameters

  • channel: BaseChannel

  • message: UserMessage

  Returns MessageRequestHandler<UserMessage>

copyUserMessage

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

• Parameters

  • targetChannel: BaseChannel

  • message: UserMessage

  Returns Promise<UserMessage>

  Deprecated

  since v4.9.8. Use copyMessage() instead.

createBannedUserListQuery

• createBannedUserListQuery(params?): BannedUserListQuery

• Parameters

  • params: BannedUserListQueryParams = {}

  Returns BannedUserListQuery

createMessageMetaArrayKeys

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

• Parameters

  • message: BaseMessage

  • keys: string[]

  Returns Promise<BaseMessage>

createMetaCounters

• createMetaCounters(data): Promise<MetaCounter>

• Parameters

  • data: MetaCounter

  Returns Promise<MetaCounter>

createMetaData

• createMetaData(data): Promise<MetaData>

• Parameters

  • data: MetaData

  Returns Promise<MetaData>

createMutedUserListQuery

• createMutedUserListQuery(params?): MutedUserListQuery

• Parameters

  • params: MutedUserListQueryParams = {}

  Returns MutedUserListQuery

createOperatorListQuery

• createOperatorListQuery(params?): OperatorListQuery

• Parameters

  • params: OperatorListQueryParams = {}

  Returns OperatorListQuery

createPollListQuery

• createPollListQuery(limit?): PollListQuery

• Parameters

  • limit: number = DEFAULT_POLLS_LIMIT

  Returns PollListQuery

createPollVoterListQuery

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

• Parameters

  • pollId: number

  • pollOptionId: number

  • limit: number = DEFAULT_POLL_VOTER_LIST_LIMIT

  Returns PollVoterListQuery

createPreviousMessageListQuery

• createPreviousMessageListQuery(params?): PreviousMessageListQuery

• Parameters

  • params: PreviousMessageListQueryParams = {}

  Returns PreviousMessageListQuery

decreaseMetaCounters

• decreaseMetaCounters(data): Promise<MetaCounter>

• Parameters

  • data: MetaCounter

  Returns Promise<MetaCounter>

deleteAllMetaCounters

• deleteAllMetaCounters(): Promise<void>

• Returns Promise<void>

deleteAllMetaData

• deleteAllMetaData(): Promise<void>

• Returns Promise<void>

deleteMessage

• deleteMessage(message): Promise<void>

• Parameters

  • message: BaseMessage

  Returns Promise<void>

deleteMessageMetaArrayKeys

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

• Parameters

  • message: BaseMessage

  • keys: string[]

  Returns Promise<BaseMessage>

deleteMetaCounter

• deleteMetaCounter(key): Promise<void>

• Parameters

  • key: string

  Returns Promise<void>

deleteMetaData

• deleteMetaData(key): Promise<void>

• Parameters

  • key: string

  Returns Promise<void>

deletePoll

• deletePoll(pollId): Promise<void>

• Parameters

  • pollId: number

  Returns Promise<void>

deletePollOption

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

• Parameters

  • pollId: number

  • pollOptionId: number

  Returns Promise<void>

deleteReaction

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

• Parameters

  • message: BaseMessage

  • key: string

  Returns Promise<ReactionEvent>

freeze

• freeze(): Promise<void>

• Returns Promise<void>

getAllMetaCounters

• getAllMetaCounters(): Promise<MetaCounter>

• Returns Promise<MetaCounter>

getAllMetaData

• getAllMetaData(): Promise<MetaData>

• Returns Promise<MetaData>

getMessageChangeLogsSinceTimestamp

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

• Parameters

  • ts: number

  • params: MessageChangeLogsParams = {}

  Returns Promise<MessageChangelogs>

getMessageChangeLogsSinceToken

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

• Parameters

  • token: string

  • params: MessageChangeLogsParams = {}

  Returns Promise<MessageChangelogs>

getMessagesByMessageId

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

• Parameters

  • messageId: number

  • params: MessageListParams

  Returns Promise<BaseMessage[]>

getMessagesByTimestamp

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

• Parameters

  • ts: number

  • params: MessageListParams

  Returns Promise<BaseMessage[]>

getMetaCounters

• getMetaCounters(keys): Promise<MetaCounter>

• Parameters

  • keys: string[]

  Returns Promise<MetaCounter>

getMetaData

• getMetaData(keys): Promise<MetaData>

• Parameters

  • keys: string[]

  Returns Promise<MetaData>

getMyMutedInfo

• getMyMutedInfo(): Promise<MutedInfo>

• Returns Promise<MutedInfo>

getPollChangeLogsSinceTimestamp

• getPollChangeLogsSinceTimestamp(ts): Promise<PollChangelogs>

• Parameters

  • ts: number

  Returns Promise<PollChangelogs>

getPollChangeLogsSinceToken

• getPollChangeLogsSinceToken(token): Promise<PollChangelogs>

• Parameters

  • token: null | string

  Returns Promise<PollChangelogs>

increaseMetaCounters

• increaseMetaCounters(data): Promise<MetaCounter>

• Parameters

  • data: MetaCounter

  Returns Promise<MetaCounter>

isEqual

• isEqual(channel): boolean

• Parameters

  • channel: BaseChannel

  Returns boolean

isFeedChannel

• isFeedChannel(): this is FeedChannel

• Returns this is FeedChannel

isGroupChannel

• isGroupChannel(): this is GroupChannel

• Returns this is GroupChannel

isIdentical

• isIdentical(channel): boolean

• Parameters

  • channel: BaseChannel

  Returns boolean

isOpenChannel

• isOpenChannel(): this is OpenChannel

• Returns this is OpenChannel

muteUser

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

• Parameters

  • user: User

  • Optional duration: number

  • Optional description: string

  Returns Promise<void>

muteUserWithUserId

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

• Parameters

  • userId: string

  • Optional duration: number

  • Optional description: string

  Returns Promise<void>

removeMessageMetaArrayValues

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

• Parameters

  • message: BaseMessage

  • metaArrays: MessageMetaArray[]

  Returns Promise<BaseMessage>

removeOperators

• removeOperators(userIds): Promise<void>

• Parameters

  • userIds: string[]

  Returns Promise<void>

report

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

• Parameters

  • category: ReportCategory

  • description: string

  Returns Promise<void>

reportMessage

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

• Parameters

  • message: default

  • category: ReportCategory

  • description: string

  Returns Promise<void>

reportUser

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

• Parameters

  • user: User

  • category: ReportCategory

  • description: string

  Returns Promise<void>

resendFileMessage

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

• Parameters

  • failedMessage: FileMessage

  • Optional file: FileCompat

  Returns Promise<FileMessage>

  Deprecated

  since v4.9.8. Use resendMessage() instead.

resendMessage

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

• Parameters

  • failedMessage: FileMessage

  • Optional file: FileCompat

  Returns MessageRequestHandler<FileMessage>

• resendMessage(failedMessage): MessageRequestHandler<UserMessage>

• Parameters

  • failedMessage: UserMessage

  Returns MessageRequestHandler<UserMessage>

resendUserMessage

• resendUserMessage(failedMessage): Promise<UserMessage>

• Parameters

  • failedMessage: UserMessage

  Returns Promise<UserMessage>

  Deprecated

  since v4.9.8. Use resendMessage() instead.

sendFileMessage

• sendFileMessage(params): MessageRequestHandler<default>

• Parameters

  • params: FileMessageCreateParams

  Returns MessageRequestHandler<default>

sendFileMessages

• sendFileMessages(paramsList): MessageRequestHandler<default>

• Parameters

  • paramsList: FileMessageCreateParams[]

  Returns MessageRequestHandler<default>

sendUserMessage

• sendUserMessage(params): MessageRequestHandler<default>

• Parameters

  • params: UserMessageCreateParams

  Returns MessageRequestHandler<default>

translateUserMessage

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

• Parameters

  • targetMessage: UserMessage

  • languages: string[]

  Returns Promise<UserMessage>

unbanUser

• unbanUser(user): Promise<void>

• Parameters

  • user: User

  Returns Promise<void>

unbanUserWithUserId

• unbanUserWithUserId(userId): Promise<void>

• Parameters

  • userId: string

  Returns Promise<void>

unfreeze

• unfreeze(): Promise<void>

• Returns Promise<void>

unmuteUser

• unmuteUser(user): Promise<void>

• Parameters

  • user: User

  Returns Promise<void>

unmuteUserWithUserId

• unmuteUserWithUserId(userId): Promise<void>

• Parameters

  • userId: string

  Returns Promise<void>

updateFileMessage

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

• Parameters

  • messageId: number

  • params: FileMessageUpdateParams

  Returns Promise<FileMessage>

updateMetaCounters

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

• Parameters

  • data: MetaCounter

  • upsert: boolean = false

  Returns Promise<MetaCounter>

updateMetaData

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

• Parameters

  • data: MetaData

  • upsert: boolean = false

  Returns Promise<MetaData>

updatePoll

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

• Parameters

  • pollId: number

  • params: PollUpdateParams

  Returns Promise<Poll>

updatePollOption

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

• Parameters

  • pollId: number

  • pollOptionId: number

  • optionText: string

  Returns Promise<Poll>

updateUserMessage

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

• Parameters

  • messageId: number

  • params: UserMessageUpdateParams

  Returns Promise<UserMessage>

votePoll

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

• Parameters

  • pollId: number

  • pollOptionIds: number[]

  Returns Promise<PollVoteEvent>