Package net.dv8tion.jda.internal.requests

Class RestActionImpl<T>

java.lang.Object
net.dv8tion.jda.internal.requests.RestActionImpl<T>
All Implemented Interfaces:
RestAction<T>
Direct Known Subclasses:
AuditableRestActionImpl, CommandCreateActionImpl, CommandEditActionImpl, CommandListUpdateActionImpl, ForumPostActionImpl, GuildActionImpl, InteractionCallbackImpl, MemberActionImpl, MessageCreateActionImpl, MessageEditActionImpl, MessageHistory.MessageRetrieveAction, OrderActionImpl, PaginationActionImpl, StageInstanceActionImpl, TestEntitlementCreateActionImpl, TriggerRestAction
public class RestActionImpl<T> extends Object implements RestAction<T>

  • Field Details

    • LOG

      public static final org.slf4j.Logger LOG

  • Constructor Details

  • Method Details

    • setPassContext

      public static void setPassContext(boolean enable)

    • isPassContext

      public static boolean isPassContext()

    • setDefaultFailure

      public static void setDefaultFailure(Consumer<? super Throwable> callback)

    • setDefaultSuccess

      public static void setDefaultSuccess(Consumer<Object> callback)

    • setDefaultTimeout

      public static void setDefaultTimeout(long timeout, @Nonnull TimeUnit unit)

    • getDefaultTimeout

      public static long getDefaultTimeout()

    • getDefaultFailure

      public static Consumer<? super Throwable> getDefaultFailure()

    • getDefaultSuccess

      public static Consumer<Object> getDefaultSuccess()

    • setErrorMapper

      public void setErrorMapper(ErrorMapper errorMapper)

    • priority

      public RestActionImpl<T> priority()

    • getJDA

      @Nonnull public JDA getJDA()
      Description copied from interface: RestAction
      The current JDA instance
      Specified by:
      getJDA in interface RestAction<T>
      Returns:
      The corresponding JDA instance

    • setCheck

      @Nonnull public RestAction<T> 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<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:

    • getCheck

      @Nullable public BooleanSupplier getCheck()
      Description copied from interface: RestAction
      The current checks for this RestAction.
      Specified by:
      getCheck in interface RestAction<T>
      Returns:
      The current checks, or null if none were set
      See Also:

    • deadline

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

    • queue

      public void queue(Consumer<? super T> success, Consumer<? super Throwable> failure)
      Description copied from interface: RestAction
      Submits a Request for execution.

      This method is asynchronous

      Example

      
 public static void sendPrivateMessage(JDA jda, String userId, String content)
 {
     // Retrieve the user by their id
     RestAction<User> action = jda.retrieveUserById(userId);
     action.queue(
         // Handle success if the user exists
         (user) -> user.openPrivateChannel().queue(
             (channel) -> channel.sendMessage(content).queue()),

         // Handle failure if the user does not exist (or another issue appeared)
         (error) -> error.printStackTrace()
     );

     // Alternatively use submit() to remove nested callbacks
 }
      Specified by:
      queue in interface RestAction<T>
      Parameters:
      success - The success callback that will be called at a convenient time for the API. (can be null to use default)
      failure - The failure callback that will be called if the Request encounters an exception at its execution point. (can be null to use default)
      See Also:

    • submit

      @Nonnull public CompletableFuture<T> submit(boolean shouldQueue)
      Description copied from interface: RestAction
      Submits a Request for execution and provides a CompletableFuture representing its completion task.
      Cancelling the returned Future will result in the cancellation of the Request!
      Specified by:
      submit in interface RestAction<T>
      Parameters:
      shouldQueue - Whether the Request should automatically handle rate limitations. (default true)
      Returns:
      Never-null CompletableFuture task representing the completion promise

    • complete

      public T complete(boolean shouldQueue) throws RateLimitedException
      Description copied from interface: RestAction
      Blocks the current Thread and awaits the completion of an RestAction.submit() request.
      Used for synchronous logic.
      Specified by:
      complete in interface RestAction<T>
      Parameters:
      shouldQueue - Whether this should automatically handle rate limitations (default true)
      Returns:
      The response value
      Throws:
      RateLimitedException - If we were rate limited and the shouldQueue is false. Use RestAction.complete() to avoid this Exception.

    • handleResponse

      public void handleResponse(Response response, Request<T> request)