Class ChatInputCommandInteraction

Represents a chat input command interaction.

Hierarchy (View Summary)

CommandInteraction
- ChatInputCommandInteraction

Properties

applicationId

applicationId: string

The ID of the application (bot) this interaction is for.

appPermissions

appPermissions: Readonly<BitField>

The permissions the application (bot) has in the interaction's channel.

attachmentSizeLimit

attachmentSizeLimit: number

Maximum attachment size allowed for this interaction (in bytes).

authorizingIntegrationOwners

authorizingIntegrationOwners: APIAuthorizingIntegrationOwnersMap

channelId

channelId: null | string

The ID of the channel this interaction was sent in.

`Readonly`client

client: default

The client instance

commandGuildId

commandGuildId: null | string

The ID of the guild this command is registered to, if any

commandId

commandId: string

The ID of the invoked application command

commandName

commandName: string

The name of the invoked application command

commandType

commandType: ApplicationCommandType

The type of the invoked application command

context

context: null | number

The context in which this interaction was triggered (e.g., direct message, command, etc.).

deferred

deferred: boolean

Whether the reply has been deferred

entitlements

entitlements: APIEntitlement[]

ephemeral

ephemeral: null | boolean

Whether the reply is ephemeral (visible only to the user)

guildId

guildId: null | string

The ID of the guild this interaction was sent in (if applicable).

guildLocale

guildLocale: null | Locale

The preferred locale of the guild, if the interaction was in a guild.

id

id: string

The interaction's unique ID.

locale

locale: Locale

The locale of the user invoking the interaction (e.g., "en-US").

member

member: null | APIInteractionGuildMember

The guild member who invoked this interaction (if in a guild).

memberPermissions

memberPermissions: null | Readonly<BitField<Record<string, number>, number>>

The permissions the invoking member has in the interaction's channel.

options

options: ChatInputCommandOptions

The options passed to the command.

replied

replied: boolean

Whether this interaction has already been replied to

`Readonly`token

token: string

The interaction token used for responding.

type

type: InteractionType

The interaction's type.

user

user: APIUser

The user who invoked this interaction.

version

version: number

The interaction protocol version.

webhook

webhook: InteractionWebhook

A webhook associated with this interaction

Accessors

createdAt

get createdAt(): Date
The time the interaction was created at

Returns Date
Inherited from CommandInteraction.createdAt
- Defined in src/structures/Interaction/BaseInterction.ts:225

createdTimestamp

get createdTimestamp(): number
The timestamp the interaction was created at

Returns number
Inherited from CommandInteraction.createdTimestamp
- Defined in src/structures/Interaction/BaseInterction.ts:217

Methods

deferReply

deferReply(
    options?: Omit<
        djs.InteractionDeferReplyOptions,
        "ephemeral"
        | "fetchReply"
        | "withResponse",
    >,
): void
Parameters
- options: Omit<
      djs.InteractionDeferReplyOptions,
      "ephemeral"
      | "fetchReply"
      | "withResponse",
  > = {}
Returns void
Inherited from CommandInteraction.deferReply
- Defined in src/structures/Interaction/InteractionReponseMixin.ts:82

deleteReply

deleteReply(message?: string): Promise<void>
Parameters
- message: string = "@original"
Returns Promise<void>
Inherited from CommandInteraction.deleteReply
- Defined in src/structures/Interaction/InteractionReponseMixin.ts:238

editReply

editReply(
options: string | MessagePayload | InteractionEditReplyOptions,
): Promise<APIMessage>
Parameters
- options: string | MessagePayload | InteractionEditReplyOptions
  The new options for the message
Returns Promise<APIMessage>
Inherited from CommandInteraction.editReply
- Defined in src/structures/Interaction/InteractionReponseMixin.ts:214

fetchReply

fetchReply(message?: string): Promise<APIMessage>
Parameters
- message: string = "@original"
Returns Promise<APIMessage>
Inherited from CommandInteraction.fetchReply
- Defined in src/structures/Interaction/InteractionReponseMixin.ts:202

followUp

followUp(
options: { withResponse: true } & InteractionReplyOptions,
): Promise<APIMessage>
Send a follow-up message to this interaction.
Parameters
- options: { withResponse: true } & InteractionReplyOptions
  The options for the reply
Returns Promise<APIMessage>
Inherited from CommandInteraction.followUp
- Defined in src/structures/Interaction/InteractionReponseMixin.ts:252
followUp(
options: string | InteractionReplyOptions & { withResponse?: false },
): Promise<undefined>
Send a follow-up message to this interaction.
Parameters
- options: string | InteractionReplyOptions & { withResponse?: false }
  The options for the reply
Returns Promise<undefined>
Inherited from CommandInteraction.followUp
- Defined in src/structures/Interaction/InteractionReponseMixin.ts:255

inGuild

inGuild(): boolean
Indicates whether this interaction is received from a guild.

