Class Application

Represents an application.

Hierarchy (view full)

ClientApplication
- Application

Index

Constructors

constructor

Accessors

createdAt

Constructors

constructor

new Application(data, client): Application
Parameters
- data: RESTApplication
- client: Client<ClientEvents>
Returns Application
Overrides ClientApplication.constructor
- Defined in lib/structures/Application.ts:99

Properties

approximateGuildCount

approximateGuildCount: number

The approximate number of guilds the application is in.

`Optional` botPublic

botPublic?: boolean

If the bot can be invited by anyone.

`Optional` botRequireCodeGrant

botRequireCodeGrant?: boolean

If authorizing the bot requires a code grant.

client

client: Client<ClientEvents>

coverImage

coverImage: null | string

This application's rich presence invite cover image hash, if any.

`Optional` customInstallURL

customInstallURL?: string

This application's default custom authorization link, if any.

description

description: string

The description of the application.

`Optional` discoverabilityState

discoverabilityState?: ApplicationDiscoverabilityState

The state of this application's discoverability.

`Optional` discoveryEligibilityFlags

discoveryEligibilityFlags?: number

The flags for this application's discovery eligibility.

entitlements

entitlements: TypedCollection<RawEntitlement | RawTestEntitlement, Entitlement | TestEntitlement, []>

The entitlements for this application. This will almost certainly be empty unless you fetch entitlements, or recieve new/updated entitlements.

`Optional` explicitContentFilter

explicitContentFilter?: ApplicationExplicitContentFilterLevel

The explicit content filter for this application.

flags

flags: number

This application's flags.

guild

guild: null | OAuthGuild

If this application is a game sold on Discord, the guild to which it has been linked. This will only be present if recieved via /applications/@me.

guildID

guildID: null | string

If this application is a game sold on Discord, the ID of the guild to which it has been linked.

hook

hook: boolean

icon

icon: null | string

The icon hash of the application.

id

id: string

`Optional` installParams

installParams?: InstallParams

Settings for this application's in-app authorization link, if enabled.

integrationTypes

integrationTypes: ApplicationIntegrationTypes[]

The install types available for this application.

integrationTypesConfig

integrationTypesConfig: IntegrationTypesConfig

The configs for the install types available for this application.

interactionsEndpointURL

interactionsEndpointURL: null | string

This applications interaction endpoint url, if any.

`Optional` interactionsEventTypes

interactionsEventTypes?: string[]

The event types that will be recieved like http interactions, if interactionsVersion is 2.

`Optional` interactionsVersion

interactionsVersion?: number

The interactions version of this application.

isMonetized

isMonetized: boolean

If this application is monetized.

`Optional` monetizationEligibilityFlags

monetizationEligibilityFlags?: number

The flags for this application's monetization eligibility.

`Optional` monetizationState

monetizationState?: ApplicationMonetizationState

This application's monetization state.

name

name: string

The name of the application.

owner

owner: null | User

The owner of this application.

`Optional` primarySKUID

primarySKUID?: string

If this application is a game sold on Discord, the id of the Game's SKU.

`Optional` privacyPolicyURL

privacyPolicyURL?: string

A URL to this application's privacy policy.

redirectURIs

redirectURIs: string[]

The redirect URIs for this application.

roleConnectionsVerificationURL

roleConnectionsVerificationURL: null | string

This application's role connections verification url, if any.

`Optional` rpcApplicationState

rpcApplicationState?: RPCApplicationState

The state of this application's RPC application.

rpcOrigins

rpcOrigins: string[]

A list of rpc origin urls, if rpc is enabled.

`Optional` slug

slug?: string

If this application is a game sold on Discord, the slug that links to its store page.

`Optional` storeApplicationState

storeApplicationState?: StoreApplicationState

The state of this application's store application state.

team

team: null | Team

The team that owns this application.

`Optional` termsOfServiceURL

termsOfServiceURL?: string

A URL to this application's terms of service.

type

type: null | number

The type of this application.

`Optional` verificationState

verificationState?: ApplicationVerificationState

The state of this application's verification.

verifyKey

verifyKey: string

The bot's hex encoded public key.

Accessors

createdAt

get createdAt(): Date
Returns Date
Inherited from ClientApplication.createdAt
- Defined in lib/structures/Base.ts:39

Methods

bulkEditGlobalCommands

