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

Interface StageInstanceAction

All Superinterfaces:

RestAction<StageInstance>

public interface StageInstanceAction
extends RestAction<StageInstance>

Specialized RestAction used to create a StageInstance

See Also:

• StageChannel.createStageInstance(String)

Method Summary

Modifier and Type	Method	Description
StageInstanceAction	deadline(long timestamp)	Similar to RestAction.timeout(long, TimeUnit) but schedules a deadline at which the request has to be completed.
StageInstanceAction	setCheck(BooleanSupplier checks)	Sets the last-second checks before finally executing the http request in the queue.
StageInstanceAction	setPrivacyLevel(StageInstance.PrivacyLevel level)	Sets the PrivacyLevel for the stage instance.
StageInstanceAction	setTopic(String topic)	Sets the topic for the stage instance.
StageInstanceAction	timeout(long timeout, 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, onSuccess, queue, queue, queue, queueAfter, queueAfter, queueAfter, queueAfter, queueAfter, queueAfter, submit, submit, submitAfter, submitAfter, zip

Method Details

setCheck

@Nonnull
StageInstanceAction setCheck(@Nullable
 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 RestAction<StageInstance>

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
StageInstanceAction 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 RestAction<StageInstance>

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
StageInstanceAction 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 RestAction<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
 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:

IllegalArgumentException - If the topic is null, empty, or longer than 120 characters

setPrivacyLevel

@Nonnull
@CheckReturnValue
StageInstanceAction setPrivacyLevel(@Nonnull
 StageInstance.PrivacyLevel level)

Sets the PrivacyLevel for the stage instance.
This indicates whether guild lurkers are allowed to join the stage instance or only guild members.

Parameters:

level - The StageInstance.PrivacyLevel

Returns:

The StageInstanceAction for chaining

Throws:

IllegalArgumentException - If the privacy level is null, UNKNOWN, or PUBLIC.