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

Class StageInstanceActionImpl

java.lang.Object

net.dv8tion.jda.internal.requests.RestActionImpl<StageInstance>

net.dv8tion.jda.internal.requests.restaction.StageInstanceActionImpl

All Implemented Interfaces:

RestAction<StageInstance>, StageInstanceAction

public class StageInstanceActionImpl
extends RestActionImpl<StageInstance>
implements StageInstanceAction

Field Summary

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

LOG

Constructor Summary

Constructors

Constructor	Description
StageInstanceActionImpl(StageChannel channel)

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	setTopic(String topic)	Sets the topic for the stage instance.
StageInstanceAction	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

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

Constructor Details

StageInstanceActionImpl

public StageInstanceActionImpl(StageChannel channel)

Method Details

setCheck

@Nonnull
public StageInstanceAction 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 RestAction<StageInstance>

Specified by:

setCheck in interface StageInstanceAction

Overrides:

setCheck in class RestActionImpl<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
public 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>

Specified by:

timeout in interface StageInstanceAction

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

Specified by:

deadline in interface StageInstanceAction

Overrides:

deadline in class RestActionImpl<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
public StageInstanceAction setTopic(@Nonnull
 String topic)

Description copied from interface: StageInstanceAction

Sets the topic for the stage instance.
This shows up in stage discovery and in the stage view.

Specified by:

setTopic in interface StageInstanceAction

Parameters:

topic - The topic, must be 1-120 characters long

Returns:

The StageInstanceAction for chaining