Class CommandInteraction<Cached>`Abstract`

Type Parameters

Cached extends CacheType = CacheType

Hierarchy (View Summary)

BaseInteraction<Cached>
- CommandInteraction

Index

Constructors

constructor

Accessors

channel command createdAt createdTimestamp guild

Constructors

`Protected`constructor

new CommandInteraction<Cached extends CacheType = CacheType>(
client: Client<true>,
data: APIInteraction,
): CommandInteraction<Cached>
Type Parameters
- Cached extends CacheType = CacheType
Parameters
- client: Client<true>
- data: APIInteraction
Returns CommandInteraction<Cached>
Inherited from BaseInteraction.constructor
- Defined in node_modules/discord.js/typings/index.d.ts:2112

Properties

applicationId

applicationId: string

appPermissions

appPermissions: Readonly<PermissionsBitField>

attachmentSizeLimit

attachmentSizeLimit: number

authorizingIntegrationOwners

authorizingIntegrationOwners: APIAuthorizingIntegrationOwnersMap

channelId

channelId: string

`Readonly`client

client: Client<true>

commandGuildId

commandGuildId: null | string

commandId

commandId: string

commandName

commandName: string

commandType

commandType: ApplicationCommandType

context

context: null | InteractionContextType

deferred

deferred: boolean

entitlements

entitlements: Collection<string, Entitlement>

ephemeral

ephemeral: null | boolean

guildId

guildId: CacheTypeReducer<Cached, string>

guildLocale

guildLocale: CacheTypeReducer<Cached, Locale>

id

id: string

locale

locale: Locale

member

member: CacheTypeReducer<Cached, GuildMember, APIInteractionGuildMember>

memberPermissions

memberPermissions: CacheTypeReducer<Cached, Readonly<PermissionsBitField>>

replied

replied: boolean

`Readonly`token

token: string

type

type: ApplicationCommand

user

user: User

version

version: number

webhook

webhook: InteractionWebhook

Accessors

channel

get channel(): CacheTypeReducer<
    Cached,
    null
    | GuildTextBasedChannel,
    null | GuildTextBasedChannel,
    null | GuildTextBasedChannel,
    null | TextBasedChannel,
>
Returns CacheTypeReducer<
    Cached,
    null
    | GuildTextBasedChannel,
    null | GuildTextBasedChannel,
    null | GuildTextBasedChannel,
    null | TextBasedChannel,
>
Inherited from BaseInteraction.channel
- Defined in node_modules/discord.js/typings/index.d.ts:2115

command

get command(): | null
| ApplicationCommand<{}>
| ApplicationCommand<{ guild: GuildResolvable }>
Returns null | ApplicationCommand<{}> | ApplicationCommand<{ guild: GuildResolvable }>
- Defined in node_modules/discord.js/typings/index.d.ts:588

createdAt

get createdAt(): Date
Returns Date
Inherited from BaseInteraction.createdAt
- Defined in node_modules/discord.js/typings/index.d.ts:2124

createdTimestamp

get createdTimestamp(): number
Returns number
Inherited from BaseInteraction.createdTimestamp
- Defined in node_modules/discord.js/typings/index.d.ts:2125

guild

get guild(): CacheTypeReducer<Cached, Guild, null>
Returns CacheTypeReducer<Cached, Guild, null>
Inherited from BaseInteraction.guild
- Defined in node_modules/discord.js/typings/index.d.ts:2126

Methods

awaitModalSubmit

awaitModalSubmit(
options: AwaitModalSubmitOptions<ModalSubmitInteraction<CacheType>>,
): Promise<ModalSubmitInteraction<Cached>>
Parameters
- options: AwaitModalSubmitOptions<ModalSubmitInteraction<CacheType>>
Returns Promise<ModalSubmitInteraction<Cached>>
- Defined in node_modules/discord.js/typings/index.d.ts:653

deferReply

deferReply(
options: InteractionDeferReplyOptions & { withResponse: true },
): Promise<InteractionCallbackResponse<BooleanCache<Cached>>>
Parameters
- options: InteractionDeferReplyOptions & { withResponse: true }
Returns Promise<InteractionCallbackResponse<BooleanCache<Cached>>>
- Defined in node_modules/discord.js/typings/index.d.ts:601
deferReply(
options: InteractionDeferReplyOptions & { fetchReply: true },
): Promise<Message<BooleanCache<Cached>>>
Parameters
- options: InteractionDeferReplyOptions & { fetchReply: true }
Returns Promise<Message<BooleanCache<Cached>>>
Deprecated
fetchReply is deprecated. Use withResponse instead or fetch the response after using the method.
- Defined in node_modules/discord.js/typings/index.d.ts:605
deferReply(
options?: InteractionDeferReplyOptions,
): Promise<InteractionResponse<BooleanCache<Cached>>>
Parameters
- Optionaloptions: InteractionDeferReplyOptions
Returns Promise<InteractionResponse<BooleanCache<Cached>>>
- Defined in node_modules/discord.js/typings/index.d.ts:608

