import type { BigString, DiscordChannel, GetMessagesOptions } from '@discordeno/types'; import type Client from '../../Client.js'; import Collection from '../../Collection.js'; import type { CreateChannelInviteOptions, CreateThreadOptions, CreateThreadWithoutMessageOptions, FileContent, GetArchivedThreadsOptions, GetMessageReactionOptions, ListedChannelThreads, MessageContent, MessageContentEdit, PurgeChannelOptions } from '../../typings.js'; import type Invite from '../Invite.js'; import type Message from '../Message.js'; import GuildChannel from './Guild.js'; import type PrivateThreadChannel from './threads/PrivateThread.js'; import type PublicThreadChannel from './threads/PublicThread.js'; export declare class TextChannel extends GuildChannel { /** Collection of Messages in this channel */ messages: Collection; /** The ratelimit of the channel, in seconds. 0 means no ratelimit is enabled */ rateLimitPerUser: number | null; /** The ID of the last message in this channel */ lastMessageID: string; /** The timestamp of the last pinned message */ lastPinTimestamp?: number | null; /** Default duration for newly created threads, in minutes, to automatically archive the thread after recent activity, can be set to: 60, 1440, 4320, 10080 */ defaultAutoArchiveDuration?: number; /** The channel topic (0-4096 characters for GUILD_FORUM channels, 0-1024 characters for all others) */ topic?: string | null; constructor(data: DiscordChannel, client: Client, messageLimit?: number); update(data: DiscordChannel): void; /** Add a reaction to a message */ addMessageReaction(messageID: BigString, reaction: string): Promise; /** Create an invite for the channel */ createInvite(options?: CreateChannelInviteOptions, reason?: string): Promise; /** * Create a message in the channel * @arg {String | Object} content A string or object. If an object is passed: * @arg {Object} [content.allowedMentions] A list of mentions to allow (overrides default) * @arg {Boolean} [content.allowedMentions.everyone] Whether or not to allow @everyone/@here. * @arg {Boolean | Array} [content.allowedMentions.roles] Whether or not to allow all role mentions, or an array of specific role mentions to allow. * @arg {Boolean | Array} [content.allowedMentions.users] Whether or not to allow all user mentions, or an array of specific user mentions to allow. * @arg {Boolean} [content.allowedMentions.repliedUser] Whether or not to mention the author of the message being replied to. * @arg {Array} [content.components] An array of component objects * @arg {String} [content.components[].custom_id] The ID of the component (type 2 style 0-4 and type 3 only) * @arg {Boolean} [content.components[].disabled] Whether the component is disabled (type 2 and 3 only) * @arg {Object} [content.components[].emoji] The emoji to be displayed in the component (type 2) * @arg {String} [content.components[].label] The label to be displayed in the component (type 2) * @arg {Number} [content.components[].max_values] The maximum number of items that can be chosen (1-25, default 1) * @arg {Number} [content.components[].min_values] The minimum number of items that must be chosen (0-25, default 1) * @arg {Array} [content.components[].options] The options for this component (type 3 only) * @arg {Boolean} [content.components[].options[].default] Whether this option should be the default value selected * @arg {String} [content.components[].options[].description] The description for this option * @arg {Object} [content.components[].options[].emoji] The emoji to be displayed in this option * @arg {String} content.components[].options[].label The label for this option * @arg {Number | String} content.components[].options[].value The value for this option * @arg {String} [content.components[].placeholder] The placeholder text for the component when no option is selected (type 3 only) * @arg {Number} [content.components[].style] The style of the component (type 2 only) - If 0-4, `custom_id` is required; if 5, `url` is required * @arg {Number} content.components[].type The type of component - If 1, it is a collection and a `components` array (nested) is required; if 2, it is a button; if 3, it is a select menu * @arg {String} [content.components[].url] The URL that the component should open for users (type 2 style 5 only) * @arg {String} [content.content] A content string * @arg {Object} [content.embed] An embed object. See [the official Discord API documentation entry](https://discord.com/developers/docs/resources/channel#embed-object) for object structure * @arg {Array} [content.embeds] An array of embed objects. See [the official Discord API documentation entry](https://discord.com/developers/docs/resources/channel#embed-object) for object structure * @arg {Object} [content.messageReference] The message reference, used when replying to messages * @arg {String} [content.messageReference.channelID] The channel ID of the referenced message * @arg {Boolean} [content.messageReference.failIfNotExists=true] Whether to throw an error if the message reference doesn't exist. If false, and the referenced message doesn't exist, the message is created without a referenced message * @arg {String} [content.messageReference.guildID] The guild ID of the referenced message * @arg {String} content.messageReference.messageID The message ID of the referenced message. This cannot reference a system message * @arg {String} [content.messageReferenceID] [DEPRECATED] The ID of the message should be replied to. Use `messageReference` instead * @arg {Array} [content.stickerIDs] An array of IDs corresponding to stickers to send * @arg {Boolean} [content.tts] Set the message TTS flag * @arg {Object | Array} [file] A file object (or an Array of them) * @arg {Buffer} file.file A buffer containing file data * @arg {String} file.name What to name the file * @returns {Promise} */ createMessage(content: MessageContent, file?: FileContent | FileContent[]): Promise; /** * Create a thread with an existing message * @arg {String} messageID The ID of the message to create the thread from * @arg {Object} options The thread options * @arg {Number} options.autoArchiveDuration Duration in minutes to automatically archive the thread after recent activity, either 60, 1440, 4320 or 10080 * @arg {String} options.name The thread channel name * @returns {Promise} */ createThreadWithMessage(messageID: string, options: CreateThreadOptions): Promise; /** * Create a thread without an existing message * @arg {Object} options The thread options * @arg {Number} options.autoArchiveDuration Duration in minutes to automatically archive the thread after recent activity, either 60, 1440, 4320 or 10080 * @arg {boolean} [options.invitable] Whether non-moderators can add other non-moderators to the thread (private threads only) * @arg {String} options.name The thread channel name * @arg {Number} [options.type] The channel type of the thread to create. It is recommended to explicitly set this property as this will be a required property in API v10 * @returns {Promise} */ createThreadWithoutMessage(options: CreateThreadWithoutMessageOptions): Promise; /** * Create a channel webhook * @arg {Object} options Webhook options * @arg {String} [options.avatar] The default avatar as a base64 data URI. Note: base64 strings alone are not base64 data URI strings * @arg {String} options.name The default name * @arg {String} [reason] The reason to be displayed in audit logs * @returns {Promise} Resolves with a webhook object */ createWebhook(options: { name: string; avatar?: string | null; }, reason: string): Promise; /** * Delete a message * @arg {String} messageID The ID of the message * @arg {String} [reason] The reason to be displayed in audit logs * @returns {Promise} */ deleteMessage(messageID: string, reason: string): Promise; /** * Bulk delete messages (bot accounts only) * @arg {Array} messageIDs Array of message IDs to delete * @arg {String} [reason] The reason to be displayed in audit logs * @returns {Promise} */ deleteMessages(messageIDs: string[], reason: string): Promise; /** * Edit a message * @arg {String} messageID The ID of the message * @arg {String | Array | Object} content A string, array of strings, or object. If an object is passed: * @arg {Object} [content.allowedMentions] A list of mentions to allow (overrides default) * @arg {Boolean} [content.allowedMentions.everyone] Whether or not to allow @everyone/@here. * @arg {Boolean | Array} [content.allowedMentions.roles] Whether or not to allow all role mentions, or an array of specific role mentions to allow. * @arg {Boolean | Array} [content.allowedMentions.users] Whether or not to allow all user mentions, or an array of specific user mentions to allow. * @arg {Array} [content.components] An array of component objects * @arg {String} [content.components[].custom_id] The ID of the component (type 2 style 0-4 and type 3 only) * @arg {Boolean} [content.components[].disabled] Whether the component is disabled (type 2 and 3 only) * @arg {Object} [content.components[].emoji] The emoji to be displayed in the component (type 2) * @arg {String} [content.components[].label] The label to be displayed in the component (type 2) * @arg {Number} [content.components[].max_values] The maximum number of items that can be chosen (1-25, default 1) * @arg {Number} [content.components[].min_values] The minimum number of items that must be chosen (0-25, default 1) * @arg {Array} [content.components[].options] The options for this component (type 3 only) * @arg {Boolean} [content.components[].options[].default] Whether this option should be the default value selected * @arg {String} [content.components[].options[].description] The description for this option * @arg {Object} [content.components[].options[].emoji] The emoji to be displayed in this option * @arg {String} content.components[].options[].label The label for this option * @arg {Number | String} content.components[].options[].value The value for this option * @arg {String} [content.components[].placeholder] The placeholder text for the component when no option is selected (type 3 only) * @arg {Number} [content.components[].style] The style of the component (type 2 only) - If 0-4, `custom_id` is required; if 5, `url` is required * @arg {Number} content.components[].type The type of component - If 1, it is a collection and a `components` array (nested) is required; if 2, it is a button; if 3, it is a select menu * @arg {String} [content.components[].url] The URL that the component should open for users (type 2 style 5 only) * @arg {String} [content.content] A content string * @arg {Object} [content.embed] An embed object. See [the official Discord API documentation entry](https://discord.com/developers/docs/resources/channel#embed-object) for object structure * @arg {Array} [content.embeds] An array of embed objects. See [the official Discord API documentation entry](https://discord.com/developers/docs/resources/channel#embed-object) for object structure * @arg {Object | Array} [content.file] A file object (or an Array of them) * @arg {Buffer} content.file[].file A buffer containing file data * @arg {String} content.file[].name What to name the file * @arg {Number} [content.flags] A number representing the flags to apply to the message. See [the official Discord API documentation entry](https://discord.com/developers/docs/resources/channel#message-object-message-flags) for flags reference * @returns {Promise} */ editMessage(messageID: string, content: MessageContentEdit): Promise; /** Get all archived threads in this channel */ getArchivedThreads(type: 'private', options?: GetArchivedThreadsOptions): Promise>; getArchivedThreads(type: 'public', options?: GetArchivedThreadsOptions): Promise>; /** * Get all invites in the channel * @returns {Promise>} */ getInvites(): Promise; /** * Get joined private archived threads in this channel * @arg {Object} [options] Additional options when requesting archived threads * @arg {Date} [options.before] List of threads to return before the timestamp * @arg {Number} [options.limit] Maximum number of threads to return * @returns {Promise} An object containing an array of `threads`, an array of `members` and whether the response `hasMore` threads that could be returned in a subsequent call */ getJoinedPrivateArchivedThreads(options: GetArchivedThreadsOptions): Promise>; /** * Get a previous message in the channel * @arg {String} messageID The ID of the message * @returns {Promise} */ getMessage(messageID: string): Promise; /** * Get a list of users who reacted with a specific reaction * @arg {String} messageID The ID of the message * @arg {String} reaction The reaction (Unicode string if Unicode emoji, `emojiName:emojiID` if custom emoji) * @arg {Object} [options] Options for the request. If this is a number, it is treated as `options.limit` ([DEPRECATED] behavior) * @arg {Number} [options.limit=100] The maximum number of users to get * @arg {String} [options.after] Get users after this user ID * @returns {Promise>} */ getMessageReaction(messageID: string, reaction: string, options: GetMessageReactionOptions): Promise; /** * Get previous messages in the channel * @arg {Object} [options] Options for the request. If this is a number ([DEPRECATED] behavior), it is treated as `options.limit` * @arg {String} [options.after] Get messages after this message ID * @arg {String} [options.around] Get messages around this message ID (does not work with limit > 100) * @arg {String} [options.before] Get messages before this message ID * @arg {Number} [options.limit=50] The max number of messages to get * @returns {Promise>} */ getMessages(options: GetMessagesOptions): Promise; /** * Get all the pins in the channel * @returns {Promise>} */ getPins(): Promise; /** * Get all the webhooks in the channel * @returns {Promise>} Resolves with an array of webhook objects */ getWebhooks(): Promise; /** * Pin a message * @arg {String} messageID The ID of the message * @returns {Promise} */ pinMessage(messageID: string): Promise; /** * Purge previous messages in the channel with an optional filter (bot accounts only) * @arg {Object} options Options for the request. If this is a number ([DEPRECATED] behavior), it is treated as `options.limit` * @arg {String} [options.after] Get messages after this message ID * @arg {String} [options.before] Get messages before this message ID * @arg {Function} [options.filter] Optional filter function that returns a boolean when passed a Message object * @arg {Number} options.limit The max number of messages to search through, -1 for no limit * @arg {String} [options.reason] The reason to be displayed in audit logs * @returns {Promise} Resolves with the number of messages deleted */ purge(limit: PurgeChannelOptions): Promise; /** * Remove a reaction from a message * @arg {String} messageID The ID of the message * @arg {String} reaction The reaction (Unicode string if Unicode emoji, `emojiName:emojiID` if custom emoji) * @arg {String} [userID="@me"] The ID of the user to remove the reaction for * @returns {Promise} */ removeMessageReaction(messageID: string, reaction: string, userID: string): Promise; /** * Remove all reactions from a message for a single emoji * @arg {String} messageID The ID of the message * @arg {String} reaction The reaction (Unicode string if Unicode emoji, `emojiName:emojiID` if custom emoji) * @returns {Promise} */ removeMessageReactionEmoji(messageID: string, reaction: string): Promise; /** * Remove all reactions from a message * @arg {String} messageID The ID of the message * @returns {Promise} */ removeMessageReactions(messageID: string): Promise; /** * Send typing status in the channel * @returns {Promise} */ sendTyping(): Promise; /** * Unpin a message * @arg {String} messageID The ID of the message * @returns {Promise} */ unpinMessage(messageID: string): Promise; /** * Un-send a message. You're welcome Programmix * @arg {String} messageID The ID of the message * @returns {Promise} */ unsendMessage(messageID: string): Promise; toJSON(props?: string[]): Record; } export default TextChannel; //# sourceMappingURL=Text.d.ts.map