Class ApplicationCommand

The base component class that other components extend from.

Hierarchy (view full)

_BaseComponent
- ApplicationCommand

Index

Constructors

constructor

new ApplicationCommand(key, client, options): ApplicationCommand
Parameters
- key: string
- client: BetterClient
- options: ApplicationCommandOptions
Returns ApplicationCommand
Overrides _BaseComponent.constructor
- Defined in packages/lib/src/classes/ApplicationCommand.ts:30

Properties

`Readonly` authorOnly

authorOnly: boolean

Whether this component can only be used by the author of the interaction.

`Readonly` client

client: BetterClient

The client that instantiated this component.

`Readonly` cooldown

cooldown: number

The cooldown of this component. This is in milliseconds.

`Readonly` description

description: string

The description of the command

`Optional` `Readonly` dmPermission

dmPermission?: boolean

Whether this component can be used in DMs.

`Readonly` key

key: string

The key of this component. This is used to identify the component, and is usually used as the custom ID or the command name.

`Readonly` options

options: ApplicationCommandOptionData[] = []

The options of the command

Default

[]

`Optional` `Readonly` permissions

permissions?: PermissionsBitField

The permissions required from the user to run this component.

`Readonly` type

type: ApplicationCommandType = ApplicationCommandType.ChatInput

The type of the command

Default

ApplicationCommandType.ChatInput

Methods

autocomplete

autocomplete(_interaction, _option): Promise<void>
Parameters
- _interaction: AutocompleteInteraction<CacheType>
- _option: AutocompleteFocusedOption
Returns Promise<void>
- Defined in packages/lib/src/classes/ApplicationCommand.ts:49

run

run(_interaction): Promise<any>
Parameters
- _interaction: ChatInputCommandInteraction<CacheType> | MessageContextMenuCommandInteraction<CacheType> | UserContextMenuCommandInteraction<CacheType>
Returns Promise<any>
Overrides _BaseComponent.run
- Defined in packages/lib/src/classes/ApplicationCommand.ts:41

specificValidate

specificValidate(_interaction): Promise<null | APIEmbed>
Parameters
- _interaction: BaseInteraction<CacheType>
Returns Promise<null | APIEmbed>
Inherited from _BaseComponent.specificValidate
- Defined in packages/lib/src/classes/_BaseComponent.ts:144

validate

validate(interaction): Promise<null | APIEmbed>
Parameters
- interaction: BaseInteraction<CacheType>
Returns Promise<null | APIEmbed>
Inherited from _BaseComponent.validate
- Defined in packages/lib/src/classes/_BaseComponent.ts:70

Class ApplicationCommand

Hierarchy (view full)

Index

Constructors

Properties

Methods

Constructors

constructor

Parameters

Returns ApplicationCommand

Properties

`Readonly` authorOnly

`Readonly` client

`Readonly` cooldown

`Readonly` description

`Optional` `Readonly` dmPermission

`Readonly` key

`Readonly` options

Default

`Optional` `Readonly` permissions

`Readonly` type

Default

Methods

autocomplete

Parameters

Returns Promise<void>

run

Parameters

Returns Promise<any>

specificValidate

Parameters

Returns Promise<null | APIEmbed>

validate

Parameters

Returns Promise<null | APIEmbed>

Settings

Member Visibility

Theme

On This Page

Class ApplicationCommand

Hierarchy (view full)

Index

Constructors

Properties

Methods

Constructors

constructor

Parameters

Returns ApplicationCommand

Properties

Readonly authorOnly

Readonly client

Readonly cooldown

Readonly description

Optional Readonly dmPermission

Readonly key

Readonly options

Default

Optional Readonly permissions

Readonly type

Default

Methods

autocomplete

Parameters

Returns Promise<void>

run

Parameters

Returns Promise<any>

specificValidate

Parameters

Returns Promise<null | APIEmbed>

validate

Parameters

Returns Promise<null | APIEmbed>

Settings

Member Visibility

Theme

On This Page

`Readonly` authorOnly

`Readonly` client

`Readonly` cooldown

`Readonly` description

`Optional` `Readonly` dmPermission

`Readonly` key

`Readonly` options

`Optional` `Readonly` permissions

`Readonly` type