SlashCommandContext | discord-rose

Hierarchy

SlashCommandContext

Implements

Omit<CommandContext, "reply" | "send" | "sendFile" | "embed" | "args">

Index

Constructors

constructor

Properties

Accessors

Methods

Constructors

constructor

new SlashCommandContext(opts: { args: (string | number | boolean)[]; command: CommandOptions; interaction: Interaction; prefix: string; ran: string; worker: Worker }): SlashCommandContext

- Defined in src/structures/SlashCommandContext.ts:85
Parameters
- opts: { args: (string | number | boolean)[]; command: CommandOptions; interaction: Interaction; prefix: string; ran: string; worker: Worker }
  - args: (string | number | boolean)[]
  - command: CommandOptions
  - interaction: Interaction
  - prefix: string
  - ran: string
  - worker: Worker
Returns SlashCommandContext

Properties

args

args: (string | number | boolean)[]

Command arguments

command

command: CommandOptions

Command options object

interaction

interaction: Interaction

Message which command was ran with

isInteraction

isInteraction: boolean = true

Whether or not a command is an interaction or not

options

options: InteractionOptions = {}

Interaction options if ran as a slash command

prefix

prefix: string

Prefix command was ran with

ran

ran: string

Actual command that was ran (including possible aliases)

worker

worker: Worker

Worker

Accessors

author

get author(): APIUser

- Defined in src/structures/SlashCommandContext.ts:103
Author of the message

Returns APIUser

channel

get channel(): undefined | APIChannel

- Defined in src/structures/SlashCommandContext.ts:119
Channel where the message was sent

Returns undefined | APIChannel

embed

get embed(): Embed<null>

- Defined in src/structures/SlashCommandContext.ts:224
Makes an embed to send

example

ctx.embed .title('Hello') .send()

Returns Embed<null>

guild

get guild(): CachedGuild

- Defined in src/structures/SlashCommandContext.ts:110
Guild where the message was sent

Returns CachedGuild

me

get me(): APIGuildMember

- Defined in src/structures/SlashCommandContext.ts:135
Bot's memeber within the guild

Returns APIGuildMember

member

get member(): APIInteractionGuildMember

- Defined in src/structures/SlashCommandContext.ts:126
Member who sent the message

Returns APIInteractionGuildMember

message

get message(): APIMessage

- Defined in src/structures/SlashCommandContext.ts:54
Returns APIMessage

Methods

delete

delete(): Promise<never>

Implementation of Omit.delete
- Defined in src/structures/SlashCommandContext.ts:50
Returns Promise<never>

dm

dm(data: MessageTypes): Promise<APIMessage>

Implementation of Omit.dm
- Defined in src/structures/SlashCommandContext.ts:194
Sends a message to the user who ran the command

Parameters
- data: MessageTypes
  
  Data for message
Returns Promise<APIMessage>

error

error(message: string | Promise<string>): Promise<void>

Implementation of Omit.error
- Defined in src/structures/SlashCommandContext.ts:182
Runs an error through sendback of commands.error

Parameters
- message: string | Promise<string>
  
  Message of error
Returns Promise<void>

hasPerms

hasPerms(perms: "createInvites" | "kick" | "ban" | "administrator" | "manageChannels" | "manageGuild" | "addReactions" | "auditLog" | "prioritySpeaker" | "stream" | "viewChannel" | "sendMessages" | "tts" | "manageMessages" | "embed" | "files" | "readHistory" | "mentionEveryone" | "externalEmojis" | "viewInsights" | "connect" | "speak" | "mute" | "deafen" | "move" | "useVoiceActivity" | "nickname" | "manageNicknames" | "manageRoles" | "webhooks" | "emojis" | "useSlashCommands" | "useApplicationCommands" | "requestToSpeak" | "manageThreads" | "usePublicThreads" | "usePrivateThreads" | "createPublicThreads" | "createPrivateThreads" | "useExternalStickers" | "sendMessagesInThreads"): boolean

Implementation of Omit.hasPerms
- Defined in src/structures/SlashCommandContext.ts:236
Whether or not the running user has a certain permission

