Constructor Detail

• PostAction

  public PostAction​(org.javacord.api.DiscordApi api)

  Creates a new instance of this class.
  This will set the UserAgent used for POST request to <botname>-<discriminator>/<api-version> (Javacord) DBots/<id> using the provided DiscordApi instance.

  Parameters:

  api - The DiscordApi instance used to set the UserAgent.

Method Detail

• disableAutoPost

  public void disableAutoPost()

  Disables the automatic posting of Stats.
  This essentially just performs a ScheduledExecutorService.shutdown() by calling the disableAutoPost(null) method.

  Note that using this method will NOT make the scheduler wait for previously scheduled tasks to complete.
  If you want to wait for the tasks to complete use disableAutoPost(BotBlockAPI) or disableAutoPost(long, TimeUnit) instead.

  See Also:

  ExecutorService.shutdown()

• disableAutoPost

  public void disableAutoPost​(@Nullable
                              BotBlockAPI botBlockAPI)

  Disables the automatic posting of Stats.
  Unlike disableAutoPost() can you make the scheduler wait for all scheduled tasks to finish, or to time out after n minutes by providing the BotBlock instance.

  Passing null as argument will just perform a ScheduledExecutorService.shutdown() similar to what the disableAutoPost() method does.

  If you want to use a different delay than what you've set in the BotBlockAPI instance, can you use disableAutoPost(long, TimeUnit) instead.

  This method may throw a InterruptedException in the terminal.

  Parameters:

  botBlockAPI - The BotBlockAPI instance or null to just perform a shutdown.

  See Also:

  ExecutorService.shutdown(), ExecutorService.awaitTermination(long, TimeUnit)

• disableAutoPost

  public void disableAutoPost​(long time,
                              @Nonnull
                              TimeUnit timeUnit)

  Disables the automatic posting of Stats.
  Unlike disableAutoPost() can you make the scheduler wait for all scheduled tasks to finish, or to time out after a specified time frame.

  This method may throw a InterruptedException in the terminal.

  Following Exceptions can be thrown from the CheckUtil:

  • IllegalStateException - When the provided time param is 0 or lower.

  Parameters:

  time - The amount of time to wait for scheduled executions to finish before the Scheduler would time out.

  timeUnit - The TimeUnit to use.

  See Also:

  ExecutorService.awaitTermination(long, TimeUnit)

• enableAutoPost

  public void enableAutoPost​(@Nonnull
                             BotBlockAPI botBlockAPI,
                             @Nonnull
                             org.javacord.api.DiscordApi... discordApis)

  Starts a scheduleAtFixedRate task, which will post the statistics of the provided DiscordApi instance every n minutes.

  If the post can't be performed - either by getting a RatelimitedException or by getting an IOException - will the exception be caught and a Stacktrace printed.

  The scheduler will wait an initial delay of 1 minute and then performs a task every n minutes, where n is the time set in BotBlockAPI.Builder.setUpdateDelay(Integer) (default is 30 minutes).

  Following Exceptions can be thrown from the CheckUtil:

  • IllegalStateException - When the provided DiscordApis are 0 or less.

  Parameters:

  discordApis - The DiscordApi instances to post stats from.

  botBlockAPI - The BotBlockAPI instance to use.

• postGuilds

  public void postGuilds​(@Nonnull
                         BotBlockAPI botBlockAPI,
                         @Nonnull
                         org.javacord.api.DiscordApi... discordApis)
                  throws IOException,
                         RateLimitedException

  Performs a POST request towards the BotBlock API using the information from the provided DiscordApi and BotBlock instances.

  If the provided DiscordApi instance is a sharded Bot (Amount of shards is larger than 1) will the request contain the shards array alongside a shard_count field.

  Following Exceptions can be thrown from the CheckUtil:

  • IllegalStateException - When the provided DiscordApis are 0 or less.

  Parameters:

  discordApis - The DiscordApi instances to post stats from.

  botBlockAPI - The BotBlockAPI instance to use.

  Throws:

  IOException - When the POST request wasn't successful.

  RateLimitedException - When we get rate limited by the BotBlock API (returns error code 429).