Package io.github.unknowncoder56.javaslc

Class Bot

java.lang.Object

io.github.unknowncoder56.javaslc.User

io.github.unknowncoder56.javaslc.Bot

public class Bot
extends User

The main class of the library containing all important methods, like to run the bot. This class cannot be instantiated directly, use BotBuilder instead.

See Also:

• BotBuilder
• User

Nested Class Summary

Nested Classes

Modifier and Type	Class	Description
static enum	Bot.ChangeKey	The enum containing all possible property change keys.

Field Summary

Fields inherited from class io.github.unknowncoder56.javaslc.User

errorListener, userId

Method Summary

Modifier and Type	Method	Description
void	addCommandListener(CommandListener commandListener)	Adds a CommandListener to the bot.
void	addMessageListener(MessageListener messageListener)	Adds a MessageListener to the bot.
CompletableFuture<Void>	change(Bot.ChangeKey changeKey, String changeValue)	This method changes a bot property defined in the Bot.ChangeKey enum.
String	getBotUserId()	Gets the user ID of the bot.
ArrayList<CommandListener>	getCommandListeners()	Gets the list of CommandListeners of the bot.
ArrayList<MessageListener>	getMessageListeners()	Gets the list of MessageListeners of the bot.
String	getPrefix()	Gets the prefix of the bot.
StartListener	getStartListener()	Gets the StartListener of the bot.
CompletableFuture<Void>	join(String serverId)	This method joins a server if not already joined by the bot.
void	run()	The method to run the bot.
CompletableFuture<Void>	send(String text, String serverId)	This method sends a message text to a server if the bot is in it.
void	setPrefix(String prefix)	Sets the prefix of the bot.
void	setStartListener(StartListener startListener)	Sets the StartListener of the bot.

Methods inherited from class io.github.unknowncoder56.javaslc.User

getAccountCreationDate, getErrorListener, getJoinedServerIds, getLabelJsonObject, getNickname, getProfileImageUrl, getUserId, getUsername, isBot, setErrorListener

Methods inherited from class java.lang.Object

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

Method Details

run

public void run()
         throws RuntimeException

The method to run the bot. This method will throw a RuntimeException if the prefix, token or bot user ID is not set in the BotBuilder or later in Bot. Note: This is a blocking method. Use it as the last method call in your thread.

Throws:

RuntimeException - If the prefix, token or bot user ID is not set.

send

public CompletableFuture<Void> send(String text,
 String serverId)

This method sends a message text to a server if the bot is in it. If not this method will fail, add it to a server with join(String).

Parameters:

text - The text to send.

serverId - The ID of the server to send the message to.

Returns:

A CompletableFuture that will be completed when the message is sent.

See Also:

• join(String)

join

public CompletableFuture<Void> join(String serverId)

This method joins a server if not already joined by the bot.

Parameters:

serverId - The ID of the server to join.

Returns:

A CompletableFuture that will be completed when the bot has joined the server.

change

public CompletableFuture<Void> change(Bot.ChangeKey changeKey,
 String changeValue)

This method changes a bot property defined in the Bot.ChangeKey enum.

Parameters:

changeKey - The key of the property to change.

changeValue - The value to change the key to.

Returns:

A CompletableFuture that will be completed when the value is changed.

See Also:

• Bot.ChangeKey

getPrefix

public String getPrefix()

Gets the prefix of the bot.

Returns:

The prefix of the bot.

setPrefix

public void setPrefix(String prefix)

Sets the prefix of the bot.

Parameters:

prefix - The prefix to set.

getStartListener

public StartListener getStartListener()

Gets the StartListener of the bot.

Returns:

The StartListener of the bot.

setStartListener

public void setStartListener(StartListener startListener)

Sets the StartListener of the bot.

Parameters:

startListener - The StartListener to set.

getBotUserId

public String getBotUserId()

Gets the user ID of the bot.

Returns:

The user ID of the bot.

getMessageListeners

public ArrayList<MessageListener> getMessageListeners()

Gets the list of MessageListeners of the bot.

Returns:

An ArrayList containing the MessageListeners of the bot.

addMessageListener

public void addMessageListener(MessageListener messageListener)

Adds a MessageListener to the bot.

Parameters:

messageListener - The MessageListener to add.

getCommandListeners

public ArrayList<CommandListener> getCommandListeners()

Gets the list of CommandListeners of the bot.

Returns:

An ArrayList containing the CommandListeners of the bot.

addCommandListener

public void addCommandListener(CommandListener commandListener)

Adds a CommandListener to the bot.

Parameters:

commandListener - The CommandListener to add.