Interface ButtonInteraction

All Superinterfaces:

ComponentInteraction, ICustomIdInteraction, IDeferrableCallback, IMessageEditCallback, IModalCallback, Interaction, 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 ComponentInteraction

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

Methods inherited from interface IDeferrableCallback

getHook

Methods inherited from interface IMessageEditCallback

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

Methods inherited from interface IModalCallback

replyModal

Methods inherited from interface Interaction

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

Methods inherited from interface IReplyCallback

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

Methods inherited from interface 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