No summary provided.
constructor(rest)
Constructs a new instance of the
ThreadsAPI class| Name | Type | Optional | Description |
|---|---|---|---|
| rest | REST | No | None |
Adds a member to a thread
create(channelId, body, messageId?, { signal }?)
:
Promise<import("discord-api-types/v10").APIChannel>
Creates a new thread
| Name | Type | Optional | Description |
|---|---|---|---|
| channelId | Snowflake | No | The id of the channel to start the thread in |
| body | RESTPostAPIChannelThreadsJSONBody | No | The data to use when starting the thread |
| messageId | Snowflake | Yes | The id of the message to start the thread from |
| { signal } | Pick<RequestData, 'signal'> | Yes | None |
Creates a new forum post
| Name | Type | Optional | Description |
|---|---|---|---|
| channelId | Snowflake | No | The id of the forum channel to start the thread in |
| { message, ...optionsBody } | StartForumThreadOptions | No | None |
| { signal } | Pick<RequestData, 'signal'> | Yes | None |
Fetches a thread
| Name | Type | Optional | Description |
|---|---|---|---|
| threadId | Snowflake | No | The id of the thread |
| { signal } | Pick<RequestData, 'signal'> | Yes | None |
Fetches all members of a thread
| Name | Type | Optional | Description |
|---|---|---|---|
| threadId | Snowflake | No | The id of the thread to fetch the members from |
| { signal } | Pick<RequestData, 'signal'> | Yes | None |
Fetches a member of a thread
Adds the current user to a thread
| Name | Type | Optional | Description |
|---|---|---|---|
| threadId | Snowflake | No | The id of the thread to join |
| { signal } | Pick<RequestData, 'signal'> | Yes | None |
Removes the current user from a thread
| Name | Type | Optional | Description |
|---|---|---|---|
| threadId | Snowflake | No | The id of the thread to leave |
| { signal } | Pick<RequestData, 'signal'> | Yes | None |
Removes a member from a thread