Index (ultimategdbot-api 5.0.0-RC2 API)

A B C D E F G H I K L M N O P Q R S T U V W
All Classes All Packages

A

acquireUntil(Object, Publisher<X>) - Method in class com.github.alex1304.ultimategdbot.api.utils.MutexPool
add(Command) - Method in class com.github.alex1304.ultimategdbot.api.command.CommandProvider: Adds a command to this provider.
add(String) - Method in class com.github.alex1304.ultimategdbot.api.command.FlagSet.FlagSetBuilder
add(String, String) - Method in class com.github.alex1304.ultimategdbot.api.command.FlagSet.FlagSetBuilder
addAnnotated(Object) - Method in class com.github.alex1304.ultimategdbot.api.command.annotated.AnnotatedCommandProvider: Builds and adds a new command based on the given annotated object.
addHandler(Class<T>, BiFunction<T, Context, Mono<Void>>) - Method in class com.github.alex1304.ultimategdbot.api.command.CommandErrorHandler: Adds an error handler.
addMessageItem(String, Function<MessageMenuInteraction, Mono<Void>>) - Method in class com.github.alex1304.ultimategdbot.api.utils.menu.InteractiveMenu
addParamConverter(ParamConverter<?>) - Method in class com.github.alex1304.ultimategdbot.api.command.annotated.AnnotatedCommandProvider: Adds a new param converter to this annotated command provider.
addProvider(CommandProvider) - Method in class com.github.alex1304.ultimategdbot.api.CommandKernel: Adds a new command provider to this kernel.
addReactionItem(String, Function<ReactionMenuInteraction, Mono<Void>>) - Method in class com.github.alex1304.ultimategdbot.api.utils.menu.InteractiveMenu
aliases() - Method in annotation type com.github.alex1304.ultimategdbot.api.command.annotated.CommandSpec
AnnotatedCommand - Class in com.github.alex1304.ultimategdbot.api.command.annotated: Command implemented via annotations.
AnnotatedCommandProvider - Class in com.github.alex1304.ultimategdbot.api.command.annotated
AnnotatedCommandProvider() - Constructor for class com.github.alex1304.ultimategdbot.api.command.annotated.AnnotatedCommandProvider
ANYWHERE - com.github.alex1304.ultimategdbot.api.command.Scope
apply(Mono<Void>, Context) - Method in class com.github.alex1304.ultimategdbot.api.command.CommandErrorHandler: Applies the handler on the resulting Mono of Command.run(Context).
ArgumentList - Class in com.github.alex1304.ultimategdbot.api.command: Represents the list of the arguments of a command.
ArgumentList(List<String>) - Constructor for class com.github.alex1304.ultimategdbot.api.command.ArgumentList
asIs() - Static method in interface com.github.alex1304.ultimategdbot.api.utils.DatabaseInputFunction: Forwards the input value to the database as is, without any modification or check.

B

blacklist(long) - Method in class com.github.alex1304.ultimategdbot.api.CommandKernel: Blacklists a new ID.
BlacklistedIds - Class in com.github.alex1304.ultimategdbot.api.database
BlacklistedIds() - Constructor for class com.github.alex1304.ultimategdbot.api.database.BlacklistedIds
bold(String) - Static method in class com.github.alex1304.ultimategdbot.api.utils.Markdown: Formats the text with bold markdown
Bot - Class in com.github.alex1304.ultimategdbot.api: Represents the bot itself.
BOT_ADMIN - com.github.alex1304.ultimategdbot.api.command.PermissionLevel
BOT_OWNER - com.github.alex1304.ultimategdbot.api.command.PermissionLevel
BotAdmins - Class in com.github.alex1304.ultimategdbot.api.database
BotAdmins() - Constructor for class com.github.alex1304.ultimategdbot.api.database.BotAdmins
BotUtils - Class in com.github.alex1304.ultimategdbot.api.utils: Contains various utility methods.
build() - Method in class com.github.alex1304.ultimategdbot.api.command.FlagSet.FlagSetBuilder
builder() - Static method in class com.github.alex1304.ultimategdbot.api.command.FlagSet: Creates a builder to configure a new set of flags.
buildFromProperties(Properties, Properties) - Static method in class com.github.alex1304.ultimategdbot.api.Bot
BYTE - com.github.alex1304.ultimategdbot.api.utils.SystemUnit

C