bulkEditGlobalCommands(options): Promise<ApplicationCommand<ApplicationCommandTypes>[]>
Overwrite all existing global application commands.
Parameters
- options: CreateApplicationCommandOptions[]
  The commands.
Returns Promise<ApplicationCommand<ApplicationCommandTypes>[]>
Inherited from ClientApplication.bulkEditGlobalCommands
- Defined in lib/structures/ClientApplication.ts:63

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>[]>
Inherited from ClientApplication.bulkEditGuildCommands
- Defined in lib/structures/ClientApplication.ts:72

consumeEntitlement

consumeEntitlement(entitlementID): Promise<void>
Mark an entitlement as consumed.
Parameters
- entitlementID: string
  The ID of the entitlement to consume.
Returns Promise<void>
Inherited from ClientApplication.consumeEntitlement
- Defined in lib/structures/ClientApplication.ts:80

coverImageURL

coverImageURL(format?, size?): null | string
The url of this application's cover image.
Parameters
- Optional format: "jpg" | "jpeg" | "png" | "webp" | "gif"
  The format the url should be.
- Optional size: number
  The dimensions of the image.
Returns null | string
- Defined in lib/structures/Application.ts:146

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>>
Inherited from ClientApplication.createGlobalCommand
- Defined in lib/structures/ClientApplication.ts:88

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>>
Inherited from ClientApplication.createGuildCommand
- Defined in lib/structures/ClientApplication.ts:97

createTestEntitlement

createTestEntitlement(options): Promise<TestEntitlement>
Create a test entitlement.
Parameters
- options: CreateTestEntitlementOptions
  The options for creating the test entitlement.
Returns Promise<TestEntitlement>
Inherited from ClientApplication.createTestEntitlement
- Defined in lib/structures/ClientApplication.ts:105

deleteGlobalCommand

deleteGlobalCommand(commandID): Promise<void>
Delete a global application command.
Parameters
- commandID: string
  The ID of the command.
Returns Promise<void>
Inherited from ClientApplication.deleteGlobalCommand
- Defined in lib/structures/ClientApplication.ts:113

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>
Inherited from ClientApplication.deleteGuildCommand
- Defined in lib/structures/ClientApplication.ts:122

deleteTestEntitlement

deleteTestEntitlement(entitlementID): Promise<void>
Delete a test entitlement.
Parameters
- entitlementID: string
  The ID of the entitlement to delete.
Returns Promise<void>
Inherited from ClientApplication.deleteTestEntitlement
- Defined in lib/structures/ClientApplication.ts:130

edit

edit(options): Promise<Application>
Edit this application.
Parameters
- options: EditApplicationOptions
  The options for editing the application.
Returns Promise<Application>
Inherited from ClientApplication.edit
- Defined in lib/structures/ClientApplication.ts:138

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>>
Inherited from ClientApplication.editGlobalCommand
- Defined in lib/structures/ClientApplication.ts:147

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>>
Inherited from ClientApplication.editGuildCommand
- Defined in lib/structures/ClientApplication.ts:157

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>
Inherited from ClientApplication.editGuildCommandPermissions
- Defined in lib/structures/ClientApplication.ts:167

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)[]>
Inherited from ClientApplication.getEntitlements
- Defined in lib/structures/ClientApplication.ts:175

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>
Inherited from ClientApplication.getGlobalCommand
- Defined in lib/structures/ClientApplication.ts:184

getGlobalCommands

getGlobalCommands(options?): Promise<AnyApplicationCommand[]>
Get this application's global commands.
Parameters
- Optional options: GetApplicationCommandOptions
  The options for getting the command.
Returns Promise<AnyApplicationCommand[]>
Inherited from ClientApplication.getGlobalCommands
- Defined in lib/structures/ClientApplication.ts:192

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>
Inherited from ClientApplication.getGuildCommand
- Defined in lib/structures/ClientApplication.ts:202

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[]>
Inherited from ClientApplication.getGuildCommands
- Defined in lib/structures/ClientApplication.ts:211

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>
Inherited from ClientApplication.getGuildPermission
- Defined in lib/structures/ClientApplication.ts:220

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[]>
Inherited from ClientApplication.getGuildPermissions
- Defined in lib/structures/ClientApplication.ts:228

getRoleConnectionsMetadata

getRoleConnectionsMetadata(): Promise<RoleConnectionMetadata[]>
Get this application's role connection metadata records.

Returns Promise<RoleConnectionMetadata[]>
Inherited from ClientApplication.getRoleConnectionsMetadata
- Defined in lib/structures/ClientApplication.ts:235

