Interface EditChannelOptions

interface EditChannelOptions {
    appliedTags?: string[];
    archived?: boolean;
    autoArchiveDuration?: 60 | 1440 | 4320 | 10080;
    availableTags?: (Omit<ForumTag, "id"> & {
        id?: string;
    })[];
    bitrate?: null | number;
    defaultAutoArchiveDuration?: null | 60 | 1440 | 4320 | 10080;
    defaultForumLayout?: ForumLayoutTypes;
    defaultReactionEmoji?: null | ForumEmoji;
    defaultSortOrder?: SortOrderTypes;
    defaultThreadRateLimitPerUser?: number;
    flags?: number;
    icon?: string | Buffer;
    invitable?: boolean;
    locked?: boolean;
    name?: string;
    nsfw?: null | string;
    parentID?: null | string;
    permissionOverwrites?: null | OverwriteOptions[];
    position?: null | number;
    rateLimitPerUser?: null | number;
    reason?: string;
    rtcRegion?: null | string;
    topic?: null | string;
    type?: GUILD_TEXT | GUILD_ANNOUNCEMENT;
    userLimit?: null | number;
    videoQualityMode?: null | VideoQualityModes;
}

Hierarchy (view full)

Properties

appliedTags? archived? autoArchiveDuration? availableTags? bitrate? defaultAutoArchiveDuration? defaultForumLayout? defaultReactionEmoji? defaultSortOrder? defaultThreadRateLimitPerUser? flags? icon? invitable? locked? name? nsfw? parentID? permissionOverwrites? position? rateLimitPerUser? reason? rtcRegion? topic? type? userLimit? videoQualityMode?

Properties

Optional appliedTags

appliedTags?: string[]

[Forum Thread] The ID of the forum available tags applied on the channel. A maximum of 5 can be applied.

Optional archived

archived?: boolean

[Thread] If the thread is archived.

Optional autoArchiveDuration

autoArchiveDuration?: 60 | 1440 | 4320 | 10080

[Thread] The duration after which the thread will be archived.

Optional availableTags

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

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

Optional bitrate

bitrate?: null | number

[Stage, Voice] The bitrate of the channel. Minimum 8000.

Optional defaultAutoArchiveDuration

defaultAutoArchiveDuration?: null | 60 | 1440 | 4320 | 10080

[Announcement, Text] The default auto archive duration for threads made in this channel.

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 icon

icon?: string | Buffer

[Group DM] The icon of the channel.

Optional invitable

invitable?: boolean

[Private Thread] If non-moderators can add other non-moderators to the thread.

Optional locked

locked?: boolean

[Thread] If the thread should be locked.

Optional name

name?: string

The name of the channel.

Optional nsfw

nsfw?: null | string

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

Optional parentID

parentID?: null | string

[Announcement, Forum, Text, Voice] The id of the parent category channel.

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 rtcRegion

rtcRegion?: null | string

[Stage, Voice] The voice region id of the channel, null for automatic.

Optional topic

topic?: null | string

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

Optional type

type?: GUILD_TEXT | GUILD_ANNOUNCEMENT

[Announcement, Text] Provide the opposite type to convert the channel.

Optional userLimit

userLimit?: null | number

[Voice] The maximum amount of users in the channel. 0 is unlimited, values range 1-99.

Optional videoQualityMode

videoQualityMode?: null | VideoQualityModes

[Voice] The video quality mode of the channel.

Settings

Member Visibility

Theme

On This Page

appliedTagsarchivedautoArchiveDurationavailableTagsbitratedefaultAutoArchiveDurationdefaultForumLayoutdefaultReactionEmojidefaultSortOrderdefaultThreadRateLimitPerUserflagsiconinvitablelockednamensfwparentIDpermissionOverwritespositionrateLimitPerUserreasonrtcRegiontopictypeuserLimitvideoQualityMode