Class ApplicationCommand<T>

Represents an application command.

Type Parameters

T extends ApplicationCommandTypes = ApplicationCommandTypes

Hierarchy (view full)

Base
- ApplicationCommand

Constructors

constructor

new ApplicationCommand<T>(data, client): ApplicationCommand<T>
Type Parameters
- T extends ApplicationCommandTypes = ApplicationCommandTypes
Parameters
- data: RawApplicationCommand
- client: Client<ClientEvents>
Returns ApplicationCommand<T>
Overrides Base.constructor
- Defined in lib/structures/ApplicationCommand.ts:57

Properties

`Optional` application

application?: ClientApplication

The application this command is for.

applicationID

applicationID: string

The ID of application this command is for.

client

client: Client<ClientEvents>

contexts

contexts: InteractionContextTypes[]

The contexts in which this application command can be used in.

defaultMemberPermissions

defaultMemberPermissions: null | Permission

The default permissions for this command.

description

description: T extends CHAT_INPUT
? string
: ""

The description of this command. Empty string for non CHAT_INPUT commands.

`Optional` descriptionLocalizations

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

A dictionary of locales to localized descriptions.

`Optional` descriptionLocalized

descriptionLocalized?: string

The description of this application command in the requested locale.

`Optional` dmPermission

dmPermission?: boolean

If this command can be used in direct messages (global commands only).

guildID

guildID: null | string

The id of the guild this command is in (guild commands only).

id

id: string

integrationTypes

integrationTypes: ApplicationIntegrationTypes[]

The installation contexts in which this command is available.

name

name: string

The name of this command.

`Optional` nameLocalizations

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

A dictionary of locales to localized names.

`Optional` nameLocalized

nameLocalized?: string

The description of this application command in the requested locale.

`Optional` nsfw

nsfw?: boolean

Whether the command is age restricted.

`Optional` options

options?: ApplicationCommandOptions[]

The options on this command. Only valid for CHAT_INPUT.

type

type: T

The type of this command.

version

version: string

Autoincrementing version identifier updated during substantial record changes.

Accessors

createdAt

get createdAt(): Date
Returns Date
Inherited from Base.createdAt
- Defined in lib/structures/Base.ts:39

guild

get guild(): null | Guild
The guild this command is in (guild commands only). This will throw an error if the guild is not cached.

Returns null | Guild
- Defined in lib/structures/ApplicationCommand.ts:79

Methods

delete

delete(): Promise<void>
Delete this command.

Returns Promise<void>
- Defined in lib/structures/ApplicationCommand.ts:95

edit

edit(options): Promise<ApplicationCommandOptionConversion<TypeToEdit<T>>>
Edit this command.
Parameters
- options: TypeToEdit<T>
  The options for editing the command.
Returns Promise<ApplicationCommandOptionConversion<TypeToEdit<T>>>
- Defined in lib/structures/ApplicationCommand.ts:103

editGuildCommandPermissions

editGuildCommandPermissions(options): Promise<RESTGuildApplicationCommandPermissions>
Edit this command's permissions (guild commands only). This requires a bearer token with the applications.commands.permissions.update scope.
Parameters
- options: EditApplicationCommandPermissionsOptions
  The options for editing the permissions.
Returns Promise<RESTGuildApplicationCommandPermissions>
- Defined in lib/structures/ApplicationCommand.ts:111

getGuildPermission

getGuildPermission(): Promise<RESTGuildApplicationCommandPermissions>
Get this command's permissions (guild commands only).

Returns Promise<RESTGuildApplicationCommandPermissions>
- Defined in lib/structures/ApplicationCommand.ts:121

mention

mention(sub?): string
Get a mention for this command.
Parameters
- Optional sub: [subcommand: string] | [subcommandGroup: string, subcommand: string]
  The subcommand group and/or subcommand to include (["subcommand"] or ["subcommand-group", "subcommand"]).
Returns string
- Defined in lib/structures/ApplicationCommand.ts:132

toJSON

toJSON(): JSONApplicationCommand
Returns JSONApplicationCommand
Overrides Base.toJSON
- Defined in lib/structures/ApplicationCommand.ts:140

toString

toString(): string
Returns string
Inherited from Base.toString
- Defined in lib/structures/Base.ts:64

`Static` generateID

generateID(timestamp?): string
Parameters
- timestamp: number | Date = ...
Returns string
Inherited from Base.generateID
- Defined in lib/structures/Base.ts:21

`Static` getCreatedAt

getCreatedAt(id): Date
Parameters
- id: string
Returns Date
Inherited from Base.getCreatedAt
- Defined in lib/structures/Base.ts:28

`Static` getDiscordEpoch

getDiscordEpoch(id): number
Parameters
- id: string
Returns number
Inherited from Base.getDiscordEpoch
- Defined in lib/structures/Base.ts:32

Class ApplicationCommand<T>

Type Parameters

T extends ApplicationCommandTypes = ApplicationCommandTypes

Hierarchy (view full)

Index

Constructors

Properties

Accessors

Methods

Constructors

constructor

Type Parameters

T extends ApplicationCommandTypes = ApplicationCommandTypes

Parameters

data: RawApplicationCommand

client: Client<ClientEvents>

Returns ApplicationCommand<T>

Properties

Optional application

applicationID

client

contexts

defaultMemberPermissions

description

Optional descriptionLocalizations

Optional descriptionLocalized

Optional dmPermission

guildID

id

integrationTypes

name

Optional nameLocalizations

Optional nameLocalized

Optional nsfw

Optional options

type

version

Accessors

createdAt

Returns Date

guild

Returns null | Guild

Methods

delete

Returns Promise<void>

edit

Parameters

options: TypeToEdit<T>

Returns Promise<ApplicationCommandOptionConversion<TypeToEdit<T>>>

editGuildCommandPermissions

Parameters

options: EditApplicationCommandPermissionsOptions

Returns Promise<RESTGuildApplicationCommandPermissions>

getGuildPermission

Returns Promise<RESTGuildApplicationCommandPermissions>

mention

Parameters

Optional sub: [subcommand: string] | [subcommandGroup: string, subcommand: string]

Returns string

toJSON

Returns JSONApplicationCommand

toString

Returns string

Static generateID

Parameters

timestamp: number | Date = ...

Returns string

Static getCreatedAt

Parameters

id: string

Returns Date

Static getDiscordEpoch

Parameters

id: string

Returns number

Settings

Member Visibility

Theme

On This Page

`Optional` application

`Optional` descriptionLocalizations

`Optional` descriptionLocalized

`Optional` dmPermission

`Optional` nameLocalizations

`Optional` nameLocalized

`Optional` nsfw

`Optional` options

`Optional` sub: [subcommand: string] | [subcommandGroup: string, subcommand: string]

`Static` generateID

`Static` getCreatedAt

`Static` getDiscordEpoch