getSKUs

getSKUs(): Promise<SKU[]>
Get the SKUs for this application.

Returns Promise<SKU[]>
Inherited from ClientApplication.getSKUs
- Defined in lib/structures/ClientApplication.ts:242

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>
Inherited from ClientApplication.getUserRoleConnection
- Defined in lib/structures/ClientApplication.ts:249

iconURL

iconURL(format?, size?): null | string
The url of this application's icon.
Parameters
- Optional format: "jpg" | "jpeg" | "png" | "webp" | "gif"
  The format the url should be.
- Optional size: number
  The dimensions of the image.
Returns null | string
- Defined in lib/structures/Application.ts:155

toJSON

toJSON(): JSONApplication
Returns JSONApplication
Overrides ClientApplication.toJSON
- Defined in lib/structures/Application.ts:159

toString

toString(): string
Returns string
Inherited from ClientApplication.toString
- Defined in lib/structures/Base.ts:64

updateRoleConnectionsMetadata

updateRoleConnectionsMetadata(metadata): Promise<RoleConnectionMetadata[]>
Update this application's role connections metadata.
Parameters
- metadata: RoleConnectionMetadata[]
  The metadata records.
Returns Promise<RoleConnectionMetadata[]>
Inherited from ClientApplication.updateRoleConnectionsMetadata
- Defined in lib/structures/ClientApplication.ts:264

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>
Inherited from ClientApplication.updateUserRoleConnection
- Defined in lib/structures/ClientApplication.ts:272

`Static` generateID

generateID(timestamp?): string
Parameters
- timestamp: number | Date = ...
Returns string
Inherited from ClientApplication.generateID
- Defined in lib/structures/Base.ts:21

`Static` getCreatedAt

getCreatedAt(id): Date
Parameters
- id: string
Returns Date
Inherited from ClientApplication.getCreatedAt
- Defined in lib/structures/Base.ts:28

`Static` getDiscordEpoch

getDiscordEpoch(id): number
Parameters
- id: string
Returns number
Inherited from ClientApplication.getDiscordEpoch
- Defined in lib/structures/Base.ts:32

Class Application

Hierarchy (view full)

Index

Constructors

Properties

Accessors

Methods

Constructors

constructor

Parameters

Returns Application

Properties

approximateGuildCount

Optional botPublic

Optional botRequireCodeGrant

client

coverImage

Optional customInstallURL

description

Optional discoverabilityState

Optional discoveryEligibilityFlags

entitlements

Optional explicitContentFilter

flags

guild

guildID

hook

icon

id

Optional installParams

integrationTypes

integrationTypesConfig

interactionsEndpointURL

Optional interactionsEventTypes

Optional interactionsVersion

isMonetized

Optional monetizationEligibilityFlags

Optional monetizationState

name

owner

Optional primarySKUID

Optional privacyPolicyURL

redirectURIs

roleConnectionsVerificationURL

Optional rpcApplicationState

rpcOrigins

Optional slug

Optional storeApplicationState

tags

team

Optional termsOfServiceURL

type

Optional verificationState

verifyKey

Accessors

createdAt

Returns Date

Methods

bulkEditGlobalCommands

Parameters

Returns Promise<ApplicationCommand<ApplicationCommandTypes>[]>

bulkEditGuildCommands

Parameters

Returns Promise<ApplicationCommand<ApplicationCommandTypes>[]>

consumeEntitlement

Parameters

Returns Promise<void>

coverImageURL

Parameters

Returns null | string

createGlobalCommand

Type Parameters

Parameters

Returns Promise<ApplicationCommandOptionConversion<T>>

createGuildCommand

Type Parameters

Parameters

Returns Promise<ApplicationCommandOptionConversion<T>>

createTestEntitlement

Parameters

`Optional` botPublic

`Optional` botRequireCodeGrant

`Optional` customInstallURL

`Optional` discoverabilityState

`Optional` discoveryEligibilityFlags

`Optional` explicitContentFilter

`Optional` installParams

`Optional` interactionsEventTypes

`Optional` interactionsVersion

`Optional` monetizationEligibilityFlags

`Optional` monetizationState

`Optional` primarySKUID

`Optional` privacyPolicyURL

`Optional` rpcApplicationState

`Optional` slug

`Optional` storeApplicationState

`Optional` termsOfServiceURL

`Optional` verificationState

`Static` generateID

`Static` getCreatedAt