check(int, int, int) - Static method in exception com.github.alex1304.ultimategdbot.api.utils.menu.PageNumberOutOfRangeException
checkGranted(Context) - Method in enum com.github.alex1304.ultimategdbot.api.command.PermissionLevel: Completes empty if the permission is granted in the given context, or errors with PermissionDeniedException otherwise.
ClockRateLimiter - Class in com.github.alex1304.ultimategdbot.api: Custom implementation of GlobalRateLimiter that uses a clock ticking at regular intervals in order to give permits for requests.
ClockRateLimiter(int, Duration) - Constructor for class com.github.alex1304.ultimategdbot.api.ClockRateLimiter: Creates a ClockRateLimiter with a specified interval and number of permits per tick.
closeAfterMessage(boolean) - Method in class com.github.alex1304.ultimategdbot.api.utils.menu.InteractiveMenu
closeAfterReaction(boolean) - Method in class com.github.alex1304.ultimategdbot.api.utils.menu.InteractiveMenu
code(String) - Static method in class com.github.alex1304.ultimategdbot.api.utils.Markdown: Formats the text as code.
codeBlock(String) - Static method in class com.github.alex1304.ultimategdbot.api.utils.Markdown: Formats the text as a code block.
codeBlock(String, String) - Static method in class com.github.alex1304.ultimategdbot.api.utils.Markdown: Formats the text as a code block.
com.github.alex1304.ultimategdbot.api - package com.github.alex1304.ultimategdbot.api
com.github.alex1304.ultimategdbot.api.command - package com.github.alex1304.ultimategdbot.api.command
com.github.alex1304.ultimategdbot.api.command.annotated - package com.github.alex1304.ultimategdbot.api.command.annotated
com.github.alex1304.ultimategdbot.api.command.annotated.paramconverter - package com.github.alex1304.ultimategdbot.api.command.annotated.paramconverter
com.github.alex1304.ultimategdbot.api.database - package com.github.alex1304.ultimategdbot.api.database
com.github.alex1304.ultimategdbot.api.utils - package com.github.alex1304.ultimategdbot.api.utils
com.github.alex1304.ultimategdbot.api.utils.menu - package com.github.alex1304.ultimategdbot.api.utils.menu
Command - Interface in com.github.alex1304.ultimategdbot.api.command: Represents a bot command.
CommandAction - Annotation Type in com.github.alex1304.ultimategdbot.api.command.annotated
CommandDoc - Annotation Type in com.github.alex1304.ultimategdbot.api.command.annotated
CommandDocumentation - Class in com.github.alex1304.ultimategdbot.api.command: Holds the documentation for a specific command.
CommandDocumentation(String, Map<String, CommandDocumentationEntry>, boolean) - Constructor for class com.github.alex1304.ultimategdbot.api.command.CommandDocumentation
CommandDocumentationEntry - Class in com.github.alex1304.ultimategdbot.api.command: Represents a documentation entry.
CommandDocumentationEntry(String, String, Map<String, FlagInformation>) - Constructor for class com.github.alex1304.ultimategdbot.api.command.CommandDocumentationEntry
CommandErrorHandler - Class in com.github.alex1304.ultimategdbot.api.command: Provides a convenient way to add error handlers for bot commands.
CommandErrorHandler() - Constructor for class com.github.alex1304.ultimategdbot.api.command.CommandErrorHandler
CommandFailedException - Exception in com.github.alex1304.ultimategdbot.api.command: Thrown when something goes wrong during the execution of a command.
CommandFailedException() - Constructor for exception com.github.alex1304.ultimategdbot.api.command.CommandFailedException
CommandFailedException(String) - Constructor for exception com.github.alex1304.ultimategdbot.api.command.CommandFailedException
CommandFailedException(String, Throwable) - Constructor for exception com.github.alex1304.ultimategdbot.api.command.CommandFailedException
CommandFailedException(String, Throwable, boolean, boolean) - Constructor for exception com.github.alex1304.ultimategdbot.api.command.CommandFailedException
CommandFailedException(Throwable) - Constructor for exception com.github.alex1304.ultimategdbot.api.command.CommandFailedException
CommandKernel - Class in com.github.alex1304.ultimategdbot.api: The command kernel coordinates the command providers from all plugins.
CommandKernel(Bot) - Constructor for class com.github.alex1304.ultimategdbot.api.CommandKernel
CommandProvider - Class in com.github.alex1304.ultimategdbot.api.command: Provides a set of commands.
CommandProvider() - Constructor for class com.github.alex1304.ultimategdbot.api.command.CommandProvider
CommandSpec - Annotation Type in com.github.alex1304.ultimategdbot.api.command.annotated
configure() - Method in class com.github.alex1304.ultimategdbot.api.Database: Initializes the database.
Context - Class in com.github.alex1304.ultimategdbot.api.command
Context(Command, MessageCreateEvent, List<String>, FlagSet, Bot, String, MessageChannel) - Constructor for class com.github.alex1304.ultimategdbot.api.command.Context
convert(long) - Method in enum com.github.alex1304.ultimategdbot.api.utils.SystemUnit: Converts the given value to the unit represented by the current object
convert(Context, String) - Method in class com.github.alex1304.ultimategdbot.api.command.annotated.paramconverter.GuildChannelConverter
convert(Context, String) - Method in class com.github.alex1304.ultimategdbot.api.command.annotated.paramconverter.IntConverter
convert(Context, String) - Method in class com.github.alex1304.ultimategdbot.api.command.annotated.paramconverter.LongConverter
convert(Context, String) - Method in interface com.github.alex1304.ultimategdbot.api.command.annotated.paramconverter.ParamConverter: Accepts a String input and parses it into an object of type T.
convert(Context, String) - Method in class com.github.alex1304.ultimategdbot.api.command.annotated.paramconverter.RoleConverter
convert(Context, String) - Method in class com.github.alex1304.ultimategdbot.api.command.annotated.paramconverter.StringConverter
convert(Context, String) - Method in class com.github.alex1304.ultimategdbot.api.command.annotated.paramconverter.UserConverter
create(String) - Static method in class com.github.alex1304.ultimategdbot.api.utils.menu.InteractiveMenu: Creates a new empty InteractiveMenu with a given message that will serve as menu prompt.
create(Consumer<MessageCreateSpec>) - Static method in class com.github.alex1304.ultimategdbot.api.utils.menu.InteractiveMenu: Creates a new empty InteractiveMenu with a given message that will serve as menu prompt.
create(Mono<Consumer<MessageCreateSpec>>) - Static method in class com.github.alex1304.ultimategdbot.api.utils.menu.InteractiveMenu: Creates a new empty InteractiveMenu with a given message that will serve as menu prompt.
createAsyncPaginated(AtomicInteger, PaginationControls, IntFunction<Mono<UniversalMessageSpec>>) - Static method in class com.github.alex1304.ultimategdbot.api.utils.menu.InteractiveMenu: Creates a new InteractiveMenu prefilled with menu items useful for pagination.
createPaginated(AtomicInteger, PaginationControls, IntFunction<UniversalMessageSpec>) - Static method in class com.github.alex1304.ultimategdbot.api.utils.menu.InteractiveMenu: Creates a new InteractiveMenu prefilled with menu items useful for pagination.

D

Database - Class in com.github.alex1304.ultimategdbot.api: Manages interactions with the database.
Database() - Constructor for class com.github.alex1304.ultimategdbot.api.Database
DatabaseException - Exception in com.github.alex1304.ultimategdbot.api
DatabaseException(Throwable) - Constructor for exception com.github.alex1304.ultimategdbot.api.DatabaseException
DatabaseInputFunction<D> - Interface in com.github.alex1304.ultimategdbot.api.utils: Function that determines the value to save to the database after reading the user input as String.
DatabaseOutputFunction<D> - Interface in com.github.alex1304.ultimategdbot.api.utils: Function that determines the string to display to the user after reading the value from teh database.
debugError(String, Context, Throwable) - Static method in class com.github.alex1304.ultimategdbot.api.utils.BotUtils: Sends an error report to the debug log channel.
delete(Object) - Method in class com.github.alex1304.ultimategdbot.api.Database: Deletes an object from database
deleteMenuOnClose(boolean) - Method in class com.github.alex1304.ultimategdbot.api.utils.menu.InteractiveMenu
deleteMenuOnTimeout(boolean) - Method in class com.github.alex1304.ultimategdbot.api.utils.menu.InteractiveMenu
description() - Method in annotation type com.github.alex1304.ultimategdbot.api.command.annotated.FlagInfo
DiscordFormatter - Class in com.github.alex1304.ultimategdbot.api.utils: Contains utility methods to format a Discord entity into a user-friendly String.
DiscordParser - Class in com.github.alex1304.ultimategdbot.api.utils: Contains utility methods to parse a user input into a Discord entity.
DM_ONLY - com.github.alex1304.ultimategdbot.api.command.Scope

