ClassOpenChannel

Description

Represents an open channel.

Hierarchy (view full)

BaseChannel
- OpenChannel

Index

Properties

channelType

channelType: ChannelType = ChannelType.BASE

coverUrl

coverUrl: string = ''

The cover image URL.

creator

creator: null | User = null

A User who created the channel. null if it's created by system.

customType

customType: string = ''

The custom type of the channel.

data

data: string = ''

The channel data.

isEphemeral

isEphemeral: boolean = false

Whether the channel is ephemeral.

isFrozen

isFrozen: boolean = false

Whether the channel is frozen.

lastPinnedMessage

lastPinnedMessage: null | BaseMessage = null

The last message among channel's pinned messages.

operators

operators: User[] = []

The operators of the channel.

participantCount

participantCount: number = 0

The total number of participants in this channel.

pinnedMessageIds

pinnedMessageIds: number[] = []

The pinned message IDs of the channel.

Accessors

cachedMetaData

get cachedMetaData(): object
All locally cached metadata as a map.

Returns object
Inherited from BaseChannel.cachedMetaData

createdAt

get createdAt(): number
The creation time of the channel in milliseconds.

Returns number
Inherited from BaseChannel.createdAt

messageCollectionLastAccessedAt

get messageCollectionLastAccessedAt(): number
The local timestamp of when this channel has been used in a MessageCollection.

Returns number
Inherited from BaseChannel.messageCollectionLastAccessedAt

name

get name(): string
The topic or name of the channel.

Returns string
Inherited from BaseChannel.name
set name(value): void
Parameters
- value: string
Returns void
Inherited from BaseChannel.name

url

get url(): string
The unique channel URL.

Returns string
Inherited from BaseChannel.url

Methods

addMessageMetaArrayValues

addMessageMetaArrayValues(message, metaArrays): Promise<BaseMessage>
Parameters
- message: BaseMessage
- metaArrays: MessageMetaArray[]
Returns Promise<BaseMessage>
Description
Adds message meta array values.

Inherited from BaseChannel.addMessageMetaArrayValues

addOperators

addOperators(userIds): Promise<void>
Parameters
- userIds: string[]
Returns Promise<void>
Description
Add operators to the channel.

Inherited from BaseChannel.addOperators

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.

Inherited from BaseChannel.addPollOption

addReaction

addReaction(message, key): Promise<ReactionEvent>
Parameters
- message: BaseMessage
- key: string
Returns Promise<ReactionEvent>
Description
Adds Reaction.

Inherited from BaseChannel.addReaction

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.

Inherited from BaseChannel.banUser

banUserWithUserId

banUserWithUserId(userId, duration?, description?): Promise<void>
Parameters
- userId: string
- Optionalduration: number
- Optionaldescription: string
Returns Promise<void>
Description
Bans a member with userId.

Inherited from BaseChannel.banUserWithUserId

cancelUploadingFileMessage

cancelUploadingFileMessage(requestId): Promise<boolean>
Parameters
- requestId: string
Returns Promise<boolean>
Description
Cancels an ongoing FileMessage upload.

Inherited from BaseChannel.cancelUploadingFileMessage

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.

Inherited from BaseChannel.closePoll

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.

Inherited from BaseChannel.copyFileMessage

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.

Inherited from BaseChannel.copyMessage
copyMessage(channel, message): MessageRequestHandler<UserMessage>
Parameters
- channel: BaseChannel
- message: UserMessage
Returns MessageRequestHandler<UserMessage>
Description
Copies a message from this channel to the target channel.

Inherited from BaseChannel.copyMessage

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.

Inherited from BaseChannel.copyUserMessage

createBannedUserListQuery

createBannedUserListQuery(params?): BannedUserListQuery
Parameters
- params: BannedUserListQueryParams = {}
Returns BannedUserListQuery
Description
Creates a query instance to get the banned user list from this channel.

Inherited from BaseChannel.createBannedUserListQuery

createMessageMetaArrayKeys

