Class REST/ApplicationCommands

Various methods for interacting with application commands. Located at Client#rest .applicationCommands.

Hierarchy

REST/ApplicationCommands

Index

Constructors

Methods

bulkEditGlobalCommands bulkEditGuildCommands createGlobalCommand createGuildCommand deleteGlobalCommand deleteGuildCommand editGlobalCommand editGuildCommand editGuildCommandPermissions getGlobalCommand getGlobalCommands getGuildCommand getGuildCommands getGuildPermission getGuildPermissions

Constructors

constructor

new ApplicationCommands(manager): REST/ApplicationCommands
Parameters
- manager: RESTManager
Returns REST/ApplicationCommands
- Defined in lib/routes/ApplicationCommands.ts:25

Methods

bulkEditGlobalCommands

bulkEditGlobalCommands(applicationID, options): Promise<ApplicationCommand<ApplicationCommandTypes>[]>
Overwrite all existing global application commands.
Parameters
- applicationID: string
  
  The ID of the application.
- options: CreateApplicationCommandOptions[]
  
  The commands.
Returns Promise<ApplicationCommand<ApplicationCommandTypes>[]>

Caching
This method does not cache its result.
- Defined in lib/routes/ApplicationCommands.ts:35

bulkEditGuildCommands

bulkEditGuildCommands(applicationID, guildID, options): Promise<ApplicationCommand<ApplicationCommandTypes>[]>
Overwrite all existing application commands in a guild.
Parameters
- applicationID: string
  
  The ID of the application.
- guildID: string
  
  The ID of the guild.
- options: CreateGuildApplicationCommandOptions[]
  
  The commands.
Returns Promise<ApplicationCommand<ApplicationCommandTypes>[]>

Caching
This method does not cache its result.
- Defined in lib/routes/ApplicationCommands.ts:61

createGlobalCommand

createGlobalCommand<T>(applicationID, options): Promise<ApplicationCommandOptionConversion<T>>
Create a global application command.
Type Parameters
- T extends CreateApplicationCommandOptions = CreateApplicationCommandOptions
Parameters
- applicationID: string
  
  The ID of the application.
- options: T
  
  The options for the command.
Returns Promise<ApplicationCommandOptionConversion<T>>

Caching
This method does not cache its result.
- Defined in lib/routes/ApplicationCommands.ts:87

createGuildCommand

createGuildCommand<T>(applicationID, guildID, options): Promise<ApplicationCommandOptionConversion<T>>
Create a guild application command.
Type Parameters
- T extends CreateGuildApplicationCommandOptions = CreateGuildApplicationCommandOptions
Parameters
- applicationID: string
  
  The ID of the application.
- guildID: string
  
  The ID of the guild.
- options: T
  
  The options for the command.
Returns Promise<ApplicationCommandOptionConversion<T>>

Caching
This method does not cache its result.
- Defined in lib/routes/ApplicationCommands.ts:113

deleteGlobalCommand

deleteGlobalCommand(applicationID, commandID): Promise<void>
Delete a global application command.
Parameters
- applicationID: string
  
  The ID of the application.
- commandID: string
  
  The ID the command to delete.
Returns Promise<void>

Caching
This method does not cache its result.
- Defined in lib/routes/ApplicationCommands.ts:138

deleteGuildCommand

deleteGuildCommand(applicationID, guildID, commandID): Promise<void>
Delete a guild application command.
Parameters
- applicationID: string
  
  The ID of the application.
- guildID: string
  
  The ID of the guild.
- commandID: string
  
  The ID of the command to delete.
Returns Promise<void>

Caching
This method does not cache its result.
- Defined in lib/routes/ApplicationCommands.ts:152

editGlobalCommand

editGlobalCommand<T>(applicationID, commandID, options): Promise<ApplicationCommandOptionConversion<T>>
Edit a global application command.
Type Parameters
- T extends EditApplicationCommandOptions = EditApplicationCommandOptions
Parameters
- applicationID: string
  
  The ID of the application.
- commandID: string
  
  The ID of the command to edit.
- options: T
  
  The options for editing the command.
Returns Promise<ApplicationCommandOptionConversion<T>>

Caching
This method does not cache its result.
- Defined in lib/routes/ApplicationCommands.ts:166

editGuildCommand

editGuildCommand<T>(applicationID, guildID, commandID, options): Promise<ApplicationCommandOptionConversion<T>>
Edit a guild application command.
Type Parameters
- T extends EditGuildApplicationCommandOptions = EditGuildApplicationCommandOptions
Parameters
- applicationID: string
  
  The ID of the application.
- guildID: string
  
  The ID of the guild.
- commandID: string
  
  The ID of the command to edit.
- options: T
  
  The options for editing the command.
Returns Promise<ApplicationCommandOptionConversion<T>>

Caching
This method does not cache its result.
- Defined in lib/routes/ApplicationCommands.ts:192

editGuildCommandPermissions

editGuildCommandPermissions(applicationID, guildID, commandID, options): Promise<RESTGuildApplicationCommandPermissions>
Edit a guild application command's permissions. This requires a bearer token with the applications.commands.permissions.update scope.
Parameters
- applicationID: string
  
  The ID of the application.
- guildID: string
  
  The ID of the guild.
- commandID: string
  
  The ID of the command.
- options: EditApplicationCommandPermissionsOptions
  
  The options for editing the permissions.
