com.ericramirezs.commando4j

Class CommandEngine

java.lang.Object

net.dv8tion.jda.api.hooks.ListenerAdapter

com.ericramirezs.commando4j.CommandEngine

All Implemented Interfaces:

ICommandEngine, net.dv8tion.jda.api.hooks.EventListener

public class CommandEngine
extends net.dv8tion.jda.api.hooks.ListenerAdapter
implements ICommandEngine

The core of commando4j, It will handle all command calls registered through this engine.

Constructor Summary

Constructors

Modifier	Constructor and Description
protected	CommandEngine() Creates an Instance of this ICommandEngine implementations.

Method Summary

Modifier and Type	Method and Description
ICommandEngine	addAlias(@NotNull String name, ICommand command) Add an alternative name to a command.
ICommandEngine	addCommand(@NotNull ICommand command) Registers an ICommand into the engine.
static void	addCommandPackage(String path) Set the package name where the classes that extends ICommand are located in your project.
static @NotNull net.dv8tion.jda.api.JDA	create(@NotNull net.dv8tion.jda.api.JDABuilder builder) This will build the JDA object.
static @NotNull net.dv8tion.jda.api.JDA	create(String token, Collection<net.dv8tion.jda.api.requests.GatewayIntent> intents) Creates a JDA with the predefined token.
static @NotNull net.dv8tion.jda.api.JDA	create(String token, net.dv8tion.jda.api.requests.GatewayIntent intent, net.dv8tion.jda.api.requests.GatewayIntent... intents) Creates a JDA with the predefined token.
static @NotNull net.dv8tion.jda.api.JDA	createDefault(String token) Creates a JDABuilder with recommended default settings.
static @NotNull net.dv8tion.jda.api.JDA	createDefault(String token, Collection<net.dv8tion.jda.api.requests.GatewayIntent> intents) Creates a JDABuilder with recommended default settings.
static @NotNull net.dv8tion.jda.api.JDA	createDefault(String token, net.dv8tion.jda.api.requests.GatewayIntent intent, net.dv8tion.jda.api.requests.GatewayIntent... intents) Creates a JDABuilder with recommended default settings.
static @NotNull net.dv8tion.jda.api.JDA	createLight(String token) Creates a JDA with low memory profile settings and with ICommandEngine preset.
static @NotNull net.dv8tion.jda.api.JDA	createLight(String token, Collection<net.dv8tion.jda.api.requests.GatewayIntent> intents) Creates a JDA with low memory profile settings and with ICommandEngine preset.
static @NotNull net.dv8tion.jda.api.JDA	createLight(String token, net.dv8tion.jda.api.requests.GatewayIntent intent, net.dv8tion.jda.api.requests.GatewayIntent... intents) Creates a JDA with low memory profile settings and with ICommandEngine preset.
@Nullable ICommand	getCommand(@NotNull String name) Get an ICommand from the registered commands in the Engine.
@NotNull @UnmodifiableView List<ICommand>	getCommands() Get a list of ICommand registered in the Engine.
@NotNull List<ICommand>	getCommandsByExactMatch(String name) Get a list of ICommand from the registered commands in the Engine.
@NotNull List<ICommand>	getCommandsByPartialMatch(String name) Get a list of ICommand from the registered commands in the Engine.
ICommand	getHelpCommand() Return the ICommand object of the help command.
static ICommandEngine	getInstance() Get the actual instance of ICommandEngine that is being used.
net.dv8tion.jda.api.JDA	getJda() Get the JDA object set within this Engine.
Locale	getLanguage() Gets the default language to be used by the bot.
Locale	getLanguage(@Nullable net.dv8tion.jda.api.events.Event event) By default, gets the default language to be used by the bot.
String	getPrefix() Gets the prefix configured on the bot.
String	getPrefix(@NotNull net.dv8tion.jda.api.events.Event event) By default, it gets the prefix configured on the bot.
String	getPrefix(@NotNull net.dv8tion.jda.api.events.message.MessageReceivedEvent event) By default, it gets the prefix configured on the bot.
String	getPrefix(@NotNull net.dv8tion.jda.api.events.interaction.command.SlashCommandInteractionEvent event) By default, it gets the prefix configured on the bot.
IRepository	getRepository() Return the repository Controller.
@NotNull String	getString(@NotNull String key) Gets a text string in the configured language of the bot.
@NotNull String	getString(@NotNull String key, @NotNull Locale locale) Gets a text string in a specific language.
@NotNull String[]	getStringArray(@NotNull String key) Gets a string Array in the configured language of the bot.
@NotNull String[]	getStringArray(@NotNull String key, @NotNull Locale locale) Gets a string Array in a specific language.
static void	includeBuildInUtils() Include pre-created commands, such has Help, Ping, Language and prefix.
boolean	isReactToMention() Get whether the bot should react to mention or not.
boolean	isReactToMention(net.dv8tion.jda.api.events.Event event) Checks if bot should react to mention calls (Messages that starts with @BOT_NAME).
void	loadCommands() Registers ICommands from packages set into the engine.
void	logDebug(String message) Log a message at the DEBUG level.
void	logError(String message) Log a message at the ERROR level.
void	logInfo(String message) Log a message at the INFO level.
void	logWarn(String message) Log a message at the WARN level.
void	onMessageReceived(@NotNull net.dv8tion.jda.api.events.message.MessageReceivedEvent event)
void	onSlashCommandInteraction(@NotNull net.dv8tion.jda.api.events.interaction.command.SlashCommandInteractionEvent event)
ICommandEngine	setHelp(String help) Set which command is related to user help.
static void	setInstance(ICommandEngine newCommandConfig) Set a custom implementation of ICommandEngine.
ICommandEngine	setJda(net.dv8tion.jda.api.JDA jda) Set the JDA instance of the bot.
ICommandEngine	setLanguage(@NotNull Locale language) Sets the default language to be used by the bot.
ICommandEngine	setPrefix(@NotNull net.dv8tion.jda.api.entities.Guild guild, @NotNull String prefix) Sets a prefix for a specific guild.
ICommandEngine	setPrefix(@NotNull String prefix) Sets the default prefix for the bot.
ICommandEngine	setReactToMention(boolean reactToMention) Sets if the bot should react to a message starting by mentioning the bot @bot_name if sets to false, the bot will only react to prefix.
static void	setRepository(IRepository repository)