E

equals(Object) - Method in class com.github.alex1304.ultimategdbot.api.database.NativeGuildSettings
escape(String) - Static method in class com.github.alex1304.ultimategdbot.api.utils.Markdown: Escapes characters used in Markdown syntax using a backslash
ExecutableCommand - Class in com.github.alex1304.ultimategdbot.api.command: Represents a command ready to be executed, meaning that the context and the error handler of the command are already defined.
ExecutableCommand(Command, Context, CommandErrorHandler) - Constructor for class com.github.alex1304.ultimategdbot.api.command.ExecutableCommand
execute() - Method in class com.github.alex1304.ultimategdbot.api.command.ExecutableCommand: Executes the command by taking into account the context and by applying the error handler.

F

findByID(Class<T>, K) - Method in class com.github.alex1304.ultimategdbot.api.Database: Allows to find a database entity by its ID.
FlagDoc - Annotation Type in com.github.alex1304.ultimategdbot.api.command.annotated
FlagInfo - Annotation Type in com.github.alex1304.ultimategdbot.api.command.annotated
FlagInformation - Class in com.github.alex1304.ultimategdbot.api.command: Holds information about a command flag.
FlagInformation(String, String) - Constructor for class com.github.alex1304.ultimategdbot.api.command.FlagInformation
FlagSet - Class in com.github.alex1304.ultimategdbot.api.command: Contains the set of flags used in a command.
FlagSet(Map<String, Optional<String>>) - Constructor for class com.github.alex1304.ultimategdbot.api.command.FlagSet
FlagSet.FlagSetBuilder - Class in com.github.alex1304.ultimategdbot.api.command
format(long) - Static method in enum com.github.alex1304.ultimategdbot.api.utils.SystemUnit: Formats the given value to a human readable format, using the appropriate unit
formatDuration(Duration) - Static method in class com.github.alex1304.ultimategdbot.api.utils.BotUtils: Formats a Duration into a human readable String.
formatGuildChannel(GuildChannel) - Static method in class com.github.alex1304.ultimategdbot.api.utils.DiscordFormatter: Formats a channel to the channel mention if text channel, or name (id) if voice channel or category.
formatRole(Role) - Static method in class com.github.alex1304.ultimategdbot.api.utils.DiscordFormatter: Formats a role to the following format: @name (id)
formatUser(User) - Static method in class com.github.alex1304.ultimategdbot.api.utils.DiscordFormatter: Formats a user to the following format: username#discriminator
from(Function<? super D, String>) - Static method in interface com.github.alex1304.ultimategdbot.api.utils.DatabaseOutputFunction: Forwards the value from the database by returning its string representation provided by the given function.
fromChannelId(Bot) - Static method in interface com.github.alex1304.ultimategdbot.api.utils.DatabaseOutputFunction: Reads the database value as a channel ID, attempts to convert it to a channel and gives a string representation of this channel provided by DiscordFormatter.formatGuildChannel(GuildChannel).
fromChannelId(Bot, Function<? super GuildChannel, String>) - Static method in interface com.github.alex1304.ultimategdbot.api.utils.DatabaseOutputFunction: Reads the database value as a channel ID, attempts to convert it to a channel and gives a string representation of this channel.
fromRoleId(Bot) - Static method in interface com.github.alex1304.ultimategdbot.api.utils.DatabaseOutputFunction: Reads the database value as a role ID, attempts to convert it to a role and gives a string representation of this role provided by DiscordFormatter.formatRole(Role).
fromRoleId(Bot, Function<? super Role, String>) - Static method in interface com.github.alex1304.ultimategdbot.api.utils.DatabaseOutputFunction: Reads the database value as a role ID, attempts to convert it to a role and gives a string representation of this role.
fromUserId(Bot) - Static method in interface com.github.alex1304.ultimategdbot.api.utils.DatabaseOutputFunction: Reads the database value as a user ID, attempts to convert it to a user and gives a string representation of this user provided by DiscordFormatter.formatUser(User).
fromUserId(Bot, Function<? super User, String>) - Static method in interface com.github.alex1304.ultimategdbot.api.utils.DatabaseOutputFunction: Reads the database value as a user ID, attempts to convert it to a user and gives a string representation of this user.

G

