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

Class AbstractWebhookMessageActionImpl<T,R extends AbstractWebhookMessageActionImpl<T,R>>

java.lang.Object

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

net.dv8tion.jda.internal.requests.restaction.TriggerRestAction<T>

net.dv8tion.jda.internal.requests.restaction.AbstractWebhookMessageActionImpl<T,R>

All Implemented Interfaces:

RestAction<T>

Direct Known Subclasses:

WebhookMessageCreateActionImpl, WebhookMessageDeleteActionImpl, WebhookMessageEditActionImpl, WebhookMessageRetrieveActionImpl

public abstract class AbstractWebhookMessageActionImpl<T,R extends AbstractWebhookMessageActionImpl<T,R>>
extends TriggerRestAction<T>

Field Summary

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

LOG

Constructor Summary

Constructors

Constructor	Description
AbstractWebhookMessageActionImpl(JDA api, Route.CompiledRoute route)
AbstractWebhookMessageActionImpl(JDA api, Route.CompiledRoute route, BiFunction<Response,Request<T>,T> handler)

Method Summary

Modifier and Type	Method	Description
R	deadline(long timestamp)	Similar to RestAction.timeout(long, TimeUnit) but schedules a deadline at which the request has to be completed.
R	setCheck(BooleanSupplier checks)	Sets the last-second checks before finally executing the http request in the queue.
R	setThreadId(String threadId)

Methods inherited from class net.dv8tion.jda.internal.requests.restaction.TriggerRestAction

fail, onReady, queue, run, submit

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

complete, getCheck, getDefaultFailure, getDefaultSuccess, getDefaultTimeout, getJDA, handleResponse, 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.api.requests.RestAction

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

Constructor Details

AbstractWebhookMessageActionImpl

public AbstractWebhookMessageActionImpl(JDA api,
 Route.CompiledRoute route)

AbstractWebhookMessageActionImpl

public AbstractWebhookMessageActionImpl(JDA api,
 Route.CompiledRoute route,
 BiFunction<Response,Request<T>,T> handler)

Method Details

setThreadId

@Nonnull
public R setThreadId(@Nullable
 String threadId)

setCheck

@Nonnull
public R 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 RestAction<T>

Overrides:

setCheck in class RestActionImpl<T>

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 R 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 RestAction<T>

Overrides:

deadline in class RestActionImpl<T>

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)