Class ForumThread<T>

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

Type Parameters

T extends ForumChannel

Hierarchy (view full)

Base<number>
- ForumThread

Index

Constructors

constructor

new ForumThread<T>(data, client): ForumThread<T>
Type Parameters
- T extends ForumChannel
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
    
    Description
    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
    
    Description
    The ID of the channel
  - content: string
    Content Format: long-form markdown
    
    Description
    The content of the forum topic
  - createdAt: string
    Created at Format: date-time
    
    Description
    The ISO 8601 timestamp that the forum topic was created at
  - createdBy: string
    Created by
    
    Description
    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
    
    Description
    The ID of the group
  - id: number
    Description
    The ID of the forum topic
  - isLocked: boolean
    Is locked
    Default
    false
  - isPinned: boolean
    Is pinned
    Default
    false
  - Optionalmentions?: {
        channels?: {
            id: string;
        }[];
        everyone?: boolean;
        here?: boolean;
        roles?: {
            id: number;
        }[];
        users?: {
            id: string;
        }[];
    }
    - Optionalchannels?: {
      id: string;
      }[]
      Channels
      
      Description
      Info on mentioned channels
    - Optionaleveryone?: boolean
      Everyone
      
      Description
      If
      
      Everyone
      was mentioned
    - Optionalhere?: boolean
      Here
      
      Description
      If
      
      Here
      was mentioned
    - Optionalroles?: {
      id: number;
      }[]
      Roles
      
      Description
      Info on mentioned roles
    - Optionalusers?: {
      id: string;
      }[]
      Users
      
      Description
      Info on mentioned users
  - serverId: string
    Server ID
    
    Description
    The ID of the server
  - title: string
    Title
    
    Description
    The title of the forum topic
  - OptionalupdatedAt?: string
    Updated at Format: date-time
    
    Description
    The ISO 8601 timestamp that the forum topic was updated at, if relevant
- client: Client
  client
Returns ForumThread<T>
Overrides Base.constructor
- Defined in lib/structures/ForumThread.ts:61

Properties

bumpedAt

bumpedAt: null | Date

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

channelID

channelID: string

Forum channel id

client

client: Client

App's client.

comments

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

Description
The ID of the channel
content: string
Content Format: long-form markdown

Description
The content of the forum topic comment
createdAt: string
Created at Format: date-time

Description
The ISO 8601 timestamp that the forum topic comment was created at
createdBy: string
Created by

Description
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
Description
The ID of the forum topic
id: number
Description
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
  
  Description
  Info on mentioned channels
- Optionaleveryone?: boolean
  Everyone
  
  Description
  If
  
  Everyone
  was mentioned
- Optionalhere?: boolean
  Here
  
  Description
  If
  
  Here
  was mentioned
- Optionalroles?: {
  id: number;
  }[]
  Roles
  
  Description
  Info on mentioned roles
- Optionalusers?: {
  id: string;
  }[]
  Users
  
  Description
  Info on mentioned users
OptionalupdatedAt?: string
Updated at Format: date-time

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

content

content: string

Content of the thread

createdAt

createdAt: Date

When this forum thread was created.

editedTimestamp

editedTimestamp: null | Date

Timestamp at which this channel was last edited.

guildID

guildID: string

Guild ID

id

id: number

Item ID

isLocked

isLocked: boolean

If true, the thread is locked.

isPinned

isPinned: boolean

If true, the thread is pinned.

mentions

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

Thread mentions

Type declaration

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

Description
Info on mentioned channels
Optionaleveryone?: boolean
Everyone

Description
If

Everyone
was mentioned
Optionalhere?: boolean
Here

Description
If

Here
was mentioned
Optionalroles?: {
id: number;
}[]
Roles

Description
Info on mentioned roles
Optionalusers?: {
id: string;
}[]
Users

Description
Info on mentioned users

name

name: string

Name of the thread

owner

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

Owner of this thread, if cached.

ownerID

