Index
All Classes and Interfaces|All Packages|Serialized Form
A
- addButtonMappings(IdMapping<ButtonHandler>...) - Method in class xyz.dynxsty.dih4jda.DIH4JDA
- addContextCommands(ContextCommand<?>...) - Method in class xyz.dynxsty.dih4jda.DIH4JDA
-
Manually registers
ContextCommand
s. - addEntitySelectMenuMappings(IdMapping<EntitySelectMenuHandler>...) - Method in class xyz.dynxsty.dih4jda.DIH4JDA
-
Binds all
EntitySelectMenuHandler
s to their id, - addEventListener(Object...) - Method in class xyz.dynxsty.dih4jda.DIH4JDA
-
Allows to register
event listener
classes. - addModalMappings(IdMapping<ModalHandler>...) - Method in class xyz.dynxsty.dih4jda.DIH4JDA
-
Binds all
ModalHandler
s to their id. - addSlashCommands(SlashCommand...) - Method in class xyz.dynxsty.dih4jda.DIH4JDA
-
Manually registers
SlashCommand
s. - addStringSelectMenuMappings(IdMapping<StringSelectMenuHandler>...) - Method in class xyz.dynxsty.dih4jda.DIH4JDA
-
Binds all
StringSelectMenuHandler
s to their id. - addSubcommandGroups(SlashCommand.SubcommandGroup...) - Method in class xyz.dynxsty.dih4jda.interactions.commands.application.SlashCommand
-
Adds
SlashCommand.SubcommandGroup
s to thisSlashCommand
. - addSubcommands(SlashCommand.Subcommand...) - Method in class xyz.dynxsty.dih4jda.interactions.commands.application.SlashCommand
-
Adds
SlashCommand.Subcommand
s to thisSlashCommand
. - ApplicationCommand<E,
T> - Class in xyz.dynxsty.dih4jda.interactions.commands.application -
Model class for all Application Commands.
- ApplicationCommand() - Constructor for class xyz.dynxsty.dih4jda.interactions.commands.application.ApplicationCommand
-
Creates a default
ApplicationCommand
. - applyCooldown(long, Instant) - Method in class xyz.dynxsty.dih4jda.interactions.commands.RestrictedCommand
-
Manually applies a cooldown for the specified user id.
Command Cooldowns DO NOT persist between sessions! - ArrayUtil - Class in xyz.dynxsty.dih4jda.util
-
Utility class that contains some useful methods regarding arrays.
- asCommand() - Method in class xyz.dynxsty.dih4jda.interactions.commands.application.SlashCommand
-
Gets the corresponding
JDA entity
for this command. - asSubcommand() - Method in class xyz.dynxsty.dih4jda.interactions.commands.application.SlashCommand.Subcommand
-
Gets the corresponding
JDA-entity
for this subcommand. - AutoCompletable - Interface in xyz.dynxsty.dih4jda.interactions
-
Interface for commands that handle the
CommandAutoCompleteInteractionEvent
. - AutoCompleteExceptionEvent - Class in xyz.dynxsty.dih4jda.events
-
An event that gets fired when an exception gets raised while handling an autocomplete interaction.
- AutoCompleteExceptionEvent(DIH4JDA, CommandAutoCompleteInteraction, Throwable) - Constructor for class xyz.dynxsty.dih4jda.events.AutoCompleteExceptionEvent
-
Creates an exception event object.
- AutoCompleteUtils - Class in xyz.dynxsty.dih4jda.util
-
Utility class that contains some useful methods regarding the AutoComplete system.
B
- BaseApplicationCommand<E,
T> - Class in xyz.dynxsty.dih4jda.interactions.commands.application -
An extension of
ApplicationCommand
which contains aRegistrationType
andBaseApplicationCommand.queueableGuilds
. - BaseApplicationCommand() - Constructor for class xyz.dynxsty.dih4jda.interactions.commands.application.BaseApplicationCommand
-
Creates a default
BaseApplicationCommand
. - build() - Method in class xyz.dynxsty.dih4jda.DIH4JDABuilder
-
Returns a validated
DIH4JDA
instance. - build(String, Object...) - Static method in class xyz.dynxsty.dih4jda.util.ComponentIdBuilder
-
Builds a component-id using the (set) separator and the given identifier and arguments.
- buildCommandPath(String...) - Static method in class xyz.dynxsty.dih4jda.util.CommandUtils
-
Used to create one command name out of the SlashCommand, SlashSubCommandGroup and SlashSubCommand
- BUTTON_NOT_FOUND - Enum constant in enum class xyz.dynxsty.dih4jda.DIH4JDALogger.Type
-
If a button could not be found.
- ButtonHandler - Interface in xyz.dynxsty.dih4jda.interactions.components
-
An interface that contains the method that should be executed when a user interacts with a
Button
.
C
- checkEmptyConstructor(Class<?>) - Static method in class xyz.dynxsty.dih4jda.util.Checks
-
Checks if the given class has an empty constructor.
- checkImplementation(Class<?>, Class<?>) - Static method in class xyz.dynxsty.dih4jda.util.Checks
-
Checks if the given base class implements a certain class.
- Checks - Class in xyz.dynxsty.dih4jda.util
-
Utility class for checking certain conditions.
- ClasspathHelper - Class in xyz.dynxsty.dih4jda.util
-
Utility class for finding classes on the classpath.
- ClassUtils - Class in xyz.dynxsty.dih4jda.util
-
Utility class for working with classes.
- ClassWalker - Class in xyz.dynxsty.dih4jda.util
-
A class that provides you with the ability to get all classes inside a specific package.
- ClassWalker(String) - Constructor for class xyz.dynxsty.dih4jda.util.ClassWalker
-
Creates a new instance that allows you to perform reflective operations for the defined package.
- CommandCooldownEvent - Class in xyz.dynxsty.dih4jda.events
-
An event that gets fired when the user, which invoked the command, is not yet able to use this command due to a specified
Command Cooldown
Command Cooldowns DO NOT persist between sessions! - CommandCooldownEvent(DIH4JDA, CommandInteraction, RestrictedCommand.Cooldown) - Constructor for class xyz.dynxsty.dih4jda.events.CommandCooldownEvent
-
Creates a new instance of this event.
- Command Cooldowns DO NOT persist between sessions! - Search tag in class xyz.dynxsty.dih4jda.interactions.commands.RestrictedCommand.Cooldown
- Section
- CommandExceptionEvent - Class in xyz.dynxsty.dih4jda.events
-
An event that gets fired when an exception gets raised while executing any command.
- CommandExceptionEvent(DIH4JDA, CommandInteraction, Throwable) - Constructor for class xyz.dynxsty.dih4jda.events.CommandExceptionEvent
-
Creates a new instance of this event.
- CommandNotRegisteredException - Exception Class in xyz.dynxsty.dih4jda.exceptions
-
An exception that is thrown if a command is not registered by the
DIH4JDA
instance. - CommandNotRegisteredException(String) - Constructor for exception class xyz.dynxsty.dih4jda.exceptions.CommandNotRegisteredException
-
Creates a new instance of this exception.
- COMMANDS_QUEUED - Enum constant in enum class xyz.dynxsty.dih4jda.DIH4JDALogger.Type
-
Something related to queueing commands.
- CommandUtils - Class in xyz.dynxsty.dih4jda.util
-
A utility class that contains some useful methods regarding command data.
- compareContextCommands(Command, ContextCommand<?>) - Static method in class xyz.dynxsty.dih4jda.util.CommandUtils
-
Takes a
Command
object that wraps a context-command and compares it to aContextCommand
object. - compareSlashCommands(Command, SlashCommand) - Static method in class xyz.dynxsty.dih4jda.util.CommandUtils
-
Takes a
Command
object that wraps aSlashCommandData
object and compares it to aSlashCommand
object. - ComponentExceptionEvent - Class in xyz.dynxsty.dih4jda.events
-
An event that gets fired when an exception gets raised while interacting with a message component.
- ComponentExceptionEvent(DIH4JDA, ComponentInteraction, Throwable) - Constructor for class xyz.dynxsty.dih4jda.events.ComponentExceptionEvent
-
Creates a new instance of this event.
- ComponentIdBuilder - Class in xyz.dynxsty.dih4jda.util
-
Utility class that allows for easy and consistent Component-ID building.
- contains(Object[], Object) - Static method in class xyz.dynxsty.dih4jda.util.ArrayUtil
-
Checks if the specified object is inside the specified array.
- CONTEXT_COMMAND_REGISTERED - Enum constant in enum class xyz.dynxsty.dih4jda.DIH4JDALogger.Type
-
Use this if a context command was registered.
- CONTEXT_COMMAND_SKIPPED - Enum constant in enum class xyz.dynxsty.dih4jda.DIH4JDALogger.Type
-
Use this if a context command was skipped.
For example if the command should not be registered on a specific guild. - ContextCommand<E> - Class in xyz.dynxsty.dih4jda.interactions.commands.application
-
Model class which represents a single Context Command.
- ContextCommand.Message - Class in xyz.dynxsty.dih4jda.interactions.commands.application
-
Creates a new message-context command.
- ContextCommand.User - Class in xyz.dynxsty.dih4jda.interactions.commands.application
-
Creates a new user-context command.
D
- debug(String, Object...) - Static method in class xyz.dynxsty.dih4jda.DIH4JDALogger
-
Logs a message with the specified
Level.DEBUG
. - debug(DIH4JDALogger.Type, String, Object...) - Static method in class xyz.dynxsty.dih4jda.DIH4JDALogger
-
Logs a message with the specified
DIH4JDALogger.Type
andLevel.DEBUG
. - DEBUG - Enum constant in enum class xyz.dynxsty.dih4jda.DIH4JDALogger.Type
-
Use this if you want to debug something/debug information.
- DIH4JDA - Class in xyz.dynxsty.dih4jda
-
Getting Started
- DIH4JDA(DIH4JDAConfig) - Constructor for class xyz.dynxsty.dih4jda.DIH4JDA
-
Constructs a new DIH4JDA instance using the specified
DIH4JDAConfig
. - DIH4JDABuilder - Class in xyz.dynxsty.dih4jda
-
Builder class used to instantiate a new
DIH4JDA
instance. - DIH4JDAConfig - Class in xyz.dynxsty.dih4jda.config
-
Simple data class which represents
DIH4JDA
's configuration. - DIH4JDAConfig() - Constructor for class xyz.dynxsty.dih4jda.config.DIH4JDAConfig
-
Creates a default instance.
- DIH4JDAEvent<I> - Class in xyz.dynxsty.dih4jda.events
-
A generic event, which holds the events' name, the
DIH4JDA
instance and thefollow-up interaction
. - DIH4JDAEventListener - Interface in xyz.dynxsty.dih4jda.events
-
An interface containing all events and their method that DIH4JDA can fire.
- DIH4JDAException - Exception Class in xyz.dynxsty.dih4jda.exceptions
-
The top-level
Exception
that is thrown for everything regarding DIH4JDA. - DIH4JDAException(String) - Constructor for exception class xyz.dynxsty.dih4jda.exceptions.DIH4JDAException
-
Creates a new instance of this exception.
- DIH4JDAException(Throwable) - Constructor for exception class xyz.dynxsty.dih4jda.exceptions.DIH4JDAException
-
Creates a new instance of this exception if it was caused by another
Throwable
. - DIH4JDALogger - Class in xyz.dynxsty.dih4jda
-
This handler's own Logging System.
- DIH4JDALogger() - Constructor for class xyz.dynxsty.dih4jda.DIH4JDALogger
-
Creates a new, default instance of the
DIH4JDALogger
. - DIH4JDALogger.Type - Enum Class in xyz.dynxsty.dih4jda
-
All types that are supported by the
DIH4JDALogger
. - DIH4JDAReflectionException - Exception Class in xyz.dynxsty.dih4jda.exceptions
-
Exception that is thrown for everything that is related to reflection inside DIH4JDA.
- DIH4JDAReflectionException(Throwable) - Constructor for exception class xyz.dynxsty.dih4jda.exceptions.DIH4JDAReflectionException
-
Creates a new instance of the
DIH4JDAReflectionException
. - DIH4JDAThrowableEvent<I> - Class in xyz.dynxsty.dih4jda.events
-
Further abstraction of the
DIH4JDAEvent
class, which featuresThrowable
s. - disableAutomaticCommandRegistration() - Method in class xyz.dynxsty.dih4jda.DIH4JDABuilder
-
Whether DIH4JDA should automatically register all interactions on each onReady event.
- disableLogging(DIH4JDALogger.Type...) - Method in class xyz.dynxsty.dih4jda.DIH4JDABuilder
-
Deprecated, for removal: This API element is subject to removal in a future version.
- disableLogging(DIH4JDALogger.Type...) - Static method in class xyz.dynxsty.dih4jda.DIH4JDALogger
-
Sets the types of logging that should be disabled.
- disableStacktracePrinting() - Method in class xyz.dynxsty.dih4jda.DIH4JDABuilder
-
Disables stacktrace-printing for all raised exceptions that were not caught by an
DIH4JDAEventListener
. - disableUnknownCommandDeletion() - Method in class xyz.dynxsty.dih4jda.DIH4JDABuilder
-
Disables the deletion of unknown/unused commands while using SmartQueue.
- disableUnregisteredCommandException() - Method in class xyz.dynxsty.dih4jda.DIH4JDABuilder
-
Disables the
CommandNotRegisteredException
getting thrown for unregistered commands. - doesImplement(Class<?>, Class<?>) - Static method in class xyz.dynxsty.dih4jda.util.ClassUtils
-
Checks if the given base class implements a certain class.
E
- EntitySelectMenuHandler - Interface in xyz.dynxsty.dih4jda.interactions.components
-
An interface that contains the method that should be executed when a user interacts with a
EntitySelectMenu
. - equals(DataObject, DataObject) - Static method in class xyz.dynxsty.dih4jda.util.CommandUtils
-
Compares two
DataObject
. - error(String, Object...) - Static method in class xyz.dynxsty.dih4jda.DIH4JDALogger
-
Logs a message with the specified
Level.ERROR
. - error(DIH4JDALogger.Type, String, Object...) - Static method in class xyz.dynxsty.dih4jda.DIH4JDALogger
-
Logs a message with the specified
DIH4JDALogger.Type
andLevel.ERROR
. - ERROR - Enum constant in enum class xyz.dynxsty.dih4jda.DIH4JDALogger.Type
-
Use this if an error occurred.
- EVENT_MISSING_HANDLER - Enum constant in enum class xyz.dynxsty.dih4jda.DIH4JDALogger.Type
-
If an implementation for
DIH4JDAEventListener
is missing. - ExecutableCommand<E> - Interface in xyz.dynxsty.dih4jda.interactions.commands
-
Represents an executable command.
- execute(E) - Method in interface xyz.dynxsty.dih4jda.interactions.commands.ExecutableCommand
-
The method that gets called once the command gets executed.
- execute(SlashCommandInteractionEvent) - Method in class xyz.dynxsty.dih4jda.interactions.commands.application.SlashCommand
F
- filterByType(Pair<Set<SlashCommand>, Set<ContextCommand<?>>>, RegistrationType) - Static method in class xyz.dynxsty.dih4jda.util.CommandUtils
-
Removes all elements of the provided
Pair
which don't match the givenRegistrationType
. - filterChoices(String, List<Command.Choice>) - Static method in class xyz.dynxsty.dih4jda.util.AutoCompleteUtils
-
Filters all AutoComplete choices based on the user's current input.
- filterChoices(String, Command.Choice...) - Static method in class xyz.dynxsty.dih4jda.util.AutoCompleteUtils
-
Filters all AutoComplete choices based on the user's current input.
- filterChoices(CommandAutoCompleteInteractionEvent, List<Command.Choice>) - Static method in class xyz.dynxsty.dih4jda.util.AutoCompleteUtils
-
Filters all AutoComplete choices based on the user's current input.
- filterChoices(CommandAutoCompleteInteractionEvent, Command.Choice...) - Static method in class xyz.dynxsty.dih4jda.util.AutoCompleteUtils
-
Filters all AutoComplete choices based on the user's current input.
- fire(DIH4JDAEvent<I>) - Static method in class xyz.dynxsty.dih4jda.events.DIH4JDAEvent
-
Fires an event from the
DIH4JDAEventListener
. - forPackage(String) - Static method in class xyz.dynxsty.dih4jda.util.ClasspathHelper
-
Gets all
URL
s in the specified package.
G
- getAllClasses() - Method in class xyz.dynxsty.dih4jda.util.ClassWalker
-
Gets all classes inside the given package and sub packages.
- getAsMention(SlashCommand) - Static method in class xyz.dynxsty.dih4jda.util.CommandUtils
-
Gets the mention from a
SlashCommand
. - getAsMention(SlashCommand.Subcommand) - Static method in class xyz.dynxsty.dih4jda.util.CommandUtils
-
Gets the mention from a
SlashCommand.Subcommand
. - getClassLoaderForClass(Class<?>) - Static method in class xyz.dynxsty.dih4jda.util.IoUtils
-
Tries to get the classloader for the given class.
- getCommandCooldown() - Method in class xyz.dynxsty.dih4jda.interactions.commands.RestrictedCommand
-
Returns the
Duration
the user has to wait between command executions. - getCommandData() - Method in class xyz.dynxsty.dih4jda.interactions.commands.application.ApplicationCommand
-
Gets the command data that was previously set with
ApplicationCommand.setCommandData(Object)
- getData() - Method in class xyz.dynxsty.dih4jda.interactions.commands.application.SlashCommand.SubcommandGroup
-
Gets the
SubcommandGroupData
. - getHandler() - Method in class xyz.dynxsty.dih4jda.interactions.components.IdMapping
-
Gets you the handler that was linked with the
IdMapping.getIds()
. - getIds() - Method in class xyz.dynxsty.dih4jda.interactions.components.IdMapping
-
Gets you the ids that linked themselves with their
IdMapping.getHandler()
. - getInstance(Class<?>) - Static method in class xyz.dynxsty.dih4jda.util.ClassUtils
-
Creates a new Instance of the given class.
- getJDA() - Method in class xyz.dynxsty.dih4jda.DIH4JDA
-
Gets the
JDA
instanceDIH4JDA
uses. - getLastUse() - Method in class xyz.dynxsty.dih4jda.interactions.commands.RestrictedCommand.Cooldown
-
Gets you the
Instant
the user has used theRestrictedCommand
the last time. - getNames(Set<ContextCommand<?>>, Set<SlashCommand>) - Static method in class xyz.dynxsty.dih4jda.util.CommandUtils
-
Builds a formatted string out of the given sets of CommandData.
- getNextUse() - Method in class xyz.dynxsty.dih4jda.interactions.commands.RestrictedCommand.Cooldown
-
Gets you the
Instant
of when a user can use theRestrictedCommand
the next time. - getParent() - Method in class xyz.dynxsty.dih4jda.interactions.commands.application.SlashCommand.Subcommand
-
Gets the
parent
for this subcommand. - getQueueableGuilds() - Method in class xyz.dynxsty.dih4jda.interactions.commands.application.BaseApplicationCommand
-
Gets all the guilds that the command should be registered/queued in.
- getRegistrationType() - Method in class xyz.dynxsty.dih4jda.interactions.commands.application.BaseApplicationCommand
-
The
RegistrationType
the command got assigned. - getRequiredGuilds() - Method in class xyz.dynxsty.dih4jda.interactions.commands.RestrictedCommand
-
The required guilds the command can be executed in.
- getRequiredPermissions() - Method in class xyz.dynxsty.dih4jda.interactions.commands.RestrictedCommand
-
The required
Permission
theUser
needs to execute the command. - getRequiredRoles() - Method in class xyz.dynxsty.dih4jda.interactions.commands.RestrictedCommand
-
The
Role
s that are required to execute the command. - getRequiredUsers() - Method in class xyz.dynxsty.dih4jda.interactions.commands.RestrictedCommand
-
The user ids from the
User
that are allowed to execute the command. - getRetrievedCommands() - Static method in class xyz.dynxsty.dih4jda.InteractionHandler
-
Returns an unmodifiable Map of all retrieved (and/or queued) commands, where the key is the commands' name and the value the
Command
instance itself. - getSubcommandGroups() - Method in class xyz.dynxsty.dih4jda.interactions.commands.application.SlashCommand
-
Returns an array of all
SlashCommand.SubcommandGroup
s this command contains. - getSubcommands() - Method in class xyz.dynxsty.dih4jda.interactions.commands.application.SlashCommand
-
Returns an array of all
SlashCommand.Subcommand
s this command contains. - getSubcommands() - Method in class xyz.dynxsty.dih4jda.interactions.commands.application.SlashCommand.SubcommandGroup
-
Gets the
SlashCommand.Subcommand
. - getSubTypesOf(Class<T>) - Method in class xyz.dynxsty.dih4jda.util.ClassWalker
-
Gets all classes in the given package and sub packages which extend the specified class.
- GLOBAL - Enum constant in enum class xyz.dynxsty.dih4jda.interactions.commands.application.RegistrationType
-
Marks a command as a global command.
- GUILD - Enum constant in enum class xyz.dynxsty.dih4jda.interactions.commands.application.RegistrationType
-
Marks a command as a guild only command.
H
- handleAutoComplete(CommandAutoCompleteInteractionEvent, AutoCompleteQuery) - Method in interface xyz.dynxsty.dih4jda.interactions.AutoCompletable
-
Method that must be overridden for all commands that handle auto-complete interactions.
- handleButton(ButtonInteractionEvent, Button) - Method in interface xyz.dynxsty.dih4jda.interactions.components.ButtonHandler
-
Method that must be overridden for all commands that handle button interactions.
- handleEntitySelectMenu(EntitySelectInteractionEvent, List<IMentionable>) - Method in interface xyz.dynxsty.dih4jda.interactions.components.EntitySelectMenuHandler
-
Method that must be overridden for all classes that handle
EntitySelectInteraction
All select menus that match the identifier will execute this class's implementation of the handleEntitySelectMenu method. - handleModal(ModalInteractionEvent, List<ModalMapping>) - Method in interface xyz.dynxsty.dih4jda.interactions.components.ModalHandler
-
Method that must be overridden for all Commands that handle Modal Interactions.
- handleStringSelectMenu(StringSelectInteractionEvent, List<String>) - Method in interface xyz.dynxsty.dih4jda.interactions.components.StringSelectMenuHandler
-
Method that must be overridden for all classes that handle
StringSelectInteraction
. - hasCooldown(long) - Method in class xyz.dynxsty.dih4jda.interactions.commands.RestrictedCommand
-
Returns whether the command can be used by the specified user.
Command Cooldowns DO NOT persist between sessions!
I
- IdMapping<T> - Class in xyz.dynxsty.dih4jda.interactions.components
- info(String, Object...) - Static method in class xyz.dynxsty.dih4jda.DIH4JDALogger
-
Logs a message with the specified
Level.INFO
. - info(DIH4JDALogger.Type, String, Object...) - Static method in class xyz.dynxsty.dih4jda.DIH4JDALogger
-
Logs a message with the specified
DIH4JDALogger.Type
andLevel.INFO
. - INFO - Enum constant in enum class xyz.dynxsty.dih4jda.DIH4JDALogger.Type
-
Use this if you want to inform the user.
- InsufficientPermissionsEvent - Class in xyz.dynxsty.dih4jda.events
-
An event that gets fired when the user, which invoked the command, does NOT have one of the required permissions.
- InsufficientPermissionsEvent(DIH4JDA, CommandInteraction, Set<Permission>) - Constructor for class xyz.dynxsty.dih4jda.events.InsufficientPermissionsEvent
-
Creates an instance of the
InsufficientPermissionsEvent
. - InteractionHandler - Class in xyz.dynxsty.dih4jda
-
Handler class, that finds, registers and handles all Application Commands and their components.
- InvalidGuildEvent - Class in xyz.dynxsty.dih4jda.events
-
An event that gets fired when the command is NOT executed in one of the required guild.
- InvalidGuildEvent(DIH4JDA, CommandInteraction, Set<Long>) - Constructor for class xyz.dynxsty.dih4jda.events.InvalidGuildEvent
-
Creates a new instance
InvalidGuildEvent
. - InvalidPackageException - Exception Class in xyz.dynxsty.dih4jda.exceptions
-
Exception that is thrown for an invalid command package configuration.
- InvalidPackageException(String) - Constructor for exception class xyz.dynxsty.dih4jda.exceptions.InvalidPackageException
-
Creates a new
InvalidPackageException
. - InvalidRoleEvent - Class in xyz.dynxsty.dih4jda.events
-
An event that gets fired when the user, which invoked the command, does NOT have the required roles to use this command.
- InvalidRoleEvent(DIH4JDA, CommandInteraction, Set<Long>) - Constructor for class xyz.dynxsty.dih4jda.events.InvalidRoleEvent
-
Create a new instance of the
InvalidRoleEvent
. - InvalidUserEvent - Class in xyz.dynxsty.dih4jda.events
-
An event that gets fired when the user, which invoked the command, is NOT allowed to use this command.
- InvalidUserEvent(DIH4JDA, CommandInteraction, Set<Long>) - Constructor for class xyz.dynxsty.dih4jda.events.InvalidUserEvent
-
Creates a new instance of the
InvalidUserEvent
. - IoUtils - Class in xyz.dynxsty.dih4jda.util
-
Utility class that contains some useful methods regarding IO.
M
- Message() - Constructor for class xyz.dynxsty.dih4jda.interactions.commands.application.ContextCommand.Message
-
Creates a new, default message command.
- MODAL_NOT_FOUND - Enum constant in enum class xyz.dynxsty.dih4jda.DIH4JDALogger.Type
-
If a modal could not be found.
- ModalExceptionEvent - Class in xyz.dynxsty.dih4jda.events
-
An event that gets fired when an exception gets raised while handling a modal interaction.
- ModalExceptionEvent(DIH4JDA, ModalInteraction, Throwable) - Constructor for class xyz.dynxsty.dih4jda.events.ModalExceptionEvent
-
Creates a new
ModalExceptionEvent
. - ModalHandler - Interface in xyz.dynxsty.dih4jda.interactions.components
-
An interface that contains the method that should be executed when a user interacts with a
Modal
.
N
- notNull(Object, String) - Static method in class xyz.dynxsty.dih4jda.util.Checks
-
Throws an
IllegalArgumentException
if the givenObject
is null.
O
- of(SubcommandGroupData, SlashCommand.Subcommand...) - Static method in class xyz.dynxsty.dih4jda.interactions.commands.application.SlashCommand.SubcommandGroup
-
Creates a new instance of the
SlashCommand.SubcommandGroup
class. - of(T, String...) - Static method in class xyz.dynxsty.dih4jda.interactions.components.IdMapping
-
Creates a new
IdMapping
with the specified handler and ids. - onAutoCompleteException(AutoCompleteExceptionEvent) - Method in interface xyz.dynxsty.dih4jda.events.DIH4JDAEventListener
-
An event that gets fired when an exception gets raised while handling an autocomplete interaction.
- onButtonInteraction(ButtonInteractionEvent) - Method in class xyz.dynxsty.dih4jda.InteractionHandler
-
Fired if Discord reports a
ButtonInteractionEvent
. - onCommandAutoCompleteInteraction(CommandAutoCompleteInteractionEvent) - Method in class xyz.dynxsty.dih4jda.InteractionHandler
-
Fired if Discord reports a
CommandAutoCompleteInteractionEvent
. - onCommandCooldown(CommandCooldownEvent) - Method in interface xyz.dynxsty.dih4jda.events.DIH4JDAEventListener
-
An event that gets fired when the user, which invoked the command, is not yet able to use this command due to a specified
Command Cooldown
Command Cooldowns DO NOT persist between sessions! - onCommandException(CommandExceptionEvent) - Method in interface xyz.dynxsty.dih4jda.events.DIH4JDAEventListener
-
An event that gets fired when an exception gets raised while executing any command.
- onComponentException(ComponentExceptionEvent) - Method in interface xyz.dynxsty.dih4jda.events.DIH4JDAEventListener
-
An event that gets fired when an exception gets raised while interacting with a message component.
- onEntitySelectInteraction(EntitySelectInteractionEvent) - Method in class xyz.dynxsty.dih4jda.InteractionHandler
- onInsufficientPermissions(InsufficientPermissionsEvent) - Method in interface xyz.dynxsty.dih4jda.events.DIH4JDAEventListener
-
An event that gets fired when the user, which invoked the command, does NOT have one of the required permissions.
- onInvalidGuild(InvalidGuildEvent) - Method in interface xyz.dynxsty.dih4jda.events.DIH4JDAEventListener
-
An event that gets fired when the command is NOT executed in one of the required guild.
- onInvalidRole(InvalidRoleEvent) - Method in interface xyz.dynxsty.dih4jda.events.DIH4JDAEventListener
-
An event that gets fired when the user, which invoked the command, does NOT have the required roles to use this command.
- onInvalidUser(InvalidUserEvent) - Method in interface xyz.dynxsty.dih4jda.events.DIH4JDAEventListener
-
An event that gets fired when the user, which invoked the command, is NOT allowed to use this command.
- onMessageContextInteraction(MessageContextInteractionEvent) - Method in class xyz.dynxsty.dih4jda.InteractionHandler
-
Fired if Discord reports a
MessageContextInteractionEvent
. - onModalException(ModalExceptionEvent) - Method in interface xyz.dynxsty.dih4jda.events.DIH4JDAEventListener
-
An event that gets fired when an exception gets raised while handling a modal interaction.
- onModalInteraction(ModalInteractionEvent) - Method in class xyz.dynxsty.dih4jda.InteractionHandler
-
Fired if Discord reports a
ModalInteractionEvent
. - onReady(ReadyEvent) - Method in class xyz.dynxsty.dih4jda.DIH4JDA
-
Ran once the
JDA
instance fires theReadyEvent
. - onSlashCommandInteraction(SlashCommandInteractionEvent) - Method in class xyz.dynxsty.dih4jda.InteractionHandler
-
Fired if Discord reports a
SlashCommandInteractionEvent
. - onStringSelectInteraction(StringSelectInteractionEvent) - Method in class xyz.dynxsty.dih4jda.InteractionHandler
-
Fired if Discord reports a
StringSelectInteractionEvent
. - onUserContextInteraction(UserContextInteractionEvent) - Method in class xyz.dynxsty.dih4jda.InteractionHandler
-
Fired if Discord reports a
UserContextInteractionEvent
.
P
- Pair<F,
S> - Class in xyz.dynxsty.dih4jda.util -
A Pair of two elements.
- Pair(F, S) - Constructor for class xyz.dynxsty.dih4jda.util.Pair
R
- registerInteractions() - Method in class xyz.dynxsty.dih4jda.DIH4JDA
-
Registers all Interactions and replaces the old ones.
- registerInteractions() - Method in class xyz.dynxsty.dih4jda.InteractionHandler
-
Registers all interactions.
- RegistrationType - Enum Class in xyz.dynxsty.dih4jda.interactions.commands.application
-
Whether the command should be queued as a global- or as a guild command.
- RestrictedCommand - Class in xyz.dynxsty.dih4jda.interactions.commands
-
Represents a basic command.
- RestrictedCommand() - Constructor for class xyz.dynxsty.dih4jda.interactions.commands.RestrictedCommand
-
Creates a default instance.
- RestrictedCommand.Cooldown - Class in xyz.dynxsty.dih4jda.interactions.commands
-
Model class which represents a single command cooldown.
- retrieveCooldown(long) - Method in class xyz.dynxsty.dih4jda.interactions.commands.RestrictedCommand
-
Gets the
time
the specified user can execute this command again.
S
- SELECT_MENU_NOT_FOUND - Enum constant in enum class xyz.dynxsty.dih4jda.DIH4JDALogger.Type
-
If a select menu could not be found.
- setCommandCooldown(Duration) - Method in class xyz.dynxsty.dih4jda.interactions.commands.RestrictedCommand
-
Allows to set a cooldown for this command.
- setCommandData(T) - Method in class xyz.dynxsty.dih4jda.interactions.commands.application.ApplicationCommand
-
Sets this commands'
CommandData
. - setCommandPackages(String...) - Method in class xyz.dynxsty.dih4jda.DIH4JDABuilder
-
Allows to specify package(s) that house all
ApplicationCommand
s classes. - setDefaultRegistrationType(RegistrationType) - Static method in class xyz.dynxsty.dih4jda.DIH4JDA
-
Sets the default
RegistrationType
for allApplication Commands
. - setExecutor(Executor) - Method in class xyz.dynxsty.dih4jda.DIH4JDABuilder
-
Allows to specify a custom
Executor
that will be used to execute all commands and events.
If you have access to Java 21 it's recommended to use theExecutors.newVirtualThreadPerTaskExecutor()
.
Standard:ForkJoinPool.commonPool()
- setGlobalSmartQueue(boolean) - Method in class xyz.dynxsty.dih4jda.DIH4JDABuilder
-
NOT RECOMMENDED (unless there are some bugs)
This will disable the GLOBAL Smart Queueing functionality. - setGuildSmartQueue(boolean) - Method in class xyz.dynxsty.dih4jda.DIH4JDABuilder
-
This will disable the GUILD Smart Queueing functionality.
- setJDA(JDA) - Static method in class xyz.dynxsty.dih4jda.DIH4JDABuilder
-
Sets the
JDA
instance the handler will be used for. - setQueueableGuilds(Long...) - Method in class xyz.dynxsty.dih4jda.interactions.commands.application.BaseApplicationCommand
-
Limits this command to only be queued in the specified guilds.
- setRegistrationType(RegistrationType) - Method in class xyz.dynxsty.dih4jda.interactions.commands.application.BaseApplicationCommand
-
How the command should be queued.
- setRequiredGuilds(Long...) - Method in class xyz.dynxsty.dih4jda.interactions.commands.RestrictedCommand
-
Allows to require a set of
Guild
s only in which the command can get executed. - setRequiredPermissions(Permission...) - Method in class xyz.dynxsty.dih4jda.interactions.commands.RestrictedCommand
-
Allows to require a set of
Permission
s which are needed to execute the corresponding command. - setRequiredRoles(Long...) - Method in class xyz.dynxsty.dih4jda.interactions.commands.RestrictedCommand
-
Allows to require a set of
Long
s (role Ids) which are able to execute the corresponding command. - setRequiredUsers(Long...) - Method in class xyz.dynxsty.dih4jda.interactions.commands.RestrictedCommand
-
Allows to require a set of
Long
s (user Ids) which are able to execute the corresponding command. - shouldBeRegistered(Guild, BaseApplicationCommand<?, ?>) - Static method in class xyz.dynxsty.dih4jda.util.CommandUtils
-
Checks if a command should be registered on a specific guild.
- SLASH_COMMAND_REGISTERED - Enum constant in enum class xyz.dynxsty.dih4jda.DIH4JDALogger.Type
-
Use this if a slash command was registered.
- SLASH_COMMAND_SKIPPED - Enum constant in enum class xyz.dynxsty.dih4jda.DIH4JDALogger.Type
-
Use this if a slash command was skipped.
For example if the command should not be registered on a specific guild. - SlashCommand - Class in xyz.dynxsty.dih4jda.interactions.commands.application
-
Represents a single Slash Command.
- SlashCommand.Subcommand - Class in xyz.dynxsty.dih4jda.interactions.commands.application
-
Model class which represents a single Subcommand.
- SlashCommand.SubcommandGroup - Class in xyz.dynxsty.dih4jda.interactions.commands.application
-
Model class which represents a single subcommand group.
- SMART_QUEUE - Enum constant in enum class xyz.dynxsty.dih4jda.DIH4JDALogger.Type
-
Used together with
SmartQueue
. - SMART_QUEUE_DELETED_UNKNOWN - Enum constant in enum class xyz.dynxsty.dih4jda.DIH4JDALogger.Type
-
If a command got deleted by the
SmartQueue
. - SMART_QUEUE_IGNORED - Enum constant in enum class xyz.dynxsty.dih4jda.DIH4JDALogger.Type
-
If a command got ignored by the
SmartQueue
. - SMART_QUEUE_IGNORED_UNKNOWN - Enum constant in enum class xyz.dynxsty.dih4jda.DIH4JDALogger.Type
-
If a command got ignored by the
SmartQueue
because it was unknown. - SmartQueue - Class in xyz.dynxsty.dih4jda
-
Smart Queue
This Class handles all the SmartQueue functionality which can be disabled usingDIH4JDABuilder.setGlobalSmartQueue(boolean)
andDIH4JDABuilder.setGuildSmartQueue(boolean)
. - sortArrayFromDataArray(DataArray) - Static method in class xyz.dynxsty.dih4jda.util.ArrayUtil
-
Checks if the specified object is inside the specified array.
- split(String) - Static method in class xyz.dynxsty.dih4jda.util.ComponentIdBuilder
-
Splits the given id by the current separator.
- StringSelectMenuHandler - Interface in xyz.dynxsty.dih4jda.interactions.components
-
An interface that contains the method that should be executed when a user interacts with a
StringSelectMenu
. - Subcommand() - Constructor for class xyz.dynxsty.dih4jda.interactions.commands.application.SlashCommand.Subcommand
-
Creates a default instance.
T
- trace(String, Object...) - Static method in class xyz.dynxsty.dih4jda.DIH4JDALogger
-
Logs a message with the specified
Level.TRACE
. - trace(DIH4JDALogger.Type, String, Object...) - Static method in class xyz.dynxsty.dih4jda.DIH4JDALogger
-
Logs a message with the specified
DIH4JDALogger.Type
andLevel.TRACE
. - TRACE - Enum constant in enum class xyz.dynxsty.dih4jda.DIH4JDALogger.Type
-
Use this if you want to trace something down.
U
- User() - Constructor for class xyz.dynxsty.dih4jda.interactions.commands.application.ContextCommand.User
-
Creates a new, default user command.
V
- valueOf(String) - Static method in enum class xyz.dynxsty.dih4jda.DIH4JDALogger.Type
-
Returns the enum constant of this class with the specified name.
- valueOf(String) - Static method in enum class xyz.dynxsty.dih4jda.interactions.commands.application.RegistrationType
-
Returns the enum constant of this class with the specified name.
- values() - Static method in enum class xyz.dynxsty.dih4jda.DIH4JDALogger.Type
-
Returns an array containing the constants of this enum class, in the order they are declared.
- values() - Static method in enum class xyz.dynxsty.dih4jda.interactions.commands.application.RegistrationType
-
Returns an array containing the constants of this enum class, in the order they are declared.
W
- warn(String, Object...) - Static method in class xyz.dynxsty.dih4jda.DIH4JDALogger
-
Logs a message with the specified
Level.WARN
. - warn(DIH4JDALogger.Type, String, Object...) - Static method in class xyz.dynxsty.dih4jda.DIH4JDALogger
-
Logs a message with the specified
DIH4JDALogger.Type
andLevel.WARN
. - WARN - Enum constant in enum class xyz.dynxsty.dih4jda.DIH4JDALogger.Type
-
Use this if you want to warn the user.
X
- xyz.dynxsty.dih4jda - package xyz.dynxsty.dih4jda
-
Root package of Dynxsty's Interaction Handler for JDA.
- xyz.dynxsty.dih4jda.config - package xyz.dynxsty.dih4jda.config
-
Contains configuration classes
DIH4JDA
uses. - xyz.dynxsty.dih4jda.events - package xyz.dynxsty.dih4jda.events
-
The core events that are fired by this library, which inform the end-user about states of the registered commands.
- xyz.dynxsty.dih4jda.exceptions - package xyz.dynxsty.dih4jda.exceptions
-
Contains custom exceptions DIH4JDA uses.
- xyz.dynxsty.dih4jda.interactions - package xyz.dynxsty.dih4jda.interactions
-
Used for all kinds of stuff regarding interactions.
- xyz.dynxsty.dih4jda.interactions.commands - package xyz.dynxsty.dih4jda.interactions.commands
-
Contains model-classes for all command types this framework supports.
- xyz.dynxsty.dih4jda.interactions.commands.application - package xyz.dynxsty.dih4jda.interactions.commands.application
-
Contains various types of model-classes for discords' Application Commands.
- xyz.dynxsty.dih4jda.interactions.components - package xyz.dynxsty.dih4jda.interactions.components
-
Contains handler-classes that are used to handle JDA interactions and components.
- xyz.dynxsty.dih4jda.util - package xyz.dynxsty.dih4jda.util
-
The package for utility classes that are used directly by
DIH4JDA
, by the user or both.
All Classes and Interfaces|All Packages|Serialized Form
DIH4JDALogger.disableLogging(DIH4JDALogger.Type...)
instead. Will be removed in 2.0