Application

classe · Source

Represents an OAuth2 Application.

Extends: Base

Properties

id

id: Snowflake

The application's id Source

name

nullable

name: string

The name of the application Source

description

nullable

description: string

The application's description Source

icon

nullable

icon: string

The application's icon hash Source

termsOfServiceURL

nullable

termsOfServiceURL: string

The URL of the application's terms of service Source

privacyPolicyURL

nullable

privacyPolicyURL: string

The URL of the application's privacy policy Source

verifyKey

nullable

verifyKey: string

The hex-encoded key for verification in interactions and the GameSDK's GetTicket Source

roleConnectionsVerificationURL

nullable

roleConnectionsVerificationURL: string

This application's role connection verification entry point URL Source

tags

tags: Array<string>

The tags this application has (max of 5) Source

installParams

nullable

installParams: ClientApplicationInstallParams

Settings for this application's default in-app authorization Source

customInstallURL

nullable

customInstallURL: string

This application's custom installation URL Source

flags

flags: ApplicationFlags

The flags this application has Source

flagsNew

flagsNew: bigint

The complete application flags bitfield, including bits above bit 30. Discord serializes this response-only field as a string. Source

approximateGuildCount

nullable

approximateGuildCount: number

An approximate amount of guilds this application is in. Source

guildId

nullable

guildId: Snowflake

The id of the guild associated with this application. Source

cover

nullable

cover: string

The hash of the application's cover image Source

rpcOrigins

rpcOrigins: Array<string>

The application's RPC origins, if enabled Source

botRequireCodeGrant

nullable · deprecated

botRequireCodeGrant: boolean

If this application's bot requires a code grant when using the OAuth2 flow Source

botPublic

nullable · deprecated

botPublic: boolean

If this application's bot is public Source

owner

nullable

owner: User | Team

The owner of this OAuth application Source

splash

nullable

splash: string

The application's splash image hash Source

type

type: number

The type of the application Source

primarySkuId

nullable

primarySkuId: Snowflake

The ID of the application's primary SKU (game, application subscription, etc.) Source

eulaId

nullable

eulaId: Snowflake

The ID of the application's EULA Source

slug

nullable

slug: string

The URL slug that links to the primary store page of the application Source

aliases

aliases: Array<string>

Other names the application's game is associated with Source

executables

nullable

executables: Array<ApplicationExecutable>

The unique executables of the application's game Source

thirdPartySkus

nullable

thirdPartySkus: Array<ApplicationSku>

The third party SKUs of the application's game Source

hook

nullable

hook: boolean

Whether the Discord client is allowed to hook into the application's game directly Source

overlay

nullable

overlay: boolean

Whether the application's game supports the Discord overlay (default false) Source

overlayMethods

nullable

overlayMethods: number

The methods of overlaying that the application's game supports Source

overlayWarn

nullable

overlayWarn: boolean

Whether the Discord overlay is known to be problematic with this application's game (default false) Source

overlayCompatibilityHook

nullable

overlayCompatibilityHook: boolean

Whether to use the compatibility hook for the overlay (default false) Source

bot

nullable

bot: User

The bot attached to this application Source

developers

nullable

developers: Array<Company>

The companies that developed the application Source

publishers

nullable

publishers: Array<Company>

The companies that published the application Source

redirectUris

nullable

redirectUris: Array<string>

The whitelisted URLs for redirecting to during OAuth2 authorization (max 10) Source

deeplinkUri

nullable

deeplinkUri: string

The URL used for deep linking during OAuth2 authorization on mobile devices Source

integrationPublic

nullable

integrationPublic: boolean

Whether only the application owner can add the integration Source

integrationRequireCodeGrant

nullable

integrationRequireCodeGrant: boolean

Whether the integration will only be added upon completion of a full OAuth2 token exchange Source

botDisabled

nullable

botDisabled: boolean

Whether the application's bot is disabled by Discord (default false) Source

botQuarantined

nullable

botQuarantined: boolean

Whether the application's bot is quarantined by Discord Source

approximateUserInstallCount

nullable

approximateUserInstallCount: number

Approximate count of users that have authorized the application with the applications.commands scope Source

approximateUserAuthorizationCount

nullable

approximateUserAuthorizationCount: number

