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

Class CommandListUpdateActionImpl

java.lang.Object

net.dv8tion.jda.internal.requests.RestActionImpl<List<Command>>

net.dv8tion.jda.internal.requests.restaction.CommandListUpdateActionImpl

All Implemented Interfaces:

RestAction<List<Command>>, CommandListUpdateAction

public class CommandListUpdateActionImpl
extends RestActionImpl<List<Command>>
implements CommandListUpdateAction

Field Summary

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

LOG

Constructor Summary

Constructors

Constructor	Description
CommandListUpdateActionImpl(JDA api, GuildImpl guild, Route.CompiledRoute route)

Method Summary

Modifier and Type	Method	Description
CommandListUpdateAction	addCheck(BooleanSupplier checks)	Shortcut for setCheck(() -> getCheck().getAsBoolean() && checks.getAsBoolean()).
CommandListUpdateAction	addCommands(Collection<? extends CommandData> commands)	Adds up to 100 slash commands, 5 user context commands, and 5 message context commands.
CommandListUpdateAction	deadline(long timestamp)	Similar to RestAction.timeout(long, TimeUnit) but schedules a deadline at which the request has to be completed.
CommandListUpdateAction	setCheck(BooleanSupplier checks)	Sets the last-second checks before finally executing the http request in the queue.
CommandListUpdateAction	timeout(long timeout, TimeUnit unit)	Timeout for this RestAction instance.

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.api.requests.restaction.CommandListUpdateAction

addCommands

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

CommandListUpdateActionImpl

public CommandListUpdateActionImpl(JDA api,
 GuildImpl guild,
 Route.CompiledRoute route)

Method Details

timeout

@Nonnull
public CommandListUpdateAction 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 CommandListUpdateAction

Specified by:

timeout in interface RestAction<List<Command>>

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)

addCheck

@Nonnull
public CommandListUpdateAction addCheck(@Nonnull
 BooleanSupplier checks)

Description copied from interface: RestAction

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

Specified by:

addCheck in interface CommandListUpdateAction

Specified by:

addCheck in interface RestAction<List<Command>>

Parameters:

checks - Other checks to run

Returns:

The current RestAction for chaining convenience

See Also:

• RestAction.setCheck(BooleanSupplier)

setCheck

@Nonnull
public CommandListUpdateAction 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 CommandListUpdateAction

Specified by:

setCheck in interface RestAction<List<Command>>

Overrides:

setCheck in class RestActionImpl<List<Command>>

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 CommandListUpdateAction 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 CommandListUpdateAction

Specified by:

deadline in interface RestAction<List<Command>>

Overrides:

deadline in class RestActionImpl<List<Command>>

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)

addCommands

@Nonnull
public CommandListUpdateAction addCommands(@Nonnull
 Collection<? extends CommandData> commands)

Description copied from interface: CommandListUpdateAction

Adds up to 100 slash commands, 5 user context commands, and 5 message context commands.

When a command is not listed in this request, it will be deleted.

Specified by:

addCommands in interface CommandListUpdateAction

Parameters:

commands - The commands to add

Returns:

The CommandUpdateAction instance, for chaining

See Also:

• Commands.slash(...)
• Commands.message(...)
• Commands.user(...)