Class InteractiveCommand<T>

Type Parameters

T extends InteractiveCommandTargets

Hierarchy

InteractiveBase<T>
- InteractiveCommand

Index

Constructors

constructor

Properties

Methods

Constructors

constructor

new InteractiveCommand<T>(name: string, access: AccessTarget[], module: Module, builder: T, forGuildId?: string): InteractiveCommand<T>

Overrides InteractiveBase.constructor
- Defined in src/Interactions/InteractiveCommand.ts:14
Type Parameters
- T extends InteractiveCommandTargets
Parameters
- name: string
- access: AccessTarget[]
- module: Module
- builder: T
- Optional forGuildId: string
Returns InteractiveCommand<T>

Properties

access

access: AccessTarget[]

Private Optional autocompleteCallback

autocompleteCallback?: AutocompleteCallback

builder

builder: T

Optional Readonly forGuildId

forGuildId?: string

isPushed

isPushed: boolean = false

isUpdated

isUpdated: boolean = true

Optional lastInteraction

lastInteraction?: InteractionTypeOf<T>

module

module: Module

Readonly name

name: string

Methods

_autocomplete

_autocomplete(interaction: AutocompleteInteraction<CacheType>): Promise<void>

- Defined in src/Interactions/InteractiveCommand.ts:55
Don't execute this function directly! It is for internal calls

Parameters
- interaction: AutocompleteInteraction<CacheType>
Returns Promise<void>

_exec

_exec(interaction: InteractionTypeOf<T>, user: User): Promise<void>

Inherited from InteractiveBase._exec
- Defined in src/Interactions/InteractiveBase.ts:25
Don't execute this function directly! It is for internal calls

Parameters
- interaction: InteractionTypeOf<T>
- user: User
Returns Promise<void>

build

build(f: ((builder: T) => Omit<T, any>)): InteractiveCommand<T>

- Defined in src/Interactions/InteractiveCommand.ts:30
Get command structure builder

Parameters
- f: ((builder: T) => Omit<T, any>)
  - - (builder: T): Omit<T, any>
    - Parameters
      - builder: T
      Returns Omit<T, any>
Returns InteractiveCommand<T>

commit

commit(): InteractiveCommand<T>

- Defined in src/Interactions/InteractiveCommand.ts:38
Mark command as ready to upload

Returns InteractiveCommand<T>

isContextMenuCommand

isContextMenuCommand(): this is InteractiveCommand<ContextMenuCommandBuilder>

- Defined in src/Interactions/InteractiveCommand.ts:23
Returns this is InteractiveCommand<ContextMenuCommandBuilder>

isSlashCommand

isSlashCommand(): this is InteractiveCommand<SlashCommandBuilder>

- Defined in src/Interactions/InteractiveCommand.ts:19
Returns this is InteractiveCommand<SlashCommandBuilder>

onAutocomplete

onAutocomplete(callback: AutocompleteCallback): InteractiveCommand<T>

- Defined in src/Interactions/InteractiveCommand.ts:47
Set command autocomplete callback function

Parameters
- callback: AutocompleteCallback
  
  function to execute when received autocomplete interaction
Returns InteractiveCommand<T>

onExecute

onExecute(callback: CallbackTypeOf<T>): InteractiveCommand<T>

Inherited from InteractiveBase.onExecute
- Defined in src/Interactions/InteractiveBase.ts:17
Set command callback function

Parameters
- callback: CallbackTypeOf<T>
  
  function to execute when received interaction
Returns InteractiveCommand<T>

Generated using TypeDoc