Documentation / @imvu/bot / CommandContext

Interface: CommandContext<S>

Defined in: packages/bot/src/Bot.ts:102

Type Parameters

Type Parameter	Default type
S extends MessageSource	MessageSource

Properties

args

args: string[];

Defined in: packages/bot/src/Bot.ts:110

---

argText

argText: string;

Defined in: packages/bot/src/Bot.ts:111

---

author

author: User;

Defined in: packages/bot/src/Bot.ts:106

---

bot

bot: Bot;

Defined in: packages/bot/src/Bot.ts:103

---

command

command: string;

Defined in: packages/bot/src/Bot.ts:109

The canonical command name (not the alias that was typed).

---

message

message: BotMessage;

Defined in: packages/bot/src/Bot.ts:104

---

participant

participant: ChatParticipant | null;

Defined in: packages/bot/src/Bot.ts:107

---

role

role: Role;

Defined in: packages/bot/src/Bot.ts:113

The author's role in this source.

---

source

source: S;

Defined in: packages/bot/src/Bot.ts:105

Methods

reply()

reply(text): Promise<void>;

Defined in: packages/bot/src/Bot.ts:114

Parameters

Parameter	Type
text	string

Returns

Promise<void>

---

whisper()

whisper(text): Promise<void>;

Defined in: packages/bot/src/Bot.ts:116

Whisper the author.

Parameters

Parameter	Type
text	string

Returns

Promise<void>