GuildCategoryChannel

extends GuildChannel

Represents a channel category in a Discord guild, used to organize individual text or voice channels in that guild.

Instances of this class should not be constructed by users.

Properties Inherited From GuildChannel

Name	Type	Description
category	GuildCategoryChannel/nil	The parent channel category that may contain this channel.
guild	Guild	The guild in which this channel exists.
name	string	The name of the channel. This should be between 2 and 100 characters in length.
permissionOverwrites	Cache	An iterable cache of all overwrites that exist in this channel. To access an overwrite that may exist, but is not cached, use GuildChannel:getPermissionOverwriteFor.
position	number	The position of the channel, where 0 is the highest.
private	boolean	Whether the "everyone" role has permission to view this channel. In the Discord channel, private text channels are indicated with a lock icon and private voice channels are not visible.

Properties

Name	Type	Description
textChannels	FilteredIterable	Iterable of all textChannels in the Category.
voiceChannels	FilteredIterable	Iterable of all voiceChannels in the Category.

Methods Inherited From GuildChannel

createInvite(payload)

Parameter	Type	Optional
payload	table	✔

Creates an invite to the channel. Optional payload fields are: max_age: number time in seconds until expiration, default = 86400 (24 hours), max_uses: number total number of uses allowed, default = 0 (unlimited), temporary: boolean whether the invite grants temporary membership, default = false, unique: boolean whether a unique code should be guaranteed, default = false

Returns: Invite

delete()

Permanently deletes the channel. This cannot be undone!

Returns: boolean

getInvites()

Returns a newly constructed cache of all invite objects for the channel. The cache and its objects are not automatically updated via gateway events. You must call this method again to get the updated objects.

Returns: Cache

getPermissionOverwriteFor(obj)

Parameter	Type
obj	Role/Member

Returns a permission overwrite object corresponding to the provided member or role object. If a cached overwrite is not found, an empty overwrite with zero-permissions is returned instead. Therefore, this can be used to create a new overwrite when one does not exist. Note that the member or role must exist in the same guild as the channel does.

Returns: PermissionOverwrite

moveDown(n)

Parameter	Type
n	number

Moves a channel down its list. The parameter n indicates how many spaces the channel should be moved, clamped to the lowest position, with a default of 1 if it is omitted. This will also normalize the positions of all channels.

Returns: boolean

moveUp(n)

Parameter	Type
n	number

Moves a channel up its list. The parameter n indicates how many spaces the channel should be moved, clamped to the highest position, with a default of 1 if it is omitted. This will also normalize the positions of all channels.

Returns: boolean

setCategory(id)

Parameter	Type
id	Channel-ID-Resolvable

Sets the channel's parent category.

Returns: boolean

setName(name)

Parameter	Type
name	string

Sets the channel's name. This must be between 2 and 100 characters in length.

Returns: boolean

Methods

createTextChannel(name)

Parameter	Type
name	string

Creates a new GuildTextChannel with this category as it's parent. Similar to Guild:createTextChannel(name)

Returns: GuildTextChannel

createVoiceChannel(name)

Parameter	Type
name	string

Creates a new GuildVoiceChannel with this category as it's parent. Similar to Guild:createVoiceChannel(name)

Returns: GuildVoiceChannel