Returns boolean
Inherited from CommandInteraction.inGuild
- Defined in src/structures/Interaction/BaseInterction.ts:232

launchActivity

launchActivity(
options: LaunchActivityOptions & { withResponse: true },
): Promise<InteractionCallbackResponse>
Parameters
- options: LaunchActivityOptions & { withResponse: true }
Returns Promise<InteractionCallbackResponse>
Inherited from CommandInteraction.launchActivity
- Defined in src/structures/Interaction/InteractionReponseMixin.ts:273
launchActivity(
options: LaunchActivityOptions & { withResponse?: false },
): Promise<undefined>
Parameters
- options: LaunchActivityOptions & { withResponse?: false }
Returns Promise<undefined>
Inherited from CommandInteraction.launchActivity
- Defined in src/structures/Interaction/InteractionReponseMixin.ts:276

reply

reply(
options: string | InteractionReplyOptions & { withResponse?: false },
): Promise<undefined>
Creates a reply to this interaction.
Parameters
- options: string | InteractionReplyOptions & { withResponse?: false }
Returns Promise<undefined>
Remarks
Use the withResponse option to get the interaction callback response if a response has already been sent.
Example
```
await interaction.reply("Hello world!");
```
Inherited from CommandInteraction.reply
- Defined in src/structures/Interaction/InteractionReponseMixin.ts:121
reply(
options: string | InteractionReplyOptions & { withResponse: true },
): Promise<InteractionCallbackResponse>
Creates a reply to this interaction.
Parameters
- options: string | InteractionReplyOptions & { withResponse: true }
Returns Promise<InteractionCallbackResponse>
Remarks
Use the withResponse option to get the interaction callback response if a response has already been sent.
Example
```
await interaction.reply("Hello world!");
```
Inherited from CommandInteraction.reply
- Defined in src/structures/Interaction/InteractionReponseMixin.ts:124

showModal

showModal(
    modal:
        | ModalBuilder
        | APIModalInteractionResponseCallbackData
        | ModalComponentData,
    options: ShowModalOptions & { withResposne: true },
): Promise<undefined>
Parameters
- modal: ModalBuilder | APIModalInteractionResponseCallbackData | ModalComponentData
- options: ShowModalOptions & { withResposne: true }
Returns Promise<undefined>
Inherited from CommandInteraction.showModal
- Defined in src/structures/Interaction/InteractionReponseMixin.ts:465
showModal(
    modal:
        | ModalBuilder
        | APIModalInteractionResponseCallbackData
        | ModalComponentData,
    options: ShowModalOptions & { withResponse?: false },
): Promise<InteractionCallbackResponse>
Parameters
- modal: ModalBuilder | APIModalInteractionResponseCallbackData | ModalComponentData
- options: ShowModalOptions & { withResponse?: false }
Returns Promise<InteractionCallbackResponse>
Inherited from CommandInteraction.showModal
- Defined in src/structures/Interaction/InteractionReponseMixin.ts:472

Class ChatInputCommandInteraction

Hierarchy (View Summary)

Index

Properties

Accessors

Methods

Properties

applicationId

appPermissions

attachmentSizeLimit

authorizingIntegrationOwners

channelId

Readonlyclient

commandGuildId

commandId

commandName

commandType

context

deferred

entitlements

ephemeral

guildId

guildLocale

id

locale

member

memberPermissions

options

replied

Readonlytoken

type

user

version

webhook

Accessors

createdAt

Returns Date

createdTimestamp

Returns number

Methods

deferReply

Parameters

Returns void

deleteReply

Parameters

Returns Promise<void>

editReply

Parameters

Returns Promise<APIMessage>

fetchReply

Parameters

Returns Promise<APIMessage>

followUp

Parameters

Returns Promise<APIMessage>

Parameters

Returns Promise<undefined>

inGuild

Returns boolean

isAutocomplete

Returns this is AutoCompleteInteraction

isButton

Returns this is ButtonInteraction

isChannelSelectMenu

Returns this is ChannelSelectMenuInteraction

isChatInputCommand

Returns this is ChatInputCommandInteraction

isCommand

Returns this is CommandInteraction

isContextMenuCommand

Returns this is ContextMenuInteraction

isMentionableSelectMenu

Returns this is MentionableSelectMenuInteraction

isMessageComponent

Returns this is MessageComponentInteraction

isMessageContextMenuCommand

Returns this is MessageContextMenuInteraction

isModalSubmit

Returns this is ModalSubmitInteraction

isRepliable

`Readonly`client

`Readonly`token

Returns this is
| ChatInputCommandInteraction
| ContextMenuInteraction
| MessageComponentInteraction
| ModalSubmitInteraction

Returns this is
| UserSelectMenuInteraction
| RoleSelectMenuInteraction
| StringSelectMenuInteraction
| ChannelSelectMenuInteraction
| MentionableSelectMenuInteraction