class TextChannel
extends
BaseGuildTextChannelexport class TextChannel extends BaseGuildTextChannel
Represents a guild text channel on Discord.
readonlyClient client :
The client that instantiated this
readonlyDate createdAt :
The time the channel was created at
readonlynumber createdTimestamp :
The timestamp the channel was created at
optionalThreadAutoArchiveDuration defaultAutoArchiveDuration? :
The default auto archive duration for newly created threads in this channel
optionalnumber defaultThreadRateLimitPerUser? :
The initial rate limit per user (slowmode) to set on newly created threads in a channel.
readonlyboolean deletable :
Whether the channel is deletable by the client user
optionalReadonly<ChannelFlagsBitField> flags? :
The flags that are applied to the channel. This is only null
in a PartialGroupDMChannel. In all other cases, it is not null
.
Guild guild :
The guild the channel is in
Snowflake guildId :
The id of the guild the channel is in
Snowflake id :
The channel's id
readonlyoptionalMessage lastMessage? :
The Message object of the last message in the channel, if one was sent
optionalSnowflake lastMessageId? :
The last message id sent in the channel, if one was sent
readonlyoptionalDate lastPinAt? :
The date when the last pinned message was pinned, if there was one
optionalnumber lastPinTimestamp? :
The timestamp when the last pinned message was pinned, if there was one
readonlyboolean manageable :
Whether the channel is manageable by the client user
readonlyCollection<Snowflake, GuildMember> members :
A collection of cached members of this channel, mapped by their ids. Members that can view this channel, if the channel is text-based. Members in the channel, if the channel is voice-based.
GuildMessageManager messages :
A manager of the messages sent to this channel
string name :
The name of the guild channel
boolean nsfw :
If the guild considers this channel NSFW
readonlyoptionalCategoryChannel parent? :
The category parent of this channel
optionalSnowflake parentId? :
The id of the category parent of this channel
readonlyboolean partial :
Whether this Channel is a partial This is always false outside of DM channels.
PermissionOverwriteManager permissionOverwrites :
A manager of permission overwrites that belong to this channel
readonlyoptionalboolean permissionsLocked? :
If the permissionOverwrites match the parent channel, null if no parent
readonlynumber position :
The position of the channel
number rateLimitPerUser :
The rate limit per user (slowmode) for this channel in seconds
number rawPosition :
The raw position of the channel from Discord
A manager of the threads belonging to this channel
optionalstring topic? :
The topic of the text channel
ChannelType.GuildText type :
The type of the channel
readonlystring url :
The URL to the channel
readonlyboolean viewable :
Whether the channel is viewable by the client user
awaitMessageComponentoptions?: AwaitMessageComponentOptions) : Promise<MessageComponentInteraction> (
Collects a single component interaction that passes the filter. The Promise will reject if the time expires.
// Collect a message component interaction
const filter = (interaction) => interaction.customId === 'button' && interaction.user.id === 'someId';
channel.awaitMessageComponent({ filter, time: 15_000 })
.then(interaction => console.log(`${interaction.customId} was clicked!`))
.catch(console.error);
Inherited from: BaseGuildTextChannel
awaitMessagesoptions?: AwaitMessagesOptions) : Promise<Collection<Snowflake, Message>> (
Similar to createMessageCollector but in promise form. Resolves with a collection of messages that pass the specified filter.
// Await !vote messages
const filter = m => m.content.startsWith('!vote');
// Errors: ['time'] treats ending because of the time limit as an error
channel.awaitMessages({ filter, max: 4, time: 60_000, errors: ['time'] })
.then(collected => console.log(collected.size))
.catch(collected => console.log(`After a minute, only ${collected.size} out of 4 voted.`));
Inherited from: BaseGuildTextChannel
bulkDeletemessages: Collection<Snowflake, Message> | Array<MessageResolvable> | numberfilterOld?: boolean) : Promise<Collection<Snowflake, (Message|undefined)>> (
Bulk deletes given messages that are newer than two weeks.
// Bulk delete messages
channel.bulkDelete(5)
.then(messages => console.log(`Bulk deleted ${messages.size} messages`))
.catch(console.error);
Returns: Returns the deleted messages *
Inherited from: BaseGuildTextChannel
createInviteoptions?: InviteCreateOptions) : Promise<Invite> (
Creates an invite to this guild channel.
// Create an invite to a channel
channel.createInvite()
.then(invite => console.log(`Created an invite with a code of ${invite.code}`))
.catch(console.error);
Inherited from: BaseGuildTextChannel
createMessageCollectoroptions?: MessageCollectorOptions) : MessageCollector (
Creates a Message Collector.
// Create a message collector
const filter = message => message.content.includes('discord');
const collector = channel.createMessageCollector({ filter, time: 15_000 });
collector.on('collect', message => console.log(`Collected ${message.content}`));
collector.on('end', collected => console.log(`Collected ${collected.size} items`));
Inherited from: BaseGuildTextChannel
createMessageComponentCollectoroptions?: MessageComponentCollectorOptions) : InteractionCollector (
Creates a component interaction collector.
// Create a button interaction collector
const filter = (interaction) => interaction.customId === 'button' && interaction.user.id === 'someId';
const collector = channel.createMessageComponentCollector({ filter, time: 15_000 });
collector.on('collect', interaction => console.log(`Collected ${interaction.customId}`));
collector.on('end', collected => console.log(`Collected ${collected.size} items`));
Inherited from: BaseGuildTextChannel
createWebhookoptions?: ChannelWebhookCreateOptions) : Promise<Webhook> (
Creates a webhook for the channel.
// Create a webhook for the current channel
channel.createWebhook({
name: 'Snek',
avatar: 'https://i.imgur.com/mI8XcpG.jpg',
reason: 'Needed a cool new Webhook'
})
.then(console.log)
.catch(console.error)
Returns: Returns the created Webhook *
Inherited from: BaseGuildTextChannel
fetchInvitescache?: boolean) : Promise<Collection<string, Invite>> (
Fetches a collection of invites to this guild channel. Resolves with a collection mapping invites by their codes.
Inherited from: BaseGuildTextChannel
fetchWebhooksPromise<Collection<Snowflake, Webhook>> () :
Fetches all webhooks for the channel.
// Fetch webhooks
channel.fetchWebhooks()
.then(hooks => console.log(`This channel has ${hooks.size} hooks`))
.catch(console.error);
Inherited from: BaseGuildTextChannel
sendoptions: string | MessagePayload | MessageCreateOptions) : Promise<Message> (
Sends a message to this channel.
// Send a basic message
channel.send('hello!')
.then(message => console.log(`Sent message: ${message.content}`))
.catch(console.error);
// Send a remote file
channel.send({
files: ['https://cdn.discordapp.com/icons/222078108977594368/6e1019b3179d71046e463a75915e7244.png?size=2048']
})
.then(console.log)
.catch(console.error);
// Send a local file
channel.send({
files: [{
attachment: 'entire/path/to/file.jpg',
name: 'file.jpg',
description: 'A description of the file'
}]
})
.then(console.log)
.catch(console.error);
Inherited from: BaseGuildTextChannel
Sends a typing indicator in the channel.
// Start typing in a channel
channel.sendTyping();
Returns: Resolves upon the typing status being sent *
Inherited from: BaseGuildTextChannel
setDefaultAutoArchiveDurationdefaultAutoArchiveDuration: ThreadAutoArchiveDurationreason?: string) : Promise<this> (
Sets the default auto archive duration for all newly created threads in this channel.
Inherited from: BaseGuildTextChannel
Sets whether this channel is flagged as NSFW.
Inherited from: BaseGuildTextChannel
setRateLimitPerUser) : Promise<TextChannel> (
Sets the rate limit per user (slowmode) for this channel.
Sets a new topic for the guild channel.
// Set a new channel topic
channel.setTopic('needs more rate limiting')
.then(newChannel => console.log(`Channel's new topic is ${newChannel.topic}`))
.catch(console.error);
Inherited from: BaseGuildTextChannel
setTypetype: ChannelType.GuildTextreason?: string) : Promise<TextChannel> (
Sets the type of this channel. Only conversion between TextChannel and NewsChannel is supported.