Class SlashCommandContext

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

Hierarchy

SlashCommandContext

Index

Constructors

constructor

Methods

Constructors

constructor

new SlashCommandContext(sender: IUser, room: IRoom, params: string[], threadId?: string, triggerId?: string): SlashCommandContext

- Defined in src/definition/slashcommands/SlashCommandContext.ts:8
Parameters
- sender: IUser
- room: IRoom
- params: string[]
- Optional threadId: string
- Optional triggerId: string
Returns SlashCommandContext

Methods

getArguments

getArguments(): string[]

- Defined in src/definition/slashcommands/SlashCommandContext.ts:28
The arguments passed into the command.

Returns string[]

getRoom

getRoom(): IRoom

- Defined in src/definition/slashcommands/SlashCommandContext.ts:23
The room where the command was sent in.

Returns IRoom

getSender

getSender(): IUser

- Defined in src/definition/slashcommands/SlashCommandContext.ts:18
The user who sent the command.

Returns IUser

getThreadId

getThreadId(): string

- Defined in src/definition/slashcommands/SlashCommandContext.ts:32
Returns string

getTriggerId

getTriggerId(): string

- Defined in src/definition/slashcommands/SlashCommandContext.ts:36
Returns string

Generated using TypeDoc