get applicationId(): null | string
Returns null | string
Inherited from CommandContext.applicationId
- Defined in packages/command-context/src/lib/structures/CommandContext.ts:21

author

get author(): User
Returns User
Inherited from CommandContext.author
- Defined in packages/command-context/src/lib/structures/CommandContext.ts:25

channel

get channel(): null | TextBasedChannel
Returns null | TextBasedChannel
Inherited from CommandContext.channel
- Defined in packages/command-context/src/lib/structures/CommandContext.ts:29

channelId

get channelId(): string
Returns string
Inherited from CommandContext.channelId
- Defined in packages/command-context/src/lib/structures/CommandContext.ts:33

client

get client(): Client<true>
Returns Client<true>
Inherited from CommandContext.client
- Defined in packages/command-context/src/lib/structures/CommandContext.ts:37

commandType

get commandType(): ApplicationCommandType
Returns ApplicationCommandType
- Defined in packages/command-context/src/lib/structures/CommandInteractionContext.ts:61

createdAt

get createdAt(): Date
Returns Date
Inherited from CommandContext.createdAt
- Defined in packages/command-context/src/lib/structures/CommandContext.ts:41

createdTimestamp

get createdTimestamp(): number
Returns number
Inherited from CommandContext.createdTimestamp
- Defined in packages/command-context/src/lib/structures/CommandContext.ts:45

deferred

get deferred(): boolean
Returns boolean
- Defined in packages/command-context/src/lib/structures/CommandInteractionContext.ts:41

entitlements

get entitlements(): Collection<string, Entitlement>
Returns Collection<string, Entitlement>
- Defined in packages/command-context/src/lib/structures/CommandInteractionContext.ts:109

ephemeral

get ephemeral(): null | boolean
Returns null | boolean
- Defined in packages/command-context/src/lib/structures/CommandInteractionContext.ts:69

guild

get guild(): null | Guild
Returns null | Guild
Inherited from CommandContext.guild
- Defined in packages/command-context/src/lib/structures/CommandContext.ts:49

guildId

get guildId(): null | string
Returns null | string
Inherited from CommandContext.guildId
- Defined in packages/command-context/src/lib/structures/CommandContext.ts:53

guildLocale

get guildLocale(): null | Locale
Returns null | Locale
- Defined in packages/command-context/src/lib/structures/CommandInteractionContext.ts:105

id

get id(): string
Returns string
Inherited from CommandContext.id
- Defined in packages/command-context/src/lib/structures/CommandContext.ts:57

locale

get locale(): Locale
Returns Locale
- Defined in packages/command-context/src/lib/structures/CommandInteractionContext.ts:101

member

get member(): null | GuildMember | APIInteractionGuildMember
Returns null | GuildMember | APIInteractionGuildMember
Inherited from CommandContext.member
- Defined in packages/command-context/src/lib/structures/CommandContext.ts:61

memberPermissions

get memberPermissions(): null | Readonly<PermissionsBitField>
Returns null | Readonly<PermissionsBitField>
- Defined in packages/command-context/src/lib/structures/CommandInteractionContext.ts:97

options

get options(): Omit<CommandInteractionOptionResolver<CacheType>,
    | "getMessage"
    | "getFocused"
    | "getSubcommand"
    | "getSubcommandGroup"
    | "getBoolean"
    | "getChannel"
    | "getString"
    | "getInteger"
    | "getNumber"
    | "getUser"
    | "getMember"
    | "getRole"
    | "getAttachment"
    | "getMentionable">
Returns Omit<CommandInteractionOptionResolver<CacheType>,
    | "getMessage"
    | "getFocused"
    | "getSubcommand"
    | "getSubcommandGroup"
    | "getBoolean"
    | "getChannel"
    | "getString"
    | "getInteger"
    | "getNumber"
    | "getUser"
    | "getMember"
    | "getRole"
    | "getAttachment"
    | "getMentionable">
- Defined in packages/command-context/src/lib/structures/CommandInteractionContext.ts:49

replied

get replied(): boolean
Returns boolean
- Defined in packages/command-context/src/lib/structures/CommandInteractionContext.ts:73

token

get token(): string
Returns string
- Defined in packages/command-context/src/lib/structures/CommandInteractionContext.ts:81

