ChatCommandInit | commandbot

Intialization options of chat command

interface

Hierarchy

PermissionGuildCommandInit
- ChatCommandInit

Index

Properties

Optional aliases

aliases?: string | string[]

Different string that can be used with prefix to invoke the command

Optional announceSuccess

announceSuccess?: boolean

Whether to send a built-in success message when the command has completed (if no other response is defined)

Optional default_permission

default_permission?: boolean

Discord API default permission

Optional description

description?: string

Command description

Optional dm

dm?: boolean

Whether this command should be callable using private messages with bot

Optional ephemeral

ephemeral?: EphemeralType

Whether a reply should be visible only to the caller

NONE - bot replies are public and visible to everyone in a text channel
INTERACTIONS - bot will mark responses to Discord interactions as ephemeral and they will only be visible to the command caller
FULL - INTERACTIONS + responses to prefix interactions will be sent as direct messages to the command caller

Optional function

function?: CommandFunction

Command function (will be executed when calling a command)

Optional guilds

guilds?: string[]

List of Guild IDs in which the command can be called

name

name: string

Command name

Optional parameters

parameters?: ParameterSchema[] | "simple" | "no_input"

List of object defining all parameters of the command

Optional permissions

permissions?: CommandPermissionsInit

Object with permissions' options and resolvables

Optional slash

slash?: boolean

Whether this command should be registered as a slash command

Optional usage

usage?: string

Command usage (if undefined, the usage will be automatically generated using parameters)

Optional visible

visible?: boolean

Whether this command is visible in the help message