Interface CommandListUpdateAction
-
- All Superinterfaces:
RestAction<java.util.List<Command>>
public interface CommandListUpdateAction extends RestAction<java.util.List<Command>>
SpecializedRestActionused to replace existing commands of a guild or globally.
Any commands that currently exist and are not listed throughaddCommands(CommandData...)will be DELETED!
-
-
Method Summary
All Methods Instance Methods Abstract Methods Default Methods Modifier and Type Method Description CommandListUpdateActionaddCheck(java.util.function.BooleanSupplier checks)Shortcut forsetCheck(() -> getCheck().getAsBoolean() && checks.getAsBoolean()).CommandListUpdateActionaddCommands(java.util.Collection<? extends CommandData> commands)Adds up to 100 commands.default CommandListUpdateActionaddCommands(CommandData... commands)Adds up to 100 commands.CommandListUpdateActiondeadline(long timestamp)Similar toRestAction.timeout(long, TimeUnit)but schedules a deadline at which the request has to be completed.CommandListUpdateActionsetCheck(java.util.function.BooleanSupplier checks)Sets the last-second checks before finally executing the http request in the queue.CommandListUpdateActiontimeout(long timeout, java.util.concurrent.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, queue, queue, queue, queueAfter, queueAfter, queueAfter, queueAfter, queueAfter, queueAfter, submit, submit, submitAfter, submitAfter, zip
-
-
-
-
Method Detail
-
timeout
@Nonnull CommandListUpdateAction timeout(long timeout, @Nonnull java.util.concurrent.TimeUnit unit)
Description copied from interface:RestActionTimeout 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 asdeadline(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:
timeoutin interfaceRestAction<java.util.List<Command>>- Parameters:
timeout- The timeout to useunit-Unitfor the timeout value- Returns:
- The same RestAction instance with the applied timeout
- See Also:
RestAction.setDefaultTimeout(long, TimeUnit)
-
deadline
@Nonnull CommandListUpdateAction deadline(long timestamp)
Description copied from interface:RestActionSimilar toRestAction.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 aTimeoutException.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:
deadlinein interfaceRestAction<java.util.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)
-
setCheck
@Nonnull CommandListUpdateAction setCheck(@Nullable java.util.function.BooleanSupplier checks)
Description copied from interface:RestActionSets the last-second checks before finally executing the http request in the queue.
If the provided supplier evaluates tofalseor 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:
setCheckin interfaceRestAction<java.util.List<Command>>- Parameters:
checks- The checks to run before executing the request, ornullto run no checks- Returns:
- The current RestAction for chaining convenience
- See Also:
RestAction.getCheck(),RestAction.addCheck(BooleanSupplier)
-
addCheck
@Nonnull CommandListUpdateAction addCheck(@Nonnull java.util.function.BooleanSupplier checks)
Description copied from interface:RestActionShortcut forsetCheck(() -> getCheck().getAsBoolean() && checks.getAsBoolean()).- Specified by:
addCheckin interfaceRestAction<java.util.List<Command>>- Parameters:
checks- Other checks to run- Returns:
- The current RestAction for chaining convenience
- See Also:
RestAction.setCheck(BooleanSupplier)
-
addCommands
@Nonnull @CheckReturnValue CommandListUpdateAction addCommands(@Nonnull java.util.Collection<? extends CommandData> commands)
Adds up to 100 commands.When a command is not listed in this request, it will be deleted.
- Parameters:
commands- Thecommandsto add- Returns:
- The CommandUpdateAction instance, for chaining
- Throws:
java.lang.IllegalArgumentException- If null or more than 100 commands are provided
-
addCommands
@Nonnull @CheckReturnValue default CommandListUpdateAction addCommands(@Nonnull CommandData... commands)
Adds up to 100 commands.When a command is not listed in this request, it will be deleted.
- Parameters:
commands- Thecommandsto add- Returns:
- The CommandUpdateAction instance, for chaining
- Throws:
java.lang.IllegalArgumentException- If null or more than 100 commands are provided
-
-