Class REST/Applications

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

Constructors

constructor

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

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/Applications.ts:28

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/Applications.ts:57

consumeEntitlement

consumeEntitlement(applicationID, entitlementID): Promise<void>
Mark an entitlement as consumed.
Parameters
- applicationID: string
  The ID of the application to the entitlement is for.
- entitlementID: string
  The ID of the entitlement to consume.
Returns Promise<void>
- Defined in lib/routes/Applications.ts:82

createEmoji

createEmoji(applicationID, options): Promise<ApplicationEmoji>
Create an emoji for an application.
Parameters
- applicationID: string
  The ID of the application.
- options: CreateApplicationEmojiOptions
  The options for creating the emoji.
Returns Promise<ApplicationEmoji>
Caching
This method does not cache its result.
- Defined in lib/routes/Applications.ts:95

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/Applications.ts:118

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/Applications.ts:147

createTestEntitlement

createTestEntitlement(applicationID, options): Promise<TestEntitlement>
Create a test entitlement.
Parameters
- applicationID: string
  The ID of the application to create the entitlement for.
- options: CreateTestEntitlementOptions
  The options for creating the test entitlement.
Returns Promise<TestEntitlement>
- Defined in lib/routes/Applications.ts:171

deleteEmoji

deleteEmoji(applicationID, emojiID): Promise<void>
Delete an emoji for an application.
Parameters
- applicationID: string
  The ID of the application.
- emojiID: string
  The ID of the emoji to be deleted.
Returns Promise<void>
Caching
This method does not cache its result.
- Defined in lib/routes/Applications.ts:190

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/Applications.ts:203

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/Applications.ts:217

deleteTestEntitlement

deleteTestEntitlement(applicationID, entitlementID): Promise<void>
Delete an entitlement.
Parameters
- applicationID: string
  The ID of the application to delete the entitlement from.
- entitlementID: string
  The ID of the entitlement to delete.
Returns Promise<void>
- Defined in lib/routes/Applications.ts:229

editCurrent

editCurrent(options): Promise<Application>
Edit the currently authenticated bot's application info.
Parameters
- options: EditApplicationOptions
  The options for editing the application.
Returns Promise<Application>
Caching
This method does not cache its result.
- Defined in lib/routes/Applications.ts:241

editEmoji

editEmoji(applicationID, emojiID, options): Promise<ApplicationEmoji>
Edit an existing emoji for an application.
Parameters
- applicationID: string
  The ID of the application.
- emojiID: string
  The ID of the emoji to be edited.
- options: EditApplicationEmojiOptions
  The options for editing the emoji.
Returns Promise<ApplicationEmoji>
Caching
This method does not cache its result.
- Defined in lib/routes/Applications.ts:280

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/Applications.ts:296

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/Applications.ts:324

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/Applications.ts:350

get

get(applicationID): Promise<Application>
Get an application's info.
Parameters
- applicationID: string
  The ID of the application.
Returns Promise<Application>
Caching
This method does not cache its result.

Note
This generally cannot be used on any application except the authenticated bot.
- Defined in lib/routes/Applications.ts:374

getActivityInstance

getActivityInstance(applicationID, instanceID): Promise<ActivityInstance>
Get an activity instance.
Parameters
- applicationID: string
  The ID of the application.
- instanceID: string
  The ID of the instance.
Returns Promise<ActivityInstance>
- Defined in lib/routes/Applications.ts:386

getClient

getClient(): Promise<ClientApplication>
Get the currently authenticated bot's application info as a bare ClientApplication.

Returns Promise<ClientApplication>
Caching
This method does not cache its result.
- Defined in lib/routes/Applications.ts:408

getCurrent

getCurrent(): Promise<Application>
Get the currently authenticated bot's application info.

Returns Promise<Application>
Caching
This method does not cache its result.
- Defined in lib/routes/Applications.ts:419

getEmoji

getEmoji(applicationID, emojiID): Promise<ApplicationEmoji>
Get an emoji for an application.
Parameters
- applicationID: string
  The ID of the application to get the emojis of.
- emojiID: string
  The ID of the emoji to get.
Returns Promise<ApplicationEmoji>
Caching
This method does not cache its result.
- Defined in lib/routes/Applications.ts:429

getEmojis

getEmojis(applicationID): Promise<ApplicationEmojis>
Get the emojis for an application.
Parameters
- applicationID: string
  The ID of the application to get the emojis of.
Returns Promise<ApplicationEmojis>
Caching
This method does not cache its result.
- Defined in lib/routes/Applications.ts:441

getEntitlement

