Index

A B C D E F G H I J L M N O P Q R S T U V W
All Classes and Interfaces|All Packages|Constant Field Values|Serialized Form

A

AboutCommand - Class in com.jagrosh.jdautilities.examples.command

AboutCommand(Color, String, String[], Permission...) - Constructor for class com.jagrosh.jdautilities.examples.command.AboutCommand

add(K, V) - Method in class com.jagrosh.jdautilities.commons.utils.FixedSizeCache

Adds a key and pairs it with a value.

addAlias(String) - Method in class com.jagrosh.jdautilities.command.CommandBuilder

Adds a alias for the Command built from this CommandBuilder.

addAliases(String...) - Method in class com.jagrosh.jdautilities.command.CommandBuilder

Adds aliases for the Command built from this CommandBuilder.

addAnnotatedModule(Object) - Method in interface com.jagrosh.jdautilities.command.CommandClient

Compiles the provided Object annotated with JDACommand.Module into a List of Commands and adds them to this CommandClient in the order they are listed.

addAnnotatedModule(Object) - Method in class com.jagrosh.jdautilities.command.CommandClientBuilder

Adds an annotated command module to the CommandClientImpl for this session.

addAnnotatedModule(Object) - Method in class com.jagrosh.jdautilities.command.impl.CommandClientImpl

addAnnotatedModule(Object, Function<Command, Integer>) - Method in interface com.jagrosh.jdautilities.command.CommandClient

Compiles the provided Object annotated with JDACommand.Module into a List of Commands and adds them to this CommandClient via the Function provided.

addAnnotatedModule(Object, Function<Command, Integer>) - Method in class com.jagrosh.jdautilities.command.impl.CommandClientImpl

addAnnotatedModules(Object...) - Method in class com.jagrosh.jdautilities.command.CommandClientBuilder

Adds multiple annotated command modules to the CommandClientImpl for this session.

addChild(Command) - Method in class com.jagrosh.jdautilities.command.CommandBuilder

Adds a child Command to the Command built from this CommandBuilder.

addChildren(Command...) - Method in class com.jagrosh.jdautilities.command.CommandBuilder

Adds child Commands to the Command built from this CommandBuilder.

addChoice(String) - Method in class com.jagrosh.jdautilities.menu.ButtonMenu.Builder

Adds a single String unicode emoji as a button choice.

addChoice(String) - Method in class com.jagrosh.jdautilities.menu.OrderedMenu.Builder

Adds a single String choice.

addChoice(Emoji) - Method in class com.jagrosh.jdautilities.menu.ButtonMenu.Builder

Adds a single custom Emote as button choices.

addChoices(String...) - Method in class com.jagrosh.jdautilities.menu.ButtonMenu.Builder

Adds String unicode emojis as button choices.

addChoices(String...) - Method in class com.jagrosh.jdautilities.menu.OrderedMenu.Builder

Adds the String choices.

addChoices(String...) - Method in class com.jagrosh.jdautilities.menu.SelectionDialog.Builder

Adds String choices to be shown as selections.

addChoices(Emoji...) - Method in class com.jagrosh.jdautilities.menu.ButtonMenu.Builder

Adds custom Emotes as button choices.

addCommand(Command) - Method in interface com.jagrosh.jdautilities.command.CommandClient

Adds a single Command to this CommandClient's registered Commands.

addCommand(Command) - Method in class com.jagrosh.jdautilities.command.CommandClientBuilder

Adds a Command and registers it to the CommandClientImpl for this session.

addCommand(Command) - Method in class com.jagrosh.jdautilities.command.impl.CommandClientImpl

addCommand(Command, int) - Method in interface com.jagrosh.jdautilities.command.CommandClient

Adds a single Command to this CommandClient's registered Commands at the specified index.

addCommand(Command, int) - Method in class com.jagrosh.jdautilities.command.impl.CommandClientImpl

addCommands(Command...) - Method in class com.jagrosh.jdautilities.command.CommandClientBuilder

Adds and registers multiple Commands to the CommandClientImpl for this session.

addContextMenu(ContextMenu) - Method in interface com.jagrosh.jdautilities.command.CommandClient

Adds a single ContextMenu to this CommandClient's registered Context Menus.

addContextMenu(ContextMenu) - Method in class com.jagrosh.jdautilities.command.CommandClientBuilder

Adds a SlashCommand and registers it to the CommandClientImpl for this session.

addContextMenu(ContextMenu) - Method in class com.jagrosh.jdautilities.command.impl.CommandClientImpl

addContextMenu(ContextMenu, int) - Method in interface com.jagrosh.jdautilities.command.CommandClient

Adds a single ContextMenu to this CommandClient's registered Context Menus.

addContextMenu(ContextMenu, int) - Method in class com.jagrosh.jdautilities.command.impl.CommandClientImpl

addContextMenus(ContextMenu...) - Method in class com.jagrosh.jdautilities.command.CommandClientBuilder

Adds and registers multiple SlashCommands to the CommandClientImpl for this session.

addHeaders(String...) - Method in class com.jagrosh.jdautilities.commons.utils.TableBuilder

Sets the headers for the columns specified in values, applied in the order given here.

addItems(String...) - Method in class com.jagrosh.jdautilities.menu.ButtonEmbedPaginator.Builder

Adds MessageEmbeds to the list of items to paginate.

addItems(String...) - Method in class com.jagrosh.jdautilities.menu.EmbedPaginator.Builder

Adds MessageEmbeds to the list of items to paginate.

addItems(String...) - Method in class com.jagrosh.jdautilities.menu.Paginator.Builder

Adds String items to the list of items to paginate.

addItems(String...) - Method in class com.jagrosh.jdautilities.menu.Slideshow.Builder

Adds String items to the list of items to paginate.

addItems(Collection<MessageEmbed>) - Method in class com.jagrosh.jdautilities.menu.ButtonEmbedPaginator.Builder

Adds the collection of provided MessageEmbed to the list of items to paginate.

addItems(Collection<MessageEmbed>) - Method in class com.jagrosh.jdautilities.menu.EmbedPaginator.Builder

Adds the collection of provided MessageEmbeds to the list of items to paginate.

addItems(MessageEmbed...) - Method in class com.jagrosh.jdautilities.menu.ButtonEmbedPaginator.Builder

Adds MessageEmbed to the list of items to paginate.

addItems(MessageEmbed...) - Method in class com.jagrosh.jdautilities.menu.EmbedPaginator.Builder

Adds MessageEmbeds to the list of items to paginate.

addRoles(Role...) - Method in class com.jagrosh.jdautilities.menu.Menu.Builder

Adds Roles that are allowed to use the Menu that will be built.

addRowNames(String...) - Method in class com.jagrosh.jdautilities.commons.utils.TableBuilder

Sets names for the rows specified in values, applied in the order given here.

addSlashCommand(SlashCommand) - Method in interface com.jagrosh.jdautilities.command.CommandClient

Adds a single SlashCommand to this CommandClient's registered SlashCommand.

addSlashCommand(SlashCommand) - Method in class com.jagrosh.jdautilities.command.CommandClientBuilder

Adds a SlashCommand and registers it to the CommandClientImpl for this session.

addSlashCommand(SlashCommand) - Method in class com.jagrosh.jdautilities.command.impl.CommandClientImpl

addSlashCommand(SlashCommand, int) - Method in interface com.jagrosh.jdautilities.command.CommandClient

Adds a single SlashCommand to this CommandClient's registered Commands at the specified index.

addSlashCommand(SlashCommand, int) - Method in class com.jagrosh.jdautilities.command.impl.CommandClientImpl

addSlashCommands(SlashCommand...) - Method in class com.jagrosh.jdautilities.command.CommandClientBuilder

Adds and registers multiple SlashCommands to the CommandClientImpl for this session.

addUsers(User...) - Method in class com.jagrosh.jdautilities.menu.Menu.Builder

Adds Users that are allowed to use the Menu that will be built.

aliases - Variable in class com.jagrosh.jdautilities.command.Command

The aliases of the command, when calling a command these function identically to calling the Command.name.

allowTextInput(boolean) - Method in class com.jagrosh.jdautilities.menu.EmbedPaginator.Builder

Sets the EmbedPaginator to allow a page number to be specified by a user via text.

allowTextInput(boolean) - Method in class com.jagrosh.jdautilities.menu.OrderedMenu.Builder

If true, Users can type the number or letter of the input to make their selection, in addition to the reaction option.

allowTextInput(boolean) - Method in class com.jagrosh.jdautilities.menu.Paginator.Builder

Sets the Paginator to allow a page number to be specified by a user via text.

allowTextInput(boolean) - Method in class com.jagrosh.jdautilities.menu.Slideshow.Builder

Sets the Slideshow to allow a slide number to be specified by a user via text.

AnnotatedModuleCompiler - Interface in com.jagrosh.jdautilities.command

A "compiler" for Objects that uses Annotations as helpers for creating Commands.

AnnotatedModuleCompilerImpl - Class in com.jagrosh.jdautilities.command.impl

Default implementation for AnnotatedModuleCompiler.

AnnotatedModuleCompilerImpl() - Constructor for class com.jagrosh.jdautilities.command.impl.AnnotatedModuleCompilerImpl

applyCooldown(String, int) - Method in interface com.jagrosh.jdautilities.command.CommandClient

Applies the specified cooldown with the provided name.

applyCooldown(String, int) - Method in class com.jagrosh.jdautilities.command.impl.CommandClientImpl

arguments - Variable in class com.jagrosh.jdautilities.command.Command

An arguments format String for the command, used in the default help builder.

arguments() - Element in annotation interface com.jagrosh.jdautilities.command.annotation.JDACommand

The arguments string for the command.

async(Runnable) - Method in class com.jagrosh.jdautilities.command.CommandEvent

Uses the client's executor to run the provided Runnable asynchronously without blocking the thread this is called in.

Author - Annotation Interface in com.jagrosh.jdautilities.examples.doc

Annotation to mark a command's specific author.

AUTHOR - Static variable in class com.jagrosh.jdautilities.commons.JDAUtilitiesInfo

Author.Converter - Class in com.jagrosh.jdautilities.examples.doc

AUTHORIZE - Enum constant in enum class com.jagrosh.jdautilities.oauth2.requests.OAuth2URL

autoAdjust(boolean) - Method in class com.jagrosh.jdautilities.commons.utils.TableBuilder

Sets whether the table should be adjusted automatically according to the lengths of the values.

B

BASE_API_URL - Static variable in enum class com.jagrosh.jdautilities.oauth2.requests.OAuth2URL

BIG_LEFT - Static variable in class com.jagrosh.jdautilities.menu.ButtonEmbedPaginator

BIG_LEFT - Static variable in class com.jagrosh.jdautilities.menu.EmbedPaginator

BIG_LEFT - Static variable in class com.jagrosh.jdautilities.menu.Paginator

BIG_LEFT - Static variable in class com.jagrosh.jdautilities.menu.Slideshow

BIG_RIGHT - Static variable in class com.jagrosh.jdautilities.menu.ButtonEmbedPaginator

BIG_RIGHT - Static variable in class com.jagrosh.jdautilities.menu.EmbedPaginator

BIG_RIGHT - Static variable in class com.jagrosh.jdautilities.menu.Paginator

BIG_RIGHT - Static variable in class com.jagrosh.jdautilities.menu.Slideshow

BOT - Enum constant in enum class com.jagrosh.jdautilities.oauth2.Scope

For oauth2 bots, this puts the bot in the user's selected guild by default

botMissingPermMessage - Variable in class com.jagrosh.jdautilities.command.Interaction

The permission message used when the bot does not have the required permission.

botPermissions - Variable in class com.jagrosh.jdautilities.command.Interaction

Any Permissions the bot must have to use a command.

botPermissions() - Element in annotation interface com.jagrosh.jdautilities.command.annotation.JDACommand

The Permissions the bot must have on a guild to use this command.

build() - Method in class com.jagrosh.jdautilities.command.CommandClientBuilder

Builds a CommandClientImpl with the provided settings.

build() - Method in class com.jagrosh.jdautilities.commons.utils.TableBuilder

Builds a String table according to the settings made.

build() - Method in class com.jagrosh.jdautilities.menu.ButtonEmbedPaginator.Builder

Builds the ButtonEmbedPaginator with this Builder.

build() - Method in class com.jagrosh.jdautilities.menu.ButtonMenu.Builder

Builds the ButtonMenu with this Builder.

build() - Method in class com.jagrosh.jdautilities.menu.EmbedPaginator.Builder

Builds the EmbedPaginator with this Builder.

build() - Method in class com.jagrosh.jdautilities.menu.Menu.Builder

Builds the Menu corresponding to this Menu.Builder.

build() - Method in class com.jagrosh.jdautilities.menu.OrderedMenu.Builder

Builds the OrderedMenu with this Builder.

build() - Method in class com.jagrosh.jdautilities.menu.Paginator.Builder

Builds the Paginator with this Builder.

build() - Method in class com.jagrosh.jdautilities.menu.SelectionDialog.Builder

Builds the SelectionDialog with this Builder.

build() - Method in class com.jagrosh.jdautilities.menu.Slideshow.Builder

Builds the Slideshow with this Builder.

build() - Method in class com.jagrosh.jdautilities.oauth2.OAuth2Client.Builder

Finalizes and builds an OAuth2Client instance using this builder.

build(BiConsumer<Command, CommandEvent>) - Method in class com.jagrosh.jdautilities.command.CommandBuilder

Builds the Command using the previously provided information.

build(Consumer<CommandEvent>) - Method in class com.jagrosh.jdautilities.command.CommandBuilder

Builds the Command using the previously provided information.

buildCommandData() - Method in class com.jagrosh.jdautilities.command.ContextMenu

Builds CommandData for the ContextMenu upsert.

buildCommandData() - Method in interface com.jagrosh.jdautilities.command.interfaces.ISlashCommand

Builds CommandData for the SlashCommand upsert.

buildCommandData() - Method in class com.jagrosh.jdautilities.command.MessageContextMenu

buildCommandData() - Method in class com.jagrosh.jdautilities.command.SlashCommand

Builds CommandData for the SlashCommand upsert.

buildCommandData() - Method in class com.jagrosh.jdautilities.command.UserContextMenu

Builder() - Constructor for class com.jagrosh.jdautilities.menu.ButtonEmbedPaginator.Builder

Builder() - Constructor for class com.jagrosh.jdautilities.menu.ButtonMenu.Builder

Builder() - Constructor for class com.jagrosh.jdautilities.menu.EmbedPaginator.Builder

Builder() - Constructor for class com.jagrosh.jdautilities.menu.Menu.Builder

Builder() - Constructor for class com.jagrosh.jdautilities.menu.OrderedMenu.Builder

Builder() - Constructor for class com.jagrosh.jdautilities.menu.Paginator.Builder

Builder() - Constructor for class com.jagrosh.jdautilities.menu.SelectionDialog.Builder

Builder() - Constructor for class com.jagrosh.jdautilities.menu.Slideshow.Builder

Builder() - Constructor for class com.jagrosh.jdautilities.oauth2.OAuth2Client.Builder

buildRequest() - Method in class com.jagrosh.jdautilities.oauth2.requests.OAuth2Action

ButtonEmbedPaginator - Class in com.jagrosh.jdautilities.menu

A Menu implementation, nearly identical to EmbedPaginator, that displays an individual MessageEmbeds on each page instead of a list of text items.

ButtonEmbedPaginator(EventWaiter, Set<User>, Set<Role>, long, TimeUnit, BiFunction<Integer, Integer, String>, Consumer<Message>, boolean, List<MessageEmbed>, int, boolean, ButtonStyle) - Constructor for class com.jagrosh.jdautilities.menu.ButtonEmbedPaginator

ButtonEmbedPaginator.Builder - Class in com.jagrosh.jdautilities.menu

The Menu.Builder for a ButtonEmbedPaginator.

ButtonMenu - Class in com.jagrosh.jdautilities.menu

A Menu implementation that creates a organized display of emotes/emojis as buttons paired with options, and below the menu reactions corresponding to each button.

ButtonMenu.Builder - Class in com.jagrosh.jdautilities.menu

The Menu.Builder for a ButtonMenu.

C

CANCEL - Static variable in class com.jagrosh.jdautilities.menu.OrderedMenu

CANCEL - Static variable in class com.jagrosh.jdautilities.menu.SelectionDialog

category - Variable in class com.jagrosh.jdautilities.command.Command

The Category of the command.

category() - Element in annotation interface com.jagrosh.jdautilities.command.annotation.JDACommand

The JDACommand.Category for this command.

Category(String) - Constructor for class com.jagrosh.jdautilities.command.Command.Category

A Command Category containing a name.

Category(String, String, Predicate<CommandEvent>) - Constructor for class com.jagrosh.jdautilities.command.Command.Category

A Command Category containing a name, a Predicate, and a failure response.

Category(String, Predicate<CommandEvent>) - Constructor for class com.jagrosh.jdautilities.command.Command.Category

A Command Category containing a name and a Predicate.

CENTER - Enum constant in enum class com.jagrosh.jdautilities.commons.utils.TableBuilder.Alignment

CHANNEL - Enum constant in enum class com.jagrosh.jdautilities.command.CooldownScope

Applies the cooldown to the MessageChannel the command is called in.

CHANNEL_MENTION - Static variable in class com.jagrosh.jdautilities.commons.utils.FinderUtil

checkId(String) - Static method in class com.jagrosh.jdautilities.commons.utils.SafeIdUtil

Checks if the provided String ID is usable with MiscUtil.parseSnowflake(String).

children - Variable in class com.jagrosh.jdautilities.command.Command

The child commands of the command.

children - Variable in class com.jagrosh.jdautilities.command.SlashCommand

The child commands of the command.

children() - Element in annotation interface com.jagrosh.jdautilities.command.annotation.JDACommand

The names of any methods representing child commands for this command.

cleanCooldowns() - Method in interface com.jagrosh.jdautilities.command.CommandClient

Cleans up expired cooldowns to reduce memory.

cleanCooldowns() - Method in class com.jagrosh.jdautilities.command.impl.CommandClientImpl

clearChoices() - Method in class com.jagrosh.jdautilities.menu.OrderedMenu.Builder

Clears all previously set choices.

clearChoices() - Method in class com.jagrosh.jdautilities.menu.SelectionDialog.Builder

Clears the choices to be shown.

clearItems() - Method in class com.jagrosh.jdautilities.menu.ButtonEmbedPaginator.Builder

Clears all previously set items.

clearItems() - Method in class com.jagrosh.jdautilities.menu.EmbedPaginator.Builder

Clears all previously set items.

clearItems() - Method in class com.jagrosh.jdautilities.menu.Paginator.Builder

Clears the list of String items to paginate.

client - Variable in class com.jagrosh.jdautilities.command.SlashCommand

