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

Interface CacheRestAction<T>

Type Parameters:
T - The entity type
All Superinterfaces:
RestAction<T>
public interface CacheRestAction<T> extends RestAction<T>
Requests which can use cached values instead of making a request to Discord.

  • Method Details

    • setCheck

      @Nonnull @CheckReturnValue CacheRestAction<T> 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<T>
      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:

    • addCheck

      @Nonnull @CheckReturnValue default CacheRestAction<T> addCheck(@Nonnull BooleanSupplier checks)
      Description copied from interface: RestAction
      Shortcut for setCheck(() -> getCheck().getAsBoolean() && checks.getAsBoolean()).
      Specified by:
      addCheck in interface RestAction<T>
      Parameters:
      checks - Other checks to run
      Returns:
      The current RestAction for chaining convenience
      See Also:

    • timeout

      @Nonnull @CheckReturnValue default CacheRestAction<T> 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<T>
      Parameters:
      timeout - The timeout to use
      unit - Unit for the timeout value
      Returns:
      The same RestAction instance with the applied timeout
      See Also:

    • deadline

      @Nonnull @CheckReturnValue default CacheRestAction<T> 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<T>
      Parameters:
      timestamp - Millisecond timestamp at which the request will timeout
      Returns:
      The same RestAction with the applied deadline
      See Also:

    • useCache

      @Nonnull @CheckReturnValue CacheRestAction<T> useCache(boolean useCache)
      Sets whether this request should rely on cached entities, or always retrieve a new one.
      Parameters:
      useCache - True if the cache should be used when available, even if the entity might be outdated. False, to always request a new instance from the API.
      Returns:
      This RestAction instance