Class ClientApplication

constructor

• new ClientApplication(data, client): ClientApplication

• Parameters

  • data: RawClientApplication
  • client: Client<ClientEvents>

  Returns ClientApplication

entitlements

flags

flagsNew

subscriptions

bulkEditGlobalCommands

• bulkEditGlobalCommands(options): Promise<ApplicationCommand<ApplicationCommandTypes>[]>

• Overwrite all existing global application commands.

  Parameters

  • options: CreateApplicationCommandOptions[]

    The commands.

  Returns Promise<ApplicationCommand<ApplicationCommandTypes>[]>

bulkEditGuildCommands

• bulkEditGuildCommands(guildID, options): Promise<ApplicationCommand<ApplicationCommandTypes>[]>

• Overwrite all existing application commands in a guild.

  Parameters

  • guildID: string

    The ID of the guild.
  • options: CreateGuildApplicationCommandOptions[]

    The commands.

  Returns Promise<ApplicationCommand<ApplicationCommandTypes>[]>

consumeEntitlement

• consumeEntitlement(entitlementID): Promise<void>

• Mark an entitlement as consumed.

  Parameters

  • entitlementID: string

    The ID of the entitlement to consume.

  Returns Promise<void>

createEmoji

• createEmoji(options): Promise<ApplicationEmoji>

• Create an emoji for this application.

  Parameters

  • options: CreateApplicationEmojiOptions

    The options for creating the emoji.

  Returns Promise<ApplicationEmoji>

  Caching

  This method does not cache its result.

createGlobalCommand

• createGlobalCommand<T>(options): Promise<ApplicationCommandOptionConversion<T>>

• Create a global application command.

  Type Parameters

  • T extends CreateApplicationCommandOptions = CreateApplicationCommandOptions

  Parameters

  • options: T

    The options for creating the command.

  Returns Promise<ApplicationCommandOptionConversion<T>>

createGuildCommand

• createGuildCommand<T>(guildID, options): Promise<ApplicationCommandOptionConversion<T>>

• Create a guild application command.

  Type Parameters

  • T extends CreateGuildApplicationCommandOptions = CreateGuildApplicationCommandOptions

  Parameters

  • guildID: string

    The ID of the guild.
  • options: T

    The options for creating the command.

  Returns Promise<ApplicationCommandOptionConversion<T>>

createTestEntitlement

• createTestEntitlement(options): Promise<TestEntitlement>

• Create a test entitlement.

  Parameters

  • options: CreateTestEntitlementOptions

    The options for creating the test entitlement.

  Returns Promise<TestEntitlement>

deleteEmoji

• deleteEmoji(emojiID): Promise<void>

• Delete an emoji for this application.

  Parameters

  • emojiID: string

    The ID of the emoji to be deleted.

  Returns Promise<void>

  Caching

  This method does not cache its result.

deleteGlobalCommand

• deleteGlobalCommand(commandID): Promise<void>

• Delete a global application command.

  Parameters

  • commandID: string

    The ID of the command.

  Returns Promise<void>

deleteGuildCommand

• deleteGuildCommand(guildID, commandID): Promise<void>

• Delete a guild application command.

  Parameters

  • guildID: string

    The ID of the guild.
  • commandID: string

    The ID of the command.

  Returns Promise<void>

deleteTestEntitlement

• deleteTestEntitlement(entitlementID): Promise<void>

• Delete a test entitlement.

  Parameters

  • entitlementID: string

    The ID of the entitlement to delete.

  Returns Promise<void>

edit

• edit(options): Promise<Application>

• Edit this application.

  Parameters

  • options: EditApplicationOptions

    The options for editing the application.

  Returns Promise<Application>

editEmoji

• editEmoji(emojiID, options): Promise<ApplicationEmoji>

• Edit an existing emoji for this application.

  Parameters

  • 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.

editGlobalCommand

• editGlobalCommand<T>(commandID, options): Promise<ApplicationCommandOptionConversion<T>>

• Edit a global application command.

  Type Parameters

  • T extends EditApplicationCommandOptions = EditApplicationCommandOptions

  Parameters

  • commandID: string

    The ID of the command.
  • options: T

    The options for editing the command.

  Returns Promise<ApplicationCommandOptionConversion<T>>

editGuildCommand

• editGuildCommand<T>(guildID, commandID, options): Promise<ApplicationCommandOptionConversion<T>>

• Edit a guild application command.

  Type Parameters

  • T extends EditGuildApplicationCommandOptions = EditGuildApplicationCommandOptions

  Parameters

  • guildID: string

    The ID of the guild.
  • commandID: string

    The ID of the command.
  • options: T

    The options for editing the command.

  Returns Promise<ApplicationCommandOptionConversion<T>>