ownerID: string

The ID of the owner of this thread.

Accessors

channel

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

Returns T extends TextChannel
? T<T>
: undefined
- Defined in lib/structures/ForumThread.ts:125

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
- Defined in lib/structures/ForumThread.ts:134

Methods

createForumComment

createForumComment(options): Promise<ForumThreadComment>
Add a comment to this forum thread.
Parameters
- options: CreateForumCommentOptions
  Options of the comment.
Returns Promise<ForumThreadComment>
- Defined in lib/structures/ForumThread.ts:147

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>
- Defined in lib/structures/ForumThread.ts:158

delete

delete(): Promise<void>
Delete this forum thread.

Returns Promise<void>
- Defined in lib/structures/ForumThread.ts:168

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>
- Defined in lib/structures/ForumThread.ts:178

edit

edit(options): Promise<ForumThread<T>>
Edit the forum thread.
Parameters
- options: EditForumThreadOptions
  Edit options.
Returns Promise<ForumThread<T>>
- Defined in lib/structures/ForumThread.ts:190

lock

lock(): Promise<void>
Lock this forum thread.

Returns Promise<void>
- Defined in lib/structures/ForumThread.ts:199

pin(): Promise<void>
Pin this forum thread.

Returns Promise<void>
- Defined in lib/structures/ForumThread.ts:204

toJSON

toJSON(): JSONForumThread<T>
Returns JSONForumThread<T>
Overrides Base.toJSON
- Defined in lib/structures/ForumThread.ts:208

unlock

unlock(): Promise<void>
Unlock this forum thread.

Returns Promise<void>
- Defined in lib/structures/ForumThread.ts:228

unpin

unpin(): Promise<void>
Unpin this forum thread.

Returns Promise<void>
- Defined in lib/structures/ForumThread.ts:233

Class ForumThread<T>

Type Parameters

Hierarchy (view full)

Index

Constructors

Properties

Accessors

Methods

Constructors

constructor

Type Parameters

Parameters

OptionalbumpedAt?: string

Description

channelId: string

Description

content: string

Description

createdAt: string

Description

createdBy: string

Description

groupId: string

Description

id: number

Description

isLocked: boolean

Default

isPinned: boolean

Default

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

Optionalchannels?: { id: string; }[]

Description

Optionaleveryone?: boolean

Description

Everyone

Optionalhere?: boolean

Description

Here

Optionalroles?: { id: number; }[]

Description

Optionalusers?: { id: string; }[]

Description

serverId: string

Description

title: string

Description

OptionalupdatedAt?: string

Description

Returns ForumThread<T>

Properties

bumpedAt

channelID

client

comments

Type declaration

channelId: string

Description

content: string

Description

createdAt: string

Description

createdBy: string

Description

forumTopicId: number

Description

id: number

Description

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

Optionalchannels?: { id: string; }[]

Description

Optionaleveryone?: boolean

Description

Everyone

Optionalhere?: boolean

Description

Here

Optionalroles?: { id: number; }[]

Description

Optionalusers?: { id: string; }[]

`Optional`bumpedAt?: string

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

`Optional`channels?: {
id: string;
}[]

`Optional`everyone?: boolean

`Optional`here?: boolean

`Optional`roles?: {
id: number;
}[]

`Optional`users?: {
id: string;
}[]

`Optional`updatedAt?: string

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

`Optional`channels?: {
id: string;
}[]

`Optional`everyone?: boolean

`Optional`here?: boolean

`Optional`roles?: {
id: number;
}[]

`Optional`users?: {
id: string;
}[]

`Optional`updatedAt?: string

`Optional`channels?: {
id: string;
}[]

`Optional`everyone?: boolean

`Optional`here?: boolean

`Optional`roles?: {
id: number;
}[]

`Optional`users?: {
id: string;
}[]

Returns T extends TextChannel
? T<T>
: undefined

Returns T extends Guild
? Guild
: null | Guild