Interface ISlashCommand

command

i18nDescription

i18nParamsExample

Optional permission

providesPreview

Optional executePreviewItem

• executePreviewItem(item, context, read, modify, http, persis): Promise<void>

• The function which gets executed whenever a user selects a preview item.

  Parameters

  • item: ISlashCommandPreviewItem

  • context: SlashCommandContext

  • read: IRead

  • modify: IModify

  • http: IHttp

  • persis: IPersistence

  Returns Promise<void>

executor

• executor(context, read, modify, http, persis): Promise<void>

• 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

  • context: SlashCommandContext

  • read: IRead

  • modify: IModify

  • http: IHttp

  • persis: IPersistence

  Returns Promise<void>

Optional previewer

• previewer(context, read, modify, http, persis): Promise<ISlashCommandPreview>

• The function which gets called whenever a user starts typing the command and the providesPreview is set to true. Max amount returned to the client is 10 and no more, period.

  Parameters

  • context: SlashCommandContext

  • read: IRead

  • modify: IModify

  • http: IHttp

  • persis: IPersistence

  Returns Promise<ISlashCommandPreview>