Interface StageInstanceAction
-
- All Superinterfaces:
RestAction<StageInstance>
public interface StageInstanceAction extends RestAction<StageInstance>
SpecializedRestAction
used to create aStageInstance
- See Also:
StageChannel.createStageInstance(String)
-
-
Method Summary
All Methods Instance Methods Abstract Methods Modifier and Type Method Description StageInstanceAction
deadline(long timestamp)
Similar toRestAction.timeout(long, TimeUnit)
but schedules a deadline at which the request has to be completed.StageInstanceAction
setCheck(java.util.function.BooleanSupplier checks)
Sets the last-second checks before finally executing the http request in the queue.StageInstanceAction
setPrivacyLevel(StageInstance.PrivacyLevel level)
Sets thePrivacyLevel
for the stage instance.StageInstanceAction
setTopic(java.lang.String topic)
Sets the topic for the stage instance.StageInstanceAction
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
-
setCheck
@Nonnull StageInstanceAction setCheck(@Nullable java.util.function.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 tofalse
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 interfaceRestAction<StageInstance>
- Parameters:
checks
- The checks to run before executing the request, ornull
to run no checks- Returns:
- The current RestAction for chaining convenience
- See Also:
RestAction.getCheck()
,RestAction.addCheck(BooleanSupplier)
-
timeout
@Nonnull StageInstanceAction timeout(long timeout, @Nonnull java.util.concurrent.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 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:
timeout
in interfaceRestAction<StageInstance>
- Parameters:
timeout
- The timeout to useunit
-Unit
for the timeout value- Returns:
- The same RestAction instance with the applied timeout
- See Also:
RestAction.setDefaultTimeout(long, TimeUnit)
-
deadline
@Nonnull StageInstanceAction deadline(long timestamp)
Description copied from interface:RestAction
Similar 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:
deadline
in interfaceRestAction<StageInstance>
- 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)
-
setTopic
@Nonnull @CheckReturnValue StageInstanceAction setTopic(@Nonnull java.lang.String topic)
Sets the topic for the stage instance.
This shows up in stage discovery and in the stage view.- Parameters:
topic
- The topic, must be 1-120 characters long- Returns:
- The StageInstanceAction for chaining
- Throws:
java.lang.IllegalArgumentException
- If the topic is null, empty, or longer than 120 characters
-
setPrivacyLevel
@Nonnull @CheckReturnValue StageInstanceAction setPrivacyLevel(@Nonnull StageInstance.PrivacyLevel level)
Sets thePrivacyLevel
for the stage instance.
This indicates whether guild lurkers are allowed to join the stage instance or only guild members.- Parameters:
level
- TheStageInstance.PrivacyLevel
- Returns:
- The StageInstanceAction for chaining
- Throws:
java.lang.IllegalArgumentException
- If the provided level is null orUNKNOWN
-
-