Methods inherited from class net.dv8tion.jda.api.hooks.ListenerAdapter

onApplicationCommandUpdatePrivileges, onApplicationUpdatePrivileges, onButtonInteraction, onChannelCreate, onChannelDelete, onChannelUpdateArchived, onChannelUpdateArchiveTimestamp, onChannelUpdateAutoArchiveDuration, onChannelUpdateBitrate, onChannelUpdateInvitable, onChannelUpdateLocked, onChannelUpdateName, onChannelUpdateNSFW, onChannelUpdateParent, onChannelUpdatePosition, onChannelUpdateRegion, onChannelUpdateSlowmode, onChannelUpdateTopic, onChannelUpdateType, onChannelUpdateUserLimit, onCommandAutoCompleteInteraction, onDisconnect, onEmojiAdded, onEmojiRemoved, onEmojiUpdateName, onEmojiUpdateRoles, onEvent, onException, onGatewayPing, onGenericAutoCompleteInteraction, onGenericChannel, onGenericChannelUpdate, onGenericCommandInteraction, onGenericComponentInteractionCreate, onGenericContextInteraction, onGenericEmoji, onGenericEmojiUpdate, onGenericEvent, onGenericGuild, onGenericGuildInvite, onGenericGuildMember, onGenericGuildMemberUpdate, onGenericGuildSticker, onGenericGuildStickerUpdate, onGenericGuildUpdate, onGenericGuildVoice, onGenericInteractionCreate, onGenericMessage, onGenericMessageReaction, onGenericPermissionOverride, onGenericPrivilegeUpdate, onGenericRole, onGenericRoleUpdate, onGenericSelfUpdate, onGenericStageInstance, onGenericStageInstanceUpdate, onGenericThread, onGenericThreadMember, onGenericUpdate, onGenericUser, onGenericUserPresence, onGuildAvailable, onGuildBan, onGuildInviteCreate, onGuildInviteDelete, onGuildJoin, onGuildLeave, onGuildMemberJoin, onGuildMemberRemove, onGuildMemberRoleAdd, onGuildMemberRoleRemove, onGuildMemberUpdate, onGuildMemberUpdateAvatar, onGuildMemberUpdateBoostTime, onGuildMemberUpdateNickname, onGuildMemberUpdatePending, onGuildMemberUpdateTimeOut, onGuildReady, onGuildStickerAdded, onGuildStickerRemoved, onGuildStickerUpdateAvailable, onGuildStickerUpdateDescription, onGuildStickerUpdateName, onGuildStickerUpdateTags, onGuildTimeout, onGuildUnavailable, onGuildUnban, onGuildUpdateAfkChannel, onGuildUpdateAfkTimeout, onGuildUpdateBanner, onGuildUpdateBoostCount, onGuildUpdateBoostTier, onGuildUpdateCommunityUpdatesChannel, onGuildUpdateDescription, onGuildUpdateExplicitContentLevel, onGuildUpdateFeatures, onGuildUpdateIcon, onGuildUpdateLocale, onGuildUpdateMaxMembers, onGuildUpdateMaxPresences, onGuildUpdateMFALevel, onGuildUpdateName, onGuildUpdateNotificationLevel, onGuildUpdateNSFWLevel, onGuildUpdateOwner, onGuildUpdateRulesChannel, onGuildUpdateSplash, onGuildUpdateSystemChannel, onGuildUpdateVanityCode, onGuildUpdateVerificationLevel, onGuildVoiceDeafen, onGuildVoiceGuildDeafen, onGuildVoiceGuildMute, onGuildVoiceJoin, onGuildVoiceLeave, onGuildVoiceMove, onGuildVoiceMute, onGuildVoiceRequestToSpeak, onGuildVoiceSelfDeafen, onGuildVoiceSelfMute, onGuildVoiceStream, onGuildVoiceSuppress, onGuildVoiceUpdate, onGuildVoiceVideo, onHttpRequest, onMessageBulkDelete, onMessageContextInteraction, onMessageDelete, onMessageEmbed, onMessageReactionAdd, onMessageReactionRemove, onMessageReactionRemoveAll, onMessageReactionRemoveEmoji, onMessageUpdate, onModalInteraction, onPermissionOverrideCreate, onPermissionOverrideDelete, onPermissionOverrideUpdate, onRawGateway, onReady, onReconnected, onResumed, onRoleCreate, onRoleDelete, onRoleUpdateColor, onRoleUpdateHoisted, onRoleUpdateIcon, onRoleUpdateMentionable, onRoleUpdateName, onRoleUpdatePermissions, onRoleUpdatePosition, onSelectMenuInteraction, onSelfUpdateAvatar, onSelfUpdateMFA, onSelfUpdateName, onSelfUpdateVerified, onShutdown, onStageInstanceCreate, onStageInstanceDelete, onStageInstanceUpdatePrivacyLevel, onStageInstanceUpdateTopic, onStatusChange, onThreadHidden, onThreadMemberJoin, onThreadMemberLeave, onThreadRevealed, onUnavailableGuildJoined, onUnavailableGuildLeave, onUserActivityEnd, onUserActivityStart, onUserContextInteraction, onUserTyping, onUserUpdateActivities, onUserUpdateActivityOrder, onUserUpdateAvatar, onUserUpdateDiscriminator, onUserUpdateFlags, onUserUpdateName, onUserUpdateOnlineStatus

