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

Interface ComponentInteraction

All Superinterfaces:

ICustomIdInteraction, IDeferrableCallback, IMessageEditCallback, IModalCallback, Interaction, IReplyCallback, ISnowflake

All Known Subinterfaces:

ButtonInteraction, EntitySelectInteraction, SelectMenuInteraction<T,S>, StringSelectInteraction

All Known Implementing Classes:

ButtonInteractionEvent, EntitySelectInteractionEvent, GenericComponentInteractionCreateEvent, GenericSelectMenuInteractionEvent, StringSelectInteractionEvent

public interface ComponentInteraction
extends IReplyCallback, IMessageEditCallback, IModalCallback, ICustomIdInteraction

Interaction on a message ActionComponent.

Instead of IReplyCallback.deferReply() and IReplyCallback.reply(String) you can use IMessageEditCallback.deferEdit() and IMessageEditCallback.editMessage(String) with these interactions! You can only acknowledge an interaction once!

Method Summary

Modifier and Type	Method	Description
MessageChannelUnion	getChannel()	The respective MessageChannelUnion for this interaction.
ActionComponent	getComponent()	The ActionComponent instance.
String	getComponentId()	The custom component ID provided to the component when it was originally created.
Component.Type	getComponentType()	The Component.Type
default String	getCustomId()	The relevant custom ID, that has been provided for the component or modal when it was originally created.
default GuildMessageChannelUnion	getGuildChannel()	The GuildChannel this interaction happened in.
Message	getMessage()	The Message instance.
default String	getMessageId()	The id of the message.
long	getMessageIdLong()	The id of the message.
default int	getUniqueId()	The numeric component ID provided to the component when it was originally created.

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, 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, getContext, getEntitlements, getGuild, getGuildLocale, getIntegrationOwners, getJDA, getMember, getMessageChannel, getToken, getType, getTypeRaw, getUser, getUserLocale, isAcknowledged, isFromAttachedGuild, isFromGuild

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

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

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

getId, getIdLong, getTimeCreated

Method Details

getCustomId

@Nonnull
default String getCustomId()

Description copied from interface: ICustomIdInteraction

The relevant custom ID, that has been provided for the component or modal when it was originally created.
This value should be used to determine what action to take in regard to this interaction.
This id does not have to be numerical.

Specified by:

getCustomId in interface ICustomIdInteraction

Returns:

The custom ID

See Also:

• getComponentId()
• ModalInteraction.getModalId()

getComponentId

@Nonnull
String getComponentId()

The custom component ID provided to the component when it was originally created.
This value should be used to determine what action to take in regard to this interaction.
This id does not have to be numerical.

Returns:

The component ID

See Also:

• ICustomId.getCustomId()

getUniqueId

default int getUniqueId()

The numeric component ID provided to the component when it was originally created.
This value is typically used to uniquely identify the component.

Returns:

The unique, numeric component ID

See Also:

• Component.getUniqueId()

getComponent

@Nonnull
ActionComponent getComponent()

The ActionComponent instance.

Returns:

The ActionComponent

getMessage

@Nonnull
Message getMessage()

The Message instance.

Returns:

The Message

getMessageIdLong

long getMessageIdLong()

The id of the message.

Returns:

The message id

getMessageId

@Nonnull
default String getMessageId()

The id of the message.

Returns:

The message id

getComponentType

@Nonnull
Component.Type getComponentType()

The Component.Type

Returns:

The Component.Type

getChannel

@Nonnull
MessageChannelUnion getChannel()

The respective MessageChannelUnion for this interaction.

Specified by:

getChannel in interface Interaction

Returns:

The MessageChannelUnion

getGuildChannel

@Nonnull
default GuildMessageChannelUnion getGuildChannel()

Description copied from interface: Interaction

The GuildChannel this interaction happened in.
If Interaction.getChannelType() is not a guild type, this throws IllegalStateException!

Specified by:

getGuildChannel in interface Interaction

Returns:

The GuildChannel