Class CommandInteraction<T>

Represents a command interaction.

Type Parameters

T extends AnyInteractionChannel | Uncached = AnyInteractionChannel | Uncached

Hierarchy

Interaction
- CommandInteraction

Constructors

constructor

new CommandInteraction<T>(data: RawApplicationCommandInteraction, client: Client<ClientEvents>): CommandInteraction<T>
Type Parameters
- T extends Uncached | AnyInteractionChannel = Uncached | AnyInteractionChannel
Parameters
- data: RawApplicationCommandInteraction
- client: Client<ClientEvents>
Returns CommandInteraction<T>
Overrides Interaction.constructor
- Defined in lib/structures/CommandInteraction.ts:55

Properties

acknowledged

acknowledged: boolean

If this interaction has been acknowledged.

appPermissions

appPermissions: T extends AnyTextableGuildChannel ? Permission : undefined | Permission

The permissions the bot has in the channel this interaction was sent from, if this interaction is sent from a guild.

`Optional` application

application?: ClientApplication

The application this interaction is for.

applicationID

applicationID: string

The ID of the application this interaction is for.

channelID

channelID: string

The ID of the channel this interaction was sent from.

client

client: Client<ClientEvents>

data

data: ApplicationCommandInteractionData

The data associated with the interaction.

guildID

guildID: T extends AnyTextableGuildChannel ? string : null | string

The id of the guild this interaction was sent from, if applicable.

guildLocale

guildLocale: T extends AnyTextableGuildChannel ? string : undefined | string

The preferred locale of the guild this interaction was sent from, if applicable.

id

id: string

locale

locale: string

The locale of the invoking user.

member

member: T extends AnyTextableGuildChannel ? Member : null | Member

The member associated with the invoking user, if this interaction is sent from a guild.

memberPermissions

memberPermissions: T extends AnyTextableGuildChannel ? Permission : null | Permission

The permissions of the member associated with the invoking user, if this interaction is sent from a guild.

token

token: string

The token of this interaction.

type

type: APPLICATION_COMMAND

The type of this interaction.

user

user: User

The user that invoked this interaction.

version

version: 1

Read-only property, always 1

Accessors

channel

get channel(): T extends AnyInteractionChannel ? T : undefined
The channel this interaction was sent from.

Returns T extends AnyInteractionChannel ? T : undefined
- Defined in lib/structures/CommandInteraction.ts:138

createdAt

get createdAt(): Date
Returns Date
Inherited from Interaction.createdAt
- Defined in lib/structures/Base.ts:39

guild

get guild(): T extends AnyTextableGuildChannel ? Guild : null | Guild
The guild this interaction was sent from, if applicable. This will throw an error if the guild is not cached.

Returns T extends AnyTextableGuildChannel ? Guild : null | Guild
- Defined in lib/structures/CommandInteraction.ts:143

Methods

createFollowup

createFollowup(options: InteractionContent): Promise<Message<T>>
Create a followup message.
Parameters
- options: InteractionContent
  
  The options for creating the followup message.
Returns Promise<Message<T>>
- Defined in lib/structures/CommandInteraction.ts:160

createMessage

createMessage(options: InitialInteractionContent): Promise<void>
Create a message through this interaction. This is an initial response, and more than one initial response cannot be used. Use createFollowup.

Note
You cannot attach files in an initial response. Defer the interaction, then use createFollowup.
Parameters
- options: InitialInteractionContent
  
  The options for the message.
Returns Promise<void>
- Defined in lib/structures/CommandInteraction.ts:169

createModal

createModal(options: ModalData): Promise<void>
Respond to this interaction with a modal. This is an initial response, and more than one initial response cannot be used.
Parameters
- options: ModalData
  
  The options for the modal.
Returns Promise<void>
- Defined in lib/structures/CommandInteraction.ts:184

defer

defer(flags?: number): Promise<void>
Defer this interaction. This is an initial response, and more than one initial response cannot be used.
Parameters
- Optional flags: number
  
  The flags to respond with.
Returns Promise<void>
- Defined in lib/structures/CommandInteraction.ts:196

deleteFollowup

deleteFollowup(messageID: string): Promise<void>
Delete a follow-up message.
Parameters
- messageID: string
  
  The ID of the message.
Returns Promise<void>
- Defined in lib/structures/CommandInteraction.ts:208

deleteOriginal

deleteOriginal(): Promise<void>
Delete the original interaction response.

Returns Promise<void>
- Defined in lib/structures/CommandInteraction.ts:215

editFollowup

editFollowup(messageID: string, options: InteractionContent): Promise<Message<T>>
Edit a followup message.
Parameters
- messageID: string
  
  The ID of the message.
