Class ComponentInteraction<V, T>

Represents a component interaction.

Type Parameters

V extends BUTTON | SelectMenuTypes = BUTTON | SelectMenuTypes
T extends AnyTextChannelWithoutGroup | Uncached = AnyTextChannelWithoutGroup | Uncached

Hierarchy

Interaction
- ComponentInteraction

Constructors

constructor

new ComponentInteraction<V, T>(data: RawMessageComponentInteraction, client: Client<ClientEvents>): ComponentInteraction<V, T>
Type Parameters
- V extends BUTTON | SelectMenuTypes = BUTTON | SelectMenuTypes
- T extends Uncached | AnyTextChannelWithoutGroup = Uncached | AnyTextChannelWithoutGroup
Parameters
- data: RawMessageComponentInteraction
- client: Client<ClientEvents>
Returns ComponentInteraction<V, T>
Overrides Interaction.constructor
- Defined in lib/structures/ComponentInteraction.ts:55

Properties

acknowledged

acknowledged: boolean

If this interaction has been acknowledged.

appPermissions

appPermissions: T extends AnyGuildTextChannel ? 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: V extends BUTTON ? MessageComponentButtonInteractionData : MessageComponentSelectMenuInteractionData

The data associated with the interaction.

guildID

guildID: T extends AnyGuildTextChannel ? string : null | string

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

guildLocale

guildLocale: T extends AnyGuildTextChannel ? 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 AnyGuildTextChannel ? Member : undefined | Member

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

memberPermissions

memberPermissions: T extends AnyGuildTextChannel ? Permission : undefined | Permission

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

message

message: Message<T>

The message the interaction is from.

token

token: string

The token of this interaction.

type

type: MESSAGE_COMPONENT

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 AnyTextChannelWithoutGroup ? T : undefined
The channel this interaction was sent from.

Returns T extends AnyTextChannelWithoutGroup ? T : undefined
- Defined in lib/structures/ComponentInteraction.ts:127

createdAt

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

guild

get guild(): T extends AnyGuildTextChannel ? 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 AnyGuildTextChannel ? Guild : null | Guild
- Defined in lib/structures/ComponentInteraction.ts:132

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/ComponentInteraction.ts:152

createMessage

createMessage(options: InteractionContent): Promise<void>
Create a message through this interaction. This is an initial response, and more than one initial response cannot be used. Use createFollowup.
Parameters
- options: InteractionContent
  
  The options for the message.
Returns Promise<void>
- Defined in lib/structures/ComponentInteraction.ts:160

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/ComponentInteraction.ts:172

defer

defer(flags?: number): Promise<void>
Defer this interaction with a DEFERRED_CHANNEL_MESSAGE_WITH_SOURCE response. 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/ComponentInteraction.ts:184

deferUpdate

deferUpdate(flags?: number): Promise<void>
Defer this interaction with a DEFERRED_UPDATE_MESSAGE response. 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/ComponentInteraction.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/ComponentInteraction.ts:208

deleteOriginal

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

Returns Promise<void>
- Defined in lib/structures/ComponentInteraction.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/ComponentInteraction.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/ComponentInteraction.ts:232

editParent

editParent(options: InteractionContent): Promise<void>
Edit the message this interaction is from. If this interaction has already been acknowledged, use editOriginal.
Parameters
- options: InteractionContent
  
  The options for editing the message.
Returns Promise<void>
- Defined in lib/structures/ComponentInteraction.ts:240

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/ComponentInteraction.ts:252

getOriginal

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

Returns Promise<Message<T>>
- Defined in lib/structures/ComponentInteraction.ts:259

inCachedGuildChannel

inCachedGuildChannel(): this is ComponentInteraction<V, AnyGuildTextChannel>
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 ComponentInteraction<V, AnyGuildTextChannel>
- Defined in lib/structures/ComponentInteraction.ts:264

inPrivateChannel

inPrivateChannel(): this is ComponentInteraction<V, 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 ComponentInteraction<V, Uncached | PrivateChannel>
- Defined in lib/structures/ComponentInteraction.ts:269

isButtonComponentInteraction

isButtonComponentInteraction(): this is ComponentInteraction<BUTTON, T>
Whether this interaction is a button interaction. 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 component type.

Returns this is ComponentInteraction<BUTTON, T>
- Defined in lib/structures/ComponentInteraction.ts:274

isSelectMenuComponentInteraction

isSelectMenuComponentInteraction(): this is ComponentInteraction<SelectMenuTypes, T>
Whether this interaction is a select menu interaction. 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 component type.

Returns this is ComponentInteraction<SelectMenuTypes, T>
- Defined in lib/structures/ComponentInteraction.ts:279

toJSON

toJSON(): JSONComponentInteraction
Returns JSONComponentInteraction
Overrides Interaction.toJSON
- Defined in lib/structures/ComponentInteraction.ts:287

toString

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

`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` getCreatedAt

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

`Static` getDiscordEpoch

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

Class ComponentInteraction<V, T>

Type Parameters

V extends BUTTON | SelectMenuTypes = BUTTON | SelectMenuTypes

T extends AnyTextChannelWithoutGroup | Uncached = AnyTextChannelWithoutGroup | Uncached

Hierarchy

Index

Constructors

Properties

Accessors

Methods

Constructors

constructor

Type Parameters

V extends BUTTON | SelectMenuTypes = BUTTON | SelectMenuTypes

T extends Uncached | AnyTextChannelWithoutGroup = Uncached | AnyTextChannelWithoutGroup

Parameters

data: RawMessageComponentInteraction

client: Client<ClientEvents>

Returns ComponentInteraction<V, T>

Properties

acknowledged

appPermissions

Optional application

applicationID

channelID

client

data

guildID

guildLocale

id

locale

member

memberPermissions

message

token

type

user

version

Accessors

channel

Returns T extends AnyTextChannelWithoutGroup ? T : undefined

createdAt

Returns Date

guild

Returns T extends AnyGuildTextChannel ? Guild : null | Guild

Methods

createFollowup

Parameters

options: InteractionContent

Returns Promise<Message<T>>

createMessage

Parameters

options: InteractionContent

Returns Promise<void>

createModal

Parameters

options: ModalData

Returns Promise<void>

defer

Parameters

Optional flags: number

Returns Promise<void>

deferUpdate

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

`Optional` application

`Optional` flags: number

`Optional` flags: number

`Static` from

`Static` getCreatedAt

`Static` getDiscordEpoch