createMessageMetaArrayKeys(message, keys): Promise<BaseMessage>
Parameters
- message: BaseMessage
- keys: string[]
Returns Promise<BaseMessage>
Description
Creates message meta array keys.

Inherited from BaseChannel.createMessageMetaArrayKeys

createMetaCounters

createMetaCounters(data): Promise<MetaCounter>
Parameters
- data: MetaCounter
Returns Promise<MetaCounter>
Description
Creates meta counters. This can be used to customize the channel.

Inherited from BaseChannel.createMetaCounters

createMetaData

createMetaData(data): Promise<MetaData>
Parameters
- data: MetaData
Returns Promise<MetaData>
Description
Creates meta data. This can be used to customize the channel.

Inherited from BaseChannel.createMetaData

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.

Inherited from BaseChannel.createMutedUserListQuery

createOperatorListQuery

createOperatorListQuery(params?): OperatorListQuery
Parameters
- params: OperatorListQueryParams = {}
Returns OperatorListQuery
Description
Creates a query instance to get the operator list from this channel.

Inherited from BaseChannel.createOperatorListQuery

createParticipantListQuery

createParticipantListQuery(params): ParticipantListQuery
Parameters
- params: ParticipantListQueryParams
Returns ParticipantListQuery
Description
Creates a query instance to get the whole participant list (online only) of this channel.

createPinnedMessageListQuery

createPinnedMessageListQuery(params?): PinnedMessageListQuery
Parameters
- params: PinnedMessageListQueryParams = {}
Returns PinnedMessageListQuery
Description
Creates a query instance to get pinned messages.

Inherited from BaseChannel.createPinnedMessageListQuery

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.

Inherited from BaseChannel.createPollListQuery

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.

Inherited from BaseChannel.createPollVoterListQuery

createPreviousMessageListQuery

createPreviousMessageListQuery(params?): PreviousMessageListQuery
Parameters
- params: PreviousMessageListQueryParams = {}
Returns PreviousMessageListQuery
Description
Creates previous message list query for this channel.

Inherited from BaseChannel.createPreviousMessageListQuery

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.

Inherited from BaseChannel.decreaseMetaCounters

delete

delete(): Promise<void>
Returns Promise<void>
Description
Deletes an OpenChannel. Note that only operators of a channel are able to delete it or else, an error will be returned to the handler.

deleteAllMetaCounters

deleteAllMetaCounters(): Promise<void>
Returns Promise<void>
Description
Deletes all meta counters.

Inherited from BaseChannel.deleteAllMetaCounters

deleteAllMetaData

deleteAllMetaData(): Promise<void>
Returns Promise<void>
Description
Deletes all meta data.

Inherited from BaseChannel.deleteAllMetaData

deleteMessage

deleteMessage(message): Promise<void>
Parameters
- message: BaseMessage
Returns Promise<void>
Description
Deletes a message.

Inherited from BaseChannel.deleteMessage

deleteMessageMetaArrayKeys

deleteMessageMetaArrayKeys(message, keys): Promise<BaseMessage>
Parameters
- message: BaseMessage
- keys: string[]
Returns Promise<BaseMessage>
Description
Deletes message meta array keys.

Inherited from BaseChannel.deleteMessageMetaArrayKeys

deleteMetaCounter

deleteMetaCounter(key): Promise<void>
Parameters
- key: string
Returns Promise<void>
Description
Deletes a meta counter.

Inherited from BaseChannel.deleteMetaCounter

deleteMetaData

deleteMetaData(key): Promise<void>
Parameters
- key: string
Returns Promise<void>
Description
Deletes a meta data.

Inherited from BaseChannel.deleteMetaData

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.

Inherited from BaseChannel.deletePoll

deletePollOption

deletePollOption(pollId, pollOptionId): Promise<void>
Parameters
- pollId: number
- pollOptionId: number
Returns Promise<void>
Description
Deletes this poll option.

Inherited from BaseChannel.deletePollOption

deleteReaction