Parameters
- perms: "createInvites" | "kick" | "ban" | "administrator" | "manageChannels" | "manageGuild" | "addReactions" | "auditLog" | "prioritySpeaker" | "stream" | "viewChannel" | "sendMessages" | "tts" | "manageMessages" | "embed" | "files" | "readHistory" | "mentionEveryone" | "externalEmojis" | "viewInsights" | "connect" | "speak" | "mute" | "deafen" | "move" | "useVoiceActivity" | "nickname" | "manageNicknames" | "manageRoles" | "webhooks" | "emojis" | "useSlashCommands" | "useApplicationCommands" | "requestToSpeak" | "manageThreads" | "usePublicThreads" | "usePrivateThreads" | "createPublicThreads" | "createPrivateThreads" | "useExternalStickers" | "sendMessagesInThreads"
  
  Permission to test
Returns boolean

myPerms

myPerms(perms: "createInvites" | "kick" | "ban" | "administrator" | "manageChannels" | "manageGuild" | "addReactions" | "auditLog" | "prioritySpeaker" | "stream" | "viewChannel" | "sendMessages" | "tts" | "manageMessages" | "embed" | "files" | "readHistory" | "mentionEveryone" | "externalEmojis" | "viewInsights" | "connect" | "speak" | "mute" | "deafen" | "move" | "useVoiceActivity" | "nickname" | "manageNicknames" | "manageRoles" | "webhooks" | "emojis" | "useSlashCommands" | "useApplicationCommands" | "requestToSpeak" | "manageThreads" | "usePublicThreads" | "usePrivateThreads" | "createPublicThreads" | "createPrivateThreads" | "useExternalStickers" | "sendMessagesInThreads"): boolean

Implementation of Omit.myPerms
- Defined in src/structures/SlashCommandContext.ts:245
Whether or not the bot user has a certain permission

Parameters
- perms: "createInvites" | "kick" | "ban" | "administrator" | "manageChannels" | "manageGuild" | "addReactions" | "auditLog" | "prioritySpeaker" | "stream" | "viewChannel" | "sendMessages" | "tts" | "manageMessages" | "embed" | "files" | "readHistory" | "mentionEveryone" | "externalEmojis" | "viewInsights" | "connect" | "speak" | "mute" | "deafen" | "move" | "useVoiceActivity" | "nickname" | "manageNicknames" | "manageRoles" | "webhooks" | "emojis" | "useSlashCommands" | "useApplicationCommands" | "requestToSpeak" | "manageThreads" | "usePublicThreads" | "usePrivateThreads" | "createPublicThreads" | "createPrivateThreads" | "useExternalStickers" | "sendMessagesInThreads"
  
  Permission to test
Returns boolean

react

react(): Promise<never>

Implementation of Omit.react
- Defined in src/structures/SlashCommandContext.ts:46
Returns Promise<never>

reply

reply(data: MessageTypes, mention?: boolean, ephemeral?: boolean): Promise<null>

- Defined in src/structures/SlashCommandContext.ts:146
Replies to the invoking message

Parameters
- data: MessageTypes
  
  Data for message
- mention: boolean = false
- ephemeral: boolean = false
Returns Promise<null>

nothing

send

send(data: MessageTypes, ephemeral?: boolean): Promise<null>

- Defined in src/structures/SlashCommandContext.ts:161
Sends a message in the same channel as invoking message

Parameters
- data: MessageTypes
  
  Data for message
- ephemeral: boolean = false
Returns Promise<null>

Message sent

sendFile

sendFile(file: { buffer: Buffer; name: string }, extra?: MessageTypes): Promise<null>

- Defined in src/structures/SlashCommandContext.ts:204
Sends a file to the same channel

Parameters
- file: { buffer: Buffer; name: string }
  
  File buffer
  - buffer: Buffer
  - name: string
- Optional extra: MessageTypes
  
  Extra message options
Returns Promise<null>

typing

typing(): Promise<null>

Implementation of Omit.typing
- Defined in src/structures/SlashCommandContext.ts:211
Starts typing in the channel

Returns Promise<null>

Generated using TypeDoc