Skip to main content

ModifyChannel

@discordeno/bot • Docs

Documentation / @discordeno/bot / ModifyChannel

Interface: ModifyChannel

Properties​

appliedTags?​

optional appliedTags: BigString[]

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

Defined in​

packages/types/dist/types/discordeno.d.ts:800

archived?​

optional archived: boolean

Whether the thread is archived

Remarks​

This is only valid when editing a thread

Defined in​

packages/types/dist/types/discordeno.d.ts:768

autoArchiveDuration?​

optional autoArchiveDuration: 60 | 1440 | 4320 | 10080

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

Defined in​

packages/types/dist/types/discordeno.d.ts:775

availableTags?​

optional availableTags: DiscordForumTag[]

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.

Defined in​

packages/types/dist/types/discordeno.d.ts:731

bitrate?​

optional bitrate: null | number

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.

Defined in​

packages/types/dist/types/discordeno.d.ts:666

defaultAutoArchiveDuration?​

optional defaultAutoArchiveDuration: 60 | 1440 | 4320 | 10080

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.

Defined in​

packages/types/dist/types/discordeno.d.ts:711

defaultFormLayout?​

optional defaultFormLayout: ForumLayout

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.

Defined in​

packages/types/dist/types/discordeno.d.ts:761

defaultReactionEmoji?​

optional defaultReactionEmoji: DiscordDefaultReactionEmoji

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.

Defined in​

packages/types/dist/types/discordeno.d.ts:738

defaultSortOrder?​

optional defaultSortOrder: null | SortOrderTypes

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.

Defined in​

packages/types/dist/types/discordeno.d.ts:754

defaultThreadRateLimitPerUser?​

optional defaultThreadRateLimitPerUser: number

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.

Defined in​

packages/types/dist/types/discordeno.d.ts:747

flags?​

optional flags: number

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.

Defined in​

packages/types/dist/types/discordeno.d.ts:722

icon?​

optional icon: string

Base64 encoded icon

Remarks​

This is valid only when editing group dms

Defined in​

packages/types/dist/types/discordeno.d.ts:608

invitable?​

optional invitable: boolean

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

Defined in​

packages/types/dist/types/discordeno.d.ts:791

locked?​

optional locked: boolean

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

Defined in​

packages/types/dist/types/discordeno.d.ts:782

name?​

optional name: string

1-100 character channel name

Remarks​

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

Defined in​

packages/types/dist/types/discordeno.d.ts:601

nsfw?​

optional nsfw: null | boolean

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.

Defined in​

packages/types/dist/types/discordeno.d.ts:640

parentId?​

optional parentId: null | BigString

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.

Defined in​

packages/types/dist/types/discordeno.d.ts:690

permissionOverwrites?​

optional permissionOverwrites: null | OverwriteReadable[]

Channel or category-specific permissions

Remarks​

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

Defined in​

packages/types/dist/types/discordeno.d.ts:683

position?​

optional position: null | number

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

Defined in​

packages/types/dist/types/discordeno.d.ts:624

rateLimitPerUser?​

optional rateLimitPerUser: null | number

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.

Defined in​

packages/types/dist/types/discordeno.d.ts:649

rtcRegion?​

optional rtcRegion: null | string

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.

Defined in​

packages/types/dist/types/discordeno.d.ts:697

topic?​

optional topic: null | string

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.

Defined in​

packages/types/dist/types/discordeno.d.ts:633

type?​

optional type: ChannelTypes

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.

Defined in​

packages/types/dist/types/discordeno.d.ts:617

userLimit?​

optional userLimit: null | number

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.

Defined in​

packages/types/dist/types/discordeno.d.ts:676

videoQualityMode?​

optional videoQualityMode: VideoQualityModes

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.

Defined in​

packages/types/dist/types/discordeno.d.ts:704