discord.js | ApplicationCommandManager

Search...

ApplicationCommandManager

export class ApplicationCommandManager<ApplicationCommandScope = ApplicationCommand<{ guild: GuildResolvable }>, PermissionsOptionsExtras = { guild: GuildResolvable }, PermissionsGuildType = null,> extends CachedManager<Snowflake, ApplicationCommandScope, ApplicationCommandResolvable>

export class ApplicationCommandManager<ApplicationCommandScope = ApplicationCommand<{ guild: GuildResolvable }>, PermissionsOptionsExtras = { guild: GuildResolvable }, PermissionsGuildType = null,> extends CachedManager<Snowflake, ApplicationCommandScope, ApplicationCommandResolvable>

Manages API methods for application commands and stores their cache.

Extends

CachedManager<Snowflake, ApplicationCommandScope, ApplicationCommandResolvable>

Name	Optional	Default	Description
ApplicationCommandScope	Yes	ApplicationCommand<{ guild: GuildResolvable }>	None
PermissionsOptionsExtras	Yes	{ guild: GuildResolvable }	None
PermissionsGuildType	Yes	null	None

constructor(client, iterable?)

Constructs a new instance of the ApplicationCommandManager class

Name	Type	Optional	Description
client	Client<true>	No	None
iterable	Iterable<unknown>	Yes	None

Readonly

cache:Collection<Key, Holds>

The cache of items for this manager.

Inherited from DataManager

Readonly

client:Client

The client that instantiated this Manager

Inherited from BaseManager

guild:GuildResolvable

Readonly

holds:Constructable<Holds>

The data structure belonging to this manager.

Inherited from DataManager

permissions:ApplicationCommandPermissionsManager<{ command?: ApplicationCommandResolvable } & PermissionsOptionsExtras, { command: ApplicationCommandResolvable } & PermissionsOptionsExtras, PermissionsGuildType, null>

The manager for permissions of arbitrary commands on arbitrary guilds

create(command, guildId?):Promise<ApplicationCommandScope>

Creates an application command.

Example

// Create a new command
client.application.commands.create({
  name: 'test',
  description: 'A test command',
})
  .then(console.log)
  .catch(console.error);

// Create a new command
client.application.commands.create({
  name: 'test',
  description: 'A test command',
})
  .then(console.log)
  .catch(console.error);

Name	Type	Optional	Description
command	ApplicationCommandDataResolvable	No	The command
guildId	Snowflake	Yes	The guild's id to create this command in, ignored when using a GuildApplicationCommandManager

delete(command, guildId?):Promise<ApplicationCommandScope | null>

Deletes an application command.

Example

// Delete a command
guild.commands.delete('123456789012345678')
  .then(console.log)
  .catch(console.error);

// Delete a command
guild.commands.delete('123456789012345678')
  .then(console.log)
  .catch(console.error);

Name	Type	Optional	Description
command	ApplicationCommandResolvable	No	The command to delete
guildId	Snowflake	Yes	The guild's id where the command is registered, ignored when using a GuildApplicationCommandManager

edit(command, data):Promise<ApplicationCommandScope>

Edits an application command.

Example

// Edit an existing command
client.application.commands.edit('123456789012345678', {
  description: 'New description',
})
  .then(console.log)
  .catch(console.error);

// Edit an existing command
client.application.commands.edit('123456789012345678', {
  description: 'New description',
})
  .then(console.log)
  .catch(console.error);

Name	Type	Optional	Description
command	ApplicationCommandResolvable	No	The command to edit
data	Partial<ApplicationCommandDataResolvable>	No	The data to update the command with

fetch(id, options):Promise<ApplicationCommand>

Obtains one or multiple application commands from Discord, or the cache if it's already available.

Example

// Fetch a single command
client.application.commands.fetch('123456789012345678')
  .then(command => console.log(`Fetched command ${command.name}`))
  .catch(console.error);

// Fetch a single command
client.application.commands.fetch('123456789012345678')
  .then(command => console.log(`Fetched command ${command.name}`))
  .catch(console.error);

Example

// Fetch all commands
guild.commands.fetch()
  .then(commands => console.log(`Fetched ${commands.size} commands`))
  .catch(console.error);

// Fetch all commands
guild.commands.fetch()
  .then(commands => console.log(`Fetched ${commands.size} commands`))
  .catch(console.error);

Name	Type	Optional	Description
id	Snowflake	No	Options for fetching application command(s)
options	FetchApplicationCommandOptions & { guildId: Snowflake }	No	Additional options for this fetch

resolve(idOrInstance):Holds

Resolves a data entry to a data Object.

Returns

An instance from this Manager

Name	Type	Optional	Description
idOrInstance	Holds	No	The id or instance of something in this Manager

resolveId(idOrInstance):Key

Resolves a data entry to an instance id.

Returns

Name	Type	Optional	Description
idOrInstance	Key \| Holds	No	The id or instance of something in this Manager

set(commands):Promise<Collection<Snowflake, ApplicationCommandScope>>

Sets all the commands for this application or guild.

Example

// Set all commands to just this one
client.application.commands.set([
  {
    name: 'test',
    description: 'A test command',
  },
])
  .then(console.log)
  .catch(console.error);

// Set all commands to just this one
client.application.commands.set([
  {
    name: 'test',
    description: 'A test command',
  },
])
  .then(console.log)
  .catch(console.error);

Example

// Remove all commands
guild.commands.set([])
  .then(console.log)
  .catch(console.error);

// Remove all commands
guild.commands.set([])
  .then(console.log)
  .catch(console.error);

Name	Type	Optional	Description
commands	readonly ApplicationCommandDataResolvable[]	No	The commands

valueOf():Collection<Key, Holds>