Package net.dv8tion.jda.internal.requests.restaction.interactions

Class ReplyCallbackActionImpl

java.lang.Object

net.dv8tion.jda.internal.requests.RestActionImpl<InteractionHook>

net.dv8tion.jda.internal.requests.restaction.interactions.InteractionCallbackImpl<InteractionHook>

net.dv8tion.jda.internal.requests.restaction.interactions.DeferrableCallbackActionImpl

net.dv8tion.jda.internal.requests.restaction.interactions.ReplyCallbackActionImpl

All Implemented Interfaces:

FluentRestAction<InteractionHook,ReplyCallbackAction>, RestAction<InteractionHook>, InteractionCallbackAction<InteractionHook>, ReplyCallbackAction, MessageCreateRequest<ReplyCallbackAction>, MessageData, MessageRequest<ReplyCallbackAction>, AbstractMessageBuilderMixin<ReplyCallbackAction,MessageCreateBuilder>, MessageCreateBuilderMixin<ReplyCallbackAction>

public class ReplyCallbackActionImpl
extends DeferrableCallbackActionImpl
implements ReplyCallbackAction, MessageCreateBuilderMixin<ReplyCallbackAction>

Nested Class Summary

Nested classes/interfaces inherited from interface net.dv8tion.jda.api.requests.restaction.interactions.InteractionCallbackAction

InteractionCallbackAction.ResponseType

Field Summary

Fields inherited from class net.dv8tion.jda.internal.requests.RestActionImpl

LOG

Constructor Summary

Constructors

Constructor	Description
ReplyCallbackActionImpl(InteractionHookImpl hook)

Method Summary

Modifier and Type	Method	Description
ReplyCallbackActionImpl	closeResources()	Closes all owned resources used for this request.
ReplyCallbackAction	deadline(long timestamp)	Similar to RestAction.timeout(long, TimeUnit) but schedules a deadline at which the request has to be completed.
MessageCreateBuilder	getBuilder()
ReplyCallbackAction	setCheck(BooleanSupplier checks)	Sets the last-second checks before finally executing the http request in the queue.
ReplyCallbackActionImpl	setEphemeral(boolean ephemeral)	Set whether this message should be visible to other users.
ReplyCallbackAction	timeout(long timeout, TimeUnit unit)	Timeout for this RestAction instance.

Methods inherited from class net.dv8tion.jda.internal.requests.restaction.interactions.InteractionCallbackImpl

handleResponse, queue, submit

Methods inherited from class net.dv8tion.jda.internal.requests.RestActionImpl

complete, getCheck, getDefaultFailure, getDefaultSuccess, getDefaultTimeout, getJDA, isPassContext, priority, setDefaultFailure, setDefaultSuccess, setDefaultTimeout, setErrorMapper, setPassContext

Methods inherited from class java.lang.Object

equals, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

Methods inherited from interface net.dv8tion.jda.internal.utils.message.AbstractMessageBuilderMixin

getAllowedMentions, getComponents, getContent, getEmbeds, getMentionedRoles, getMentionedUsers, isMentionRepliedUser, isSuppressEmbeds, isUsingComponentsV2, mention, mentionRepliedUser, mentionRoles, mentionUsers, setAllowedMentions, setComponents, setContent, setEmbeds, setSuppressEmbeds, useComponentsV2

Methods inherited from interface net.dv8tion.jda.api.requests.FluentRestAction

addCheck

Methods inherited from interface net.dv8tion.jda.internal.utils.message.MessageCreateBuilderMixin

addComponents, addContent, addEmbeds, addFiles, getAttachments, getPoll, setFiles, setPoll, setSuppressedNotifications, setTTS, setVoiceMessage

Methods inherited from interface net.dv8tion.jda.api.utils.messages.MessageCreateRequest

addComponents, addComponents, addEmbeds, addFiles, applyData, applyEditData, applyMessage, getAttachments

Methods inherited from interface net.dv8tion.jda.api.utils.messages.MessageData

getComponentTree

Methods inherited from interface net.dv8tion.jda.api.utils.messages.MessageRequest

mention, mentionRoles, mentionRoles, mentionUsers, mentionUsers, setComponents, setComponents, setEmbeds, setFiles, useComponentsV2

Methods inherited from interface net.dv8tion.jda.api.requests.RestAction