Methods inherited from class java.lang.Object

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

Constructor Detail

CommandEngine

protected CommandEngine()

Creates an Instance of this ICommandEngine implementations. It will initialize a SQLite database if the Repository implementation is set as the IRepository implementation for the Engine (preset by default). You may change it by using setRepository(IRepository) method.

Method Detail

addCommandPackage

public static void addCommandPackage(String path)

Set the package name where the classes that extends ICommand are located in your project.

It will also look though sub-packaged.

Parameters:

path - the package name as described after the package keyword in your *.java files

See Also:

ICommand, Slash

getInstance

public static ICommandEngine getInstance()

Get the actual instance of ICommandEngine that is being used.

By default, CommandEngine implementation will be used.

Returns:

a reference of the active instance.

See Also:

ICommandEngine

setInstance

public static void setInstance(ICommandEngine newCommandConfig)

Set a custom implementation of ICommandEngine. It if highly recommended that to customize the engine, you extend from the default implementation CommandEngine instead of a raw version.

By default, CommandEngine implementation will be used.

Parameters:

newCommandConfig - custom implementation of ICommandEngine

includeBuildInUtils

public static void includeBuildInUtils()

Include pre-created commands, such has Help, Ping, Language and prefix.

Help: command to get simple and detailed information about commands.

Ping: Test to see if the bot is reachable.

Language: Set the language used in a guild.

prefix: Set the prefix the bot react to in a guild.

