62 lines
2.3 KiB
JavaScript
62 lines
2.3 KiB
JavaScript
'use strict';
|
|
|
|
const GuildChannel = require('./GuildChannel');
|
|
|
|
/**
|
|
* Represents a guild category channel on Discord.
|
|
* @extends {GuildChannel}
|
|
*/
|
|
class CategoryChannel extends GuildChannel {
|
|
/**
|
|
* Channels that are a part of this category
|
|
* @type {Collection<Snowflake, GuildChannel>}
|
|
* @readonly
|
|
*/
|
|
get children() {
|
|
return this.guild.channels.cache.filter(c => c.parentId === this.id);
|
|
}
|
|
|
|
/**
|
|
* Sets the category parent of this channel.
|
|
* <warn>It is not currently possible to set the parent of a CategoryChannel.</warn>
|
|
* @method setParent
|
|
* @memberof CategoryChannel
|
|
* @instance
|
|
* @param {?CategoryChannelResolvable} channel The channel to set as parent
|
|
* @param {SetParentOptions} [options={}] The options for setting the parent
|
|
* @returns {Promise<GuildChannel>}
|
|
*/
|
|
|
|
/**
|
|
* Options for creating a channel using {@link CategoryChannel#createChannel}.
|
|
* @typedef {Object} CategoryCreateChannelOptions
|
|
* @property {ChannelType|number} [type='GUILD_TEXT'] The type of the new channel.
|
|
* @property {string} [topic] The topic for the new channel
|
|
* @property {boolean} [nsfw] Whether the new channel is NSFW
|
|
* @property {number} [bitrate] Bitrate of the new channel in bits (only voice)
|
|
* @property {number} [userLimit] Maximum amount of users allowed in the new channel (only voice)
|
|
* @property {OverwriteResolvable[]|Collection<Snowflake, OverwriteResolvable>} [permissionOverwrites]
|
|
* Permission overwrites of the new channel
|
|
* @property {number} [position] Position of the new channel
|
|
* @property {number} [rateLimitPerUser] The rate limit per user (slowmode) for the new channel in seconds
|
|
* @property {string} [rtcRegion] The specific region of the new channel.
|
|
* @property {string} [reason] Reason for creating the new channel
|
|
*/
|
|
|
|
/**
|
|
* Creates a new channel within this category.
|
|
* <info>You cannot create a channel of type `GUILD_CATEGORY` inside a CategoryChannel.</info>
|
|
* @param {string} name The name of the new channel
|
|
* @param {CategoryCreateChannelOptions} options Options for creating the new channel
|
|
* @returns {Promise<GuildChannel>}
|
|
*/
|
|
createChannel(name, options) {
|
|
return this.guild.channels.create(name, {
|
|
...options,
|
|
parent: this.id,
|
|
});
|
|
}
|
|
}
|
|
|
|
module.exports = CategoryChannel;
|