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

Interface FluentAuditableRestAction<T,R extends FluentAuditableRestAction<T,R>>

Type Parameters:

T - The result type of the AuditableRestAction

R - The concrete AuditableRestAction type used for chaining (fluent interface)

All Superinterfaces:

AuditableRestAction<T>, RestAction<T>

All Known Subinterfaces:

ChannelAction<T>, ScheduledEventAction, ThreadChannelAction

public interface FluentAuditableRestAction<T,R extends FluentAuditableRestAction<T,R>>
extends AuditableRestAction<T>

Interface used to mixin the customization parameters for AuditableRestActions.
This simply fixes the return types to be the concrete implementation instead of the base interface.

Field Summary

Fields inherited from interface net.dv8tion.jda.api.requests.restaction.AuditableRestAction

MAX_REASON_LENGTH

Method Summary

Modifier and Type	Method	Description
default R	addCheck(BooleanSupplier checks)	Shortcut for setCheck(() -> getCheck().getAsBoolean() && checks.getAsBoolean()).
default R	deadline(long timestamp)	Similar to RestAction.timeout(long, TimeUnit) but schedules a deadline at which the request has to be completed.
R	reason(String reason)	Applies the specified reason as audit-log reason field.
R	setCheck(BooleanSupplier checks)	Sets the last-second checks before finally executing the http request in the queue.
default R	timeout(long timeout, TimeUnit unit)	Timeout for this RestAction instance.

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

Method Details

reason

@Nonnull
@CheckReturnValue
R reason(@Nullable
 String reason)

Description copied from interface: AuditableRestAction

Applies the specified reason as audit-log reason field.
When the provided reason is empty or null it will be treated as not set. If the provided reason is longer than 512 characters, it will be truncated to fit the limit.

Reasons for any AuditableRestAction may be retrieved via AuditLogEntry.getReason() in iterable AuditLogPaginationActions from Guild.retrieveAuditLogs()! For guild bans, this is also accessible via Guild.Ban.getReason().

This will specify the reason via the X-Audit-Log-Reason Request Header.

Specified by:

reason in interface AuditableRestAction<T>

Parameters:

reason - The reason for this action which should be logged in the Guild's AuditLogs (up to 512 characters)

Returns:

The current AuditableRestAction instance for chaining convenience

See Also:

• ThreadLocalReason

setCheck

@Nonnull
@CheckReturnValue
R setCheck(@Nullable
 BooleanSupplier checks)

Description copied from interface: AuditableRestAction

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

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)

addCheck

@Nonnull
@CheckReturnValue
default R addCheck(@Nonnull
 BooleanSupplier checks)

Description copied from interface: RestAction

Shortcut for setCheck(() -> getCheck().getAsBoolean() && checks.getAsBoolean()).

Specified by:

addCheck in interface RestAction<T>

Parameters:

checks - Other checks to run

Returns:

The current RestAction for chaining convenience

See Also:

• RestAction.setCheck(BooleanSupplier)

timeout

@Nonnull
@CheckReturnValue
default R timeout(long timeout,
 @Nonnull
 TimeUnit unit)

Description copied from interface: AuditableRestAction

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

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
@CheckReturnValue
default R deadline(long timestamp)

Description copied from interface: AuditableRestAction

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

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)