• NOTE: To include only some of these command, use ICommandEngine.addCommand(ICommand) instead.

See Also:

HelpCommand, PrefixCommand, LanguageCommand, PrefixCommand

logWarn

public void logWarn(String message)

Description copied from interface: ICommandEngine

Log a message at the WARN level.

Specified by:

logWarn in interface ICommandEngine

Parameters:

message - the message string to be logged

logDebug

public void logDebug(String message)

Description copied from interface: ICommandEngine

Log a message at the DEBUG level.

Specified by:

logDebug in interface ICommandEngine

Parameters:

message - the message string to be logged

logInfo

public void logInfo(String message)

Description copied from interface: ICommandEngine

Log a message at the INFO level.

Specified by:

logInfo in interface ICommandEngine

Parameters:

message - the message string to be logged

logError

public void logError(String message)

Description copied from interface: ICommandEngine

Log a message at the ERROR level.

Specified by:

logError in interface ICommandEngine

Parameters:

message - the message string to be logged

setHelp

public ICommandEngine setHelp(String help)

Description copied from interface: ICommandEngine

Set which command is related to user help. The command will be recommended if the user fails to use a command.

Specified by:

setHelp in interface ICommandEngine

Parameters:

help - command name

Returns:

A reference to this object.

See Also:

HelpCommand

getHelpCommand

public ICommand getHelpCommand()

Description copied from interface: ICommandEngine

Return the ICommand object of the help command.

Specified by:

getHelpCommand in interface ICommandEngine

Returns:

Help Command object.

loadCommands

public void loadCommands()

Description copied from interface: ICommandEngine

Registers ICommands from packages set into the engine. It also registers into JDA any ICommand object that also implements Slash.

Specified by:

loadCommands in interface ICommandEngine

isReactToMention

public boolean isReactToMention()

Description copied from interface: ICommandEngine

Get whether the bot should react to mention or not.

Specified by:

isReactToMention in interface ICommandEngine

Returns:

True if the bot should react to mention calls.

setReactToMention

public ICommandEngine setReactToMention(boolean reactToMention)

Description copied from interface: ICommandEngine

Sets if the bot should react to a message starting by mentioning the bot @bot_name if sets to false, the bot will only react to prefix.

Specified by:

setReactToMention in interface ICommandEngine

Parameters:

reactToMention - True if the bot should react to mention calls.

Returns:

A reference to this object.

See Also:

ICommandEngine.getPrefix(MessageReceivedEvent)

isReactToMention

public boolean isReactToMention(net.dv8tion.jda.api.events.Event event)

Description copied from interface: ICommandEngine

Checks if bot should react to mention calls (Messages that starts with @BOT_NAME).

Specified by:

isReactToMention in interface ICommandEngine

Parameters:

event - Discord event that triggered this function call.

Returns:

true if the bot should react to mention, false if only reacts to prefix.

getCommand

@Nullable
public @Nullable ICommand getCommand(@NotNull
                                                @NotNull String name)

Description copied from interface: ICommandEngine

Get an ICommand from the registered commands in the Engine.

Specified by:

getCommand in interface ICommandEngine

Parameters:

name - command's name.

Returns:

ICommand instance.

See Also:

ICommand

getCommandsByPartialMatch

@NotNull
public @NotNull List<ICommand> getCommandsByPartialMatch(String name)

Description copied from interface: ICommandEngine

Get a list of ICommand from the registered commands in the Engine.

Specified by:

getCommandsByPartialMatch in interface ICommandEngine

Parameters:

name - partial command's name.

Returns:

List of ICommand that match the partial search.

getCommandsByExactMatch

@NotNull
public @NotNull List<ICommand> getCommandsByExactMatch(String name)

Description copied from interface: ICommandEngine

Get a list of ICommand from the registered commands in the Engine.

Specified by:

getCommandsByExactMatch in interface ICommandEngine

Parameters:

name - expected command's name.

Returns:

List of ICommand that match the search.

getCommands

@Contract(value=" -> new")
 @NotNull
public final @NotNull @UnmodifiableView List<ICommand> getCommands()

Description copied from interface: ICommandEngine

Get a list of ICommand registered in the Engine.

Specified by:

getCommands in interface ICommandEngine

Returns:

list of ICommand instances loaded in the Engine.

addCommand

public ICommandEngine addCommand(@NotNull
                                 @NotNull ICommand command)
                          throws DuplicatedNameException,
                                 InvalidNameException

