Index (command-framework 1.1.2 API)

A B C D G H I M O R S V
All Classes and Interfaces|All Packages

A

action(CommandEvent) - Method in interface io.github.jdiscordbots.command_framework.command.ICommand: Executes the command.
addCommand(String, ICommand) - Method in class io.github.jdiscordbots.command_framework.CommandFramework: Adds a new command.
allowExecute(CommandEvent) - Method in interface io.github.jdiscordbots.command_framework.command.ICommand: Return whether command can be executed or not
Argument - Interface in io.github.jdiscordbots.command_framework.command: Represents an argument of a command.
ArgumentTemplate - Class in io.github.jdiscordbots.command_framework.command: Represents an expected parameter of a command
ArgumentTemplate(String, String, boolean, int...) - Constructor for class io.github.jdiscordbots.command_framework.command.ArgumentTemplate: Creates an ArgumentTemplate of an argument that can only be one of specific int choices.
ArgumentTemplate(String, String, boolean, String...) - Constructor for class io.github.jdiscordbots.command_framework.command.ArgumentTemplate: Creates an ArgumentTemplate of an argument that can only be one of specific String choices.
ArgumentTemplate(OptionType, String, String, boolean) - Constructor for class io.github.jdiscordbots.command_framework.command.ArgumentTemplate: Creates an ArgumentTemplate.

B

build() - Method in class io.github.jdiscordbots.command_framework.CommandFramework: Creates a listener for handling events related to the command framework.

C

Command - Annotation Type in io.github.jdiscordbots.command_framework.command: Annotation used for discovering commands.
CommandEvent - Interface in io.github.jdiscordbots.command_framework.command: Represents a command that is executed and allows to take actions in response.
CommandFramework - Class in io.github.jdiscordbots.command_framework: Main class of the command framework.
CommandFramework() - Constructor for class io.github.jdiscordbots.command_framework.CommandFramework: Constructs a new CommandFramework instance with the caller-package Only classes in the same package (and subpackages) than the calling class will be scanned for commands.
CommandFramework(String) - Constructor for class io.github.jdiscordbots.command_framework.CommandFramework: Creates an instance of the command framework.

D

deleteOriginalMessage() - Method in interface io.github.jdiscordbots.command_framework.command.CommandEvent: deletes the message associated with the command
deleteOriginalMessage() - Method in class io.github.jdiscordbots.command_framework.command.slash.SlashCommandFrameworkEvent: deletes the message associated with the command
deleteOriginalMessage() - Method in class io.github.jdiscordbots.command_framework.command.text.MessageCommandEvent: deletes the message associated with the command

G

