Package net.dv8tion.jda.internal.interactions.components

Class ComponentInteractionImpl

java.lang.Object

net.dv8tion.jda.internal.interactions.InteractionImpl

net.dv8tion.jda.internal.interactions.DeferrableInteractionImpl

net.dv8tion.jda.internal.interactions.components.ComponentInteractionImpl

All Implemented Interfaces:

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

Direct Known Subclasses:

ButtonInteractionImpl, SelectMenuInteractionImpl

public abstract class ComponentInteractionImpl
extends DeferrableInteractionImpl
implements ComponentInteraction

Constructor Summary

Constructors

Constructor	Description
ComponentInteractionImpl(JDAImpl jda, DataObject data)

Method Summary

Modifier and Type	Method	Description
MessageEditCallbackActionImpl	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.
String	getComponentId()	The custom component ID provided to the component when it was originally created.
Message	getMessage()	The Message instance.
long	getMessageIdLong()	The id of the message.
ModalCallbackAction	replyModal(Modal modal)	Acknowledgement of this interaction with a Modal.

Methods inherited from class net.dv8tion.jda.internal.interactions.DeferrableInteractionImpl

getHook, releaseHook

Methods inherited from class net.dv8tion.jda.internal.interactions.InteractionImpl

ack, getChannelIdLong, getContext, getEntitlements, getGuild, getIdLong, getIntegrationOwners, getJDA, getMember, getToken, getTypeRaw, getUser, getUserLocale, isAcknowledged

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

getComponent, getComponentType, getGuildChannel, getMessageId, getUniqueId

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

getHook

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

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

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, reply, reply, replyComponents, replyComponents, replyComponents, replyEmbeds, replyEmbeds, replyFiles, replyFiles, replyFormat, replyPoll

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

getId, getIdLong, getTimeCreated

Constructor Details

ComponentInteractionImpl

public ComponentInteractionImpl(JDAImpl jda,
 DataObject data)

Method Details

getChannel

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 InteractionImpl

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.getCustomId()

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

deferEdit

@Nonnull
public MessageEditCallbackActionImpl 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)

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