discord.js | GuildForumThreadManager

Search...

GuildForumThreadManager

export class GuildForumThreadManager extends ThreadManager<true>

export class GuildForumThreadManager extends ThreadManager<true>

Manages API methods for threads in forum channels and stores their cache.

Extends

ThreadManager<true>

cache:Collection<Snowflake, ThreadChannel>

The cache of this Manager

channel:ForumChannel

The channel this Manager belongs to

Readonly

client:Client

The client that instantiated this Manager

Readonly

holds:Constructable<Holds>

The data structure belonging to this manager.

Inherited from DataManager

create(options):Promise<ThreadChannel>

Creates a new thread in the channel.

Example

// Create a new forum post
forum.threads
  .create({
    name: 'Food Talk',
    autoArchiveDuration: ThreadAutoArchiveDuration.OneHour,
    message: {
     content: 'Discuss your favorite food!',
    },
    reason: 'Needed a separate thread for food',
  })
  .then(threadChannel => console.log(threadChannel))
  .catch(console.error);

// Create a new forum post
forum.threads
  .create({
    name: 'Food Talk',
    autoArchiveDuration: ThreadAutoArchiveDuration.OneHour,
    message: {
     content: 'Discuss your favorite food!',
    },
    reason: 'Needed a separate thread for food',
  })
  .then(threadChannel => console.log(threadChannel))
  .catch(console.error);

Name	Type	Optional	Description
options	GuildForumThreadCreateOptions	No	Options to create a new thread

fetch(options, cacheOptions?):Promise<AnyThreadChannel | null>

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

Returns

FetchedThreads if active & FetchedThreadsMore if archived.

Example

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

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

Name	Type	Optional	Description
options	ThreadChannelResolvable	No	The options to fetch threads. If it is a ThreadChannelResolvable then the specified thread will be fetched. Fetches all active threads if `undefined`
cacheOptions	BaseFetchOptions	Yes	Additional options for this fetch. The `force` field gets ignored if `options` is not a ThreadChannelResolvable

fetchActive(cache?):Promise<FetchedThreads>

Obtains all active threads in the channel.

Name	Type	Optional	Description
cache	boolean	Yes	Whether to cache the fetched data

Inherited from ThreadManager

fetchArchived(options?, cache?):Promise<FetchedThreadsMore>

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

Name	Type	Optional	Description
options	FetchArchivedThreadOptions	Yes	The options to fetch archived threads
cache	boolean	Yes	Whether to cache the new thread objects if they aren't already

Inherited from ThreadManager

resolve(thread):ThreadChannel

Resolves a ThreadChannelResolvable to a ThreadChannel object.

Name	Type	Optional	Description
thread	ThreadChannelResolvable	No	The ThreadChannel resolvable to resolve

Inherited from ThreadManager

resolveId(thread):Snowflake

Resolves a ThreadChannelResolvable to a ThreadChannel id.

Name	Type	Optional	Description
thread	ThreadChannelResolvable	No	The ThreadChannel resolvable to resolve

Inherited from ThreadManager

valueOf():Collection<Key, Holds>