Description copied from interface: ICommandEngine

Registers an ICommand into the engine.

Specified by:

addCommand in interface ICommandEngine

Parameters:

command - The command to be registered.

Returns:

A reference to this object.

Throws:

DuplicatedNameException - Error if there's another command with the same name or alias registered.

InvalidNameException - Error if the command doesn't match the expected name.

addAlias

public ICommandEngine addAlias(@NotNull
                               @NotNull String name,
                               ICommand command)
                        throws DuplicatedNameException,
                               InvalidNameException

Description copied from interface: ICommandEngine

Add an alternative name to a command.

Specified by:

addAlias in interface ICommandEngine

Parameters:

name - alternative name.

command - Command to be called.

Returns:

A reference to this object.

Throws:

DuplicatedNameException - Thrown when there's already a commando with the same name/alias.

InvalidNameException - Thrown when the command's alias uses non-alphanumeric characters.

getPrefix

public String getPrefix(@NotNull
                        @NotNull net.dv8tion.jda.api.events.message.MessageReceivedEvent event)

Description copied from interface: ICommandEngine

By default, it gets the prefix configured on the bot. May be used to get a prefix based on the guild.

Specified by:

getPrefix in interface ICommandEngine

Parameters:

event - Message Received event that triggered this request.

Returns:

prefix string.

getPrefix

public String getPrefix(@NotNull
                        @NotNull net.dv8tion.jda.api.events.interaction.command.SlashCommandInteractionEvent event)

Description copied from interface: ICommandEngine

By default, it gets the prefix configured on the bot. May be used to get a prefix based on the guild.

Specified by:

getPrefix in interface ICommandEngine

Parameters:

event - Slash command that triggered this request.

Returns:

prefix string.

getPrefix

public String getPrefix(@NotNull
                        @NotNull net.dv8tion.jda.api.events.Event event)

Description copied from interface: ICommandEngine

By default, it gets the prefix configured on the bot. May be used to get a prefix based on the guild.

Specified by:

getPrefix in interface ICommandEngine

Parameters:

event - Event that triggered this request.

Returns:

prefix string.

getPrefix

public String getPrefix()

Description copied from interface: ICommandEngine

Gets the prefix configured on the bot.

Specified by:

getPrefix in interface ICommandEngine

Returns:

prefix string.

setPrefix

public ICommandEngine setPrefix(@NotNull
                                @NotNull String prefix)

Description copied from interface: ICommandEngine

Sets the default prefix for the bot.

Specified by:

setPrefix in interface ICommandEngine

Parameters:

prefix - prefix string.

Returns:

A reference to this object.

setPrefix

public ICommandEngine setPrefix(@NotNull
                                @NotNull net.dv8tion.jda.api.entities.Guild guild,
                                @NotNull
                                @NotNull String prefix)

Description copied from interface: ICommandEngine

Sets a prefix for a specific guild.

Specified by:

setPrefix in interface ICommandEngine

Parameters:

guild - Guild object.

prefix - prefix String.

Returns:

A reference to this object.

getLanguage

public Locale getLanguage()

Description copied from interface: ICommandEngine

Gets the default language to be used by the bot.

Specified by:

getLanguage in interface ICommandEngine

Returns:

current language.

See Also:

MultiLocaleResourceBundle.getSupportedLocale()

setLanguage

public ICommandEngine setLanguage(@NotNull
                                  @NotNull Locale language)

Description copied from interface: ICommandEngine

Sets the default language to be used by the bot.

Specified by:

setLanguage in interface ICommandEngine

Parameters:

language - Locale to use.

Returns:

A reference to this object.

See Also:

MultiLocaleResourceBundle.getSupportedLocale()

getLanguage

public Locale getLanguage(@Nullable
                          @Nullable net.dv8tion.jda.api.events.Event event)

Description copied from interface: ICommandEngine

By default, gets the default language to be used by the bot. May be used to get a Locale based on the Guild information.

Specified by:

getLanguage in interface ICommandEngine

Parameters:

event - Discord event that triggered this function call.

Returns:

current language.

See Also:

MultiLocaleResourceBundle.getSupportedLocale()

getString

@NotNull
public final @NotNull String getString(@NotNull
                                                 @NotNull String key)

Description copied from interface: ICommandEngine

Gets a text string in the configured language of the bot.

Specified by:

getString in interface ICommandEngine

Parameters:

key - String key in resourceBundle.

Returns:

String in the current language.

getString

@NotNull
public final @NotNull String getString(@NotNull
                                                 @NotNull String key,
                                                 @NotNull
                                                 @NotNull Locale locale)

Description copied from interface: ICommandEngine

Gets a text string in a specific language.

Specified by:

getString in interface ICommandEngine

Parameters:

key - String key in resourceBundle.

locale - expected language.

Returns:

String in the specific language.

getStringArray

@NotNull
public final @NotNull String[] getStringArray(@NotNull
                                                        @NotNull String key)

Description copied from interface: ICommandEngine

Gets a string Array in the configured language of the bot.

Specified by:

getStringArray in interface ICommandEngine

Parameters:

key - String key in resourceBundle.

Returns:

String in the current language.

getStringArray

@NotNull
public final @NotNull String[] getStringArray(@NotNull
                                                        @NotNull String key,
                                                        @NotNull
                                                        @NotNull Locale locale)

Description copied from interface: ICommandEngine

Gets a string Array in a specific language.

Specified by:

getStringArray in interface ICommandEngine

Parameters:

key - String key in resourceBundle.

locale - Expected language.

Returns:

String in the specific language.

getJda

public net.dv8tion.jda.api.JDA getJda()

Get the JDA object set within this Engine.

Returns:

JDA session object.

setJda

public ICommandEngine setJda(net.dv8tion.jda.api.JDA jda)

Set the JDA instance of the bot. Used to set Slash commands

Parameters:

jda - Built JDA object.

Returns:

A reference to this object.

getRepository

public IRepository getRepository()

Description copied from interface: ICommandEngine

Return the repository Controller.

Specified by:

getRepository in interface ICommandEngine

Returns:

IRepository object.

setRepository

public static void setRepository(IRepository repository)

onMessageReceived

public final void onMessageReceived(@NotNull
                                    @NotNull net.dv8tion.jda.api.events.message.MessageReceivedEvent event)

Overrides:

onMessageReceived in class net.dv8tion.jda.api.hooks.ListenerAdapter

onSlashCommandInteraction

public void onSlashCommandInteraction(@NotNull
                                      @NotNull net.dv8tion.jda.api.events.interaction.command.SlashCommandInteractionEvent event)

Overrides:

onSlashCommandInteraction in class net.dv8tion.jda.api.hooks.ListenerAdapter

createLight

@NotNull
public static @NotNull net.dv8tion.jda.api.JDA createLight(String token)
                                                              throws LoginException,
                                                                     IllegalArgumentException

Creates a JDA with low memory profile settings and with ICommandEngine preset.

Parameters:

token - The bot token to use.

Returns:

A JDA instance that has started the login process. It is unknown to whether or not loading has finished when this returns.

Throws:

LoginException - If the provided token is invalid.

IllegalArgumentException - If the provided token is empty or null. Or the provided intents/cache configuration is not possible.

See Also:

JDABuilder#createLight(String), JDABuilder.build()

createLight

@NotNull
public static @NotNull net.dv8tion.jda.api.JDA createLight(String token,
                                                                     Collection<net.dv8tion.jda.api.requests.GatewayIntent> intents)
                                                              throws LoginException,
                                                                     IllegalArgumentException

Creates a JDA with low memory profile settings and with ICommandEngine preset.

Parameters:

token - The bot token to use.

intents - The gateway intents to use

Returns:

A JDA instance that has started the login process. It is unknown to whether or not loading has finished when this returns.

Throws:

LoginException - If the provided token is invalid.

IllegalArgumentException - If the provided token is empty or null. Or the provided intents/cache configuration is not possible.

See Also:

JDABuilder.createLight(String, Collection), JDABuilder.build()

createLight

@NotNull
public static @NotNull net.dv8tion.jda.api.JDA createLight(String token,
                                                                     net.dv8tion.jda.api.requests.GatewayIntent intent,
                                                                     net.dv8tion.jda.api.requests.GatewayIntent... intents)
                                                              throws LoginException,
                                                                     IllegalArgumentException

Creates a JDA with low memory profile settings and with ICommandEngine preset.

Parameters:

token - The bot token to use

intent - The first intent to use

intents - The other gateway intents to use

Returns:

A JDA instance that has started the login process. It is unknown to whether or not loading has finished when this returns.

Throws:

LoginException - If the provided token is invalid.

IllegalArgumentException - If the provided token is empty or null. Or the provided intents/cache configuration is not possible.