Returns Promise<RESTGuildApplicationCommandPermissions>

Caching
This method does not cache its result.
- Defined in lib/routes/ApplicationCommands.ts:218

getGlobalCommand

getGlobalCommand<T>(applicationID, commandID, options?): Promise<T>
Get a global application command.
Type Parameters
- T extends AnyApplicationCommand = AnyApplicationCommand
Parameters
- applicationID: string
  
  The ID of the application.
- commandID: string
  
  The ID of the command.
- Optional options: GetApplicationCommandOptions
  
  The options for getting the command.
Returns Promise<T>

Caching
This method does not cache its result.
- Defined in lib/routes/ApplicationCommands.ts:242

getGlobalCommands

getGlobalCommands(applicationID, options?): Promise<AnyApplicationCommand[]>
Get an application's global commands.
Parameters
- applicationID: string
  
  The ID of the application.
- Optional options: GetApplicationCommandOptions
  
  The options for getting the command.
Returns Promise<AnyApplicationCommand[]>

Caching
This method does not cache its result.
- Defined in lib/routes/ApplicationCommands.ts:261

getGuildCommand

getGuildCommand<T>(applicationID, guildID, commandID, options?): Promise<T>
Get a global application command.
Type Parameters
- T extends AnyApplicationCommand = AnyApplicationCommand
Parameters
- applicationID: string
  
  The ID of the application.
- guildID: string
  
  The ID of the guild.
- commandID: string
  
  The ID of the command.
- Optional options: GetApplicationCommandOptions
  
  The options for getting the command.
Returns Promise<T>

Caching
This method does not cache its result.
- Defined in lib/routes/ApplicationCommands.ts:282

getGuildCommands

getGuildCommands(applicationID, guildID, options?): Promise<AnyApplicationCommand[]>
Get an application's application commands in a specific guild.
Parameters
- applicationID: string
  
  The ID of the application.
- guildID: string
  
  The ID of the guild.
- Optional options: GetApplicationCommandOptions
  
  The options for getting the command.
Returns Promise<AnyApplicationCommand[]>

Caching
This method does not cache its result.
- Defined in lib/routes/ApplicationCommands.ts:302

getGuildPermission

getGuildPermission(applicationID, guildID, commandID): Promise<RESTGuildApplicationCommandPermissions>
Get an application command's permissions in a guild.
Parameters
- applicationID: string
  
  The ID of the application.
- guildID: string
  
  The ID of the guild.
- commandID: string
  
  The ID of the command.
Returns Promise<RESTGuildApplicationCommandPermissions>

Caching
This method does not cache its result.
- Defined in lib/routes/ApplicationCommands.ts:322

getGuildPermissions

getGuildPermissions(applicationID, guildID): Promise<RESTGuildApplicationCommandPermissions[]>
Get the permissions for all application commands in a guild.
Parameters
- applicationID: string
  
  The ID of the application.
- guildID: string
  
  The ID of the guild.
Returns Promise<RESTGuildApplicationCommandPermissions[]>

Caching
This method does not cache its result.
- Defined in lib/routes/ApplicationCommands.ts:340

Class REST/ApplicationCommands

Hierarchy

Index

Constructors

Methods

Constructors

constructor

Parameters

manager: RESTManager

Returns REST/ApplicationCommands

Methods

bulkEditGlobalCommands

Parameters

applicationID: string

options: CreateApplicationCommandOptions[]

Returns Promise<ApplicationCommand<ApplicationCommandTypes>[]>

Caching

bulkEditGuildCommands

Parameters

applicationID: string

guildID: string

options: CreateGuildApplicationCommandOptions[]

Returns Promise<ApplicationCommand<ApplicationCommandTypes>[]>

Caching

createGlobalCommand

Type Parameters

T extends CreateApplicationCommandOptions = CreateApplicationCommandOptions

Parameters

applicationID: string

options: T

Returns Promise<ApplicationCommandOptionConversion<T>>

Caching

createGuildCommand

Type Parameters

T extends CreateGuildApplicationCommandOptions = CreateGuildApplicationCommandOptions

Parameters

applicationID: string

guildID: string

options: T

Returns Promise<ApplicationCommandOptionConversion<T>>

Caching

deleteGlobalCommand

Parameters

applicationID: string

commandID: string

Returns Promise<void>

Caching

deleteGuildCommand

Parameters

applicationID: string

guildID: string

commandID: string

Returns Promise<void>

Caching

editGlobalCommand

Type Parameters

T extends EditApplicationCommandOptions = EditApplicationCommandOptions

Parameters

applicationID: string

commandID: string

options: T

Returns Promise<ApplicationCommandOptionConversion<T>>

Caching

editGuildCommand

Type Parameters

T extends EditGuildApplicationCommandOptions = EditGuildApplicationCommandOptions

Parameters

applicationID: string

guildID: string

commandID: string

options: T

Returns Promise<ApplicationCommandOptionConversion<T>>

Caching

editGuildCommandPermissions

Parameters

applicationID: string

guildID: string

commandID: string

options: EditApplicationCommandPermissionsOptions

Returns Promise<RESTGuildApplicationCommandPermissions>

`Optional` options: GetApplicationCommandOptions

`Optional` options: GetApplicationCommandOptions

`Optional` options: GetApplicationCommandOptions

`Optional` options: GetApplicationCommandOptions