Package net.dv8tion.jda.internal.managers

Class ManagerBase<M extends Manager<M>>

java.lang.Object
net.dv8tion.jda.internal.requests.RestActionImpl<Void>
net.dv8tion.jda.internal.requests.restaction.AuditableRestActionImpl<Void>
net.dv8tion.jda.internal.managers.ManagerBase<M>
All Implemented Interfaces:
Manager<M>, RestAction<Void>, AuditableRestAction<Void>
Direct Known Subclasses:
AccountManagerImpl, ApplicationEmojiManagerImpl, ApplicationManagerImpl, AutoModRuleManagerImpl, ChannelManagerImpl, CustomEmojiManagerImpl, GuildManagerImpl, GuildStickerManagerImpl, GuildWelcomeScreenManagerImpl, PermOverrideManagerImpl, RoleManagerImpl, ScheduledEventManagerImpl, StageInstanceManagerImpl, TemplateManagerImpl, WebhookManagerImpl
public abstract class ManagerBase<M extends Manager<M>> extends AuditableRestActionImpl<Void> implements Manager<M>

  • Method Details

    • setPermissionChecksEnabled

      public static void setPermissionChecksEnabled(boolean enable)

    • isPermissionChecksEnabled

      public static boolean isPermissionChecksEnabled()

    • setCheck

      @Nonnull public M setCheck(@Nonnull 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 AuditableRestAction<M extends Manager<M>>
      Specified by:
      setCheck in interface Manager<M extends Manager<M>>
      Specified by:
      setCheck in interface RestAction<M extends Manager<M>>
      Overrides:
      setCheck in class AuditableRestActionImpl<Void>
      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:

    • timeout

      @Nonnull public M 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<M extends Manager<M>>
      Specified by:
      timeout in interface Manager<M extends Manager<M>>
      Specified by:
      timeout in interface RestAction<M extends Manager<M>>
      Overrides:
      timeout in class AuditableRestActionImpl<Void>
      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 public M 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 AuditableRestAction<M extends Manager<M>>
      Specified by:
      deadline in interface Manager<M extends Manager<M>>
      Specified by:
      deadline in interface RestAction<M extends Manager<M>>
      Overrides:
      deadline in class AuditableRestActionImpl<Void>
      Parameters:
      timestamp - Millisecond timestamp at which the request will timeout
      Returns:
      The same RestAction with the applied deadline
      See Also:

    • reset

      @Nonnull public M reset(long fields)
      Specified by:
      reset in interface Manager<M extends Manager<M>>

    • reset

      @Nonnull public M reset(long... fields)
      Specified by:
      reset in interface Manager<M extends Manager<M>>

    • reset

      @Nonnull public M reset()
      Description copied from interface: Manager
      Resets all fields for this Manager
      Specified by:
      reset in interface Manager<M extends Manager<M>>
      Returns:
      The current Manager with all settings reset to default

    • queue

      public void queue(Consumer<? super Void> 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<M extends Manager<M>>
      Overrides:
      queue in class RestActionImpl<Void>
      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:

    • complete

      public Void 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<M extends Manager<M>>
      Overrides:
      complete in class RestActionImpl<Void>
      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.