See Also:

JDABuilder.createLight(String, GatewayIntent, GatewayIntent...), JDABuilder.build()

create

@NotNull
public static @NotNull net.dv8tion.jda.api.JDA create(String token,
                                                                @Nonnull
                                                                Collection<net.dv8tion.jda.api.requests.GatewayIntent> intents)
                                                         throws LoginException,
                                                                IllegalArgumentException

Creates a JDA with the predefined token.

Parameters:

token - The bot token to use

intents - The gateway intents to use

Returns:

A JDA instance that has started the login process. It is unknown to whether or not loading has finished when this returns.

Throws:

LoginException - If the provided token is invalid.

IllegalArgumentException - If the provided token is empty or null. Or the provided intents/cache configuration is not possible.

See Also:

JDABuilder.create(String, GatewayIntent, GatewayIntent...), JDABuilder.build()

create

@NotNull
public static @NotNull net.dv8tion.jda.api.JDA create(String token,
                                                                net.dv8tion.jda.api.requests.GatewayIntent intent,
                                                                net.dv8tion.jda.api.requests.GatewayIntent... intents)
                                                         throws LoginException,
                                                                IllegalArgumentException

Creates a JDA with the predefined token.

Parameters:

token - The bot token to use

intent - The first intent to use

intents - The other gateway intents to use

Returns:

A JDA instance that has started the login process. It is unknown to whether or not loading has finished when this returns.

Throws:

LoginException - If the provided token is invalid.

IllegalArgumentException - If the provided token is empty or null. Or the provided intents/cache configuration is not possible.

See Also:

JDABuilder.create(String, GatewayIntent, GatewayIntent...), JDABuilder.build()

createDefault

@NotNull
public static @NotNull net.dv8tion.jda.api.JDA createDefault(String token)
                                                                throws LoginException,
                                                                       IllegalArgumentException

Creates a JDABuilder with recommended default settings.

Parameters:

token - The bot token to use.

Returns:

A JDA instance that has started the login process. It is unknown to whether or not loading has finished when this returns.

Throws:

LoginException - If the provided token is invalid.

IllegalArgumentException - If the provided token is empty or null. Or the provided intents/cache configuration is not possible.

See Also:

JDABuilder.createDefault(String), JDABuilder.build()

createDefault

@NotNull
public static @NotNull net.dv8tion.jda.api.JDA createDefault(String token,
                                                                       Collection<net.dv8tion.jda.api.requests.GatewayIntent> intents)
                                                                throws LoginException,
                                                                       IllegalArgumentException

Creates a JDABuilder with recommended default settings.

Parameters:

token - The bot token to use.

intents - The gateway intents to use

Returns:

A JDA instance that has started the login process. It is unknown to whether or not loading has finished when this returns.

Throws:

LoginException - If the provided token is invalid.

IllegalArgumentException - If the provided token is empty or null. Or the provided intents/cache configuration is not possible.

See Also:

JDABuilder.createDefault(String, Collection), JDABuilder.build()

createDefault

@NotNull
public static @NotNull net.dv8tion.jda.api.JDA createDefault(String token,
                                                                       net.dv8tion.jda.api.requests.GatewayIntent intent,
                                                                       net.dv8tion.jda.api.requests.GatewayIntent... intents)
                                                                throws LoginException,
                                                                       IllegalArgumentException

Creates a JDABuilder with recommended default settings.

Parameters:

token - The bot token to use

intent - The first intent to use

intents - The other gateway intents to use

Returns:

A JDA instance that has started the login process. It is unknown to whether or not loading has finished when this returns.

Throws:

LoginException - If the provided token is invalid.

IllegalArgumentException - If the provided token is empty or null. Or the provided intents/cache configuration is not possible.

See Also:

JDABuilder.createDefault(String, GatewayIntent, GatewayIntent...), JDABuilder.build()

create

@NotNull
public static @NotNull net.dv8tion.jda.api.JDA create(@NotNull
                                                                @NotNull net.dv8tion.jda.api.JDABuilder builder)
                                                         throws LoginException,
                                                                IllegalArgumentException

This will build the JDA object.

Parameters:

builder - preset JDABuilder

Returns:

A JDA instance that has started the login process. It is unknown to whether or not loading has finished when this returns.

Throws:

LoginException - If the provided token is invalid.

IllegalArgumentException - If the provided token is empty or null. Or the provided intents/cache configuration is not possible.