Interface CreateChannelOptions<T>

interface CreateChannelOptions<T> {
    availableTags?: null | Omit<ForumTag, "id">[];
    bitrate?: null | number;
    defaultAutoArchiveDuration?: null | 60 | 1440 | 4320 | 10080;
    defaultForumLayout?: ForumLayoutTypes;
    defaultReactionEmoji?: null | ForumEmoji;
    defaultSortOrder?: null | SortOrderTypes;
    name: string;
    nsfw?: null | boolean;
    parentID?: null | string;
    permissionOverwrites?: null | OverwriteOptions[];
    position?: null | number;
    rateLimitPerUser?: null | number;
    reason?: string;
    rtcRegion?: null | string;
    topic?: null | string;
    type: T;
    userLimit?: null | number;
    videoQualityMode?: null | VideoQualityModes;
}

Type Parameters

Properties

availableTags? bitrate? defaultAutoArchiveDuration? defaultForumLayout? defaultReactionEmoji? defaultSortOrder? name nsfw? parentID? permissionOverwrites? position? rateLimitPerUser? reason? rtcRegion? topic? type userLimit? videoQualityMode?

Properties

Optional availableTags

availableTags?: null | Omit<ForumTag, "id">[]

[Forum] The tags available in the channel.

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 the 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?: null | SortOrderTypes

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

name

name: string

The name of the channel.

Optional nsfw

nsfw?: null | boolean

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

Optional parentID

parentID?: null | string

The ID of the category to put this channel in.

Optional permissionOverwrites

permissionOverwrites?: null | OverwriteOptions[]

The permission overwrites to apply to the channel.

Optional position

position?: null | number

The position of the channel.

Optional rateLimitPerUser

rateLimitPerUser?: null | number

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

Optional reason

reason?: string

The reason for creating the channel.

Optional rtcRegion

rtcRegion?: null | string

[Stage, Voice] The voice region for the channel.

Optional topic

topic?: null | string

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

type

type: T

The type of channel to create.

Optional userLimit

userLimit?: null | number

[Voice] The maximum number of users that can be in the channel. Between 0 and 99.

Optional videoQualityMode

videoQualityMode?: null | VideoQualityModes

[Voice] The video quality mode for the channel.

Settings

Member Visibility

Theme

On This Page

availableTagsbitratedefaultAutoArchiveDurationdefaultForumLayoutdefaultReactionEmojidefaultSortOrdernamensfwparentIDpermissionOverwritespositionrateLimitPerUserreasonrtcRegiontopictypeuserLimitvideoQualityMode