ThreadManager
Defined in: packages/managers/src/thread.ts:45
Manages thread resources created from a parent channel.
Constructors
Section titled “Constructors”Constructor
Section titled “Constructor”new ThreadManager(
rest,context,channelId,allowedMentions?):ThreadManager
Defined in: packages/managers/src/thread.ts:51
Creates a thread manager.
Parameters
Section titled “Parameters”REST transport.
context
Section titled “context”Structure resource context.
channelId
Section titled “channelId”string
Parent channel identifier.
allowedMentions?
Section titled “allowedMentions?”AllowedMentions
Default allowed_mentions for a forum post’s first message without its own.
Returns
Section titled “Returns”ThreadManager
Throws
Section titled “Throws”If channelId is empty.
Methods
Section titled “Methods”addMember()
Section titled “addMember()”addMember(
threadId,userId):Promise<void>
Defined in: packages/managers/src/thread.ts:188
Adds a member to a thread.
Parameters
Section titled “Parameters”threadId
Section titled “threadId”string
userId
Section titled “userId”string
Returns
Section titled “Returns”Promise<void>
create()
Section titled “create()”create(
options):Promise<Channel>
Defined in: packages/managers/src/thread.ts:87
Starts a thread that is not attached to a message: a private thread
(type: 12, the default) or a public one (type: 11) in a text or
announcement channel.
Parameters
Section titled “Parameters”options
Section titled “options”ThreadCreateOptions & object
Returns
Section titled “Returns”Promise<Channel>
createForumPost()
Section titled “createForumPost()”createForumPost(
options):Promise<Channel>
Defined in: packages/managers/src/thread.ts:113
Posts to a forum or media channel: one request creates the thread and its
first message. message takes everything send() does, files included.
Parameters
Section titled “Parameters”options
Section titled “options”ThreadCreateOptions & object
Returns
Section titled “Returns”Promise<Channel>
createFromMessage()
Section titled “createFromMessage()”createFromMessage(
messageId,options):Promise<Channel>
Defined in: packages/managers/src/thread.ts:64
Creates a thread from a message.
Parameters
Section titled “Parameters”messageId
Section titled “messageId”string
Message identifier.
options
Section titled “options”Thread creation options.
autoArchiveDuration?
Section titled “autoArchiveDuration?”60 | 1440 | 4320 | 10080
string
rateLimitPerUser?
Section titled “rateLimitPerUser?”number
Returns
Section titled “Returns”Promise<Channel>
Created thread channel.
Throws
Section titled “Throws”If REST rejects the request.
fetchArchived()
Section titled “fetchArchived()”fetchArchived(
scope,options?):Promise<ArchivedThreads>
Defined in: packages/managers/src/thread.ts:145
Lists archived threads of this channel, newest first. joined-private
is the private archived threads the bot is a member of.
Parameters
Section titled “Parameters”ArchivedThreadScope
options?
Section titled “options?”before?
Section titled “before?”string
limit?
Section titled “limit?”number
Returns
Section titled “Returns”Promise<ArchivedThreads>
fetchMember()
Section titled “fetchMember()”fetchMember(
threadId,userId,query?):Promise<APIThreadMember&object>
Defined in: packages/managers/src/thread.ts:198
Fetches one thread member; rejects with a 404 when they have not joined.
Parameters
Section titled “Parameters”threadId
Section titled “threadId”string
userId
Section titled “userId”string
query?
Section titled “query?”ThreadMemberQuery = {}
Returns
Section titled “Returns”Promise<APIThreadMember & object>
fetchMembers()
Section titled “fetchMembers()”fetchMembers(
threadId,options?):Promise<APIThreadMember[]>
Defined in: packages/managers/src/thread.ts:210
Lists thread members (needs the Guild Members intent), one page at a time (limit 1-100).
Parameters
Section titled “Parameters”threadId
Section titled “threadId”string
options?
Section titled “options?”ThreadMemberQuery & object = {}
Returns
Section titled “Returns”Promise<APIThreadMember[]>
join()
Section titled “join()”join(
threadId):Promise<void>
Defined in: packages/managers/src/thread.ts:178
Joins a thread as the bot.
Parameters
Section titled “Parameters”threadId
Section titled “threadId”string
Returns
Section titled “Returns”Promise<void>
leave()
Section titled “leave()”leave(
threadId):Promise<void>
Defined in: packages/managers/src/thread.ts:183
Leaves a thread as the bot.
Parameters
Section titled “Parameters”threadId
Section titled “threadId”string
Returns
Section titled “Returns”Promise<void>
removeMember()
Section titled “removeMember()”removeMember(
threadId,userId):Promise<void>
Defined in: packages/managers/src/thread.ts:193
Removes a member from a thread.
Parameters
Section titled “Parameters”threadId
Section titled “threadId”string
userId
Section titled “userId”string
Returns
Section titled “Returns”Promise<void>