Deprecated.

This is now retrieved from SlashCommandEvent.getClient().

client - Variable in class com.jagrosh.jdautilities.oauth2.requests.OAuth2Action

codeblock(boolean) - Method in class com.jagrosh.jdautilities.commons.utils.TableBuilder

Sets whether the table should be embedded in a markdown code block (no special semantics).

columnDelimiter - Variable in class com.jagrosh.jdautilities.commons.utils.TableBuilder.Borders

com.jagrosh.jdautilities.command - package com.jagrosh.jdautilities.command

Items in this package pertain to the CommandClient and Commands.

com.jagrosh.jdautilities.command.annotation - package com.jagrosh.jdautilities.command.annotation

com.jagrosh.jdautilities.command.impl - package com.jagrosh.jdautilities.command.impl

com.jagrosh.jdautilities.command.interfaces - package com.jagrosh.jdautilities.command.interfaces

com.jagrosh.jdautilities.commons - package com.jagrosh.jdautilities.commons

Common package for all package for all utilities, used both internally and available for developer usage outside of the extension library.

com.jagrosh.jdautilities.commons.utils - package com.jagrosh.jdautilities.commons.utils

com.jagrosh.jdautilities.commons.waiter - package com.jagrosh.jdautilities.commons.waiter

com.jagrosh.jdautilities.doc - package com.jagrosh.jdautilities.doc

Items in this package pertain to the DocGenerator.

com.jagrosh.jdautilities.doc.standard - package com.jagrosh.jdautilities.doc.standard

com.jagrosh.jdautilities.examples.command - package com.jagrosh.jdautilities.examples.command

com.jagrosh.jdautilities.examples.doc - package com.jagrosh.jdautilities.examples.doc

com.jagrosh.jdautilities.menu - package com.jagrosh.jdautilities.menu

Menus package.
Contains the Menu class and all standard implementations of it: ButtonMenu
A menu where users select a choice via "reaction-buttons". OrderedMenu
A menu with 1 - 10 ordered items, each with their own reaction to choose them with. Paginator
A menu that paginates a number of items across a number of pages and uses reactions to traverse between them. SelectionDialog
A menu that orders choices and uses a indicator and reactions to choose one of the choices. Slideshow
A menu similar to the Paginator that displays a picture on each page. All menus also come with an implementation of a Menu.Builder as a static inner class of the corresponding Menu implementation, which are the main entryway to create said implementations for usage.

com.jagrosh.jdautilities.oauth2 - package com.jagrosh.jdautilities.oauth2

com.jagrosh.jdautilities.oauth2.entities - package com.jagrosh.jdautilities.oauth2.entities

com.jagrosh.jdautilities.oauth2.entities.impl - package com.jagrosh.jdautilities.oauth2.entities.impl

com.jagrosh.jdautilities.oauth2.exceptions - package com.jagrosh.jdautilities.oauth2.exceptions

com.jagrosh.jdautilities.oauth2.requests - package com.jagrosh.jdautilities.oauth2.requests

com.jagrosh.jdautilities.oauth2.session - package com.jagrosh.jdautilities.oauth2.session

com.jagrosh.jdautilities.oauth2.state - package com.jagrosh.jdautilities.oauth2.state

Command - Class in com.jagrosh.jdautilities.command

Commands In JDA-Utilities

Command() - Constructor for class com.jagrosh.jdautilities.command.Command

Command.Category - Class in com.jagrosh.jdautilities.command

To be used in Commands as a means of organizing commands into "Categories" as well as terminate command usage when the calling CommandEvent doesn't meet certain requirements.

CommandBuilder - Class in com.jagrosh.jdautilities.command

A chain-setter based builder for Commands.

CommandBuilder() - Constructor for class com.jagrosh.jdautilities.command.CommandBuilder

CommandClient - Interface in com.jagrosh.jdautilities.command

A Bot Client interface implemented on objects used to hold bot data.

CommandClientBuilder - Class in com.jagrosh.jdautilities.command

A simple builder used to create a CommandClientImpl.

CommandClientBuilder() - Constructor for class com.jagrosh.jdautilities.command.CommandClientBuilder

CommandClientImpl - Class in com.jagrosh.jdautilities.command.impl

An implementation of CommandClient to be used by a bot.

CommandClientImpl(String, String[], String, String, String[], Function<MessageReceivedEvent, String>, Function<MessageReceivedEvent, Boolean>, BiFunction<MessageReceivedEvent, Command, Boolean>, Activity, OnlineStatus, String, String, String, String, String, String, ArrayList<Command>, ArrayList<SlashCommand>, ArrayList<ContextMenu>, String, boolean, boolean, boolean, Consumer<CommandEvent>, String, ScheduledExecutorService, int, AnnotatedModuleCompiler, GuildSettingsManager) - Constructor for class com.jagrosh.jdautilities.command.impl.CommandClientImpl

CommandEvent - Class in com.jagrosh.jdautilities.command

A wrapper class for a MessageReceivedEvent, CommandClient, and String user arguments compatible with all Commands.

CommandEvent(MessageReceivedEvent, String, String, CommandClient) - Constructor for class com.jagrosh.jdautilities.command.CommandEvent

Constructor for a CommandEvent.

CommandInfo - Annotation Interface in com.jagrosh.jdautilities.doc.standard

A CommandDoc Annotation that contains basic information on command usage, declaration, and requirements.

CommandInfo.Converter - Class in com.jagrosh.jdautilities.doc.standard

The DocConverter for the @CommandInfo annotation.

CommandListener - Interface in com.jagrosh.jdautilities.command

An implementable "Listener" that can be added to a CommandClient and used to handle events relating to Commands.

compile(Object) - Method in interface com.jagrosh.jdautilities.command.AnnotatedModuleCompiler

Compiles one or more Commands using method annotations as for properties from the specified Object.

compile(Object) - Method in class com.jagrosh.jdautilities.command.impl.AnnotatedModuleCompilerImpl

compile(Object...) - Method in enum class com.jagrosh.jdautilities.oauth2.requests.OAuth2URL

compileQueryParams(Object...) - Method in enum class com.jagrosh.jdautilities.oauth2.requests.OAuth2URL

complete() - Method in class com.jagrosh.jdautilities.oauth2.requests.OAuth2Action

Synchronously executes this OAuth2Action, returning the value constructed from the response if it was successful, or throwing the Exception if it was not.

CONNECTIONS - Enum constant in enum class com.jagrosh.jdautilities.oauth2.Scope

Allows /users/@me/connections to return linked third-party accounts

consumeState(String) - Method in class com.jagrosh.jdautilities.oauth2.state.DefaultStateController

consumeState(String) - Method in interface com.jagrosh.jdautilities.oauth2.state.StateController

Consumes a state to get the corresponding redirect URI.

contains(Scope[], Scope) - Static method in enum class com.jagrosh.jdautilities.oauth2.Scope

contains(K) - Method in class com.jagrosh.jdautilities.commons.utils.FixedSizeCache

Checks if this FixedSizeCache contains a key.

ContextMenu - Class in com.jagrosh.jdautilities.command

Middleware for child context menu types.

ContextMenu() - Constructor for class com.jagrosh.jdautilities.command.ContextMenu

ConvertedBy - Annotation Interface in com.jagrosh.jdautilities.doc

Specifies an Annotation can be converted using the specified DocConverter value.

Converter() - Constructor for class com.jagrosh.jdautilities.doc.standard.CommandInfo.Converter

Converter() - Constructor for class com.jagrosh.jdautilities.doc.standard.Error.Converter

Converter() - Constructor for class com.jagrosh.jdautilities.doc.standard.RequiredPermissions.Converter

Converter() - Constructor for class com.jagrosh.jdautilities.examples.doc.Author.Converter

cooldown - Variable in class com.jagrosh.jdautilities.command.Interaction

An int number of seconds users must wait before using this command again.

cooldown() - Element in annotation interface com.jagrosh.jdautilities.command.annotation.JDACommand

The JDACommand.Cooldown for the command.

cooldownScope - Variable in class com.jagrosh.jdautilities.command.Interaction

The CooldownScope of the command.

CooldownScope - Enum Class in com.jagrosh.jdautilities.command

A series of Enums used for defining the scope size for a Interaction's cooldown.

createSession(SessionData) - Method in class com.jagrosh.jdautilities.oauth2.session.DefaultSessionController

createSession(SessionData) - Method in interface com.jagrosh.jdautilities.oauth2.session.SessionController

Creates a new Session using the specified SessionData.

crossDelimiter - Variable in class com.jagrosh.jdautilities.commons.utils.TableBuilder.Borders

CURRENT_USER - Enum constant in enum class com.jagrosh.jdautilities.oauth2.requests.OAuth2URL

CURRENT_USER_GUILDS - Enum constant in enum class com.jagrosh.jdautilities.oauth2.requests.OAuth2URL

D

DEFAULT_FAILURE - Static variable in class com.jagrosh.jdautilities.oauth2.requests.OAuth2Action

DEFAULT_SUCCESS - Static variable in class com.jagrosh.jdautilities.oauth2.requests.OAuth2Action

DefaultSessionController - Class in com.jagrosh.jdautilities.oauth2.session

The default SessionController implementation.

DefaultSessionController() - Constructor for class com.jagrosh.jdautilities.oauth2.session.DefaultSessionController

DefaultSessionController.DefaultSession - Class in com.jagrosh.jdautilities.oauth2.session

DefaultStateController - Class in com.jagrosh.jdautilities.oauth2.state

The default StateController implementation.

DefaultStateController() - Constructor for class com.jagrosh.jdautilities.oauth2.state.DefaultStateController

description() - Element in annotation interface com.jagrosh.jdautilities.doc.standard.CommandInfo

A description of this command, what it does, and (if needed) elaboration on the CommandInfo.usage().

descriptionLocalization - Variable in class com.jagrosh.jdautilities.command.SlashCommand

Localization of slash command description.

DISCORD_ID - Static variable in class com.jagrosh.jdautilities.commons.utils.FinderUtil

DISCORD_REST_VERSION - Static variable in interface com.jagrosh.jdautilities.oauth2.OAuth2Client

The REST version targeted by JDA-Utilities OAuth2.

display(MessageChannel) - Method in class com.jagrosh.jdautilities.menu.ButtonEmbedPaginator

Begins pagination on page 1 as a new Message in the provided MessageChannel.

display(MessageChannel) - Method in class com.jagrosh.jdautilities.menu.ButtonMenu

Shows the ButtonMenu as a new Message in the provided MessageChannel.

display(MessageChannel) - Method in class com.jagrosh.jdautilities.menu.EmbedPaginator

Begins pagination on page 1 as a new Message in the provided MessageChannel.

display(MessageChannel) - Method in class com.jagrosh.jdautilities.menu.Menu

Displays this Menu in a MessageChannel.

display(MessageChannel) - Method in class com.jagrosh.jdautilities.menu.OrderedMenu

Shows the OrderedMenu as a new Message in the provided MessageChannel.

display(MessageChannel) - Method in class com.jagrosh.jdautilities.menu.Paginator

Begins pagination on page 1 as a new Message in the provided MessageChannel.

display(MessageChannel) - Method in class com.jagrosh.jdautilities.menu.SelectionDialog

Shows the SelectionDialog as a new Message in the provided MessageChannel, starting with the first selection.

display(MessageChannel) - Method in class com.jagrosh.jdautilities.menu.Slideshow

Begins pagination on page 1 as a new Message in the provided MessageChannel.

display(Message) - Method in class com.jagrosh.jdautilities.menu.ButtonEmbedPaginator

Begins pagination on page 1 displaying this by editing the provided Message.

display(Message) - Method in class com.jagrosh.jdautilities.menu.ButtonMenu

Displays this ButtonMenu by editing the provided Message.

display(Message) - Method in class com.jagrosh.jdautilities.menu.EmbedPaginator

Begins pagination on page 1 displaying this by editing the provided Message.

display(Message) - Method in class com.jagrosh.jdautilities.menu.Menu

Displays this Menu as a designated Message.

display(Message) - Method in class com.jagrosh.jdautilities.menu.OrderedMenu

Displays this OrderedMenu by editing the provided Message.

display(Message) - Method in class com.jagrosh.jdautilities.menu.Paginator

Begins pagination on page 1 displaying this Pagination by editing the provided Message.

display(Message) - Method in class com.jagrosh.jdautilities.menu.SelectionDialog

Displays this SelectionDialog by editing the provided Message, starting with the first selection.

display(Message) - Method in class com.jagrosh.jdautilities.menu.Slideshow

Begins pagination on page 1 displaying this by editing the provided Message.

DocConverter<T extends Annotation> - Interface in com.jagrosh.jdautilities.doc

Converts an annotation of the specified type T into a String to be collected with other conversions into a single String documenting a class or method representing a command for a bot.

DocGenerator - Class in com.jagrosh.jdautilities.doc

An instance based documentation engine for bot commands written in JDA.

DocGenerator() - Constructor for class com.jagrosh.jdautilities.doc.DocGenerator

Gets a blank DocGenerator with no conversions loaded.

DocGenerator(int) - Constructor for class com.jagrosh.jdautilities.doc.DocGenerator

Gets a blank DocGenerator with no conversions loaded, and a cache with the specified max-size.

DocGenerator(String, int) - Constructor for class com.jagrosh.jdautilities.doc.DocGenerator

Gets a blank DocGenerator with no conversions loaded and with the specified separator, and a cache with the specified max-size.

DocMultiple - Annotation Interface in com.jagrosh.jdautilities.doc

A helper Annotation, useful for formatting multiple occurrences of the same CommandDoc annotation.

DOWN - Static variable in class com.jagrosh.jdautilities.menu.SelectionDialog

E

EMAIL - Enum constant in enum class com.jagrosh.jdautilities.oauth2.Scope

Enables /users/@me to return an email

EmbedPaginator - Class in com.jagrosh.jdautilities.menu

A Menu implementation, nearly identical to Paginator, that displays an individual MessageEmbed on each page instead of a list of text items.

EmbedPaginator(EventWaiter, Set<User>, Set<Role>, long, TimeUnit, BiFunction<Integer, Integer, String>, Consumer<Message>, boolean, List<MessageEmbed>, int, boolean, String, String, boolean) - Constructor for class com.jagrosh.jdautilities.menu.EmbedPaginator

EmbedPaginator.Builder - Class in com.jagrosh.jdautilities.menu

The Menu.Builder for a EmbedPaginator.

EMOTE_MENTION - Static variable in class com.jagrosh.jdautilities.commons.utils.FinderUtil

EMPTY_BODY - Static variable in class com.jagrosh.jdautilities.oauth2.requests.OAuth2Requester

equals(Object) - Method in class com.jagrosh.jdautilities.command.Command.Category

equals(Object) - Method in class com.jagrosh.jdautilities.oauth2.entities.impl.OAuth2UserImpl

equals(Object) - Method in class com.jagrosh.jdautilities.oauth2.session.SessionData

Error - Annotation Interface in com.jagrosh.jdautilities.doc.standard

A CommandDoc Annotation that describes a possible error or termination clause a Command might have during it's runtime.

Error.Converter - Class in com.jagrosh.jdautilities.doc.standard

The DocConverter for the @Error annotation.

Errors - Annotation Interface in com.jagrosh.jdautilities.doc.standard

The @Repeatable value for @Error.

EventWaiter - Class in com.jagrosh.jdautilities.commons.waiter

The EventWaiter is capable of handling specialized forms of Event that must meet criteria not normally specifiable without implementation of an EventListener.

EventWaiter() - Constructor for class com.jagrosh.jdautilities.commons.waiter.EventWaiter

Constructs an empty EventWaiter.

EventWaiter(ScheduledExecutorService, boolean) - Constructor for class com.jagrosh.jdautilities.commons.waiter.EventWaiter

Constructs an EventWaiter using the provided Executor as it's threadpool.

execute(CommandEvent) - Method in class com.jagrosh.jdautilities.command.Command

The main body method of a Command.

execute(CommandEvent) - Method in class com.jagrosh.jdautilities.command.SlashCommand

The main body method of a Command.

execute(CommandEvent) - Method in class com.jagrosh.jdautilities.examples.command.AboutCommand

execute(CommandEvent) - Method in class com.jagrosh.jdautilities.examples.command.GuildlistCommand

execute(CommandEvent) - Method in class com.jagrosh.jdautilities.examples.command.PingCommand

execute(CommandEvent) - Method in class com.jagrosh.jdautilities.examples.command.RoleinfoCommand

execute(CommandEvent) - Method in class com.jagrosh.jdautilities.examples.command.ServerinfoCommand

execute(CommandEvent) - Method in class com.jagrosh.jdautilities.examples.command.ShutdownCommand

execute(MessageContextMenuEvent) - Method in class com.jagrosh.jdautilities.command.MessageContextMenu

The main body method of a MessageContextMenu.

execute(SlashCommandEvent) - Method in class com.jagrosh.jdautilities.command.SlashCommand

The main body method of a SlashCommand.

execute(UserContextMenuEvent) - Method in class com.jagrosh.jdautilities.command.UserContextMenu

The main body method of a UserContextMenu.

F

failure(Response) - Static method in class com.jagrosh.jdautilities.oauth2.entities.impl.OAuth2ClientImpl

findBannedUsers(String, Guild) - Static method in class com.jagrosh.jdautilities.commons.utils.FinderUtil

Queries a provided Guild for a banned User.

findCategories(String, Guild) - Static method in class com.jagrosh.jdautilities.commons.utils.FinderUtil

Queries a provided Guild for Categories.

findCategories(String, JDA) - Static method in class com.jagrosh.jdautilities.commons.utils.FinderUtil

Queries a provided instance of JDA for Categories.

findEmotes(String, Guild) - Static method in class com.jagrosh.jdautilities.commons.utils.FinderUtil

Queries a provided Guild for Emotes.

findEmotes(String, JDA) - Static method in class com.jagrosh.jdautilities.commons.utils.FinderUtil

Queries a provided instance of JDA for Emojis.

FinderUtil - Class in com.jagrosh.jdautilities.commons.utils

A series of query based utilities for finding entities, either globally across all accessible Guilds, or locally to a specified Guild.

findMembers(String, Guild) - Static method in class com.jagrosh.jdautilities.commons.utils.FinderUtil

Queries a provided Guild for Members.

findRoles(String, Guild) - Static method in class com.jagrosh.jdautilities.commons.utils.FinderUtil

Queries a provided Guild for Roles.

findShardCategories(String, JDA) - Static method in class com.jagrosh.jdautilities.commons.utils.FinderUtil

Queries a provided instance of JDA for Categories.

findShardEmotes(String, JDA) - Static method in class com.jagrosh.jdautilities.commons.utils.FinderUtil

Queries a provided instance of JDA for Emotes.