deleteReaction(message, key): Promise<ReactionEvent>
Parameters
- message: BaseMessage
- key: string
Returns Promise<ReactionEvent>
Description
Deletes Reaction.

Inherited from BaseChannel.deleteReaction

enter

enter(): Promise<void>
Returns Promise<void>
Description
Enters this channel. The current User becomes a participant of this channel.

exit

exit(): Promise<void>
Returns Promise<void>
Description
Exits from this channel. The current User is no longer a participant of this channel.

freeze

freeze(): Promise<void>
Returns Promise<void>
Description
Freezes the channel. No one could send a message in a frozen channel.

Inherited from BaseChannel.freeze

getAllMetaCounters

getAllMetaCounters(): Promise<MetaCounter>
Returns Promise<MetaCounter>
Description
Get all meta counters.

Inherited from BaseChannel.getAllMetaCounters

getAllMetaData

getAllMetaData(): Promise<MetaData>
Returns Promise<MetaData>
Description
Gets all meta data.

Inherited from BaseChannel.getAllMetaData

getMessageChangeLogsSinceTimestamp

getMessageChangeLogsSinceTimestamp(ts, params?): Promise<MessageChangelogs>
Parameters
- ts: number
- params: MessageChangeLogsParams = {}
Returns Promise<MessageChangelogs>
Description
Requests message change logs after given timestamp.

Inherited from BaseChannel.getMessageChangeLogsSinceTimestamp

getMessageChangeLogsSinceToken

getMessageChangeLogsSinceToken(token, params?): Promise<MessageChangelogs>
Parameters
- token: string
- params: MessageChangeLogsParams = {}
Returns Promise<MessageChangelogs>
Description
Requests message change logs after given token.

Inherited from BaseChannel.getMessageChangeLogsSinceToken

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.

Inherited from BaseChannel.getMessagesByMessageId

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.

Inherited from BaseChannel.getMessagesByTimestamp

getMetaCounters

getMetaCounters(keys): Promise<MetaCounter>
Parameters
- keys: string[]
Returns Promise<MetaCounter>
Description
Gets meta counters.

Inherited from BaseChannel.getMetaCounters

getMetaData

getMetaData(keys): Promise<MetaData>
Parameters
- keys: string[]
Returns Promise<MetaData>
Description
Gets meta data.

Inherited from BaseChannel.getMetaData

getMyMutedInfo

getMyMutedInfo(): Promise<MutedInfo>
Returns Promise<MutedInfo>
Description
Gets my muted information in this channel.

Inherited from BaseChannel.getMyMutedInfo

getPollChangeLogsSinceTimestamp

getPollChangeLogsSinceTimestamp(ts): Promise<PollChangelogs>
Parameters
- ts: number
Returns Promise<PollChangelogs>
Description
Requests poll change logs after given timestamp.

Inherited from BaseChannel.getPollChangeLogsSinceTimestamp

getPollChangeLogsSinceToken

getPollChangeLogsSinceToken(token): Promise<PollChangelogs>
Parameters
- token: null | string
Returns Promise<PollChangelogs>
Description
Requests poll change logs after given token.

Inherited from BaseChannel.getPollChangeLogsSinceToken

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.

Inherited from BaseChannel.increaseMetaCounters

isEqual

isEqual(channel): boolean
Parameters
- channel: BaseChannel
Returns boolean
Description
Whether the given channel is equal in all the values of this channel.

Inherited from BaseChannel.isEqual

isFeedChannel

isFeedChannel(): this is FeedChannel
Returns this is FeedChannel
Description
Whether the instance is FeedChannel type.

Inherited from BaseChannel.isFeedChannel

isGroupChannel

isGroupChannel(): this is GroupChannel
Returns this is GroupChannel
Description
Whether the instance is GroupChannel type.

Inherited from BaseChannel.isGroupChannel

isIdentical

isIdentical(channel): boolean
Parameters
- channel: BaseChannel
Returns boolean
Description
Whether the given channel is identical to this channel.