getArgs() - Method in interface io.github.jdiscordbots.command_framework.command.CommandEvent: Gets a List containing all Arguments supplied to this command.
getArgs() - Method in class io.github.jdiscordbots.command_framework.command.slash.SlashCommandFrameworkEvent: Gets a List containing all Arguments supplied to this command.
getArgs() - Method in class io.github.jdiscordbots.command_framework.command.text.MessageCommandEvent: Gets a List containing all Arguments supplied to this command.
getAsBoolean() - Method in interface io.github.jdiscordbots.command_framework.command.Argument: Gets the argument as a boolean.
getAsBoolean() - Method in class io.github.jdiscordbots.command_framework.command.slash.SlashArgument: Gets the argument as a boolean.
getAsBoolean() - Method in class io.github.jdiscordbots.command_framework.command.text.MessageArgument: Gets the argument as a boolean.
getAsGuildChannel() - Method in interface io.github.jdiscordbots.command_framework.command.Argument: Gets the argument as a GuildChannel.
getAsGuildChannel() - Method in class io.github.jdiscordbots.command_framework.command.slash.SlashArgument: Gets the argument as a GuildChannel.
getAsGuildChannel() - Method in class io.github.jdiscordbots.command_framework.command.text.MessageArgument: Gets the argument as a GuildChannel.
getAsLong() - Method in interface io.github.jdiscordbots.command_framework.command.Argument: Gets the argument as a long.
getAsLong() - Method in class io.github.jdiscordbots.command_framework.command.slash.SlashArgument: Gets the argument as a long.
getAsLong() - Method in class io.github.jdiscordbots.command_framework.command.text.MessageArgument: Gets the argument as a long.
getAsMember() - Method in interface io.github.jdiscordbots.command_framework.command.Argument: Gets the argument as a Member.
getAsMember() - Method in class io.github.jdiscordbots.command_framework.command.slash.SlashArgument: Gets the argument as a Member.
getAsMember() - Method in class io.github.jdiscordbots.command_framework.command.text.MessageArgument: Gets the argument as a Member.
getAsMessageChannel() - Method in interface io.github.jdiscordbots.command_framework.command.Argument: Gets the argument as a MessageChannel.
getAsMessageChannel() - Method in class io.github.jdiscordbots.command_framework.command.slash.SlashArgument: Gets the argument as a MessageChannel.
getAsMessageChannel() - Method in class io.github.jdiscordbots.command_framework.command.text.MessageArgument: Gets the argument as a MessageChannel.
getAsRole() - Method in interface io.github.jdiscordbots.command_framework.command.Argument: Gets the argument as a Role.
getAsRole() - Method in class io.github.jdiscordbots.command_framework.command.slash.SlashArgument: Gets the argument as a Role.
getAsRole() - Method in class io.github.jdiscordbots.command_framework.command.text.MessageArgument: Gets the argument as a Role.
getAsString() - Method in interface io.github.jdiscordbots.command_framework.command.Argument: gets the argument as a String
getAsString() - Method in class io.github.jdiscordbots.command_framework.command.slash.SlashArgument: gets the argument as a String
getAsString() - Method in class io.github.jdiscordbots.command_framework.command.text.MessageArgument: gets the argument as a String
getAsUser() - Method in interface io.github.jdiscordbots.command_framework.command.Argument: Gets the argument as a User.
getAsUser() - Method in class io.github.jdiscordbots.command_framework.command.slash.SlashArgument: Gets the argument as a User.
getAsUser() - Method in class io.github.jdiscordbots.command_framework.command.text.MessageArgument: Gets the argument as a User.
getAuthor() - Method in interface io.github.jdiscordbots.command_framework.command.CommandEvent: Gets the User object representing the user invoking the command.
getAuthor() - Method in class io.github.jdiscordbots.command_framework.command.slash.SlashCommandFrameworkEvent: Gets the User object representing the user invoking the command.
getAuthor() - Method in class io.github.jdiscordbots.command_framework.command.text.MessageCommandEvent: Gets the User object representing the user invoking the command.
getCallerPackageName() - Static method in class io.github.jdiscordbots.command_framework.CommandFramework: Gets the package name of the class of the calling method
getChannel() - Method in interface io.github.jdiscordbots.command_framework.command.CommandEvent: Gets the MessageChannel in which the command was invoked.
getChannel() - Method in class io.github.jdiscordbots.command_framework.command.slash.SlashCommandFrameworkEvent: Gets the MessageChannel in which the command was invoked.
getChannel() - Method in class io.github.jdiscordbots.command_framework.command.text.MessageCommandEvent: Gets the MessageChannel in which the command was invoked.
getChannelType() - Method in interface io.github.jdiscordbots.command_framework.command.Argument: Gets the channel type of the argument if it belongs to a channel
getChannelType() - Method in class io.github.jdiscordbots.command_framework.command.slash.SlashArgument: Gets the channel type of the argument if it belongs to a channel
getChannelType() - Method in class io.github.jdiscordbots.command_framework.command.text.MessageArgument: Gets the channel type of the argument if it belongs to a channel
getChoices() - Method in class io.github.jdiscordbots.command_framework.command.ArgumentTemplate: Gets the choices for this argument.
getCommands() - Method in class io.github.jdiscordbots.command_framework.CommandFramework: Get all registered commands of the CommandFramework instance
getDescription() - Method in class io.github.jdiscordbots.command_framework.command.ArgumentTemplate: Gets the description of the parameter.
getEvent() - Method in class io.github.jdiscordbots.command_framework.command.slash.SlashCommandFrameworkEvent
getEvent() - Method in class io.github.jdiscordbots.command_framework.command.text.MessageCommandEvent
getExpectedArguments() - Method in interface io.github.jdiscordbots.command_framework.command.ICommand: gets a list of all parameters the command expects.
getFramework() - Method in interface io.github.jdiscordbots.command_framework.command.CommandEvent: Gets the CommandFramework instance managing CommandEvent.
getFramework() - Method in class io.github.jdiscordbots.command_framework.command.slash.SlashCommandFrameworkEvent: Gets the CommandFramework instance managing CommandEvent.
getFramework() - Method in class io.github.jdiscordbots.command_framework.command.text.MessageCommandEvent: Gets the CommandFramework instance managing CommandEvent.
getGuild() - Method in interface io.github.jdiscordbots.command_framework.command.CommandEvent: Gets the Guild the command is invoked in.
getGuild() - Method in class io.github.jdiscordbots.command_framework.command.slash.SlashCommandFrameworkEvent: Gets the Guild the command is invoked in.
getGuild() - Method in class io.github.jdiscordbots.command_framework.command.text.MessageCommandEvent: Gets the Guild the command is invoked in.
getId() - Method in interface io.github.jdiscordbots.command_framework.command.CommandEvent: Gets the id of the invocation of the command represented as a String.
getId() - Method in class io.github.jdiscordbots.command_framework.command.slash.SlashCommandFrameworkEvent: Gets the id of the invocation of the command represented as a String.
getId() - Method in class io.github.jdiscordbots.command_framework.command.text.MessageCommandEvent: Gets the id of the invocation of the command represented as a String.
getIdLong() - Method in interface io.github.jdiscordbots.command_framework.command.CommandEvent: Gets the id of the invocation of the command represented as a long.
getIdLong() - Method in class io.github.jdiscordbots.command_framework.command.slash.SlashCommandFrameworkEvent: Gets the id of the invocation of the command represented as a long.
getIdLong() - Method in class io.github.jdiscordbots.command_framework.command.text.MessageCommandEvent: Gets the id of the invocation of the command represented as a long.
getJDA() - Method in interface io.github.jdiscordbots.command_framework.command.CommandEvent: Gets the JDA-object used for receiving the command.
getJDA() - Method in class io.github.jdiscordbots.command_framework.command.slash.SlashCommandFrameworkEvent: Gets the JDA-object used for receiving the command.
getJDA() - Method in class io.github.jdiscordbots.command_framework.command.text.MessageCommandEvent: Gets the JDA-object used for receiving the command.
getMember() - Method in interface io.github.jdiscordbots.command_framework.command.CommandEvent: Gets the Member object representing the member invoking the command.
getMember() - Method in class io.github.jdiscordbots.command_framework.command.slash.SlashCommandFrameworkEvent: Gets the Member object representing the member invoking the command.
getMember() - Method in class io.github.jdiscordbots.command_framework.command.text.MessageCommandEvent: Gets the Member object representing the member invoking the command.
getMessage() - Method in interface io.github.jdiscordbots.command_framework.command.CommandEvent: Gets the Message associated with the invoked command.
getMessage() - Method in class io.github.jdiscordbots.command_framework.command.slash.SlashCommandFrameworkEvent: Gets the Message associated with the invoked command.
getMessage() - Method in class io.github.jdiscordbots.command_framework.command.text.MessageCommandEvent: Gets the Message associated with the invoked command.
getName() - Method in class io.github.jdiscordbots.command_framework.command.ArgumentTemplate: Gets the name of the parameter.
getOwners() - Method in class io.github.jdiscordbots.command_framework.CommandFramework: Gets the owners of the bot.
getPrefix() - Method in class io.github.jdiscordbots.command_framework.CommandFramework: Gets the current prefix for commands to listen on.
getPrivateChannel() - Method in interface io.github.jdiscordbots.command_framework.command.CommandEvent: Gets the PrivateChannel object is the command was invoked in a private channel.
getPrivateChannel() - Method in class io.github.jdiscordbots.command_framework.command.slash.SlashCommandFrameworkEvent: Gets the PrivateChannel object is the command was invoked in a private channel.
getPrivateChannel() - Method in class io.github.jdiscordbots.command_framework.command.text.MessageCommandEvent: Gets the PrivateChannel object is the command was invoked in a private channel.
getRequiredPermissions() - Method in interface io.github.jdiscordbots.command_framework.command.ICommand: Gets the permissions required for executing a command.
getSelfMember() - Method in interface io.github.jdiscordbots.command_framework.command.CommandEvent: Gets the currently logged in User as Member.
getSelfMember() - Method in class io.github.jdiscordbots.command_framework.command.slash.SlashCommandFrameworkEvent: Gets the currently logged in User as Member.
getSelfMember() - Method in class io.github.jdiscordbots.command_framework.command.text.MessageCommandEvent: Gets the currently logged in User as Member.
getSelfUser() - Method in interface io.github.jdiscordbots.command_framework.command.CommandEvent: Gets the currently logged in User.
getSelfUser() - Method in class io.github.jdiscordbots.command_framework.command.slash.SlashCommandFrameworkEvent: Gets the currently logged in User.
getSelfUser() - Method in class io.github.jdiscordbots.command_framework.command.text.MessageCommandEvent: Gets the currently logged in User.
getType() - Method in interface io.github.jdiscordbots.command_framework.command.Argument: Gets the type of the argument.
getType() - Method in class io.github.jdiscordbots.command_framework.command.ArgumentTemplate: Gets the type of the parameter.
getType() - Method in class io.github.jdiscordbots.command_framework.command.slash.SlashArgument: Gets the type of the argument.
getType() - Method in class io.github.jdiscordbots.command_framework.command.text.MessageArgument: Gets the type of the argument.
getUnknownButtonAction() - Method in class io.github.jdiscordbots.command_framework.CommandFramework
getUnknownCommandConsumer() - Method in class io.github.jdiscordbots.command_framework.CommandFramework