findShardTextChannels(String, JDA) - Static method in class com.jagrosh.jdautilities.commons.utils.FinderUtil

Queries a provided instance of JDA for TextChannels.

findShardUsers(String, JDA) - Static method in class com.jagrosh.jdautilities.commons.utils.FinderUtil

Queries a provided instance of JDA for Users.

findShardVoiceChannels(String, JDA) - Static method in class com.jagrosh.jdautilities.commons.utils.FinderUtil

Queries a provided instance of JDA for VoiceChannels.

findTextChannels(String, Guild) - Static method in class com.jagrosh.jdautilities.commons.utils.FinderUtil

Queries a provided Guild for TextChannels.

findTextChannels(String, JDA) - Static method in class com.jagrosh.jdautilities.commons.utils.FinderUtil

Queries a provided instance of JDA for TextChannels.

findUsers(String, JDA) - Static method in class com.jagrosh.jdautilities.commons.utils.FinderUtil

Queries a provided instance of JDA for Users.

findVoiceChannels(String, Guild) - Static method in class com.jagrosh.jdautilities.commons.utils.FinderUtil

Queries a provided Guild for VoiceChannels.

findVoiceChannels(String, JDA) - Static method in class com.jagrosh.jdautilities.commons.utils.FinderUtil

Queries a provided instance of JDA for VoiceChannels.

firstColumnCrossDelimiter - Variable in class com.jagrosh.jdautilities.commons.utils.TableBuilder.Borders

firstColumnDelimiter - Variable in class com.jagrosh.jdautilities.commons.utils.TableBuilder.Borders

firstColumnLowerIntersection - Variable in class com.jagrosh.jdautilities.commons.utils.TableBuilder.Borders

firstColumnUpperIntersection - Variable in class com.jagrosh.jdautilities.commons.utils.TableBuilder.Borders

FixedSizeCache<K,V> - Class in com.jagrosh.jdautilities.commons.utils

A simple first-in-first-out key-value storage that uses a HashMap to store keys and values while simultaneously registering the keys to an array to maintain a specified maximum capacity.

FixedSizeCache(int) - Constructor for class com.jagrosh.jdautilities.commons.utils.FixedSizeCache

Constructs a new FixedSizeCache with a set maximum capacity.

forcedGuildId() - Method in interface com.jagrosh.jdautilities.command.CommandClient

Returns the forced Guild ID for automatic slash command upserts

forcedGuildId() - Method in class com.jagrosh.jdautilities.command.impl.CommandClientImpl

forceGuildOnly(long) - Method in class com.jagrosh.jdautilities.command.CommandClientBuilder

Forces Guild Only for SlashCommands.

forceGuildOnly(String) - Method in class com.jagrosh.jdautilities.command.CommandClientBuilder

Forces Guild Only for SlashCommands.

frame(boolean) - Method in class com.jagrosh.jdautilities.commons.utils.TableBuilder

Sets whether the table should be framed.

FRAME - Static variable in class com.jagrosh.jdautilities.commons.utils.TableBuilder.Borders

An instance that can be used for framed tables without any special characters for headers or row name columns.

from(String) - Static method in enum class com.jagrosh.jdautilities.oauth2.Scope

Gets a scope based on the specified text key.

FULL_USER_REF - Static variable in class com.jagrosh.jdautilities.commons.utils.FinderUtil

G

GDM_JOIN - Enum constant in enum class com.jagrosh.jdautilities.oauth2.Scope

Allows your app to join users to a group dm

generateAuthorizationURL(String, Scope...) - Method in class com.jagrosh.jdautilities.oauth2.entities.impl.OAuth2ClientImpl

generateAuthorizationURL(String, Scope...) - Method in interface com.jagrosh.jdautilities.oauth2.OAuth2Client

Generates a formatted authorization URL from the provided redirect URI fragment and Scopes.

generateNewState(String) - Method in class com.jagrosh.jdautilities.oauth2.state.DefaultStateController

generateNewState(String) - Method in interface com.jagrosh.jdautilities.oauth2.state.StateController

Generates a new state string using the provided redirect URI.

get(K) - Method in class com.jagrosh.jdautilities.commons.utils.FixedSizeCache

Retrieves a value from this FixedSizeCache corresponding to the specified key, or null if there is no corresponding value to be retrieved.

getAccessToken() - Method in class com.jagrosh.jdautilities.oauth2.session.DefaultSessionController.DefaultSession

getAccessToken() - Method in interface com.jagrosh.jdautilities.oauth2.session.Session

Gets the session's access token.

getAccessToken() - Method in class com.jagrosh.jdautilities.oauth2.session.SessionData

Gets the session access token.

getAliases() - Method in class com.jagrosh.jdautilities.command.Command

Gets the Command.aliases for the Command.

getAltPrefix() - Method in interface com.jagrosh.jdautilities.command.CommandClient

Gets the Client's alternate prefix.

getAltPrefix() - Method in class com.jagrosh.jdautilities.command.impl.CommandClientImpl

getArgs() - Method in class com.jagrosh.jdautilities.command.CommandEvent

Returns the user's String arguments for the command.

getArguments() - Method in class com.jagrosh.jdautilities.command.Command

Gets the Command.arguments for the Command.

getAsMention() - Method in class com.jagrosh.jdautilities.oauth2.entities.impl.OAuth2UserImpl

getAsMention() - Method in interface com.jagrosh.jdautilities.oauth2.entities.OAuth2User

Gets the user as a discord formatted mention:
<@SNOWFLAKE_ID>

getAuthor() - Method in class com.jagrosh.jdautilities.command.CommandEvent

Gets the User who triggered this CommandEvent.

getAvatarId() - Method in class com.jagrosh.jdautilities.oauth2.entities.impl.OAuth2UserImpl

getAvatarId() - Method in interface com.jagrosh.jdautilities.oauth2.entities.OAuth2User

Gets the user's avatar ID, or null if they have not set one.

getAvatarUrl() - Method in class com.jagrosh.jdautilities.oauth2.entities.impl.OAuth2UserImpl

getAvatarUrl() - Method in interface com.jagrosh.jdautilities.oauth2.entities.OAuth2User

Gets the user's avatar URL, or null if they have not set one.

getBody() - Method in class com.jagrosh.jdautilities.oauth2.requests.OAuth2Action

getBotPermissions() - Method in class com.jagrosh.jdautilities.command.Interaction

Gets the botPermissions for the Interaction.

getCategory() - Method in class com.jagrosh.jdautilities.command.Command

Gets the Command.category for the Command.

getChannel() - Method in class com.jagrosh.jdautilities.command.CommandEvent

Gets the MessageChannel that the CommandEvent was triggered on.

getChannelType() - Method in class com.jagrosh.jdautilities.command.CommandEvent

Gets the ChannelType of the MessageChannel that the CommandEvent was triggered on.

getChildren() - Method in class com.jagrosh.jdautilities.command.Command

Gets the Command.children for the Command.

getChildren() - Method in class com.jagrosh.jdautilities.command.SlashCommand

Gets the Command.children for the Command.

getClient() - Method in class com.jagrosh.jdautilities.command.CommandEvent

Returns the CommandClient that initiated this CommandEvent.

getClient() - Method in class com.jagrosh.jdautilities.command.MessageContextMenuEvent

Returns the CommandClient that initiated this event.

getClient() - Method in class com.jagrosh.jdautilities.command.SlashCommand

Deprecated.

This is now retrieved from SlashCommandEvent.getClient().

getClient() - Method in class com.jagrosh.jdautilities.command.SlashCommandEvent

The CommandClient that this event was triggered from.

getClient() - Method in class com.jagrosh.jdautilities.command.UserContextMenuEvent

Returns the CommandClient that triggered this event.

getClient() - Method in class com.jagrosh.jdautilities.oauth2.entities.impl.OAuth2GuildImpl

getClient() - Method in class com.jagrosh.jdautilities.oauth2.entities.impl.OAuth2UserImpl

getClient() - Method in interface com.jagrosh.jdautilities.oauth2.entities.OAuth2Guild

Gets the underlying OAuth2Client that created this OAuth2Guild.

getClient() - Method in interface com.jagrosh.jdautilities.oauth2.entities.OAuth2User

Gets the underlying OAuth2Client that created this OAuth2User.

getClient() - Method in class com.jagrosh.jdautilities.oauth2.requests.OAuth2Action

Gets the client responsible for creating this OAuth2Action.

getCommands() - Method in interface com.jagrosh.jdautilities.command.CommandClient

Returns the list of registered Commands during this session.

getCommands() - Method in class com.jagrosh.jdautilities.command.impl.CommandClientImpl

getCommandUses(Command) - Method in interface com.jagrosh.jdautilities.command.CommandClient

Gets the number of uses for the provide Command during this session, or 0 if the command is not registered to this CommandClient.

getCommandUses(Command) - Method in class com.jagrosh.jdautilities.command.impl.CommandClientImpl

getCommandUses(String) - Method in interface com.jagrosh.jdautilities.command.CommandClient

Gets the number of uses for a Command during this session matching the provided String name, or 0 if there is no Command with the name.

getCommandUses(String) - Method in class com.jagrosh.jdautilities.command.impl.CommandClientImpl

getContextMenus() - Method in interface com.jagrosh.jdautilities.command.CommandClient

Returns the list of registered ContextMenus during this session.

getContextMenus() - Method in class com.jagrosh.jdautilities.command.impl.CommandClientImpl

getCooldown() - Method in class com.jagrosh.jdautilities.command.Interaction

Gets the cooldown for the Interaction.

getCooldown(String) - Method in interface com.jagrosh.jdautilities.command.CommandClient

Gets the OffsetDateTime that the specified cooldown expires.

getCooldown(String) - Method in class com.jagrosh.jdautilities.command.impl.CommandClientImpl

getCooldownError(CommandEvent, int) - Method in class com.jagrosh.jdautilities.command.Command

Gets an error message for this Command under the provided CommanEvent.

getCooldownError(SlashCommandEvent, int, CommandClient) - Method in class com.jagrosh.jdautilities.command.SlashCommand

Gets an error message for this Command under the provided SlashCommandEvent.

getCooldownError(GenericCommandInteractionEvent, int, CommandClient) - Method in class com.jagrosh.jdautilities.command.ContextMenu

Gets an error message for this Context Menu under the provided GenericCommandInteractionEvent.

getCooldownKey(CommandEvent) - Method in class com.jagrosh.jdautilities.command.Command

Gets the proper cooldown key for this Command under the provided CommandEvent.

getCooldownKey(SlashCommandEvent) - Method in class com.jagrosh.jdautilities.command.SlashCommand

Gets the proper cooldown key for this Command under the provided SlashCommandEvent.

getCooldownKey(GenericCommandInteractionEvent) - Method in class com.jagrosh.jdautilities.command.ContextMenu

Gets the proper cooldown key for this Command under the provided GenericCommandInteractionEvent.

getCooldownScope() - Method in class com.jagrosh.jdautilities.command.Interaction

Gets the cooldown for the Interaction.

getCoOwnerIds() - Method in interface com.jagrosh.jdautilities.command.CommandClient

Gets the ID(s) of any CoOwners of this bot as a String Array.

getCoOwnerIds() - Method in class com.jagrosh.jdautilities.command.impl.CommandClientImpl

getCoOwnerIdsLong() - Method in interface com.jagrosh.jdautilities.command.CommandClient

Gets the ID(s) of any CoOwners of this bot as a long Array.

getCoOwnerIdsLong() - Method in class com.jagrosh.jdautilities.command.impl.CommandClientImpl

getDefaultAvatarId() - Method in class com.jagrosh.jdautilities.oauth2.entities.impl.OAuth2UserImpl

getDefaultAvatarId() - Method in interface com.jagrosh.jdautilities.oauth2.entities.OAuth2User

Gets the user's avatar URL.

getDefaultAvatarUrl() - Method in class com.jagrosh.jdautilities.oauth2.entities.impl.OAuth2UserImpl

getDefaultAvatarUrl() - Method in interface com.jagrosh.jdautilities.oauth2.entities.OAuth2User

Gets the user's default avatar ID.

getDefaultGenerator() - Static method in class com.jagrosh.jdautilities.doc.DocGenerator

Gets a default DocGenerator with standard conversions loaded.

getDescriptionLocalization() - Method in class com.jagrosh.jdautilities.command.SlashCommand

Gets the specified localizations of slash command descriptions.

getDiscriminator() - Method in class com.jagrosh.jdautilities.oauth2.entities.impl.OAuth2UserImpl

getDiscriminator() - Method in interface com.jagrosh.jdautilities.oauth2.entities.OAuth2User

Gets the user's discriminator.

getDocFor(Class<?>) - Method in class com.jagrosh.jdautilities.doc.DocGenerator

Reads CommandDoc from the provided Class and returns the String formatted and from it.

getDocFor(Method) - Method in class com.jagrosh.jdautilities.doc.DocGenerator

Reads CommandDoc from the provided Method and returns the String formatted and from it.

getDocForMethods(Class<?>) - Method in class com.jagrosh.jdautilities.doc.DocGenerator

Reads all Methods from the provided Class and returns a List of CommandDoc of each.

getEffectiveAvatarUrl() - Method in class com.jagrosh.jdautilities.oauth2.entities.impl.OAuth2UserImpl

getEffectiveAvatarUrl() - Method in interface com.jagrosh.jdautilities.oauth2.entities.OAuth2User

Gets the user's avatar URL, or their default avatar URL if they do not have a custom avatar set on their account.

getEmail() - Method in class com.jagrosh.jdautilities.oauth2.entities.impl.OAuth2UserImpl

getEmail() - Method in interface com.jagrosh.jdautilities.oauth2.entities.OAuth2User

Gets the user's email address that is associated with their Discord account.

getError() - Method in interface com.jagrosh.jdautilities.command.CommandClient

Gets the error emoji.

getError() - Method in class com.jagrosh.jdautilities.command.impl.CommandClientImpl

getEvent() - Method in class com.jagrosh.jdautilities.command.CommandEvent

Returns the underlying MessageReceivedEvent for this CommandEvent.

getExpiration() - Method in class com.jagrosh.jdautilities.oauth2.session.DefaultSessionController.DefaultSession

getExpiration() - Method in interface com.jagrosh.jdautilities.oauth2.session.Session

Gets the session's expiration time.

getExpiration() - Method in class com.jagrosh.jdautilities.oauth2.session.SessionData

Gets the session expiration time.

getFailureResponse() - Method in class com.jagrosh.jdautilities.command.Command.Category

Gets the failure response of the Category.

getGuild() - Method in class com.jagrosh.jdautilities.command.CommandEvent

Gets the Guild that this CommandEvent was triggered on.

getGuildChannel() - Method in class com.jagrosh.jdautilities.command.CommandEvent

Gets the GuildMessageChannel that this CommandEvent may have taken place on, or null if it didn't happen on a GuildMessageChannel.

getGuilds(Session) - Method in class com.jagrosh.jdautilities.oauth2.entities.impl.OAuth2ClientImpl

getGuilds(Session) - Method in interface com.jagrosh.jdautilities.oauth2.OAuth2Client

Requests a list of OAuth2Guilds from the Session.

getHeaders() - Method in class com.jagrosh.jdautilities.oauth2.requests.OAuth2Action

getHelp() - Method in class com.jagrosh.jdautilities.command.Command

Gets the Command.help for the Command.

getHelpWord() - Method in interface com.jagrosh.jdautilities.command.CommandClient

Gets the word used to invoke a help DM.

getHelpWord() - Method in class com.jagrosh.jdautilities.command.impl.CommandClientImpl

getIconId() - Method in class com.jagrosh.jdautilities.oauth2.entities.impl.OAuth2GuildImpl

getIconId() - Method in interface com.jagrosh.jdautilities.oauth2.entities.OAuth2Guild

Gets the Guild's icon ID, or null if the Guild does not have an icon.

getIconUrl() - Method in class com.jagrosh.jdautilities.oauth2.entities.impl.OAuth2GuildImpl

getIconUrl() - Method in interface com.jagrosh.jdautilities.oauth2.entities.OAuth2Guild

Gets the Guild's icon URL, or null if the Guild does not have an icon.

getId() - Method in class com.jagrosh.jdautilities.oauth2.entities.impl.OAuth2ClientImpl

getId() - Method in class com.jagrosh.jdautilities.oauth2.entities.impl.OAuth2UserImpl

getId() - Method in interface com.jagrosh.jdautilities.oauth2.entities.OAuth2User

Gets the user's Snowflake ID as a String.

getId() - Method in interface com.jagrosh.jdautilities.oauth2.OAuth2Client

Gets the client ID for this OAuth2Client.

getIdentifier() - Method in class com.jagrosh.jdautilities.oauth2.session.SessionData

Gets the session identifier.

getIdLong() - Method in class com.jagrosh.jdautilities.oauth2.entities.impl.OAuth2GuildImpl

getIdLong() - Method in class com.jagrosh.jdautilities.oauth2.entities.impl.OAuth2UserImpl

getIdLong() - Method in interface com.jagrosh.jdautilities.oauth2.entities.OAuth2User

Gets the user's Snowflake ID as a long.

getItems() - Method in class com.jagrosh.jdautilities.menu.Paginator.Builder

Gets the String list of items to paginate.

getJDA() - Method in class com.jagrosh.jdautilities.command.CommandEvent

Gets the instance of JDA that this CommandEvent was caught by.

getJDAUser(JDA) - Method in class com.jagrosh.jdautilities.oauth2.entities.impl.OAuth2UserImpl

getJDAUser(JDA) - Method in interface com.jagrosh.jdautilities.oauth2.entities.OAuth2User

Gets the corresponding JDA User from the provided instance of JDA.

getJDAUser(ShardManager) - Method in class com.jagrosh.jdautilities.oauth2.entities.impl.OAuth2UserImpl

getJDAUser(ShardManager) - Method in interface com.jagrosh.jdautilities.oauth2.entities.OAuth2User

Gets the corresponding JDA User from the provided ShardManager.

getListener() - Method in interface com.jagrosh.jdautilities.command.CommandClient

Returns the current CommandListener.

getListener() - Method in class com.jagrosh.jdautilities.command.impl.CommandClientImpl

getMember() - Method in class com.jagrosh.jdautilities.command.CommandEvent

Gets the Member that triggered this CommandEvent.

getMessage() - Method in class com.jagrosh.jdautilities.command.CommandEvent

Gets the Message responsible for triggering this CommandEvent.

getMethod() - Method in class com.jagrosh.jdautilities.oauth2.requests.OAuth2Action

getName() - Method in class com.jagrosh.jdautilities.command.Command.Category

Gets the name of the Category.

getName() - Method in class com.jagrosh.jdautilities.command.Command

Gets the Command.name for the Command.

