A B C D E F G H I 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
- accept(ConfigEntryVisitor<R>) - Method in class com.github.alex1304.ultimategdbot.api.database.guildconfig.BooleanConfigEntry
- accept(ConfigEntryVisitor<R>) - Method in interface com.github.alex1304.ultimategdbot.api.database.guildconfig.ConfigEntry
-
Accepts a visitor to visit the concrete type of this config entry.
- accept(ConfigEntryVisitor<R>) - Method in class com.github.alex1304.ultimategdbot.api.database.guildconfig.GuildChannelConfigEntry
- accept(ConfigEntryVisitor<R>) - Method in class com.github.alex1304.ultimategdbot.api.database.guildconfig.GuildMemberConfigEntry
- accept(ConfigEntryVisitor<R>) - Method in class com.github.alex1304.ultimategdbot.api.database.guildconfig.GuildRoleConfigEntry
- accept(ConfigEntryVisitor<R>) - Method in class com.github.alex1304.ultimategdbot.api.database.guildconfig.IntegerConfigEntry
- accept(ConfigEntryVisitor<R>) - Method in class com.github.alex1304.ultimategdbot.api.database.guildconfig.LongConfigEntry
- accept(ConfigEntryVisitor<R>) - Method in class com.github.alex1304.ultimategdbot.api.database.guildconfig.StringConfigEntry
- 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
- addAllFromModule(Module) - Method in class com.github.alex1304.ultimategdbot.api.command.CommandProvider
-
Scans the module path and adds all commands that are found in the given module.
- addAllFromModule(Module, Predicate<String>) - Method in class com.github.alex1304.ultimategdbot.api.command.CommandProvider
-
Scans the module path and adds all commands that are found in the given module.
- addAnnotated(Object) - Method in class com.github.alex1304.ultimategdbot.api.command.CommandProvider
-
Adds an annotated object as a command into this provider.
- addCommandProvider(CommandService, CommandProvider) - Method in class com.github.alex1304.ultimategdbot.api.service.RootServiceSetupHelper
- addCommandProvider(CommandService, CommandProvider, Predicate<String>) - Method in class com.github.alex1304.ultimategdbot.api.service.RootServiceSetupHelper
- addEntry(ConfigEntryBuilder<D, ?>) - Method in class com.github.alex1304.ultimategdbot.api.database.guildconfig.GuildConfigurator.Builder
-
Adds a new entry to this configurator.
- addGuildConfigurator(Class<? extends GuildConfigDao<D>>, BiFunction<? super D, ? super Translator, GuildConfigurator<D>>) - Method in class com.github.alex1304.ultimategdbot.api.database.DatabaseService
-
Registers a guild configurator to this database.
- 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.command.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.CommandProvider
-
Adds a new param converter to this annotated command provider.
- addProvider(CommandProvider) - Method in class com.github.alex1304.ultimategdbot.api.command.CommandService
-
Adds a new command provider to this kernel.
- addReactionItem(String, Function<ReactionMenuInteraction, Mono<Void>>) - Method in class com.github.alex1304.ultimategdbot.api.command.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
- all() - Method in class com.github.alex1304.ultimategdbot.api.metadata.PluginMetadataService
-
Gets an immutable set of metadata of all plugins loaded in the bot.
- allowingAll() - Static method in interface com.github.alex1304.ultimategdbot.api.database.guildconfig.Validator
-
Creates a validator that allows all values.
- allowingIf(Predicate<? super T>, String) - Static method in interface com.github.alex1304.ultimategdbot.api.database.guildconfig.Validator
-
Creates a validator that allows the value if the predicate is matched, with the given failure message if the validation doesn't pass.
- allowingWhen(Function<? super T, ? extends Publisher<Boolean>>, String) - Static method in interface com.github.alex1304.ultimategdbot.api.database.guildconfig.Validator
-
Creates a validator that allows the value if the Publisher emits true, with the given failure message if the validation doesn't pass.
- and(Validator<T>) - Method in interface com.github.alex1304.ultimategdbot.api.database.guildconfig.Validator
-
Creates a validator that allows the value if BOTH this validator AND the given one allow the value.
- AnnotatedCommand - Class in com.github.alex1304.ultimategdbot.api.command.annotated
-
Command implemented via annotations.
- ANYWHERE - com.github.alex1304.ultimategdbot.api.command.Scope
- API_GIT_RESOURCE - Static variable in class com.github.alex1304.ultimategdbot.api.util.VersionUtils
- 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
- 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.CommandService
-
Blacklists a new ID.
- bold(String) - Static method in class com.github.alex1304.ultimategdbot.api.util.Markdown
-
Formats the text with bold markdown
- BooleanConfigEntry - Class in com.github.alex1304.ultimategdbot.api.database.guildconfig
- BOT - Static variable in class com.github.alex1304.ultimategdbot.api.service.CommonServices
- 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
-
Contains configuration resources for the bot.
- BotService - Class in com.github.alex1304.ultimategdbot.api.service
- BotService(GatewayDiscordClient, CommandService, DatabaseService, EmojiService, InteractiveMenuService, LocalizationService, LoggingService, PluginMetadataService) - Constructor for class com.github.alex1304.ultimategdbot.api.service.BotService
- build() - Method in class com.github.alex1304.ultimategdbot.api.command.FlagSet.FlagSetBuilder
- build() - Method in class com.github.alex1304.ultimategdbot.api.database.guildconfig.GuildConfigurator.Builder
-
Builds the configurator with all the attributes previously set.
- build() - Method in class com.github.alex1304.ultimategdbot.api.PluginMetadata.Builder
-
Builds the
PluginMetadata
object. - 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.database.guildconfig.BooleanConfigEntry
-
Creates a builder for this ConfigEntry implementation.
- builder(String) - Static method in class com.github.alex1304.ultimategdbot.api.database.guildconfig.GuildChannelConfigEntry
-
Creates a builder for this ConfigEntry implementation.
- builder(String) - Static method in class com.github.alex1304.ultimategdbot.api.database.guildconfig.GuildMemberConfigEntry
-
Creates a builder for this ConfigEntry implementation.
- builder(String) - Static method in class com.github.alex1304.ultimategdbot.api.database.guildconfig.GuildRoleConfigEntry
-
Creates a builder for this ConfigEntry implementation.
- builder(String) - Static method in class com.github.alex1304.ultimategdbot.api.database.guildconfig.IntegerConfigEntry
-
Creates a builder for this ConfigEntry implementation.
- builder(String) - Static method in class com.github.alex1304.ultimategdbot.api.database.guildconfig.LongConfigEntry
-
Creates a builder for this ConfigEntry implementation.
- builder(String) - Static method in class com.github.alex1304.ultimategdbot.api.database.guildconfig.StringConfigEntry
-
Creates a builder for this ConfigEntry implementation.
- builder(String) - Static method in class com.github.alex1304.ultimategdbot.api.PluginMetadata
-
Initiates a builder for a
PluginMetadata
. - builder(String, D, Class<? extends GuildConfigDao<D>>) - Static method in class com.github.alex1304.ultimategdbot.api.database.guildconfig.GuildConfigurator
-
Creates a new configurator builder with the given name and initial data.
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.command.menu.PageNumberOutOfRangeException
- chunk(String) - Static method in class com.github.alex1304.ultimategdbot.api.util.MessageUtils
-
Splits a message into several chunks.
- chunk(String, int) - Static method in class com.github.alex1304.ultimategdbot.api.util.MessageUtils
-
Splits a message into several chunks which size is specified.
- closeAfterMessage(boolean) - Method in class com.github.alex1304.ultimategdbot.api.command.menu.InteractiveMenu
-
Sets whether to close this menu after a message item is triggered.
- closeAfterReaction(boolean) - Method in class com.github.alex1304.ultimategdbot.api.command.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.command.menu - package com.github.alex1304.ultimategdbot.api.command.menu
- com.github.alex1304.ultimategdbot.api.database - package com.github.alex1304.ultimategdbot.api.database
- com.github.alex1304.ultimategdbot.api.database.guildconfig - package com.github.alex1304.ultimategdbot.api.database.guildconfig
- com.github.alex1304.ultimategdbot.api.emoji - package com.github.alex1304.ultimategdbot.api.emoji
- com.github.alex1304.ultimategdbot.api.localization - package com.github.alex1304.ultimategdbot.api.localization
- com.github.alex1304.ultimategdbot.api.logging - package com.github.alex1304.ultimategdbot.api.logging
- com.github.alex1304.ultimategdbot.api.metadata - package com.github.alex1304.ultimategdbot.api.metadata
- com.github.alex1304.ultimategdbot.api.service - package com.github.alex1304.ultimategdbot.api.service
- com.github.alex1304.ultimategdbot.api.util - package com.github.alex1304.ultimategdbot.api.util
- command() - Method in class com.github.alex1304.ultimategdbot.api.command.Context
-
Gets the command that created this context.
- command() - Method in class com.github.alex1304.ultimategdbot.api.service.BotService
- Command - Interface in com.github.alex1304.ultimategdbot.api.command
-
Represents a bot command.
- COMMAND_SERVICE - Static variable in class com.github.alex1304.ultimategdbot.api.service.CommonServices
- 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(Translator, 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(Translator, 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
- 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(String) - Constructor for class com.github.alex1304.ultimategdbot.api.command.CommandProvider
-
Deprecated.
- CommandProvider(String, PermissionChecker) - Constructor for class com.github.alex1304.ultimategdbot.api.command.CommandProvider
- CommandService - Class in com.github.alex1304.ultimategdbot.api.command
-
The command service coordinates the command providers from all plugins.
- CommandService(BotConfig, GatewayDiscordClient, LocalizationService, LoggingService) - Constructor for class com.github.alex1304.ultimategdbot.api.command.CommandService
- CommonServices - Class in com.github.alex1304.ultimategdbot.api.service
-
Defines references and descriptors for all common services.
- CommonServices() - Constructor for class com.github.alex1304.ultimategdbot.api.service.CommonServices
- CONFIG_RESOURCE_NAME - Static variable in class com.github.alex1304.ultimategdbot.api.command.CommandService
- CONFIG_RESOURCE_NAME - Static variable in class com.github.alex1304.ultimategdbot.api.command.menu.InteractiveMenuService
- CONFIG_RESOURCE_NAME - Static variable in class com.github.alex1304.ultimategdbot.api.emoji.EmojiService
- CONFIG_RESOURCE_NAME - Static variable in class com.github.alex1304.ultimategdbot.api.localization.LocalizationService
- CONFIG_RESOURCE_NAME - Static variable in class com.github.alex1304.ultimategdbot.api.logging.LoggingService
- ConfigEntry<T> - Interface in com.github.alex1304.ultimategdbot.api.database.guildconfig
-
Represents a guild configuration entry.
- ConfigEntryBuilder<D extends GuildConfigData<D>,T> - Class in com.github.alex1304.ultimategdbot.api.database.guildconfig
-
Provides methods to build a configuration entry.
- ConfigEntryVisitor<R> - Interface in com.github.alex1304.ultimategdbot.api.database.guildconfig
-
Visitor that visits concrete types of
ConfigEntry
. - configureGuild(Translator, Snowflake) - Method in class com.github.alex1304.ultimategdbot.api.database.DatabaseService
-
Retrieves all registered configurators for the given guild referenced by its ID.
- configureJdbi(Consumer<Jdbi>) - Method in class com.github.alex1304.ultimategdbot.api.database.DatabaseService
-
Allows to access the backing
Jdbi
instance to enrich its configuration, such as registering mappers. - Context - Class in com.github.alex1304.ultimategdbot.api.command
- Context(Command, MessageCreateEvent, List<String>, FlagSet, String, Locale, MessageChannel) - Constructor for class com.github.alex1304.ultimategdbot.api.command.Context
- 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
- convertParam(Context, String, Class<T>) - Method in class com.github.alex1304.ultimategdbot.api.command.CommandProvider
- create(long) - Method in interface com.github.alex1304.ultimategdbot.api.database.guildconfig.GuildConfigDao
-
Creates new configuration data for this guild with default values.
- create(String) - Method in class com.github.alex1304.ultimategdbot.api.command.menu.InteractiveMenuService
-
Creates a new empty InteractiveMenu with a given message that will serve as menu prompt.
- create(Consumer<MessageCreateSpec>) - Method in class com.github.alex1304.ultimategdbot.api.command.menu.InteractiveMenuService
-
Creates a new empty InteractiveMenu with a given message that will serve as menu prompt.
- create(Function<Translator, Mono<Consumer<MessageCreateSpec>>>) - Method in class com.github.alex1304.ultimategdbot.api.command.menu.InteractiveMenuService
-
Creates a new empty InteractiveMenu with a given message that will serve as menu prompt.
- create(Supplier<S>) - Static method in class com.github.alex1304.ultimategdbot.api.service.RootServiceSetupHelper
- create(Jdbi) - Static method in class com.github.alex1304.ultimategdbot.api.database.DatabaseService
-
Creates a new database backed by the given
Jdbi
instance. - createAsyncPaginated(BiFunction<Translator, Integer, Mono<MessageSpecTemplate>>) - Method in class com.github.alex1304.ultimategdbot.api.command.menu.InteractiveMenuService
-
Creates a new
InteractiveMenu
prefilled with menu items useful for pagination. - createPaginated(String, int) - Method in class com.github.alex1304.ultimategdbot.api.command.menu.InteractiveMenuService
-
Creates a new
InteractiveMenu
splitting the given text into several pages, returning a paginatedInteractiveMenu
if it contains 2 pages or more. - createPaginated(BiFunction<Translator, Integer, MessageSpecTemplate>) - Method in class com.github.alex1304.ultimategdbot.api.command.menu.InteractiveMenuService
-
Creates a new
InteractiveMenu
prefilled with menu items useful for pagination.
D
- database() - Method in class com.github.alex1304.ultimategdbot.api.service.BotService
- DATABASE_SERVICE - Static variable in class com.github.alex1304.ultimategdbot.api.service.CommonServices
- DatabaseException - Exception in com.github.alex1304.ultimategdbot.api.database
- DatabaseException(Throwable) - Constructor for exception com.github.alex1304.ultimategdbot.api.database.DatabaseException
- DatabaseService - Class in com.github.alex1304.ultimategdbot.api.database
-
Database backed by JDBI with reactive capabilities.
- declareServices(BotConfig) - Method in class com.github.alex1304.ultimategdbot.api.service.CommonServices
- declareServices(BotConfig) - Method in interface com.github.alex1304.ultimategdbot.api.service.ServiceDeclarator
-
Declares service descriptors to register to the bot's service container.
- DEFAULT_CLOSE_EMOJI - Static variable in class com.github.alex1304.ultimategdbot.api.command.menu.PaginationControls
- DEFAULT_NEXT_EMOJI - Static variable in class com.github.alex1304.ultimategdbot.api.command.menu.PaginationControls
- DEFAULT_PREVIOUS_EMOJI - Static variable in class com.github.alex1304.ultimategdbot.api.command.menu.PaginationControls
- deleteMenuOnClose(boolean) - Method in class com.github.alex1304.ultimategdbot.api.command.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.command.menu.InteractiveMenu
-
Sets whether to delete the menu message when the menu is closed automatically by timeout
- denyingAll(String) - Static method in interface com.github.alex1304.ultimategdbot.api.database.guildconfig.Validator
-
Creates a validator that denies all values.
- denyingIf(Predicate<? super T>, String) - Static method in interface com.github.alex1304.ultimategdbot.api.database.guildconfig.Validator
-
Creates a validator that denies the value if the predicate is matched, with the given failure message if the validation doesn't pass.
- denyingIfNotNull(String) - Static method in interface com.github.alex1304.ultimategdbot.api.database.guildconfig.Validator
-
Creates a validator that only allows null values.
- denyingIfNull(String) - Static method in interface com.github.alex1304.ultimategdbot.api.database.guildconfig.Validator
-
Creates a validator that denies null values.
- denyingWhen(Function<? super T, ? extends Publisher<Boolean>>, String) - Static method in interface com.github.alex1304.ultimategdbot.api.database.guildconfig.Validator
-
Creates a validator that denies the value if the Publisher emits true, with the given failure message if the validation doesn't pass.
- 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
- DurationUtils - Class in com.github.alex1304.ultimategdbot.api.util
-
Utilities to manipulate Duration objects.
E
- emoji() - Method in class com.github.alex1304.ultimategdbot.api.service.BotService
- EMOJI_SERVICE - Static variable in class com.github.alex1304.ultimategdbot.api.service.CommonServices
- EmojiService - Class in com.github.alex1304.ultimategdbot.api.emoji
- EmojiService(BotConfig, GatewayDiscordClient) - Constructor for class com.github.alex1304.ultimategdbot.api.emoji.EmojiService
- EMPTY - Static variable in interface com.github.alex1304.ultimategdbot.api.util.PropertyReader
-
A
PropertyReader
that doesn't contain any property. - equals(Object) - Method in class com.github.alex1304.ultimategdbot.api.PluginMetadata
- 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, PermissionChecker) - 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
- 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(Translator, 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
- forGuildChannel(GatewayDiscordClient, Function<? super D, Snowflake>) - Static method in class com.github.alex1304.ultimategdbot.api.database.guildconfig.ValueGetters
-
Convenient method to generate a value getter for guild channel configuration entries.
- forGuildMember(GatewayDiscordClient, Function<? super D, Snowflake>) - Static method in class com.github.alex1304.ultimategdbot.api.database.guildconfig.ValueGetters
-
Convenient method to generate a value getter for guild member configuration entries.
- forGuildRole(GatewayDiscordClient, Function<? super D, Snowflake>) - Static method in class com.github.alex1304.ultimategdbot.api.database.guildconfig.ValueGetters
-
Convenient method to generate a value getter for guild role configuration entries.
- format(Duration) - Static method in class com.github.alex1304.ultimategdbot.api.util.DurationUtils
-
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)
- forOptionalGuildChannel(GatewayDiscordClient, Function<? super D, Optional<Snowflake>>) - Static method in class com.github.alex1304.ultimategdbot.api.database.guildconfig.ValueGetters
-
Convenient method to generate a value getter for guild channel configuration entries.
- forOptionalGuildMember(GatewayDiscordClient, Function<? super D, Optional<Snowflake>>) - Static method in class com.github.alex1304.ultimategdbot.api.database.guildconfig.ValueGetters
-
Convenient method to generate a value getter for guild member configuration entries.
- forOptionalGuildRole(GatewayDiscordClient, Function<? super D, Optional<Snowflake>>) - Static method in class com.github.alex1304.ultimategdbot.api.database.guildconfig.ValueGetters
-
Convenient method to generate a value getter for guild role configuration entries.
- forOptionalValue(Function<? super D, Optional<? extends T>>) - Static method in class com.github.alex1304.ultimategdbot.api.database.guildconfig.ValueGetters
-
Convenient method to generate a value getter for optional value-based configuration entries.
- forSimpleValue(Function<? super D, ? extends T>) - Static method in class com.github.alex1304.ultimategdbot.api.database.guildconfig.ValueGetters
-
Convenient method to generate a value getter for simple value-based configuration entries.
- from(Object, CommandProvider, PermissionChecker) - Static method in class com.github.alex1304.ultimategdbot.api.command.annotated.AnnotatedCommand
- 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
. - fromResourceMap(Map<String, PropertyReader>) - Static method in class com.github.alex1304.ultimategdbot.api.BotConfig
-
Creates a new
BotConfig
initialized with resources defined in the given map.
G
- gateway() - Method in class com.github.alex1304.ultimategdbot.api.service.BotService
- GATEWAY_DISCORD_CLIENT - Static variable in class com.github.alex1304.ultimategdbot.api.service.CommonServices
- get(int) - Method in class com.github.alex1304.ultimategdbot.api.command.ArgumentList
-
Returns the argument at the specified position.
- get(long) - Method in interface com.github.alex1304.ultimategdbot.api.database.guildconfig.GuildConfigDao
-
Retrieves the data for a particular guild, if present.
- get(String) - Method in class com.github.alex1304.ultimategdbot.api.command.FlagSet
-
Gets the value of the flag with the given name.
- get(String) - Method in class com.github.alex1304.ultimategdbot.api.emoji.EmojiService
- getActualValue() - Method in exception com.github.alex1304.ultimategdbot.api.command.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.command.menu.MessageMenuInteraction
- getChannel() - Method in class com.github.alex1304.ultimategdbot.api.command.menu.ReactionToggleEvent
- getChannelId() - Method in class com.github.alex1304.ultimategdbot.api.command.menu.ReactionToggleEvent
- getCloseEmoji() - Method in class com.github.alex1304.ultimategdbot.api.command.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.CommandProvider
-
Gets a command instance corresponding to the given alias.
- getCommandByAlias(String) - Method in class com.github.alex1304.ultimategdbot.api.command.CommandService
-
Gets a command instance corresponding to the given alias.
- getCommandPrefix() - Method in class com.github.alex1304.ultimategdbot.api.command.CommandService
- getCommandProviders() - Method in class com.github.alex1304.ultimategdbot.api.command.CommandService
-
Gets an immutable view of the command providers added to the service.
- getConfigEntries() - Method in class com.github.alex1304.ultimategdbot.api.database.guildconfig.GuildConfigurator
-
Gets a collection of configuration entries containied in this configurator.
- getConfigEntry(String) - Method in class com.github.alex1304.ultimategdbot.api.database.guildconfig.GuildConfigurator
-
Gets the configuration entry corresponding to the given key
- 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.
- getDefault() - Static method in class com.github.alex1304.ultimategdbot.api.command.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.
- getDescription() - Method in interface com.github.alex1304.ultimategdbot.api.database.guildconfig.ConfigEntry
-
Gets the description of this entry.
- getDescription() - Method in class com.github.alex1304.ultimategdbot.api.database.guildconfig.GuildConfigurator
-
Gets the description of this configurator.
- getDescription() - Method in class com.github.alex1304.ultimategdbot.api.PluginMetadata
-
Gets the description of the plugin
- getDevelopers() - Method in class com.github.alex1304.ultimategdbot.api.PluginMetadata
-
Gets the list of developerrs that contributed to this plugin
- getDisplayName() - Method in interface com.github.alex1304.ultimategdbot.api.database.guildconfig.ConfigEntry
-
Gets the display name of this entry.
- getDocumentation(Locale) - Method in class com.github.alex1304.ultimategdbot.api.command.annotated.AnnotatedCommand
- getDocumentation(Locale) - 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.command.menu.ReactionToggleEvent
- getEmojiGuildIds() - Method in class com.github.alex1304.ultimategdbot.api.emoji.EmojiService
- 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.menu.MessageMenuInteraction
- getEvent() - Method in class com.github.alex1304.ultimategdbot.api.command.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.command.CommandService
- getFlags() - Method in class com.github.alex1304.ultimategdbot.api.command.menu.MessageMenuInteraction
- getGitProperties(String) - Static method in class com.github.alex1304.ultimategdbot.api.util.VersionUtils
-
Extracts the git properties from a properties file which location is given.
- getGuild() - Method in class com.github.alex1304.ultimategdbot.api.command.menu.ReactionToggleEvent
- getGuildId() - Method in class com.github.alex1304.ultimategdbot.api.command.menu.ReactionToggleEvent
- getGuildId() - Method in interface com.github.alex1304.ultimategdbot.api.database.guildconfig.ConfigEntry
-
Gets the ID of the guild this config entry is attached to.
- getGuildId() - Method in class com.github.alex1304.ultimategdbot.api.database.guildconfig.GuildConfigurator
-
Gets the ID of the guild this configurator is atttached to.
- getKey() - Method in interface com.github.alex1304.ultimategdbot.api.database.guildconfig.ConfigEntry
-
Gets the unique key of this entry.
- getKey() - Method in exception com.github.alex1304.ultimategdbot.api.database.guildconfig.ReadOnlyConfigEntryException
-
Gets the configuration entry key that caused this exception.
- getLocale() - Method in class com.github.alex1304.ultimategdbot.api.command.Context
- getLocale() - Method in class com.github.alex1304.ultimategdbot.api.localization.LocalizationService
- getLocale() - Method in interface com.github.alex1304.ultimategdbot.api.Translator
-
Gets the locale used by this translator.
- getLocaleForGuild(long) - Method in class com.github.alex1304.ultimategdbot.api.localization.LocalizationService
-
Finds the locale specific to the given guild.
- getMaxPage() - Method in exception com.github.alex1304.ultimategdbot.api.command.menu.PageNumberOutOfRangeException
- getMessage() - Method in class com.github.alex1304.ultimategdbot.api.command.menu.ReactionToggleEvent
- getMessageId() - Method in class com.github.alex1304.ultimategdbot.api.command.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.command.menu.PageNumberOutOfRangeException
- getName() - Method in class com.github.alex1304.ultimategdbot.api.command.CommandProvider
-
Gets the name of this command provider.
- getName() - Method in class com.github.alex1304.ultimategdbot.api.database.guildconfig.GuildConfigurator
-
Gets the name of this configurator.
- getName() - Method in class com.github.alex1304.ultimategdbot.api.PluginMetadata
-
Gets the name of the plugin
- getNextEmoji() - Method in class com.github.alex1304.ultimategdbot.api.command.menu.PaginationControls
- getOrCreate(long) - Method in interface com.github.alex1304.ultimategdbot.api.database.guildconfig.GuildConfigDao
-
Retrieves the data for a particular guild.
- getPaginationControls() - Method in class com.github.alex1304.ultimategdbot.api.command.menu.InteractiveMenuService
-
Gets the pagination controls used by this service.
- getPermissionChecker() - Method in class com.github.alex1304.ultimategdbot.api.command.CommandProvider
-
Deprecated.
- getPermissionChecker() - Method in class com.github.alex1304.ultimategdbot.api.command.CommandService
-
Gets the permission checker used to check permissions for commands provided by this kernel.
- getPreviousEmoji() - Method in class com.github.alex1304.ultimategdbot.api.command.menu.PaginationControls
- getProvidedCommands() - Method in class com.github.alex1304.ultimategdbot.api.command.CommandProvider
-
Gets all provided commands.
- 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.
- 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.
- getSupportedLocales() - Method in class com.github.alex1304.ultimategdbot.api.localization.LocalizationService
-
Gets the set of locales supported by this service.
- getSyntax() - Method in class com.github.alex1304.ultimategdbot.api.command.CommandDocumentationEntry
-
Gets the syntax of the command relevant for this entry.
- getTokens() - Method in class com.github.alex1304.ultimategdbot.api.command.ArgumentList
- getTokens(int) - Method in class com.github.alex1304.ultimategdbot.api.command.ArgumentList
- getUrl() - Method in class com.github.alex1304.ultimategdbot.api.PluginMetadata
-
Gets the URL of the plugin's site or repository.
- getUser() - Method in class com.github.alex1304.ultimategdbot.api.command.menu.ReactionToggleEvent
- getUserId() - Method in class com.github.alex1304.ultimategdbot.api.command.menu.ReactionToggleEvent
- getValue() - Method in interface com.github.alex1304.ultimategdbot.api.database.guildconfig.ConfigEntry
-
Gets the current value of this entry.
- getValueFormat() - Method in class com.github.alex1304.ultimategdbot.api.command.FlagInformation
-
Gets a description of the value format.
- getVersion() - Method in class com.github.alex1304.ultimategdbot.api.PluginMetadata
-
Gets the version of the plugin
- 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
- GuildChannelConfigEntry - Class in com.github.alex1304.ultimategdbot.api.database.guildconfig
- GuildChannelConverter - Class in com.github.alex1304.ultimategdbot.api.command.annotated.paramconverter
- GuildChannelConverter() - Constructor for class com.github.alex1304.ultimategdbot.api.command.annotated.paramconverter.GuildChannelConverter
- GuildConfigDao<D extends GuildConfigData<D>> - Interface in com.github.alex1304.ultimategdbot.api.database.guildconfig
-
Generic DAO to retrieve configuration for a guild.
- GuildConfigData<D extends GuildConfigData<D>> - Interface in com.github.alex1304.ultimategdbot.api.database.guildconfig
-
Database entity representing settings for a guild.
- GuildConfigurator<D extends GuildConfigData<D>> - Class in com.github.alex1304.ultimategdbot.api.database.guildconfig
-
Allows to view and edit configuration for a guild.
- GuildConfigurator.Builder<D extends GuildConfigData<D>> - Class in com.github.alex1304.ultimategdbot.api.database.guildconfig
- guildId() - Method in interface com.github.alex1304.ultimategdbot.api.database.guildconfig.GuildConfigData
- GuildMemberConfigEntry - Class in com.github.alex1304.ultimategdbot.api.database.guildconfig
- GuildRoleConfigEntry - Class in com.github.alex1304.ultimategdbot.api.database.guildconfig
H
- hashCode() - Method in class com.github.alex1304.ultimategdbot.api.PluginMetadata
- HiddenCommand - Annotation Type in com.github.alex1304.ultimategdbot.api.command.annotated
I
- IntConverter - Class in com.github.alex1304.ultimategdbot.api.command.annotated.paramconverter
- IntConverter() - Constructor for class com.github.alex1304.ultimategdbot.api.command.annotated.paramconverter.IntConverter
- IntegerConfigEntry - Class in com.github.alex1304.ultimategdbot.api.database.guildconfig
- INTERACTIVE_MENU_SERVICE - Static variable in class com.github.alex1304.ultimategdbot.api.service.CommonServices
- interactiveMenu() - Method in class com.github.alex1304.ultimategdbot.api.service.BotService
- InteractiveMenu - Class in com.github.alex1304.ultimategdbot.api.command.menu
-
Utility to create interactive menus in Discord.
- InteractiveMenuService - Class in com.github.alex1304.ultimategdbot.api.command.menu
- InteractiveMenuService(BotConfig, GatewayDiscordClient, CommandService, EmojiService) - Constructor for class com.github.alex1304.ultimategdbot.api.command.menu.InteractiveMenuService
- inTransaction(HandleCallback<T, ?>) - Method in class com.github.alex1304.ultimategdbot.api.database.DatabaseService
-
Performs a database transaction.
- 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.command.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
- isReadOnly() - Method in interface com.github.alex1304.ultimategdbot.api.database.guildconfig.ConfigEntry
-
Tells whether this entry is read-only.
- 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
L
- level() - Method in annotation type com.github.alex1304.ultimategdbot.api.command.annotated.CommandPermission
- localization() - Method in class com.github.alex1304.ultimategdbot.api.service.BotService
- LOCALIZATION_SERVICE - Static variable in class com.github.alex1304.ultimategdbot.api.service.CommonServices
- LocalizationService - Class in com.github.alex1304.ultimategdbot.api.localization
- LocalizationService(BotConfig) - Constructor for class com.github.alex1304.ultimategdbot.api.localization.LocalizationService
- log(String) - Method in class com.github.alex1304.ultimategdbot.api.logging.LoggingService
- logging() - Method in class com.github.alex1304.ultimategdbot.api.service.BotService
- LOGGING_SERVICE - Static variable in class com.github.alex1304.ultimategdbot.api.service.CommonServices
- LoggingService - Class in com.github.alex1304.ultimategdbot.api.logging
- LoggingService(BotConfig, GatewayDiscordClient) - Constructor for class com.github.alex1304.ultimategdbot.api.logging.LoggingService
- LongConfigEntry - Class in com.github.alex1304.ultimategdbot.api.database.guildconfig
- 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.
- MessageMenuInteraction - Class in com.github.alex1304.ultimategdbot.api.command.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
- MessageUtils - Class in com.github.alex1304.ultimategdbot.api.util
-
Utility methods to process message content.
- metadata() - Method in interface com.github.alex1304.ultimategdbot.api.Plugin
-
Gets the metadata of this plugin.
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
O
- onSave(Consumer<? super D>) - Method in class com.github.alex1304.ultimategdbot.api.database.guildconfig.GuildConfigurator.Builder
-
Specifies a callback to invoke when the modified data is saved to the database.
- open(Context) - Method in class com.github.alex1304.ultimategdbot.api.command.menu.InteractiveMenu
-
Opens the interactive menu, that is, sends the menu message over Discord and starts listening for user's interaction.
- or(Validator<T>) - Method in interface com.github.alex1304.ultimategdbot.api.database.guildconfig.Validator
-
Creates a validator that allows the value if EITHER this validator OR the given one allows the value.
P
- PageNumberOutOfRangeException - Exception in com.github.alex1304.ultimategdbot.api.command.menu
- PageNumberOutOfRangeException(int, int, int) - Constructor for exception com.github.alex1304.ultimategdbot.api.command.menu.PageNumberOutOfRangeException
- PaginationControls - Class in com.github.alex1304.ultimategdbot.api.command.menu
- PaginationControls(String, String, String) - Constructor for class com.github.alex1304.ultimategdbot.api.command.menu.PaginationControls
- ParamConversionException - Exception in com.github.alex1304.ultimategdbot.api.command.annotated.paramconverter
- ParamConversionException(Translator, 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(Translator, GatewayDiscordClient, Snowflake, String) - Static method in class com.github.alex1304.ultimategdbot.api.util.DiscordParser
-
Parses the input into a Discord channel.
- parseRole(Translator, GatewayDiscordClient, Snowflake, String) - Static method in class com.github.alex1304.ultimategdbot.api.util.DiscordParser
-
Parses the input into a Discord role.
- parseUser(Translator, GatewayDiscordClient, String) - Static method in class com.github.alex1304.ultimategdbot.api.util.DiscordParser
-
Parses the input into a Discord user.
- 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 - Interface in com.github.alex1304.ultimategdbot.api
-
Configures and creates a plugin.
- PLUGIN_METADATA_SERVICE - Static variable in class com.github.alex1304.ultimategdbot.api.service.CommonServices
- pluginMetadata() - Method in class com.github.alex1304.ultimategdbot.api.service.BotService
- PluginMetadata - Class in com.github.alex1304.ultimategdbot.api
-
Holds metadata describing a plugin.
- PluginMetadata.Builder - Class in com.github.alex1304.ultimategdbot.api
-
Builder to build a
PluginMetadata
object. - PluginMetadataService - Class in com.github.alex1304.ultimategdbot.api.metadata
-
Service that exposes the metadata of all plugins loaded in the bot.
- PluginMetadataService(Set<PluginMetadata>) - Constructor for class com.github.alex1304.ultimategdbot.api.metadata.PluginMetadataService
- 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.CommandService
-
Processes a MessageCreateEvent.
- PropertyReader - Interface in com.github.alex1304.ultimategdbot.api.util
-
Allows to read values from an abstracted source of properties.
- PUBLIC - com.github.alex1304.ultimategdbot.api.command.PermissionLevel
Q
- quote(String) - Static method in class com.github.alex1304.ultimategdbot.api.util.Markdown
-
Formats the text as a quote.
R
- ReactionMenuInteraction - Class in com.github.alex1304.ultimategdbot.api.command.menu
- ReactionToggleEvent - Class in com.github.alex1304.ultimategdbot.api.command.menu
- ReactionToggleEvent(Event) - Constructor for class com.github.alex1304.ultimategdbot.api.command.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.
- ReadOnlyConfigEntryException - Exception in com.github.alex1304.ultimategdbot.api.database.guildconfig
- ReadOnlyConfigEntryException(String) - Constructor for exception com.github.alex1304.ultimategdbot.api.database.guildconfig.ReadOnlyConfigEntryException
- 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
-
Deprecated.
- 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.
- reset(long) - Method in interface com.github.alex1304.ultimategdbot.api.database.guildconfig.GuildConfigDao
-
Resets data for this guild.
- resetAndGet(long) - Method in interface com.github.alex1304.ultimategdbot.api.database.guildconfig.GuildConfigDao
-
Resets the data for a particular guild, then returns the data after reset.
- resetConfig(DatabaseService) - Method in class com.github.alex1304.ultimategdbot.api.database.guildconfig.GuildConfigurator
-
Resets the configuration to its default value and saves the data with the default values in the given database.
- resource(String) - Method in class com.github.alex1304.ultimategdbot.api.BotConfig
-
Gets a configuration resource by the given name.
- RoleConverter - Class in com.github.alex1304.ultimategdbot.api.command.annotated.paramconverter
- RoleConverter() - Constructor for class com.github.alex1304.ultimategdbot.api.command.annotated.paramconverter.RoleConverter
- Root - Annotation Type in com.github.alex1304.ultimategdbot.api.service
- rootService() - Method in interface com.github.alex1304.ultimategdbot.api.Plugin
-
Defines the root service of the plugin.
- RootServiceSetupHelper<S> - Class in com.github.alex1304.ultimategdbot.api.service
- 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
- saveConfig(DatabaseService) - Method in class com.github.alex1304.ultimategdbot.api.database.guildconfig.GuildConfigurator
-
Saves in the given database the data object reflecting all modifications performed through the entries of this configurator.
- 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.
- ServiceDeclarator - Interface in com.github.alex1304.ultimategdbot.api.service
-
Declares one or more services to register to the bot.
- setDescription(String) - Method in class com.github.alex1304.ultimategdbot.api.database.guildconfig.ConfigEntryBuilder
-
Specifies a user-friendly description for this entry.
- setDescription(String) - Method in class com.github.alex1304.ultimategdbot.api.database.guildconfig.GuildConfigurator.Builder
-
Specifies a user-friendly description for this configurator.
- setDescription(String) - Method in class com.github.alex1304.ultimategdbot.api.PluginMetadata.Builder
-
Sets the description of the plugin.
- setDevelopers(List<String>) - Method in class com.github.alex1304.ultimategdbot.api.PluginMetadata.Builder
-
Sets the developers of the plugin.
- setDisplayName(String) - Method in class com.github.alex1304.ultimategdbot.api.database.guildconfig.ConfigEntryBuilder
-
Specifies a user-friendly name for this entry.
- setErrorHandler(CommandErrorHandler) - Method in class com.github.alex1304.ultimategdbot.api.command.CommandProvider
-
Sets a custom command handler.
- setLocaleForGuild(long, Locale) - Method in class com.github.alex1304.ultimategdbot.api.localization.LocalizationService
-
Sets a locale specific for the given guild.
- setPermissionChecker(PermissionChecker) - Method in class com.github.alex1304.ultimategdbot.api.command.CommandProvider
-
Deprecated.
- setPrefixForGuild(long, String) - Method in class com.github.alex1304.ultimategdbot.api.command.CommandService
-
Sets a prefix specific for the given guild.
- setSetupSequence(Publisher<?>) - Method in class com.github.alex1304.ultimategdbot.api.service.RootServiceSetupHelper
- setup() - Method in class com.github.alex1304.ultimategdbot.api.service.RootServiceSetupHelper
- setUrl(String) - Method in class com.github.alex1304.ultimategdbot.api.PluginMetadata.Builder
-
Sets the url of the plugin.
- setValidator(Validator<T>) - Method in class com.github.alex1304.ultimategdbot.api.database.guildconfig.ConfigEntryBuilder
-
Specifies the validator that will validate new values set to the entry.
- setValue(T) - Method in interface com.github.alex1304.ultimategdbot.api.database.guildconfig.ConfigEntry
-
Sets a new value for this entry.
- setValueGetter(Function<? super D, ? extends Mono<T>>) - Method in class com.github.alex1304.ultimategdbot.api.database.guildconfig.ConfigEntryBuilder
-
Specifies how to extract the value from the data object.
- setValueSetter(BiFunction<? super D, ? super T, ? extends D>) - Method in class com.github.alex1304.ultimategdbot.api.database.guildconfig.ConfigEntryBuilder
-
Specifies how to update the value and store it in the data object.
- setVersion(String) - Method in class com.github.alex1304.ultimategdbot.api.PluginMetadata.Builder
-
Sets the version of the plugin.
- shortDescription() - Method in annotation type com.github.alex1304.ultimategdbot.api.command.annotated.CommandDescriptor
- spoiler(String) - Static method in class com.github.alex1304.ultimategdbot.api.util.Markdown
-
Formats the text with spoiler markdown.
- strikethrough(String) - Static method in class com.github.alex1304.ultimategdbot.api.util.Markdown
-
Formats the text with strikethrough markdown.
- StringConfigEntry - Class in com.github.alex1304.ultimategdbot.api.database.guildconfig
- StringConverter - Class in com.github.alex1304.ultimategdbot.api.command.annotated.paramconverter
- StringConverter() - Constructor for class com.github.alex1304.ultimategdbot.api.command.annotated.paramconverter.StringConverter
T
- to(Locale) - Static method in interface com.github.alex1304.ultimategdbot.api.Translator
-
Creates a new
Translator
that translates to the target locale. - toJdkProperties() - Method in interface com.github.alex1304.ultimategdbot.api.util.PropertyReader
-
Converts this
PropertyReader
into a JDKProperties
object. - 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.MessageUtils
-
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
- 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 class com.github.alex1304.ultimategdbot.api.PluginMetadata
- translate(String, String, Object...) - Method in interface com.github.alex1304.ultimategdbot.api.Translator
-
Translates a string.
- Translator - Interface in com.github.alex1304.ultimategdbot.api
-
A class implementing this interface is able to translate strings.
- 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
- ultimategdbot.api - module ultimategdbot.api
- unblacklist(long) - Method in class com.github.alex1304.ultimategdbot.api.command.CommandService
-
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.command.menu
- UnexpectedReplyException(String) - Constructor for exception com.github.alex1304.ultimategdbot.api.command.menu.UnexpectedReplyException
- update(D) - Method in interface com.github.alex1304.ultimategdbot.api.database.guildconfig.GuildConfigDao
-
Updates the data for a certain guild.
- useExtension(Class<E>, ExtensionConsumer<E, ?>) - Method in class com.github.alex1304.ultimategdbot.api.database.DatabaseService
-
Uses a JDBI Extension.
- useHandle(HandleConsumer<?>) - Method in class com.github.alex1304.ultimategdbot.api.database.DatabaseService
-
Acquires a
Handle
to perform actions on the database. - UserConverter - Class in com.github.alex1304.ultimategdbot.api.command.annotated.paramconverter
- UserConverter() - Constructor for class com.github.alex1304.ultimategdbot.api.command.annotated.paramconverter.UserConverter
- useTransaction(HandleConsumer<?>) - Method in class com.github.alex1304.ultimategdbot.api.database.DatabaseService
-
Performs a database transaction.
V
- ValidationException - Exception in com.github.alex1304.ultimategdbot.api.database.guildconfig
-
Thrown when the validation of a value fails.
- ValidationException(String) - Constructor for exception com.github.alex1304.ultimategdbot.api.database.guildconfig.ValidationException
- Validator<T> - Interface in com.github.alex1304.ultimategdbot.api.database.guildconfig
-
Validates a value in a reactive way.
- 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
- ValueGetters - Class in com.github.alex1304.ultimategdbot.api.database.guildconfig
-
Utility class that provides factories for guild configuration value getters.
- 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.
- 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.
- VersionUtils - Class in com.github.alex1304.ultimategdbot.api.util
- visit(BooleanConfigEntry) - Method in interface com.github.alex1304.ultimategdbot.api.database.guildconfig.ConfigEntryVisitor
- visit(GuildChannelConfigEntry) - Method in interface com.github.alex1304.ultimategdbot.api.database.guildconfig.ConfigEntryVisitor
- visit(GuildMemberConfigEntry) - Method in interface com.github.alex1304.ultimategdbot.api.database.guildconfig.ConfigEntryVisitor
- visit(GuildRoleConfigEntry) - Method in interface com.github.alex1304.ultimategdbot.api.database.guildconfig.ConfigEntryVisitor
- visit(IntegerConfigEntry) - Method in interface com.github.alex1304.ultimategdbot.api.database.guildconfig.ConfigEntryVisitor
- visit(LongConfigEntry) - Method in interface com.github.alex1304.ultimategdbot.api.database.guildconfig.ConfigEntryVisitor
- visit(StringConfigEntry) - Method in interface com.github.alex1304.ultimategdbot.api.database.guildconfig.ConfigEntryVisitor
W
- withExtension(Class<E>, ExtensionCallback<T, E, ?>) - Method in class com.github.alex1304.ultimategdbot.api.database.DatabaseService
-
Uses a JDBI Extension.
- withHandle(HandleCallback<T, ?>) - Method in class com.github.alex1304.ultimategdbot.api.database.DatabaseService
-
Acquires a
Handle
to perform actions on the database. - withInteractionContext(Consumer<Map<String, Object>>) - Method in class com.github.alex1304.ultimategdbot.api.command.menu.InteractiveMenu
-
Initializes the interaction context that will be passed to all interaction instances happening while this menu is open.
- withTimeout(Duration) - Method in class com.github.alex1304.ultimategdbot.api.command.menu.InteractiveMenu
-
Sets a timeou after which the menu automatically closes.
All Classes All Packages