Skip to main content

DiscordApplication

Documentation

Documentation / @discordeno/types / DiscordApplication

Interface: DiscordApplication

Defined in: discord/application.ts:10

https://docs.discord.com/developers/resources/application#application-object-application-structure

Properties​

approximate_guild_count?​

optional approximate_guild_count?: number

Defined in: discord/application.ts:50

An approximate count of the app's guild membership.

approximate_user_authorization_count?​

optional approximate_user_authorization_count?: number

Defined in: discord/application.ts:54

Approximate count of users that have OAuth2 authorizations for the app

approximate_user_install_count?​

optional approximate_user_install_count?: number

Defined in: discord/application.ts:52

Approximate count of users that have installed the app. (authorized with application.commands as a scope)

bot?​

optional bot?: Partial<DiscordUser>

Defined in: discord/application.ts:26

Partial user object for the bot user associated with the app

bot_public​

bot_public: boolean

Defined in: discord/application.ts:22

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

bot_require_code_grant​

bot_require_code_grant: boolean

Defined in: discord/application.ts:24

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

cover_image?​

optional cover_image?: string

Defined in: discord/application.ts:46

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

custom_install_url?​

optional custom_install_url?: string

Defined in: discord/application.ts:74

the application's default custom authorization link, if enabled

description​

description: string

Defined in: discord/application.ts:18

The description of the app

event_webhooks_status​

event_webhooks_status: DiscordApplicationEventWebhookStatus

Defined in: discord/application.ts:64

If webhook events are enabled for the app. 1 to disable, and 2 to enable.

event_webhooks_types?​

optional event_webhooks_types?: DiscordWebhookEventType[]

Defined in: discord/application.ts:66

List of Webhook event types the app subscribes to

event_webhooks_url?​

optional event_webhooks_url?: string | null

Defined in: discord/application.ts:62

Event webhook URL for the app to receive webhook events

flags?​

optional flags?: ApplicationFlags

Defined in: discord/application.ts:48

The application's public flags

guild?​

optional guild?: Partial<DiscordGuild>

Defined in: discord/application.ts:40

A partial object of the associated guild

guild_id?​

optional guild_id?: string

Defined in: discord/application.ts:38

Guild associated with the app. For example, a developer support server.

icon​

icon: string | null

Defined in: discord/application.ts:16

The icon hash of the app

id​

id: string

Defined in: discord/application.ts:12

ID of the app

install_params?​

optional install_params?: DiscordInstallParams

Defined in: discord/application.ts:70

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

integration_types_config?​

optional integration_types_config?: Partial<Record<"0" | "1", DiscordApplicationIntegrationTypeConfiguration>>

Defined in: discord/application.ts:72

Default scopes and permissions for each supported installation context.

interactions_endpoint_url?​

optional interactions_endpoint_url?: string | null

Defined in: discord/application.ts:58

Interactions endpoint URL for the app

name​

name: string

Defined in: discord/application.ts:14

The name of the app

owner?​

optional owner?: Partial<DiscordUser>

Defined in: discord/application.ts:32

Partial user object containing info on the owner of the application

primary_sku_id?​

optional primary_sku_id?: string

Defined in: discord/application.ts:42

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?​

optional privacy_policy_url?: string

Defined in: discord/application.ts:30

The url of the app's privacy policy

redirect_uris?​

optional redirect_uris?: string[]

Defined in: discord/application.ts:56

Array of redirect URIs for the app

role_connections_verification_url?​

optional role_connections_verification_url?: string | null

Defined in: discord/application.ts:60

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?​

optional rpc_origins?: string[]

Defined in: discord/application.ts:20

An array of rpc origin urls, if rpc is enabled

slug?​

optional slug?: string

Defined in: discord/application.ts:44

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

tags?​

optional tags?: string[]

Defined in: discord/application.ts:68

up to 5 tags describing the content and functionality of the application

team​

team: DiscordTeam | null

Defined in: discord/application.ts:36

If the application belongs to a team, this will be a list of the members of that team

terms_of_service_url?​

optional terms_of_service_url?: string

Defined in: discord/application.ts:28

The url of the app's terms of service

verify_key​

verify_key: string

Defined in: discord/application.ts:34

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