Interface EditForumChannelOptions

interface EditForumChannelOptions {
    availableTags?: (Omit<ForumTag, "id"> & {
        id?: string;
    })[];
    defaultForumLayout?: ForumLayoutTypes;
    defaultReactionEmoji?: null | ForumEmoji;
    defaultSortOrder?: SortOrderTypes;
    defaultThreadRateLimitPerUser?: number;
    flags?: number;
    name?: string;
    nsfw?: null | string;
    permissionOverwrites?: null | OverwriteOptions[];
    position?: null | number;
    rateLimitPerUser?: null | number;
    reason?: string;
    topic?: null | string;
}

Hierarchy (view full)

Properties

availableTags? defaultForumLayout? defaultReactionEmoji? defaultSortOrder? defaultThreadRateLimitPerUser? flags? name? nsfw? permissionOverwrites? position? rateLimitPerUser? reason? topic?

Properties

Optional availableTags

availableTags?: (Omit<ForumTag, "id"> & {
    id?: string;
})[]

[Forum] The tags available in the channel. A maximum of 20 can be present.

Optional defaultForumLayout

defaultForumLayout?: ForumLayoutTypes

[Forum] The default forum layout used to display threads.

Optional defaultReactionEmoji

defaultReactionEmoji?: null | ForumEmoji

[Forum] The default reaction emoji for threads.

Optional defaultSortOrder

defaultSortOrder?: SortOrderTypes

[Forum] The default sort order mode used to sort forum threads.

Optional defaultThreadRateLimitPerUser

defaultThreadRateLimitPerUser?: number

[Text, Forum] The default reaction emoji for threads.

Optional flags

flags?: number

[Forum, Forum Thread] The Channel Flags to set on the channel.

Optional name

name?: string

The name of the channel.

Optional nsfw

nsfw?: null | string

[Announcement, Text, Voice] If the channel is age gated.

Optional permissionOverwrites

permissionOverwrites?: null | OverwriteOptions[]

Channel or category specific permissions.

Optional position

position?: null | number

The position of the channel in the channel list.

Optional rateLimitPerUser

rateLimitPerUser?: null | number

[Forum, Text, Thread] The seconds between sending messages for users. Between 0 and 21600.

Optional reason

reason?: string

The reason to be displayed in the audit log.

Optional topic

topic?: null | string

[Announcement, Forum, Text, Voice] The topic of the channel. In forum channels, this is the Guidelines section.

Settings

Member Visibility

Theme

On This Page

availableTagsdefaultForumLayoutdefaultReactionEmojidefaultSortOrderdefaultThreadRateLimitPerUserflagsnamensfwpermissionOverwritespositionrateLimitPerUserreasontopic