getName() - Method in class com.jagrosh.jdautilities.command.ContextMenu

Gets the ContextMenu.name for the Context Menu.

getName() - Method in interface com.jagrosh.jdautilities.command.interfaces.ISlashCommand

Gets the name for the Command.

getName() - Method in class com.jagrosh.jdautilities.oauth2.entities.impl.OAuth2GuildImpl

getName() - Method in class com.jagrosh.jdautilities.oauth2.entities.impl.OAuth2UserImpl

getName() - Method in interface com.jagrosh.jdautilities.oauth2.entities.OAuth2Guild

Gets the Guild's name.

getName() - Method in interface com.jagrosh.jdautilities.oauth2.entities.OAuth2User

Gets the user's account name.

getNameLocalization() - Method in class com.jagrosh.jdautilities.command.ContextMenu

Gets the specified localizations of menu name.

getNameLocalization() - Method in class com.jagrosh.jdautilities.command.SlashCommand

Gets the specified localizations of slash command names.

getOptions() - Method in class com.jagrosh.jdautilities.command.SlashCommand

Gets the options associated with this command.

getOwnerId() - Method in interface com.jagrosh.jdautilities.command.CommandClient

Gets the ID of the owner of this bot as a String.

getOwnerId() - Method in class com.jagrosh.jdautilities.command.impl.CommandClientImpl

getOwnerIdLong() - Method in interface com.jagrosh.jdautilities.command.CommandClient

Gets the ID of the owner of this bot as a long.

getOwnerIdLong() - Method in class com.jagrosh.jdautilities.command.impl.CommandClientImpl

getPermissions() - Method in class com.jagrosh.jdautilities.oauth2.entities.impl.OAuth2GuildImpl

getPermissions() - Method in interface com.jagrosh.jdautilities.oauth2.entities.OAuth2Guild

Gets the Session User's Permissions for the Guild.

getPermissionsRaw() - Method in class com.jagrosh.jdautilities.oauth2.entities.impl.OAuth2GuildImpl

getPermissionsRaw() - Method in interface com.jagrosh.jdautilities.oauth2.entities.OAuth2Guild

Gets the Session User's raw permission value for the Guild.

getPrefix() - Method in interface com.jagrosh.jdautilities.command.CommandClient

Gets the Client's prefix.

getPrefix() - Method in class com.jagrosh.jdautilities.command.CommandEvent

Returns the prefix used when this event was raised.

getPrefix() - Method in class com.jagrosh.jdautilities.command.impl.CommandClientImpl

getPrefixes() - Method in interface com.jagrosh.jdautilities.command.CommandClient

Gets the array of prefixes

getPrefixes() - Method in interface com.jagrosh.jdautilities.command.GuildSettingsProvider

Gets a Collection of String prefixes available for the Guild represented by this implementation.

getPrefixes() - Method in class com.jagrosh.jdautilities.command.impl.CommandClientImpl

getPrefixFunction() - Method in interface com.jagrosh.jdautilities.command.CommandClient

Gets the prefix BiConsumer

getPrefixFunction() - Method in class com.jagrosh.jdautilities.command.impl.CommandClientImpl

getPrivateChannel() - Method in class com.jagrosh.jdautilities.command.CommandEvent

Gets the PrivateChannel that this CommandEvent may have taken place on, or null if it didn't happen on a PrivateChannel.

getRefreshToken() - Method in class com.jagrosh.jdautilities.oauth2.session.DefaultSessionController.DefaultSession

getRefreshToken() - Method in interface com.jagrosh.jdautilities.oauth2.session.Session

Gets the session's refresh token.

getRefreshToken() - Method in class com.jagrosh.jdautilities.oauth2.session.SessionData

Gets the session refresh token.

getRemainingCooldown(String) - Method in interface com.jagrosh.jdautilities.command.CommandClient

Gets the remaining number of seconds on the specified cooldown.

getRemainingCooldown(String) - Method in class com.jagrosh.jdautilities.command.impl.CommandClientImpl

getRequester() - Method in class com.jagrosh.jdautilities.oauth2.entities.impl.OAuth2ClientImpl

Gets the internal OAuth2Requester used by this OAuth2Client.

getRequiredRole() - Method in class com.jagrosh.jdautilities.command.Command

Gets the Command.requiredRole for the Command.

getResponseNumber() - Method in class com.jagrosh.jdautilities.command.CommandEvent

Gets the response number for the MessageReceivedEvent.

getRoute() - Method in enum class com.jagrosh.jdautilities.oauth2.requests.OAuth2URL

getRouteWithBaseUrl() - Method in enum class com.jagrosh.jdautilities.oauth2.requests.OAuth2URL

getScheduleExecutor() - Method in interface com.jagrosh.jdautilities.command.CommandClient

Gets the ScheduledExecutorService held by this client.

getScheduleExecutor() - Method in class com.jagrosh.jdautilities.command.impl.CommandClientImpl

getScopes() - Method in class com.jagrosh.jdautilities.oauth2.session.DefaultSessionController.DefaultSession

getScopes() - Method in interface com.jagrosh.jdautilities.oauth2.session.Session

Gets the session's Scopes.

getScopes() - Method in class com.jagrosh.jdautilities.oauth2.session.SessionData

Gets the session Scopes.

getSecret() - Method in class com.jagrosh.jdautilities.oauth2.entities.impl.OAuth2ClientImpl

getSecret() - Method in interface com.jagrosh.jdautilities.oauth2.OAuth2Client

Gets the client's secret.

getSelfMember() - Method in class com.jagrosh.jdautilities.command.CommandEvent

Gets a Member representing the bot, or null if the event does not take place on a Guild.

getSelfUser() - Method in class com.jagrosh.jdautilities.command.CommandEvent

Gets a SelfUser representing the bot.

getServerInvite() - Method in interface com.jagrosh.jdautilities.command.CommandClient

Gets the invite to the bot's support server.

getServerInvite() - Method in class com.jagrosh.jdautilities.command.impl.CommandClientImpl

getSession() - Method in class com.jagrosh.jdautilities.oauth2.entities.impl.OAuth2UserImpl

getSession() - Method in interface com.jagrosh.jdautilities.oauth2.entities.OAuth2User

Gets the originating Session that is responsible for this OAuth2User.

getSession(String) - Method in class com.jagrosh.jdautilities.oauth2.session.DefaultSessionController

getSession(String) - Method in interface com.jagrosh.jdautilities.oauth2.session.SessionController

Gets a Session that was previously created using the provided identifier.

getSessionController() - Method in class com.jagrosh.jdautilities.oauth2.entities.impl.OAuth2ClientImpl

getSessionController() - Method in interface com.jagrosh.jdautilities.oauth2.OAuth2Client

Gets the client's SessionController.

getSettings(Guild) - Method in interface com.jagrosh.jdautilities.command.GuildSettingsManager

Gets settings for a specified Guild as an object of the specified type T, or null if the guild has no settings.

getSettingsFor(Guild) - Method in interface com.jagrosh.jdautilities.command.CommandClient

Returns an Object of the type parameter that should contain settings relating to the specified Guild.

getSettingsFor(Guild) - Method in class com.jagrosh.jdautilities.command.impl.CommandClientImpl

getSettingsManager() - Method in interface com.jagrosh.jdautilities.command.CommandClient

Returns the type of GuildSettingsManager, the same type of one provided when building this CommandClient, or null if one was not provided there.

getSettingsManager() - Method in class com.jagrosh.jdautilities.command.impl.CommandClientImpl

getSlashCommands() - Method in interface com.jagrosh.jdautilities.command.CommandClient

Returns the list of registered SlashCommands during this session.

getSlashCommands() - Method in class com.jagrosh.jdautilities.command.impl.CommandClientImpl

getStartTime() - Method in interface com.jagrosh.jdautilities.command.CommandClient

Gets the time this CommandClient implementation was created.

getStartTime() - Method in class com.jagrosh.jdautilities.command.impl.CommandClientImpl

getStateController() - Method in class com.jagrosh.jdautilities.oauth2.entities.impl.OAuth2ClientImpl

getStateController() - Method in interface com.jagrosh.jdautilities.oauth2.OAuth2Client

Gets the client's StateController.

getSubcommandGroup() - Method in class com.jagrosh.jdautilities.command.SlashCommand

Gets the subcommand data associated with this subcommand.

getSuccess() - Method in interface com.jagrosh.jdautilities.command.CommandClient

Gets the success emoji.

getSuccess() - Method in class com.jagrosh.jdautilities.command.impl.CommandClientImpl

getText() - Method in enum class com.jagrosh.jdautilities.oauth2.Scope

The text key associated with this scope.

getTextChannel() - Method in class com.jagrosh.jdautilities.command.CommandEvent

Gets the TextChannel that this CommandEvent may have taken place on, or null if it didn't happen on a TextChannel.

getTextChannel() - Method in class com.jagrosh.jdautilities.command.SlashCommandEvent

Gets the TextChannel that this CommandEvent may have taken place on, or null if it didn't happen on a TextChannel.

getTextualPrefix() - Method in interface com.jagrosh.jdautilities.command.CommandClient

Returns the visual representation of the bot's prefix.

getTextualPrefix() - Method in class com.jagrosh.jdautilities.command.impl.CommandClientImpl

getTokenType() - Method in class com.jagrosh.jdautilities.oauth2.session.DefaultSessionController.DefaultSession

getTokenType() - Method in interface com.jagrosh.jdautilities.oauth2.session.Session

Gets the session's token type.

getTokenType() - Method in class com.jagrosh.jdautilities.oauth2.session.SessionData

Gets the session token type.

getTotalGuilds() - Method in interface com.jagrosh.jdautilities.command.CommandClient

Gets an a recently updated count of all the Guilds the bot is connected to on all shards.

getTotalGuilds() - Method in class com.jagrosh.jdautilities.command.impl.CommandClientImpl

getType() - Method in class com.jagrosh.jdautilities.command.ContextMenu

Gets the type of context menu.

getUrl() - Method in class com.jagrosh.jdautilities.oauth2.requests.OAuth2Action

getUser(Session) - Method in class com.jagrosh.jdautilities.oauth2.entities.impl.OAuth2ClientImpl

getUser(Session) - Method in interface com.jagrosh.jdautilities.oauth2.OAuth2Client

Requests a OAuth2User from the Session.

getUserPermissions() - Method in class com.jagrosh.jdautilities.command.Interaction

Gets the userPermissions for the Interaction.

getWarning() - Method in interface com.jagrosh.jdautilities.command.CommandClient

Gets the warning emoji.

getWarning() - Method in class com.jagrosh.jdautilities.command.impl.CommandClientImpl

GITHUB - Static variable in class com.jagrosh.jdautilities.commons.JDAUtilitiesInfo

GLOBAL - Enum constant in enum class com.jagrosh.jdautilities.command.CooldownScope

Applies this cooldown globally.

GUILD - Enum constant in enum class com.jagrosh.jdautilities.command.CooldownScope

Applies the cooldown to the Guild the command is called in.

GuildlistCommand - Class in com.jagrosh.jdautilities.examples.command

GuildlistCommand(EventWaiter) - Constructor for class com.jagrosh.jdautilities.examples.command.GuildlistCommand

guildOnly - Variable in class com.jagrosh.jdautilities.command.Interaction

true if the command may only be used in a Guild, false if it may be used in both a Guild and a DM.

guildOnly() - Element in annotation interface com.jagrosh.jdautilities.command.annotation.JDACommand

Whether or not the command is only usable in a guild.

GUILDS - Enum constant in enum class com.jagrosh.jdautilities.oauth2.Scope

Allows /users/@me/guilds to return basic information about all of a user's guilds

GUILDS_JOIN - Enum constant in enum class com.jagrosh.jdautilities.oauth2.Scope

Allows /invites/{invite.id} to be used for joining users to a guild

GuildSettingsManager<T> - Interface in com.jagrosh.jdautilities.command

An implementable frame for classes that handle Guild-Specific settings.

GuildSettingsProvider - Interface in com.jagrosh.jdautilities.command

A basic frame that is optionally implementable by objects returned from GuildSettingsManager#getSettings(Guild).

H

handle(Response) - Method in class com.jagrosh.jdautilities.oauth2.requests.OAuth2Action

hashCode() - Method in class com.jagrosh.jdautilities.command.Command.Category

hashCode() - Method in class com.jagrosh.jdautilities.oauth2.entities.impl.OAuth2UserImpl

hasOption(SlashCommandEvent, String) - Static method in class pw.chew.jdachewtils.command.OptionHelper

Deprecated.

Use SlashCommandEvent.hasOption(String) instead.

hasOption(String) - Method in class com.jagrosh.jdautilities.command.SlashCommandEvent

Will return if the provided key resolves into a provided Option for the SlashCommand.

hasPermission(Permission...) - Method in class com.jagrosh.jdautilities.oauth2.entities.impl.OAuth2GuildImpl

hasPermission(Permission...) - Method in interface com.jagrosh.jdautilities.oauth2.entities.OAuth2Guild

Whether or not the Session User has all of the specified Permissions in the Guild.

hasQueryParams() - Method in enum class com.jagrosh.jdautilities.oauth2.requests.OAuth2URL

HEADER_FRAME - Static variable in class com.jagrosh.jdautilities.commons.utils.TableBuilder.Borders

An instance that can be used for framed tables with a header row, for it provides a special delimiter for the first row.

HEADER_PLAIN - Static variable in class com.jagrosh.jdautilities.commons.utils.TableBuilder.Borders

An instance that can be used for tables without a frame that have a header, for this provides a special delimiter for the first row.

HEADER_ROW_FRAME - Static variable in class com.jagrosh.jdautilities.commons.utils.TableBuilder.Borders

An instance that can be used for framed tables with a header row and a columns with row names, for it provides special delimiters for the first row and column.

HEADER_ROW_PLAIN - Static variable in class com.jagrosh.jdautilities.commons.utils.TableBuilder.Borders

An instance that can be used for tables without a frame that have a header row and a row name column, for this provides special delimiters for the first row and column.

headerColumnCrossDelimiter - Variable in class com.jagrosh.jdautilities.commons.utils.TableBuilder.Borders

headerCrossDelimiter - Variable in class com.jagrosh.jdautilities.commons.utils.TableBuilder.Borders

headerDelimiter - Variable in class com.jagrosh.jdautilities.commons.utils.TableBuilder.Borders

headerLeftIntersection - Variable in class com.jagrosh.jdautilities.commons.utils.TableBuilder.Borders

headerRightIntersection - Variable in class com.jagrosh.jdautilities.commons.utils.TableBuilder.Borders

help - Variable in class com.jagrosh.jdautilities.command.Command

A small help String that summarizes the function of the command, used in the default help builder, and shown in the client for Slash Commands.

help() - Element in annotation interface com.jagrosh.jdautilities.command.annotation.JDACommand

The help string for a command.

helpBiConsumer - Variable in class com.jagrosh.jdautilities.command.Command

The BiConsumer for creating a help response to the format [prefix]<command name> help.

hidden - Variable in class com.jagrosh.jdautilities.command.Command

true if this command should be hidden from the help.

horizontalOutline - Variable in class com.jagrosh.jdautilities.commons.utils.TableBuilder.Borders

I

IDENTIFY - Enum constant in enum class com.jagrosh.jdautilities.oauth2.Scope

Allows /users/@me without email

init() - Method in interface com.jagrosh.jdautilities.command.GuildSettingsManager

Called when JDA has fired a ReadyEvent.

Interaction - Class in com.jagrosh.jdautilities.command

A class that represents an interaction with a user.

Interaction() - Constructor for class com.jagrosh.jdautilities.command.Interaction

InvalidStateException - Exception Class in com.jagrosh.jdautilities.oauth2.exceptions

Exception raised when the provided OAuth2 state is not valid.

InvalidStateException(String) - Constructor for exception class com.jagrosh.jdautilities.oauth2.exceptions.InvalidStateException

isAllowed(TextChannel) - Method in class com.jagrosh.jdautilities.command.Command

Checks whether a command is allowed in a TextChannel by searching the channel topic for topic tags relating to the command.

isBot() - Method in interface com.jagrosh.jdautilities.oauth2.entities.OAuth2User

Deprecated.

Due to the nature of OAuth2 at this moment, bots are not allowed to use the various urls provided.
This method is scheduled for removal upon merging it with master in JDA-Utilities 2.2

isCommandFor(String) - Method in class com.jagrosh.jdautilities.command.Command

Checks if the given input represents this Command

isFromType(ChannelType) - Method in class com.jagrosh.jdautilities.command.CommandEvent

Compares a provided ChannelType with the one this CommandEvent occurred on, returning true if they are the same ChannelType.

isFromType(ChannelType) - Method in class com.jagrosh.jdautilities.command.SlashCommandEvent

Compares a provided ChannelType with the one this event occurred on, returning true if they are the same ChannelType.

isGuildOnly() - Method in class com.jagrosh.jdautilities.command.Command

Checks if this Command can only be used in a Guild.

isHidden() - Element in annotation interface com.jagrosh.jdautilities.command.annotation.JDACommand

Whether or not this command should remain hidden in the help builder.

isHidden() - Method in class com.jagrosh.jdautilities.command.Command

Checks whether or not this command should be hidden from the help.

ISlashCommand - Interface in com.jagrosh.jdautilities.command.interfaces

isManualUpsert() - Method in interface com.jagrosh.jdautilities.command.CommandClient

Returns whether manual upsertion is enabled

isManualUpsert() - Method in class com.jagrosh.jdautilities.command.impl.CommandClientImpl

isMfaEnabled() - Method in class com.jagrosh.jdautilities.oauth2.entities.impl.OAuth2UserImpl

isMfaEnabled() - Method in interface com.jagrosh.jdautilities.oauth2.entities.OAuth2User

Returns true if this user has multi-factor authentication enabled.

isOwner() - Method in class com.jagrosh.jdautilities.command.CommandEvent

Tests whether or not the User who triggered this event is an owner of the bot.

isOwner() - Method in class com.jagrosh.jdautilities.command.MessageContextMenuEvent

Tests whether the User who triggered this event is an owner of the bot.

isOwner() - Method in class com.jagrosh.jdautilities.command.UserContextMenuEvent

Tests whether the User who triggered this event is an owner of the bot.

isOwner() - Method in class com.jagrosh.jdautilities.oauth2.entities.impl.OAuth2GuildImpl

isOwner() - Method in interface com.jagrosh.jdautilities.oauth2.entities.OAuth2Guild

Whether or not the Session User is the owner of the Guild.

isOwner(SlashCommandEvent, CommandClient) - Method in class com.jagrosh.jdautilities.command.SlashCommand

Tests whether or not the User who triggered this event is an owner of the bot.

isOwnerCommand() - Method in class com.jagrosh.jdautilities.command.Interaction