and, and, complete, complete, completeAfter, delay, delay, delay, delay, flatMap, flatMap, getCheck, getJDA, map, mapToResult, onErrorFlatMap, onErrorFlatMap, onErrorMap, onErrorMap, onSuccess, queue, queue, queue, queueAfter, queueAfter, queueAfter, queueAfter, queueAfter, queueAfter, submit, submit, submitAfter, submitAfter, zip

Constructor Details

ReplyCallbackActionImpl

public ReplyCallbackActionImpl(InteractionHookImpl hook)

Method Details

getBuilder

public MessageCreateBuilder getBuilder()

Specified by:

getBuilder in interface AbstractMessageBuilderMixin<ReplyCallbackAction,MessageCreateBuilder>

closeResources

@Nonnull
public ReplyCallbackActionImpl closeResources()

Description copied from interface: InteractionCallbackAction

Closes all owned resources used for this request.

This closes all files added, if applicable.

Specified by:

closeResources in interface InteractionCallbackAction<InteractionHook>

Specified by:

closeResources in interface ReplyCallbackAction

Overrides:

closeResources in class InteractionCallbackImpl<InteractionHook>

Returns:

This instance for chaining.

setEphemeral

@Nonnull
public ReplyCallbackActionImpl setEphemeral(boolean ephemeral)

Description copied from interface: ReplyCallbackAction

Set whether this message should be visible to other users.
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 ReplyCallbackAction

Parameters:

ephemeral - True, if this message should be invisible for other users

Returns:

The same reply action, for chaining convenience

setCheck

@Nonnull
public ReplyCallbackAction setCheck(BooleanSupplier checks)

Description copied from interface: RestAction

Sets the last-second checks before finally executing the http request in the queue.
If the provided supplier evaluates to false or throws an exception this will not be finished. When an exception is thrown from the supplier it will be provided to the failure callback.

Specified by:

setCheck in interface FluentRestAction<InteractionHook,ReplyCallbackAction>

Specified by:

setCheck in interface RestAction<InteractionHook>

Overrides:

setCheck in class RestActionImpl<InteractionHook>

Parameters:

checks - The checks to run before executing the request, or null to run no checks

Returns:

The current RestAction for chaining convenience

See Also:

• RestAction.getCheck()
• RestAction.addCheck(BooleanSupplier)

timeout

@Nonnull
public ReplyCallbackAction timeout(long timeout,
 @Nonnull
 TimeUnit unit)

Description copied from interface: RestAction

Timeout for this RestAction instance.
If the request doesn't get executed within the timeout it will fail.

When a RestAction times out, it will fail with a TimeoutException. This is the same as deadline(System.currentTimeMillis() + unit.toMillis(timeout)).

Example

 action.timeout(10, TimeUnit.SECONDS) // 10 seconds from now
       .queueAfter(20, SECONDS); // request will not be executed within deadline and timeout immediately after 20 seconds
 

Specified by:

timeout in interface FluentRestAction<InteractionHook,ReplyCallbackAction>

Specified by:

timeout in interface RestAction<InteractionHook>

Parameters:

timeout - The timeout to use

unit - Unit for the timeout value

Returns:

The same RestAction instance with the applied timeout

See Also:

• RestAction.setDefaultTimeout(long, TimeUnit)

deadline

@Nonnull
public ReplyCallbackAction deadline(long timestamp)

Description copied from interface: RestAction

Similar to RestAction.timeout(long, TimeUnit) but schedules a deadline at which the request has to be completed.
If the deadline is reached, the request will fail with a TimeoutException.

This does not mean that the request will immediately timeout when the deadline is reached. JDA will check the deadline right before executing the request or within intervals in a worker thread. This only means the request will timeout if the deadline has passed.

Example

 action.deadline(System.currentTimeMillis() + 10000) // 10 seconds from now
       .queueAfter(20, SECONDS); // request will not be executed within deadline and timeout immediately after 20 seconds
 

Specified by:

deadline in interface FluentRestAction<InteractionHook,ReplyCallbackAction>

Specified by:

deadline in interface RestAction<InteractionHook>

Overrides:

deadline in class RestActionImpl<InteractionHook>

Parameters:

timestamp - Millisecond timestamp at which the request will timeout

Returns:

The same RestAction with the applied deadline

See Also:

• RestAction.timeout(long, TimeUnit)
• RestAction.setDefaultTimeout(long, TimeUnit)