deleteReply

deleteReply(message?: MessageResolvable): Promise<void>
Parameters
- Optionalmessage: MessageResolvable
Returns Promise<void>
- Defined in node_modules/discord.js/typings/index.d.ts:609

editReply

editReply(
options: string | MessagePayload | InteractionEditReplyOptions,
): Promise<Message<BooleanCache<Cached>>>
Parameters
- options: string | MessagePayload | InteractionEditReplyOptions
Returns Promise<Message<BooleanCache<Cached>>>
- Defined in node_modules/discord.js/typings/index.d.ts:610

fetchReply

fetchReply(message?: string): Promise<Message<BooleanCache<Cached>>>
Parameters
- Optionalmessage: string
Returns Promise<Message<BooleanCache<Cached>>>
- Defined in node_modules/discord.js/typings/index.d.ts:613

followUp

followUp(
options: string | MessagePayload | InteractionReplyOptions,
): Promise<Message<BooleanCache<Cached>>>
Parameters
- options: string | MessagePayload | InteractionReplyOptions
Returns Promise<Message<BooleanCache<Cached>>>
- Defined in node_modules/discord.js/typings/index.d.ts:614

inCachedGuild

inCachedGuild(): this is CommandInteraction<"cached">
Returns this is CommandInteraction<"cached">
Overrides BaseInteraction.inCachedGuild
- Defined in node_modules/discord.js/typings/index.d.ts:599

inGuild

inGuild(): this is CommandInteraction<"raw" | "cached">
Returns this is CommandInteraction<"raw" | "cached">
Overrides BaseInteraction.inGuild
- Defined in node_modules/discord.js/typings/index.d.ts:598

inRawGuild

inRawGuild(): this is CommandInteraction<"raw">
Returns this is CommandInteraction<"raw">
Overrides BaseInteraction.inRawGuild
- Defined in node_modules/discord.js/typings/index.d.ts:600

isAnySelectMenu

isAnySelectMenu(): this is AnySelectMenuInteraction<Cached>
Returns this is AnySelectMenuInteraction<Cached>
Inherited from BaseInteraction.isAnySelectMenu
- Defined in node_modules/discord.js/typings/index.d.ts:2155

isAutocomplete

isAutocomplete(): this is AutocompleteInteraction<Cached>
Returns this is AutocompleteInteraction<Cached>
Inherited from BaseInteraction.isAutocomplete
- Defined in node_modules/discord.js/typings/index.d.ts:2144

isButton

isButton(): this is ButtonInteraction<Cached>
Returns this is ButtonInteraction<Cached>
Inherited from BaseInteraction.isButton
- Defined in node_modules/discord.js/typings/index.d.ts:2143

isChannelSelectMenu

isChannelSelectMenu(): this is ChannelSelectMenuInteraction<Cached>
Returns this is ChannelSelectMenuInteraction<Cached>
Inherited from BaseInteraction.isChannelSelectMenu
- Defined in node_modules/discord.js/typings/index.d.ts:2160

isChatInputCommand

isChatInputCommand(): this is ChatInputCommandInteraction<Cached>
Returns this is ChatInputCommandInteraction<Cached>
Inherited from BaseInteraction.isChatInputCommand
- Defined in node_modules/discord.js/typings/index.d.ts:2145

isCommand

isCommand(): this is CommandInteraction<Cached>
Returns this is CommandInteraction<Cached>
Inherited from BaseInteraction.isCommand
- Defined in node_modules/discord.js/typings/index.d.ts:2146

isContextMenuCommand

isContextMenuCommand(): this is ContextMenuCommandInteraction<Cached>
Returns this is ContextMenuCommandInteraction<Cached>
Inherited from BaseInteraction.isContextMenuCommand
- Defined in node_modules/discord.js/typings/index.d.ts:2147

isMentionableSelectMenu

isMentionableSelectMenu(): this is MentionableSelectMenuInteraction<Cached>
Returns this is MentionableSelectMenuInteraction<Cached>
Inherited from BaseInteraction.isMentionableSelectMenu
- Defined in node_modules/discord.js/typings/index.d.ts:2159

isMessageComponent

isMessageComponent(): this is MessageComponentInteraction<Cached>
Returns this is MessageComponentInteraction<Cached>
Inherited from BaseInteraction.isMessageComponent
- Defined in node_modules/discord.js/typings/index.d.ts:2149

isMessageContextMenuCommand

