Skip to main content

ModifyChannel

@discordeno/bot

Documentation / @discordeno/bot / ModifyChannel

Interface: ModifyChannel

Defined in: packages/types/dist/types/discordeno.d.ts:607

Properties​

appliedTags?​

optional appliedTags: BigString[]

Defined in: packages/types/dist/types/discordeno.d.ts:813

The IDs of the set of tags that have been applied to a thread in a ChannelTypes.GuildForum or a ChannelTypes.GuildMedia channel

Remarks​

Limited to 5

This is only valid when editing a thread

archived?​

optional archived: boolean

Defined in: packages/types/dist/types/discordeno.d.ts:781

Whether the thread is archived

Remarks​

This is only valid when editing a thread

autoArchiveDuration?​

optional autoArchiveDuration: 60 | 1440 | 4320 | 10080

Defined in: packages/types/dist/types/discordeno.d.ts:788

The thread will stop showing in the channel list after auto_archive_duration minutes of inactivity

Remarks​

This is only valid when editing a thread

availableTags?​

optional availableTags: DiscordForumTag[]

Defined in: packages/types/dist/types/discordeno.d.ts:744

The set of tags that can be used in a ChannelTypes.GuildForum or a ChannelTypes.GuildMedia channel

Remarks​

Limited to 20 tags

This is only valid when editing a guild channel of type ChannelTypes.GuildForum or ChannelTypes.GuildMedia.

bitrate?​

optional bitrate: null | number

Defined in: packages/types/dist/types/discordeno.d.ts:679

The bitrate (in bits) of the voice or stage channel

Remarks​

Minimum of 8000 bits

For voice channels:

  • normal servers can set bitrate up to 96000
  • servers with Boost level 1 can set up to 128000
  • servers with Boost level 2 can set up to 256000
  • servers with Boost level 3 or the VIP_REGIONS guild feature can set up to 384000.

For stage channels, bitrate can be set up to 64000.

This is only valid when editing a guild channel of type ChannelTypes.GuildVoice, ChannelTypes.GuildStageVoice.

defaultAutoArchiveDuration?​

optional defaultAutoArchiveDuration: 60 | 1440 | 4320 | 10080

Defined in: packages/types/dist/types/discordeno.d.ts:724

The default duration that the clients use (not the API) for newly created threads in the channel, in minutes, to automatically archive the thread after recent activity

Remarks​

This is only valid when editing a guild channel of type ChannelTypes.GuildText, ChannelTypes.GuildAnnouncement, ChannelTypes.GuildForum or ChannelTypes.GuildMedia.

defaultFormLayout?​

optional defaultFormLayout: ForumLayout

Defined in: packages/types/dist/types/discordeno.d.ts:774

The default forum layout type used to display posts in ChannelTypes.GuildForum channels

Remarks​

This is only valid when editing a guild channel of type ChannelTypes.GuildForum.

defaultReactionEmoji?​

optional defaultReactionEmoji: DiscordDefaultReactionEmoji

Defined in: packages/types/dist/types/discordeno.d.ts:751

The emoji to show in the add reaction button on a thread in a ChannelTypes.GuildForum or a ChannelTypes.GuildMedia channel

Remarks​

This is only valid when editing a guild channel of type ChannelTypes.GuildForum or ChannelTypes.GuildMedia.

defaultSortOrder?​

optional defaultSortOrder: null | SortOrderTypes

Defined in: packages/types/dist/types/discordeno.d.ts:767

The default sort order type used to order posts in ChannelTypes.GuildForum and ChannelTypes.GuildMedia channels

Remarks​

This is only valid when editing a guild channel of type ChannelTypes.GuildForum or ChannelTypes.GuildMedia.

defaultThreadRateLimitPerUser?​

optional defaultThreadRateLimitPerUser: number

Defined in: packages/types/dist/types/discordeno.d.ts:760

The initial rate_limit_per_user to set on newly created threads in a channel.

Remarks​

This field is copied to the thread at creation time and does not live update.

This is only valid when editing a guild channel of type ChannelTypes.GuildText, ChannelTypes.GuildForum or ChannelTypes.GuildMedia.

flags?​

optional flags: number

Defined in: packages/types/dist/types/discordeno.d.ts:735

Channel flags combined as a bitfield.

Remarks​

This is only valid when editing a guild channel of type ChannelTypes.GuildForum or ChannelTypes.GuildMedia, or a thread.

icon?​

optional icon: string

Defined in: packages/types/dist/types/discordeno.d.ts:621

