Options
All
  • Public
  • Public/Protected
  • All
Menu

Interface ISlashCommand

Represents a slash command that is being provided.

Hierarchy

  • ISlashCommand

Index

Properties

command

command: string

The value which determines what the user types.

i18nDescription

i18nDescription: string

i18n string for the description of the command.

i18nParamsExample

i18nParamsExample: string

Example of the parameters or an i18n string.

Optional permission

permission: string

Optional. Permission value required for the user to have to see/use it.

providesPreview

providesPreview: boolean

Lets the clients know that this command does provide preview results.

Methods

Optional executePreviewItem

executor

  • The function which gets called when a user enters the command.

    Note: This will not get called if a preview is defined and presented to the user and the user interacts with the preview. When that happens, the executePreviewItem function will be called.

    Parameters

    Returns Promise<void>

Optional previewer

Generated using TypeDoc