Interface APIApplicationCommand

See

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

interface APIApplicationCommand {
    application_id: string;
    contexts?: null | InteractionContextType[];
    default_member_permissions: null | string;
    default_permission?: boolean;
    description: string;
    description_localizations?: null | Partial<Record<Locale, null | string>>;
    description_localized?: string;
    dm_permission?: boolean;
    guild_id?: string;
    handler?: EntryPointCommandHandlerType;
    id: string;
    integration_types?: ApplicationIntegrationType[];
    name: string;
    name_localizations?: null | Partial<Record<Locale, null | string>>;
    name_localized?: string;
    nsfw?: boolean;
    options?: APIApplicationCommandOption[];
    type: ApplicationCommandType;
    version: string;
}

Properties

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

Properties

application_id

application_id: string

Unique id of the parent application

Optionalcontexts

contexts?: null | InteractionContextType[]

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

Default Value

[InteractionContextType.Guild, InteractionContextType.BotDM, InteractionContextType.PrivateChannel]

default_member_permissions

default_member_permissions: null | string

Set of permissions represented as a bitset

Optionaldefault_permission

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 APIApplicationCommand.dm_permission and/or APIApplicationCommand.default_member_permissions instead

description

description: string

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

Optionaldescription_localizations

description_localizations?: null | Partial<Record<Locale, null | string>>

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

Optionaldescription_localized

description_localized?: string

The localized description

Optionaldm_permission

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 APIApplicationCommand.contexts instead

Optionalguild_id

guild_id?: string

Guild id of the command, if not global

Optionalhandler

handler?: EntryPointCommandHandlerType

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

Remarks

This is only available for ApplicationCommandType.PrimaryEntryPoint commands

id

id: string

Unique id of the command

Optionalintegration_types

integration_types?: ApplicationIntegrationType[]

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

Default Value

[ApplicationIntegrationType.GuildInstall]

name

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

Optionalname_localizations

name_localizations?: null | Partial<Record<Locale, null | string>>

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

Optionalname_localized

name_localized?: string

The localized name

Optionalnsfw

nsfw?: boolean

Indicates whether the command is age-restricted

Default Value

false

Optionaloptions

options?: APIApplicationCommandOption[]

The parameters for the CHAT_INPUT command, max 25

type

type: ApplicationCommandType

Type of the command

version

version: string

Autoincrementing version identifier updated during substantial record changes

Settings

Member Visibility

On This Page

Properties