Inherited from BaseChannel.isIdentical

isOpenChannel

isOpenChannel(): this is OpenChannel
Returns this is OpenChannel
Description
Whether the instance is OpenChannel type.

Inherited from BaseChannel.isOpenChannel

isOperator

isOperator(userOrUserId): boolean
Parameters
- userOrUserId: string | User
Returns boolean
Description
Checks if the given User is an operator of this channel.

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.

Inherited from BaseChannel.muteUser

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.

Inherited from BaseChannel.muteUserWithUserId

pinMessage

pinMessage(messageId): Promise<void>
Parameters
- messageId: number
Returns Promise<void>
Description
Pins a message to the channel.

Inherited from BaseChannel.pinMessage

refresh

refresh(): Promise<OpenChannel>
Returns Promise<OpenChannel>
Description
Refreshes all the data of this channel.

removeMessageMetaArrayValues

removeMessageMetaArrayValues(message, metaArrays): Promise<BaseMessage>
Parameters
- message: BaseMessage
- metaArrays: MessageMetaArray[]
Returns Promise<BaseMessage>
Description
Removes message meta array values.

Inherited from BaseChannel.removeMessageMetaArrayValues

removeOperators

removeOperators(userIds): Promise<void>
Parameters
- userIds: string[]
Returns Promise<void>
Description
Remove operators from the channel.

Inherited from BaseChannel.removeOperators

report

report(category, description): Promise<void>
Parameters
- category: ReportCategory
- description: string
Returns Promise<void>
Description
Reports this channel of inappropriate activities.

Inherited from BaseChannel.report

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.

Inherited from BaseChannel.reportMessage

reportUser

reportUser(user, category, description): Promise<void>
Parameters
- user: User
- category: ReportCategory
- description: string
Returns Promise<void>
Description
Reports a user of suspicious activities.

Inherited from BaseChannel.reportUser

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.

Inherited from BaseChannel.resendFileMessage

resendMessage

resendMessage(failedMessage, file?): MessageRequestHandler<FileMessage>
Parameters
- failedMessage: FileMessage
- Optionalfile: FileCompat
Returns MessageRequestHandler<FileMessage>
Description
Resends a failed message.

Inherited from BaseChannel.resendMessage
resendMessage(failedMessage): MessageRequestHandler<UserMessage>
Parameters
- failedMessage: UserMessage
Returns MessageRequestHandler<UserMessage>
Description
Resends a failed message.

Inherited from BaseChannel.resendMessage

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.

Inherited from BaseChannel.resendUserMessage

sendFileMessage

sendFileMessage(params): MessageRequestHandler<SendableMessage>
Parameters
- params: FileMessageCreateParams
Returns MessageRequestHandler<SendableMessage>
Description
Sends a file with given file information.

Inherited from BaseChannel.sendFileMessage

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.

Inherited from BaseChannel.sendFileMessages

sendMultipleFilesMessage

sendMultipleFilesMessage(params): MultipleFilesMessageRequestHandler<SendableMessage>
Parameters
- params: MultipleFilesMessageCreateParams
Returns MultipleFilesMessageRequestHandler<SendableMessage>
Description
Sends a multiple files or file URLs as a single MultipleFilesMessage.

Inherited from BaseChannel.sendMultipleFilesMessage

sendUserMessage

sendUserMessage(params): MessageRequestHandler<SendableMessage>
Parameters
- params: UserMessageCreateParams
Returns MessageRequestHandler<SendableMessage>
Description
Sends a user message.

Inherited from BaseChannel.sendUserMessage

serialize

serialize(): object
Returns object
Description
Serializes the OpenChannel instance. The instance can be restored by OpenChannelModule.buildOpenChannelFromSerializedData.

translateUserMessage

translateUserMessage(targetMessage, languages): Promise<UserMessage>
Parameters
- targetMessage: UserMessage
- languages: string[]
Returns Promise<UserMessage>
Description
Translates a user message.