get(int) - Method in class com.github.alex1304.ultimategdbot.api.command.ArgumentList: Returns the argument at the specified position.
get(String) - Method in class com.github.alex1304.ultimategdbot.api.command.FlagSet: Gets the value of the flag with the given name.
getActualValue() - Method in exception com.github.alex1304.ultimategdbot.api.utils.menu.PageNumberOutOfRangeException
getAliases() - Method in class com.github.alex1304.ultimategdbot.api.command.annotated.AnnotatedCommand
getAliases() - Method in interface com.github.alex1304.ultimategdbot.api.command.Command: Gets the aliases for this command.
getAllAfter(int) - Method in class com.github.alex1304.ultimategdbot.api.command.ArgumentList: Gets all arguments from the specified position to the last one, into one String resulting of the concatenation of all arguments (separated with a whitespace).
getApplicationInfo() - Method in class com.github.alex1304.ultimategdbot.api.Bot: Get the application info of the bot
getArgs() - Method in class com.github.alex1304.ultimategdbot.api.command.Context: Gets the arguments of the command.
getArgs() - Method in class com.github.alex1304.ultimategdbot.api.utils.menu.MessageMenuInteraction
getAsString(Session, long) - Method in class com.github.alex1304.ultimategdbot.api.database.GuildSettingsEntry
getAttachmentsChannel() - Method in class com.github.alex1304.ultimategdbot.api.Bot: Gets the channel where the bot can send attachments for its embeds.
getAuthor() - Method in class com.github.alex1304.ultimategdbot.api.command.Context: Gets the author of the message that created this context.
getBlacklist() - Method in class com.github.alex1304.ultimategdbot.api.CommandKernel: Gets an unmodifiable set of IDs that are not allowed to perform operations on the command kernel.
getBot() - Method in class com.github.alex1304.ultimategdbot.api.command.Context: Gets the bot instance.
getChannel() - Method in class com.github.alex1304.ultimategdbot.api.command.Context: Gets the channel of the message that created this context.
getChannel() - Method in class com.github.alex1304.ultimategdbot.api.utils.menu.ReactionToggleEvent
getChannelId() - Method in class com.github.alex1304.ultimategdbot.api.utils.menu.ReactionToggleEvent
getCloseEmoji() - Method in class com.github.alex1304.ultimategdbot.api.utils.menu.PaginationControls
getCommand() - Method in class com.github.alex1304.ultimategdbot.api.command.Context: Gets the command that created this context.
getCommand() - Method in class com.github.alex1304.ultimategdbot.api.command.ExecutableCommand: Gets the underlying command instance.
getCommandByAlias(String) - Method in class com.github.alex1304.ultimategdbot.api.command.CommandProvider: Gets a command instance corresponding to the given alias.
getCommandByAlias(String) - Method in class com.github.alex1304.ultimategdbot.api.CommandKernel: Gets a command instance corresponding to the given alias.
getCommandKernel() - Method in class com.github.alex1304.ultimategdbot.api.Bot: Gets the command kernel of this bot.
getCommandProvider() - Method in interface com.github.alex1304.ultimategdbot.api.Plugin: Gets the command provider for this plugin.
getContent() - Method in class com.github.alex1304.ultimategdbot.api.utils.UniversalMessageSpec
getContext() - Method in class com.github.alex1304.ultimategdbot.api.command.ExecutableCommand: Gets the context of the command.
getDatabase() - Method in class com.github.alex1304.ultimategdbot.api.Bot: Gets the database of the bot.
getDatabaseMappingResources() - Method in interface com.github.alex1304.ultimategdbot.api.Plugin: Gets a set of resource names that corresponds to database mapping files.
getDebugLogChannel() - Method in class com.github.alex1304.ultimategdbot.api.Bot: Gets the channel where the bot sends messages for debugging purposes.
getDefaultPaginationControls() - Method in class com.github.alex1304.ultimategdbot.api.Bot: Gets the default emojis used for pagination controls configured for the bot.
getDefaultPrefix() - Method in class com.github.alex1304.ultimategdbot.api.Bot: Gets the default prefix.
getDescription() - Method in class com.github.alex1304.ultimategdbot.api.command.CommandDocumentationEntry: Gets the description of what the command does, according to the usage represented by this entry.
getDescription() - Method in class com.github.alex1304.ultimategdbot.api.command.FlagInformation: Gets a description of what this flag does for the command.
getDiscordClients() - Method in class com.github.alex1304.ultimategdbot.api.Bot: Gets the Flux containing the discord client for each shard.
getDocumentation() - Method in class com.github.alex1304.ultimategdbot.api.command.annotated.AnnotatedCommand
getDocumentation() - Method in interface com.github.alex1304.ultimategdbot.api.command.Command: Gets the documentation of the command.
getEmbed() - Method in class com.github.alex1304.ultimategdbot.api.utils.UniversalMessageSpec
getEmoji() - Method in class com.github.alex1304.ultimategdbot.api.utils.menu.ReactionToggleEvent
getEmoji(String) - Method in class com.github.alex1304.ultimategdbot.api.Bot: Gets the String representation of an emoji installed on one of the emoji servers.
getEntityClass() - Method in class com.github.alex1304.ultimategdbot.api.database.GuildSettingsEntry
getEntries() - Method in class com.github.alex1304.ultimategdbot.api.command.CommandDocumentation: Gets all entries corresponding to subsections of the command documentation.
getErrorHandler() - Method in class com.github.alex1304.ultimategdbot.api.command.CommandProvider: Gets the error handler assigned to this provider.
getErrorHandler() - Method in class com.github.alex1304.ultimategdbot.api.command.ExecutableCommand: Gets the error handler applied to this command.
getEvent() - Method in class com.github.alex1304.ultimategdbot.api.command.Context: Gets the message create event associated to this command.
getEvent() - Method in class com.github.alex1304.ultimategdbot.api.utils.menu.MessageMenuInteraction
getEvent() - Method in class com.github.alex1304.ultimategdbot.api.utils.menu.ReactionMenuInteraction
getFlagInfo() - Method in class com.github.alex1304.ultimategdbot.api.command.CommandDocumentationEntry: Gets information on the flags that can be used with this part of the command.
getFlags() - Method in class com.github.alex1304.ultimategdbot.api.command.Context
getFlags() - Method in class com.github.alex1304.ultimategdbot.api.utils.menu.MessageMenuInteraction
getGitProperties() - Method in interface com.github.alex1304.ultimategdbot.api.Plugin: Gets the Git properties for this plugin.
getGuild() - Method in class com.github.alex1304.ultimategdbot.api.utils.menu.ReactionToggleEvent
getGuildConfigurationEntries() - Method in interface com.github.alex1304.ultimategdbot.api.Plugin: Gets a map of configuration entries for guilds.
getGuildId() - Method in interface com.github.alex1304.ultimategdbot.api.database.GuildSettings: Gets the guildID
getGuildId() - Method in class com.github.alex1304.ultimategdbot.api.database.NativeGuildSettings
getGuildId() - Method in class com.github.alex1304.ultimategdbot.api.utils.menu.ReactionToggleEvent
getId() - Method in class com.github.alex1304.ultimategdbot.api.database.BlacklistedIds
getInstalledEmojis() - Method in class com.github.alex1304.ultimategdbot.api.Bot: Gets all emojis installed.
getInteractiveMenuTimeout() - Method in class com.github.alex1304.ultimategdbot.api.Bot: Gets the maximum time in seconds that the bot should wait for a user interaction when an interactive menu is open.
getMainDiscordClient() - Method in class com.github.alex1304.ultimategdbot.api.Bot: Gets the discord client representing shard 0.
getMaxPage() - Method in exception com.github.alex1304.ultimategdbot.api.utils.menu.PageNumberOutOfRangeException
getMessage() - Method in class com.github.alex1304.ultimategdbot.api.utils.menu.ReactionToggleEvent
getMessageId() - Method in class com.github.alex1304.ultimategdbot.api.utils.menu.ReactionToggleEvent
getMinPage() - Method in exception com.github.alex1304.ultimategdbot.api.utils.menu.PageNumberOutOfRangeException
getName() - Method in interface com.github.alex1304.ultimategdbot.api.Plugin: Gets the name of the plugin.
getNextEmoji() - Method in class com.github.alex1304.ultimategdbot.api.utils.menu.PaginationControls
getPermissionLevel() - Method in class com.github.alex1304.ultimategdbot.api.command.annotated.AnnotatedCommand
getPermissionLevel() - Method in interface com.github.alex1304.ultimategdbot.api.command.Command: Gets the permission level required to execute this command.
getPlugins() - Method in class com.github.alex1304.ultimategdbot.api.Bot: Gets a Set containing all successfully loaded plugins.
getPrefix() - Method in class com.github.alex1304.ultimategdbot.api.database.NativeGuildSettings
getPrefixUsed() - Method in class com.github.alex1304.ultimategdbot.api.command.Context: Gets the prefix used in the command that created this context.
getPreviousEmoji() - Method in class com.github.alex1304.ultimategdbot.api.utils.menu.PaginationControls
getProvidedCommands() - Method in class com.github.alex1304.ultimategdbot.api.command.CommandProvider: Gets all provided commands.
getRaw(Session, long) - Method in class com.github.alex1304.ultimategdbot.api.database.GuildSettingsEntry
getRemaining() - Method in class com.github.alex1304.ultimategdbot.api.ClockRateLimiter
getScope() - Method in class com.github.alex1304.ultimategdbot.api.command.annotated.AnnotatedCommand
getScope() - Method in interface com.github.alex1304.ultimategdbot.api.command.Command: Gets the type of channels this command is allowed for use in.
getServerModRoleId() - Method in class com.github.alex1304.ultimategdbot.api.database.NativeGuildSettings
getShortDescription() - Method in class com.github.alex1304.ultimategdbot.api.command.CommandDocumentation: Gets the short description of the command.
getSyntax() - Method in class com.github.alex1304.ultimategdbot.api.command.CommandDocumentationEntry: Gets the syntax of the command relevant for this entry.
getToken() - Method in class com.github.alex1304.ultimategdbot.api.Bot: Get the bot token.
getTokens() - Method in class com.github.alex1304.ultimategdbot.api.command.ArgumentList
getTokens(int) - Method in class com.github.alex1304.ultimategdbot.api.command.ArgumentList
getUser() - Method in class com.github.alex1304.ultimategdbot.api.utils.menu.ReactionToggleEvent
getUserId() - Method in class com.github.alex1304.ultimategdbot.api.database.BotAdmins
getUserId() - Method in class com.github.alex1304.ultimategdbot.api.utils.menu.ReactionToggleEvent
getValueFormat() - Method in class com.github.alex1304.ultimategdbot.api.command.FlagInformation: Gets a description of the value format.
GIGABYTE - com.github.alex1304.ultimategdbot.api.utils.SystemUnit
GUILD_ONLY - com.github.alex1304.ultimategdbot.api.command.Scope
GuildChannelConverter - Class in com.github.alex1304.ultimategdbot.api.command.annotated.paramconverter
GuildChannelConverter() - Constructor for class com.github.alex1304.ultimategdbot.api.command.annotated.paramconverter.GuildChannelConverter
GuildSettings - Interface in com.github.alex1304.ultimategdbot.api.database
GuildSettingsEntry<E extends GuildSettings,D> - Class in com.github.alex1304.ultimategdbot.api.database: Represents a guild configuration entry.
GuildSettingsEntry(Class<E>, Function<E, D>, BiConsumer<E, D>, DatabaseInputFunction<D>, DatabaseOutputFunction<D>) - Constructor for class com.github.alex1304.ultimategdbot.api.database.GuildSettingsEntry