H

hasChoices() - Method in class io.github.jdiscordbots.command_framework.command.ArgumentTemplate: Checks if the argument is a choice-argument
help() - Method in interface io.github.jdiscordbots.command_framework.command.ICommand: Returns a help message of this command.

I

ICommand - Interface in io.github.jdiscordbots.command_framework.command: Commands should implement this interface.
io.github.jdiscordbots.command_framework - package io.github.jdiscordbots.command_framework
io.github.jdiscordbots.command_framework.command - package io.github.jdiscordbots.command_framework.command
io.github.jdiscordbots.command_framework.command.slash - package io.github.jdiscordbots.command_framework.command.slash
io.github.jdiscordbots.command_framework.command.text - package io.github.jdiscordbots.command_framework.command.text
isAvailableToEveryone() - Method in interface io.github.jdiscordbots.command_framework.command.ICommand: checks weather this command can be used by anyone without special permissions.
isMentionPrefix() - Method in class io.github.jdiscordbots.command_framework.CommandFramework: Checks whether messages starting with a mention are interpreted as commands or not.
isRemoveUnknownSlashCommands() - Method in class io.github.jdiscordbots.command_framework.CommandFramework: Checks whether unknown slash commands should be removed on startup or not.
isRequired() - Method in class io.github.jdiscordbots.command_framework.command.ArgumentTemplate: Tests if the parameter is required.
isSlashCommandsPerGuild() - Method in class io.github.jdiscordbots.command_framework.CommandFramework: Checks whether slash commands should be enabled globally or on a per-guild basis.
isUnknownCommand() - Method in class io.github.jdiscordbots.command_framework.CommandFramework: Checks whether an action should be taken if an unknown command is executed.

