discord.js | ButtonInteraction

Search...

ButtonInteraction

export class ButtonInteraction<Cached extends CacheType = CacheType> extends MessageComponentInteraction<Cached>

export class ButtonInteraction<Cached extends CacheType = CacheType> extends MessageComponentInteraction<Cached>

Represents a button interaction.

Extends

MessageComponentInteraction<Cached>

Name	Constraints	Optional	Default	Description
Cached	CacheType	Yes	CacheType	None

applicationId:Snowflake

The application's id

Inherited from BaseInteraction

appPermissions:CacheTypeReducer<Cached, Readonly<PermissionsBitField>>

Set of permissions the application or bot has within the channel the interaction was sent from

Inherited from BaseInteraction

Readonly

channel:CacheTypeReducer< Cached, GuildTextBasedChannel | null, GuildTextBasedChannel | null, GuildTextBasedChannel | null, TextBasedChannel | null >

The channel this interaction was sent in

Inherited from BaseInteraction

channelId:Snowflake

The id of the channel this interaction was sent in

Inherited from MessageComponentInteraction

Readonly

client:Client<true>

The client that instantiated this

Inherited from Base

Readonly

component:CacheTypeReducer< Cached, ButtonComponent, APIButtonComponent, ButtonComponent | APIButtonComponent, ButtonComponent | APIButtonComponent >

The component which was interacted with

componentType:ComponentType.Button

The type of component which was interacted with

Readonly

createdAt:Date

The time the interaction was created at

Inherited from BaseInteraction

Readonly

createdTimestamp:number

The timestamp the interaction was created at

Inherited from BaseInteraction

customId:string

The custom id of the component which was interacted with

Inherited from MessageComponentInteraction

deferred:boolean

Whether the reply to this interaction has been deferred

Inherited from MessageComponentInteraction

ephemeral:boolean | null

Whether the reply to this interaction is ephemeral

Inherited from MessageComponentInteraction

Readonly

guild:CacheTypeReducer<Cached, Guild, null>

The guild this interaction was sent in

Inherited from BaseInteraction

guildId:CacheTypeReducer<Cached, Snowflake>

The id of the guild this interaction was sent in

Inherited from BaseInteraction

guildLocale:CacheTypeReducer<Cached, Locale>

The preferred locale from the guild this interaction was sent in

Inherited from BaseInteraction

id:Snowflake

The interaction's id

Inherited from BaseInteraction

locale:Locale

The locale of the user who invoked this interaction

Inherited from BaseInteraction

member:CacheTypeReducer<Cached, GuildMember, APIInteractionGuildMember>

If this interaction was sent in a guild, the member which sent it

Inherited from BaseInteraction

memberPermissions:CacheTypeReducer<Cached, Readonly<PermissionsBitField>>

The permissions of the member, if one exists, in the channel this interaction was executed in

Inherited from BaseInteraction

message:Message<BooleanCache<Cached>>

The message to which the component was attached

Inherited from MessageComponentInteraction

replied:boolean

Whether this interaction has already been replied to

Inherited from MessageComponentInteraction

Readonly

token:string

The interaction's token

Inherited from BaseInteraction

type:InteractionType.MessageComponent

The interaction's type

Inherited from MessageComponentInteraction

user:User

The user who created this interaction

Inherited from BaseInteraction

version:number

The version

Inherited from BaseInteraction

webhook:InteractionWebhook

An associated interaction webhook, can be used to further interact with this interaction

Inherited from MessageComponentInteraction

awaitModalSubmit(options):Promise<ModalSubmitInteraction<Cached>>

Collects a single modal submit interaction that passes the filter. The Promise will reject if the time expires.

Name	Type	Optional	Description
options	AwaitModalSubmitOptions<ModalSubmitInteraction>	No	Options to pass to the internal collector

Inherited from MessageComponentInteraction

deferReply(options):Promise<Message<BooleanCache<Cached>>>

Defers the reply to this interaction.

Name	Type	Optional	Description
options	InteractionDeferReplyOptions & { fetchReply: true }	No	Options for deferring the reply to this interaction

deferUpdate(options):Promise<Message<BooleanCache<Cached>>>

Defers an update to the message to which the component was attached.

Name	Type	Optional	Description
options	InteractionDeferUpdateOptions & { fetchReply: true }	No	Options for deferring the update to this interaction

deleteReply(message?):Promise<void>

Deletes a reply to this interaction.

Name	Type	Optional	Description
message	MessageResolvable \| '@original'	Yes	The response to delete

Inherited from MessageComponentInteraction

editReply(options):Promise<Message<BooleanCache<Cached>>>

Edits a reply to this interaction.

Name	Type	Optional	Description
options	string \| MessagePayload \| InteractionEditReplyOptions	No	The new options for the message

