Class ContextCommandAbstract

Hierarchy (view full)

Constructors

constructor

Properties

aliases applicationCommandRegistry chatInputCommand? contextMenuCommand? description detailedDescription enabled fullCategory location name options preconditions rawName store strategy typing

Accessors

category container parentCategory subCategory

Methods

autocompleteRun? chatInputRun contextMenuRun contextRun messagePreParse messageRun onLoad onUnload parseConstructorPreConditions parseConstructorPreConditionsCooldown parseConstructorPreConditionsNsfw parseConstructorPreConditionsRequiredClientPermissions parseConstructorPreConditionsRequiredUserPermissions parseConstructorPreConditionsRunIn registerApplicationCommands? reload resolveConstructorPreConditionsRunType supportsAutocompleteInteractions supportsChatInputCommands supportsContextMenuCommands supportsMessageCommands toJSON unload runInTypeIsSpecificsObject

Constructors

constructor

Properties

aliases

aliases: readonly string[]

The aliases for the piece.

ReadonlyapplicationCommandRegistry

applicationCommandRegistry: ApplicationCommandRegistry

The application command registry associated with this command.

Since

3.0.0

OptionalchatInputCommand

chatInputCommand?: SlashCommandBuilder

OptionalcontextMenuCommand

contextMenuCommand?: ContextMenuCommandBuilder

description

description: string

A basic summary about the command

Since

1.0.0

detailedDescription

detailedDescription: DetailedDescriptionCommand

Longer version of command's summary and how to use it

Since

1.0.0

enabled

enabled: boolean

Whether or not the piece is enabled.

ReadonlyfullCategory

fullCategory: readonly string[]

The full category for the command, can be overridden by setting the Command.Options.fullCategory option.

If Command.Options.fullCategory is not set, then:

  • If the command is loaded from the file system, then this is the command's location in file system relative to the commands folder. For example, if you have a command located at commands/General/Information/info.ts then this property will be ['General', 'Info'].
  • If the command is virtual, then this will be [].

Since

2.0.0

Readonlylocation

location: PieceLocation

The location metadata for the piece's file.

Readonlyname

name: string

The name of the piece.

Readonlyoptions

options: CommandOptions

The raw options passed to this Piece

preconditions

preconditions: PreconditionContainerArray

The preconditions to be run.

Since

1.0.0

rawName

rawName: string

The raw name of the command as provided through file name or constructor options.

This is exactly what is set by the developer, completely unmodified internally by the framework. Unlike the name which gets lowercased for storing it uniquely in the CommandStore.

Readonlystore

store: CommandStore

The store that contains the piece.

strategy

strategy: IUnorderedStrategy

The strategy to use for the lexer.

Since

1.0.0

typing

typing: boolean

If SapphireClient.typing is true, it can be overridden for a specific command using this property, set via its options. Otherwise, this property will be ignored.

Default

true

Accessors

category

  • get category(): null | string

  • The main category for the command, if any.

    This getter retrieves the first value of Command.fullCategory, if it has at least one item, otherwise it returns null.

    Returns null | string

    Note

    You can set Command.Options.fullCategory to override the built-in category resolution.

container

  • get container(): Container

  • A reference to the Container object for ease of use.

    Returns Container

    See

    container

parentCategory

  • get parentCategory(): null | string

  • The parent category for the command.

    This getter retrieves the last value of Command.fullCategory, if it has at least one item, otherwise it returns null.

    Returns null | string

    Note

    You can set Command.Options.fullCategory to override the built-in category resolution.

subCategory

  • get subCategory(): null | string

  • The sub-category for the command, if any.

    This getter retrieves the second value of Command.fullCategory, if it has at least two items, otherwise it returns null.

    Returns null | string

    Note

    You can set Command.Options.fullCategory to override the built-in category resolution.

Methods

OptionalautocompleteRun

  • autocompleteRun(interaction): unknown

  • Executes the autocomplete logic.

    :::tip

    You may use this, or alternatively create an InteractionHandler interaction handler to handle autocomplete interactions. Keep in mind that commands take precedence over interaction handlers.

    :::

    Parameters

    Returns unknown

chatInputRun

contextMenuRun

AbstractcontextRun

messagePreParse

  • messagePreParse(message, parameters, context): Awaitable<Args>

  • The message pre-parse method. This method can be overridden by plugins to define their own argument parser.

    Parameters

    • message: Message<boolean>

      The message that triggered the command.

    • parameters: string

      The raw parameters as a single string.

    • context: MessageCommandContext

      The command-context used in this execution.

    Returns Awaitable<Args>

