Package net.dv8tion.jda.api.events.interaction.component

Class ButtonInteractionEvent

java.lang.Object

net.dv8tion.jda.api.events.Event

net.dv8tion.jda.api.events.interaction.GenericInteractionCreateEvent

net.dv8tion.jda.api.events.interaction.component.GenericComponentInteractionCreateEvent

net.dv8tion.jda.api.events.interaction.component.ButtonInteractionEvent

All Implemented Interfaces:

ISnowflake, GenericEvent, IDeferrableCallback, IMessageEditCallback, IModalCallback, IPremiumRequiredReplyCallback, IReplyCallback, ButtonInteraction, ComponentInteraction, Interaction

public class ButtonInteractionEvent
extends GenericComponentInteractionCreateEvent
implements ButtonInteraction

Indicates that a custom Button on one of the bots messages was clicked by a user.

This fires when a user clicks one of the custom buttons attached to a bot or webhook message.

Requirements
To receive these events, you must unset the Interactions Endpoint URL in your application dashboard. You can simply remove the URL for this endpoint in your settings at the Discord Developers Portal.

Constructor Summary

Constructors

Constructor	Description
ButtonInteractionEvent(JDA api, long responseNumber, ButtonInteraction interaction)

Method Summary

Modifier and Type	Method	Description
Button	getButton()	The Button this interaction belongs to.
Button	getComponent()	The ActionComponent instance.
ButtonInteraction	getInteraction()	The Interaction instance.

Methods inherited from class net.dv8tion.jda.api.events.interaction.component.GenericComponentInteractionCreateEvent

deferEdit, deferReply, getChannel, getComponentId, getComponentType, getHook, getMessage, getMessageIdLong, replyModal, replyWithPremiumRequired

Methods inherited from class net.dv8tion.jda.api.events.interaction.GenericInteractionCreateEvent

getChannelIdLong, getEntitlements, getGuild, getGuildLocale, getIdLong, getMember, getToken, getTypeRaw, getUser, getUserLocale, isAcknowledged

Methods inherited from class net.dv8tion.jda.api.events.Event

getJDA, getRawData, getResponseNumber, toString

Methods inherited from class java.lang.Object

equals, getClass, hashCode, notify, notifyAll, wait, wait, wait

Methods inherited from interface net.dv8tion.jda.api.interactions.components.buttons.ButtonInteraction

editButton

Methods inherited from interface net.dv8tion.jda.api.interactions.components.ComponentInteraction

getChannel, getComponentId, getComponentType, getGuildChannel, getMessage, getMessageId, getMessageIdLong

Methods inherited from interface net.dv8tion.jda.api.interactions.callbacks.IDeferrableCallback

getHook

Methods inherited from interface net.dv8tion.jda.api.interactions.callbacks.IMessageEditCallback

deferEdit, editComponents, editComponents, editMessage, editMessage, editMessageAttachments, editMessageAttachments, editMessageEmbeds, editMessageEmbeds, editMessageFormat

Methods inherited from interface net.dv8tion.jda.api.interactions.callbacks.IModalCallback

replyModal

Methods inherited from interface net.dv8tion.jda.api.interactions.Interaction

getChannelId, getChannelIdLong, getChannelType, getEntitlements, getGuild, getGuildLocale, getJDA, getMember, getMessageChannel, getToken, getType, getTypeRaw, getUser, getUserLocale, isAcknowledged, isFromGuild

Methods inherited from interface net.dv8tion.jda.api.interactions.callbacks.IPremiumRequiredReplyCallback

replyWithPremiumRequired

Methods inherited from interface net.dv8tion.jda.api.interactions.callbacks.IReplyCallback

deferReply, deferReply, reply, reply, replyComponents, replyComponents, replyEmbeds, replyEmbeds, replyFiles, replyFiles, replyFormat, replyPoll

Methods inherited from interface net.dv8tion.jda.api.entities.ISnowflake

getId, getIdLong, getTimeCreated

Constructor Details

ButtonInteractionEvent

public ButtonInteractionEvent(@Nonnull
 JDA api,
 long responseNumber,
 @Nonnull
 ButtonInteraction interaction)

Method Details

getInteraction

@Nonnull
public ButtonInteraction getInteraction()

Description copied from class: GenericInteractionCreateEvent

The Interaction instance.
Note that this event is a delegate which implements the same interface.

Overrides:

getInteraction in class GenericComponentInteractionCreateEvent

Returns:

The Interaction

getComponent

@Nonnull
public Button getComponent()

Description copied from interface: ComponentInteraction

The ActionComponent instance.

Specified by:

getComponent in interface ButtonInteraction

Specified by:

getComponent in interface ComponentInteraction

Overrides:

getComponent in class GenericComponentInteractionCreateEvent

Returns:

The ActionComponent

getButton

@Nonnull
public Button getButton()

Description copied from interface: ButtonInteraction

The Button this interaction belongs to.

Specified by:

getButton in interface ButtonInteraction

Returns:

The Button

See Also:

• ComponentInteraction.getComponentId()