Checks whether this is an owner only Interaction, meaning only the owner and co-owners can use it.

isShutdown() - Method in class com.jagrosh.jdautilities.commons.waiter.EventWaiter

Gets whether the EventWaiter's internal ScheduledExecutorService is shutdown.

isValidUser(User) - Method in class com.jagrosh.jdautilities.menu.Menu

Checks to see if the provided User is valid to interact with this Menu.

isValidUser(User, Guild) - Method in class com.jagrosh.jdautilities.menu.Menu

Checks to see if the provided User is valid to interact with this Menu.

isVerified() - Method in class com.jagrosh.jdautilities.oauth2.entities.impl.OAuth2UserImpl

isVerified() - Method in interface com.jagrosh.jdautilities.oauth2.entities.OAuth2User

Returns true if the user's Discord account has been verified via email.

J

JDACommand - Annotation Interface in com.jagrosh.jdautilities.command.annotation

An Annotation applicable to Methods that will act as Commands when added to a Client using CommandClientBuilder#addAnnotatedModule() serving as metadata "constructors" for what would be a class extending Command of the same functionality and settings.

JDACommand.Category - Annotation Interface in com.jagrosh.jdautilities.command.annotation

A helper annotation to assist in location of Category instance.

JDACommand.Cooldown - Annotation Interface in com.jagrosh.jdautilities.command.annotation

A value wrapper for what would be Command#cooldown and Command#cooldownScope.

JDACommand.Module - Annotation Interface in com.jagrosh.jdautilities.command.annotation

A helper annotation to assist in location of methods that will generate into Commands.

JDAUtilitiesInfo - Class in com.jagrosh.jdautilities.commons

Information regarding the library.

JDAUtilitiesInfo() - Constructor for class com.jagrosh.jdautilities.commons.JDAUtilitiesInfo

join(boolean, Scope...) - Static method in enum class com.jagrosh.jdautilities.oauth2.Scope

Joins the specified scopes properly as they should be represented as part of an authorization URL.

join(Scope...) - Static method in enum class com.jagrosh.jdautilities.oauth2.Scope

Joins the specified scopes properly as they should be represented as part of an authorization URL.

L

LEFT - Enum constant in enum class com.jagrosh.jdautilities.commons.utils.TableBuilder.Alignment

LEFT - Static variable in class com.jagrosh.jdautilities.menu.ButtonEmbedPaginator

LEFT - Static variable in class com.jagrosh.jdautilities.menu.EmbedPaginator

LEFT - Static variable in class com.jagrosh.jdautilities.menu.Paginator

LEFT - Static variable in class com.jagrosh.jdautilities.menu.Slideshow

leftIntersection - Variable in class com.jagrosh.jdautilities.commons.utils.TableBuilder.Borders

LETTERS - Static variable in class com.jagrosh.jdautilities.menu.OrderedMenu

linkId(Message) - Method in class com.jagrosh.jdautilities.command.CommandEvent

Links a Message with the calling Message contained by this CommandEvent.

linkIds(long, Message) - Method in class com.jagrosh.jdautilities.command.impl.CommandClientImpl

DO NOT USE THIS!

location() - Element in annotation interface com.jagrosh.jdautilities.command.annotation.JDACommand.Category

The target class where the static field is located.

LOGGER - Static variable in class com.jagrosh.jdautilities.oauth2.requests.OAuth2Requester

lowerIntersection - Variable in class com.jagrosh.jdautilities.commons.utils.TableBuilder.Borders

lowLeftCorner - Variable in class com.jagrosh.jdautilities.commons.utils.TableBuilder.Borders

lowRightCorner - Variable in class com.jagrosh.jdautilities.commons.utils.TableBuilder.Borders

M

MAX_MESSAGES - Static variable in class com.jagrosh.jdautilities.command.CommandEvent

Menu - Class in com.jagrosh.jdautilities.menu

A frame for wrapping an EventWaiter into a "action, reaction" menu that waits on forms of user input such as reactions, or key-phrases.

Menu(EventWaiter, Set<User>, Set<Role>, long, TimeUnit) - Constructor for class com.jagrosh.jdautilities.menu.Menu

Menu.Builder<T extends Menu.Builder<T,V>,V extends Menu> - Class in com.jagrosh.jdautilities.menu

An extendable frame for a chain-method builder that constructs a specified type of Menu.

MessageContextMenu - Class in com.jagrosh.jdautilities.command

MessageContextMenu() - Constructor for class com.jagrosh.jdautilities.command.MessageContextMenu

MessageContextMenuEvent - Class in com.jagrosh.jdautilities.command

Message Context Menus In JDA-Chewtils

MessageContextMenuEvent(JDA, long, MessageContextInteraction, CommandClient) - Constructor for class com.jagrosh.jdautilities.command.MessageContextMenuEvent

MESSAGES_READ - Enum constant in enum class com.jagrosh.jdautilities.oauth2.Scope

For local rpc server api access, this allows you to read messages from all client channels (otherwise restricted to channels/guilds your app creates)

method - Variable in class com.jagrosh.jdautilities.oauth2.requests.OAuth2Action

MissingScopeException - Exception Class in com.jagrosh.jdautilities.oauth2.exceptions

Exception raised whenever attempting to perform an action or function with a missing Scope.

MissingScopeException(String, Scope) - Constructor for exception class com.jagrosh.jdautilities.oauth2.exceptions.MissingScopeException

N

name - Variable in class com.jagrosh.jdautilities.command.Command

The name of the command, allows the command to be called the formats:
Normal Command: [prefix]<command name>.

name - Variable in class com.jagrosh.jdautilities.command.ContextMenu

The name of the command.

name() - Element in annotation interface com.jagrosh.jdautilities.command.annotation.JDACommand.Category

The name of the static field in the target class that will be the category for the annotated command.

name() - Element in annotation interface com.jagrosh.jdautilities.command.annotation.JDACommand

The name and aliases of the command.

name() - Element in annotation interface com.jagrosh.jdautilities.doc.standard.CommandInfo

The name and aliases of a command.

nameLocalization - Variable in class com.jagrosh.jdautilities.command.ContextMenu

Localization of menu names.

nameLocalization - Variable in class com.jagrosh.jdautilities.command.SlashCommand

Localization of slash command name.

newFrameBorders(String, String, String, String, String, String, String, String, String, String, String, String, String) - Static method in class com.jagrosh.jdautilities.commons.utils.TableBuilder.Borders

The factory method for Borders instances that should support framing and don't have any special characters for headers or row names.

newHeaderFrameBorders(String, String, String, String, String, String, String, String, String, String, String, String, String, String, String, String, String) - Static method in class com.jagrosh.jdautilities.commons.utils.TableBuilder.Borders

The factory method for Borders instances that should support framing and special characters for a header row.

newHeaderPlainBorders(String, String, String, String, String) - Static method in class com.jagrosh.jdautilities.commons.utils.TableBuilder.Borders

The factory method for Borders instances that should not support framing but special characters for a header row.

newHeaderRowNamesFrameBorders(String, String, String, String, String, String, String, String, String, String, String, String, String, String, String, String, String, String, String, String, String, String) - Static method in class com.jagrosh.jdautilities.commons.utils.TableBuilder.Borders

The factory method for Borders instances that should support framing as well as special characters for a header row and a row name column.

newHeaderRowNamesPlainBorders(String, String, String, String, String, String, String, String) - Static method in class com.jagrosh.jdautilities.commons.utils.TableBuilder.Borders

The factory method for Borders instances that should not support framing but special characters for a header row and a row name column.

newPlainBorders(String, String, String) - Static method in class com.jagrosh.jdautilities.commons.utils.TableBuilder.Borders

The factory method for Borders instances that should not support framing and no special characters for a header row or a row name column.

nsfwOnly - Variable in class com.jagrosh.jdautilities.command.Interaction

true if the command may only be used in an NSFW TextChannel or DMs.

NUMBERS - Static variable in class com.jagrosh.jdautilities.menu.OrderedMenu

O

OAuth2Action<T> - Class in com.jagrosh.jdautilities.oauth2.requests

An adaptable lookalike of JDA's RestAction.

OAuth2Action(OAuth2ClientImpl, Method, String) - Constructor for class com.jagrosh.jdautilities.oauth2.requests.OAuth2Action

OAuth2Client - Interface in com.jagrosh.jdautilities.oauth2

The central controller for OAuth2 state and session management using the Discord API.

OAuth2Client.Builder - Class in com.jagrosh.jdautilities.oauth2

Builder for creating OAuth2Client instances.

OAuth2ClientImpl - Class in com.jagrosh.jdautilities.oauth2.entities.impl

OAuth2ClientImpl(long, String, SessionController, StateController, OkHttpClient) - Constructor for class com.jagrosh.jdautilities.oauth2.entities.impl.OAuth2ClientImpl

OAuth2Guild - Interface in com.jagrosh.jdautilities.oauth2.entities

OAuth2 representation of a Discord Server/Guild.

OAuth2GuildImpl - Class in com.jagrosh.jdautilities.oauth2.entities.impl

OAuth2GuildImpl(OAuth2Client, long, String, String, boolean, long) - Constructor for class com.jagrosh.jdautilities.oauth2.entities.impl.OAuth2GuildImpl

OAuth2Requester - Class in com.jagrosh.jdautilities.oauth2.requests

OAuth2Requester(OkHttpClient) - Constructor for class com.jagrosh.jdautilities.oauth2.requests.OAuth2Requester

OAuth2URL - Enum Class in com.jagrosh.jdautilities.oauth2.requests

Simple formattable constants for various URLs used in the JDA-Utilities OAuth2.

OAuth2User - Interface in com.jagrosh.jdautilities.oauth2.entities

OAuth2 representation of a Discord User.

OAuth2UserImpl - Class in com.jagrosh.jdautilities.oauth2.entities.impl

OAuth2UserImpl(OAuth2Client, Session, long, String, String, String, String, boolean, boolean) - Constructor for class com.jagrosh.jdautilities.oauth2.entities.impl.OAuth2UserImpl

onAutoComplete(CommandAutoCompleteInteractionEvent) - Method in interface com.jagrosh.jdautilities.command.interfaces.ISlashCommand

This body is executed when an auto-complete event is received.

onAutoComplete(CommandAutoCompleteInteractionEvent) - Method in class com.jagrosh.jdautilities.command.SlashCommand

This body is executed when an auto-complete event is received.

onCommand(CommandEvent, Command) - Method in interface com.jagrosh.jdautilities.command.CommandListener

Called when a Command is triggered by a CommandEvent.

onCommandException(CommandEvent, Command, Throwable) - Method in interface com.jagrosh.jdautilities.command.CommandListener

Called when a Command catches a Throwable during execution.

onCompletedCommand(CommandEvent, Command) - Method in interface com.jagrosh.jdautilities.command.CommandListener

Called when a Command is triggered by a CommandEvent after it's completed successfully.

onCompletedMessageContextMenu(MessageContextMenuEvent, MessageContextMenu) - Method in interface com.jagrosh.jdautilities.command.CommandListener

Called when a MessageContextMenu is triggered by a MessageContextMenuEvent after it's completed successfully.

onCompletedSlashCommand(SlashCommandEvent, SlashCommand) - Method in interface com.jagrosh.jdautilities.command.CommandListener

Called when a SlashCommand is triggered by a SlashCommandEvent after it's completed successfully.

onCompletedUserContextMenu(UserContextMenuEvent, UserContextMenu) - Method in interface com.jagrosh.jdautilities.command.CommandListener

Called when a UserContextMenu is triggered by a UserContextMenuEvent after it's completed successfully.

onEvent(GenericEvent) - Method in class com.jagrosh.jdautilities.command.impl.CommandClientImpl

onEvent(GenericEvent) - Method in class com.jagrosh.jdautilities.commons.waiter.EventWaiter

onMessageContextMenu(MessageContextMenuEvent, MessageContextMenu) - Method in interface com.jagrosh.jdautilities.command.CommandListener

Called when a MessageContextMenu is triggered by a MessageContextMenuEvent.

onMessageContextMenuException(MessageContextMenuEvent, MessageContextMenu, Throwable) - Method in interface com.jagrosh.jdautilities.command.CommandListener

Called when a ContextMenu catches a Throwable during execution.

onNonCommandMessage(MessageReceivedEvent) - Method in interface com.jagrosh.jdautilities.command.CommandListener

Called when a MessageReceivedEvent is caught by the Client Listener's but doesn't correspond to a Command.

onSlashCommand(SlashCommandEvent, SlashCommand) - Method in interface com.jagrosh.jdautilities.command.CommandListener

Called when a SlashCommand is triggered by a SlashCommandEvent.

onSlashCommandException(SlashCommandEvent, SlashCommand, Throwable) - Method in interface com.jagrosh.jdautilities.command.CommandListener

Called when a SlashCommand catches a Throwable during execution.

onTerminatedCommand(CommandEvent, Command) - Method in interface com.jagrosh.jdautilities.command.CommandListener

Called when a Command is triggered by a CommandEvent but is terminated before completion.

onTerminatedMessageContextMenu(MessageContextMenuEvent, MessageContextMenu) - Method in interface com.jagrosh.jdautilities.command.CommandListener

Called when a MessageContextMenu is triggered by a MessageContextMenuEvent but is terminated before completion.

onTerminatedSlashCommand(SlashCommandEvent, SlashCommand) - Method in interface com.jagrosh.jdautilities.command.CommandListener

Called when a SlashCommand is triggered by a SlashCommandEvent but is terminated before completion.

onTerminatedUserContextMenu(UserContextMenuEvent, UserContextMenu) - Method in interface com.jagrosh.jdautilities.command.CommandListener

Called when a UserContextMenu is triggered by a UserContextMenuEvent but is terminated before completion.

onUserContextMenu(UserContextMenuEvent, UserContextMenu) - Method in interface com.jagrosh.jdautilities.command.CommandListener

Called when a UserContextMenu is triggered by a UserContextMenuEvent.

onUserContextMenuException(UserContextMenuEvent, UserContextMenu, Throwable) - Method in interface com.jagrosh.jdautilities.command.CommandListener

Called when a ContextMenu catches a Throwable during execution.

optAttachment(String) - Method in class com.jagrosh.jdautilities.command.SlashCommandEvent

Gets the provided Option Key as an Attachment value, or returns null if the option cannot be found.

optAttachment(String, Message.Attachment) - Method in class com.jagrosh.jdautilities.command.SlashCommandEvent

Gets the provided Option Key as an Attachment value, or returns the default one if the option cannot be found.

optBoolean(SlashCommandEvent, String) - Static method in class pw.chew.jdachewtils.command.OptionHelper

Deprecated.

Use SlashCommandEvent.optBoolean(String) instead.

optBoolean(SlashCommandEvent, String, boolean) - Static method in class pw.chew.jdachewtils.command.OptionHelper

Deprecated.

Use SlashCommandEvent.optBoolean(String, boolean) instead.

optBoolean(String) - Method in class com.jagrosh.jdautilities.command.SlashCommandEvent

Gets the provided Option Key as a boolean value, or returns false if the option cannot be found.

optBoolean(String, boolean) - Method in class com.jagrosh.jdautilities.command.SlashCommandEvent

Gets the provided Option Key as a boolean value, or returns the default one if the option cannot be found.

optDouble(SlashCommandEvent, String) - Static method in class pw.chew.jdachewtils.command.OptionHelper

Deprecated.

Use SlashCommandEvent.optDouble(String) instead.

optDouble(SlashCommandEvent, String, double) - Static method in class pw.chew.jdachewtils.command.OptionHelper

Deprecated.

Use SlashCommandEvent.optDouble(String, double) instead.

optDouble(String) - Method in class com.jagrosh.jdautilities.command.SlashCommandEvent

Gets the provided Option Key as a double value, or returns 0.0 if the option cannot be found.

optDouble(String, double) - Method in class com.jagrosh.jdautilities.command.SlashCommandEvent

Gets the provided Option Key as a double value, or returns the default one if the option cannot be found.

optGuildChannel(SlashCommandEvent, String) - Static method in class pw.chew.jdachewtils.command.OptionHelper

Deprecated.

Use SlashCommandEvent.optGuildChannel(String) instead.

optGuildChannel(SlashCommandEvent, String, GuildChannel) - Static method in class pw.chew.jdachewtils.command.OptionHelper

Deprecated.

Use SlashCommandEvent.optGuildChannel(String, GuildChannel) instead.

optGuildChannel(String) - Method in class com.jagrosh.jdautilities.command.SlashCommandEvent

Gets the provided Option Key as a GuildChannel value, or returns null if the option cannot be found.

optGuildChannel(String, GuildChannel) - Method in class com.jagrosh.jdautilities.command.SlashCommandEvent

Gets the provided Option Key as a GuildChannel value, or returns the default one if the option cannot be found.

OptionHelper - Class in pw.chew.jdachewtils.command

Deprecated.

Use SlashCommandEvent methods instead.

options - Variable in class com.jagrosh.jdautilities.command.SlashCommand

An array list of OptionData.

optLong(SlashCommandEvent, String) - Static method in class pw.chew.jdachewtils.command.OptionHelper

Deprecated.

Use SlashCommandEvent.optLong(String) instead.

optLong(SlashCommandEvent, String, long) - Static method in class pw.chew.jdachewtils.command.OptionHelper

Deprecated.

Use SlashCommandEvent.optLong(String, long) instead.

optLong(String) - Method in class com.jagrosh.jdautilities.command.SlashCommandEvent

Gets the provided Option Key as a long value, or returns 0 if the option cannot be found.

optLong(String, long) - Method in class com.jagrosh.jdautilities.command.SlashCommandEvent

Gets the provided Option Key as a long value, or returns the default one if the option cannot be found.

optMember(SlashCommandEvent, String) - Static method in class pw.chew.jdachewtils.command.OptionHelper

Deprecated.

Use SlashCommandEvent.optMember(String) instead.

optMember(SlashCommandEvent, String, Member) - Static method in class pw.chew.jdachewtils.command.OptionHelper

Deprecated.

Use SlashCommandEvent.optMember(String, Member) instead.

optMember(String) - Method in class com.jagrosh.jdautilities.command.SlashCommandEvent

Gets the provided Option Key as a Member value, or returns null if the option cannot be found.

optMember(String, Member) - Method in class com.jagrosh.jdautilities.command.SlashCommandEvent

Gets the provided Option Key as a Member value, or returns the default one if the option cannot be found.

optMentionable(SlashCommandEvent, String) - Static method in class pw.chew.jdachewtils.command.OptionHelper

Deprecated.

Use SlashCommandEvent.optMentionable(String) instead.

optMentionable(SlashCommandEvent, String, IMentionable) - Static method in class pw.chew.jdachewtils.command.OptionHelper

Deprecated.

Use SlashCommandEvent.optMentionable(String, IMentionable) instead.

