Package net.dv8tion.jda.api.requests.restaction

Interface AuditableRestAction<T>

Type Parameters:

T - The return type

All Superinterfaces:

RestAction<T>

All Known Subinterfaces:

AccountManager, ChannelAction<T>, ChannelManager, EmoteManager, GuildManager, InviteAction, Manager<M>, PermissionOverrideAction, PermOverrideManager, RoleAction, RoleManager, StageInstanceManager, TemplateManager, WebhookAction, WebhookManager

public interface AuditableRestAction<T>
extends RestAction<T>

Extension of RestAction to allow setting a reason, only available to accounts of AccountType.BOT

This will automatically use the ThreadLocalReason if no reason was specified via reason(String).

Since:

3.3.0

Method Summary

Modifier and Type	Method	Description
AuditableRestAction<T>	deadline(long timestamp)	Similar to RestAction.timeout(long, TimeUnit) but schedules a deadline at which the request has to be completed.
AuditableRestAction<T>	reason(java.lang.String reason)	Applies the specified reason as audit-log reason field.
AuditableRestAction<T>	setCheck(java.util.function.BooleanSupplier checks)	Sets the last-second checks before finally executing the http request in the queue.
AuditableRestAction<T>	timeout(long timeout, java.util.concurrent.TimeUnit unit)	Timeout for this RestAction instance.

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

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

Method Detail

reason

@Nonnull
AuditableRestAction<T> reason(@Nullable
                              java.lang.String reason)

Applies the specified reason as audit-log reason field.
When the provided reason is empty or null it will be treated as not set.

Reasons for any AuditableRestAction may be retrieved via AuditLogEntry.getReason() in iterable AuditLogPaginationActions from Guild.retrieveAuditLogs()!

This will specify the reason via the X-Audit-Log-Reason Request Header.
Using methods with a reason parameter will always work and override this header. (ct. Guild.ban(User, int, String))

Parameters:

reason - The reason for this action which should be logged in the Guild's AuditLogs

Returns:

The current AuditableRestAction instance for chaining convenience

See Also:

ThreadLocalReason

setCheck

@Nonnull
AuditableRestAction<T> setCheck(@Nullable
                                java.util.function.BooleanSupplier checks)

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>

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
AuditableRestAction<T> timeout(long timeout,
                               @Nonnull
                               java.util.concurrent.TimeUnit unit)

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

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
AuditableRestAction<T> deadline(long timestamp)

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>

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)