mirror of
https://github.com/discordjs/discord.js.git
synced 2026-03-09 16:13:31 +01:00
feat(Guild): setChannelPositions parent, lockPermissions keys (#5507)
Co-authored-by: Antonio Román <kyradiscord@gmail.com>
This commit is contained in:
@@ -1272,15 +1272,25 @@ class Guild extends Base {
|
||||
return this.edit({ preferredLocale }, reason);
|
||||
}
|
||||
|
||||
/**
|
||||
* Data that can be resolved to give a Category Channel object. This can be:
|
||||
* * A CategoryChannel object
|
||||
* * A Snowflake
|
||||
* @typedef {CategoryChannel|Snowflake} CategoryChannelResolvable
|
||||
*/
|
||||
|
||||
/**
|
||||
* The data needed for updating a channel's position.
|
||||
* @typedef {Object} ChannelPosition
|
||||
* @property {ChannelResolvable} channel Channel to update
|
||||
* @property {number} position New position for the channel
|
||||
* @property {number} [position] New position for the channel
|
||||
* @property {CategoryChannelResolvable} [parent] Parent channel for this channel
|
||||
* @property {boolean} [lockPermissions] If the overwrites should be locked to the parents overwrites
|
||||
*/
|
||||
|
||||
/**
|
||||
* Batch-updates the guild's channels' positions.
|
||||
* <info>Only one channel's parent can be changed at a time</info>
|
||||
* @param {ChannelPosition[]} channelPositions Channel positions to update
|
||||
* @returns {Promise<Guild>}
|
||||
* @example
|
||||
@@ -1292,6 +1302,8 @@ class Guild extends Base {
|
||||
const updatedChannels = channelPositions.map(r => ({
|
||||
id: this.client.channels.resolveID(r.channel),
|
||||
position: r.position,
|
||||
lock_permissions: r.lockPermissions,
|
||||
parent_id: this.channels.resolveID(r.parent),
|
||||
}));
|
||||
|
||||
return this.client.api
|
||||
|
||||
6
typings/index.d.ts
vendored
6
typings/index.d.ts
vendored
@@ -220,6 +220,8 @@ declare module 'discord.js' {
|
||||
public type: 'category';
|
||||
}
|
||||
|
||||
type CategoryChannelResolvable = Snowflake | CategoryChannel;
|
||||
|
||||
export class Channel extends Base {
|
||||
constructor(client: Client, data?: object);
|
||||
public readonly createdAt: Date;
|
||||
@@ -2358,7 +2360,9 @@ declare module 'discord.js' {
|
||||
|
||||
interface ChannelPosition {
|
||||
channel: ChannelResolvable;
|
||||
position: number;
|
||||
lockPermissions?: boolean;
|
||||
parent?: CategoryChannelResolvable;
|
||||
position?: number;
|
||||
}
|
||||
|
||||
type ChannelResolvable = Channel | Snowflake;
|
||||
|
||||
Reference in New Issue
Block a user