Class
A thread inside a text, announcement, forum, or media channel. Threads are text-capable channels: use send the same way as a text channel.
Extends TextCapable(GuildChannel)
new ThreadChannel(client: Client, data: APIChannel)ClientAPIChannel| Name | Type | Description |
|---|---|---|
| appliedTags | string[] | Tag IDs applied to a forum or media post. |
| archived | boolean | Whether the thread is archived. |
| archiveTimestamp | string | null | ISO-8601 timestamp when the archive status last changed. |
| autoArchiveDuration | number | Minutes of inactivity before the thread archives. |
| flags | number | Channel flags bitfield. |
| invitable | boolean | null | Whether non-moderators can add other non-moderators. Private threads only. |
| lastMessageId | string | null | ID of the last message sent in this thread. |
| locked | boolean | Whether only moderators can unarchive the thread. |
| member | ThreadMember | null | The current user's membership, when the payload included it. |
| memberCount | number | Approximate member count, capped at 50. |
| membersread-only | ThreadMemberManager | Add, remove, and list members of this thread. |
| messageCount | number | Messages in the thread, excluding the starter and deleted messages. |
| ownerId | string | null | User who created the thread. |
| parentId | string | null | Parent channel ID. |
| rateLimitPerUser | number | Slowmode in seconds. |
| totalMessageSent | number | Messages ever sent in the thread. This count is never decremented. |
options: ThreadEditOptions | ChannelEditOptions → Promise<this>
Edit this thread. Requires Manage Threads on public threads, or ownership on private ones. appliedTags is sent for public and announcement threads. invitable is sent for private threads.
await message.thread.edit(options);options: ThreadMemberSettingsOptions → Promise<ThreadMember | null>
Update the current user's notification settings for this thread.
await message.thread.editSelf(options);→ Promise<void>
Join this thread.
await message.thread.join();→ Promise<void>
Leave this thread.
await message.thread.leave();archived: boolean, reason?: string → Promise<this>
Archive or unarchive this thread.
await message.thread.setArchived(archived);locked: boolean, reason?: string → Promise<this>
Lock or unlock this thread. Locked threads can only be unarchived by moderators.
await message.thread.setLocked(locked);