Class ForumThread<T>

constructor

• new ForumThread<T>(data, client): ForumThread<T>

• Type Parameters

  • T extends ForumChannel<T>

  Parameters

  • data: APIForumTopic

    raw data

  • client: Client

    client

  Returns ForumThread<T>

bumpedAt

channelID

comments

content

createdAt

editedTimestamp

guildID

isLocked

isPinned

mentions

name

owner

ownerID

channel

• get channel(): T extends TextChannel
      ? T
      : undefined

• The forum channel this thread was created in.

  Returns T extends TextChannel
      ? T
      : undefined

guild

• get guild(): T extends Guild
      ? Guild
      : null | Guild

• The guild the thread is in. This will throw an error if the guild isn't cached.

  Returns T extends Guild
      ? Guild
      : null | Guild

createForumComment

• createForumComment(options): Promise<ForumThreadComment>

• Add a comment to this forum thread.

  Parameters

  • options: CreateForumCommentOptions

    Options of the comment.

  Returns Promise<ForumThreadComment>

createReaction

• createReaction(emoteID): Promise<void>

• Add a reaction to this forum thread.

  Parameters

  • emoteID: number

    ID of the emote to be added.

  Returns Promise<void>

delete

• delete(): Promise<void>

• Delete this forum thread.

  Returns Promise<void>

deleteReaction

• deleteReaction(emoteID): Promise<void>

• Remove a reaction from this forum thread.

  Parameters

  • emoteID: number

    ID of the emote to be added.

  Returns Promise<void>

edit

• edit(options): Promise<ForumThread<T>>

• Edit the forum thread.

  Parameters

  • options: EditForumThreadOptions

    Edit options.

  Returns Promise<ForumThread<T>>

lock

• lock(): Promise<void>

• Lock this forum thread.

  Returns Promise<void>

pin

• pin(): Promise<void>

• Pin this forum thread.

  Returns Promise<void>

toJSON

• toJSON(): JSONForumThread

• Returns JSONForumThread

unlock

• unlock(): Promise<void>

• Unlock this forum thread.

  Returns Promise<void>

unpin

• unpin(): Promise<void>

• Unpin this forum thread.

  Returns Promise<void>