interface APIApplicationCommand

external
export interface APIApplicationCommand

See also: https://discord.com/developers/docs/interactions/application-commands#application-command-object

application_id
contexts
default_member_permissions
default_permission
description_localizations
description_localized
description
dm_permission
guild_id
handler
id
integration_types
name_localizations
name_localized
name
nsfw
options
type
version

external
application_id : Snowflake

Unique id of the parent application

optionalexternal
contexts? : InteractionContextType[] | null = [InteractionContextType.Guild, InteractionContextType.BotDM, InteractionContextType.PrivateChannel]

Interaction context(s) where the command can be used, only for globally-scoped commands

external
default_member_permissions : Permissions | null

Set of permissions represented as a bitset

deprecatedoptionalexternal
default_permission? : boolean

Whether the command is enabled by default when the app is added to a guildIf missing, this property should be assumed as true

optionalexternal
description_localizations? : LocalizationMap | null

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

optionalexternal
description_localized? : string

The localized description

external
description : string

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

deprecatedoptionalexternal
dm_permission? : boolean

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

optionalexternal
guild_id? : Snowflake

Guild id of the command, if not global

optionalexternal
handler? : EntryPointCommandHandlerType

Determines whether the interaction is handled by the app's interactions handler or by Discord

external
id : Snowflake

Unique id of the command

optionalexternal
integration_types? : ApplicationIntegrationType[] = [ApplicationIntegrationType.GuildInstall]

Installation context(s) where the command is available, only for globally-scoped commands

optionalexternal
name_localizations? : LocalizationMap | null

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

optionalexternal
name_localized? : string

The localized name

external
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}$

optionalexternal
nsfw? : boolean = false

Indicates whether the command is age-restricted

optionalexternal
options? : APIApplicationCommandOption[]

The parameters for the CHAT_INPUT command, max 25

external
type : ApplicationCommandType

Type of the command

external
version : Snowflake

Autoincrementing version identifier updated during substantial record changes