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
All Classes All Packages
All Classes All Packages
A
- 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.
- addDatabaseMappingRessources(String, String...) - Method in class com.github.alex1304.ultimategdbot.api.Plugin.Builder
-
Adds one or more resource paths where database mapping files are located.
- addGuildSettingsEntry(String, GuildSettingsEntry<?, ?>) - Method in class com.github.alex1304.ultimategdbot.api.Plugin.Builder
-
Adds a new entry to guild settings.
- 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.util.menu.InteractiveMenu
-
Adds an item to this menu that is triggered when replying with a specific message.
- 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.command.CommandKernel
-
Adds a new command provider to this kernel.
- addReactionItem(String, Function<ReactionMenuInteraction, Mono<Void>>) - Method in class com.github.alex1304.ultimategdbot.api.util.menu.InteractiveMenu
-
Adds an item to this menu that is triggered when adding or removing a reaction to the menu message.
- aliases() - Method in annotation type com.github.alex1304.ultimategdbot.api.command.annotated.CommandDescriptor
- 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(Publisher<T>) - Method in class com.github.alex1304.ultimategdbot.api.NewRateLimitOperator
- 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)
. - args() - Method in class com.github.alex1304.ultimategdbot.api.command.Context
-
Gets the arguments of the command.
- 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.util.DatabaseInputFunction
-
Forwards the input value to the database as is, without any modification or check.
- author() - Method in class com.github.alex1304.ultimategdbot.api.command.Context
-
Gets the author of the message that created this context.
B
- blacklist(long) - Method in class com.github.alex1304.ultimategdbot.api.command.CommandKernel
-
Blacklists a new ID.
- bold(String) - Static method in class com.github.alex1304.ultimategdbot.api.util.Markdown
-
Formats the text with bold markdown
- bot() - Method in class com.github.alex1304.ultimategdbot.api.command.Context
-
Gets the bot instance.
- Bot - Interface 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
- BotConfig - Class in com.github.alex1304.ultimategdbot.api
-
Holds the bot's configuration.
- BotConfig.Builder - Class in com.github.alex1304.ultimategdbot.api
- BotUtils - Class in com.github.alex1304.ultimategdbot.api.util
-
Contains various utility methods.
- build() - Method in class com.github.alex1304.ultimategdbot.api.BotConfig.Builder
-
Builds a
BotConfig
with the configured values. - build() - Method in class com.github.alex1304.ultimategdbot.api.command.FlagSet.FlagSetBuilder
- build() - Method in class com.github.alex1304.ultimategdbot.api.Plugin.Builder
-
Builds the plugin instance.
- builder() - Static method in class com.github.alex1304.ultimategdbot.api.command.FlagSet
-
Creates a builder to configure a new set of flags.
- builder(String) - Static method in class com.github.alex1304.ultimategdbot.api.BotConfig
-
Creates a new builder of
BotConfig
. - builder(String) - Static method in class com.github.alex1304.ultimategdbot.api.Plugin
-
Creates a new plugin builder with the specified name.
- BYTE - com.github.alex1304.ultimategdbot.api.util.SystemUnit
C
- channel() - Method in class com.github.alex1304.ultimategdbot.api.command.Context
-
Gets the channel of the message that created this context.
- check(int, int, int) - Static method in exception com.github.alex1304.ultimategdbot.api.util.menu.PageNumberOutOfRangeException
- closeAfterMessage(boolean) - Method in class com.github.alex1304.ultimategdbot.api.util.menu.InteractiveMenu
-
Sets whether to close this menu after a message item is triggered.
- closeAfterReaction(boolean) - Method in class com.github.alex1304.ultimategdbot.api.util.menu.InteractiveMenu
-
Sets whether to close this menu after a reaction item is triggered.
- code(String) - Static method in class com.github.alex1304.ultimategdbot.api.util.Markdown
-
Formats the text as code.
- codeBlock(String) - Static method in class com.github.alex1304.ultimategdbot.api.util.Markdown
-
Formats the text as a code block.
- codeBlock(String, String) - Static method in class com.github.alex1304.ultimategdbot.api.util.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.util - package com.github.alex1304.ultimategdbot.api.util
- com.github.alex1304.ultimategdbot.api.util.menu - package com.github.alex1304.ultimategdbot.api.util.menu
- command() - Method in class com.github.alex1304.ultimategdbot.api.command.Context
-
Gets the command that created this context.
- Command - Interface in com.github.alex1304.ultimategdbot.api.command
-
Represents a bot command.
- CommandAction - Annotation Type in com.github.alex1304.ultimategdbot.api.command.annotated
- CommandDescriptor - 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() - Method in interface com.github.alex1304.ultimategdbot.api.Bot
-
Gets the command kernel of this bot.
- commandKernel() - Method in class com.github.alex1304.ultimategdbot.api.SimpleBot
- CommandKernel - Class in com.github.alex1304.ultimategdbot.api.command
-
The command kernel coordinates the command providers from all plugins.
- CommandKernel(Bot) - Constructor for class com.github.alex1304.ultimategdbot.api.command.CommandKernel
- CommandPermission - Annotation Type in com.github.alex1304.ultimategdbot.api.command.annotated
- 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
- config() - Method in interface com.github.alex1304.ultimategdbot.api.Bot
-
Gets the config of the bot.
- config() - Method in class com.github.alex1304.ultimategdbot.api.SimpleBot
- configure(Set<String>) - Method in class com.github.alex1304.ultimategdbot.api.database.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.util.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() - Static method in class com.github.alex1304.ultimategdbot.api.NewBucketGlobalRateLimiter
-
Creates a new global rate limiter of 50 requests per second using
Schedulers.parallel()
to inject delays. - create(int, Duration, Scheduler) - Static method in class com.github.alex1304.ultimategdbot.api.NewBucketGlobalRateLimiter
-
Creates a new global rate limiter with the given parameters.
- create(BotConfig) - Static method in class com.github.alex1304.ultimategdbot.api.SimpleBot
-
Creates a new
SimpleBot
using the given config. - create(String) - Static method in class com.github.alex1304.ultimategdbot.api.util.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.util.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.util.menu.InteractiveMenu
-
Creates a new empty InteractiveMenu with a given message that will serve as menu prompt.
- createAsyncPaginated(AtomicInteger, PaginationControls, IntFunction<Mono<MessageSpecTemplate>>) - Static method in class com.github.alex1304.ultimategdbot.api.util.menu.InteractiveMenu
-
Creates a new InteractiveMenu prefilled with menu items useful for pagination.
- createPaginated(AtomicInteger, PaginationControls, IntFunction<MessageSpecTemplate>) - Static method in class com.github.alex1304.ultimategdbot.api.util.menu.InteractiveMenu
-
Creates a new InteractiveMenu prefilled with menu items useful for pagination.
D
- database() - Method in interface com.github.alex1304.ultimategdbot.api.Bot
-
Gets the database of the bot.
- database() - Method in class com.github.alex1304.ultimategdbot.api.SimpleBot
- Database - Class in com.github.alex1304.ultimategdbot.api.database
-
Manages interactions with the database.
- Database() - Constructor for class com.github.alex1304.ultimategdbot.api.database.Database
- DatabaseException - Exception in com.github.alex1304.ultimategdbot.api.database
- DatabaseException(Throwable) - Constructor for exception com.github.alex1304.ultimategdbot.api.database.DatabaseException
- DatabaseInputFunction<D> - Interface in com.github.alex1304.ultimategdbot.api.util
-
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.util
-
Function that determines the string to display to the user after reading the value from teh database.
- DEFAULT_CLOSE_EMOJI - Static variable in class com.github.alex1304.ultimategdbot.api.util.menu.PaginationControls
- DEFAULT_COMMAND_PREFIX - Static variable in class com.github.alex1304.ultimategdbot.api.BotConfig
- DEFAULT_FLAG_PREFIX - Static variable in class com.github.alex1304.ultimategdbot.api.BotConfig
- DEFAULT_INTERACTIVE_MENU_TIMEOUT - Static variable in class com.github.alex1304.ultimategdbot.api.BotConfig
- DEFAULT_MESSAGE_CACHE_MAX_SIZE - Static variable in class com.github.alex1304.ultimategdbot.api.BotConfig
- DEFAULT_NEXT_EMOJI - Static variable in class com.github.alex1304.ultimategdbot.api.util.menu.PaginationControls
- DEFAULT_PREVIOUS_EMOJI - Static variable in class com.github.alex1304.ultimategdbot.api.util.menu.PaginationControls
- DEFAULT_REST_BUFFER_SIZE - Static variable in class com.github.alex1304.ultimategdbot.api.BotConfig
- DEFAULT_REST_TIMEOUT - Static variable in class com.github.alex1304.ultimategdbot.api.BotConfig
- DEFAULT_STATUS - Static variable in class com.github.alex1304.ultimategdbot.api.BotConfig
- delete(Object) - Method in class com.github.alex1304.ultimategdbot.api.database.Database
-
Deletes an object from database
- deleteMenuOnClose(boolean) - Method in class com.github.alex1304.ultimategdbot.api.util.menu.InteractiveMenu
-
Sets whether to delete the menu message when the menu is closed by user.
- deleteMenuOnTimeout(boolean) - Method in class com.github.alex1304.ultimategdbot.api.util.menu.InteractiveMenu
-
Sets whether to delete the menu message when the menu is closed automatically by timeout
- description() - Method in annotation type com.github.alex1304.ultimategdbot.api.command.annotated.FlagInfo
- DiscordFormatter - Class in com.github.alex1304.ultimategdbot.api.util
-
Contains utility methods to format a Discord entity into a user-friendly String.
- DiscordParser - Class in com.github.alex1304.ultimategdbot.api.util
-
Contains utility methods to parse a user input into a Discord entity.
- DM_ONLY - com.github.alex1304.ultimategdbot.api.command.Scope
E
- emoji(String) - Method in interface com.github.alex1304.ultimategdbot.api.Bot
-
Gets the String representation of an emoji installed on one of the emoji servers.
- emoji(String) - Method in class com.github.alex1304.ultimategdbot.api.SimpleBot
- EMPTY - Static variable in interface com.github.alex1304.ultimategdbot.api.util.PropertyReader
-
A
PropertyReader
that doesn't contain any property. - escape(String) - Static method in class com.github.alex1304.ultimategdbot.api.util.Markdown
-
Escapes characters used in Markdown syntax using a backslash
- event() - Method in class com.github.alex1304.ultimategdbot.api.command.Context
-
Gets the message create event associated to this command.
- 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.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
- flags() - Method in class com.github.alex1304.ultimategdbot.api.command.Context
- 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.util.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.util.BotUtils
-
Formats a Duration into a human readable String.
- formatGuildChannel(GuildChannel) - Static method in class com.github.alex1304.ultimategdbot.api.util.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.util.DiscordFormatter
-
Formats a role to the following format: @name (id)
- from(Function<? super D, String>) - Static method in interface com.github.alex1304.ultimategdbot.api.util.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.util.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.util.DatabaseOutputFunction
-
Reads the database value as a channel ID, attempts to convert it to a channel and gives a string representation of this channel.
- fromProperties(Properties) - Static method in interface com.github.alex1304.ultimategdbot.api.util.PropertyReader
-
Creates a new
PropertyReader
reading properties from the givenProperties
object. - fromPropertiesFile(Path) - Static method in interface com.github.alex1304.ultimategdbot.api.util.PropertyReader
-
Reads the properties from a Java properties file located at the given
Path
. - fromRoleId(Bot) - Static method in interface com.github.alex1304.ultimategdbot.api.util.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.util.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.util.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
User.getTag()
. - fromUserId(Bot, Function<? super User, String>) - Static method in interface com.github.alex1304.ultimategdbot.api.util.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
- gateway() - Method in interface com.github.alex1304.ultimategdbot.api.Bot
-
Gets the gateway client of the bot.
- gateway() - Method in class com.github.alex1304.ultimategdbot.api.SimpleBot
- 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.util.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).
- getArgs() - Method in class com.github.alex1304.ultimategdbot.api.util.menu.MessageMenuInteraction
- getAsString(Session, long) - Method in class com.github.alex1304.ultimategdbot.api.database.GuildSettingsEntry
- getChannel() - Method in class com.github.alex1304.ultimategdbot.api.util.menu.ReactionToggleEvent
- getChannelId() - Method in class com.github.alex1304.ultimategdbot.api.util.menu.ReactionToggleEvent
- getCloseEmoji() - Method in class com.github.alex1304.ultimategdbot.api.util.menu.PaginationControls
- 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.CommandKernel
-
Gets a command instance corresponding to the given alias.
- getCommandByAlias(String) - Method in class com.github.alex1304.ultimategdbot.api.command.CommandProvider
-
Gets a command instance corresponding to the given alias.
- getCommandPrefix() - Method in class com.github.alex1304.ultimategdbot.api.BotConfig
-
Gets the prefix to use for commands.
- getCommandProvider() - Method in class com.github.alex1304.ultimategdbot.api.Plugin
-
Gets the command provider for this plugin.
- getContent() - Method in class com.github.alex1304.ultimategdbot.api.util.MessageSpecTemplate
- getContext() - Method in class com.github.alex1304.ultimategdbot.api.command.ExecutableCommand
-
Gets the context of the command.
- getDatabaseMappingResources() - Method in class com.github.alex1304.ultimategdbot.api.Plugin
-
Gets a set of resource names that corresponds to database mapping files.
- getDebugLogChannelId() - Method in class com.github.alex1304.ultimategdbot.api.BotConfig
-
Gets the channel ID where the bot will send debug log messages, if present.
- getDefault() - Static method in class com.github.alex1304.ultimategdbot.api.util.menu.PaginationControls
- 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.
- 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.util.MessageSpecTemplate
- getEmoji() - Method in class com.github.alex1304.ultimategdbot.api.util.menu.ReactionToggleEvent
- getEmojiGuildIds() - Method in class com.github.alex1304.ultimategdbot.api.BotConfig
-
Gets the guild IDs where the bot will look for emojis.
- 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.util.menu.MessageMenuInteraction
- getEvent() - Method in class com.github.alex1304.ultimategdbot.api.util.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.
- getFlagPrefix() - Method in class com.github.alex1304.ultimategdbot.api.BotConfig
-
Gets the prefix to use for command flags.
- getFlags() - Method in class com.github.alex1304.ultimategdbot.api.util.menu.MessageMenuInteraction
- getGitProperties() - Method in class com.github.alex1304.ultimategdbot.api.Plugin
-
Gets the Git properties for this plugin.
- getGuild() - Method in class com.github.alex1304.ultimategdbot.api.util.menu.ReactionToggleEvent
- getGuildConfigurationEntries() - Method in class 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.util.menu.ReactionToggleEvent
- getInteractiveMenuTimeout() - Method in class com.github.alex1304.ultimategdbot.api.BotConfig
-
Gets the timeout after which interactive menus will automatically close.
- getMaxPage() - Method in exception com.github.alex1304.ultimategdbot.api.util.menu.PageNumberOutOfRangeException
- getMessage() - Method in class com.github.alex1304.ultimategdbot.api.util.menu.ReactionToggleEvent
- getMessageCacheMaxSize() - Method in class com.github.alex1304.ultimategdbot.api.BotConfig
-
Gets the maximum size of the message cache.
- getMessageId() - Method in class com.github.alex1304.ultimategdbot.api.util.menu.ReactionToggleEvent
- getMinimumPermissionLevel() - Method in class com.github.alex1304.ultimategdbot.api.command.annotated.AnnotatedCommand
- getMinimumPermissionLevel() - Method in interface com.github.alex1304.ultimategdbot.api.command.Command
-
Gets the permission level required to use the command.
- getMinPage() - Method in exception com.github.alex1304.ultimategdbot.api.util.menu.PageNumberOutOfRangeException
- getName() - Method in class com.github.alex1304.ultimategdbot.api.Plugin
-
Gets the name of the plugin.
- getNextEmoji() - Method in class com.github.alex1304.ultimategdbot.api.util.menu.PaginationControls
- getPaginationControls() - Method in class com.github.alex1304.ultimategdbot.api.BotConfig
-
Gets the pagination controls to use for interactive menus.
- getPermissionChecker() - Method in class com.github.alex1304.ultimategdbot.api.command.CommandKernel
-
Gets the permission checker used to check permissions for commands provided by this kernel.
- getPermissionChecker() - Method in class com.github.alex1304.ultimategdbot.api.command.CommandProvider
-
Gets the permission checker assigned to this provider.
- getPreviousEmoji() - Method in class com.github.alex1304.ultimategdbot.api.util.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.NewBucketGlobalRateLimiter
- getRequiredPermission() - Method in class com.github.alex1304.ultimategdbot.api.command.annotated.AnnotatedCommand
- getRequiredPermission() - Method in interface com.github.alex1304.ultimategdbot.api.command.Command
-
Gets the name of the permission required to use the command.
- getRestBufferSize() - Method in class com.github.alex1304.ultimategdbot.api.BotConfig
-
Gets the buffer size for Discord REST requests.
- getRestTimeout() - Method in class com.github.alex1304.ultimategdbot.api.BotConfig
-
Gets the timeout to apply on each Discord REST request.
- 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 scope of this command.
- getShortDescription() - Method in class com.github.alex1304.ultimategdbot.api.command.CommandDocumentation
-
Gets the short description of the command.
- getStatus() - Method in class com.github.alex1304.ultimategdbot.api.BotConfig
-
Gets the initial bot's status.
- 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.BotConfig
-
Gets 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.util.menu.ReactionToggleEvent
- getUserId() - Method in class com.github.alex1304.ultimategdbot.api.util.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.util.SystemUnit
- GUILD_ADMIN - com.github.alex1304.ultimategdbot.api.command.PermissionLevel
- GUILD_HEAD_STAFF - com.github.alex1304.ultimategdbot.api.command.PermissionLevel
- GUILD_ONLY - com.github.alex1304.ultimategdbot.api.command.Scope
- GUILD_OWNER - com.github.alex1304.ultimategdbot.api.command.PermissionLevel
- GUILD_REGULAR_MEMBER - com.github.alex1304.ultimategdbot.api.command.PermissionLevel
- GUILD_STAFF - com.github.alex1304.ultimategdbot.api.command.PermissionLevel
- GUILD_TRUSTED_MEMBER - com.github.alex1304.ultimategdbot.api.command.PermissionLevel
- 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
- HiddenCommand - Annotation Type in com.github.alex1304.ultimategdbot.api.command.annotated
I
- initPluginProperties() - Method in interface com.github.alex1304.ultimategdbot.api.PluginBootstrap
-
Initializes the plugin properties.
- InputTokenizer - Class in com.github.alex1304.ultimategdbot.api.util
-
Utility methods to split an input into tokens and recognize which are flags and which are arguments.
- 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.util.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
- isAddEvent() - Method in class com.github.alex1304.ultimategdbot.api.util.menu.ReactionToggleEvent
- isGranted(PermissionLevel, Context) - Method in class com.github.alex1304.ultimategdbot.api.command.PermissionChecker
-
Checks whether the given permission level is granted in the specified context.
- isGranted(String, Context) - Method in class com.github.alex1304.ultimategdbot.api.command.PermissionChecker
-
Checks whether the given permission is granted in the specified context.
- 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.util.Markdown
-
Formats the text with italic markdown.
- italic(String, boolean) - Static method in class com.github.alex1304.ultimategdbot.api.util.Markdown
-
Formats the text with italic markdown
K
- KILOBYTE - com.github.alex1304.ultimategdbot.api.util.SystemUnit
L
- level() - Method in annotation type com.github.alex1304.ultimategdbot.api.command.annotated.CommandPermission
- log(String) - Method in interface com.github.alex1304.ultimategdbot.api.Bot
-
Sends a message into the debug log channel.
- log(String) - Method in class com.github.alex1304.ultimategdbot.api.SimpleBot
- logCommandError(Logger, Context, Throwable) - Static method in class com.github.alex1304.ultimategdbot.api.util.BotUtils
- 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.util
- maskedLink(String, String) - Static method in class com.github.alex1304.ultimategdbot.api.util.Markdown
-
Make a masked link using markdown.
- MEGABYTE - com.github.alex1304.ultimategdbot.api.util.SystemUnit
- MessageMenuInteraction - Class in com.github.alex1304.ultimategdbot.api.util.menu
- MessageSpecTemplate - Class in com.github.alex1304.ultimategdbot.api.util
-
Message specification that is compatible with both
MessageCreateSpec
andMessageEditSpec
. - MessageSpecTemplate(String) - Constructor for class com.github.alex1304.ultimategdbot.api.util.MessageSpecTemplate
- MessageSpecTemplate(String, Consumer<EmbedCreateSpec>) - Constructor for class com.github.alex1304.ultimategdbot.api.util.MessageSpecTemplate
- MessageSpecTemplate(Consumer<EmbedCreateSpec>) - Constructor for class com.github.alex1304.ultimategdbot.api.util.MessageSpecTemplate
N
- name() - Method in annotation type com.github.alex1304.ultimategdbot.api.command.annotated.CommandPermission
- name() - Method in annotation type com.github.alex1304.ultimategdbot.api.command.annotated.FlagInfo
- NewBucketGlobalRateLimiter - Class in com.github.alex1304.ultimategdbot.api
-
An implementation of
GlobalRateLimiter
that uses aNewRateLimitOperator
coordinate requests, injecting an additional delay if a source trips the limiter early throughNewBucketGlobalRateLimiter.rateLimitFor(Duration)
. - NewRateLimitOperator<T> - Class in com.github.alex1304.ultimategdbot.api
-
A rate limiting operator based off the token bucket algorithm.
- NewRateLimitOperator(int, Duration) - Constructor for class com.github.alex1304.ultimategdbot.api.NewRateLimitOperator
- NewRateLimitOperator(int, Duration, Scheduler) - Constructor for class com.github.alex1304.ultimategdbot.api.NewRateLimitOperator
O
- of(BiFunction<D, Long, Mono<String>>) - Static method in interface com.github.alex1304.ultimategdbot.api.util.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.util.DatabaseInputFunction
-
Encapsulates a regular BiFunction into an instance of
DatabaseInputFunction
. - onReady(Supplier<Mono<Void>>) - Method in class com.github.alex1304.ultimategdbot.api.Plugin.Builder
- open(Context) - Method in class com.github.alex1304.ultimategdbot.api.util.menu.InteractiveMenu
-
Opens the interactive menu, that is, sends the menu message over Discord and starts listening for user's interaction.
- owner() - Method in interface com.github.alex1304.ultimategdbot.api.Bot
-
Gets the bot owner.
- owner() - Method in class com.github.alex1304.ultimategdbot.api.SimpleBot
P
- PageNumberOutOfRangeException - Exception in com.github.alex1304.ultimategdbot.api.util.menu
- PageNumberOutOfRangeException(int, int, int) - Constructor for exception com.github.alex1304.ultimategdbot.api.util.menu.PageNumberOutOfRangeException
- PaginationControls - Class in com.github.alex1304.ultimategdbot.api.util.menu
- PaginationControls(String, String, String) - Constructor for class com.github.alex1304.ultimategdbot.api.util.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.
- parseGuildChannel(Bot, Snowflake, String) - Static method in class com.github.alex1304.ultimategdbot.api.util.DiscordParser
-
Parses the input into a Discord channel.
- parseRole(Bot, Snowflake, String) - Static method in class com.github.alex1304.ultimategdbot.api.util.DiscordParser
-
Parses the input into a Discord role.
- parseUser(Bot, String) - Static method in class com.github.alex1304.ultimategdbot.api.util.DiscordParser
-
Parses the input into a Discord user.
- performEmptyTransaction(Consumer<Session>) - Method in class com.github.alex1304.ultimategdbot.api.database.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.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.Database
-
Allows to manipulate a Session in an asynchronous context.
- PermissionChecker - Class in com.github.alex1304.ultimategdbot.api.command
-
Class used to check permissions for using a command.
- PermissionChecker() - Constructor for class com.github.alex1304.ultimategdbot.api.command.PermissionChecker
- 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
- Plugin - Class in com.github.alex1304.ultimategdbot.api
-
Represents a plugin.
- Plugin.Builder - Class in com.github.alex1304.ultimategdbot.api
- PluginBootstrap - Interface in com.github.alex1304.ultimategdbot.api
-
Configures and creates a plugin.
- plugins() - Method in interface com.github.alex1304.ultimategdbot.api.Bot
-
Gets a Set containing all successfully loaded plugins.
- plugins() - Method in class com.github.alex1304.ultimategdbot.api.SimpleBot
- prefixUsed() - Method in class com.github.alex1304.ultimategdbot.api.command.Context
-
Gets the prefix used in the command that created this context.
- processEvent(MessageCreateEvent) - Method in class com.github.alex1304.ultimategdbot.api.command.CommandKernel
-
Processes a MessageCreateEvent.
- PropertyReader - Interface in com.github.alex1304.ultimategdbot.api.util
-
Allows to read values from an abstracted source of properties.
- 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.Database
-
Makes a simple query to the database.
- quote(String) - Static method in class com.github.alex1304.ultimategdbot.api.util.Markdown
-
Formats the text as a quote.
R
- rateLimitFor(Duration) - Method in class com.github.alex1304.ultimategdbot.api.NewBucketGlobalRateLimiter
- ReactionMenuInteraction - Class in com.github.alex1304.ultimategdbot.api.util.menu
- ReactionToggleEvent - Class in com.github.alex1304.ultimategdbot.api.util.menu
- ReactionToggleEvent(Event) - Constructor for class com.github.alex1304.ultimategdbot.api.util.menu.ReactionToggleEvent
- read(String) - Method in interface com.github.alex1304.ultimategdbot.api.util.PropertyReader
-
Reads a value associated with the given key.
- readAs(String, Function<? super String, ? extends T>) - Method in interface com.github.alex1304.ultimategdbot.api.util.PropertyReader
-
Reads the value associated with the given key and maps it to an object via the given function.
- readAsStream(String, String) - Method in interface com.github.alex1304.ultimategdbot.api.util.PropertyReader
-
Reads the value as a stream of values, each element being separated with a separator character.
- readOptional(String) - Method in interface com.github.alex1304.ultimategdbot.api.util.PropertyReader
-
Reads a value associated with the given key, if present.
- register(PermissionLevel, Function<Context, Mono<Boolean>>) - Method in class com.github.alex1304.ultimategdbot.api.command.PermissionChecker
-
Registers a new permission into this checker.
- register(String, Function<Context, Mono<Boolean>>) - Method in class com.github.alex1304.ultimategdbot.api.command.PermissionChecker
-
Registers a new permission into this checker.
- registerAll(PermissionChecker) - Method in class com.github.alex1304.ultimategdbot.api.command.PermissionChecker
-
Copies all permissions registered in the specified permission checker into this one.
- 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.
- rest() - Method in interface com.github.alex1304.ultimategdbot.api.Bot
-
Gets the REST client of the bot.
- rest() - Method in class com.github.alex1304.ultimategdbot.api.SimpleBot
- 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
- runOnReady() - Method in class com.github.alex1304.ultimategdbot.api.Plugin
S
- save(Object) - Method in class com.github.alex1304.ultimategdbot.api.database.Database
-
Saves an object in database
- scope() - Method in annotation type com.github.alex1304.ultimategdbot.api.command.annotated.CommandDescriptor
- 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.util.BotUtils
- sendPaginatedMessage(Context, String, PaginationControls) - Static method in class com.github.alex1304.ultimategdbot.api.util.BotUtils
- sendPaginatedMessage(Context, String, PaginationControls, int) - Static method in class com.github.alex1304.ultimategdbot.api.util.BotUtils
- setCommandPrefix(String) - Method in class com.github.alex1304.ultimategdbot.api.BotConfig.Builder
-
Sets the prefix to use for commands.
- setCommandProvider(CommandProvider) - Method in class com.github.alex1304.ultimategdbot.api.Plugin.Builder
-
Sets the command provider for this plugin.
- setDebugLogChannelId(Snowflake) - Method in class com.github.alex1304.ultimategdbot.api.BotConfig.Builder
-
Sets the channel ID where the bot will send debug log messages.
- setEmojiGuildIds(Set<Snowflake>) - Method in class com.github.alex1304.ultimategdbot.api.BotConfig.Builder
-
Sets the guild IDs where the bot will look for emojis.
- setErrorHandler(CommandErrorHandler) - Method in class com.github.alex1304.ultimategdbot.api.command.CommandProvider
-
Sets a custom command handler.
- setFlagPrefix(String) - Method in class com.github.alex1304.ultimategdbot.api.BotConfig.Builder
-
Sets the prefix to use for command flags.
- 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
- setInteractiveMenuTimeout(Duration) - Method in class com.github.alex1304.ultimategdbot.api.BotConfig.Builder
-
Sets the timeout after which interactive menus will automatically close.
- setMessageCacheMaxSize(int) - Method in class com.github.alex1304.ultimategdbot.api.BotConfig.Builder
-
Sets the maximum size of the message cache.
- setPaginationControls(PaginationControls) - Method in class com.github.alex1304.ultimategdbot.api.BotConfig.Builder
-
Sets the pagination controls to use for interative menus.
- setPermissionChecker(PermissionChecker) - Method in class com.github.alex1304.ultimategdbot.api.command.CommandProvider
-
Sets a custom permission checker.
- setPrefixForGuild(long, String) - Method in class com.github.alex1304.ultimategdbot.api.command.CommandKernel
-
Sets a prefix specific for the given guild.
- setRaw(Session, D, long) - Method in class com.github.alex1304.ultimategdbot.api.database.GuildSettingsEntry
- setRestBufferSize(int) - Method in class com.github.alex1304.ultimategdbot.api.BotConfig.Builder
-
Sets the buffer size for Discord REST requests.
- setRestTimeout(Duration) - Method in class com.github.alex1304.ultimategdbot.api.BotConfig.Builder
-
Sets the timeout to apply on each Discord REST request.
- setStatus(StatusUpdate) - Method in class com.github.alex1304.ultimategdbot.api.BotConfig.Builder
-
Sets the initial bot's status.
- setup(Bot, PropertyReader) - Method in interface com.github.alex1304.ultimategdbot.api.PluginBootstrap
-
Creates a
Plugin
derived from the given bot and properties. - shortDescription() - Method in annotation type com.github.alex1304.ultimategdbot.api.command.annotated.CommandDescriptor
- SimpleBot - Class in com.github.alex1304.ultimategdbot.api
-
Basic implementation of a Discord bot, configured with default Discord4J settings.
- splitMessage(String) - Static method in class com.github.alex1304.ultimategdbot.api.util.BotUtils
-
Splits a message into several chunks.
- splitMessage(String, int) - Static method in class com.github.alex1304.ultimategdbot.api.util.BotUtils
-
Splits a message into several chunks which size is specified.
- spoiler(String) - Static method in class com.github.alex1304.ultimategdbot.api.util.Markdown
-
Formats the text with spoiler markdown.
- start() - Method in interface com.github.alex1304.ultimategdbot.api.Bot
-
Starts the bot.
- start() - Method in class com.github.alex1304.ultimategdbot.api.command.CommandKernel
-
Starts listening to message create events.
- start() - Method in class com.github.alex1304.ultimategdbot.api.SimpleBot
- strikethrough(String) - Static method in class com.github.alex1304.ultimategdbot.api.util.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.util.DatabaseOutputFunction
-
Forwards the value from the database by returning its string representation provided by
Object.toString()
- SystemUnit - Enum in com.github.alex1304.ultimategdbot.api.util
-
Enumerates system units (bytes, kilobytes, etc until terabytes) Provides methods for conversion and formatting.
T
- TERABYTE - com.github.alex1304.ultimategdbot.api.util.SystemUnit
- to(Function<? super String, D>) - Static method in interface com.github.alex1304.ultimategdbot.api.util.DatabaseInputFunction
-
Converts the input using the supplied conversion function.
- toChannelId(Bot, Class<? extends GuildChannel>) - Static method in interface com.github.alex1304.ultimategdbot.api.util.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, String) - Static method in class com.github.alex1304.ultimategdbot.api.util.InputTokenizer
-
Splits the input into tokens.
- toMessageCreateSpec() - Method in class com.github.alex1304.ultimategdbot.api.util.MessageSpecTemplate
- toMessageEditSpec() - Method in class com.github.alex1304.ultimategdbot.api.util.MessageSpecTemplate
- toRoleId(Bot) - Static method in interface com.github.alex1304.ultimategdbot.api.util.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.ExecutableCommand
- toString() - Method in class com.github.alex1304.ultimategdbot.api.command.FlagSet
- toString() - Method in enum com.github.alex1304.ultimategdbot.api.util.SystemUnit
- toUserId(Bot) - Static method in interface com.github.alex1304.ultimategdbot.api.util.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.command.CommandKernel
-
Removes an ID from the blacklist.
- underline(String) - Static method in class com.github.alex1304.ultimategdbot.api.util.Markdown
-
Formats the text with underline markdown.
- UnexpectedReplyException - Exception in com.github.alex1304.ultimategdbot.api.util.menu
- UnexpectedReplyException(String) - Constructor for exception com.github.alex1304.ultimategdbot.api.util.menu.UnexpectedReplyException
- 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.util.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.util.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.util.DatabaseInputFunction
-
Adds a check on the user input before this function is executed.
- withLimiter(Publisher<T>) - Method in class com.github.alex1304.ultimategdbot.api.NewBucketGlobalRateLimiter
- withTimeout(Duration) - Method in class com.github.alex1304.ultimategdbot.api.util.menu.InteractiveMenu
-
Sets a timeou after which the menu automatically closes.
- withValueCheck(Predicate<D>, String) - Method in interface com.github.alex1304.ultimategdbot.api.util.DatabaseInputFunction
-
Adds a check on the value produced by this function, after the user input was process by this function.
All Classes All Packages