M

MessageArgument - Class in io.github.jdiscordbots.command_framework.command.text: An Argument representing an argument of a text command
MessageArgument(Message, String) - Constructor for class io.github.jdiscordbots.command_framework.command.text.MessageArgument
MessageCommandEvent - Class in io.github.jdiscordbots.command_framework.command.text: A CommandEvent representing an executed text command.
MessageCommandEvent(CommandFramework, MessageReceivedEvent, List<Argument>) - Constructor for class io.github.jdiscordbots.command_framework.command.text.MessageCommandEvent

O

onButtonClick(ButtonInteractionEvent) - Method in interface io.github.jdiscordbots.command_framework.command.ICommand: This method is executed on every button click where the button id equals the name of the command.

R

removeCommand(String) - Method in class io.github.jdiscordbots.command_framework.CommandFramework: Removes an existing command.
reply(String) - Method in interface io.github.jdiscordbots.command_framework.command.CommandEvent: Sends a message in response to the invoked command.
reply(String) - Method in class io.github.jdiscordbots.command_framework.command.slash.SlashCommandFrameworkEvent: Sends a message in response to the invoked command.
reply(String) - Method in class io.github.jdiscordbots.command_framework.command.text.MessageCommandEvent: Sends a message in response to the invoked command.
reply(MessageEmbed) - Method in interface io.github.jdiscordbots.command_framework.command.CommandEvent: Sends a message in response to the invoked command.
reply(MessageEmbed) - Method in class io.github.jdiscordbots.command_framework.command.slash.SlashCommandFrameworkEvent: Sends a message in response to the invoked command.
reply(MessageEmbed) - Method in class io.github.jdiscordbots.command_framework.command.text.MessageCommandEvent: Sends a message in response to the invoked command.
reply(MessageCreateData) - Method in interface io.github.jdiscordbots.command_framework.command.CommandEvent: Sends a message in response to the invoked command.
reply(MessageCreateData) - Method in class io.github.jdiscordbots.command_framework.command.slash.SlashCommandFrameworkEvent: Sends a message in response to the invoked command.
reply(MessageCreateData) - Method in class io.github.jdiscordbots.command_framework.command.text.MessageCommandEvent: Sends a message in response to the invoked command.
replyWithActionRow(String, ItemComponent...) - Method in interface io.github.jdiscordbots.command_framework.command.CommandEvent: Sends a message with components in an action row in response to the invoked command.
replyWithActionRow(MessageEmbed, ItemComponent...) - Method in interface io.github.jdiscordbots.command_framework.command.CommandEvent: Sends a message with components in an action row in response to the invoked command.
replyWithActionRows(String, MessageEmbed, ActionRow...) - Method in interface io.github.jdiscordbots.command_framework.command.CommandEvent: Sends a message with components in an action row in response to the invoked command.
replyWithActionRows(String, ActionRow...) - Method in interface io.github.jdiscordbots.command_framework.command.CommandEvent: Sends a message with action rows in response to the invoked command.
replyWithActionRows(MessageEmbed, ActionRow...) - Method in interface io.github.jdiscordbots.command_framework.command.CommandEvent: Sends a message with action rows in response to the invoked command.