Inherited from BaseChannel.translateUserMessage

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.

Inherited from BaseChannel.unbanUser

unbanUserWithUserId

unbanUserWithUserId(userId): Promise<void>
Parameters
- userId: string
Returns Promise<void>
Description
Unbans User with userId.

Inherited from BaseChannel.unbanUserWithUserId

unfreeze

unfreeze(): Promise<void>
Returns Promise<void>
Description
Unfreezes the channel.

Inherited from BaseChannel.unfreeze

unmuteUser

unmuteUser(user): Promise<void>
Parameters
- user: User
Returns Promise<void>
Description
Unmutes User. The unmuted user could send a message again.

Inherited from BaseChannel.unmuteUser

unmuteUserWithUserId

unmuteUserWithUserId(userId): Promise<void>
Parameters
- userId: string
Returns Promise<void>
Description
Unmutes User with userId. The unmuted user could send a message again.

Inherited from BaseChannel.unmuteUserWithUserId

unpinMessage

unpinMessage(messageId): Promise<void>
Parameters
- messageId: number
Returns Promise<void>
Description
Removes the message from the channel's pinned messages.

Inherited from BaseChannel.unpinMessage

updateChannel

updateChannel(params): Promise<OpenChannel>
Parameters
- params: OpenChannelUpdateParams
Returns Promise<OpenChannel>
Description
Update this channel with OpenChannelUpdateParams.

updateChannelWithOperatorUserIds

updateChannelWithOperatorUserIds(name, coverUrlOrImage, data, operatorUserIds, customType): Promise<OpenChannel>
Parameters
- name: string
- coverUrlOrImage: string | FileCompat
- data: string
- operatorUserIds: string[]
- customType: string
Returns Promise<OpenChannel>
Deprecated
Description
Update this channel with given parameters.

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.

Overrides BaseChannel.updateFileMessage

updateMetaCounters

updateMetaCounters(data, upsert?): Promise<MetaCounter>
Parameters
- data: MetaCounter
- upsert: boolean = false
Returns Promise<MetaCounter>
Description
Updates meta counters.

Inherited from BaseChannel.updateMetaCounters

updateMetaData

updateMetaData(data, upsert?): Promise<MetaData>
Parameters
- data: MetaData
- upsert: boolean = false
Returns Promise<MetaData>
Description
Updates meta data.

Inherited from BaseChannel.updateMetaData

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.

Inherited from BaseChannel.updatePoll

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.

Inherited from BaseChannel.updatePollOption

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.

Overrides BaseChannel.updateUserMessage

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.

Inherited from BaseChannel.uploadFile

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.

Inherited from BaseChannel.votePoll

ClassOpenChannel

Description

Hierarchy (view full)

Index

Properties

Accessors

Methods

Properties

channelType

coverUrl

creator

customType

data

isEphemeral

isFrozen

lastPinnedMessage

operators

participantCount

pinnedMessageIds

Accessors

cachedMetaData

Returns object

createdAt

Returns number

messageCollectionLastAccessedAt

Returns number

name

Returns string

Parameters

Returns void

url

Returns string

Methods

addMessageMetaArrayValues

Parameters

Returns Promise<BaseMessage>

Description

addOperators

Parameters

Returns Promise<void>

Description

addPollOption

Parameters

Returns Promise<Poll>

Description

addReaction

Parameters

Returns Promise<ReactionEvent>

Description

banUser

Parameters

Returns Promise<void>

Description

banUserWithUserId

Parameters

Returns Promise<void>

Description

cancelUploadingFileMessage

Parameters

Returns Promise<boolean>

Description

closePoll

Parameters

Returns Promise<Poll>

Description

copyFileMessage

Parameters

Returns Promise<FileMessage>

Deprecated

Description

copyMessage

Parameters

Returns MessageRequestHandler<FileMessage>

Description

Parameters

Returns MessageRequestHandler<UserMessage>

Description

copyUserMessage

Parameters

Returns Promise<UserMessage>