Approximate count of users that have OAuth2 authorizations for the application Source

internalGuildRestriction

nullable

internalGuildRestriction: number

What guilds the application can be authorized in Source

interactionsEndpointUrl

nullable

interactionsEndpointUrl: string

The URL of the application's interactions endpoint Source

interactionsVersion

nullable

interactionsVersion: number

The version of the application's interactions endpoint implementation Source

interactionsEventTypes

nullable

interactionsEventTypes: Array<string>

The enabled event webhook types to send to the interaction endpoint Source

eventWebhooksStatus

nullable

eventWebhooksStatus: number

Whether event webhooks are enabled Source

eventWebhooksUrl

nullable

eventWebhooksUrl: string

The URL of the application's event webhooks endpoint Source

eventWebhooksTypes

nullable

eventWebhooksTypes: Array<string>

The enabled event webhook types to send to the event webhooks endpoint Source

explicitContentFilter

nullable

explicitContentFilter: number

Whether uploaded media content used in application commands is scanned and deleted for explicit content Source

integrationTypesConfig

nullable

integrationTypesConfig: object

The configuration for each integration type supported by the application Source

isVerified

nullable

isVerified: boolean

Whether the application is verified Source

verificationState

nullable

verificationState: number

The current verification state of the application Source

storeApplicationState

nullable

storeApplicationState: number

The current store approval state of the commerce application Source

rpcApplicationState

nullable

rpcApplicationState: number

The current RPC approval state of the application Source

creatorMonetizationState

nullable

creatorMonetizationState: number

The current guild creator monetization state of the application Source

isDiscoverable

nullable

isDiscoverable: boolean

Whether the application is discoverable in the application directory Source

discoverabilityState

nullable

discoverabilityState: number

The current application directory discoverability state of the application Source

discoveryEligibilityFlags

nullable

discoveryEligibilityFlags: number

The current application directory eligibility flags for the application Source

isMonetized

nullable

isMonetized: boolean

Whether the application has monetization enabled Source

storefrontAvailable

nullable

storefrontAvailable: boolean

Whether the application has public subscriptions or products available for purchase Source

monetizationState

nullable

monetizationState: number

The current application monetization state of the application Source

monetizationEligibilityFlags

nullable

monetizationEligibilityFlags: number

The current application monetization eligibility flags for the application Source

maxParticipants

nullable

maxParticipants: number

The maximum possible participants in the application's embedded activity (-1 for no limit) Source

guild

readonly · nullable

guild: Guild

The guild associated with this application. Source

partial

readonly

partial: boolean

Whether this application is partial Source

createdTimestamp

readonly

createdTimestamp: number

The timestamp the application was created at Source

createdAt

readonly

createdAt: Date

The time the application was created at Source

client

readonly

client: Client

The client that instantiated this Source

Methods

fetch

async

async fetch(): Promise<Application>

Obtains this application from Discord. Returns: Promise<Application>Source

fetchRoleConnectionMetadataRecords

async

async fetchRoleConnectionMetadataRecords(): Promise<Array<ApplicationRoleConnectionMetadata>>

Gets this application's role connection metadata records Returns: Promise<Array<ApplicationRoleConnectionMetadata>>Source

fetchActivityInstance

async

async fetchActivityInstance(instanceId: string): Promise<ActivityInstance>

Fetches an activity instance for this application. Parameters

Name	Type	Description
instanceId	string	The activity instance id

Returns: Promise<ActivityInstance>Source

iconURL

iconURL(options?: StaticImageURLOptions): string

A link to the application's icon. Parameters

Name	Type	Description
options?	StaticImageURLOptions	Options for the Image URL Default: {}.

Returns: stringSource

coverURL

coverURL(options?: StaticImageURLOptions): string

A link to this application's cover image. Parameters

Name	Type	Description
options?	StaticImageURLOptions	Options for the Image URL Default: {}.

Returns: stringSource

fetchAssets

async · deprecated

async fetchAssets(): Promise<Array<ApplicationAsset>>

Gets the application's rich presence assets. Returns: Promise<Array<ApplicationAsset>>Source

toString

toString(): string

When concatenated with a string, this automatically returns the application's name instead of the Application object. Returns: string

// Logs: Application name: My App
console.log(`Application name: ${application}`);

Source