S

setMentionPrefix(boolean) - Method in class io.github.jdiscordbots.command_framework.CommandFramework: Set whether the system should respond to mentions or not
setOwners(String...) - Method in class io.github.jdiscordbots.command_framework.CommandFramework: Sets the owners of the bot.
setOwners(Collection<String>) - Method in class io.github.jdiscordbots.command_framework.CommandFramework: Sets the owners of the bot.
setPrefix(String) - Method in class io.github.jdiscordbots.command_framework.CommandFramework: Sets the prefix for commands to listen on.
setRemoveUnknownSlashCommands(boolean) - Method in class io.github.jdiscordbots.command_framework.CommandFramework: Sets whether unknown slash commands should be removed on startup or not.
setSlashCommandsPerGuild(boolean) - Method in class io.github.jdiscordbots.command_framework.CommandFramework: Sets whether slash commands should be enabled globally or on a per-guild basis.
setUnknownButtonAction(Consumer<ButtonInteractionEvent>) - Method in class io.github.jdiscordbots.command_framework.CommandFramework: Sets the action executed when an unknown button is pressed.
setUnknownCommand(boolean) - Method in class io.github.jdiscordbots.command_framework.CommandFramework: Sets whether an action should be taken if an unknown command is executed.
setUnknownCommandAction(Consumer<CommandEvent>) - Method in class io.github.jdiscordbots.command_framework.CommandFramework: Sets the action that occurs when an unkwown command is entered.
SlashArgument - Class in io.github.jdiscordbots.command_framework.command.slash: An Argument representing an argument of a slash command
SlashArgument(OptionMapping) - Constructor for class io.github.jdiscordbots.command_framework.command.slash.SlashArgument
SlashCommandFrameworkEvent - Class in io.github.jdiscordbots.command_framework.command.slash: A CommandEvent representing an executed slash command.
SlashCommandFrameworkEvent(CommandFramework, SlashCommandInteractionEvent) - Constructor for class io.github.jdiscordbots.command_framework.command.slash.SlashCommandFrameworkEvent
SlashCommandFrameworkEvent(CommandFramework, SlashCommandInteractionEvent, Collection<ArgumentTemplate>) - Constructor for class io.github.jdiscordbots.command_framework.command.slash.SlashCommandFrameworkEvent

V

value() - Element in annotation type io.github.jdiscordbots.command_framework.command.Command: Gets the aliases that can be used in order to execute this command

A B C D G H I M O R S V
All Classes and Interfaces|All Packages