Interface SoundboardSoundCreateAction

All Superinterfaces:

AuditableRestAction<SoundboardSound>, RestAction<SoundboardSound>

public interface SoundboardSoundCreateAction
extends AuditableRestAction<SoundboardSound>

Specialized RestAction used to create a SoundboardSound in a guild.

Field Summary

Fields inherited from interface AuditableRestAction

MAX_REASON_LENGTH

Method Summary

Modifier and Type	Method	Description
SoundboardSoundCreateAction	addCheck(BooleanSupplier checks)	Shortcut for setCheck(() -> getCheck().getAsBoolean() && checks.getAsBoolean()).
SoundboardSoundCreateAction	deadline(long timestamp)	Similar to RestAction.timeout(long, TimeUnit) but schedules a deadline at which the request has to be completed.
SoundboardSoundCreateAction	setCheck(BooleanSupplier checks)	Sets the last-second checks before finally executing the http request in the queue.
SoundboardSoundCreateAction	setEmoji(Emoji emoji)	Sets the emoji of the soundboard sound being created.
SoundboardSoundCreateAction	setVolume(double volume)	Sets the volume of the soundboard sound being created.
SoundboardSoundCreateAction	timeout(long timeout, TimeUnit unit)	Timeout for this RestAction instance.

Methods inherited from interface AuditableRestAction

reason

Methods inherited from interface 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

Method Details

timeout

@Nonnull
@CheckReturnValue
SoundboardSoundCreateAction timeout(long timeout,
 @Nonnull
 TimeUnit unit)

Description copied from interface: AuditableRestAction

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 AuditableRestAction<SoundboardSound>

Specified by:

timeout in interface RestAction<SoundboardSound>

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
@CheckReturnValue
SoundboardSoundCreateAction deadline(long timestamp)

Description copied from interface: AuditableRestAction

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 AuditableRestAction<SoundboardSound>

Specified by:

deadline in interface RestAction<SoundboardSound>

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
@CheckReturnValue
SoundboardSoundCreateAction setCheck(@Nullable
 BooleanSupplier checks)

Description copied from interface: AuditableRestAction

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 AuditableRestAction<SoundboardSound>

Specified by:

setCheck in interface RestAction<SoundboardSound>

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)

addCheck

@Nonnull
@CheckReturnValue
SoundboardSoundCreateAction addCheck(@Nonnull
 BooleanSupplier checks)

Description copied from interface: RestAction

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

Specified by:

addCheck in interface RestAction<SoundboardSound>

Parameters:

checks - Other checks to run

Returns:

The current RestAction for chaining convenience

See Also:

• RestAction.setCheck(BooleanSupplier)

setVolume

@Nonnull
@CheckReturnValue
SoundboardSoundCreateAction setVolume(double volume)

Sets the volume of the soundboard sound being created.

Parameters:

volume - The new volume

Returns:

This action for chaining convenience

Throws:

IllegalArgumentException - If the provided volume is not between 0-1

setEmoji

@Nonnull
@CheckReturnValue
SoundboardSoundCreateAction setEmoji(@Nullable
 Emoji emoji)

Sets the emoji of the soundboard sound being created.

Parameters:

emoji - The new emoji, can be null

Returns:

This action for chaining convenience