Package net.dv8tion.jda.internal.interactions

Class InteractionHookImpl

java.lang.Object

net.dv8tion.jda.internal.entities.AbstractWebhookClient<Message>

net.dv8tion.jda.internal.interactions.InteractionHookImpl

All Implemented Interfaces:

ISnowflake, WebhookClient<Message>, InteractionHook

public class InteractionHookImpl
extends AbstractWebhookClient<Message>
implements InteractionHook

Field Summary

Fields

Modifier and Type	Field	Description
static final String	TIMEOUT_MESSAGE

Constructor Summary

Constructors

Constructor	Description
InteractionHookImpl(JDA api, String token)
InteractionHookImpl(DeferrableInteractionImpl interaction, JDA api)

Method Summary

Modifier and Type	Method	Description
boolean	ack()
Message	buildMessage(DataObject json)
WebhookMessageDeleteAction	deleteMessageById(String messageId)	Delete a message from this webhook.
WebhookMessageEditActionImpl<Message>	editRequest(String messageId)
void	fail(Exception exception)
InteractionCallbackResponse	getCallbackResponse()	The callback response created by interaction replies like IReplyCallback.reply(String) or interaction updates like IMessageEditCallback.editMessage(String).
long	getExpirationTimestamp()	The unix millisecond timestamp for the expiration of this interaction hook.
InteractionImpl	getInteraction()	The interaction attached to this hook.
boolean	hasCallbackResponse()	Whether this InteractionHook contains a callback response.
boolean	isAck()
void	ready()
WebhookMessageRetrieveAction	retrieveMessageById(String messageId)	Retrieves the message with the provided id.
WebhookMessageCreateActionImpl<Message>	sendRequest()
InteractionHookImpl	setCallbackResponse(InteractionCallbackResponseImpl callbackResponse)
InteractionHook	setEphemeral(boolean ephemeral)	Whether messages sent from this interaction hook should be ephemeral by default.

Methods inherited from class net.dv8tion.jda.internal.entities.AbstractWebhookClient

editMessageAttachmentsById, editMessageById, editMessageById, editMessageComponentsById, editMessageEmbedsById, getIdLong, getJDA, getToken, sendFiles, sendMessage, sendMessage, sendMessageComponents, sendMessageEmbeds, sendMessagePoll

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

deleteOriginal, editOriginal, editOriginal, editOriginalAttachments, editOriginalAttachments, editOriginalComponents, editOriginalComponents, editOriginalComponents, editOriginalEmbeds, editOriginalEmbeds, editOriginalFormat, getJDA, isExpired, retrieveOriginal

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

getId, getIdLong, getTimeCreated

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

deleteMessageById, editMessageAttachmentsById, editMessageAttachmentsById, editMessageAttachmentsById, editMessageAttachmentsById, editMessageById, editMessageById, editMessageById, editMessageById, editMessageComponentsById, editMessageComponentsById, editMessageComponentsById, editMessageComponentsById, editMessageComponentsById, editMessageComponentsById, editMessageEmbedsById, editMessageEmbedsById, editMessageEmbedsById, editMessageEmbedsById, editMessageFormatById, editMessageFormatById, getToken, sendFiles, sendFiles, sendMessage, sendMessage, sendMessageComponents, sendMessageComponents, sendMessageComponents, sendMessageEmbeds, sendMessageEmbeds, sendMessageFormat, sendMessagePoll

Field Details

TIMEOUT_MESSAGE

public static final String TIMEOUT_MESSAGE

See Also:

• Constant Field Values

Constructor Details

InteractionHookImpl

public InteractionHookImpl(@Nonnull
 DeferrableInteractionImpl interaction,
 @Nonnull
 JDA api)

InteractionHookImpl

public InteractionHookImpl(@Nonnull
 JDA api,
 @Nonnull
 String token)

Method Details

ack

public boolean ack()

isAck

public boolean isAck()

ready

public void ready()

fail

public void fail(Exception exception)

setCallbackResponse

public InteractionHookImpl setCallbackResponse(InteractionCallbackResponseImpl callbackResponse)

getInteraction

@Nonnull
public InteractionImpl getInteraction()

Description copied from interface: InteractionHook

The interaction attached to this hook.

Specified by:

getInteraction in interface InteractionHook

Returns:

The Interaction

