Class CommandInteraction<Cached>`Abstract`

Type Parameters

Cached extends CacheType = CacheType

Hierarchy

BaseInteraction<Cached>
- CommandInteraction
  - ChatInputCommandInteraction
  - ContextMenuCommandInteraction

Index

Constructors

constructor

Accessors

channel command createdAt createdTimestamp guild

Constructors

`Protected` constructor

new CommandInteraction<Cached>(client, data): 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:1925

Properties

appPermissions

appPermissions: Readonly<PermissionsBitField>

applicationId

applicationId: string

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, string, string, null | string>

guildLocale

guildLocale: CacheTypeReducer<Cached, Locale, Locale, Locale, null | Locale>

id

id: string

locale

locale: Locale

member

member: CacheTypeReducer<Cached, GuildMember, APIInteractionGuildMember, GuildMember | APIInteractionGuildMember, null | GuildMember | APIInteractionGuildMember>

memberPermissions

memberPermissions: CacheTypeReducer<Cached, Readonly<PermissionsBitField>, Readonly<PermissionsBitField>, Readonly<PermissionsBitField>, null | Readonly<PermissionsBitField>>

options

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:1927

command

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

createdAt

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

createdTimestamp

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

guild

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

Methods

awaitModalSubmit

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

deferReply

deferReply(options): Promise<Message<BooleanCache<Cached>>>
Parameters
- options: InteractionDeferReplyOptions & {
  fetchReply: true;
  }
Returns Promise<Message<BooleanCache<Cached>>>
- Defined in node_modules/discord.js/typings/index.d.ts:583
deferReply(options?): Promise<InteractionResponse<BooleanCache<Cached>>>
Parameters
- Optional options: InteractionDeferReplyOptions
Returns Promise<InteractionResponse<BooleanCache<Cached>>>
- Defined in node_modules/discord.js/typings/index.d.ts:586

deleteReply

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

editReply

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

fetchReply

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

followUp

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

inCachedGuild

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

inGuild

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

inRawGuild

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

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:1964

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:1954

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:1953

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:1969

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:1955

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:1956

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:1957

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:1968

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:1958

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:1959

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:1960

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:1970

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:1967

isSelectMenu

isSelectMenu(): this is StringSelectMenuInteraction<Cached>
Returns this is StringSelectMenuInteraction<Cached>

Deprecated
Use isStringSelectMenu instead.
Inherited from BaseInteraction.isSelectMenu
- Defined in node_modules/discord.js/typings/index.d.ts:1963

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:1965

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:1961

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:1966

reply

reply(options): Promise<Message<BooleanCache<Cached>>>
Parameters
- options: InteractionReplyOptions & {
  fetchReply: true;
  }
Returns Promise<Message<BooleanCache<Cached>>>
- Defined in node_modules/discord.js/typings/index.d.ts:593
reply(options): Promise<InteractionResponse<BooleanCache<Cached>>>
Parameters
- options: string | MessagePayload | InteractionReplyOptions
Returns Promise<InteractionResponse<BooleanCache<Cached>>>
- Defined in node_modules/discord.js/typings/index.d.ts:594

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:604

showModal

showModal(modal): Promise<void>
Parameters
- modal: APIModalInteractionResponseCallbackData | ModalComponentData | JSONEncodable<APIModalInteractionResponseCallbackData>
Returns Promise<void>
- Defined in node_modules/discord.js/typings/index.d.ts:597

toJSON

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

`Private` transformOption

transformOption(option, resolved): CommandInteractionOption<Cached>
Parameters
- option: APIApplicationCommandOption
- resolved: undefined | APIInteractionDataResolved | APIMessageApplicationCommandInteractionDataResolved | APIUserInteractionDataResolved
Returns CommandInteractionOption<Cached>
- Defined in node_modules/discord.js/typings/index.d.ts:608

valueOf

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

Class CommandInteraction<Cached>Abstract

Type Parameters

Cached extends CacheType = CacheType

Hierarchy

Index

Constructors

Properties

Accessors

Methods

Constructors

Protected constructor

Type Parameters

Cached extends CacheType = CacheType

Parameters

client: Client<true>

data: APIInteraction

Returns CommandInteraction<Cached>

Properties

appPermissions

applicationId

authorizingIntegrationOwners

channelId

Readonly client

commandGuildId

commandId

commandName

commandType

context

deferred

entitlements

ephemeral

guildId

guildLocale

id

locale

member

memberPermissions

options

replied

Readonly token

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, null | Guild, null | Guild>

Methods

awaitModalSubmit

Parameters

options: AwaitModalSubmitOptions<ModalSubmitInteraction<CacheType>>

Returns Promise<ModalSubmitInteraction<Cached>>

deferReply

Parameters

options: InteractionDeferReplyOptions & { fetchReply: true; }

Returns Promise<Message<BooleanCache<Cached>>>

Parameters

Optional options: InteractionDeferReplyOptions

Returns Promise<InteractionResponse<BooleanCache<Cached>>>

deleteReply

Parameters

Optional message: MessageResolvable

Returns Promise<void>

editReply

Parameters

options: string | MessagePayload | InteractionEditReplyOptions

Returns Promise<Message<BooleanCache<Cached>>>

fetchReply

Parameters

Optional message: string

Returns Promise<Message<BooleanCache<Cached>>>

followUp

Class CommandInteraction<Cached>`Abstract`

`Protected` constructor

`Readonly` client

`Readonly` token

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

options: InteractionDeferReplyOptions & {
fetchReply: true;
}

`Optional` options: InteractionDeferReplyOptions

`Optional` message: MessageResolvable

`Optional` message: string

options: InteractionReplyOptions & {
fetchReply: true;
}

`Rest` ...props: Record<string, string | boolean>[]

`Private` transformOption