getEntitlement(applicationID, entitlementID): Promise<Entitlement | TestEntitlement>
Get an entitlement for an application.
Parameters
- applicationID: string
  The ID of the application that the entitlement is for.
- entitlementID: string
  The ID of the entitlement.
Returns Promise<Entitlement | TestEntitlement>
Caching
This method may cache its result. If the entitlement's application id is the client's application id.

Caches
ClientApplication#entitlements
- Defined in lib/routes/Applications.ts:457

getEntitlements

getEntitlements(applicationID, options?): Promise<(Entitlement | TestEntitlement)[]>
Get the entitlements for an application.
Parameters
- applicationID: string
  The ID of the application to get the entitlements of.
- options: SearchEntitlementsOptions = {}
  The options for getting the entitlements.
Returns Promise<(Entitlement | TestEntitlement)[]>
Caching
This method may cache its result. If an entitlement's application id is the client's application id.

Caches
ClientApplication#entitlements
- Defined in lib/routes/Applications.ts:471

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/Applications.ts:496

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/Applications.ts:514

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/Applications.ts:534

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/Applications.ts:553

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/Applications.ts:572

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/Applications.ts:590

getSKUSubscription

getSKUSubscription(skuID, subscriptionID): Promise<Subscription>
Get the subscription for an SKU.
Parameters
- skuID: string
  The ID of the SKU to get the subscription of.
- subscriptionID: string
  The ID of the subscription to get.
Returns Promise<Subscription>
- Defined in lib/routes/Applications.ts:607

getSKUSubscriptions

getSKUSubscriptions(skuID, options): Promise<Subscription[]>
Get the subscriptions for an SKU.
Parameters
- skuID: string
  The ID of the SKU to get the subscriptions of.
- options: SearchSKUSubscriptions
  The options for getting the subscriptions.
Returns Promise<Subscription[]>
- Defined in lib/routes/Applications.ts:619

getSKUs

getSKUs(applicationID): Promise<SKU[]>
Get the SKUs for an application.
Parameters
- applicationID: string
  The ID of the application to get the SKUs of.
Returns Promise<SKU[]>
- Defined in lib/routes/Applications.ts:637

uploadAttachment

uploadAttachment(applicationID, options): Promise<Attachment>
Upload an ephemeral attachment for an application.

The application must have Activities enabled (the ApplicationFlags~EMBEDDED EMBEDDED application flag). Applications without Activities enabled currently return an "Unknown Application" error.

This endpoint requires a user OAuth2 bearer token; client credentials grant tokens are not valid and currently produce a 500 error.

The returned url is only valid for 24 hours.
Parameters
- applicationID: string
  The ID of the application.
- options: UploadApplicationAttachmentOptions
  The options for uploading the attachment.
Returns Promise<Attachment>
Caching
This method does not cache its result.
- Defined in lib/routes/Applications.ts:656

Class REST/Applications

Index

Constructors

Methods

Constructors

constructor

Parameters

Returns REST/Applications

Methods

bulkEditGlobalCommands

Parameters

Returns Promise<ApplicationCommand<ApplicationCommandTypes>[]>

Caching

bulkEditGuildCommands

Parameters

Returns Promise<ApplicationCommand<ApplicationCommandTypes>[]>

Caching

consumeEntitlement

Parameters

Returns Promise<void>

createEmoji

Parameters

Returns Promise<ApplicationEmoji>

Caching

createGlobalCommand

Type Parameters

Parameters

Returns Promise<ApplicationCommandOptionConversion<T>>

Caching

createGuildCommand

Type Parameters

Parameters

Returns Promise<ApplicationCommandOptionConversion<T>>

Caching

createTestEntitlement

Parameters

Returns Promise<TestEntitlement>

deleteEmoji

Parameters

Returns Promise<void>

Caching

deleteGlobalCommand

Parameters

Returns Promise<void>

Caching

deleteGuildCommand

Parameters

Returns Promise<void>

Caching

deleteTestEntitlement

Parameters

Returns Promise<void>

editCurrent

Parameters

Returns Promise<Application>

Caching

editEmoji

Parameters

Returns Promise<ApplicationEmoji>

Caching

editGlobalCommand

Type Parameters

Parameters

Returns Promise<ApplicationCommandOptionConversion<T>>

Caching

editGuildCommand

Type Parameters

Parameters

Returns Promise<ApplicationCommandOptionConversion<T>>

Caching

editGuildCommandPermissions

Parameters

Returns Promise<RESTGuildApplicationCommandPermissions>

Caching

get

Parameters

Returns Promise<Application>

Caching

Note

getActivityInstance