optMentionable(String) - Method in class com.jagrosh.jdautilities.command.SlashCommandEvent

Gets the provided Option Key as a IMentionable value, or returns null if the option cannot be found.

optMentionable(String, IMentionable) - Method in class com.jagrosh.jdautilities.command.SlashCommandEvent

Gets the provided Option Key as a IMentionable value, or returns the default one if the option cannot be found.

optMessageChannel(SlashCommandEvent, String) - Static method in class pw.chew.jdachewtils.command.OptionHelper

Deprecated.

Use SlashCommandEvent.optMessageChannel(String) instead.

optMessageChannel(SlashCommandEvent, String, MessageChannel) - Static method in class pw.chew.jdachewtils.command.OptionHelper

Deprecated.

Use SlashCommandEvent.optMessageChannel(String, MessageChannel) instead.

optMessageChannel(String) - Method in class com.jagrosh.jdautilities.command.SlashCommandEvent

Gets the provided Option Key as a MessageChannel value, or returns null if the option cannot be found.

optMessageChannel(String, MessageChannel) - Method in class com.jagrosh.jdautilities.command.SlashCommandEvent

Gets the provided Option Key as a MessageChannel value, or returns the default one if the option cannot be found.

optRole(SlashCommandEvent, String) - Static method in class pw.chew.jdachewtils.command.OptionHelper

Deprecated.

Use SlashCommandEvent.optRole(String) instead.

optRole(SlashCommandEvent, String, Role) - Static method in class pw.chew.jdachewtils.command.OptionHelper

Deprecated.

Use SlashCommandEvent.optRole(String, Role) instead.

optRole(String) - Method in class com.jagrosh.jdautilities.command.SlashCommandEvent

Gets the provided Option Key as a Role value, or returns null if the option cannot be found.

optRole(String, Role) - Method in class com.jagrosh.jdautilities.command.SlashCommandEvent

Gets the provided Option Key as a Role value, or returns the default one if the option cannot be found.

optString(SlashCommandEvent, String) - Static method in class pw.chew.jdachewtils.command.OptionHelper

Deprecated.

Use SlashCommandEvent.optString(String) instead.

optString(SlashCommandEvent, String, String) - Static method in class pw.chew.jdachewtils.command.OptionHelper

Deprecated.

Use SlashCommandEvent.optString(String, String) instead.

optString(String) - Method in class com.jagrosh.jdautilities.command.SlashCommandEvent

Gets the provided Option Key as a String value, or returns null if the option cannot be found.

optString(String, String) - Method in class com.jagrosh.jdautilities.command.SlashCommandEvent

Gets the provided Option Key as a String value, or returns the default one if the option cannot be found.

optUser(SlashCommandEvent, String) - Static method in class pw.chew.jdachewtils.command.OptionHelper

Deprecated.

Use SlashCommandEvent.optUser(String) instead.

optUser(SlashCommandEvent, String, User) - Static method in class pw.chew.jdachewtils.command.OptionHelper

Deprecated.

Use SlashCommandEvent.optUser(String, User) instead.

optUser(String) - Method in class com.jagrosh.jdautilities.command.SlashCommandEvent

Gets the provided Option Key as a User value, or returns null if the option cannot be found.

optUser(String, User) - Method in class com.jagrosh.jdautilities.command.SlashCommandEvent

Gets the provided Option Key as a User value, or returns the default one if the option cannot be found.

OrderedMenu - Class in com.jagrosh.jdautilities.menu

A Menu of ordered buttons signified by numbers or letters, each with a reaction linked to it for users to click.

OrderedMenu.Builder - Class in com.jagrosh.jdautilities.menu

The Menu.Builder for an OrderedMenu.

ownerCommand - Variable in class com.jagrosh.jdautilities.command.Interaction

true if the interaction may only be used by a User with an ID matching the Owners or any of the CoOwners.
If enabled for a Slash Command, only owners (owner + up to 9 co-owners) will be added to the SlashCommand.

ownerCommand() - Element in annotation interface com.jagrosh.jdautilities.command.annotation.JDACommand

Whether or not the command is owner only.

P

paginate(MessageChannel, int) - Method in class com.jagrosh.jdautilities.menu.ButtonEmbedPaginator

Begins pagination as a new Message in the provided MessageChannel, starting on whatever page number is provided.

paginate(MessageChannel, int) - Method in class com.jagrosh.jdautilities.menu.EmbedPaginator

Begins pagination as a new Message in the provided MessageChannel, starting on whatever page number is provided.

paginate(MessageChannel, int) - Method in class com.jagrosh.jdautilities.menu.Paginator

Begins pagination as a new Message in the provided MessageChannel, starting on whatever page number is provided.

paginate(MessageChannel, int) - Method in class com.jagrosh.jdautilities.menu.Slideshow

Begins pagination as a new Message in the provided MessageChannel, starting on whatever page number is provided.

paginate(Message, int) - Method in class com.jagrosh.jdautilities.menu.ButtonEmbedPaginator

Begins pagination displaying this by editing the provided Message, starting on whatever page number is provided.

paginate(Message, int) - Method in class com.jagrosh.jdautilities.menu.EmbedPaginator

Begins pagination displaying this by editing the provided Message, starting on whatever page number is provided.

paginate(Message, int) - Method in class com.jagrosh.jdautilities.menu.Paginator

Begins pagination displaying this Pagination by editing the provided Message, starting on whatever page number is provided.

paginate(Message, int) - Method in class com.jagrosh.jdautilities.menu.Slideshow

Begins pagination displaying this by editing the provided Message, starting on whatever page number is provided.

Paginator - Class in com.jagrosh.jdautilities.menu

A Menu implementation that paginates a set of one or more text items across one or more pages.

Paginator.Builder - Class in com.jagrosh.jdautilities.menu

The Menu.Builder for a Paginator.

PingCommand - Class in com.jagrosh.jdautilities.examples.command

PingCommand() - Constructor for class com.jagrosh.jdautilities.examples.command.PingCommand

PLAIN - Static variable in class com.jagrosh.jdautilities.commons.utils.TableBuilder.Borders

An instance that can be used for plain tables without a frame that do not have any special delimiters for headers or row name columns.

preface() - Element in annotation interface com.jagrosh.jdautilities.doc.DocMultiple

Text that occurs before all occurrences of the annotation this is applied to.

prefix() - Element in annotation interface com.jagrosh.jdautilities.doc.standard.Error

A prefix appended to the front of the produced String during conversion.

prefixEach() - Element in annotation interface com.jagrosh.jdautilities.doc.DocMultiple

A prefix annotation appended to the front of each occurrence.

pw.chew.jdachewtils.command - package pw.chew.jdachewtils.command

Q

queue() - Method in class com.jagrosh.jdautilities.oauth2.requests.OAuth2Action

Asynchronously executes this OAuth2Action.

queue(Consumer<T>) - Method in class com.jagrosh.jdautilities.oauth2.requests.OAuth2Action

Asynchronously executes this OAuth2Action, providing the value constructed from the response as the parameter given to the success Consumer.

queue(Consumer<T>, Consumer<Throwable>) - Method in class com.jagrosh.jdautilities.oauth2.requests.OAuth2Action

Asynchronously executes this OAuth2Action, providing the value constructed from the response as the parameter given to the success Consumer if the response is successful, or the exception to the failure Consumer if it's not.

R

reactError() - Method in class com.jagrosh.jdautilities.command.CommandEvent

Adds an error reaction to the calling Message.

reactSuccess() - Method in class com.jagrosh.jdautilities.command.CommandEvent

Adds a success reaction to the calling Message.

reactWarning() - Method in class com.jagrosh.jdautilities.command.CommandEvent

Adds a warning reaction to the calling Message.

read(CommandInfo) - Method in class com.jagrosh.jdautilities.doc.standard.CommandInfo.Converter

read(Error) - Method in class com.jagrosh.jdautilities.doc.standard.Error.Converter

read(RequiredPermissions) - Method in class com.jagrosh.jdautilities.doc.standard.RequiredPermissions.Converter

read(Author) - Method in class com.jagrosh.jdautilities.examples.doc.Author.Converter

read(T) - Method in interface com.jagrosh.jdautilities.doc.DocConverter

Returns a String processed from the contents of the provided Annotation.

register(Class<T>, DocConverter<T>) - Method in class com.jagrosh.jdautilities.doc.DocGenerator

Registers a CommandDoc Annotation to this DocGenerator with the provided DocConverter.

register(Class<T>, Object...) - Method in class com.jagrosh.jdautilities.doc.DocGenerator

Registers a CommandDoc Annotation to this DocGenerator.

removeCommand(String) - Method in interface com.jagrosh.jdautilities.command.CommandClient

Removes a single Command from this CommandClient's registered Commands at the index linked to the provided name/alias.

removeCommand(String) - Method in class com.jagrosh.jdautilities.command.impl.CommandClientImpl

reply(File, String) - Method in class com.jagrosh.jdautilities.command.CommandEvent

Replies with a File with the provided name, or a default name if left null.

reply(String) - Method in class com.jagrosh.jdautilities.command.CommandEvent

Replies with a String message.

reply(String, File, String) - Method in class com.jagrosh.jdautilities.command.CommandEvent

Replies with a String message and a File with the provided name, or a default name if left null.

reply(String, Consumer<Message>) - Method in class com.jagrosh.jdautilities.command.CommandEvent

Replies with a String message and then queues a Consumer.

reply(String, Consumer<Message>, Consumer<Throwable>) - Method in class com.jagrosh.jdautilities.command.CommandEvent

Replies with a String message and then queues a Consumer.

reply(MessageEmbed) - Method in class com.jagrosh.jdautilities.command.CommandEvent

Replies with a MessageEmbed.

reply(MessageEmbed, Consumer<Message>) - Method in class com.jagrosh.jdautilities.command.CommandEvent

Replies with a MessageEmbed and then queues a Consumer.

reply(MessageEmbed, Consumer<Message>, Consumer<Throwable>) - Method in class com.jagrosh.jdautilities.command.CommandEvent

Replies with a MessageEmbed and then queues a Consumer.

reply(MessageCreateData) - Method in class com.jagrosh.jdautilities.command.CommandEvent

Replies with a Message.

reply(MessageCreateData, Consumer<Message>) - Method in class com.jagrosh.jdautilities.command.CommandEvent

Replies with a Message and then queues a Consumer.

reply(MessageCreateData, Consumer<Message>, Consumer<Throwable>) - Method in class com.jagrosh.jdautilities.command.CommandEvent

Replies with a Message and then queues a Consumer.

replyError(String) - Method in class com.jagrosh.jdautilities.command.CommandEvent

Replies with a String message and a prefixed error emoji.

replyError(String, Consumer<Message>) - Method in class com.jagrosh.jdautilities.command.CommandEvent

Replies with a String message and a prefixed error emoji and then queues a Consumer.

replyFormatted(String, Object...) - Method in class com.jagrosh.jdautilities.command.CommandEvent

Replies with a formatted String message using the provided arguments.

replyInDm(String) - Method in class com.jagrosh.jdautilities.command.CommandEvent

Replies with a String message sent to the calling User's PrivateChannel.

replyInDm(String, File, String) - Method in class com.jagrosh.jdautilities.command.CommandEvent

Replies with a String message and a File with the provided name, or a default name if left null, and sent to the calling User's PrivateChannel.

replyInDm(String, Consumer<Message>) - Method in class com.jagrosh.jdautilities.command.CommandEvent

Replies with a String message sent to the calling User's PrivateChannel.

replyInDm(String, Consumer<Message>, Consumer<Throwable>) - Method in class com.jagrosh.jdautilities.command.CommandEvent

Replies with a String message sent to the calling User's PrivateChannel.

replyInDm(MessageEmbed) - Method in class com.jagrosh.jdautilities.command.CommandEvent

Replies with a MessageEmbed sent to the calling User's PrivateChannel.

replyInDm(MessageEmbed, Consumer<Message>) - Method in class com.jagrosh.jdautilities.command.CommandEvent

Replies with a MessageEmbed sent to the calling User's PrivateChannel.

replyInDm(MessageEmbed, Consumer<Message>, Consumer<Throwable>) - Method in class com.jagrosh.jdautilities.command.CommandEvent

Replies with a MessageEmbed sent to the calling User's PrivateChannel.

replyInDm(Message, Consumer<Message>, Consumer<Throwable>) - Method in class com.jagrosh.jdautilities.command.CommandEvent

Replies with a Message sent to the calling User's PrivateChannel.

replyInDm(MessageCreateData) - Method in class com.jagrosh.jdautilities.command.CommandEvent

Replies with a Message sent to the calling User's PrivateChannel.

replyInDm(MessageCreateData, Consumer<Message>) - Method in class com.jagrosh.jdautilities.command.CommandEvent

Replies with a Message sent to the calling User's PrivateChannel.

replyOrAlternate(String, File, String, String) - Method in class com.jagrosh.jdautilities.command.CommandEvent

Replies with a String message and a File with the provided name, or a default name if left null.

replyOrAlternate(MessageEmbed, String) - Method in class com.jagrosh.jdautilities.command.CommandEvent

Replies with a MessageEmbed if possible, or just a String message if it cannot send the embed.

replySuccess(String) - Method in class com.jagrosh.jdautilities.command.CommandEvent

Replies with a String message, and a prefixed success emoji.

replySuccess(String, Consumer<Message>) - Method in class com.jagrosh.jdautilities.command.CommandEvent

Replies with a String message and a prefixed success emoji and then queues a Consumer.

replyWarning(String) - Method in class com.jagrosh.jdautilities.command.CommandEvent

Replies with a String message, and a prefixed warning emoji.

replyWarning(String, Consumer<Message>) - Method in class com.jagrosh.jdautilities.command.CommandEvent

Replies with a String message and a prefixed warning emoji and then queues a Consumer.

RequiredPermissions - Annotation Interface in com.jagrosh.jdautilities.doc.standard

A CommandDoc Annotation that lists required Permissions a bot must have to use a command on a Guild.

RequiredPermissions.Converter - Class in com.jagrosh.jdautilities.doc.standard

The DocConverter for the @RequiredPermissions annotation.

requiredRole - Variable in class com.jagrosh.jdautilities.command.Command

A String name of a role required to use this command.

requiredRole - Variable in class com.jagrosh.jdautilities.command.SlashCommand

Deprecated.

requiredRole() - Element in annotation interface com.jagrosh.jdautilities.command.annotation.JDACommand

The name of a role required to use this command.

requirements() - Element in annotation interface com.jagrosh.jdautilities.doc.standard.CommandInfo

A series of prerequisites or requirements a user must have to use this command.

respond(File, String, String, boolean) - Method in class com.jagrosh.jdautilities.command.MessageContextMenuEvent

Replies with a File with the provided name, or a default name if left null.

respond(File, String, String, boolean) - Method in class com.jagrosh.jdautilities.command.UserContextMenuEvent

Responds with a File with the provided name, or a default name if left null.

respond(String) - Method in class com.jagrosh.jdautilities.command.MessageContextMenuEvent

Responds with a String message.

respond(String) - Method in class com.jagrosh.jdautilities.command.UserContextMenuEvent

Responds with a String message.

respond(MessageEmbed) - Method in class com.jagrosh.jdautilities.command.MessageContextMenuEvent

Responds with a MessageEmbed.

respond(MessageEmbed) - Method in class com.jagrosh.jdautilities.command.UserContextMenuEvent

Responds with a MessageEmbed.

respond(MessageCreateData) - Method in class com.jagrosh.jdautilities.command.MessageContextMenuEvent

Replies with a Message.

respond(MessageCreateData) - Method in class com.jagrosh.jdautilities.command.UserContextMenuEvent

Responds with a Message.

response() - Element in annotation interface com.jagrosh.jdautilities.doc.standard.Error

A response message that would normally be sent if this error occurs, as a means of users identifying the error without an idea of what exactly went wrong.

RIGHT - Enum constant in enum class com.jagrosh.jdautilities.commons.utils.TableBuilder.Alignment

RIGHT - Static variable in class com.jagrosh.jdautilities.menu.ButtonEmbedPaginator

RIGHT - Static variable in class com.jagrosh.jdautilities.menu.EmbedPaginator

RIGHT - Static variable in class com.jagrosh.jdautilities.menu.Paginator

RIGHT - Static variable in class com.jagrosh.jdautilities.menu.Slideshow

rightIntersection - Variable in class com.jagrosh.jdautilities.commons.utils.TableBuilder.Borders

ROLE_MENTION - Static variable in class com.jagrosh.jdautilities.commons.utils.FinderUtil

RoleinfoCommand - Class in com.jagrosh.jdautilities.examples.command

RoleinfoCommand() - Constructor for class com.jagrosh.jdautilities.examples.command.RoleinfoCommand

roles - Variable in class com.jagrosh.jdautilities.menu.Menu.Builder

roles - Variable in class com.jagrosh.jdautilities.menu.Menu

rowDelimiter - Variable in class com.jagrosh.jdautilities.commons.utils.TableBuilder.Borders

RPC - Enum constant in enum class com.jagrosh.jdautilities.oauth2.Scope

For local rpc server access, this allows you to control a user's local Discord client

RPC_API - Enum constant in enum class com.jagrosh.jdautilities.oauth2.Scope

For local rpc server api access, this allows you to access the API as the local user

RPC_NOTIFICATIONS_READ - Enum constant in enum class com.jagrosh.jdautilities.oauth2.Scope

For local rpc server api access, this allows you to receive notifications pushed out to the user

run(CommandEvent) - Method in class com.jagrosh.jdautilities.command.Command

Runs checks for the Command with the given CommandEvent that called it.

run(MessageContextMenuEvent) - Method in class com.jagrosh.jdautilities.command.MessageContextMenu

Runs checks for the MessageContextMenu with the given MessageContextMenuEvent that called it.

run(SlashCommandEvent) - Method in interface com.jagrosh.jdautilities.command.interfaces.ISlashCommand

Runs checks for the SlashCommand with the given SlashCommandEvent that called it.

run(SlashCommandEvent) - Method in class com.jagrosh.jdautilities.command.SlashCommand

Runs checks for the SlashCommand with the given SlashCommandEvent that called it.

run(UserContextMenuEvent) - Method in class com.jagrosh.jdautilities.command.UserContextMenu

Runs checks for the UserContextMenu with the given MessageContextMenuEvent that called it.

S

safeConvert(String) - Static method in class com.jagrosh.jdautilities.commons.utils.SafeIdUtil

Safely convert the provided String ID to a long usable with MiscUtil.parseSnowflake(String).

SafeIdUtil - Class in com.jagrosh.jdautilities.commons.utils

A Utilities class for safely checking and converting String IDs to longs usable with MiscUtil.parseSnowflake(String), a utility used in several Object#getXById(String) methods.

