Preview environment

class GuildTextThreadManager

extends

ThreadManager<false>
export class GuildTextThreadManager<AllowedThreadType> extends ThreadManager<false>

Manages API methods for ThreadChannel objects and stores their cache.

Type Parameters

AllowedThreadType

readonly
cache : Collection<Key, Holds>

The cache of items for this manager.

Inherited from: DataManager

channel : If<false, ForumChannel | MediaChannel, TextChannel | NewsChannel>

The channel this Manager belongs to

Inherited from: ThreadManager

readonly
client : Client

The client that instantiated this Manager

Inherited from: BaseManager

readonly
holds : Constructable<Holds>

The data structure belonging to this manager.

Inherited from: DataManager

create(
options: GuildTextThreadCreateOptions<AllowedThreadType>
) : Promise<AllowedThreadType extends ChannelType.PrivateThread ? PrivateThreadChannel : PublicThreadChannel<false>>

Creates a new thread in the channel.

Examples:
// Create a new public thread
channel.threads
  .create({
    name: 'food-talk',
    autoArchiveDuration: ThreadAutoArchiveDuration.OneHour,
    reason: 'Needed a separate thread for food',
  })
  .then(threadChannel => console.log(threadChannel))
  .catch(console.error);
// Create a new private thread
channel.threads
  .create({
     name: 'mod-talk',
     autoArchiveDuration: ThreadAutoArchiveDuration.OneHour,
     type: ChannelType.PrivateThread,
     reason: 'Needed a separate thread for moderation',
   })
  .then(threadChannel => console.log(threadChannel))
  .catch(console.error);

fetch(
options: ThreadChannelResolvable
cacheOptions?: BaseFetchOptions
) : Promise<If<ThreadOnly, ForumThreadChannel, TextThreadChannel> | null>

Obtains a thread from Discord, or the channel cache if it's already available.

Examples:
// Fetch a thread by its id
channel.threads.fetch('831955138126104859')
  .then(channel => console.log(channel.name))
  .catch(console.error);

Returns: FetchedThreads if active & FetchedThreadsMore if archived.

fetchActive(
cache?: boolean
) : Promise<FetchedThreads>

Obtains all active threads in the channel.

Inherited from: ThreadManager

fetchArchived(
options?: FetchArchivedThreadOptions
cache?: boolean
) : Promise<FetchedThreadsMore>

Obtains a set of archived threads from Discord. This method requires the PermissionFlagsBits.ReadMessageHistory permission in the parent channel.

Inherited from: ThreadManager

resolve(
thread: ThreadChannelResolvable
) : ThreadChannel | null

Resolves a ThreadChannelResolvable to a ThreadChannel object.

Inherited from: ThreadManager

resolveId(
thread: ThreadChannelResolvable
) : Snowflake | null

Resolves a ThreadChannelResolvable to a ThreadChannel id.

Inherited from: ThreadManager

valueOf() : Collection<Key, Holds>

Inherited from: DataManager