H

has(String) - Method in class com.github.alex1304.ultimategdbot.api.command.FlagSet: Checks whether the flag with he given name is present in this set.
hashCode() - Method in class com.github.alex1304.ultimategdbot.api.database.NativeGuildSettings
HiddenCommand - Annotation Type in com.github.alex1304.ultimategdbot.api.command.annotated

I

InputTokenizer - Class in com.github.alex1304.ultimategdbot.api.utils: Utility methods to split an input into tokens and recognize which are flags and which are arguments.
installEmojis() - Method in class com.github.alex1304.ultimategdbot.api.Bot: Gathers all emojis from the configured emoji guilds and put them in cache.
IntConverter - Class in com.github.alex1304.ultimategdbot.api.command.annotated.paramconverter
IntConverter() - Constructor for class com.github.alex1304.ultimategdbot.api.command.annotated.paramconverter.IntConverter
InteractiveMenu - Class in com.github.alex1304.ultimategdbot.api.utils.menu: Utility to create interactive menus in Discord.
InvalidAnnotatedObjectException - Exception in com.github.alex1304.ultimategdbot.api.command.annotated
InvalidAnnotatedObjectException(String) - Constructor for exception com.github.alex1304.ultimategdbot.api.command.annotated.InvalidAnnotatedObjectException
invalidateCachedPrefixForGuild(long) - Method in class com.github.alex1304.ultimategdbot.api.CommandKernel: Forces this command kernel to evict the prefix from cache for the specified guild.
isAddEvent() - Method in class com.github.alex1304.ultimategdbot.api.utils.menu.ReactionToggleEvent
isCorePluginDisabled() - Method in class com.github.alex1304.ultimategdbot.api.Bot: Gets whether the core plugin is disabled.
isGranted(Context) - Method in enum com.github.alex1304.ultimategdbot.api.command.PermissionLevel: Emits true if the permission is granted in the given context, false otherwise.
isHidden() - Method in class com.github.alex1304.ultimategdbot.api.command.CommandDocumentation: Gets whether the command should be hidden from the documentation front page.
isInScope(Channel) - Method in enum com.github.alex1304.ultimategdbot.api.command.Scope
italic(String) - Static method in class com.github.alex1304.ultimategdbot.api.utils.Markdown: Formats the text with italic markdown.
italic(String, boolean) - Static method in class com.github.alex1304.ultimategdbot.api.utils.Markdown: Formats the text with italic markdown

