Package net.dv8tion.jda.api.interactions.components.buttons

Interface ButtonInteraction

All Superinterfaces:

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

All Known Implementing Classes:

ButtonInteractionEvent

public interface ButtonInteraction
extends ComponentInteraction

Interaction on a Button component.

See Also:

• ButtonInteractionEvent

Method Summary

Modifier and Type	Method	Description
default RestAction<Void>	editButton(Button newButton)	Update the button with a new button instance.
Button	getButton()	The Button this interaction belongs to.
default Button	getComponent()	The ActionComponent instance.

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

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

getId, getIdLong, getTimeCreated

Method Details

getComponent

@Nonnull
default Button getComponent()

Description copied from interface: ComponentInteraction

The ActionComponent instance.

Specified by:

getComponent in interface ComponentInteraction

Returns:

The ActionComponent

getButton

@Nonnull
Button getButton()

The Button this interaction belongs to.

Returns:

The Button

See Also:

• ComponentInteraction.getComponentId()

editButton

@Nonnull
@CheckReturnValue
default RestAction<Void> editButton(@Nullable
 Button newButton)

Update the button with a new button instance.

If this interaction is already acknowledged this will use IDeferrableCallback.getHook() and otherwise IMessageEditCallback.editComponents(Collection) directly to acknowledge the interaction.

Parameters:

newButton - The new button to use, or null to remove this button from the message entirely

Returns:

RestAction