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

Class MessageEditActionImpl

java.lang.Object

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

net.dv8tion.jda.internal.requests.restaction.MessageEditActionImpl

All Implemented Interfaces:

FluentRestAction<Message,MessageEditAction>, RestAction<Message>, MessageEditAction, MessageData, MessageEditRequest<MessageEditAction>, MessageRequest<MessageEditAction>, AbstractMessageBuilderMixin<MessageEditAction,MessageEditBuilder>, MessageEditBuilderMixin<MessageEditAction>

public class MessageEditActionImpl
extends RestActionImpl<Message>
implements MessageEditAction, MessageEditBuilderMixin<MessageEditAction>

Field Summary

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

LOG

Constructor Summary

Constructors

Constructor	Description
MessageEditActionImpl(MessageChannel channel, String messageId)
MessageEditActionImpl(JDA jda, Guild guild, String channelId, String messageId)

Method Summary

Modifier and Type	Method	Description
MessageEditAction	deadline(long timestamp)	Similar to RestAction.timeout(long, TimeUnit) but schedules a deadline at which the request has to be completed.
MessageEditBuilder	getBuilder()
MessageEditAction	setCheck(BooleanSupplier checks)	Sets the last-second checks before finally executing the http request in the queue.
MessageEditActionImpl	withHook(WebhookClient<Message> hook, ChannelType channelType, long channelId)

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

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

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, getAttachments, 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, timeout

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

getComponentTree

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

applyData, isReplace, setAttachments, setFiles, setReplace

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

applyCreateData, applyMessage, setAttachments, setFiles

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

MessageEditActionImpl

public MessageEditActionImpl(@Nonnull
 JDA jda,
 @Nullable
 Guild guild,
 @Nonnull
 String channelId,
 @Nonnull
 String messageId)

MessageEditActionImpl

public MessageEditActionImpl(@Nonnull
 MessageChannel channel,
 @Nonnull
 String messageId)

Method Details

withHook

public MessageEditActionImpl withHook(WebhookClient<Message> hook,
 ChannelType channelType,
 long channelId)

getBuilder

public MessageEditBuilder getBuilder()

Specified by:

getBuilder in interface AbstractMessageBuilderMixin<MessageEditAction,MessageEditBuilder>

setCheck

@Nonnull
public MessageEditAction 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<Message,MessageEditAction>

Specified by:

setCheck in interface RestAction<Message>

Overrides:

setCheck in class RestActionImpl<Message>

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)

deadline

@Nonnull
public MessageEditAction 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<Message,MessageEditAction>

Specified by:

deadline in interface RestAction<Message>

Overrides:

deadline in class RestActionImpl<Message>

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)