ForumChannel

export class ForumChannel extends ThreadOnlyChannel
export class ForumChannel extends ThreadOnlyChannel
Represents a forum channel.
availableTags:GuildForumTag[]
The set of tags that can be used in this channel.
Inherited from ThreadOnlyChannel
defaultAutoArchiveDuration:ThreadAutoArchiveDuration | null
The default auto archive duration for newly created threads in this channel.
Inherited from ThreadOnlyChannel
defaultForumLayout:ForumLayoutType
The default layout type used to display posts
defaultReactionEmoji:DefaultReactionEmoji | null
The emoji to show in the add reaction button on a thread in a guild forum channel
Inherited from ThreadOnlyChannel
defaultSortOrder:SortOrderType | null
The default sort order mode used to order posts
Inherited from ThreadOnlyChannel
defaultThreadRateLimitPerUser:number | null
The initial rate limit per user (slowmode) to set on newly created threads in a channel.
Inherited from ThreadOnlyChannel
nsfw:boolean
If this channel is considered NSFW.
Inherited from ThreadOnlyChannel
rateLimitPerUser:number | null
The rate limit per user (slowmode) for this channel.
Inherited from ThreadOnlyChannel
A manager of the threads belonging to this channel
Inherited from ThreadOnlyChannel
topic:string | null
The topic of this channel.
Inherited from ThreadOnlyChannel
The type of the channel
createInvite(options?):Promise<Invite>
Creates an invite to this guild channel.
NameTypeOptionalDescription
optionsInviteCreateOptionsYesThe options for creating the invite
Inherited from ThreadOnlyChannel
fetchInvites(cache?):Promise<Collection<string, Invite>>
Fetches a collection of invites to this guild channel. Resolves with a collection mapping invites by their codes.
NameTypeOptionalDescription
cachebooleanYesWhether to cache the fetched invites
Inherited from ThreadOnlyChannel
setAvailableTags(availableTags, reason?):Promise<this>
Sets the available tags for this forum channel
NameTypeOptionalDescription
availableTagsGuildForumTagData[]NoThe tags to set as available in this channel
reasonstringYesReason for changing the available tags
Inherited from ThreadOnlyChannel
setDefaultAutoArchiveDuration(defaultAutoArchiveDuration, reason?):Promise<this>
Sets the default auto archive duration for all newly created threads in this channel.
NameTypeOptionalDescription
defaultAutoArchiveDurationThreadAutoArchiveDurationNoThe new default auto archive duration
reasonstringYesReason for changing the channel's default auto archive duration
Inherited from ThreadOnlyChannel
setDefaultForumLayout(defaultForumLayout, reason?):Promise<this>
Sets the default forum layout type used to display posts
NameTypeOptionalDescription
defaultForumLayoutForumLayoutTypeNoThe default forum layout type to set on this channel
reasonstringYesReason for changing the default forum layout
setDefaultReactionEmoji(defaultReactionEmoji, reason?):Promise<this>
Sets the default reaction emoji for this channel
NameTypeOptionalDescription
defaultReactionEmojiDefaultReactionEmoji | nullNoThe emoji to set as the default reaction emoji
reasonstringYesReason for changing the default reaction emoji
Inherited from ThreadOnlyChannel
setDefaultSortOrder(defaultSortOrder, reason?):Promise<this>
Sets the default sort order mode used to order posts
NameTypeOptionalDescription
defaultSortOrderSortOrderType | nullNoThe default sort order mode to set on this channel
reasonstringYesReason for changing the default sort order
Inherited from ThreadOnlyChannel
setDefaultThreadRateLimitPerUser(defaultThreadRateLimitPerUser, reason?):Promise<this>
Sets the default rate limit per user (slowmode) for new threads in this channel
NameTypeOptionalDescription
defaultThreadRateLimitPerUsernumberNoThe rate limit to set on newly created threads in this channel
reasonstringYesReason for changing the default rate limit
Inherited from ThreadOnlyChannel
setTopic(topic, reason?):Promise<this>
Sets a new topic for the guild channel.
NameTypeOptionalDescription
topicstring | nullNoThe new topic for the guild channel
reasonstringYesReason for changing the guild channel's topic
Inherited from ThreadOnlyChannel