type

get type(): ApplicationCommand | MessageType
Returns ApplicationCommand | MessageType
Inherited from CommandContext.type
- Defined in packages/command-context/src/lib/structures/CommandContext.ts:65

user

get user(): User
Returns User
- Defined in packages/command-context/src/lib/structures/CommandInteractionContext.ts:85

version

get version(): number
Returns number
- Defined in packages/command-context/src/lib/structures/CommandInteractionContext.ts:89

webhook

get webhook(): InteractionWebhook
Returns InteractionWebhook
- Defined in packages/command-context/src/lib/structures/CommandInteractionContext.ts:77

Methods

awaitModalSubmit

awaitModalSubmit(options): Promise<ModalSubmitInteraction<CacheType>>
Parameters
- options: AwaitModalSubmitOptions<ModalSubmitInteraction<CacheType>>
Returns Promise<ModalSubmitInteraction<CacheType>>
- Defined in packages/command-context/src/lib/structures/CommandInteractionContext.ts:168

deferReply

deferReply(options): Promise<Message<BooleanCache<CacheType>>>
Parameters
- options: InteractionDeferReplyOptions
Returns Promise<Message<BooleanCache<CacheType>>>
- Defined in packages/command-context/src/lib/structures/CommandInteractionContext.ts:121
deferReply(options?): Promise<InteractionResponse<BooleanCache<CacheType>>>
Parameters
- Optionaloptions: InteractionDeferReplyOptions
Returns Promise<InteractionResponse<BooleanCache<CacheType>>>
- Defined in packages/command-context/src/lib/structures/CommandInteractionContext.ts:125

deleteReply

deleteReply(message?): Promise<void>
Parameters
- Optionalmessage: MessageResolvable
Returns Promise<void>
- Defined in packages/command-context/src/lib/structures/CommandInteractionContext.ts:135

editReply

editReply(options): Promise<Message<BooleanCache<CacheType>>>
Parameters
- options: string | MessagePayload | InteractionEditReplyOptions
Returns Promise<Message<BooleanCache<CacheType>>>
- Defined in packages/command-context/src/lib/structures/CommandInteractionContext.ts:139

fetchReply

fetchReply(message?): Promise<Message<BooleanCache<CacheType>>>
Parameters
- Optionalmessage: string
Returns Promise<Message<BooleanCache<CacheType>>>
- Defined in packages/command-context/src/lib/structures/CommandInteractionContext.ts:145

followUp

followUp(options): Promise<Message<BooleanCache<CacheType>>>
Parameters
- options: string | MessagePayload | InteractionReplyOptions
Returns Promise<Message<BooleanCache<CacheType>>>
- Defined in packages/command-context/src/lib/structures/CommandInteractionContext.ts:149

inCachedGuild

inCachedGuild(): this is CommandInteraction<"cached">
Returns this is CommandInteraction<"cached">
- Defined in packages/command-context/src/lib/structures/CommandInteractionContext.ts:113

inGuild

inGuild(): boolean
Returns boolean
Inherited from CommandContext.inGuild
- Defined in packages/command-context/src/lib/structures/CommandContext.ts:69

inRawGuild

inRawGuild(): this is CommandInteraction<"raw">
Returns this is CommandInteraction<"raw">
- Defined in packages/command-context/src/lib/structures/CommandInteractionContext.ts:117

isAnySelectMenu

isAnySelectMenu(): this is AnySelectMenuInteraction
Returns this is AnySelectMenuInteraction
- Defined in packages/command-context/src/lib/structures/CommandInteractionContext.ts:214

isAutocomplete

isAutocomplete(): this is AutocompleteInteraction<CacheType>
Returns this is AutocompleteInteraction<CacheType>
- Defined in packages/command-context/src/lib/structures/CommandInteractionContext.ts:178

isButton

isButton(): this is ButtonInteraction<CacheType>
Returns this is ButtonInteraction<CacheType>
- Defined in packages/command-context/src/lib/structures/CommandInteractionContext.ts:174

isChannelSelectMenu

isChannelSelectMenu(): this is ChannelSelectMenuInteraction<CacheType>
Returns this is ChannelSelectMenuInteraction<CacheType>
- Defined in packages/command-context/src/lib/structures/CommandInteractionContext.ts:234