isMessageContextMenuCommand(): this is MessageContextMenuCommandInteraction<
Cached,
>
Returns this is MessageContextMenuCommandInteraction<Cached>
Inherited from BaseInteraction.isMessageContextMenuCommand
- Defined in node_modules/discord.js/typings/index.d.ts:2150

isModalSubmit

isModalSubmit(): this is ModalSubmitInteraction<Cached>
Returns this is ModalSubmitInteraction<Cached>
Inherited from BaseInteraction.isModalSubmit
- Defined in node_modules/discord.js/typings/index.d.ts:2151

isPrimaryEntryPointCommand

isPrimaryEntryPointCommand(): this is PrimaryEntryPointCommandInteraction<
Cached,
>
Returns this is PrimaryEntryPointCommandInteraction<Cached>
Inherited from BaseInteraction.isPrimaryEntryPointCommand
- Defined in node_modules/discord.js/typings/index.d.ts:2148

isRepliable

isRepliable(): this is RepliableInteraction<Cached>
Returns this is RepliableInteraction<Cached>
Inherited from BaseInteraction.isRepliable
- Defined in node_modules/discord.js/typings/index.d.ts:2161

isRoleSelectMenu

isRoleSelectMenu(): this is RoleSelectMenuInteraction<Cached>
Returns this is RoleSelectMenuInteraction<Cached>
Inherited from BaseInteraction.isRoleSelectMenu
- Defined in node_modules/discord.js/typings/index.d.ts:2158

isSelectMenu

isSelectMenu(): this is StringSelectMenuInteraction<Cached>
Returns this is StringSelectMenuInteraction<Cached>
Deprecated
Use BaseInteraction.isStringSelectMenu instead.
Inherited from BaseInteraction.isSelectMenu
- Defined in node_modules/discord.js/typings/index.d.ts:2154

isStringSelectMenu

isStringSelectMenu(): this is StringSelectMenuInteraction<Cached>
Returns this is StringSelectMenuInteraction<Cached>
Inherited from BaseInteraction.isStringSelectMenu
- Defined in node_modules/discord.js/typings/index.d.ts:2156

isUserContextMenuCommand

isUserContextMenuCommand(): this is UserContextMenuCommandInteraction<Cached>
Returns this is UserContextMenuCommandInteraction<Cached>
Inherited from BaseInteraction.isUserContextMenuCommand
- Defined in node_modules/discord.js/typings/index.d.ts:2152

isUserSelectMenu

isUserSelectMenu(): this is UserSelectMenuInteraction<Cached>
Returns this is UserSelectMenuInteraction<Cached>
Inherited from BaseInteraction.isUserSelectMenu
- Defined in node_modules/discord.js/typings/index.d.ts:2157

launchActivity

launchActivity(
options: LaunchActivityOptions & { withResponse: true },
): Promise<InteractionCallbackResponse<BooleanCache<Cached>>>
Parameters
- options: LaunchActivityOptions & { withResponse: true }
Returns Promise<InteractionCallbackResponse<BooleanCache<Cached>>>
- Defined in node_modules/discord.js/typings/index.d.ts:623
launchActivity(
options?: LaunchActivityOptions & { withResponse?: false },
): Promise<undefined>
Parameters
- Optionaloptions: LaunchActivityOptions & { withResponse?: false }
Returns Promise<undefined>
- Defined in node_modules/discord.js/typings/index.d.ts:626
launchActivity(
options?: LaunchActivityOptions,
): Promise<undefined | InteractionCallbackResponse<BooleanCache<Cached>>>
Parameters
- Optionaloptions: LaunchActivityOptions
Returns Promise<undefined | InteractionCallbackResponse<BooleanCache<Cached>>>
- Defined in node_modules/discord.js/typings/index.d.ts:627

reply

reply(
options: InteractionReplyOptions & { withResponse: true },
): Promise<InteractionCallbackResponse<BooleanCache<Cached>>>
Parameters
- options: InteractionReplyOptions & { withResponse: true }
Returns Promise<InteractionCallbackResponse<BooleanCache<Cached>>>
- Defined in node_modules/discord.js/typings/index.d.ts:615
reply(
options: InteractionReplyOptions & { fetchReply: true },
): Promise<Message<BooleanCache<Cached>>>
Parameters
- options: InteractionReplyOptions & { fetchReply: true }
Returns Promise<Message<BooleanCache<Cached>>>
Deprecated
fetchReply is deprecated. Use withResponse instead or fetch the response after using the method.
- Defined in node_modules/discord.js/typings/index.d.ts:619
reply(
options: string | MessagePayload | InteractionReplyOptions,
): Promise<InteractionResponse<BooleanCache<Cached>>>
Parameters
- options: string | MessagePayload | InteractionReplyOptions
Returns Promise<InteractionResponse<BooleanCache<Cached>>>
- Defined in node_modules/discord.js/typings/index.d.ts:620