Base64 encoded icon

Remarks​

This is valid only when editing group dms

invitable?​

optional invitable: boolean

Defined in: packages/types/dist/types/discordeno.d.ts:804

Whether non-moderators can add other non-moderators to a thread

Remarks​

Only available on private threads

This is only valid when editing a thread

locked?​

optional locked: boolean

Defined in: packages/types/dist/types/discordeno.d.ts:795

Whether the thread is locked. When a thread is locked, only users with MANAGE_THREADS can unarchive it

Remarks​

This is only valid when editing a thread

name?​

optional name: string

Defined in: packages/types/dist/types/discordeno.d.ts:614

1-100 character channel name

Remarks​

This is valid only when editing group dms, any guild channel type, or a thread

nsfw?​

optional nsfw: null | boolean

Defined in: packages/types/dist/types/discordeno.d.ts:653

Whether the channel is nsfw

Remarks​

This is only valid when editing a guild channel of type ChannelTypes.GuildText, ChannelTypes.GuildVoice, ChannelTypes.GuildAnnouncement, ChannelTypes.GuildStageVoice ChannelTypes.GuildForum or ChannelTypes.GuildMedia.

parentId?​

optional parentId: null | BigString

Defined in: packages/types/dist/types/discordeno.d.ts:703

Id of the new parent category for a channel

Remarks​

This is only valid when editing a guild channel of type ChannelTypes.GuildText, ChannelTypes.GuildVoice, ChannelTypes.GuildAnnouncement, ChannelTypes.GuildStageVoice ChannelTypes.GuildForum or ChannelTypes.GuildMedia.

permissionOverwrites?​

optional permissionOverwrites: null | OverwriteReadable[]

Defined in: packages/types/dist/types/discordeno.d.ts:696

Channel or category-specific permissions

Remarks​

This is only valid when editing a guild channel of any type

position?​

optional position: null | number

Defined in: packages/types/dist/types/discordeno.d.ts:637

The position of the channel in the left-hand listing (channels with the same position are sorted by id)

Remarks​

This is only valid when editing a guild channel of any type

rateLimitPerUser?​

optional rateLimitPerUser: null | number

Defined in: packages/types/dist/types/discordeno.d.ts:662

Amount of seconds a user has to wait before sending another message in seconds (0-21600)

Remarks​

Bots and users with the permission MANAGE_MESSAGES or MANAGE_CHANNEL, are unaffected

This is only valid when editing a guild channel of type ChannelTypes.GuildText, ChannelTypes.GuildVoice, ChannelTypes.GuildStageVoice ChannelTypes.GuildForum or ChannelTypes.GuildMedia, or a thread.

rtcRegion?​

optional rtcRegion: null | string

Defined in: packages/types/dist/types/discordeno.d.ts:710

Voice region id for the voice channel, automatic when set to null

Remarks​

This is only valid when editing a guild channel of type ChannelTypes.GuildVoice, ChannelTypes.GuildStageVoice.

topic?​

optional topic: null | string

Defined in: packages/types/dist/types/discordeno.d.ts:646

Channel topic

Remarks​

0-1024 character channel topic, or for ChannelTypes.GuildForum and ChannelTypes.GuildMedia 0-4096

This is only valid when editing a guild channel of type ChannelTypes.GuildText, ChannelTypes.GuildAnnouncement, ChannelTypes.GuildForum or ChannelTypes.GuildMedia.

type?​

optional type: ChannelTypes

Defined in: packages/types/dist/types/discordeno.d.ts:630

The type of channel

Remarks​

You can only convert between ChannelTypes.GuildText channels and ChannelTypes.GuildAnnouncement channels when the guild has the NEWS feature

This is only valid when editing a guild channel of type ChannelTypes.GuildText or ChannelTypes.GuildAnnouncement.

userLimit?​

optional userLimit: null | number

Defined in: packages/types/dist/types/discordeno.d.ts:689

The user limit of the voice or stage channel (0 refers to no limit)

Remarks​

  • For voice channels, the max is set to 99
  • For stage channels, the max is set to 10,000

This is only valid when editing a guild channel of type ChannelTypes.GuildVoice, ChannelTypes.GuildStageVoice.

videoQualityMode?​

optional videoQualityMode: VideoQualityModes

Defined in: packages/types/dist/types/discordeno.d.ts:717

The camera video quality mode of the voice channel

Remarks​

This is only valid when editing a guild channel of type ChannelTypes.GuildVoice, ChannelTypes.GuildStageVoice.