scope() - Element in annotation interface com.jagrosh.jdautilities.command.annotation.JDACommand.Cooldown

The CooldownScope for the annotated Command.

Scope - Enum Class in com.jagrosh.jdautilities.oauth2

Constants used to specify the scope of OAuth2 sessions.

SELECT - Static variable in class com.jagrosh.jdautilities.menu.SelectionDialog

SelectionDialog - Class in com.jagrosh.jdautilities.menu

A Menu implementation that creates a listed display of text choices horizontally that users can scroll through using reactions and make selections.

SelectionDialog.Builder - Class in com.jagrosh.jdautilities.menu

The Menu.Builder for a SelectuibDialog.

separateBy() - Element in annotation interface com.jagrosh.jdautilities.doc.DocMultiple

A separator String applied in-between occurrences.

ServerinfoCommand - Class in com.jagrosh.jdautilities.examples.command

ServerinfoCommand() - Constructor for class com.jagrosh.jdautilities.examples.command.ServerinfoCommand

Session - Interface in com.jagrosh.jdautilities.oauth2.session

Implementable data type used to allow access to data regarding OAuth2 sessions.

SessionController<S extends Session> - Interface in com.jagrosh.jdautilities.oauth2.session

An abstract controller for Sessions, Implementations should be able to create their respectively controlled implementations using an instance of SessionData and maintain the created instances for the entire lifetime of the session.

SessionData - Class in com.jagrosh.jdautilities.oauth2.session

Contains various data necessary for creating a Session using a SessionController.

SessionData(String, String, String, String, OffsetDateTime, Scope[]) - Constructor for class com.jagrosh.jdautilities.oauth2.session.SessionData

setAction(Consumer<Emoji>) - Method in class com.jagrosh.jdautilities.menu.ButtonMenu.Builder

Sets the Consumer action to perform upon selecting a button.

setActivity(Activity) - Method in class com.jagrosh.jdautilities.command.CommandClientBuilder

Sets the Game to use when the bot is ready.

setAliases(String...) - Method in class com.jagrosh.jdautilities.command.CommandBuilder

Sets the aliases of the Command built from this CommandBuilder.

setAliases(Collection<String>) - Method in class com.jagrosh.jdautilities.command.CommandBuilder

Sets the aliases of the Command built from this CommandBuilder.

setAlignment(TableBuilder.Alignment) - Method in class com.jagrosh.jdautilities.commons.utils.TableBuilder

Sets the alignment/orientation of all headers and values.

setAlternativePrefix(String) - Method in class com.jagrosh.jdautilities.command.CommandClientBuilder

Sets the bot's alternative prefix.

setAnnotatedCompiler(AnnotatedModuleCompiler) - Method in class com.jagrosh.jdautilities.command.CommandClientBuilder

Sets the AnnotatedModuleCompiler for this CommandClientBuilder.

setArguments(String) - Method in class com.jagrosh.jdautilities.command.CommandBuilder

Sets the arguments of the Command built from this CommandBuilder.

setBorders(TableBuilder.Borders) - Method in class com.jagrosh.jdautilities.commons.utils.TableBuilder

Sets the borders for this table using the nested Borders class.

setBotPermissions(Collection<Permission>) - Method in class com.jagrosh.jdautilities.command.CommandBuilder

Sets the required bot permissions of the Command built from this CommandBuilder.

setBotPermissions(Permission...) - Method in class com.jagrosh.jdautilities.command.CommandBuilder

Sets the required bot permissions of the Command built from this CommandBuilder.

setBulkSkipNumber(int) - Method in class com.jagrosh.jdautilities.menu.ButtonEmbedPaginator.Builder

Sets the ButtonEmbedPaginator's bulk-skip function to skip multiple pages using alternate forward and backwards reactions.

setBulkSkipNumber(int) - Method in class com.jagrosh.jdautilities.menu.EmbedPaginator.Builder

Sets the EmbedPaginator's bulk-skip function to skip multiple pages using alternate forward and backwards reactions.

setBulkSkipNumber(int) - Method in class com.jagrosh.jdautilities.menu.Paginator.Builder

Sets the Paginator's bulk-skip function to skip multiple pages using alternate forward and backwards

setBulkSkipNumber(int) - Method in class com.jagrosh.jdautilities.menu.Slideshow.Builder

Sets the Slideshow's bulk-skip function to skip multiple pages using alternate forward and backwards

setButtonStyle(ButtonStyle) - Method in class com.jagrosh.jdautilities.menu.ButtonEmbedPaginator.Builder

Sets the ButtonStyle to use for the buttons.

setCancel(Consumer<Message>) - Method in class com.jagrosh.jdautilities.menu.OrderedMenu.Builder

Sets the Consumer to perform if the OrderedMenu is cancelled.

setCanceled(Consumer<Message>) - Method in class com.jagrosh.jdautilities.menu.SelectionDialog.Builder

Sets a Consumer action to take if the menu is cancelled, either via the cancel button being used, or if the SelectionDialog times out.

setCarbonitexKey(String) - Method in class com.jagrosh.jdautilities.command.CommandClientBuilder

Sets the Carbonitex key for this bot's listing.

setCategory(Command.Category) - Method in class com.jagrosh.jdautilities.command.CommandBuilder

Sets the category of the Command built from this CommandBuilder.

setChildren(Command...) - Method in class com.jagrosh.jdautilities.command.CommandBuilder

Sets the children of the Command built from this CommandBuilder.

setChildren(Collection<Command>) - Method in class com.jagrosh.jdautilities.command.CommandBuilder

Sets the children of the Command built from this CommandBuilder.

setChoices(String...) - Method in class com.jagrosh.jdautilities.menu.ButtonMenu.Builder

Sets the String unicode emojis as button choices.

setChoices(String...) - Method in class com.jagrosh.jdautilities.menu.OrderedMenu.Builder

Sets the String choices.

setChoices(String...) - Method in class com.jagrosh.jdautilities.menu.SelectionDialog.Builder

Sets the String choices to be shown as selections.

setChoices(Emoji...) - Method in class com.jagrosh.jdautilities.menu.ButtonMenu.Builder

Sets the Emotes as button choices.

setClientId(long) - Method in class com.jagrosh.jdautilities.oauth2.OAuth2Client.Builder

Sets the OAuth2Client's ID.

setClientSecret(String) - Method in class com.jagrosh.jdautilities.oauth2.OAuth2Client.Builder

Sets the OAuth2Client's secret.

setColor(Color) - Method in class com.jagrosh.jdautilities.menu.ButtonMenu.Builder

Sets the Color of the MessageEmbed.

setColor(Color) - Method in class com.jagrosh.jdautilities.menu.OrderedMenu.Builder

Sets the Color of the MessageEmbed.

setColor(Color) - Method in class com.jagrosh.jdautilities.menu.Paginator.Builder

Sets the Color of the MessageEmbed.

setColor(Color) - Method in class com.jagrosh.jdautilities.menu.SelectionDialog.Builder

Sets the Color of the MessageEmbed.

setColor(Color) - Method in class com.jagrosh.jdautilities.menu.Slideshow.Builder

Sets the Color of the MessageEmbed.

setColor(BiFunction<Integer, Integer, Color>) - Method in class com.jagrosh.jdautilities.menu.Paginator.Builder

Sets the Color of the MessageEmbed, relative to the total page number and the current page as determined by the provided BiFunction.

setColor(BiFunction<Integer, Integer, Color>) - Method in class com.jagrosh.jdautilities.menu.Slideshow.Builder

Sets the Color of the MessageEmbed, relative to the total page number and the current page as determined by the provided BiFunction.

setColor(Function<Integer, Color>) - Method in class com.jagrosh.jdautilities.menu.SelectionDialog.Builder

Sets the Color of the MessageEmbed, relative to the current selection number as determined by the provided Function.

setColumns(int) - Method in class com.jagrosh.jdautilities.menu.Paginator.Builder

Sets the number of columns each page will have.

setCommandPreProcessBiFunction(BiFunction<MessageReceivedEvent, Command, Boolean>) - Method in class com.jagrosh.jdautilities.command.CommandClientBuilder

Sets the pre-process function.

setCommandPreProcessFunction(Function<MessageReceivedEvent, Boolean>) - Method in class com.jagrosh.jdautilities.command.CommandClientBuilder

Deprecated.

Please use CommandClientBuilder.setCommandPreProcessBiFunction(BiFunction) instead. You can simply add a new parameter for the command, it doesn't have to be used.

setCooldown(int) - Method in class com.jagrosh.jdautilities.command.CommandBuilder

Sets the cooldown of the Command built from this CommandBuilder.

setCooldownScope(CooldownScope) - Method in class com.jagrosh.jdautilities.command.CommandBuilder

Sets the cooldown scope of the Command built from this CommandBuilder.

setCoOwnerIds(long...) - Method in class com.jagrosh.jdautilities.command.CommandClientBuilder

Sets the one or more CoOwners of the bot.

setCoOwnerIds(String...) - Method in class com.jagrosh.jdautilities.command.CommandClientBuilder

Sets the one or more CoOwners of the bot.

setDefaultEnds(String, String) - Method in class com.jagrosh.jdautilities.menu.SelectionDialog.Builder

Sets the text to use on either side of all unselected items.

setDescription(String) - Method in class com.jagrosh.jdautilities.menu.ButtonMenu.Builder

Sets the description to be placed in an MessageEmbed.

setDescription(String) - Method in class com.jagrosh.jdautilities.menu.OrderedMenu.Builder

Sets the description to be placed in an MessageEmbed.

setDescription(String) - Method in class com.jagrosh.jdautilities.menu.Slideshow.Builder

Sets the description of the MessageEmbed in the Message to be displayed when the Slideshow is built.

setDescription(BiFunction<Integer, Integer, String>) - Method in class com.jagrosh.jdautilities.menu.Slideshow.Builder

Sets the description of the MessageEmbed in the Message to be displayed relative to the total page number and the current page as determined by the provided BiFunction.

setDiscordBotListKey(String) - Method in class com.jagrosh.jdautilities.command.CommandClientBuilder

Deprecated.

setDiscordBotsKey(String) - Method in class com.jagrosh.jdautilities.command.CommandClientBuilder

Sets the Discord Bots API key for this bot's listing.

setEmojis(String, String, String) - Method in class com.jagrosh.jdautilities.command.CommandClientBuilder

Sets the emojis for success, warning, and failure.

setEventWaiter(EventWaiter) - Method in class com.jagrosh.jdautilities.menu.Menu.Builder

Sets the EventWaiter that will do Menu operations.

setFinalAction(Consumer<Message>) - Method in class com.jagrosh.jdautilities.menu.ButtonEmbedPaginator.Builder

Sets the Consumer to perform if the ButtonEmbedPaginator times out.

setFinalAction(Consumer<Message>) - Method in class com.jagrosh.jdautilities.menu.ButtonMenu.Builder

Sets the Consumer to perform if the ButtonMenu is done, either via cancellation, a timeout, or a selection being made.

setFinalAction(Consumer<Message>) - Method in class com.jagrosh.jdautilities.menu.EmbedPaginator.Builder

Sets the Consumer to perform if the EmbedPaginator times out.

setFinalAction(Consumer<Message>) - Method in class com.jagrosh.jdautilities.menu.Paginator.Builder

Sets the Consumer to perform if the Paginator times out.

setFinalAction(Consumer<Message>) - Method in class com.jagrosh.jdautilities.menu.Slideshow.Builder

Sets the Consumer to perform if the Slideshow times out.

setGuildOnly(boolean) - Method in class com.jagrosh.jdautilities.command.CommandBuilder

Sets the Command built to be guild only.

setGuildSettingsManager(GuildSettingsManager) - Method in class com.jagrosh.jdautilities.command.CommandClientBuilder

Sets the GuildSettingsManager for the CommandClientImpl built using this builder.

setHelp(String) - Method in class com.jagrosh.jdautilities.command.CommandBuilder

Sets the help snippet of the Command built from this CommandBuilder.

setHelpBiConsumer(BiConsumer<CommandEvent, Command>) - Method in class com.jagrosh.jdautilities.command.CommandBuilder

Sets the help BiConsumer of the Command built from this CommandBuilder.

setHelpConsumer(Consumer<CommandEvent>) - Method in class com.jagrosh.jdautilities.command.CommandClientBuilder

Sets the consumer to run as the bot's help command.

setHelpWord(String) - Method in class com.jagrosh.jdautilities.command.CommandClientBuilder

Sets the word used to trigger the command list.

setHidden(boolean) - Method in class com.jagrosh.jdautilities.command.CommandBuilder

Sets the Command built to be hidden from the help builder.

setIsAuthor(boolean) - Method in class com.jagrosh.jdautilities.examples.command.AboutCommand

setItems(String...) - Method in class com.jagrosh.jdautilities.menu.ButtonEmbedPaginator.Builder

Sets the MessageEmbeds to paginate.

setItems(String...) - Method in class com.jagrosh.jdautilities.menu.EmbedPaginator.Builder

Sets the MessageEmbeds to paginate.

setItems(String...) - Method in class com.jagrosh.jdautilities.menu.Paginator.Builder

Sets the String list of items to paginate.

setItems(Collection<MessageEmbed>) - Method in class com.jagrosh.jdautilities.menu.ButtonEmbedPaginator.Builder

Sets the MessageEmbeds to paginate.

setItems(Collection<MessageEmbed>) - Method in class com.jagrosh.jdautilities.menu.EmbedPaginator.Builder

Sets the MessageEmbeds to paginate.

setItems(MessageEmbed...) - Method in class com.jagrosh.jdautilities.menu.ButtonEmbedPaginator.Builder

Sets the MessageEmbed to paginate.

setItems(MessageEmbed...) - Method in class com.jagrosh.jdautilities.menu.EmbedPaginator.Builder

Sets the MessageEmbeds to paginate.

setItemsPerPage(int) - Method in class com.jagrosh.jdautilities.menu.Paginator.Builder

Sets the number of items that will appear on each page.

setLeftRightText(String, String) - Method in class com.jagrosh.jdautilities.menu.EmbedPaginator.Builder

Sets the EmbedPaginator to traverse left or right when a provided text input is sent in the form of a Message to the GuildChannel the menu is displayed in.

setLeftRightText(String, String) - Method in class com.jagrosh.jdautilities.menu.Paginator.Builder

Sets the Paginator to traverse left or right when a provided text input is sent in the form of a Message to the GuildChannel the menu is displayed in.

setLeftRightText(String, String) - Method in class com.jagrosh.jdautilities.menu.Slideshow.Builder

Sets the Slideshow to traverse left or right when a provided text input is sent in the form of a Message to the GuildChannel the menu is displayed in.

setLinkedCacheSize(int) - Method in class com.jagrosh.jdautilities.command.CommandClientBuilder

Sets the internal size of the client's FixedSizeCache used for caching and pairing the bot's response Messages with the calling Message's ID.

setListener(CommandListener) - Method in interface com.jagrosh.jdautilities.command.CommandClient

Sets the CommandListener to catch command-related events thrown by this CommandClient.

setListener(CommandListener) - Method in class com.jagrosh.jdautilities.command.CommandClientBuilder

Sets the CommandListener for the CommandClientImpl.

setListener(CommandListener) - Method in class com.jagrosh.jdautilities.command.impl.CommandClientImpl

setManualUpsert(boolean) - Method in class com.jagrosh.jdautilities.command.CommandClientBuilder

Whether or not to manually upsert slash commands.

setName(String) - Method in class com.jagrosh.jdautilities.command.CommandBuilder

Sets the name of the Command built from this CommandBuilder.

setName(String) - Method in class com.jagrosh.jdautilities.commons.utils.TableBuilder

Sets the name of the table.

setOkHttpClient(OkHttpClient) - Method in class com.jagrosh.jdautilities.oauth2.OAuth2Client.Builder

Sets the client's internal OkHttpClient used for all requests and interactions with Discord.

setOwnerCommand(boolean) - Method in class com.jagrosh.jdautilities.command.CommandBuilder

Sets the Command built to be owner only.

setOwnerId(long) - Method in class com.jagrosh.jdautilities.command.CommandClientBuilder

Sets the owner for the bot.

setOwnerId(String) - Method in class com.jagrosh.jdautilities.command.CommandClientBuilder

Sets the owner for the bot.

setPadding(int) - Method in class com.jagrosh.jdautilities.commons.utils.TableBuilder

Sets a paddling that is applied to each value if autoAdjust is true.

setPrefix(String) - Method in class com.jagrosh.jdautilities.command.CommandClientBuilder

Sets the bot's prefix.

setPrefixes(String[]) - Method in class com.jagrosh.jdautilities.command.CommandClientBuilder

Sets an array of prefixes in case it's not enough.

setPrefixFunction(Function<MessageReceivedEvent, String>) - Method in class com.jagrosh.jdautilities.command.CommandClientBuilder

Sets the Prefix Function.

setReplacementCharacter(String) - Method in class com.jagrosh.jdautilities.examples.command.AboutCommand

setRequiredRole(String) - Method in class com.jagrosh.jdautilities.command.CommandBuilder

Sets the name of a required role to use the Command built from this CommandBuilder.

setRoles(Role...) - Method in class com.jagrosh.jdautilities.menu.Menu.Builder

Sets Roles that are allowed to use the Menu that will be built.

setScheduleExecutor(ScheduledExecutorService) - Method in class com.jagrosh.jdautilities.command.CommandClientBuilder

Sets the ScheduledExecutorService for the CommandClientImpl.

setSelectedEnds(String, String) - Method in class com.jagrosh.jdautilities.menu.SelectionDialog.Builder

Sets the text to use on either end of the selected item.

setSelection(BiConsumer<Message, Integer>) - Method in class com.jagrosh.jdautilities.menu.OrderedMenu.Builder

Sets the BiConsumer action to perform upon selecting a option.

setSelectionConsumer(BiConsumer<Message, Integer>) - Method in class com.jagrosh.jdautilities.menu.SelectionDialog.Builder

Sets a BiConsumer action to perform once a selection is made.

setServerInvite(String) - Method in class com.jagrosh.jdautilities.command.CommandClientBuilder

Sets the bot's support server invite.

setSessionController(SessionController) - Method in class com.jagrosh.jdautilities.oauth2.OAuth2Client.Builder

Sets the OAuth2Client's SessionController.

setShutdownAutomatically(boolean) - Method in class com.jagrosh.jdautilities.command.CommandClientBuilder

Sets the Command Client to shut down internals automatically when a ShutdownEvent is received.

setStateController(StateController) - Method in class com.jagrosh.jdautilities.oauth2.OAuth2Client.Builder

Sets the OAuth2Client's StateController.

setStatus(OnlineStatus) - Method in class com.jagrosh.jdautilities.command.CommandClientBuilder