Inherited from MessageComponentInteraction

fetchReply(message?):Promise<Message<BooleanCache<Cached>>>

Fetches a reply to this interaction.

Name	Type	Optional	Description
message	Snowflake \| '@original'	Yes	The response to fetch

Inherited from MessageComponentInteraction

followUp(options):Promise<Message<BooleanCache<Cached>>>

Send a follow-up message to this interaction.

Name	Type	Optional	Description
options	string \| MessagePayload \| InteractionReplyOptions	No	The options for the reply

Inherited from MessageComponentInteraction

inCachedGuild():this is ButtonInteraction<'cached'>

Indicates whether or not this interaction is both cached and received from a guild.

inGuild():this is ButtonInteraction<'raw' | 'cached'>

Indicates whether this interaction is received from a guild.

inRawGuild():this is ButtonInteraction<'raw'>

Indicates whether or not this interaction is received from an uncached guild.

isAnySelectMenu():this is AnySelectMenuInteraction<Cached>

Indicates whether this interaction is a select menu of any known type.

Inherited from BaseInteraction

isAutocomplete():this is AutocompleteInteraction<Cached>

Indicates whether this interaction is an AutocompleteInteraction

Inherited from BaseInteraction

isButton():this is ButtonInteraction<Cached>

Indicates whether this interaction is a ButtonInteraction.

Inherited from BaseInteraction

isChannelSelectMenu():this is ChannelSelectMenuInteraction<Cached>

Indicates whether this interaction is a ChannelSelectMenuInteraction

Inherited from BaseInteraction

isChatInputCommand():this is ChatInputCommandInteraction<Cached>

Indicates whether this interaction is a ChatInputCommandInteraction.

Inherited from BaseInteraction

isCommand():this is CommandInteraction<Cached>

Indicates whether this interaction is a CommandInteraction

Inherited from BaseInteraction

isContextMenuCommand():this is ContextMenuCommandInteraction<Cached>

Indicates whether this interaction is a ContextMenuCommandInteraction

Inherited from BaseInteraction

isMentionableSelectMenu():this is MentionableSelectMenuInteraction<Cached>

Indicates whether this interaction is a MentionableSelectMenuInteraction

Inherited from BaseInteraction

isMessageComponent():this is MessageComponentInteraction<Cached>

Indicates whether this interaction is a MessageComponentInteraction

Inherited from BaseInteraction

isMessageContextMenuCommand():this is MessageContextMenuCommandInteraction<Cached>

Indicates whether this interaction is a MessageContextMenuCommandInteraction

Inherited from BaseInteraction

isModalSubmit():this is ModalSubmitInteraction<Cached>

Indicates whether this interaction is a ModalSubmitInteraction

Inherited from BaseInteraction

isRepliable():this is RepliableInteraction<Cached>

Indicates whether this interaction can be replied to.

Inherited from BaseInteraction

isRoleSelectMenu():this is RoleSelectMenuInteraction<Cached>

Indicates whether this interaction is a RoleSelectMenuInteraction

Inherited from BaseInteraction

Deprecated

isSelectMenu():this is StringSelectMenuInteraction<Cached>

Use isStringSelectMenu instead.

Deprecated

Indicates whether this interaction is a StringSelectMenuInteraction.

Inherited from BaseInteraction

isStringSelectMenu():this is StringSelectMenuInteraction<Cached>

Indicates whether this interaction is a StringSelectMenuInteraction.

Inherited from BaseInteraction

isUserContextMenuCommand():this is UserContextMenuCommandInteraction<Cached>

Indicates whether this interaction is a UserContextMenuCommandInteraction

Inherited from BaseInteraction

isUserSelectMenu():this is UserSelectMenuInteraction<Cached>

Indicates whether this interaction is a UserSelectMenuInteraction

Inherited from BaseInteraction

reply(options):Promise<Message<BooleanCache<Cached>>>

Creates a reply to this interaction. Use the fetchReply option to get the bot's reply message.

Name	Type	Optional	Description
options	InteractionReplyOptions & { fetchReply: true }	No	The options for the reply

showModal(modal):Promise<void>

Shows a modal component

Name	Type	Optional	Description
modal	\| JSONEncodable<APIModalInteractionResponseCallbackData> \| ModalComponentData \| APIModalInteractionResponseCallbackData	No	The modal to show

Inherited from MessageComponentInteraction

toJSON(...props):unknown

Name	Type	Optional	Description
...props	Record<string, boolean \| string>[]	No	None

Inherited from Base

update(options):Promise<Message<BooleanCache<Cached>>>

Updates the original message of the component on which the interaction was received on.

Name	Type	Optional	Description
options	InteractionUpdateOptions & { fetchReply: true }	No	The options for the updated message

valueOf():string