getCallbackResponse

@Nonnull
public InteractionCallbackResponse getCallbackResponse()

Description copied from interface: InteractionHook

The callback response created by interaction replies like IReplyCallback.reply(String) or interaction updates like IMessageEditCallback.editMessage(String).

Example

 
 event.reply("foobar").queue(hook -> {
     var messageId = hook.getCallbackResponse().getMessage().getIdLong();
     System.out.println(messageId);
 });
 

Specified by:

getCallbackResponse in interface InteractionHook

Returns:

InteractionCallbackResponse

See Also:

• InteractionHook.hasCallbackResponse()

hasCallbackResponse

public boolean hasCallbackResponse()

Description copied from interface: InteractionHook

Whether this InteractionHook contains a callback response.
This will be false if the interaction has not yet been acknowledged.

Specified by:

hasCallbackResponse in interface InteractionHook

Returns:

True, if this InteractionHook contains a callback response

See Also:

• InteractionHook.getCallbackResponse()

getExpirationTimestamp

public long getExpirationTimestamp()

Description copied from interface: InteractionHook

The unix millisecond timestamp for the expiration of this interaction hook.
An interaction hook expires after 15 minutes of its creation.

Specified by:

getExpirationTimestamp in interface InteractionHook

Returns:

The timestamp in millisecond precision

See Also:

• System.currentTimeMillis()
• InteractionHook.isExpired()

setEphemeral

@Nonnull
public InteractionHook setEphemeral(boolean ephemeral)

Description copied from interface: InteractionHook

Whether messages sent from this interaction hook should be ephemeral by default.
This does not affect message updates, including deferred replies sent with sendMessage(...) methods.
When a message is ephemeral, it will only be visible to the user that used the interaction.

Ephemeral messages have some limitations and will be removed once the user restarts their client.
Limitations:

• Cannot be reacted to
• Can only be retrieved using the InteractionHook

Note: Your message can appear ephemeral in several cases:

• In guilds the bot is not a member of, if the member is unable to use external application, this usually happens for user-installed commands
• If the interaction user is unable to send messages
• If the content contains elements the user does not have the permission to send (like files or embeds)
• If the content triggered AutoMod

Specified by:

setEphemeral in interface InteractionHook

Parameters:

ephemeral - True if messages should be ephemeral

Returns:

The same interaction hook instance

sendRequest

@Nonnull
public WebhookMessageCreateActionImpl<Message> sendRequest()

Specified by:

sendRequest in class AbstractWebhookClient<Message>

editRequest

@Nonnull
public WebhookMessageEditActionImpl<Message> editRequest(String messageId)

Specified by:

editRequest in class AbstractWebhookClient<Message>

deleteMessageById

@Nonnull
public WebhookMessageDeleteAction deleteMessageById(@Nonnull
 String messageId)

Description copied from interface: WebhookClient

Delete a message from this webhook.

Use setThreadId(threadId) to delete messages from threads.

If this is an InteractionHook this method will be delayed until the interaction is acknowledged.

Possible ErrorResponses include:

• UNKNOWN_WEBHOOK
  The webhook is no longer available, either it was deleted or in case of interactions it expired.
• UNKNOWN_MESSAGE
  The message for that id does not exist

Specified by:

deleteMessageById in interface WebhookClient<Message>

Overrides:

deleteMessageById in class AbstractWebhookClient<Message>

Parameters:

messageId - The id for the message to delete

Returns:

WebhookMessageDeleteAction

retrieveMessageById

@Nonnull
public WebhookMessageRetrieveAction retrieveMessageById(@Nonnull
 String messageId)

Description copied from interface: WebhookClient

Retrieves the message with the provided id.
This only works for messages sent by this webhook. All other messages are unknown.

Use setThreadId(threadId) to retrieve messages from threads.

If this is an InteractionHook this method will be delayed until the interaction is acknowledged.

Possible ErrorResponses include:

• UNKNOWN_WEBHOOK
  The webhook is no longer available, either it was deleted or in case of interactions it expired.
• UNKNOWN_MESSAGE
  If the message is inaccessible to this webhook or does not exist.

Specified by:

retrieveMessageById in interface WebhookClient<Message>

Returns:

WebhookMessageRetrieveAction

buildMessage

public Message buildMessage(DataObject json)