Class GenericComponentInteractionCreateEvent
- java.lang.Object
-
- net.dv8tion.jda.api.events.Event
-
- net.dv8tion.jda.api.events.interaction.GenericInteractionCreateEvent
-
- net.dv8tion.jda.api.events.interaction.GenericComponentInteractionCreateEvent
-
- All Implemented Interfaces:
ISnowflake,GenericEvent,ComponentInteraction,Interaction
- Direct Known Subclasses:
ButtonClickEvent,SelectionMenuEvent
public class GenericComponentInteractionCreateEvent extends GenericInteractionCreateEvent implements ComponentInteraction
Indicates that aComponentInteractionwas created in a channel.
Every component interaction event is derived from this event.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 GenericComponentInteractionCreateEvent(JDA api, long responseNumber, ComponentInteraction interaction)
-
Method Summary
All Methods Instance Methods Concrete Methods Modifier and Type Method Description UpdateInteractionActiondeferEdit()No-op acknowledgement of this interaction.MessageChannelgetChannel()The channel this interaction happened in.ComponentgetComponent()TheComponentinstance.java.lang.StringgetComponentId()The custom component Id provided to the component when it was originally created.Component.TypegetComponentType()TheComponent.TypeComponentInteractiongetInteraction()TheInteractioninstance.MessagegetMessage()TheMessageinstance.longgetMessageIdLong()The id of the message.-
Methods inherited from class net.dv8tion.jda.api.events.interaction.GenericInteractionCreateEvent
deferReply, getGuild, getHook, getIdLong, getMember, getToken, getTypeRaw, getUser, isAcknowledged
-
Methods inherited from class net.dv8tion.jda.api.events.Event
getJDA, getResponseNumber
-
Methods inherited from class java.lang.Object
equals, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait
-
Methods inherited from interface net.dv8tion.jda.api.interactions.components.ComponentInteraction
editComponents, editComponents, editMessage, editMessage, editMessageEmbeds, editMessageEmbeds, editMessageFormat, getMessageId
-
Methods inherited from interface net.dv8tion.jda.api.interactions.Interaction
deferReply, deferReply, getChannelType, getGuild, getGuildChannel, getHook, getJDA, getMember, getMessageChannel, getPrivateChannel, getTextChannel, getToken, getType, getTypeRaw, getUser, getVoiceChannel, isAcknowledged, isFromGuild, reply, reply, replyEmbeds, replyEmbeds, replyFormat
-
Methods inherited from interface net.dv8tion.jda.api.entities.ISnowflake
getId, getIdLong, getTimeCreated
-
-
-
-
Constructor Detail
-
GenericComponentInteractionCreateEvent
public GenericComponentInteractionCreateEvent(@Nonnull JDA api, long responseNumber, @Nonnull ComponentInteraction interaction)
-
-
Method Detail
-
getInteraction
@Nonnull public ComponentInteraction getInteraction()
Description copied from class:GenericInteractionCreateEventTheInteractioninstance.
Note that this event is a delegate which implements the same interface.- Overrides:
getInteractionin classGenericInteractionCreateEvent- Returns:
- The
Interaction
-
getChannel
@Nonnull public MessageChannel getChannel()
Description copied from interface:InteractionThe channel this interaction happened in.
This is currently never null, but might be nullable in the future.- Specified by:
getChannelin interfaceComponentInteraction- Specified by:
getChannelin interfaceInteraction- Overrides:
getChannelin classGenericInteractionCreateEvent- Returns:
- The channel or null if this interaction is not from a channel context
-
getComponentId
@Nonnull public java.lang.String getComponentId()
Description copied from interface:ComponentInteractionThe custom component Id provided to the component when it was originally created.
This value should be used to determine what action to take in regards to this interaction.
This id does not have to be numerical.- Specified by:
getComponentIdin interfaceComponentInteraction- Returns:
- The component ID
-
getComponent
@Nullable public Component getComponent()
Description copied from interface:ComponentInteractionTheComponentinstance.
This is null on interactions for ephemeral messages.- Specified by:
getComponentin interfaceComponentInteraction- Returns:
- The
Component, or null if this message is ephemeral
-
getMessage
@Nonnull public Message getMessage()
Description copied from interface:ComponentInteractionTheMessageinstance.- Specified by:
getMessagein interfaceComponentInteraction- Returns:
- The
Message
-
getMessageIdLong
public long getMessageIdLong()
Description copied from interface:ComponentInteractionThe id of the message.- Specified by:
getMessageIdLongin interfaceComponentInteraction- Returns:
- The message id
-
getComponentType
@Nonnull public Component.Type getComponentType()
Description copied from interface:ComponentInteractionTheComponent.Type- Specified by:
getComponentTypein interfaceComponentInteraction- Returns:
- The
Component.Type
-
deferEdit
@Nonnull public UpdateInteractionAction deferEdit()
Description copied from interface:ComponentInteractionNo-op acknowledgement of this interaction.
This tells discord you intend to update the message that the triggering component is a part of using theInteractionHookinstead of sending a reply message. You are not required to actually update the message, this will simply acknowledge that you accepted the interaction.You only have 3 seconds to acknowledge an interaction!
When the acknowledgement is sent after the interaction expired, you will receiveErrorResponse.UNKNOWN_INTERACTION.Use
ComponentInteraction.editMessage(String)to edit it directly.- Specified by:
deferEditin interfaceComponentInteraction- Returns:
UpdateInteractionActionthat can be used to update the message- See Also:
ComponentInteraction.editMessage(String)
-
-