Class ApplicationCommands

Various methods for interacting with application commands.

Hierarchy

ApplicationCommands

Index

Constructors

Methods

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

Constructors

constructor

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

Methods

bulkEditGlobalCommands

bulkEditGlobalCommands(applicationID: string, options: CreateApplicationCommandOptions[]): 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>[]>
- Defined in lib/routes/ApplicationCommands.ts:34

bulkEditGuildCommands

bulkEditGuildCommands(applicationID: string, guildID: string, options: CreateGuildApplicationCommandOptions[]): 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>[]>
- Defined in lib/routes/ApplicationCommands.ts:59

createGlobalCommand

createGlobalCommand<T>(applicationID: string, options: T): 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>>
- Defined in lib/routes/ApplicationCommands.ts:84

createGuildCommand

createGuildCommand<T>(applicationID: string, guildID: string, options: T): 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>>
- Defined in lib/routes/ApplicationCommands.ts:109

deleteGlobalCommand

deleteGlobalCommand(applicationID: string, commandID: string): 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>
- Defined in lib/routes/ApplicationCommands.ts:133

deleteGuildCommand

deleteGuildCommand(applicationID: string, guildID: string, commandID: string): 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>
- Defined in lib/routes/ApplicationCommands.ts:146

editGlobalCommand

editGlobalCommand<T>(applicationID: string, commandID: string, options: T): 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>>
- Defined in lib/routes/ApplicationCommands.ts:159

editGuildCommand

editGuildCommand<T>(applicationID: string, guildID: string, commandID: string, options: T): 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>>
- Defined in lib/routes/ApplicationCommands.ts:184

editGuildCommandPermissions

editGuildCommandPermissions(applicationID: string, guildID: string, commandID: string, options: EditApplicationCommandPermissionsOptions): 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>
- Defined in lib/routes/ApplicationCommands.ts:209

getGlobalCommand

getGlobalCommand<T>(applicationID: string, commandID: string, options?: GetApplicationCommandOptions): 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>
- Defined in lib/routes/ApplicationCommands.ts:232

getGlobalCommands

getGlobalCommands(applicationID: string, options?: GetApplicationCommandOptions): 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[]>
- Defined in lib/routes/ApplicationCommands.ts:250

getGuildCommand

getGuildCommand<T>(applicationID: string, guildID: string, commandID: string, options?: GetApplicationCommandOptions): 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>
- Defined in lib/routes/ApplicationCommands.ts:270

getGuildCommands

getGuildCommands(applicationID: string, guildID: string, options?: GetApplicationCommandOptions): 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[]>
- Defined in lib/routes/ApplicationCommands.ts:289

getGuildPermission

getGuildPermission(applicationID: string, guildID: string, commandID: string): 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>
- Defined in lib/routes/ApplicationCommands.ts:308

getGuildPermissions

getGuildPermissions(applicationID: string, guildID: string): 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[]>
- Defined in lib/routes/ApplicationCommands.ts:325

Class ApplicationCommands

Hierarchy

Index

Constructors

Methods

Constructors

constructor

Parameters

manager: RESTManager

Returns ApplicationCommands

Methods

bulkEditGlobalCommands

Parameters

applicationID: string

options: CreateApplicationCommandOptions[]

Returns Promise<ApplicationCommand<ApplicationCommandTypes>[]>

bulkEditGuildCommands

Parameters

applicationID: string

guildID: string

options: CreateGuildApplicationCommandOptions[]

Returns Promise<ApplicationCommand<ApplicationCommandTypes>[]>

createGlobalCommand

Type Parameters

T extends CreateApplicationCommandOptions = CreateApplicationCommandOptions

Parameters

applicationID: string

options: T

Returns Promise<ApplicationCommandOptionConversion<T>>

createGuildCommand

Type Parameters

T extends CreateGuildApplicationCommandOptions = CreateGuildApplicationCommandOptions

Parameters

applicationID: string

guildID: string

options: T

Returns Promise<ApplicationCommandOptionConversion<T>>

deleteGlobalCommand

Parameters

applicationID: string

commandID: string

Returns Promise<void>

deleteGuildCommand

Parameters

applicationID: string

guildID: string

commandID: string

Returns Promise<void>

editGlobalCommand

Type Parameters

T extends EditApplicationCommandOptions = EditApplicationCommandOptions

Parameters

applicationID: string

commandID: string

options: T

Returns Promise<ApplicationCommandOptionConversion<T>>

editGuildCommand

Type Parameters

T extends EditGuildApplicationCommandOptions = EditGuildApplicationCommandOptions

Parameters

applicationID: string

guildID: string

commandID: string

options: T

Returns Promise<ApplicationCommandOptionConversion<T>>

editGuildCommandPermissions

Parameters

applicationID: string

guildID: string

commandID: string

options: EditApplicationCommandPermissionsOptions

Returns Promise<RESTGuildApplicationCommandPermissions>

getGlobalCommand

Type Parameters

T extends AnyApplicationCommand = AnyApplicationCommand

Parameters

applicationID: string

commandID: string

Optional options: GetApplicationCommandOptions

Returns Promise<T>

`Optional` options: GetApplicationCommandOptions

`Optional` options: GetApplicationCommandOptions

`Optional` options: GetApplicationCommandOptions

`Optional` options: GetApplicationCommandOptions