K

KILOBYTE - com.github.alex1304.ultimategdbot.api.utils.SystemUnit

L

log(String) - Method in class com.github.alex1304.ultimategdbot.api.Bot: Sends a message into the debug log channel.
log(Consumer<MessageCreateSpec>) - Method in class com.github.alex1304.ultimategdbot.api.Bot: Sends a message into the debug log channel.
LongConverter - Class in com.github.alex1304.ultimategdbot.api.command.annotated.paramconverter
LongConverter() - Constructor for class com.github.alex1304.ultimategdbot.api.command.annotated.paramconverter.LongConverter

M

Markdown - Class in com.github.alex1304.ultimategdbot.api.utils
maskedLink(String, String) - Static method in class com.github.alex1304.ultimategdbot.api.utils.Markdown: Make a masked link using markdown.
MEGABYTE - com.github.alex1304.ultimategdbot.api.utils.SystemUnit
MessageMenuInteraction - Class in com.github.alex1304.ultimategdbot.api.utils.menu
MutexPool - Class in com.github.alex1304.ultimategdbot.api.utils
MutexPool() - Constructor for class com.github.alex1304.ultimategdbot.api.utils.MutexPool

N

name() - Method in annotation type com.github.alex1304.ultimategdbot.api.command.annotated.FlagInfo
NativeGuildSettings - Class in com.github.alex1304.ultimategdbot.api.database
NativeGuildSettings() - Constructor for class com.github.alex1304.ultimategdbot.api.database.NativeGuildSettings

O

of(BiFunction<D, Long, Mono<String>>) - Static method in interface com.github.alex1304.ultimategdbot.api.utils.DatabaseOutputFunction: Encapsulates a regular BiFunction into an instance of DatabaseOutputFunction.
of(BiFunction<String, Long, Mono<D>>) - Static method in interface com.github.alex1304.ultimategdbot.api.utils.DatabaseInputFunction: Encapsulates a regular BiFunction into an instance of DatabaseInputFunction.
onBotReady(Bot) - Method in interface com.github.alex1304.ultimategdbot.api.Plugin: Action to execute when the bot is ready.
open(Context) - Method in class com.github.alex1304.ultimategdbot.api.utils.menu.InteractiveMenu: Opens the interactive menu, that is, sends the menu message over Discord and starts listening for user's interaction.

P

PageNumberOutOfRangeException - Exception in com.github.alex1304.ultimategdbot.api.utils.menu
PageNumberOutOfRangeException(int, int, int) - Constructor for exception com.github.alex1304.ultimategdbot.api.utils.menu.PageNumberOutOfRangeException
PaginationControls - Class in com.github.alex1304.ultimategdbot.api.utils.menu
PaginationControls(String, String, String) - Constructor for class com.github.alex1304.ultimategdbot.api.utils.menu.PaginationControls
ParamConversionException - Exception in com.github.alex1304.ultimategdbot.api.command.annotated.paramconverter
ParamConversionException(String, String, String) - Constructor for exception com.github.alex1304.ultimategdbot.api.command.annotated.paramconverter.ParamConversionException
ParamConverter<T> - Interface in com.github.alex1304.ultimategdbot.api.command.annotated.paramconverter: Parses a String into an object of parameterized type.
parse(String, Function<String, P>) - Method in class com.github.alex1304.ultimategdbot.api.utils.PropertyParser: Parses a value using the given function and returns it
parseAndGet(String, Function<String, T>) - Method in class com.github.alex1304.ultimategdbot.api.command.FlagSet: Gets the value of the flag with the given name, and transforms the value using the supplied function.
parseAsInt(String) - Method in class com.github.alex1304.ultimategdbot.api.utils.PropertyParser: Convenient method that is similar as doing:
parseAsIntOrDefault(String, int) - Method in class com.github.alex1304.ultimategdbot.api.utils.PropertyParser: Convenient method that is similar as doing:
parseAsList(String, String, Function<String, E>) - Method in class com.github.alex1304.ultimategdbot.api.utils.PropertyParser: Attempts to parse the vale as a list of values, each element being separated with a separator character.
parseAsListOrEmpty(String, String, Function<String, E>) - Method in class com.github.alex1304.ultimategdbot.api.utils.PropertyParser: Same as PropertyParser.parseAsList(String, String, Function) but in case of error returns an empty list instead of throwing an IllegalArgumentException.
parseAsLong(String) - Method in class com.github.alex1304.ultimategdbot.api.utils.PropertyParser: Convenient method that is similar as doing:
parseAsLongOrDefault(String, long) - Method in class com.github.alex1304.ultimategdbot.api.utils.PropertyParser: Convenient method that is similar as doing:
parseAsString(String) - Method in class com.github.alex1304.ultimategdbot.api.utils.PropertyParser: Convenient method that is similar as doing:
parseAsStringOrDefault(String, String) - Method in class com.github.alex1304.ultimategdbot.api.utils.PropertyParser: Convenient method that is similar as doing:
parseGuildChannel(Bot, Snowflake, String) - Static method in class com.github.alex1304.ultimategdbot.api.utils.DiscordParser: Parses the input into a Discord channel.
parseOrDefault(String, Function<String, P>, P) - Method in class com.github.alex1304.ultimategdbot.api.utils.PropertyParser: Parses a value using the given function and returns it.
parseRole(Bot, Snowflake, String) - Static method in class com.github.alex1304.ultimategdbot.api.utils.DiscordParser: Parses the input into a Discord role.
parseUser(Bot, String) - Static method in class com.github.alex1304.ultimategdbot.api.utils.DiscordParser: Parses the input into a Discord user.
performEmptyTransaction(Consumer<Session>) - Method in class com.github.alex1304.ultimategdbot.api.Database: Allows to perform more complex actions with the database, by having full control on the current transaction.
performTransaction(Function<Session, V>) - Method in class com.github.alex1304.ultimategdbot.api.Database: Allows to perform more complex actions with the database, by having full control on the current transaction.
performTransactionWhen(Function<Session, Publisher<V>>) - Method in class com.github.alex1304.ultimategdbot.api.Database: Allows to manipulate a Session in an asynchronous context.
PermissionDeniedException - Exception in com.github.alex1304.ultimategdbot.api.command
PermissionDeniedException() - Constructor for exception com.github.alex1304.ultimategdbot.api.command.PermissionDeniedException
PermissionLevel - Enum in com.github.alex1304.ultimategdbot.api.command: Permission level of a bot command.
permLevel() - Method in annotation type com.github.alex1304.ultimategdbot.api.command.annotated.CommandSpec
Plugin - Interface in com.github.alex1304.ultimategdbot.api: Represents a plugin.
processEvent(MessageCreateEvent) - Method in class com.github.alex1304.ultimategdbot.api.CommandKernel: Processes a MessageCreateEvent.
PropertyParser - Class in com.github.alex1304.ultimategdbot.api.utils: Allows to parse values from properties files.
PropertyParser(Properties) - Constructor for class com.github.alex1304.ultimategdbot.api.utils.PropertyParser
provideFromEvent(Bot, String, MessageCreateEvent, MessageChannel) - Method in class com.github.alex1304.ultimategdbot.api.command.CommandProvider: Provides a command based on a MessageCreateEvent.
PUBLIC - com.github.alex1304.ultimategdbot.api.command.PermissionLevel