Sets the OnlineStatus the bot will use once Ready This defaults to ONLINE

setText(String) - Method in class com.jagrosh.jdautilities.menu.ButtonEmbedPaginator.Builder

Sets the text of the Message to be displayed when the ButtonEmbedPaginator is built.

setText(String) - Method in class com.jagrosh.jdautilities.menu.ButtonMenu.Builder

Sets the text of the Message to be displayed when the ButtonMenu is built.

setText(String) - Method in class com.jagrosh.jdautilities.menu.EmbedPaginator.Builder

Sets the text of the Message to be displayed when the EmbedPaginator is built.

setText(String) - Method in class com.jagrosh.jdautilities.menu.OrderedMenu.Builder

Sets the text of the Message to be displayed when the OrderedMenu is built.

setText(String) - Method in class com.jagrosh.jdautilities.menu.Paginator.Builder

Sets the text of the Message to be displayed when the Paginator is built.

setText(String) - Method in class com.jagrosh.jdautilities.menu.SelectionDialog.Builder

Sets the text of the Message to be displayed when the SelectionDialog is built.

setText(String) - Method in class com.jagrosh.jdautilities.menu.Slideshow.Builder

Sets the text of the Message to be displayed when the Slideshow is built.

setText(BiFunction<Integer, Integer, String>) - Method in class com.jagrosh.jdautilities.menu.ButtonEmbedPaginator.Builder

Sets the text of the Message to be displayed relative to the total page number and the current page as determined by the provided BiFunction.

setText(BiFunction<Integer, Integer, String>) - Method in class com.jagrosh.jdautilities.menu.EmbedPaginator.Builder

Sets the text of the Message to be displayed relative to the total page number and the current page as determined by the provided BiFunction.

setText(BiFunction<Integer, Integer, String>) - Method in class com.jagrosh.jdautilities.menu.Paginator.Builder

Sets the text of the Message to be displayed relative to the total page number and the current page as determined by the provided BiFunction.

setText(BiFunction<Integer, Integer, String>) - Method in class com.jagrosh.jdautilities.menu.Slideshow.Builder

Sets the text of the Message to be displayed relative to the total page number and the current page as determined by the provided BiFunction.

setText(Function<Integer, String>) - Method in class com.jagrosh.jdautilities.menu.SelectionDialog.Builder

Sets the text of the Message to be displayed relative to the current selection number as determined by the provided Function.

setTimeout(long, TimeUnit) - Method in class com.jagrosh.jdautilities.menu.Menu.Builder

Sets the timeout that the Menu should stay available.

setUrls(String...) - Method in class com.jagrosh.jdautilities.menu.Slideshow.Builder

Sets the String list of urls to paginate.

setUserPermissions(Collection<Permission>) - Method in class com.jagrosh.jdautilities.command.CommandBuilder

Sets the required user permissions of the Command built from this CommandBuilder.

setUserPermissions(Permission...) - Method in class com.jagrosh.jdautilities.command.CommandBuilder

Sets the required user permissions of the Command built from this CommandBuilder.

setUsers(User...) - Method in class com.jagrosh.jdautilities.menu.Menu.Builder

Sets Users that are allowed to use the Menu that will be built.

setUsesTopicTags(boolean) - Method in class com.jagrosh.jdautilities.command.CommandBuilder

Sets the Command built to use TopicTags.

setValues(String[][]) - Method in class com.jagrosh.jdautilities.commons.utils.TableBuilder

Sets the values of this table.

SHARD - Enum constant in enum class com.jagrosh.jdautilities.command.CooldownScope

Applies the cooldown to the calling Shard the command is called on.

showDialog(MessageChannel, int) - Method in class com.jagrosh.jdautilities.menu.SelectionDialog

Shows the SelectionDialog as a new Message in the provided MessageChannel, starting with the number selection provided.

showDialog(Message, int) - Method in class com.jagrosh.jdautilities.menu.SelectionDialog

Displays this SelectionDialog by editing the provided Message, starting with the number selection provided.

showPageNumbers(boolean) - Method in class com.jagrosh.jdautilities.menu.Paginator.Builder

Sets whether or not the page number will be shown.

showPageNumbers(boolean) - Method in class com.jagrosh.jdautilities.menu.Slideshow.Builder

Sets whether or not the page number will be shown.

shutdown() - Method in interface com.jagrosh.jdautilities.command.CommandClient

Shuts down internals of the Command Client, such as the threadpool and guild settings manager

shutdown() - Method in interface com.jagrosh.jdautilities.command.GuildSettingsManager

Called when JDA has fired a ShutdownEvent.

shutdown() - Method in class com.jagrosh.jdautilities.command.impl.CommandClientImpl

shutdown() - Method in class com.jagrosh.jdautilities.commons.waiter.EventWaiter

Closes this EventWaiter if it doesn't normally shutdown automatically.

shutdown() - Method in class com.jagrosh.jdautilities.oauth2.entities.impl.OAuth2ClientImpl

ShutdownCommand - Class in com.jagrosh.jdautilities.examples.command

ShutdownCommand() - Constructor for class com.jagrosh.jdautilities.examples.command.ShutdownCommand

SlashCommand - Class in com.jagrosh.jdautilities.command

Slash Commands In JDA-Chewtils

SlashCommand() - Constructor for class com.jagrosh.jdautilities.command.SlashCommand

SlashCommandEvent - Class in com.jagrosh.jdautilities.command

A wrapper class for a SlashCommandInteractionEvent and CommandClient.

SlashCommandEvent(SlashCommandInteractionEvent, CommandClient) - Constructor for class com.jagrosh.jdautilities.command.SlashCommandEvent

Slideshow - Class in com.jagrosh.jdautilities.menu

A Menu implementation, nearly identical to Paginator, that displays an individual image on each page instead of a list of text items.

Slideshow.Builder - Class in com.jagrosh.jdautilities.menu

The Menu.Builder for a Slideshow.

splitMessage(String) - Static method in class com.jagrosh.jdautilities.command.CommandEvent

Splits a String into one or more Strings who's length does not exceed 2000 characters.

startSession(String, String, String, Scope...) - Method in class com.jagrosh.jdautilities.oauth2.entities.impl.OAuth2ClientImpl

startSession(String, String, String, Scope...) - Method in interface com.jagrosh.jdautilities.oauth2.OAuth2Client

Starts a Session with the provided code, state, and identifier.

StateController - Interface in com.jagrosh.jdautilities.oauth2.state

Implementable state controller, used for registering states and generating redirect URIs using them.

STOP - Static variable in class com.jagrosh.jdautilities.menu.ButtonEmbedPaginator

STOP - Static variable in class com.jagrosh.jdautilities.menu.EmbedPaginator

STOP - Static variable in class com.jagrosh.jdautilities.menu.Paginator

STOP - Static variable in class com.jagrosh.jdautilities.menu.Slideshow

subcommandGroup - Variable in class com.jagrosh.jdautilities.command.SlashCommand

The subcommand/child group this is associated with.

T

TableBuilder - Class in com.jagrosh.jdautilities.commons.utils

A utility class that can be used to easily create String tables in Java without any extra frameworks.

TableBuilder() - Constructor for class com.jagrosh.jdautilities.commons.utils.TableBuilder

TableBuilder.Alignment - Enum Class in com.jagrosh.jdautilities.commons.utils

An enum that represents the alignments possible to set

TableBuilder.Borders - Class in com.jagrosh.jdautilities.commons.utils

A data class whose instances store the characters needed to create a table with the enclosing TableBuilder.

test(CommandEvent) - Method in class com.jagrosh.jdautilities.command.Command.Category

Runs a test of the provided Predicate.

timeout - Variable in class com.jagrosh.jdautilities.menu.Menu.Builder

timeout - Variable in class com.jagrosh.jdautilities.menu.Menu

TOKEN - Enum constant in enum class com.jagrosh.jdautilities.oauth2.requests.OAuth2URL

toString() - Method in class com.jagrosh.jdautilities.oauth2.entities.impl.OAuth2UserImpl

toString() - Method in class com.jagrosh.jdautilities.oauth2.session.SessionData

U

unit - Variable in class com.jagrosh.jdautilities.menu.Menu.Builder

unit - Variable in class com.jagrosh.jdautilities.menu.Menu

UNKNOWN - Enum constant in enum class com.jagrosh.jdautilities.oauth2.Scope

Unknown scope

UNKNOWN - Static variable in class com.jagrosh.jdautilities.commons.utils.TableBuilder.Borders

UP - Static variable in class com.jagrosh.jdautilities.menu.SelectionDialog

upLeftCorner - Variable in class com.jagrosh.jdautilities.commons.utils.TableBuilder.Borders

upperIntersection - Variable in class com.jagrosh.jdautilities.commons.utils.TableBuilder.Borders

upRightCorner - Variable in class com.jagrosh.jdautilities.commons.utils.TableBuilder.Borders

upsertInteractions(JDA) - Method in interface com.jagrosh.jdautilities.command.CommandClient

Upserts all interactions to the provided forced server.

upsertInteractions(JDA) - Method in class com.jagrosh.jdautilities.command.impl.CommandClientImpl

upsertInteractions(JDA, String) - Method in interface com.jagrosh.jdautilities.command.CommandClient

Upserts all interactions to the provided server.

upsertInteractions(JDA, String) - Method in class com.jagrosh.jdautilities.command.impl.CommandClientImpl

url - Variable in class com.jagrosh.jdautilities.oauth2.requests.OAuth2Action

usage() - Element in annotation interface com.jagrosh.jdautilities.doc.standard.CommandInfo

A short format or explanation of a command's usage.

useCancelButton(boolean) - Method in class com.jagrosh.jdautilities.menu.OrderedMenu.Builder

If true, adds a cancel button that performs the timeout action when selected.

useDefaultGame() - Method in class com.jagrosh.jdautilities.command.CommandClientBuilder

Sets the Game the bot will use as the default: 'Playing Type [prefix]help'

useHelpBuilder(boolean) - Method in class com.jagrosh.jdautilities.command.CommandClientBuilder

Sets whether the CommandClient will use the builder to automatically create a help command or not.

useLetters() - Method in class com.jagrosh.jdautilities.menu.OrderedMenu.Builder

Sets the builder to build an OrderedMenu using letters for ordering and reactions (IE: A, B, C, etc.).

useLooping(boolean) - Method in class com.jagrosh.jdautilities.menu.SelectionDialog.Builder

Sets if moving up when at the top selection jumps to the bottom, and visa-versa.

useNumberedItems(boolean) - Method in class com.jagrosh.jdautilities.menu.Paginator.Builder

Sets whether or not the items will be automatically numbered.

useNumbers() - Method in class com.jagrosh.jdautilities.menu.OrderedMenu.Builder

Sets the builder to build an OrderedMenu using numbers for ordering and reactions (IE: 1, 2, 3, etc.).

USER - Enum constant in enum class com.jagrosh.jdautilities.command.CooldownScope

Applies the cooldown to the calling User across all locations on this instance (IE: TextChannels, PrivateChannels, etc).

USER_AGENT - Static variable in class com.jagrosh.jdautilities.oauth2.requests.OAuth2Requester

USER_CHANNEL - Enum constant in enum class com.jagrosh.jdautilities.command.CooldownScope

Applies the cooldown to the calling User local to the MessageChannel the command is called in.

USER_GUILD - Enum constant in enum class com.jagrosh.jdautilities.command.CooldownScope

Applies the cooldown to the calling User local to the Guild the command is called in.

USER_MENTION - Static variable in class com.jagrosh.jdautilities.commons.utils.FinderUtil

USER_SHARD - Enum constant in enum class com.jagrosh.jdautilities.command.CooldownScope

Applies the cooldown to the calling User on the Shard the command is called on.

UserContextMenu - Class in com.jagrosh.jdautilities.command

User Context Menus In JDA-Chewtils

UserContextMenu() - Constructor for class com.jagrosh.jdautilities.command.UserContextMenu

UserContextMenuEvent - Class in com.jagrosh.jdautilities.command

UserContextMenuEvent(JDA, long, UserContextInteraction, CommandClient) - Constructor for class com.jagrosh.jdautilities.command.UserContextMenuEvent

userMissingPermMessage - Variable in class com.jagrosh.jdautilities.command.Interaction

The permission message used when the user does not have the required permission.

userPermissions - Variable in class com.jagrosh.jdautilities.command.Interaction

Any Permissions a Member must have to use this interaction.

userPermissions() - Element in annotation interface com.jagrosh.jdautilities.command.annotation.JDACommand

The Permissions the user must have on a guild to use this command.

users - Variable in class com.jagrosh.jdautilities.menu.Menu.Builder

users - Variable in class com.jagrosh.jdautilities.menu.Menu

useSingleSelectionMode(boolean) - Method in class com.jagrosh.jdautilities.menu.SelectionDialog.Builder

Sets if the Menu should exit when a selection was made.

usesLinkedDeletion() - Method in interface com.jagrosh.jdautilities.command.CommandClient

Gets whether this CommandClient uses linked deletion.

usesLinkedDeletion() - Method in class com.jagrosh.jdautilities.command.impl.CommandClientImpl

usesTopicTags - Variable in class com.jagrosh.jdautilities.command.Command

true if this command checks a channel topic for topic-tags.

useTopicTags() - Element in annotation interface com.jagrosh.jdautilities.command.annotation.JDACommand

Whether or not this command uses topic tags.

V

value() - Element in annotation interface com.jagrosh.jdautilities.command.annotation.JDACommand.Cooldown

The number of seconds the annotated Command will be on cooldown.

value() - Element in annotation interface com.jagrosh.jdautilities.command.annotation.JDACommand.Module

The names of any methods that will be targeted when compiling this object using the AnnotatedModuleCompiler.

value() - Element in annotation interface com.jagrosh.jdautilities.doc.ConvertedBy

The DocConverter Class that the annotation this is applied to provides to DocConverter#read(Annotation).

value() - Element in annotation interface com.jagrosh.jdautilities.doc.standard.Error

A brief description of what caused the error.

value() - Element in annotation interface com.jagrosh.jdautilities.doc.standard.Errors

One or more @Error annotations.

value() - Element in annotation interface com.jagrosh.jdautilities.doc.standard.RequiredPermissions

An array of Permissions a bot must have to run the command.

value() - Element in annotation interface com.jagrosh.jdautilities.examples.doc.Author

valueOf(String) - Static method in enum class com.jagrosh.jdautilities.command.CooldownScope

Returns the enum constant of this class with the specified name.

valueOf(String) - Static method in enum class com.jagrosh.jdautilities.commons.utils.TableBuilder.Alignment

Returns the enum constant of this class with the specified name.

valueOf(String) - Static method in enum class com.jagrosh.jdautilities.oauth2.requests.OAuth2URL

Returns the enum constant of this class with the specified name.

valueOf(String) - Static method in enum class com.jagrosh.jdautilities.oauth2.Scope

Returns the enum constant of this class with the specified name.

values() - Static method in enum class com.jagrosh.jdautilities.command.CooldownScope

Returns an array containing the constants of this enum class, in the order they are declared.

values() - Static method in enum class com.jagrosh.jdautilities.commons.utils.TableBuilder.Alignment

Returns an array containing the constants of this enum class, in the order they are declared.

values() - Static method in enum class com.jagrosh.jdautilities.oauth2.requests.OAuth2URL

Returns an array containing the constants of this enum class, in the order they are declared.

values() - Static method in enum class com.jagrosh.jdautilities.oauth2.Scope

Returns an array containing the constants of this enum class, in the order they are declared.

VERSION - Static variable in class com.jagrosh.jdautilities.commons.JDAUtilitiesInfo

VERSION_MAJOR - Static variable in class com.jagrosh.jdautilities.commons.JDAUtilitiesInfo

VERSION_MINOR - Static variable in class com.jagrosh.jdautilities.commons.JDAUtilitiesInfo

VERSION_REVISION - Static variable in class com.jagrosh.jdautilities.commons.JDAUtilitiesInfo

verticalOutline - Variable in class com.jagrosh.jdautilities.commons.utils.TableBuilder.Borders

W

waiter - Variable in class com.jagrosh.jdautilities.menu.Menu.Builder

waiter - Variable in class com.jagrosh.jdautilities.menu.Menu

waitForEvent(Class<T>, Predicate<T>, Consumer<T>) - Method in class com.jagrosh.jdautilities.commons.waiter.EventWaiter

Waits an indefinite amount of time for an Event that returns true when tested with the provided Predicate.

waitForEvent(Class<T>, Predicate<T>, Consumer<T>, long, TimeUnit, Runnable) - Method in class com.jagrosh.jdautilities.commons.waiter.EventWaiter

Waits a predetermined amount of time for an Event that returns true when tested with the provided Predicate.

waitOnSinglePage(boolean) - Method in class com.jagrosh.jdautilities.menu.ButtonEmbedPaginator.Builder

Sets whether the ButtonEmbedPaginator will instantly timeout, and possibly run a provided Runnable, if only a single slide is available to display.

waitOnSinglePage(boolean) - Method in class com.jagrosh.jdautilities.menu.EmbedPaginator.Builder

Sets whether the EmbedPaginator will instantly timeout, and possibly run a provided Runnable, if only a single slide is available to display.

waitOnSinglePage(boolean) - Method in class com.jagrosh.jdautilities.menu.Paginator.Builder

Sets whether the Paginator will instantly timeout, and possibly run a provided Runnable, if only a single slide is available to display.

waitOnSinglePage(boolean) - Method in class com.jagrosh.jdautilities.menu.Slideshow.Builder

Sets whether the Slideshow will instantly timeout, and possibly run a provided Runnable, if only a single slide is available to display.

WEBHOOK_INCOMING - Enum constant in enum class com.jagrosh.jdautilities.oauth2.Scope

This generates a webhook that is returned in the oauth token response for authorization code grants

wrapPageEnds(boolean) - Method in class com.jagrosh.jdautilities.menu.ButtonEmbedPaginator.Builder

Sets the EmbedPaginator to wrap from the last page to the first when traversing right and vice versa from the left.

wrapPageEnds(boolean) - Method in class com.jagrosh.jdautilities.menu.EmbedPaginator.Builder

Sets the EmbedPaginator to wrap from the last page to the first when traversing right and vice versa from the left.

wrapPageEnds(boolean) - Method in class com.jagrosh.jdautilities.menu.Paginator.Builder

Sets the Paginator to wrap from the last page to the first when traversing right and visa versa from the left.

wrapPageEnds(boolean) - Method in class com.jagrosh.jdautilities.menu.Slideshow.Builder

Sets the Slideshow to wrap from the last page to the first when traversing right and visa versa from the left.

A B C D E F G H I J L M N O P Q R S T U V W
All Classes and Interfaces|All Packages|Constant Field Values|Serialized Form