Class ApplicationCommand

Hierarchy

BaseStructure
- ApplicationCommand

Index

Constructors

constructor

Properties

Accessors

Methods

Constructors

constructor

new ApplicationCommand(client: Client, data: APIApplicationCommand, guild?: Guild): ApplicationCommand

Overrides BaseStructure.constructor
- Defined in src/structures/ApplicationCommand.ts:13
Parameters
- client: Client
- data: APIApplicationCommand
- Optional guild: Guild
Returns ApplicationCommand

Properties

client

client: Client

The client that instantiated this structure

data

data: APIApplicationCommand

Raw command data

guild

guild: undefined | Guild

The guild this command is part of

Accessors

applicationId

get applicationId(): string

- Defined in src/structures/ApplicationCommand.ts:19
Unique id of the parent application

Returns string

defaultMemberPermissions

get defaultMemberPermissions(): PermissionsBitField

- Defined in src/structures/ApplicationCommand.ts:53
The default bitfield used to determine whether this command be used in a guild

Returns PermissionsBitField

description

get description(): string

- Defined in src/structures/ApplicationCommand.ts:43
The description of the command

Returns string

descriptionLocalizations

get descriptionLocalizations(): undefined | null | Partial<Record<"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" | "sv-SE" | "th" | "tr" | "uk" | "vi", null | string>>

- Defined in src/structures/ApplicationCommand.ts:48
Localization dictionary for the description field

Returns undefined | null | Partial<Record<"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" | "sv-SE" | "th" | "tr" | "uk" | "vi", null | string>>

dmPermission

get dmPermission(): undefined | null | boolean

- Defined in src/structures/ApplicationCommand.ts:58
Whether the command can be used in dms

Returns undefined | null | boolean

guildId

get guildId(): undefined | string

- Defined in src/structures/ApplicationCommand.ts:68
The guild's Id this command is part of, this may be non-null when guild is null

Returns undefined | string

id

get id(): string

- Defined in src/structures/ApplicationCommand.ts:24
Unique Id of the command

Returns string

name

get name(): string

- Defined in src/structures/ApplicationCommand.ts:33
The name of the command

Returns string

nameLocalizations

get nameLocalizations(): undefined | null | Partial<Record<"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" | "sv-SE" | "th" | "tr" | "uk" | "vi", null | string>>

- Defined in src/structures/ApplicationCommand.ts:38
Localization dictionary for the name field

Returns undefined | null | Partial<Record<"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" | "sv-SE" | "th" | "tr" | "uk" | "vi", null | string>>

options

get options(): APIApplicationCommandOption[]

- Defined in src/structures/ApplicationCommand.ts:63
The options for the command

Returns APIApplicationCommandOption[]

type

get type(): ApplicationCommandType

- Defined in src/structures/ApplicationCommand.ts:28
Returns ApplicationCommandType

Methods

clone

clone(): any

Inherited from BaseStructure.clone
- Defined in src/structures/BaseStructure.ts:10
Returns any

delete

delete(): Promise<undefined>

- Defined in src/structures/ApplicationCommand.ts:113
Deletes this command

Returns Promise<undefined>

edit

edit(data: Partial<ApplicationCommand>): Promise<ApplicationCommand>

- Defined in src/structures/ApplicationCommand.ts:80
Edits this application command
example
```
command.edit({ description: 'Shows the bot latency.' })
```
Parameters
- data: Partial<ApplicationCommand>
  
  The data to update the command with
Returns Promise<ApplicationCommand>

fetch

fetch(): Promise<ApplicationCommand>

- Defined in src/structures/ApplicationCommand.ts:121
Fetches this command

Returns Promise<ApplicationCommand>

Private parseData

parseData(data: APIApplicationCommand, guild?: Guild): ApplicationCommand

- Defined in src/structures/ApplicationCommand.ts:136
Parameters
- data: APIApplicationCommand
- Optional guild: Guild
Returns ApplicationCommand

setDMPermission

setDMPermission(dmPermission?: boolean): Promise<ApplicationCommand>

- Defined in src/structures/ApplicationCommand.ts:108
Edits the dm permission of this ApplicationCommand

Parameters
- dmPermission: boolean = true
Returns Promise<ApplicationCommand>

setDefaultMemberPermissions

setDefaultMemberPermissions(defaultMemberPermissions: PermissionsBitField): Promise<ApplicationCommand>

- Defined in src/structures/ApplicationCommand.ts:103
Edits the default member permissions of this ApplicationCommand

Parameters
- defaultMemberPermissions: PermissionsBitField
Returns Promise<ApplicationCommand>

setDescription

setDescription(description: string): Promise<ApplicationCommand>

- Defined in src/structures/ApplicationCommand.ts:98
Edits the description of this ApplicationCommand

Parameters
- description: string
Returns Promise<ApplicationCommand>

setName

setName(name: string): Promise<ApplicationCommand>

- Defined in src/structures/ApplicationCommand.ts:93
Edits the name of this ApplicationCommand

Parameters
- name: string
Returns Promise<ApplicationCommand>

toString

toString(): string

- Defined in src/structures/ApplicationCommand.ts:131
Return the command name and options name

Returns string

Generated using TypeDoc version 0.22.16, the 9/16/2022 at 1:09:15 AM