Class: CommandAPI<Bounded>

Defined in: src/betterdiscord/api/commands.ts:18

CommandAPI is a utility class for managing commands. Instance is accessible through the BdApi. This allows plugins to register and manage their own commands.

Type Parameters

Type Parameter
Bounded extends boolean

Properties

Types

Types: {
  CommandTypes: {
     CHAT_INPUT: number;
     MESSAGE: number;
     USER: number;
  };
  InputTypes: {
     BOT: number;
     BUILT_IN: number;
     PLACEHOLDER: number;
     SEARCH: number;
     TEXT: number;
  };
  MessageEmbedTypes: {
     APPLICATION_NEWS: string;
     ARTICLE: string;
     AUTO_MODERATION_MESSAGE: string;
     AUTO_MODERATION_NOTIFICATION: string;
     GAMING_PROFILE: string;
     GIFT: string;
     GIFV: string;
     IMAGE: string;
     LINK: string;
     POST_PREVIEW: string;
     RICH: string;
     SAFETY_POLICY_NOTICE: string;
     SAFETY_SYSTEM_NOTIFICATION: string;
     TEXT: string;
     TWEET: string;
     VIDEO: string;
     VOICE_CHANNEL: string;
  };
  OptionTypes: {
     ATTACHMENT: number;
     BOOLEAN: number;
     CHANNEL: number;
     INTEGER: number;
     MENTIONABLE: number;
     NUMBER: number;
     ROLE: number;
     STRING: number;
     SUB_COMMAND: number;
     SUB_COMMAND_GROUP: number;
     USER: number;
  };
};

Defined in: src/betterdiscord/api/commands.ts:26

CommandTypes

CommandTypes: {
  CHAT_INPUT: number;
  MESSAGE: number;
  USER: number;
};

CommandTypes.CHAT_INPUT

CHAT_INPUT: number = 1;

CommandTypes.MESSAGE

MESSAGE: number = 3;

CommandTypes.USER

USER: number = 2;

InputTypes

InputTypes: {
  BOT: number;
  BUILT_IN: number;
  PLACEHOLDER: number;
  SEARCH: number;
  TEXT: number;
};

InputTypes.BOT

BOT: number = 3;

InputTypes.BUILT_IN

BUILT_IN: number = 0;

InputTypes.PLACEHOLDER

PLACEHOLDER: number = 4;

InputTypes.SEARCH

SEARCH: number = 2;

InputTypes.TEXT

TEXT: number = 1;

MessageEmbedTypes

MessageEmbedTypes: {
  APPLICATION_NEWS: string;
  ARTICLE: string;
  AUTO_MODERATION_MESSAGE: string;
  AUTO_MODERATION_NOTIFICATION: string;
  GAMING_PROFILE: string;
  GIFT: string;
  GIFV: string;
  IMAGE: string;
  LINK: string;
  POST_PREVIEW: string;
  RICH: string;
  SAFETY_POLICY_NOTICE: string;
  SAFETY_SYSTEM_NOTIFICATION: string;
  TEXT: string;
  TWEET: string;
  VIDEO: string;
  VOICE_CHANNEL: string;
};

MessageEmbedTypes.APPLICATION_NEWS

APPLICATION_NEWS: string = "application_news";

MessageEmbedTypes.ARTICLE

ARTICLE: string = "article";

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 = "gift";

MessageEmbedTypes.GIFV

GIFV: string = "gifv";

MessageEmbedTypes.IMAGE

IMAGE: string = "image";

MessageEmbedTypes.LINK

LINK: string = "link";

MessageEmbedTypes.POST_PREVIEW

POST_PREVIEW: string = "post_preview";

MessageEmbedTypes.RICH

RICH: string = "rich";

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 = "text";

MessageEmbedTypes.TWEET

TWEET: string = "tweet";

MessageEmbedTypes.VIDEO

VIDEO: string = "video";

MessageEmbedTypes.VOICE_CHANNEL

VOICE_CHANNEL: string = "voice_channel";

OptionTypes

OptionTypes: {
  ATTACHMENT: number;
  BOOLEAN: number;
  CHANNEL: number;
  INTEGER: number;
  MENTIONABLE: number;
  NUMBER: number;
  ROLE: number;
  STRING: number;
  SUB_COMMAND: number;
  SUB_COMMAND_GROUP: number;
  USER: number;
};

OptionTypes.ATTACHMENT

ATTACHMENT: number = 11;

OptionTypes.BOOLEAN

BOOLEAN: number = 5;

OptionTypes.CHANNEL

CHANNEL: number = 7;

OptionTypes.INTEGER

INTEGER: number = 4;

OptionTypes.MENTIONABLE

MENTIONABLE: number = 9;

OptionTypes.NUMBER

NUMBER: number = 10;

OptionTypes.ROLE

ROLE: number = 8;

OptionTypes.STRING

STRING: number = 3;

OptionTypes.SUB_COMMAND

SUB_COMMAND: number = 1;

OptionTypes.SUB_COMMAND_GROUP

SUB_COMMAND_GROUP: number = 2;

OptionTypes.USER

USER: number = 6;

Methods

getCommandsByCaller()

getCommandsByCaller(caller: string): Command[];

Defined in: src/betterdiscord/api/commands.ts:95

Gets all commands registered by a specific caller

Parameters

Parameter	Type	Description
caller	string	Name of the caller whose commands should be retrieved

Returns

Command[]

Array of command objects registered by the caller

---

register()

register(...args: [...(Bounded extends false ? [caller: string] : [])[], Command]): () => void | undefined;

Defined in: src/betterdiscord/api/commands.ts:39

Registers a new command

Parameters

Parameter	Type
...args	[...(Bounded extends false ? [caller: string] : [])[], Command]

Returns

() => void | undefined

Unregister function

---

unregister()

unregister(...args: [...(Bounded extends false ? [caller: string] : [])[], string]): void;

Defined in: src/betterdiscord/api/commands.ts:55

Unregisters a command

Parameters

Parameter	Type
...args	[...(Bounded extends false ? [caller: string] : [])[], string]

Returns

void

---

unregisterAll()

unregisterAll(caller: string): void;

Defined in: src/betterdiscord/api/commands.ts:85

Unregisters all commands for a specific caller

Parameters

Parameter	Type	Description
caller	string	Name of the caller whose commands should be unregistered

Returns

void