get options(): | Omit<
    CommandInteractionOptionResolver<CacheType>,

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

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

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

            | "getMessage"
            | "getFocused"
            | "getSubcommand"
            | "getSubcommandGroup"
            | "getBoolean"
            | "getChannel"
            | "getString"
            | "getInteger"
            | "getNumber"
            | "getRole"
            | "getAttachment"
            | "getMentionable",
    >
    | null
- Defined in packages/command-context/src/lib/structures/CommandInteractionContext.ts:48

replied

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

token

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

type

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

user

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

version

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

webhook

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

Methods

awaitModalSubmit

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

deferReply

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

deleteReply

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

editReply

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

fetchReply

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

followUp

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

inCachedGuild

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

inGuild

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

inRawGuild

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

isAnySelectMenu

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

isAutocomplete

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

isButton

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

isChannelSelectMenu

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

isChatInputCommand

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

isChatInputInteractionContext

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

isCommand

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

isCommandInteraction

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

isContextMenuCommand

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

isMentionableSelectMenu

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

isMessageComponent

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

isMessageContext

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

isMessageContextMenuCommand

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

isMessageContextMenuInteractionContext

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

isModalSubmit

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

isRepliable

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

isRoleSelectMenu

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

isSelectMenu

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

isStringSelectMenu

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

isUserContextMenuCommand

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

isUserContextMenuInteractionContext

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

isUserSelectMenu

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

reply

reply(options: string | MessagePayloadOption): 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:130

send

send(options: string | MessagePayloadOption): 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:107

sendPremiumRequired

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

showModal

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

toJSON

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

toString

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

valueOf

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

Class CommandInteractionContext

Hierarchy (View Summary)

Index

Constructors

Properties

Accessors

Methods

Constructors

constructor

Parameters

Returns CommandInteractionContext

Properties

Readonlycontext

Accessors

applicationId

Returns string | null

appPermissions

Returns Readonly<PermissionsBitField>

author

Returns User

channel

Returns TextBasedChannel | null

channelId

Returns string

client

Returns Client<true>

command

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

commandGuildId

Returns string | null

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 boolean | null

guild

Returns Guild | null

guildId

Returns string | null

guildLocale

Returns Locale | null

id

Returns string

locale

Returns Locale

member

Returns GuildMember | APIInteractionGuildMember | null

memberPermissions

Returns Readonly<PermissionsBitField> | null

options

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

Returns Promise<Message<BooleanCache<CacheType>>>

`Readonly`context