Class SlashCommandContext

Represents the slash command's context when a user executes a slash command.

Hierarchy

SlashCommandContext

Index

Constructors

Methods

getArguments getRoom getSender getThreadId getTriggerId

Constructors

constructor

new SlashCommandContext(sender, room, params, threadId?, triggerId?): SlashCommandContext
Parameters
- sender: IUser
- room: IRoom
- params: string[]
- Optional threadId: string
- Optional triggerId: string
Returns SlashCommandContext
- Defined in src/definition/slashcommands/SlashCommandContext.ts:9

Methods

getArguments

getArguments(): string[]
The arguments passed into the command.

Returns string[]
- Defined in src/definition/slashcommands/SlashCommandContext.ts:22

getRoom

getRoom(): IRoom
The room where the command was sent in.

Returns IRoom
- Defined in src/definition/slashcommands/SlashCommandContext.ts:17

getSender

getSender(): IUser
The user who sent the command.

Returns IUser
- Defined in src/definition/slashcommands/SlashCommandContext.ts:12

getThreadId

getThreadId(): string
Returns string
- Defined in src/definition/slashcommands/SlashCommandContext.ts:26

getTriggerId

getTriggerId(): string
Returns string
- Defined in src/definition/slashcommands/SlashCommandContext.ts:30

Generated using TypeDoc