Skip to main content

ModifyChannel

Documentation

Documentation / @discordeno/types / ModifyChannel

Interface: ModifyChannel

Defined in: discordeno/channel.ts:56

Properties​

appliedTags?​

optional appliedTags?: BigString[]

Defined in: discordeno/channel.ts:269

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: discordeno/channel.ts:237

Whether the thread is archived

Remarks​

This is only valid when editing a thread

autoArchiveDuration?​

optional autoArchiveDuration?: 60 | 1440 | 4320 | 10080

Defined in: discordeno/channel.ts:244

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?: DiscordenoForumTag[]

Defined in: discordeno/channel.ts:198

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?: number | null

Defined in: discordeno/channel.ts:131

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 | null

Defined in: discordeno/channel.ts:176

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.

defaultForumLayout?​

optional defaultForumLayout?: ForumLayout

Defined in: discordeno/channel.ts:228

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?: DiscordenoDefaultReactionEmoji | null

Defined in: discordeno/channel.ts:205

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

Defined in: discordeno/channel.ts:221

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: discordeno/channel.ts:214

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: discordeno/channel.ts:189

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.

See​

ChannelFlags

icon?​

optional icon?: string

Defined in: discordeno/channel.ts:71

Base64 encoded icon

Remarks​

This is valid only when editing group dms

invitable?​

optional invitable?: boolean

Defined in: discordeno/channel.ts:260

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: discordeno/channel.ts:251

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: discordeno/channel.ts:64

1-100 character channel name

Remarks​

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

nsfw?​

optional nsfw?: boolean | null

Defined in: discordeno/channel.ts:105

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?: BigString | null

Defined in: discordeno/channel.ts:155

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?: Overwrite[] | null

Defined in: discordeno/channel.ts:148

Channel or category-specific permissions

Remarks​

This is valid when editing a guild channel of any type

position?​

optional position?: number | null

Defined in: discordeno/channel.ts:89

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?: number | null

Defined in: discordeno/channel.ts:114

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?: string | null

Defined in: discordeno/channel.ts:162

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?: string | null

Defined in: discordeno/channel.ts:98

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: discordeno/channel.ts:82

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?: number | null

Defined in: discordeno/channel.ts:141

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 | null

Defined in: discordeno/channel.ts:169

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.