Skip to content

$editChannel

$editChannel will edit a channel.

Usage

$editChannel[channelID;name?;type?;position?;topic?;nsfw?;bitrate?;userlimit?;parent?;lockPermissions?;permissionOverwrites?;rateLimitPerUser?;defaultAutoArchiveDuration?;rtcRegion?;reason?]

Parameters

FieldTypeDescriptionRequired
channelIDnumberThe ID of the channel which will be notified.true
name?stringThe new channel name.false
type?stringThe new channel type. (listed below)false
position?stringThe new channel position.false
topic?stringThe new channel topic.false
nsfw?booleanIf it should mark the channel as NSFW or not.false
bitrate?numberVoice Channel bitrate.false
userlimit?numberVoice Channel userlimit.false
parent?numberThe new parent of the channel. (category ID)false
lockPermissions?stringThe new channels lock permissions.false
permissionOverwrites?stringThe new channels permission overwrites.false
rateLimitPerUser?numberThe channel slowmode of the edited channel.false
defaultAutoArchiveDuration?numberThread/Forum archive duration. (in ms)false
rtcRegion?stringVoice Channel RTC region.false
reason?stringReason which will be displayed in the guild’s audit logs.false

Note: you can use $default to keep the current property.

Channel Types

Channel Type
Text Channel Text
Voice Channel Voice
Category Category
Stage Channel Stage
Private Thread PrivateThread
Public Thread PublicThread
Forum Forum
Announcement Thread AnnouncementThread
Announcement Channel Announcement

Note: all channel types are case-sensitive.

Example(s)

This will change the current channel name to “i-love-aoijs”:

1
client.command({
2
name: "editChannel",
3
code: `
4
$editChannel[$channelID;i-love-aoi-js]
5
`
6
});