Class Application

Represents an application.

Hierarchy (view full)

Constructors

Properties

Accessors

Methods

Constructors

Properties

aliases?: string[]
approvedConsoles?: ApprovableConsoleType[]

The approved console types for social SDK builds

approximateGuildCount?: number

The approximate number of guilds the application is in.

approximateUserAuthorizationCount?: number

Approximate count of users that have OAuth2 authorizations for the application

approximateUserInstallCount?: number

The approximate number of users this application has been installed by.

botApproximateGuildCount?: number

Approximate count of guilds the application's bot is in

botDisabled?: boolean

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

botPublic?: boolean

Deprecated

If the bot can be invited by anyone.

botQuarantined?: boolean

Whether the application's bot is quarantined by Discord; quarantined bots cannot join more guilds or start new direct messages (default false)

botRequireCodeGrant?: boolean

Deprecated

If authorizing the bot requires a code grant.

connectionEntrypointURL?: string

The URL which users will be directed to when connecting their account in the application to their Discord account

coverImage?: null | string

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

creatorMonetizationState?: number

The current guild creator monetization state of the application

customInstallURL?: string

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

deeplinkURI?: string

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

description: string

The description of the application.

developers?: ApplicationCompany[]

The companies that developed the application

discoverabilityState?: ApplicationDiscoverabilityState

The state of this application's discoverability.

discoveryEligibilityFlags?: number

The flags for this application's discovery eligibility.

embeddedActivityConfig?: EmbeddedActivityConfig

The configuration for the application's embedded activity

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

eulaID?: string

The ID of the EULA required to play the application's game

eventWebhooksStatus?: ApplicationEventWebhookStatus

If webhook events are enabled for the app.

eventWebhooksTypes?: ("APPLICATION_AUTHORIZED" | "APPLICATION_DEAUTHORIZED" | "ENTITLEMENT_CREATE" | "QUEST_USER_ENROLLMENT")[]

List of Webhook event types the app subscribes to.

eventWebhooksURL?: null | string

Event webhooks URL for the app to receive webhook events.

executables?: ApplicationExecutable[]

The unique executables of the application's game

The explicit content filter for this application.

flags: number

This application's flags.

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?: null | string

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

hook: boolean

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

icon: null | string

The icon hash of the application.

id: string
installParams?: InstallParams

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

integrationPublic?: boolean

Whether only the application owner can add the integration

integrationRequireCodeGrant?: boolean

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

integrationTypes?: ApplicationIntegrationTypes[]

The install types available for this application.

integrationTypesConfig?: IntegrationTypesConfig

The configs for the install types available for this application.

interactionsEndpointURL?: null | string

This applications interaction endpoint url, if any.

interactionsEventTypes?: string[]

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

interactionsVersion?: ApplicationInteractionsVersion

The interactions version of this application.

internalGuildRestriction?: ApplicationInternalGuildRestriction

What guilds the application can be authorized in

isDiscoverable: boolean

Whether the application is discoverable in the application directory

isMonetized: boolean

If this application is monetized.

isVerified: boolean

Whether the application is verified

maxParticipants?: number

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

monetizationEligibilityFlags?: number

The flags for this application's monetization eligibility.

monetizationState?: ApplicationMonetizationState

This application's monetization state.

name: string

The name of the application.

overlay?: boolean

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

overlayCompatibilityHook?: boolean

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

overlayMethods?: number

The methods of overlaying that the application's game supports

overlayWarn?: boolean

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

owner?: null | User

The owner of this application.

parentID?: string

The ID of the parent application

pricingLocalizationStrategy?: "localized_price_sets"

The pricing localization strategy used for the application's store presence

primarySKUID?: string

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

privacyPolicyURL?: string

A URL to this application's privacy policy.

publishers?: ApplicationCompany[]

The companies that published the application

redirectURIs?: string[]

The redirect URIs for this application.

roleConnectionsVerificationURL?: null | string

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

rpcApplicationState?: RPCApplicationState

The state of this application's RPC application.

rpcOrigins?: string[]

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

slug?: string

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

storeApplicationState?: StoreApplicationState

The state of this application's store application state.

storefrontAvailable: boolean

Whether the application has public subscriptions or products available for purchase

tags?: string[]

The tags for this application.

team?: null | Team

The team that owns this application.

termsOfServiceURL?: string

A URL to this application's terms of service.

thirdPartySKUs?: SKU[]

The third party SKUs of the application's game

type: null | ApplicationType

The type of this application.

verificationState?: ApplicationVerificationState

The state of this application's verification.

verifyKey: string

The bot's hex encoded public key.

Accessors

Methods

  • 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

  • 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