Represents a thread/topic coming from a "Forums" channel.

Type Parameters

Hierarchy (view full)

  • Base<number>
    • ForumThread

Constructors

  • Type Parameters

    Parameters

    • data: {
          bumpedAt?: string;
          channelId: string;
          content: string;
          createdAt: string;
          createdBy: string;
          groupId: string;
          id: number;
          isLocked: boolean;
          isPinned: boolean;
          mentions?: {
              channels?: {
                  id: string;
              }[];
              everyone?: boolean;
              here?: boolean;
              roles?: {
                  id: number;
              }[];
              users?: {
                  id: string;
              }[];
          };
          serverId: string;
          title: string;
          updatedAt?: string;
      }

      raw data

      • OptionalbumpedAt?: string

        Bumped at Format: date-time

        The ISO 8601 timestamp that the forum topic was bumped at. This timestamp is updated whenever there is any activity on the posts within the forum topic.

      • channelId: string

        Channel ID Format: uuid

        The ID of the channel

      • content: string

        Content Format: long-form markdown

        The content of the forum topic

      • createdAt: string

        Created at Format: date-time

        The ISO 8601 timestamp that the forum topic was created at

      • createdBy: string

        Created by

        The ID of the user who created this forum topic (Note: If this event has createdByWebhookId present, this field will still be populated, but can be ignored. In this case, the value of this field will always be Ann6LewA)

      • groupId: string

        Group ID

        The ID of the group

      • id: number

        The ID of the forum topic

      • isLocked: boolean

        Is locked

        false
        
      • isPinned: boolean

        Is pinned

        false
        
      • Optionalmentions?: {
            channels?: {
                id: string;
            }[];
            everyone?: boolean;
            here?: boolean;
            roles?: {
                id: number;
            }[];
            users?: {
                id: string;
            }[];
        }
        • Optionalchannels?: {
              id: string;
          }[]

          Channels

          Info on mentioned channels

        • Optionaleveryone?: boolean

          Everyone

          If

          was mentioned

        • Optionalhere?: boolean

          Here

          If

          was mentioned

        • Optionalroles?: {
              id: number;
          }[]

          Roles

          Info on mentioned roles

        • Optionalusers?: {
              id: string;
          }[]

          Users

          Info on mentioned users

      • serverId: string

        Server ID

        The ID of the server

      • title: string

        Title

        The title of the forum topic

      • OptionalupdatedAt?: string

        Updated at Format: date-time

        The ISO 8601 timestamp that the forum topic was updated at, if relevant

    • client: Client

      client

    Returns ForumThread<T>

Properties

bumpedAt: null | Date

Timestamp (unix epoch time) that the forum thread was bumped at.

channelID: string

Forum channel id

client: Client

App's client.

comments: TypedCollection<number, {
    channelId: string;
    content: string;
    createdAt: string;
    createdBy: string;
    forumTopicId: number;
    id: number;
    mentions?: {
        channels?: {
            id: string;
        }[];
        everyone?: boolean;
        here?: boolean;
        roles?: {
            id: number;
        }[];
        users?: {
            id: string;
        }[];
    };
    updatedAt?: string;
}, ForumThreadComment, []>

Cached comments.

Type declaration

  • channelId: string

    Channel ID Format: uuid

    The ID of the channel

  • content: string

    Content Format: long-form markdown

    The content of the forum topic comment

  • createdAt: string

    Created at Format: date-time

    The ISO 8601 timestamp that the forum topic comment was created at

  • createdBy: string

    Created by

    The ID of the user who created this forum topic comment (Note: If this event has createdByWebhookId present, this field will still be populated, but can be ignored. In this case, the value of this field will always be Ann6LewA)

  • forumTopicId: number

    The ID of the forum topic

  • id: number

    The ID of the forum topic comment

  • Optionalmentions?: {
        channels?: {
            id: string;
        }[];
        everyone?: boolean;
        here?: boolean;
        roles?: {
            id: number;
        }[];
        users?: {
            id: string;
        }[];
    }
    • Optionalchannels?: {
          id: string;
      }[]

      Channels

      Info on mentioned channels

    • Optionaleveryone?: boolean

      Everyone

      If

      was mentioned

    • Optionalhere?: boolean

      Here

      If

      was mentioned

    • Optionalroles?: {
          id: number;
      }[]

      Roles

      Info on mentioned roles

    • Optionalusers?: {
          id: string;
      }[]

      Users

      Info on mentioned users

  • OptionalupdatedAt?: string

    Updated at Format: date-time

    The ISO 8601 timestamp that the forum topic comment was updated at, if relevant

content: string

Content of the thread

createdAt: Date

When this forum thread was created.

editedTimestamp: null | Date

Timestamp at which this channel was last edited.

guildID: string

Guild ID

id: number

Item ID

isLocked: boolean

If true, the thread is locked.

isPinned: boolean

If true, the thread is pinned.

mentions: null | {
    channels?: {
        id: string;
    }[];
    everyone?: boolean;
    here?: boolean;
    roles?: {
        id: number;
    }[];
    users?: {
        id: string;
    }[];
}

Thread mentions

Type declaration

  • Optionalchannels?: {
        id: string;
    }[]

    Channels

    Info on mentioned channels

  • Optionaleveryone?: boolean

    Everyone

    If

    was mentioned

  • Optionalhere?: boolean

    Here

    If

    was mentioned

  • Optionalroles?: {
        id: number;
    }[]

    Roles

    Info on mentioned roles

  • Optionalusers?: {
        id: string;
    }[]

    Users

    Info on mentioned users

name: string

Name of the thread

owner: T extends Guild
    ? Member
    :
        | undefined
        | User
        | Member
        | Promise<Member>

Owner of this thread, if cached.

ownerID: string

The ID of the owner of this thread.

Accessors

  • get channel(): T extends TextChannel
        ? T<T>
        : undefined
  • The forum channel this thread was created in.

    Returns T extends TextChannel
        ? T<T>
        : undefined

  • 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

Methods

  • Add a reaction to this forum thread.

    Parameters

    • emoteID: number

      ID of the emote to be added.

    Returns Promise<void>

  • Delete this forum thread.

    Returns Promise<void>

  • Remove a reaction from this forum thread.

    Parameters

    • emoteID: number

      ID of the emote to be added.

    Returns Promise<void>

  • Lock this forum thread.

    Returns Promise<void>

  • Pin this forum thread.

    Returns Promise<void>

  • Unlock this forum thread.

    Returns Promise<void>

  • Unpin this forum thread.

    Returns Promise<void>