Interface APIApplication

Hierarchy

  • APIApplication

Properties

approximate_guild_count?: number

Approximate count of guilds the application has been added to

approximate_user_install_count?: number

Approximate count of users that have installed the app

bot?: APIUser

Partial user object for the bot user associated with the application

bot_public: boolean

When false only app owner can join the app's bot to guilds

bot_require_code_grant: boolean

When true the app's bot will only join upon completion of the full oauth2 code grant flow

cover_image?: string

If this application is a game sold on Discord, this field will be the hash of the image on store embeds

custom_install_url?: string

The application's default custom authorization link, if enabled

description: string

The description of the app

A partial object of the associated guild

guild_id?: string

If this application is a game sold on Discord, this field will be the guild to which it has been linked

icon: null | string

The icon hash of the app

id: string

The id of the app

Settings for the application's default in-app authorization link, if enabled

integration_types_config?: APIApplicationIntegrationTypesConfigMap

Default scopes and permissions for each supported installation context. Value for each key is an integration type configuration object

Unstable

interactions_endpoint_url?: string

The interactions endpoint URL for the application

name: string

The name of the app

owner?: APIUser

Partial user object containing info on the owner of the application

See https://discord.com/developers/docs/resources/user#user-object

primary_sku_id?: string

If this application is a game sold on Discord, this field will be the id of the "Game SKU" that is created, if exists

privacy_policy_url?: string

The url of the application's privacy policy

redirect_uris?: string[]

Array of redirect URIs for the application

role_connections_verification_url?: string

The application's role connection verification entry point, which when configured will render the app as a verification method in the guild role verification configuration

rpc_origins?: string[]

An array of rpc origin urls, if rpc is enabled

slug?: string

If this application is a game sold on Discord, this field will be the URL slug that links to the store page

summary: ""

An empty string

Deprecated

This field will be removed in v11

tags?: [string, string?, string?, string?, string?]

Up to 5 tags of max 20 characters each describing the content and functionality of the application

team: null | APITeam
terms_of_service_url?: string

The url of the application's terms of service

verify_key: string

The hexadecimal encoded key for verification in interactions and the GameSDK's GetTicket function

See https://discord.com/developers/docs/game-sdk/applications#getticket

Generated using TypeDoc