Q

query(Class<T>, String, Object...) - Method in class com.github.alex1304.ultimategdbot.api.Database: Makes a simple query to the database.
quote(String) - Static method in class com.github.alex1304.ultimategdbot.api.utils.Markdown: Formats the text as a quote.

R

rateLimitFor(Duration) - Method in class com.github.alex1304.ultimategdbot.api.ClockRateLimiter
ReactionMenuInteraction - Class in com.github.alex1304.ultimategdbot.api.utils.menu
ReactionToggleEvent - Class in com.github.alex1304.ultimategdbot.api.utils.menu
ReactionToggleEvent(Event) - Constructor for class com.github.alex1304.ultimategdbot.api.utils.menu.ReactionToggleEvent
reply(String) - Method in class com.github.alex1304.ultimategdbot.api.command.Context: Sends a message in the same channel the command was sent.
reply(Consumer<? super MessageCreateSpec>) - Method in class com.github.alex1304.ultimategdbot.api.command.Context: Sends a message in the same channel the command was sent.
RoleConverter - Class in com.github.alex1304.ultimategdbot.api.command.annotated.paramconverter
RoleConverter() - Constructor for class com.github.alex1304.ultimategdbot.api.command.annotated.paramconverter.RoleConverter
run(Context) - Method in class com.github.alex1304.ultimategdbot.api.command.annotated.AnnotatedCommand
run(Context) - Method in interface com.github.alex1304.ultimategdbot.api.command.Command: Defines the action of the command

S

save(Object) - Method in class com.github.alex1304.ultimategdbot.api.Database: Saves an object in database
scope() - Method in annotation type com.github.alex1304.ultimategdbot.api.command.annotated.CommandSpec
Scope - Enum in com.github.alex1304.ultimategdbot.api.command: The scope of a command, that is, the kind of channels where the command is applicable.
sendPaginatedMessage(Context, String) - Static method in class com.github.alex1304.ultimategdbot.api.utils.BotUtils
sendPaginatedMessage(Context, String, PaginationControls) - Static method in class com.github.alex1304.ultimategdbot.api.utils.BotUtils
sendPaginatedMessage(Context, String, PaginationControls, int) - Static method in class com.github.alex1304.ultimategdbot.api.utils.BotUtils
SERVER_ADMIN - com.github.alex1304.ultimategdbot.api.command.PermissionLevel
SERVER_MOD - com.github.alex1304.ultimategdbot.api.command.PermissionLevel
setErrorHandler(CommandErrorHandler) - Method in class com.github.alex1304.ultimategdbot.api.command.CommandProvider: Allows to supply a custom command handler.
setFromString(Session, String, long) - Method in class com.github.alex1304.ultimategdbot.api.database.GuildSettingsEntry
setGuildId(Long) - Method in interface com.github.alex1304.ultimategdbot.api.database.GuildSettings: Sets the guildID
setGuildId(Long) - Method in class com.github.alex1304.ultimategdbot.api.database.NativeGuildSettings
setId(Long) - Method in class com.github.alex1304.ultimategdbot.api.database.BlacklistedIds
setPrefix(String) - Method in class com.github.alex1304.ultimategdbot.api.database.NativeGuildSettings
setRaw(Session, D, long) - Method in class com.github.alex1304.ultimategdbot.api.database.GuildSettingsEntry
setServerModRoleId(Long) - Method in class com.github.alex1304.ultimategdbot.api.database.NativeGuildSettings
setup(Bot, PropertyParser) - Method in interface com.github.alex1304.ultimategdbot.api.Plugin: Code executed when the plugin is loaded.
setUserId(Long) - Method in class com.github.alex1304.ultimategdbot.api.database.BotAdmins
shortDescription() - Method in annotation type com.github.alex1304.ultimategdbot.api.command.annotated.CommandSpec
splitMessage(String) - Static method in class com.github.alex1304.ultimategdbot.api.utils.BotUtils: Splits a message into several chunks.
splitMessage(String, int) - Static method in class com.github.alex1304.ultimategdbot.api.utils.BotUtils: Splits a message into several chunks which size is specified.
spoiler(String) - Static method in class com.github.alex1304.ultimategdbot.api.utils.Markdown: Formats the text with spoiler markdown.
start() - Method in class com.github.alex1304.ultimategdbot.api.Bot
start() - Method in class com.github.alex1304.ultimategdbot.api.CommandKernel
strikethrough(String) - Static method in class com.github.alex1304.ultimategdbot.api.utils.Markdown: Formats the text with strikethrough markdown.
StringConverter - Class in com.github.alex1304.ultimategdbot.api.command.annotated.paramconverter
StringConverter() - Constructor for class com.github.alex1304.ultimategdbot.api.command.annotated.paramconverter.StringConverter
stringValue() - Static method in interface com.github.alex1304.ultimategdbot.api.utils.DatabaseOutputFunction: Forwards the value from the database by returning its string representation provided by Object.toString()
SystemUnit - Enum in com.github.alex1304.ultimategdbot.api.utils: Enumerates system units (bytes, kilobytes, etc until terabytes) Provides methods for conversion and formatting.