sendPremiumRequired

sendPremiumRequired(): Promise<void>
Returns Promise<void>
Deprecated
Sending a premium-style button is the new Discord behaviour.
- Defined in node_modules/discord.js/typings/index.d.ts:652

showModal

showModal(
    modal:
        | APIModalInteractionResponseCallbackData
        | JSONEncodable<APIModalInteractionResponseCallbackData>
        | ModalComponentData,
    options: ShowModalOptions & { withResponse: true },
): Promise<InteractionCallbackResponse<BooleanCache<Cached>>>
Parameters
- modal:
      | APIModalInteractionResponseCallbackData
      | JSONEncodable<APIModalInteractionResponseCallbackData>
      | ModalComponentData
- options: ShowModalOptions & { withResponse: true }
Returns Promise<InteractionCallbackResponse<BooleanCache<Cached>>>
- Defined in node_modules/discord.js/typings/index.d.ts:630
showModal(
    modal:
        | APIModalInteractionResponseCallbackData
        | JSONEncodable<APIModalInteractionResponseCallbackData>
        | ModalComponentData,
    options?: ShowModalOptions & { withResponse: true },
): Promise<InteractionCallbackResponse<BooleanCache<Cached>>>
Parameters
- modal:
      | APIModalInteractionResponseCallbackData
      | JSONEncodable<APIModalInteractionResponseCallbackData>
      | ModalComponentData
- Optionaloptions: ShowModalOptions & { withResponse: true }
Returns Promise<InteractionCallbackResponse<BooleanCache<Cached>>>
- Defined in node_modules/discord.js/typings/index.d.ts:637
showModal(
    modal:
        | APIModalInteractionResponseCallbackData
        | JSONEncodable<APIModalInteractionResponseCallbackData>
        | ModalComponentData,
    options?: ShowModalOptions,
): Promise<undefined>
Parameters
- modal:
      | APIModalInteractionResponseCallbackData
      | JSONEncodable<APIModalInteractionResponseCallbackData>
      | ModalComponentData
- Optionaloptions: ShowModalOptions
Returns Promise<undefined>
- Defined in node_modules/discord.js/typings/index.d.ts:644

toJSON

toJSON(...props: Record<string, string | boolean>[]): unknown
Parameters
- ...props: Record<string, string | boolean>[]
Returns unknown
Inherited from BaseInteraction.toJSON
- Defined in node_modules/discord.js/typings/index.d.ts:560

valueOf

valueOf(): string
Returns string
Inherited from BaseInteraction.valueOf
- Defined in node_modules/discord.js/typings/index.d.ts:561

Class CommandInteraction<Cached>Abstract

Type Parameters

Hierarchy (View Summary)

Index

Constructors

Properties

Accessors

Methods

Constructors

Protectedconstructor

Type Parameters

Parameters

Returns CommandInteraction<Cached>

Properties

applicationId

appPermissions

attachmentSizeLimit

authorizingIntegrationOwners

channelId

Readonlyclient

commandGuildId

commandId

commandName

commandType

context

deferred

entitlements

ephemeral

guildId

guildLocale

id

locale

member

memberPermissions

replied

Readonlytoken

type

user

version

webhook

Accessors

channel

Returns CacheTypeReducer< Cached, null | GuildTextBasedChannel, null | GuildTextBasedChannel, null | GuildTextBasedChannel, null | TextBasedChannel,>

command

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

createdAt

Returns Date

createdTimestamp

Returns number

guild

Returns CacheTypeReducer<Cached, Guild, null>

Methods

awaitModalSubmit

Parameters

Returns Promise<ModalSubmitInteraction<Cached>>

deferReply

Parameters

Returns Promise<InteractionCallbackResponse<BooleanCache<Cached>>>

Parameters

Returns Promise<Message<BooleanCache<Cached>>>

Deprecated

Parameters

Returns Promise<InteractionResponse<BooleanCache<Cached>>>

deleteReply

Parameters

Returns Promise<void>

editReply

Parameters

Returns Promise<Message<BooleanCache<Cached>>>

fetchReply

Parameters

Returns Promise<Message<BooleanCache<Cached>>>

followUp

Parameters

Returns Promise<Message<BooleanCache<Cached>>>

inCachedGuild

Returns this is CommandInteraction<"cached">

inGuild

Returns this is CommandInteraction<"raw" | "cached">

inRawGuild

Class CommandInteraction<Cached>`Abstract`

`Protected`constructor

`Readonly`client

`Readonly`token

Returns CacheTypeReducer<
Cached,
null
| GuildTextBasedChannel,
null | GuildTextBasedChannel,
null | GuildTextBasedChannel,
null | TextBasedChannel,
>