editGuildCommandPermissions

• editGuildCommandPermissions(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

  • 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>

getActivityInstance

• getActivityInstance(instanceID): Promise<ActivityInstance>

• Get an activity instance.

  Parameters

  • instanceID: string

    The ID of the instance.

  Returns Promise<ActivityInstance>

getEmoji

• getEmoji(emojiID): Promise<ApplicationEmoji>

• Get an emoji for this application.

  Parameters

  • emojiID: string

    The ID of the emoji to get.

  Returns Promise<ApplicationEmoji>

getEmojis

• getEmojis(): Promise<ApplicationEmojis>

• Get the emojis for this application.

  Returns Promise<ApplicationEmojis>

getEntitlement

• getEntitlement(entitlementID): Promise<Entitlement | TestEntitlement>

• Get an entitlement for this application.

  Parameters

  • entitlementID: string

    The ID of the entitlement.

  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

getEntitlements

• getEntitlements(options?): Promise<(Entitlement | TestEntitlement)[]>

• Get the entitlements for this application.

  Parameters

  • 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

getGlobalCommand

• getGlobalCommand<T>(commandID, options?): Promise<T>

• Get a global application command.

  Type Parameters

  • T extends AnyApplicationCommand = AnyApplicationCommand

  Parameters

  • commandID: string

    The ID of the command.
  • Optional options: GetApplicationCommandOptions

    The options for getting the command.

  Returns Promise<T>

getGlobalCommands

• getGlobalCommands(options?): Promise<AnyApplicationCommand[]>

• Get this application's global commands.

  Parameters

  • Optional options: GetApplicationCommandOptions

    The options for getting the command.

  Returns Promise<AnyApplicationCommand[]>

getGuildCommand

• getGuildCommand<T>(guildID, commandID, options?): Promise<T>

• Get a global application command.

  Type Parameters

  • T extends AnyApplicationCommand = AnyApplicationCommand

  Parameters

  • 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>

getGuildCommands

• getGuildCommands(guildID, options?): Promise<AnyApplicationCommand[]>

• Get this application's commands in a specific guild.

  Parameters

  • guildID: string

    The ID of the guild.
  • Optional options: GetApplicationCommandOptions

    The options for getting the command.

  Returns Promise<AnyApplicationCommand[]>

getGuildPermission

• getGuildPermission(guildID, commandID): Promise<RESTGuildApplicationCommandPermissions>

• Get a command's permissions in a guild.

  Parameters

  • guildID: string

    The ID of the guild.
  • commandID: string

    The ID of the command.

  Returns Promise<RESTGuildApplicationCommandPermissions>

getGuildPermissions

• getGuildPermissions(guildID): Promise<RESTGuildApplicationCommandPermissions[]>

• Get the permissions for all commands in a guild.

  Parameters

  • guildID: string

    The ID of the guild.

  Returns Promise<RESTGuildApplicationCommandPermissions[]>

getRoleConnectionsMetadata

• getRoleConnectionsMetadata(): Promise<RoleConnectionMetadata[]>

• Get this application's role connection metadata records.

  Returns Promise<RoleConnectionMetadata[]>

getSKUs

• getSKUs(): Promise<SKU[]>

• Get the SKUs for this application.

  Returns Promise<SKU[]>

getUserRoleConnection

• getUserRoleConnection(): Promise<RoleConnection>

• Get the authenticated user's role connection object for this application. This requires the role_connections.write scope.

  Returns Promise<RoleConnection>

toJSON

• toJSON(): JSONClientApplication

• Returns JSONClientApplication

updateRoleConnectionsMetadata

• updateRoleConnectionsMetadata(metadata): Promise<RoleConnectionMetadata[]>

• Update this application's role connections metadata.

  Parameters

  • metadata: RoleConnectionMetadata[]

    The metadata records.

  Returns Promise<RoleConnectionMetadata[]>

updateUserRoleConnection

• updateUserRoleConnection(data): Promise<RoleConnection>

• Update the authenticated user's role connection object for an application. This requires the role_connections.write scope.

  Parameters

  • data: UpdateUserApplicationRoleConnectionOptions

    The metadata to update.

  Returns Promise<RoleConnection>

uploadAttachment

• uploadAttachment(options): Promise<Attachment>

• Upload an ephemeral attachment for this application. The application must have Activities enabled (the 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.

  Parameters

  • options: UploadApplicationAttachmentOptions

    The options for uploading the attachment.

  Returns Promise<Attachment>

  Caching

  This method does not cache its result.