Interface APIApplicationCommand

Hierarchy

  • APIApplicationCommand

Properties

application_id: string

Unique id of the parent application

contexts?: null | InteractionContextType[]

Interaction context(s) where the command can be used, only for globally-scoped commands. By default, all interaction context types included for new commands [0,1,2].

Unstable

default_member_permissions: null | string

Set of permissions represented as a bitset

default_permission?: boolean

Whether the command is enabled by default when the app is added to a guild

If missing, this property should be assumed as true

Deprecated

Use dm_permission and/or default_member_permissions instead

description: string

1-100 character description for CHAT_INPUT commands, empty string for USER and MESSAGE commands

description_localizations?: null | Partial<Record<"id" | "en-US" | "en-GB" | "bg" | "zh-CN" | "zh-TW" | "hr" | "cs" | "da" | "nl" | "fi" | "fr" | "de" | "el" | "hi" | "hu" | "it" | "ja" | "ko" | "lt" | "no" | "pl" | "pt-BR" | "ro" | "ru" | "es-ES" | "es-419" | "sv-SE" | "th" | "tr" | "uk" | "vi", null | string>>

Localization dictionary for the description field. Values follow the same restrictions as description

description_localized?: string

The localized description

dm_permission?: boolean

Indicates whether the command is available in DMs with the app, only for globally-scoped commands. By default, commands are visible

Deprecated

Use contexts instead

guild_id?: string

Guild id of the command, if not global

id: string

Unique id of the command

integration_types?: ApplicationIntegrationType[]

Installation context(s) where the command is available, only for globally-scoped commands. Defaults to GUILD_INSTALL ([0])

Unstable

name: string

1-32 character name; CHAT_INPUT command names must be all lowercase matching ^[-_\p{L}\p{N}\p{sc=Deva}\p{sc=Thai}]{1,32}$

name_localizations?: null | Partial<Record<"id" | "en-US" | "en-GB" | "bg" | "zh-CN" | "zh-TW" | "hr" | "cs" | "da" | "nl" | "fi" | "fr" | "de" | "el" | "hi" | "hu" | "it" | "ja" | "ko" | "lt" | "no" | "pl" | "pt-BR" | "ro" | "ru" | "es-ES" | "es-419" | "sv-SE" | "th" | "tr" | "uk" | "vi", null | string>>

Localization dictionary for the name field. Values follow the same restrictions as name

name_localized?: string

The localized name

nsfw?: boolean

Indicates whether the command is age-restricted, defaults to false

The parameters for the CHAT_INPUT command, max 25

Type of the command

version: string

Autoincrementing version identifier updated during substantial record changes

Generated using TypeDoc