T

TERABYTE - com.github.alex1304.ultimategdbot.api.utils.SystemUnit
to(Function<? super String, D>) - Static method in interface com.github.alex1304.ultimategdbot.api.utils.DatabaseInputFunction: Converts the input using the supplied conversion function.
toChannelId(Bot, Class<? extends GuildChannel>) - Static method in interface com.github.alex1304.ultimategdbot.api.utils.DatabaseInputFunction: Converts the input into a channel and forwards its ID to the database.
tokenCount() - Method in class com.github.alex1304.ultimategdbot.api.command.ArgumentList: Gets the number of tokens (arguments) present in the list.
tokenize(String) - Static method in class com.github.alex1304.ultimategdbot.api.utils.InputTokenizer: Splits the input into tokens.
toMessageCreateSpec() - Method in class com.github.alex1304.ultimategdbot.api.utils.UniversalMessageSpec
toMessageEditSpec() - Method in class com.github.alex1304.ultimategdbot.api.utils.UniversalMessageSpec
toRoleId(Bot) - Static method in interface com.github.alex1304.ultimategdbot.api.utils.DatabaseInputFunction: Converts the input into a role and forwards its ID to the database.
toString() - Method in class com.github.alex1304.ultimategdbot.api.command.annotated.AnnotatedCommand
toString() - Method in class com.github.alex1304.ultimategdbot.api.command.ArgumentList
toString() - Method in class com.github.alex1304.ultimategdbot.api.command.CommandErrorHandler
toString() - Method in class com.github.alex1304.ultimategdbot.api.command.CommandProvider
toString() - Method in class com.github.alex1304.ultimategdbot.api.command.Context
toString() - Method in class com.github.alex1304.ultimategdbot.api.command.FlagSet
toString() - Method in enum com.github.alex1304.ultimategdbot.api.utils.SystemUnit
toUserId(Bot) - Static method in interface com.github.alex1304.ultimategdbot.api.utils.DatabaseInputFunction: Converts the input into a user and forwards its ID to the database.
type() - Method in class com.github.alex1304.ultimategdbot.api.command.annotated.paramconverter.GuildChannelConverter
type() - Method in class com.github.alex1304.ultimategdbot.api.command.annotated.paramconverter.IntConverter
type() - Method in class com.github.alex1304.ultimategdbot.api.command.annotated.paramconverter.LongConverter
type() - Method in interface com.github.alex1304.ultimategdbot.api.command.annotated.paramconverter.ParamConverter: Returns the type of object resulting of the parsing.
type() - Method in class com.github.alex1304.ultimategdbot.api.command.annotated.paramconverter.RoleConverter
type() - Method in class com.github.alex1304.ultimategdbot.api.command.annotated.paramconverter.StringConverter
type() - Method in class com.github.alex1304.ultimategdbot.api.command.annotated.paramconverter.UserConverter

U

unblacklist(long) - Method in class com.github.alex1304.ultimategdbot.api.CommandKernel: Removes an ID from the blacklist.
underline(String) - Static method in class com.github.alex1304.ultimategdbot.api.utils.Markdown: Formats the text with underline markdown.
UnexpectedReplyException - Exception in com.github.alex1304.ultimategdbot.api.utils.menu
UnexpectedReplyException(String) - Constructor for exception com.github.alex1304.ultimategdbot.api.utils.menu.UnexpectedReplyException
UniversalMessageSpec - Class in com.github.alex1304.ultimategdbot.api.utils: Message specification that is compatible with both MessageCreateSpec and MessageEditSpec.
UniversalMessageSpec(String) - Constructor for class com.github.alex1304.ultimategdbot.api.utils.UniversalMessageSpec
UniversalMessageSpec(String, Consumer<EmbedCreateSpec>) - Constructor for class com.github.alex1304.ultimategdbot.api.utils.UniversalMessageSpec
UniversalMessageSpec(Consumer<EmbedCreateSpec>) - Constructor for class com.github.alex1304.ultimategdbot.api.utils.UniversalMessageSpec
UserConverter - Class in com.github.alex1304.ultimategdbot.api.command.annotated.paramconverter
UserConverter() - Constructor for class com.github.alex1304.ultimategdbot.api.command.annotated.paramconverter.UserConverter

V

value() - Method in annotation type com.github.alex1304.ultimategdbot.api.command.annotated.CommandAction
value() - Method in annotation type com.github.alex1304.ultimategdbot.api.command.annotated.CommandDoc
value() - Method in annotation type com.github.alex1304.ultimategdbot.api.command.annotated.FlagDoc
valueFormat() - Method in annotation type com.github.alex1304.ultimategdbot.api.command.annotated.FlagInfo
valueOf(String) - Static method in enum com.github.alex1304.ultimategdbot.api.command.PermissionLevel: Returns the enum constant of this type with the specified name.
valueOf(String) - Static method in enum com.github.alex1304.ultimategdbot.api.command.Scope: Returns the enum constant of this type with the specified name.
valueOf(String) - Static method in enum com.github.alex1304.ultimategdbot.api.utils.SystemUnit: Returns the enum constant of this type with the specified name.
values() - Static method in enum com.github.alex1304.ultimategdbot.api.command.PermissionLevel: Returns an array containing the constants of this enum type, in the order they are declared.
values() - Static method in enum com.github.alex1304.ultimategdbot.api.command.Scope: Returns an array containing the constants of this enum type, in the order they are declared.
values() - Static method in enum com.github.alex1304.ultimategdbot.api.utils.SystemUnit: Returns an array containing the constants of this enum type, in the order they are declared.

W

withInputCheck(Predicate<String>, String) - Method in interface com.github.alex1304.ultimategdbot.api.utils.DatabaseInputFunction: Adds a check on the user input before this function is executed.
withLimiter(Publisher<T>) - Method in class com.github.alex1304.ultimategdbot.api.ClockRateLimiter
withValueCheck(Predicate<D>, String) - Method in interface com.github.alex1304.ultimategdbot.api.utils.DatabaseInputFunction: Adds a check on the value produced by this function, after the user input was process by this function.

A B C D E F G H I K L M N O P Q R S T U V W
All Classes All Packages