isChatInputCommand

isChatInputCommand(): this is ChatInputCommandInteraction<CacheType>
Returns this is ChatInputCommandInteraction<CacheType>
- Defined in packages/command-context/src/lib/structures/CommandInteractionContext.ts:182

isChatInputInteractionContext

isChatInputInteractionContext(): this is ChatInputCommandInteractionContext
Returns this is ChatInputCommandInteractionContext
Inherited from CommandContext.isChatInputInteractionContext
- Defined in packages/command-context/src/lib/structures/CommandContext.ts:93

isCommand

isCommand(): this is CommandInteraction<CacheType>
Returns this is CommandInteraction<CacheType>
- Defined in packages/command-context/src/lib/structures/CommandInteractionContext.ts:186

isCommandInteraction

isCommandInteraction(): this is CommandInteractionContext
Returns this is CommandInteractionContext
Inherited from CommandContext.isCommandInteraction
- Defined in packages/command-context/src/lib/structures/CommandContext.ts:89

isContextMenuCommand

isContextMenuCommand(): this is ContextMenuCommandInteraction<CacheType>
Returns this is ContextMenuCommandInteraction<CacheType>
- Defined in packages/command-context/src/lib/structures/CommandInteractionContext.ts:190

isMentionableSelectMenu

isMentionableSelectMenu(): this is MentionableSelectMenuInteraction<CacheType>
Returns this is MentionableSelectMenuInteraction<CacheType>
- Defined in packages/command-context/src/lib/structures/CommandInteractionContext.ts:230

isMessageComponent

isMessageComponent(): this is MessageComponentInteraction<CacheType>
Returns this is MessageComponentInteraction<CacheType>
- Defined in packages/command-context/src/lib/structures/CommandInteractionContext.ts:194

isMessageContext

isMessageContext(): this is MessageContext
Returns this is MessageContext
Inherited from CommandContext.isMessageContext
- Defined in packages/command-context/src/lib/structures/CommandContext.ts:85

isMessageContextMenuCommand

isMessageContextMenuCommand(): this is MessageContextMenuCommandInteraction<CacheType>
Returns this is MessageContextMenuCommandInteraction<CacheType>
- Defined in packages/command-context/src/lib/structures/CommandInteractionContext.ts:198

isMessageContextMenuInteractionContext

isMessageContextMenuInteractionContext(): this is MessageContextMenuCommandInteractionContext
Returns this is MessageContextMenuCommandInteractionContext
Inherited from CommandContext.isMessageContextMenuInteractionContext
- Defined in packages/command-context/src/lib/structures/CommandContext.ts:101

isModalSubmit

isModalSubmit(): this is ModalSubmitInteraction<CacheType>
Returns this is ModalSubmitInteraction<CacheType>
- Defined in packages/command-context/src/lib/structures/CommandInteractionContext.ts:202

isRepliable

isRepliable(): this is RepliableInteraction
Returns this is RepliableInteraction
- Defined in packages/command-context/src/lib/structures/CommandInteractionContext.ts:238

isRoleSelectMenu

isRoleSelectMenu(): this is RoleSelectMenuInteraction<CacheType>
Returns this is RoleSelectMenuInteraction<CacheType>
- Defined in packages/command-context/src/lib/structures/CommandInteractionContext.ts:226

isSelectMenu

isSelectMenu(): this is StringSelectMenuInteraction<CacheType>
Returns this is StringSelectMenuInteraction<CacheType>
- Defined in packages/command-context/src/lib/structures/CommandInteractionContext.ts:210

isStringSelectMenu

isStringSelectMenu(): this is StringSelectMenuInteraction<CacheType>
Returns this is StringSelectMenuInteraction<CacheType>
- Defined in packages/command-context/src/lib/structures/CommandInteractionContext.ts:218

isUserContextMenuCommand

isUserContextMenuCommand(): this is UserContextMenuCommandInteraction<CacheType>
Returns this is UserContextMenuCommandInteraction<CacheType>
- Defined in packages/command-context/src/lib/structures/CommandInteractionContext.ts:206

isUserContextMenuInteractionContext

