class ThreadChannel

extends

TextBasedChannelMixin(BaseChannel, true, [ 'fetchWebhooks', 'createWebhook', 'setNSFW',])
export class ThreadChannel<ThreadOnly extends boolean = boolean> extends TextBasedChannelMixin(BaseChannel, true, [ 'fetchWebhooks', 'createWebhook', 'setNSFW',])

Represents a thread channel on Discord.

Type Parameters

optional
ThreadOnly? extends boolean = boolean

appliedTags : Snowflake[]

The tags applied to this thread

archived : boolean | null

Whether the thread is archived

readonly
archivedAt : Date | null

The time at which this thread's archive status was last changed If the thread was never archived or unarchived, this is the time at which the thread was created

archiveTimestamp : number | null

The timestamp when the thread's archive status was last changed If the thread was never archived or unarchived, this is the timestamp at which the thread was created

autoArchiveDuration : ThreadAutoArchiveDuration | null

The amount of time (in minutes) after which the thread will automatically archive in case of no recent activity

readonly
createdAt : Date | null

The time the thread was created at

readonly
createdTimestamp : number | null

The timestamp when this thread was created. This isn't available for threads created before 2022-01-09

readonly
editable : boolean

Whether the thread is editable by the client user (name, archived, autoArchiveDuration)

flags : Readonly<ChannelFlagsBitField>

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 thread is in

guildId : Snowflake

The id of the guild the channel is in

readonly
guildMembers : Collection<Snowflake, GuildMember>

A collection of associated guild member objects of this thread's members

invitable : boolean | null

Whether members without the PermissionFlagsBits permission can invite other members to this thread. This property is always null in public threads.

readonly
joinable : boolean

Whether the thread is joinable by the client user

readonly
joined : boolean

Whether the client user is a member of the thread.

readonlyoptional
lastMessage? : Message

The Message object of the last message in the channel, if one was sent

optional
lastMessageId? : Snowflake

The last message id sent in this thread, if one was sent

readonlyoptional
lastPinAt? : Date

The date when the last pinned message was pinned, if there was one

optional
lastPinTimestamp? : number

The timestamp when the last pinned message was pinned, if there was one

locked : boolean | null

Whether the thread is locked

readonly
manageable : boolean

Whether the thread is manageable by the client user, for deleting or editing rateLimitPerUser or locked.

memberCount : number | null

The approximate count of users in this thread This stops counting at 50. If you need an approximate value higher than that, use ThreadChannel#members.cache.size

members : ThreadMemberManager

A manager of the members that are part of this thread

messageCount : number | null

The approximate count of messages in this thread Threads created before July 1, 2022 may have an inaccurate count. If you need an approximate value higher than that, use ThreadChannel#messages.cache.size

messages : GuildMessageManager

A manager of the messages sent to this thread

name : string

The name of the thread

ownerId : Snowflake | null

The id of the member who created this thread

readonly
parent : If<ThreadOnly, ForumChannel | MediaChannel, TextChannel | NewsChannel> | null

The parent channel of this thread

parentId : Snowflake | null

The id of the parent channel of this thread

rateLimitPerUser : number | null

The rate limit per user (slowmode) for this thread in seconds

readonly
sendable : boolean

Whether the client user can send messages in this thread

totalMessageSent : number | null

The number of messages ever sent in a thread, similar to messageCount except it will not decrement whenever a message is deleted

type : ThreadChannelType

The type of the channel

readonly
unarchivable : boolean

Whether the thread is unarchivable by the client user

readonly
viewable : boolean

Whether the thread is viewable by the client user

awaitMessageComponent(
options?: AwaitMessageComponentOptions
) : Promise<MessageComponentInteraction>

Collects a single component interaction that passes the filter. The Promise will reject if the time expires.

Examples:
// 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);

awaitMessages(
options?: AwaitMessagesOptions
) : Promise<Collection<Snowflake, Message>>

Similar to createMessageCollector but in promise form. Resolves with a collection of messages that pass the specified filter.

Examples:
// 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.`));

bulkDelete(
messages: Collection<Snowflake, Message> | Array<MessageResolvable> | number
filterOld?: boolean
) : Promise<Collection<Snowflake, (Message|undefined)>>

Bulk deletes given messages that are newer than two weeks.

Examples:
// Bulk delete messages
channel.bulkDelete(5)
  .then(messages => console.log(`Bulk deleted ${messages.size} messages`))
  .catch(console.error);

Returns: Returns the deleted messages *

