Package org.botblock.javabotblockapi.jda

Class PostAction

java.lang.Object

org.botblock.javabotblockapi.jda.PostAction

public class PostAction
extends Object

Class used to perform POST requests towards the /api/count endpoint of BotBlock using the JDA Library.

The class offers options to post either manually or automatically.
It also allows you to choose, if you want to use a JDA instance or a ShardManager instance.

If you want to post without using either instance, use the normal PostAction.

Constructor Summary

Constructors

Constructor	Description
PostAction(JDA jda)	Creates a new instance of this class.
PostAction(ShardManager shardManager)	Creates a new instance of this class.

Method Summary

Modifier and Type	Method	Description
void	disableAutoPost()	Disables the automatic posting of Stats.
void	disableAutoPost(long time, TimeUnit timeUnit)	Disables the automatic posting of Stats.
void	disableAutoPost(BotBlockAPI botBlockAPI)	Disables the automatic posting of Stats.
void	enableAutoPost(JDA jda, BotBlockAPI botBlockAPI)	Starts a scheduleAtFixedRate task, which will post the statistics of the provided JDA instance every n minutes.
void	enableAutoPost(ShardManager shardManager, BotBlockAPI botBlockAPI)	Starts a scheduleAtFixedRate task, which will post the statistics of the provided ShardManager instance every n minutes.
void	postGuilds(JDA jda, BotBlockAPI botBlockAPI)	Performs a POST request towards the BotBlock API using the information from the provided JDA and BotBlockAPI instances.
void	postGuilds(ShardManager shardManager, BotBlockAPI botBlockAPI)	Performs a POST request towards the BotBlock API using the information from the provided ShardManager and BotBlockAPI instances.

Methods inherited from class java.lang.Object

equals, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

Constructor Detail

PostAction

public PostAction(@Nonnull
                  ShardManager shardManager)

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

Parameters:

shardManager - The ShardManager instance used to set the UserAgent.

PostAction

public PostAction(@Nonnull
                  JDA jda)

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

Parameters:

jda - The JDA 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.

Since:

6.0.0

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.

Since:

6.0.0

See Also:

ExecutorService.awaitTermination(long, TimeUnit)

enableAutoPost

public void enableAutoPost(@Nonnull
                           JDA jda,
                           @Nonnull
                           BotBlockAPI botBlockAPI)

Starts a scheduleAtFixedRate task, which will post the statistics of the provided JDA 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 catched and the 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).

If you have a sharded bot is it recommendet to use enableAutoPost(ShardManager, BotBlockAPI) instead.

Parameters:

jda - The JDA instance to post stats from.

botBlockAPI - The BotBlockAPI instance to use.

enableAutoPost

public void enableAutoPost(@Nonnull
                           ShardManager shardManager,
                           @Nonnull
                           BotBlockAPI botBlockAPI)

Starts a scheduleAtFixedRate task, which will post the statistics of the provided ShardManager 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).

Parameters:

shardManager - The ShardManager instance to post stats from.

botBlockAPI - The BotBlockAPI instance to use.

postGuilds

public void postGuilds(@Nonnull
                       JDA jda,
                       @Nonnull
                       BotBlockAPI botBlockAPI)
                throws IOException,
                       RateLimitedException

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

If the provided JDA instance also is part of a sharded Bot (Amount of shards is larger than 1) will the request also include shard_id and shard_count

Parameters:

jda - The JDA instance 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).

postGuilds

public void postGuilds(@Nonnull
                       ShardManager shardManager,
                       @Nonnull
                       BotBlockAPI botBlockAPI)
                throws IOException,
                       RateLimitedException

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

The following Exceptions may be thrown by the CheckUtil:

• IllegalStateException - if the first shard of the provided ShardManager is null.

Parameters:

shardManager - The ShardManager instance 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).