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

Class GenericComponentInteractionCreateEvent

java.lang.Object

net.dv8tion.jda.api.events.Event

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

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

All Implemented Interfaces:

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

Direct Known Subclasses:

ButtonInteractionEvent, GenericSelectMenuInteractionEvent

public class GenericComponentInteractionCreateEvent
extends GenericInteractionCreateEvent
implements ComponentInteraction

Indicates that a ComponentInteraction was 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

Modifier and Type	Method	Description
MessageEditCallbackAction	deferEdit()	No-op acknowledgement of this interaction.
ReplyCallbackAction	deferReply()	Acknowledge this interaction and defer the reply to a later time.
MessageChannelUnion	getChannel()	The channel this interaction happened in.
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
InteractionHook	getHook()	The InteractionHook which can be used to send deferred replies or followup messages.
ComponentInteraction	getInteraction()	The Interaction instance.
Message	getMessage()	The Message instance.
long	getMessageIdLong()	The id of the message.
ModalCallbackAction	replyModal(Modal modal)	Acknowledgement of this interaction with a Modal.
PremiumRequiredCallbackAction	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.ComponentInteraction

getGuildChannel, getMessageId

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

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

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.IReplyCallback

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

GenericComponentInteractionCreateEvent

public GenericComponentInteractionCreateEvent(@Nonnull
 JDA api,
 long responseNumber,
 @Nonnull
 ComponentInteraction interaction)

Method Details

getInteraction

@Nonnull
public ComponentInteraction 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 GenericInteractionCreateEvent

Returns:

The Interaction

getChannel

@Nonnull
public MessageChannelUnion getChannel()

Description copied from interface: Interaction

The channel this interaction happened in.

Specified by:

getChannel in interface ComponentInteraction

Specified by:

getChannel in interface Interaction

Overrides:

getChannel in class GenericInteractionCreateEvent

Returns:

The channel or null if the channel is not provided

getComponentId

@Nonnull
public String getComponentId()

Description copied from interface: ComponentInteraction

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.

Specified by:

getComponentId in interface ComponentInteraction

Returns:

The component ID

See Also:

• ActionComponent.getId()

getComponent

@Nonnull
public ActionComponent getComponent()

Description copied from interface: ComponentInteraction

The ActionComponent instance.

Specified by:

getComponent in interface ComponentInteraction

Returns:

The ActionComponent

getMessage

@Nonnull
public Message getMessage()

Description copied from interface: ComponentInteraction

The Message instance.

Specified by:

getMessage in interface ComponentInteraction

Returns:

The Message

getMessageIdLong

public long getMessageIdLong()

Description copied from interface: ComponentInteraction

The id of the message.

Specified by:

getMessageIdLong in interface ComponentInteraction

Returns:

The message id

getComponentType

@Nonnull
public Component.Type getComponentType()

Description copied from interface: ComponentInteraction

The Component.Type

Specified by:

getComponentType in interface ComponentInteraction

Returns:

The Component.Type

deferEdit

@Nonnull
public MessageEditCallbackAction deferEdit()

Description copied from interface: IMessageEditCallback

No-op acknowledgement of this interaction.
This tells discord you intend to update the message that the triggering component is a part of using the InteractionHook instead 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 receive ErrorResponse.UNKNOWN_INTERACTION.

Use IMessageEditCallback.editMessage(String) to edit it directly.

Specified by:

deferEdit in interface IMessageEditCallback

Returns:

MessageEditCallbackAction that can be used to update the message

See Also:

• IMessageEditCallback.editMessage(String)

getHook

@Nonnull
public InteractionHook getHook()

Description copied from interface: IDeferrableCallback

The InteractionHook which can be used to send deferred replies or followup messages.

Specified by:

getHook in interface IDeferrableCallback

Returns:

The interaction hook

deferReply

@Nonnull
public ReplyCallbackAction deferReply()

Description copied from interface: IReplyCallback

Acknowledge this interaction and defer the reply to a later time.
This will send a <Bot> is thinking... message in chat that will be updated later through either InteractionHook.editOriginal(String) or WebhookClient.sendMessage(String).

You can use deferReply(true) to send a deferred ephemeral reply. If your initial deferred message is not ephemeral it cannot be made ephemeral later. Your first message to the InteractionHook will inherit whether the message is ephemeral or not from this deferred reply.

You only have 3 seconds to acknowledge an interaction!
When the acknowledgement is sent after the interaction expired, you will receive ErrorResponse.UNKNOWN_INTERACTION.

Use IReplyCallback.reply(String) to reply directly.

Specified by:

deferReply in interface IReplyCallback

Returns:

ReplyCallbackAction

replyModal

@Nonnull
public ModalCallbackAction replyModal(@Nonnull
 Modal modal)

Description copied from interface: IModalCallback

Acknowledgement of this interaction with a Modal.

This will open a popup on the target user's Discord client.

Interactions can only be acknowledged once.

You only have 3 seconds to acknowledge an interaction!
When the acknowledgement is sent after the interaction expired, you will receive ErrorResponse.UNKNOWN_INTERACTION.

Specified by:

replyModal in interface IModalCallback

Parameters:

modal - The Modal to send

Returns:

ModalCallbackAction

replyWithPremiumRequired

@Nonnull
public PremiumRequiredCallbackAction replyWithPremiumRequired()

Specified by:

replyWithPremiumRequired in interface IPremiumRequiredReplyCallback