messageRun

onLoad

  • onLoad(): unknown

  • Per-piece listener that is called when the piece is loaded into the store. Useful to set-up asynchronous initialization tasks.

    Returns unknown

onUnload

  • onUnload(): unknown

  • Per-piece listener that is called when the piece is unloaded from the store. Useful to set-up clean-up tasks.

    Returns unknown

ProtectedparseConstructorPreConditions

ProtectedparseConstructorPreConditionsCooldown

  • parseConstructorPreConditionsCooldown(options): void

  • Appends the Cooldown precondition when Command.Options.cooldownLimit and Command.Options.cooldownDelay are both non-zero.

    Parameters

    • options: CommandOptions

      The command options given from the constructor.

    Returns void

ProtectedparseConstructorPreConditionsNsfw

  • parseConstructorPreConditionsNsfw(options): void

  • Appends the NSFW precondition if Command.Options.nsfw is set to true.

    Parameters

    • options: CommandOptions

      The command options given from the constructor.

    Returns void

ProtectedparseConstructorPreConditionsRequiredClientPermissions

  • parseConstructorPreConditionsRequiredClientPermissions(options): void

  • Appends the ClientPermissions precondition when Command.Options.requiredClientPermissions resolves to a non-zero bitfield.

    Parameters

    • options: CommandOptions

      The command options given from the constructor.

    Returns void

ProtectedparseConstructorPreConditionsRequiredUserPermissions

  • parseConstructorPreConditionsRequiredUserPermissions(options): void

  • Appends the UserPermissions precondition when Command.Options.requiredUserPermissions resolves to a non-zero bitfield.

    Parameters

    • options: CommandOptions

      The command options given from the constructor.

    Returns void

ProtectedparseConstructorPreConditionsRunIn

  • parseConstructorPreConditionsRunIn(options): void

  • Appends the RunIn precondition based on the values passed, defaulting to null, which doesn't add a precondition.

    Parameters

    • options: CommandOptions

      The command options given from the constructor.

    Returns void

OptionalregisterApplicationCommands

  • registerApplicationCommands(registry): Awaitable<void>

  • Registers the application commands that should be handled by this command.

    Parameters

    • registry: ApplicationCommandRegistry

      This command's registry

    Returns Awaitable<void>

reload

  • reload(): Promise<void>

  • Reloads the piece by loading the same path in the store.

    Returns Promise<void>

ProtectedresolveConstructorPreConditionsRunType

  • resolveConstructorPreConditionsRunType(types): null | readonly ChannelType[]

  • Resolves the Command.Options.runIn option into a Command.RunInTypes array.

    Parameters

    • types: CommandRunInUnion

      The types to resolve.

    Returns null | readonly ChannelType[]

    The resolved types, or null if no types were resolved.

supportsAutocompleteInteractions

  • supportsAutocompleteInteractions(): this is AutocompleteCommand

  • Type-guard that ensures the command supports handling autocomplete interactions by checking if the handler for it is present

    Returns this is AutocompleteCommand

supportsChatInputCommands

  • supportsChatInputCommands(): this is ChatInputCommand

  • Type-guard that ensures the command supports chat input commands by checking if the handler for it is present

    Returns this is ChatInputCommand

supportsContextMenuCommands

  • supportsContextMenuCommands(): this is ContextMenuCommand

  • Type-guard that ensures the command supports context menu commands by checking if the handler for it is present

    Returns this is ContextMenuCommand

supportsMessageCommands

  • supportsMessageCommands(): this is MessageCommand

  • Type-guard that ensures the command supports message commands by checking if the handler for it is present

    Returns this is MessageCommand

toJSON

  • toJSON(): CommandJSON

  • Defines the JSON.stringify behavior of the command.

    Returns CommandJSON

unload

  • unload(): Promise<void>

  • Unloads and disables the piece.

    Returns Promise<void>

StaticrunInTypeIsSpecificsObject

  • runInTypeIsSpecificsObject(types): types is CommandSpecificRunIn

  • Parameters

    • types: CommandRunInUnion | CommandSpecificRunIn

    Returns types is CommandSpecificRunIn

Settings

Member Visibility

On This Page

Constructors
Properties
Accessors
Methods