Appearance

Class: CommandAPI ​

CommandAPI is a utility class for managing commands. An instance is available on BdApi. This allows plugins to register and manage their own commands.

Properties ​

Types ​

Types: object

CommandTypes ​

CommandTypes: object

CommandTypes.CHAT_INPUT ​

CHAT_INPUT: number = 1

CommandTypes.MESSAGE ​

MESSAGE: number

CommandTypes.USER ​

USER: number

InputTypes ​

InputTypes: object

InputTypes.BOT ​

BOT: number

InputTypes.BUILT_IN ​

BUILT_IN: number = 0

InputTypes.PLACEHOLDER ​

PLACEHOLDER: number

SEARCH: number

InputTypes.TEXT ​

TEXT: number

MessageEmbedTypes ​

MessageEmbedTypes: object

MessageEmbedTypes.APPLICATION_NEWS ​

APPLICATION_NEWS: string = "application_news"

MessageEmbedTypes.ARTICLE ​

ARTICLE: string

MessageEmbedTypes.AUTO_MODERATION_MESSAGE ​

AUTO_MODERATION_MESSAGE: string = "auto_moderation_message"

MessageEmbedTypes.AUTO_MODERATION_NOTIFICATION ​

AUTO_MODERATION_NOTIFICATION: string = "auto_moderation_notification"

MessageEmbedTypes.GAMING_PROFILE ​

GAMING_PROFILE: string = "gaming_profile"

MessageEmbedTypes.GIFT ​

GIFT: string

MessageEmbedTypes.GIFV ​

GIFV: string

MessageEmbedTypes.IMAGE ​

IMAGE: string

LINK: string

MessageEmbedTypes.POST_PREVIEW ​

POST_PREVIEW: string = "post_preview"

MessageEmbedTypes.RICH ​

RICH: string

MessageEmbedTypes.SAFETY_POLICY_NOTICE ​

SAFETY_POLICY_NOTICE: string = "safety_policy_notice"

MessageEmbedTypes.SAFETY_SYSTEM_NOTIFICATION ​

SAFETY_SYSTEM_NOTIFICATION: string = "safety_system_notification"

MessageEmbedTypes.TEXT ​

TEXT: string

MessageEmbedTypes.TWEET ​

TWEET: string

MessageEmbedTypes.VIDEO ​

VIDEO: string

MessageEmbedTypes.VOICE_CHANNEL ​

VOICE_CHANNEL: string = "voice_channel"

OptionTypes ​

OptionTypes: object

OptionTypes.ATTACHMENT ​

ATTACHMENT: number

OptionTypes.BOOLEAN ​

BOOLEAN: number

OptionTypes.CHANNEL ​

CHANNEL: number

OptionTypes.INTEGER ​

INTEGER: number

OptionTypes.MENTIONABLE ​

MENTIONABLE: number

OptionTypes.NUMBER ​

NUMBER: number

OptionTypes.ROLE ​

ROLE: number

OptionTypes.STRING ​

STRING: number

OptionTypes.SUB_COMMAND ​

SUB_COMMAND: number = 1

OptionTypes.SUB_COMMAND_GROUP ​

SUB_COMMAND_GROUP: number = 2

OptionTypes.USER ​

USER: number

Methods ​

getCommandsByCaller() ​

getCommandsByCaller(caller): Command[]

Gets all commands registered by a specific caller

Parameters ​

ParameterTypeDescription
callerstringName of the caller whose commands should be retrieved

Returns ​

Command[]

Array of command objects registered by the caller

register() ​

register(caller, command): (() => void) | undefined

Registers a new command

Parameters ​

ParameterTypeDescription
callerstringCaller name
commandCommandCommand object

Returns ​

(() => void) | undefined

Unregister function

unregister() ​

unregister(caller, commandId): void

Unregisters a command

Parameters ​

ParameterTypeDescription
callerstringCaller name
commandIdstringCommand ID

Returns ​

void

unregisterAll() ​

unregisterAll(caller): void

Unregisters all commands for a specific caller

Parameters ​

ParameterTypeDescription
callerstringName of the caller whose commands should be unregistered

Returns ​

void