- options: InteractionContent
  
  The options for editing the followup message.
Returns Promise<Message<T>>
- Defined in lib/structures/CommandInteraction.ts:224

editOriginal

editOriginal(options: InteractionContent): Promise<Message<T>>
Edit the original interaction response.
Parameters
- options: InteractionContent
  
  The options for editing the original message.
Returns Promise<Message<T>>
- Defined in lib/structures/CommandInteraction.ts:232

getFollowup

getFollowup(messageID: string): Promise<Message<T>>
Get a followup message.
Parameters
- messageID: string
  
  The ID of the message.
Returns Promise<Message<T>>
- Defined in lib/structures/CommandInteraction.ts:240

getOriginal

getOriginal(): Promise<Message<T>>
Get the original interaction response.

Returns Promise<Message<T>>
- Defined in lib/structures/CommandInteraction.ts:247

inCachedGuildChannel

inCachedGuildChannel(): this is CommandInteraction<AnyTextableGuildChannel>
Whether this interaction belongs to a cached guild channel. The only difference on using this method over a simple if statement is to easily update all the interaction properties typing definitions based on the channel it belongs to.

Returns this is CommandInteraction<AnyTextableGuildChannel>
- Defined in lib/structures/CommandInteraction.ts:252

inPrivateChannel

inPrivateChannel(): this is CommandInteraction<Uncached | PrivateChannel>
Whether this interaction belongs to a private channel (PrivateChannel or uncached). The only difference on using this method over a simple if statement is to easily update all the interaction properties typing definitions based on the channel it belongs to.

Returns this is CommandInteraction<Uncached | PrivateChannel>
- Defined in lib/structures/CommandInteraction.ts:257

toJSON

toJSON(): JSONCommandInteraction
Returns JSONCommandInteraction
Overrides Interaction.toJSON
- Defined in lib/structures/CommandInteraction.ts:261

toString

toString(): string
Returns string
Inherited from Interaction.toString
- Defined in lib/structures/Base.ts:64

`Static` from

from<T>(data: RawInteraction, client: Client<ClientEvents>): T
Type Parameters
- T extends AnyInteraction = AnyInteraction
Parameters
- data: RawInteraction
- client: Client<ClientEvents>
Returns T
Inherited from Interaction.from
- Defined in lib/structures/Interaction.ts:42

`Static` generateID

generateID(timestamp?: number | Date): string
Parameters
- timestamp: number | Date = ...
Returns string
Inherited from Interaction.generateID
- Defined in lib/structures/Base.ts:21

`Static` getCreatedAt

getCreatedAt(id: string): Date
Parameters
- id: string
Returns Date
Inherited from Interaction.getCreatedAt
- Defined in lib/structures/Base.ts:28

`Static` getDiscordEpoch

getDiscordEpoch(id: string): number
Parameters
- id: string
Returns number
Inherited from Interaction.getDiscordEpoch
- Defined in lib/structures/Base.ts:32

Class CommandInteraction<T>

Type Parameters

T extends AnyInteractionChannel | Uncached = AnyInteractionChannel | Uncached

Hierarchy

Index

Constructors

Properties

Accessors

Methods

Constructors

constructor

Type Parameters

T extends Uncached | AnyInteractionChannel = Uncached | AnyInteractionChannel

Parameters

data: RawApplicationCommandInteraction

client: Client<ClientEvents>

Returns CommandInteraction<T>

Properties

acknowledged

appPermissions

Optional application

applicationID

channelID

client

data

guildID

guildLocale

id

locale

member

memberPermissions

token

type

user

version

Accessors

channel

Returns T extends AnyInteractionChannel ? T : undefined

createdAt

Returns Date

guild

Returns T extends AnyTextableGuildChannel ? Guild : null | Guild

Methods

createFollowup

Parameters

options: InteractionContent

Returns Promise<Message<T>>

createMessage

Note

Parameters

options: InitialInteractionContent

Returns Promise<void>

createModal

Parameters

options: ModalData

Returns Promise<void>

defer

Parameters

Optional flags: number

Returns Promise<void>

deleteFollowup

Parameters

messageID: string

Returns Promise<void>

deleteOriginal

Returns Promise<void>

editFollowup

Parameters

messageID: string

options: InteractionContent

Returns Promise<Message<T>>

editOriginal

Parameters

options: InteractionContent

Returns Promise<Message<T>>

getFollowup

Parameters

messageID: string

Returns Promise<Message<T>>

getOriginal

`Optional` application

`Optional` flags: number

`Static` from

`Static` generateID

`Static` getCreatedAt

`Static` getDiscordEpoch