isUserContextMenuInteractionContext(): this is UserContextMenuCommandInteractionContext
Returns this is UserContextMenuCommandInteractionContext
Inherited from CommandContext.isUserContextMenuInteractionContext
- Defined in packages/command-context/src/lib/structures/CommandContext.ts:97

isUserSelectMenu

isUserSelectMenu(): this is UserSelectMenuInteraction<CacheType>
Returns this is UserSelectMenuInteraction<CacheType>
- Defined in packages/command-context/src/lib/structures/CommandInteractionContext.ts:222

reply

reply(options): Promise<Message<boolean>>
Parameters
- options: string | MessagePayloadOption
Returns Promise<Message<boolean>>
Inherited from CommandContext.reply
- Defined in packages/command-context/src/lib/structures/CommandContext.ts:126

send

send(options): Promise<Message<boolean>>
Parameters
- options: string | MessagePayloadOption
Returns Promise<Message<boolean>>
Inherited from CommandContext.send
- Defined in packages/command-context/src/lib/structures/CommandContext.ts:105

sendPremiumRequired

sendPremiumRequired(): Promise<void>
Returns Promise<void>
- Defined in packages/command-context/src/lib/structures/CommandInteractionContext.ts:164

showModal

showModal(modal): Promise<void>
Parameters
- modal: APIModalInteractionResponseCallbackData | ModalComponentData | JSONEncodable<APIModalInteractionResponseCallbackData>
Returns Promise<void>
- Defined in packages/command-context/src/lib/structures/CommandInteractionContext.ts:155

toJSON

toJSON(...props): unknown
Parameters
- Rest...props: Record<string, string | boolean>[]
Returns unknown
Inherited from CommandContext.toJSON
- Defined in packages/command-context/src/lib/structures/CommandContext.ts:73

toString

toString(): string
Returns string
Inherited from CommandContext.toString
- Defined in packages/command-context/src/lib/structures/CommandContext.ts:77

valueOf

valueOf(): string
Returns string
Inherited from CommandContext.valueOf
- Defined in packages/command-context/src/lib/structures/CommandContext.ts:81

Class CommandInteractionContext

Hierarchy (view full)

Index

Constructors

Properties

Accessors

Methods

Constructors

constructor

Parameters

Returns CommandInteractionContext

Properties

Readonlycontext

Accessors

appPermissions

Returns null | Readonly<PermissionsBitField>

applicationId

Returns null | string

author

Returns User

channel

Returns null | TextBasedChannel

channelId

Returns string

client

Returns Client<true>

command

Returns null | ApplicationCommand<{}> | ApplicationCommand<{ guild: GuildResolvable; }>

commandGuildId

Returns null | string

commandId

Returns string

commandName

Returns string

commandType

Returns ApplicationCommandType

createdAt

Returns Date

createdTimestamp

Returns number

deferred

Returns boolean

entitlements

Returns Collection<string, Entitlement>

ephemeral

Returns null | boolean

guild

Returns null | Guild

guildId

Returns null | string

guildLocale

Returns null | Locale

id

Returns string

locale

Returns Locale

member

Returns null | GuildMember | APIInteractionGuildMember

memberPermissions

Returns null | Readonly<PermissionsBitField>

options

Returns Omit<CommandInteractionOptionResolver<CacheType>, | "getMessage" | "getFocused" | "getSubcommand" | "getSubcommandGroup" | "getBoolean" | "getChannel" | "getString" | "getInteger" | "getNumber" | "getUser" | "getMember" | "getRole" | "getAttachment" | "getMentionable">

replied

Returns boolean

token

Returns string

type

Returns ApplicationCommand | MessageType

user

Returns User

version

Returns number

webhook

Returns InteractionWebhook

Methods

awaitModalSubmit

Parameters

Returns Promise<ModalSubmitInteraction<CacheType>>

deferReply

Parameters

`Readonly`context

Returns null | ApplicationCommand<{}> | ApplicationCommand<{
guild: GuildResolvable;
}>

Returns Omit<CommandInteractionOptionResolver<CacheType>,
| "getMessage"
| "getFocused"
| "getSubcommand"
| "getSubcommandGroup"
| "getBoolean"
| "getChannel"
| "getString"
| "getInteger"
| "getNumber"
| "getUser"
| "getMember"
| "getRole"
| "getAttachment"
| "getMentionable">