createMessageCollector(
options?: MessageCollectorOptions
) : MessageCollector

Creates a Message Collector.

Examples:
// 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`));

createMessageComponentCollector(
options?: MessageComponentCollectorOptions
) : InteractionCollector

Creates a component interaction collector.

Examples:
// 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`));

delete(
reason?: string
) : Promise<this>

Deletes this thread.

Examples:
// Delete the thread
thread.delete('cleaning out old threads')
  .then(deletedThread => console.log(deletedThread))
  .catch(console.error);

edit(
options: ThreadEditOptions
) : Promise<AnyThreadChannel>

Edits this thread.

Examples:
// Edit a thread
thread.edit({ name: 'new-thread' })
  .then(editedThread => console.log(editedThread))
  .catch(console.error);

fetchOwner(
options?: BaseFetchOptions
) : Promise<ThreadMember | null>

Fetches the owner of this thread. If the thread member object isn't needed, use ownerId instead.

fetchStarterMessage(
options?: BaseFetchOptions
) : Promise<Message<true> | null>

Fetches the message that started this thread, if any. The Promise will reject if the original message in a forum post is deleted or when the original message in the parent channel is deleted. If you just need the id of that message, use instead.

join() : Promise<AnyThreadChannel>

Makes the client user join the thread.

leave() : Promise<AnyThreadChannel>

Makes the client user leave the thread.

permissionsFor(
memberOrRole: GuildMember | Role
checkAdmin?: boolean
) : Readonly<PermissionsBitField>

Gets the overall set of permissions for a member or role in this thread's parent channel, taking overwrites into account.

pin(
reason?: string
) : Promise<ThreadChannel<true>>

Pins this thread from the forum channel (only applicable to forum threads).

send(
options: string | MessagePayload | MessageCreateOptions
) : Promise<Message>

Sends a message to this channel.

Examples:
// 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);

sendTyping() : Promise<void>

Sends a typing indicator in the channel.

Examples:
// Start typing in a channel
channel.sendTyping();

Returns: Resolves upon the typing status being sent *

setAppliedTags(
appliedTags: Snowflake[]
reason?: string
) : Promise<ThreadChannel<true>>

Set the applied tags for this channel (only applicable to forum threads)

setArchived(
archived?: boolean
reason?: string
) : Promise<AnyThreadChannel>

Sets whether the thread is archived.

Examples:
// Archive the thread
thread.setArchived(true)
  .then(newThread => console.log(`Thread is now ${newThread.archived ? 'archived' : 'active'}`))
  .catch(console.error);

setAutoArchiveDuration(
autoArchiveDuration: ThreadAutoArchiveDuration
reason?: string
) : Promise<AnyThreadChannel>

Sets the duration after which the thread will automatically archive in case of no recent activity.

Examples:
// Set the thread's auto archive time to 1 hour
thread.setAutoArchiveDuration(ThreadAutoArchiveDuration.OneHour)
  .then(newThread => {
    console.log(`Thread will now archive after ${newThread.autoArchiveDuration} minutes of inactivity`);
   });
  .catch(console.error);

setInvitable(
invitable?: boolean
reason?: string
) : Promise<AnyThreadChannel>

Sets whether members without the PermissionFlagsBits permission can invite other members to this thread.

setLocked(
locked?: boolean
reason?: string
) : Promise<AnyThreadChannel>

Sets whether the thread can be **unarchived* * by anyone with the PermissionFlagsBits permission. When a thread is locked, only members with the PermissionFlagsBits permission can unarchive it.

Examples:
// Set the thread to locked
thread.setLocked(true)
  .then(newThread => console.log(`Thread is now ${newThread.locked ? 'locked' : 'unlocked'}`))
  .catch(console.error);

setName(
name: string
reason?: string
) : Promise<AnyThreadChannel>

Sets a new name for this thread.

Examples:
// Change the thread's name
thread.setName('not_general')
  .then(newThread => console.log(`Thread's new name is ${newThread.name}`))
  .catch(console.error);

setRateLimitPerUser(
rateLimitPerUser: number
reason?: string
) : Promise<ThreadChannel>

Sets the rate limit per user (slowmode) for this thread.

toString() : ChannelMention

When concatenated with a string, this automatically returns the channel's mention instead of the Channel object.

Examples:
// Logs: Hello from <#123456789012345678>!
console.log(`Hello from ${channel}!`);

unpin(
reason?: string
) : Promise<ThreadChannel<true>>

Unpins this thread from the forum channel (only applicable to forum threads).