Index
All Classes and Interfaces|All Packages|Constant Field Values|Serialized Form
A
- accept(InvocationContext<?>) - Method in interface com.github.kaktushose.jda.commands.dispatching.middleware.Middleware
-
Executes this middleware with the given
InvocationContext
. - adapter(Class<?>, TypeAdapter<?>) - Method in class com.github.kaktushose.jda.commands.JDACommandsBuilder
- AFTER_15_MINUTES - Static variable in interface com.github.kaktushose.jda.commands.dispatching.expiration.ExpirationStrategy
-
Default
ExpirationStrategy
ofExpirationStrategy.Inactivity
, that closesRuntimes
after 15 minutes of inactivity. - afterMinutes() - Method in record class com.github.kaktushose.jda.commands.dispatching.expiration.ExpirationStrategy.Inactivity
-
Returns the value of the
afterMinutes
record component. - annotation() - Element in annotation interface com.github.kaktushose.jda.commands.annotations.Implementation
-
Gets the annotation the
Validator
should be mapped to. - annotation() - Method in record class com.github.kaktushose.jda.commands.definitions.interactions.command.OptionDataDefinition.ConstraintDefinition
-
Returns the value of the
annotation
record component. - annotation(Class<T>) - Method in interface com.github.kaktushose.jda.commands.definitions.description.Description
-
Gets this element's
Annotation
for the specified type if such an annotation is present - annotations() - Method in record class com.github.kaktushose.jda.commands.definitions.description.ClassDescription
-
Returns the value of the
annotations
record component. - annotations() - Method in interface com.github.kaktushose.jda.commands.definitions.description.Description
-
a possibly-empty
Collection
of allAnnotation
s this element is annotated with. - annotations() - Method in record class com.github.kaktushose.jda.commands.definitions.description.MethodDescription
-
Returns the value of the
annotations
record component. - annotations() - Method in record class com.github.kaktushose.jda.commands.definitions.description.ParameterDescription
-
Returns the value of the
annotations
record component. - apply(Class<?>) - Method in class com.github.kaktushose.jda.commands.definitions.description.reflective.ReflectiveDescriptor
-
Transforms the given
Class
into aClassDescription
. - apply(Object, Object, InvocationContext<?>) - Method in interface com.github.kaktushose.jda.commands.dispatching.validation.Validator
-
Validates an argument.
- apply(String, GenericInteractionCreateEvent) - Method in class com.github.kaktushose.jda.commands.dispatching.adapter.impl.AudioChannelAdapter
-
Attempts to parse a String to a
AudioChannel
. - apply(String, GenericInteractionCreateEvent) - Method in class com.github.kaktushose.jda.commands.dispatching.adapter.impl.BooleanAdapter
-
Attempts to parse a String to a Boolean.
- apply(String, GenericInteractionCreateEvent) - Method in class com.github.kaktushose.jda.commands.dispatching.adapter.impl.ByteAdapter
-
Attempts to parse a String to a Byte.
- apply(String, GenericInteractionCreateEvent) - Method in class com.github.kaktushose.jda.commands.dispatching.adapter.impl.CharacterAdapter
-
Casts a String to a Char if and only if
raw.length == 1
. - apply(String, GenericInteractionCreateEvent) - Method in class com.github.kaktushose.jda.commands.dispatching.adapter.impl.DoubleAdapter
-
Attempts to parse a String to a Double.
- apply(String, GenericInteractionCreateEvent) - Method in class com.github.kaktushose.jda.commands.dispatching.adapter.impl.FloatAdapter
-
Attempts to parse a String to a Float.
- apply(String, GenericInteractionCreateEvent) - Method in class com.github.kaktushose.jda.commands.dispatching.adapter.impl.GuildChannelAdapter
-
Attempts to parse a String to a
GuildChannel
. - apply(String, GenericInteractionCreateEvent) - Method in class com.github.kaktushose.jda.commands.dispatching.adapter.impl.GuildMessageChannelAdapter
-
Attempts to parse a String to a
GuildMessageChannel
. - apply(String, GenericInteractionCreateEvent) - Method in class com.github.kaktushose.jda.commands.dispatching.adapter.impl.IntegerAdapter
-
Attempts to parse a String to an Integer.
- apply(String, GenericInteractionCreateEvent) - Method in class com.github.kaktushose.jda.commands.dispatching.adapter.impl.LongAdapter
-
Attempts to parse a String to a Long.
- apply(String, GenericInteractionCreateEvent) - Method in class com.github.kaktushose.jda.commands.dispatching.adapter.impl.MemberAdapter
-
Attempts to parse a String to a
Member
. - apply(String, GenericInteractionCreateEvent) - Method in class com.github.kaktushose.jda.commands.dispatching.adapter.impl.NewsChannelAdapter
-
Attempts to parse a String to a
NewsChannel
. - apply(String, GenericInteractionCreateEvent) - Method in class com.github.kaktushose.jda.commands.dispatching.adapter.impl.RoleAdapter
-
Attempts to parse a String to a
Role
. - apply(String, GenericInteractionCreateEvent) - Method in class com.github.kaktushose.jda.commands.dispatching.adapter.impl.ShortAdapter
-
Attempts to parse a String to a Short.
- apply(String, GenericInteractionCreateEvent) - Method in class com.github.kaktushose.jda.commands.dispatching.adapter.impl.StageChannelAdapter
-
Attempts to parse a String to a
StageChannel
. - apply(String, GenericInteractionCreateEvent) - Method in class com.github.kaktushose.jda.commands.dispatching.adapter.impl.TextChannelAdapter
-
Attempts to parse a String to a
TextChannel
. - apply(String, GenericInteractionCreateEvent) - Method in class com.github.kaktushose.jda.commands.dispatching.adapter.impl.ThreadChannelAdapter
-
Attempts to parse a String to a
ThreadChannel
. - apply(String, GenericInteractionCreateEvent) - Method in class com.github.kaktushose.jda.commands.dispatching.adapter.impl.UserAdapter
-
Attempts to parse a String to a
User
. - apply(String, GenericInteractionCreateEvent) - Method in class com.github.kaktushose.jda.commands.dispatching.adapter.impl.VoiceChannelAdapter
-
Attempts to parse a String to a
VoiceChannel
. - apply(String, GenericInteractionCreateEvent) - Method in interface com.github.kaktushose.jda.commands.dispatching.adapter.TypeAdapter
-
Attempts to parse a String to the given type.
- apply(CommandData) - Method in class com.github.kaktushose.jda.commands.scope.DefaultGuildScopeProvider
- apply(CommandData) - Method in interface com.github.kaktushose.jda.commands.scope.GuildScopeProvider
-
Gets a Set of guild ids the provided command should be registered for.
- arguments() - Method in record class com.github.kaktushose.jda.commands.dispatching.context.InvocationContext
-
Returns the value of the
arguments
record component. - AudioChannelAdapter - Class in com.github.kaktushose.jda.commands.dispatching.adapter.impl
-
Type adapter for JDAs
AudioChannel
. - AudioChannelAdapter() - Constructor for class com.github.kaktushose.jda.commands.dispatching.adapter.impl.AudioChannelAdapter
- Author(EmbedDTO.Author) - Constructor for class com.github.kaktushose.jda.commands.embeds.EmbedDTO.Author
- Author(String, String, String) - Constructor for class com.github.kaktushose.jda.commands.embeds.EmbedDTO.Author
- autoComplete() - Method in record class com.github.kaktushose.jda.commands.definitions.interactions.command.OptionDataDefinition
-
Returns the value of the
autoComplete
record component. - AutoComplete - Annotation Interface in com.github.kaktushose.jda.commands.annotations.interactions
-
Methods annotated with AutoComplete will be registered as a handler for
AutoCompleteEvent
s for the given SlashCommand. - AutoCompleteDefinition - Record Class in com.github.kaktushose.jda.commands.definitions.interactions
-
Representation of an auto complete handler.
- AutoCompleteDefinition(ClassDescription, MethodDescription, Set<String>) - Constructor for record class com.github.kaktushose.jda.commands.definitions.interactions.AutoCompleteDefinition
-
Creates an instance of a
AutoCompleteDefinition
record class. - autoCompleteDefinitions() - Method in record class com.github.kaktushose.jda.commands.definitions.interactions.MethodBuildContext
-
Returns the value of the
autoCompleteDefinitions
record component. - AutoCompleteEvent - Class in com.github.kaktushose.jda.commands.dispatching.events.interactions
-
This class is a subclass of
Event
. - AutoCompleteEvent(CommandAutoCompleteInteractionEvent, InteractionRegistry, Runtime) - Constructor for class com.github.kaktushose.jda.commands.dispatching.events.interactions.AutoCompleteEvent
-
Constructs a new AutoCompleteEvent.
B
- BooleanAdapter - Class in com.github.kaktushose.jda.commands.dispatching.adapter.impl
-
Type adapter for boolean values.
- BooleanAdapter() - Constructor for class com.github.kaktushose.jda.commands.dispatching.adapter.impl.BooleanAdapter
- BOUND_CUSTOM_ID_REGEX - Static variable in record class com.github.kaktushose.jda.commands.definitions.interactions.CustomId
- build(Cooldown) - Static method in record class com.github.kaktushose.jda.commands.definitions.interactions.command.SlashCommandDefinition.CooldownDefinition
-
Builds a new
SlashCommandDefinition.CooldownDefinition
from the givenCooldown
annotation. - build(SelectOption) - Static method in record class com.github.kaktushose.jda.commands.definitions.interactions.component.menu.StringSelectMenuDefinition.SelectOptionDefinition
-
Constructs a new
StringSelectMenuDefinition.SelectOptionDefinition
from the givenSelectOption
. - build(ClassDescription, MethodDescription) - Static method in record class com.github.kaktushose.jda.commands.definitions.interactions.AutoCompleteDefinition
-
Builds a new
AutoCompleteDefinition
from the given class and method description. - build(ParameterDescription, boolean, Validators) - Static method in record class com.github.kaktushose.jda.commands.definitions.interactions.command.OptionDataDefinition
-
Builds a new
OptionDataDefinition
. - build(ParameterDescription) - Static method in record class com.github.kaktushose.jda.commands.definitions.interactions.ModalDefinition.TextInputDefinition
-
Builds a new
ModalDefinition.TextInputDefinition
from the givenParameterDescription
- build(MethodBuildContext) - Static method in record class com.github.kaktushose.jda.commands.definitions.interactions.command.ContextCommandDefinition
-
Builds a new
ContextCommandDefinition
from the givenMethodBuildContext
. - build(MethodBuildContext) - Static method in record class com.github.kaktushose.jda.commands.definitions.interactions.command.SlashCommandDefinition
-
Builds a new
SlashCommandDefinition
from the givenMethodBuildContext
. - build(MethodBuildContext) - Static method in record class com.github.kaktushose.jda.commands.definitions.interactions.component.ButtonDefinition
-
Constructs a new
ButtonDefinition
from the givenMethodBuildContext
. - build(MethodBuildContext) - Static method in record class com.github.kaktushose.jda.commands.definitions.interactions.component.menu.EntitySelectMenuDefinition
-
Builds a new
EntitySelectMenuDefinition
from the givenMethodBuildContext
. - build(MethodBuildContext) - Static method in record class com.github.kaktushose.jda.commands.definitions.interactions.component.menu.StringSelectMenuDefinition
-
Builds a new
StringSelectMenuDefinition
from the givenMethodBuildContext
. - build(MethodBuildContext) - Static method in record class com.github.kaktushose.jda.commands.definitions.interactions.ModalDefinition
-
Builds a new
ModalDefinition
from the givenMethodBuildContext
. - build(Validator, Annotation) - Static method in record class com.github.kaktushose.jda.commands.definitions.interactions.command.OptionDataDefinition.ConstraintDefinition
-
Builds a new
OptionDataDefinition.ConstraintDefinition
. - builder - Variable in class com.github.kaktushose.jda.commands.dispatching.reply.MessageReply
- builder(JDA, Class<?>, String...) - Static method in class com.github.kaktushose.jda.commands.JDACommands
-
Create a new builder.
- builder(ShardManager, Class<?>, String...) - Static method in class com.github.kaktushose.jda.commands.JDACommands
-
Create a new builder.
- Button - Annotation Interface in com.github.kaktushose.jda.commands.annotations.interactions
-
Methods annotated with
Button
will be registered as a button at startup. - ButtonDefinition - Record Class in com.github.kaktushose.jda.commands.definitions.interactions.component
-
Representation of a button.
- ButtonDefinition(ClassDescription, MethodDescription, Collection<String>, String, Emoji, String, ButtonStyle) - Constructor for record class com.github.kaktushose.jda.commands.definitions.interactions.component.ButtonDefinition
-
Creates an instance of a
ButtonDefinition
record class. - ByteAdapter - Class in com.github.kaktushose.jda.commands.dispatching.adapter.impl
-
Type adapter for byte values.
- ByteAdapter() - Constructor for class com.github.kaktushose.jda.commands.dispatching.adapter.impl.ByteAdapter
C
- cancel(MessageCreateData) - Method in record class com.github.kaktushose.jda.commands.dispatching.context.InvocationContext
-
Stops further execution of this invocation at the next suitable moment.
- channelTypes() - Element in annotation interface com.github.kaktushose.jda.commands.annotations.interactions.EntitySelectMenu
-
The
ChannelType
s that should be supported by this menu. - channelTypes() - Method in record class com.github.kaktushose.jda.commands.definitions.interactions.component.menu.EntitySelectMenuDefinition
-
Returns the value of the
channelTypes
record component. - CharacterAdapter - Class in com.github.kaktushose.jda.commands.dispatching.adapter.impl
-
Type adapter for character values.
- CharacterAdapter() - Constructor for class com.github.kaktushose.jda.commands.dispatching.adapter.impl.CharacterAdapter
- choices() - Method in record class com.github.kaktushose.jda.commands.definitions.interactions.command.OptionDataDefinition
-
Returns the value of the
choices
record component. - Choices - Annotation Interface in com.github.kaktushose.jda.commands.annotations.interactions
-
Annotation used to add choices to parameters.
- ClassDescription - Record Class in com.github.kaktushose.jda.commands.definitions.description
-
A
Description
that describes a class. - ClassDescription(Class<?>, String, Collection<Annotation>, Collection<MethodDescription>) - Constructor for record class com.github.kaktushose.jda.commands.definitions.description.ClassDescription
-
Creates an instance of a
ClassDescription
record class. - ClassFinder - Interface in com.github.kaktushose.jda.commands.definitions.description
- classFinders(ClassFinder...) - Method in class com.github.kaktushose.jda.commands.JDACommandsBuilder
- clazz() - Method in record class com.github.kaktushose.jda.commands.definitions.description.ClassDescription
-
Returns the value of the
clazz
record component. - clazz() - Method in record class com.github.kaktushose.jda.commands.definitions.interactions.MethodBuildContext
-
Returns the value of the
clazz
record component. - clazzDescription() - Method in record class com.github.kaktushose.jda.commands.definitions.interactions.AutoCompleteDefinition
-
Returns the value of the
clazzDescription
record component. - clazzDescription() - Method in record class com.github.kaktushose.jda.commands.definitions.interactions.command.ContextCommandDefinition
-
Returns the value of the
clazzDescription
record component. - clazzDescription() - Method in record class com.github.kaktushose.jda.commands.definitions.interactions.command.SlashCommandDefinition
-
Returns the value of the
clazzDescription
record component. - clazzDescription() - Method in record class com.github.kaktushose.jda.commands.definitions.interactions.component.ButtonDefinition
-
Returns the value of the
clazzDescription
record component. - clazzDescription() - Method in interface com.github.kaktushose.jda.commands.definitions.interactions.component.ComponentDefinition
-
The
ClassDescription
of the declaring class of theComponentDefinition.methodDescription()
- clazzDescription() - Method in record class com.github.kaktushose.jda.commands.definitions.interactions.component.menu.EntitySelectMenuDefinition
-
Returns the value of the
clazzDescription
record component. - clazzDescription() - Method in record class com.github.kaktushose.jda.commands.definitions.interactions.component.menu.StringSelectMenuDefinition
-
Returns the value of the
clazzDescription
record component. - clazzDescription() - Method in record class com.github.kaktushose.jda.commands.definitions.interactions.ModalDefinition
-
Returns the value of the
clazzDescription
record component. - clear() - Method in class com.github.kaktushose.jda.commands.dispatching.context.KeyValueStore
-
Removes all the value mappings.
- closeRuntime() - Method in class com.github.kaktushose.jda.commands.dispatching.events.Event
-
Closes the underlying
Runtime
. - com.github.kaktushose.jda.commands - package com.github.kaktushose.jda.commands
-
Root package of JDA-Commands.
- com.github.kaktushose.jda.commands.annotations - package com.github.kaktushose.jda.commands.annotations
-
All annotations that are needed to use this framework.
- com.github.kaktushose.jda.commands.annotations.constraints - package com.github.kaktushose.jda.commands.annotations.constraints
-
All annotations needed for parameter validation.
- com.github.kaktushose.jda.commands.annotations.interactions - package com.github.kaktushose.jda.commands.annotations.interactions
-
Annotations needed for interactions.
- com.github.kaktushose.jda.commands.definitions - package com.github.kaktushose.jda.commands.definitions
- com.github.kaktushose.jda.commands.definitions.description - package com.github.kaktushose.jda.commands.definitions.description
-
This packages includes different types of
Descriptions
that contain meta information about classes, methods und parameters, similar to reflections. - com.github.kaktushose.jda.commands.definitions.description.reflective - package com.github.kaktushose.jda.commands.definitions.description.reflective
- com.github.kaktushose.jda.commands.definitions.features - package com.github.kaktushose.jda.commands.definitions.features
-
This package contains interfaces that implement some form of functionality for a definition, that not all definitions might share.
- com.github.kaktushose.jda.commands.definitions.interactions - package com.github.kaktushose.jda.commands.definitions.interactions
-
Definitions
that represent any type interaction. - com.github.kaktushose.jda.commands.definitions.interactions.command - package com.github.kaktushose.jda.commands.definitions.interactions.command
-
Definitions
that represent a command interaction. - com.github.kaktushose.jda.commands.definitions.interactions.component - package com.github.kaktushose.jda.commands.definitions.interactions.component
-
Definitions
that represent component interactions. - com.github.kaktushose.jda.commands.definitions.interactions.component.menu - package com.github.kaktushose.jda.commands.definitions.interactions.component.menu
-
Definitions
that represent select menu interactions. - com.github.kaktushose.jda.commands.dependency - package com.github.kaktushose.jda.commands.dependency
-
The Dependency Injection feature of jda-commands.
- com.github.kaktushose.jda.commands.dispatching.adapter - package com.github.kaktushose.jda.commands.dispatching.adapter
-
Generic type adapting system.
- com.github.kaktushose.jda.commands.dispatching.adapter.impl - package com.github.kaktushose.jda.commands.dispatching.adapter.impl
-
Default implementations for frequently used types.
- com.github.kaktushose.jda.commands.dispatching.context - package com.github.kaktushose.jda.commands.dispatching.context
- com.github.kaktushose.jda.commands.dispatching.events - package com.github.kaktushose.jda.commands.dispatching.events
-
Abstract event classes that build the foundation for specific event implementations.
- com.github.kaktushose.jda.commands.dispatching.events.interactions - package com.github.kaktushose.jda.commands.dispatching.events.interactions
-
Event classes that represent an interaction execution.
- com.github.kaktushose.jda.commands.dispatching.expiration - package com.github.kaktushose.jda.commands.dispatching.expiration
- com.github.kaktushose.jda.commands.dispatching.middleware - package com.github.kaktushose.jda.commands.dispatching.middleware
-
Middlewares get executed between preparation and method invocation.
- com.github.kaktushose.jda.commands.dispatching.reply - package com.github.kaktushose.jda.commands.dispatching.reply
-
Classes for sending bot messages.
- com.github.kaktushose.jda.commands.dispatching.validation - package com.github.kaktushose.jda.commands.dispatching.validation
-
Command parameter validation system.
- com.github.kaktushose.jda.commands.embeds - package com.github.kaktushose.jda.commands.embeds
-
Helper and factory classes for handling embeds.
- com.github.kaktushose.jda.commands.embeds.error - package com.github.kaktushose.jda.commands.embeds.error
-
Factory classes for generating error embeds.
- com.github.kaktushose.jda.commands.permissions - package com.github.kaktushose.jda.commands.permissions
-
Command permission system.
- com.github.kaktushose.jda.commands.scope - package com.github.kaktushose.jda.commands.scope
-
Contains everything to resolve the guilds for guild commands.
- CommandDefinition - Interface in com.github.kaktushose.jda.commands.definitions.interactions.command
-
Common interface for command interaction definitions.
- CommandEvent - Class in com.github.kaktushose.jda.commands.dispatching.events.interactions
-
This class is a subclass of
Event
. - CommandEvent(GenericCommandInteractionEvent, InteractionRegistry, Runtime, InteractionDefinition, InteractionDefinition.ReplyConfig) - Constructor for class com.github.kaktushose.jda.commands.dispatching.events.interactions.CommandEvent
-
Constructs a new CommandEvent.
- commandOptions() - Method in record class com.github.kaktushose.jda.commands.definitions.interactions.command.SlashCommandDefinition
-
Returns the value of the
commandOptions
record component. - commands() - Method in record class com.github.kaktushose.jda.commands.definitions.interactions.AutoCompleteDefinition
-
Returns the value of the
commands
record component. - CommandScope - Enum Class in com.github.kaktushose.jda.commands.annotations.interactions
-
Enum describing the two possible scopes a command can be registered for.
- commandType() - Method in interface com.github.kaktushose.jda.commands.definitions.interactions.command.CommandDefinition
-
The
Command.Type
of this command. - commandType() - Method in record class com.github.kaktushose.jda.commands.definitions.interactions.command.ContextCommandDefinition
-
Returns the value of the
commandType
record component. - commandType() - Method in record class com.github.kaktushose.jda.commands.definitions.interactions.command.SlashCommandDefinition
- complete() - Method in class com.github.kaktushose.jda.commands.dispatching.reply.MessageReply
-
Sends the reply to Discord and blocks the current thread until the message was sent.
- Component - Record Class in com.github.kaktushose.jda.commands.dispatching.reply
-
Represents a component, namely
Button
,StringSelectMenu
orEntitySelectMenu
, that should be added to a reply. - Component(boolean, boolean, String) - Constructor for record class com.github.kaktushose.jda.commands.dispatching.reply.Component
-
Creates an instance of a
Component
record class. - ComponentDefinition<T> - Interface in com.github.kaktushose.jda.commands.definitions.interactions.component
-
Common interface for component interaction definitions.
- ComponentEvent - Class in com.github.kaktushose.jda.commands.dispatching.events.interactions
-
This class is a subclass of
Event
. - ComponentEvent(GenericComponentInteractionCreateEvent, InteractionRegistry, Runtime, InteractionDefinition, InteractionDefinition.ReplyConfig) - Constructor for class com.github.kaktushose.jda.commands.dispatching.events.interactions.ComponentEvent
-
Constructs a new CommandEvent.
- ComponentReply - Class in com.github.kaktushose.jda.commands.dispatching.reply
-
Subtype of
ConfigurableReply
that allows replying only with a name without a message. - ComponentReply(ConfigurableReply) - Constructor for class com.github.kaktushose.jda.commands.dispatching.reply.ComponentReply
-
Constructs a new ComponentReply.
- components(Component...) - Method in class com.github.kaktushose.jda.commands.dispatching.reply.ConfigurableReply
- components(String...) - Method in class com.github.kaktushose.jda.commands.dispatching.reply.ConfigurableReply
-
Adds an
ActionRow
to the reply and adds the passed components to it. - ConfigurableReply - Class in com.github.kaktushose.jda.commands.dispatching.reply
-
Subtype of
MessageReply
that supports adding components to messages and changing theReplyConfig
. - ConfigurableReply(ConfigurableReply) - Constructor for class com.github.kaktushose.jda.commands.dispatching.reply.ConfigurableReply
-
Constructs a new ConfigurableReply.
- ConfigurableReply(MessageReply, InteractionRegistry, String) - Constructor for class com.github.kaktushose.jda.commands.dispatching.reply.ConfigurableReply
-
Constructs a new ConfigurableReply.
- Constraint - Annotation Interface in com.github.kaktushose.jda.commands.annotations.constraints
-
Indicates that an annotation type can be used for parameter validation.
- ConstraintDefinition(Validator, String, Object) - Constructor for record class com.github.kaktushose.jda.commands.definitions.interactions.command.OptionDataDefinition.ConstraintDefinition
-
Creates an instance of a
ConstraintDefinition
record class. - constraints() - Method in record class com.github.kaktushose.jda.commands.definitions.interactions.command.OptionDataDefinition
-
Returns the value of the
constraints
record component. - contains(String) - Method in class com.github.kaktushose.jda.commands.dispatching.context.KeyValueStore
-
Whether this StateSection has a value mapped to the key.
- containsEmbed(String) - Method in class com.github.kaktushose.jda.commands.embeds.EmbedCache
-
Returns
true
if this cache contains a mapping for the specified name. - ContextCommand - Annotation Interface in com.github.kaktushose.jda.commands.annotations.interactions
-
Methods annotated with ContextMenu will be registered as a context menu command.
- ContextCommandDefinition - Record Class in com.github.kaktushose.jda.commands.definitions.interactions.command
-
Representation of a context command.
- ContextCommandDefinition(ClassDescription, MethodDescription, Collection<String>, String, Command.Type, CommandScope, boolean, boolean, Set<Permission>, LocalizationFunction) - Constructor for record class com.github.kaktushose.jda.commands.definitions.interactions.command.ContextCommandDefinition
-
Creates an instance of a
ContextCommandDefinition
record class. - cooldown() - Method in record class com.github.kaktushose.jda.commands.definitions.interactions.command.SlashCommandDefinition
-
Returns the value of the
cooldown
record component. - Cooldown - Annotation Interface in com.github.kaktushose.jda.commands.annotations.interactions
-
Commands annotated with Cooldown will have a per-user cooldown.
- cooldownDefinition() - Method in record class com.github.kaktushose.jda.commands.definitions.interactions.MethodBuildContext
-
Returns the value of the
cooldownDefinition
record component. - CooldownDefinition(long, TimeUnit) - Constructor for record class com.github.kaktushose.jda.commands.definitions.interactions.command.SlashCommandDefinition.CooldownDefinition
-
Creates an instance of a
CooldownDefinition
record class. - CustomId - Record Class in com.github.kaktushose.jda.commands.definitions.interactions
-
Representation of a custom id used in modals, buttons or select menus.
- CustomId(String, String) - Constructor for record class com.github.kaktushose.jda.commands.definitions.interactions.CustomId
-
Creates an instance of a
CustomId
record class. - CustomIdJDAEntity<T> - Interface in com.github.kaktushose.jda.commands.definitions.features
-
Indicates that the implementing
Definition
can be transformed into a JDA entity that has aCustomId
.
D
- declaringClass() - Method in record class com.github.kaktushose.jda.commands.definitions.description.MethodDescription
-
Returns the value of the
declaringClass
record component. - defaultChannels() - Element in annotation interface com.github.kaktushose.jda.commands.annotations.interactions.EntitySelectMenu
-
The default values for channels that will be shown to the user.
- DefaultDependencyInjector - Class in com.github.kaktushose.jda.commands.dependency
-
Default implementation of
DependencyInjector
. - DefaultDependencyInjector() - Constructor for class com.github.kaktushose.jda.commands.dependency.DefaultDependencyInjector
-
Create a new DependencyInjector.
- DefaultErrorMessageFactory - Class in com.github.kaktushose.jda.commands.embeds.error
-
Implementation of
ErrorMessageFactory
with default embeds. - DefaultErrorMessageFactory() - Constructor for class com.github.kaktushose.jda.commands.embeds.error.DefaultErrorMessageFactory
- DefaultGuildScopeProvider - Class in com.github.kaktushose.jda.commands.scope
-
Default implementation of
GuildScopeProvider
. - DefaultGuildScopeProvider() - Constructor for class com.github.kaktushose.jda.commands.scope.DefaultGuildScopeProvider
- DefaultPermissionsProvider - Class in com.github.kaktushose.jda.commands.permissions
-
Default implementation of
PermissionsProvider
with the following behaviour: - DefaultPermissionsProvider() - Constructor for class com.github.kaktushose.jda.commands.permissions.DefaultPermissionsProvider
- defaultRoles() - Element in annotation interface com.github.kaktushose.jda.commands.annotations.interactions.EntitySelectMenu
-
The default values for roles that will be shown to the user.
- defaultUsers() - Element in annotation interface com.github.kaktushose.jda.commands.annotations.interactions.EntitySelectMenu
-
The default values for users that will be shown to the user.
- defaultValue() - Element in annotation interface com.github.kaktushose.jda.commands.annotations.interactions.TextInput
-
The default value of this TextInput.
- defaultValue() - Method in record class com.github.kaktushose.jda.commands.definitions.interactions.command.OptionDataDefinition
-
Returns the value of the
defaultValue
record component. - defaultValue() - Method in record class com.github.kaktushose.jda.commands.definitions.interactions.ModalDefinition.TextInputDefinition
-
Returns the value of the
defaultValue
record component. - defaultValues() - Method in record class com.github.kaktushose.jda.commands.definitions.interactions.component.menu.EntitySelectMenuDefinition
-
Returns the value of the
defaultValues
record component. - definition - Variable in class com.github.kaktushose.jda.commands.dispatching.events.ReplyableEvent
- definition - Variable in class com.github.kaktushose.jda.commands.dispatching.reply.MessageReply
- definition() - Method in record class com.github.kaktushose.jda.commands.dispatching.context.InvocationContext
-
Returns the value of the
definition
record component. - definition() - Method in interface com.github.kaktushose.jda.commands.embeds.error.ErrorMessageFactory.ErrorContext
-
The
InteractionDefinition
that models the interaction of theErrorMessageFactory.ErrorContext.event()
. - Definition - Interface in com.github.kaktushose.jda.commands.definitions
-
The common interface for all interaction definitions and their sub parts, such as parameters or text inputs, etc.
- definitionId() - Method in interface com.github.kaktushose.jda.commands.definitions.Definition
-
The id for this definition.
- definitionId() - Method in record class com.github.kaktushose.jda.commands.definitions.interactions.CustomId
-
Returns the value of the
definitionId
record component. - definitionId() - Method in interface com.github.kaktushose.jda.commands.definitions.interactions.InteractionDefinition
-
The id for this definition.
- definitions() - Method in record class com.github.kaktushose.jda.commands.definitions.interactions.InteractionRegistry
-
Returns the value of the
definitions
record component. - delay() - Method in record class com.github.kaktushose.jda.commands.definitions.interactions.command.SlashCommandDefinition.CooldownDefinition
-
Returns the value of the
delay
record component. - dependencyInjector() - Method in record class com.github.kaktushose.jda.commands.definitions.interactions.InteractionRegistry
-
Returns the value of the
dependencyInjector
record component. - dependencyInjector(DependencyInjector) - Method in class com.github.kaktushose.jda.commands.JDACommandsBuilder
- DependencyInjector - Interface in com.github.kaktushose.jda.commands.dependency
-
Central registry for dependencies and producing methods.
- desc() - Element in annotation interface com.github.kaktushose.jda.commands.annotations.interactions.SlashCommand
-
Returns the description of the command.
- description() - Element in annotation interface com.github.kaktushose.jda.commands.annotations.interactions.SelectOption
-
Gets the description of an option.
- description() - Method in record class com.github.kaktushose.jda.commands.definitions.interactions.command.OptionDataDefinition
-
Returns the value of the
description
record component. - description() - Method in record class com.github.kaktushose.jda.commands.definitions.interactions.command.SlashCommandDefinition
-
Returns the value of the
description
record component. - description() - Method in record class com.github.kaktushose.jda.commands.definitions.interactions.component.menu.StringSelectMenuDefinition.SelectOptionDefinition
-
Returns the value of the
description
record component. - Description - Interface in com.github.kaktushose.jda.commands.definitions.description
-
The common interface of all
Description
types. - descriptor() - Method in record class com.github.kaktushose.jda.commands.definitions.interactions.InteractionRegistry
-
Returns the value of the
descriptor
record component. - descriptor(Descriptor) - Method in class com.github.kaktushose.jda.commands.JDACommandsBuilder
- Descriptor - Interface in com.github.kaktushose.jda.commands.definitions.description
- disabled(String) - Static method in record class com.github.kaktushose.jda.commands.dispatching.reply.Component
-
Adds disabled, runtime-bound
Component
s to the reply. - displayName() - Method in interface com.github.kaktushose.jda.commands.definitions.Definition
-
The human-readable name of this definition.
- displayName() - Method in record class com.github.kaktushose.jda.commands.definitions.interactions.AutoCompleteDefinition
- displayName() - Method in record class com.github.kaktushose.jda.commands.definitions.interactions.command.ContextCommandDefinition
- displayName() - Method in record class com.github.kaktushose.jda.commands.definitions.interactions.command.OptionDataDefinition.ConstraintDefinition
- displayName() - Method in record class com.github.kaktushose.jda.commands.definitions.interactions.command.OptionDataDefinition
- displayName() - Method in record class com.github.kaktushose.jda.commands.definitions.interactions.command.SlashCommandDefinition.CooldownDefinition
- displayName() - Method in record class com.github.kaktushose.jda.commands.definitions.interactions.command.SlashCommandDefinition
- displayName() - Method in record class com.github.kaktushose.jda.commands.definitions.interactions.component.ButtonDefinition
- displayName() - Method in record class com.github.kaktushose.jda.commands.definitions.interactions.component.menu.EntitySelectMenuDefinition
- displayName() - Method in record class com.github.kaktushose.jda.commands.definitions.interactions.component.menu.StringSelectMenuDefinition
- displayName() - Method in record class com.github.kaktushose.jda.commands.definitions.interactions.component.menu.StringSelectMenuDefinition.SelectOptionDefinition
- displayName() - Method in record class com.github.kaktushose.jda.commands.definitions.interactions.ModalDefinition
- displayName() - Method in record class com.github.kaktushose.jda.commands.definitions.interactions.ModalDefinition.TextInputDefinition
- DoubleAdapter - Class in com.github.kaktushose.jda.commands.dispatching.adapter.impl
-
Type adapter for double values.
- DoubleAdapter() - Constructor for class com.github.kaktushose.jda.commands.dispatching.adapter.impl.DoubleAdapter
E
- editReply - Variable in class com.github.kaktushose.jda.commands.dispatching.reply.MessageReply
- editReply() - Element in annotation interface com.github.kaktushose.jda.commands.annotations.interactions.ReplyConfig
-
Whether to edit the original message or to send a new one.
- editReply() - Method in record class com.github.kaktushose.jda.commands.definitions.interactions.InteractionDefinition.ReplyConfig
-
Returns the value of the
editReply
record component. - editReply(boolean) - Method in class com.github.kaktushose.jda.commands.dispatching.reply.ConfigurableReply
-
Whether to keep the original components when editing a message.
- EmbedCache - Class in com.github.kaktushose.jda.commands.embeds
-
This class loads and caches embeds from a json file.
- EmbedCache(File) - Constructor for class com.github.kaktushose.jda.commands.embeds.EmbedCache
-
Constructs a new EmbedCache object.
- EmbedCache(InputStream) - Constructor for class com.github.kaktushose.jda.commands.embeds.EmbedCache
-
Constructs a new EmbedCache object.
- EmbedCache(String) - Constructor for class com.github.kaktushose.jda.commands.embeds.EmbedCache
-
Constructs a new EmbedCache object.
- EmbedDTO - Class in com.github.kaktushose.jda.commands.embeds
-
This class is a DTO to serialize and deserialize JDAs embed objects to json.
- EmbedDTO() - Constructor for class com.github.kaktushose.jda.commands.embeds.EmbedDTO
- EmbedDTO(EmbedDTO) - Constructor for class com.github.kaktushose.jda.commands.embeds.EmbedDTO
- EmbedDTO(String, String, String, String, String, EmbedDTO.Footer, EmbedDTO.Thumbnail, EmbedDTO.Image, EmbedDTO.Author, EmbedDTO.Field[]) - Constructor for class com.github.kaktushose.jda.commands.embeds.EmbedDTO
- EmbedDTO.Author - Class in com.github.kaktushose.jda.commands.embeds
- EmbedDTO.Field - Class in com.github.kaktushose.jda.commands.embeds
- EmbedDTO.Footer - Class in com.github.kaktushose.jda.commands.embeds
- EmbedDTO.Image - Class in com.github.kaktushose.jda.commands.embeds
- EmbedDTO.Thumbnail - Class in com.github.kaktushose.jda.commands.embeds
- emoji() - Element in annotation interface com.github.kaktushose.jda.commands.annotations.interactions.Button
-
Gets the
Emoji
of the button. - emoji() - Element in annotation interface com.github.kaktushose.jda.commands.annotations.interactions.SelectOption
-
Gets the
Emoji
of an option. - emoji() - Method in record class com.github.kaktushose.jda.commands.definitions.interactions.component.ButtonDefinition
-
Returns the value of the
emoji
record component. - emoji() - Method in record class com.github.kaktushose.jda.commands.definitions.interactions.component.menu.StringSelectMenuDefinition.SelectOptionDefinition
-
Returns the value of the
emoji
record component. - enabled() - Method in record class com.github.kaktushose.jda.commands.dispatching.reply.Component
-
Returns the value of the
enabled
record component. - enabled(String) - Static method in record class com.github.kaktushose.jda.commands.dispatching.reply.Component
-
Adds enabled, runtime-bound
Component
s to the reply. - enabledFor() - Element in annotation interface com.github.kaktushose.jda.commands.annotations.interactions.ContextCommand
-
Returns an array of
Permission
this command should be enabled for by default. - enabledFor() - Element in annotation interface com.github.kaktushose.jda.commands.annotations.interactions.SlashCommand
-
Returns an array of
Permission
s this command should be enabled for by default. - enabledPermissions() - Method in interface com.github.kaktushose.jda.commands.definitions.interactions.command.CommandDefinition
-
A possibly-empty
Set
ofPermission
s this command will be enabled for. - enabledPermissions() - Method in record class com.github.kaktushose.jda.commands.definitions.interactions.command.ContextCommandDefinition
-
Returns the value of the
enabledPermissions
record component. - enabledPermissions() - Method in record class com.github.kaktushose.jda.commands.definitions.interactions.command.SlashCommandDefinition
-
Returns the value of the
enabledPermissions
record component. - EntitySelectMenu - Annotation Interface in com.github.kaktushose.jda.commands.annotations.interactions
-
Methods annotated with EntitySelectMenu will be registered as a EntitySelectMenu at startup.
- EntitySelectMenuDefinition - Record Class in com.github.kaktushose.jda.commands.definitions.interactions.component.menu
-
Representation of an entity select menu.
- EntitySelectMenuDefinition(ClassDescription, MethodDescription, Collection<String>, Set<EntitySelectMenu.SelectTarget>, Set<EntitySelectMenu.DefaultValue>, Set<ChannelType>, String, int, int) - Constructor for record class com.github.kaktushose.jda.commands.definitions.interactions.component.menu.EntitySelectMenuDefinition
-
Creates an instance of a
EntitySelectMenuDefinition
record class. - ephemeral - Variable in class com.github.kaktushose.jda.commands.dispatching.reply.MessageReply
- ephemeral() - Element in annotation interface com.github.kaktushose.jda.commands.annotations.interactions.ReplyConfig
-
Whether to send ephemeral replies.
- ephemeral() - Method in record class com.github.kaktushose.jda.commands.definitions.interactions.InteractionDefinition.ReplyConfig
-
Returns the value of the
ephemeral
record component. - ephemeral(boolean) - Method in class com.github.kaktushose.jda.commands.dispatching.reply.ConfigurableReply
-
Whether to send ephemeral replies.
- equals(Object) - Method in record class com.github.kaktushose.jda.commands.definitions.description.ClassDescription
-
Indicates whether some other object is "equal to" this one.
- equals(Object) - Method in record class com.github.kaktushose.jda.commands.definitions.description.MethodDescription
-
Indicates whether some other object is "equal to" this one.
- equals(Object) - Method in record class com.github.kaktushose.jda.commands.definitions.description.ParameterDescription
-
Indicates whether some other object is "equal to" this one.
- equals(Object) - Method in record class com.github.kaktushose.jda.commands.definitions.interactions.AutoCompleteDefinition
-
Indicates whether some other object is "equal to" this one.
- equals(Object) - Method in record class com.github.kaktushose.jda.commands.definitions.interactions.command.ContextCommandDefinition
-
Indicates whether some other object is "equal to" this one.
- equals(Object) - Method in record class com.github.kaktushose.jda.commands.definitions.interactions.command.OptionDataDefinition.ConstraintDefinition
-
Indicates whether some other object is "equal to" this one.
- equals(Object) - Method in record class com.github.kaktushose.jda.commands.definitions.interactions.command.OptionDataDefinition
-
Indicates whether some other object is "equal to" this one.
- equals(Object) - Method in record class com.github.kaktushose.jda.commands.definitions.interactions.command.SlashCommandDefinition.CooldownDefinition
-
Indicates whether some other object is "equal to" this one.
- equals(Object) - Method in record class com.github.kaktushose.jda.commands.definitions.interactions.command.SlashCommandDefinition
-
Indicates whether some other object is "equal to" this one.
- equals(Object) - Method in record class com.github.kaktushose.jda.commands.definitions.interactions.component.ButtonDefinition
-
Indicates whether some other object is "equal to" this one.
- equals(Object) - Method in record class com.github.kaktushose.jda.commands.definitions.interactions.component.menu.EntitySelectMenuDefinition
-
Indicates whether some other object is "equal to" this one.
- equals(Object) - Method in record class com.github.kaktushose.jda.commands.definitions.interactions.component.menu.StringSelectMenuDefinition
-
Indicates whether some other object is "equal to" this one.
- equals(Object) - Method in record class com.github.kaktushose.jda.commands.definitions.interactions.component.menu.StringSelectMenuDefinition.SelectOptionDefinition
-
Indicates whether some other object is "equal to" this one.
- equals(Object) - Method in record class com.github.kaktushose.jda.commands.definitions.interactions.CustomId
-
Indicates whether some other object is "equal to" this one.
- equals(Object) - Method in record class com.github.kaktushose.jda.commands.definitions.interactions.InteractionDefinition.ReplyConfig
-
Indicates whether some other object is "equal to" this one.
- equals(Object) - Method in record class com.github.kaktushose.jda.commands.definitions.interactions.InteractionRegistry
-
Indicates whether some other object is "equal to" this one.
- equals(Object) - Method in record class com.github.kaktushose.jda.commands.definitions.interactions.MethodBuildContext
-
Indicates whether some other object is "equal to" this one.
- equals(Object) - Method in record class com.github.kaktushose.jda.commands.definitions.interactions.ModalDefinition
-
Indicates whether some other object is "equal to" this one.
- equals(Object) - Method in record class com.github.kaktushose.jda.commands.definitions.interactions.ModalDefinition.TextInputDefinition
-
Indicates whether some other object is "equal to" this one.
- equals(Object) - Method in record class com.github.kaktushose.jda.commands.dispatching.context.InvocationContext
-
Indicates whether some other object is "equal to" this one.
- equals(Object) - Method in record class com.github.kaktushose.jda.commands.dispatching.expiration.ExpirationStrategy.Explicit
-
Indicates whether some other object is "equal to" this one.
- equals(Object) - Method in record class com.github.kaktushose.jda.commands.dispatching.expiration.ExpirationStrategy.Inactivity
-
Indicates whether some other object is "equal to" this one.
- equals(Object) - Method in record class com.github.kaktushose.jda.commands.dispatching.reply.Component
-
Indicates whether some other object is "equal to" this one.
- errorMessageFactory(ErrorMessageFactory) - Method in class com.github.kaktushose.jda.commands.JDACommandsBuilder
- ErrorMessageFactory - Interface in com.github.kaktushose.jda.commands.embeds.error
-
Generic interface for factory classes that generate error messages.
- ErrorMessageFactory.ErrorContext - Interface in com.github.kaktushose.jda.commands.embeds.error
-
Holds the respective
GenericInteractionCreateEvent
andInteractionDefinition
of an error. - event - Variable in class com.github.kaktushose.jda.commands.dispatching.events.Event
- event - Variable in class com.github.kaktushose.jda.commands.dispatching.reply.MessageReply
- event() - Method in record class com.github.kaktushose.jda.commands.dispatching.context.InvocationContext
-
Returns the value of the
event
record component. - event() - Method in interface com.github.kaktushose.jda.commands.embeds.error.ErrorMessageFactory.ErrorContext
-
The
GenericInteractionCreateEvent
in whose execution the error occurred. - Event<T> - Class in com.github.kaktushose.jda.commands.dispatching.events
-
Abstract base event for all interaction events, like
CommandEvent
. - Event(T, InteractionRegistry, Runtime) - Constructor for class com.github.kaktushose.jda.commands.dispatching.events.Event
-
Constructs a new Event.
- expirationStrategy(ExpirationStrategy) - Method in class com.github.kaktushose.jda.commands.JDACommandsBuilder
- ExpirationStrategy - Interface in com.github.kaktushose.jda.commands.dispatching.expiration
-
Classes implementing
ExpirationStrategy
define a strategy when aRuntime
should be closed. - ExpirationStrategy.Explicit - Record Class in com.github.kaktushose.jda.commands.dispatching.expiration
- ExpirationStrategy.Inactivity - Record Class in com.github.kaktushose.jda.commands.dispatching.expiration
-
ExpirationStrategy
that closes aRuntime
after the passed amount of time. - explicit(Class<?>...) - Static method in interface com.github.kaktushose.jda.commands.definitions.description.ClassFinder
-
This provides an array backed implementation of
ClassFinder
that just returns the explicitly stated classes. - Explicit() - Constructor for record class com.github.kaktushose.jda.commands.dispatching.expiration.ExpirationStrategy.Explicit
-
Creates an instance of a
Explicit
record class. - EXPLICIT - Static variable in interface com.github.kaktushose.jda.commands.dispatching.expiration.ExpirationStrategy
-
Default
ExpirationStrategy
ofExpirationStrategy.Explicit
.
F
- Field(EmbedDTO.Field) - Constructor for class com.github.kaktushose.jda.commands.embeds.EmbedDTO.Field
- Field(String, String, boolean) - Constructor for class com.github.kaktushose.jda.commands.embeds.EmbedDTO.Field
- find() - Method in interface com.github.kaktushose.jda.commands.definitions.description.ClassFinder
- find() - Method in class com.github.kaktushose.jda.commands.definitions.description.reflective.ReflectiveClassFinder
- find(Class<T>, boolean, Predicate<T>) - Method in record class com.github.kaktushose.jda.commands.definitions.interactions.InteractionRegistry
- find(Class<T>, Predicate<T>) - Method in record class com.github.kaktushose.jda.commands.definitions.interactions.InteractionRegistry
- FloatAdapter - Class in com.github.kaktushose.jda.commands.dispatching.adapter.impl
-
Type adapter for float values.
- FloatAdapter() - Constructor for class com.github.kaktushose.jda.commands.dispatching.adapter.impl.FloatAdapter
- Footer(EmbedDTO.Footer) - Constructor for class com.github.kaktushose.jda.commands.embeds.EmbedDTO.Footer
- Footer(String, String) - Constructor for class com.github.kaktushose.jda.commands.embeds.EmbedDTO.Footer
- fromEvent(ModalInteractionEvent) - Static method in record class com.github.kaktushose.jda.commands.definitions.interactions.CustomId
-
Constructs a new
CustomId
from the givenModalInteractionEvent
. - fromEvent(GenericComponentInteractionCreateEvent) - Static method in record class com.github.kaktushose.jda.commands.definitions.interactions.CustomId
-
Constructs a new
CustomId
from the givenGenericInteractionCreateEvent
.
G
- get(String, Class<? extends T>) - Method in class com.github.kaktushose.jda.commands.dispatching.context.KeyValueStore
-
Gets a value.
- getAuthor() - Method in class com.github.kaktushose.jda.commands.embeds.EmbedDTO
- getButton(String) - Method in class com.github.kaktushose.jda.commands.dispatching.events.ReplyableEvent
- getButton(String) - Method in class com.github.kaktushose.jda.commands.JDACommands
- getChannel() - Method in class com.github.kaktushose.jda.commands.dispatching.events.Event
- getChannelIdLong() - Method in class com.github.kaktushose.jda.commands.dispatching.events.Event
- getColor() - Method in class com.github.kaktushose.jda.commands.embeds.EmbedDTO
- getCommandExecutionFailedMessage(ErrorMessageFactory.ErrorContext, Throwable) - Method in class com.github.kaktushose.jda.commands.embeds.error.DefaultErrorMessageFactory
- getCommandExecutionFailedMessage(ErrorMessageFactory.ErrorContext, Throwable) - Method in interface com.github.kaktushose.jda.commands.embeds.error.ErrorMessageFactory
-
Gets a
MessageCreateData
to send when the command execution failed. - getCommandExecutionFailedMessage(ErrorMessageFactory.ErrorContext, Throwable) - Method in class com.github.kaktushose.jda.commands.embeds.error.JsonErrorMessageFactory
- getConstraintFailedMessage(ErrorMessageFactory.ErrorContext, OptionDataDefinition.ConstraintDefinition) - Method in class com.github.kaktushose.jda.commands.embeds.error.DefaultErrorMessageFactory
- getConstraintFailedMessage(ErrorMessageFactory.ErrorContext, OptionDataDefinition.ConstraintDefinition) - Method in interface com.github.kaktushose.jda.commands.embeds.error.ErrorMessageFactory
-
Gets a
MessageCreateData
to send when a parameter constraint fails. - getConstraintFailedMessage(ErrorMessageFactory.ErrorContext, OptionDataDefinition.ConstraintDefinition) - Method in class com.github.kaktushose.jda.commands.embeds.error.JsonErrorMessageFactory
- getCooldownMessage(ErrorMessageFactory.ErrorContext, long) - Method in class com.github.kaktushose.jda.commands.embeds.error.DefaultErrorMessageFactory
- getCooldownMessage(ErrorMessageFactory.ErrorContext, long) - Method in interface com.github.kaktushose.jda.commands.embeds.error.ErrorMessageFactory
-
Gets a
Message
to send when a command still has a cooldown. - getCooldownMessage(ErrorMessageFactory.ErrorContext, long) - Method in class com.github.kaktushose.jda.commands.embeds.error.JsonErrorMessageFactory
- getDescription() - Method in class com.github.kaktushose.jda.commands.embeds.EmbedDTO
- getEmbed(String) - Method in class com.github.kaktushose.jda.commands.embeds.EmbedCache
-
Gets an embed from the cache.
- getEntitlements() - Method in class com.github.kaktushose.jda.commands.dispatching.events.Event
- getFields() - Method in class com.github.kaktushose.jda.commands.embeds.EmbedDTO
- getFooter() - Method in class com.github.kaktushose.jda.commands.embeds.EmbedDTO
- getGuild() - Method in class com.github.kaktushose.jda.commands.dispatching.events.Event
- getIconUrl() - Method in class com.github.kaktushose.jda.commands.embeds.EmbedDTO.Author
- getIconUrl() - Method in class com.github.kaktushose.jda.commands.embeds.EmbedDTO.Footer
- getIdLong() - Method in class com.github.kaktushose.jda.commands.dispatching.events.Event
- getImage() - Method in class com.github.kaktushose.jda.commands.embeds.EmbedDTO
- getInsufficientPermissionsMessage(ErrorMessageFactory.ErrorContext) - Method in class com.github.kaktushose.jda.commands.embeds.error.DefaultErrorMessageFactory
- getInsufficientPermissionsMessage(ErrorMessageFactory.ErrorContext) - Method in interface com.github.kaktushose.jda.commands.embeds.error.ErrorMessageFactory
-
Gets a
MessageCreateData
to send when a user is missing permissions. - getInsufficientPermissionsMessage(ErrorMessageFactory.ErrorContext) - Method in class com.github.kaktushose.jda.commands.embeds.error.JsonErrorMessageFactory
- getJDA() - Method in class com.github.kaktushose.jda.commands.dispatching.events.Event
- getMember() - Method in class com.github.kaktushose.jda.commands.dispatching.events.Event
- getName() - Method in class com.github.kaktushose.jda.commands.dispatching.events.interactions.AutoCompleteEvent
-
The name of the input field, usually an option name in
CommandAutoCompleteInteraction
. - getName() - Method in class com.github.kaktushose.jda.commands.embeds.EmbedDTO.Author
- getName() - Method in class com.github.kaktushose.jda.commands.embeds.EmbedDTO.Field
- getOptionType() - Method in class com.github.kaktushose.jda.commands.dispatching.events.interactions.AutoCompleteEvent
-
The expected option type for this query.
- getSelectMenu(String) - Method in class com.github.kaktushose.jda.commands.dispatching.events.ReplyableEvent
-
Gets a
StringSelectMenu
orEntitySelectMenu
based on the method name and transforms it into a JDASelectMenu
. - getSelectMenu(String) - Method in class com.github.kaktushose.jda.commands.JDACommands
-
Gets a
StringSelectMenu
orEntitySelectMenu
based on the definition id and transforms it into a JDASelectMenu
. - getText() - Method in class com.github.kaktushose.jda.commands.embeds.EmbedDTO.Footer
- getThumbnail() - Method in class com.github.kaktushose.jda.commands.embeds.EmbedDTO
- getTimedOutComponentMessage(GenericInteractionCreateEvent) - Method in class com.github.kaktushose.jda.commands.embeds.error.DefaultErrorMessageFactory
- getTimedOutComponentMessage(GenericInteractionCreateEvent) - Method in interface com.github.kaktushose.jda.commands.embeds.error.ErrorMessageFactory
-
Gets a
MessageCreateData
to send when an incoming component interaction already timed out. - getTimedOutComponentMessage(GenericInteractionCreateEvent) - Method in class com.github.kaktushose.jda.commands.embeds.error.JsonErrorMessageFactory
- getTimestamp() - Method in class com.github.kaktushose.jda.commands.embeds.EmbedDTO
- getTitle() - Method in class com.github.kaktushose.jda.commands.embeds.EmbedDTO
- getToken() - Method in class com.github.kaktushose.jda.commands.dispatching.events.Event
- getTypeAdaptingFailedMessage(ErrorMessageFactory.ErrorContext, List<String>) - Method in class com.github.kaktushose.jda.commands.embeds.error.DefaultErrorMessageFactory
- getTypeAdaptingFailedMessage(ErrorMessageFactory.ErrorContext, List<String>) - Method in interface com.github.kaktushose.jda.commands.embeds.error.ErrorMessageFactory
-
Gets a
MessageCreateData
to send when type adapting of the user input failed. - getTypeAdaptingFailedMessage(ErrorMessageFactory.ErrorContext, List<String>) - Method in class com.github.kaktushose.jda.commands.embeds.error.JsonErrorMessageFactory
- getTypeRaw() - Method in class com.github.kaktushose.jda.commands.dispatching.events.Event
- getUrl() - Method in class com.github.kaktushose.jda.commands.embeds.EmbedDTO.Author
- getUrl() - Method in class com.github.kaktushose.jda.commands.embeds.EmbedDTO
- getUrl() - Method in class com.github.kaktushose.jda.commands.embeds.EmbedDTO.Image
- getUrl() - Method in class com.github.kaktushose.jda.commands.embeds.EmbedDTO.Thumbnail
- getUser() - Method in class com.github.kaktushose.jda.commands.dispatching.events.Event
- getUserLocale() - Method in class com.github.kaktushose.jda.commands.dispatching.events.Event
- getValue() - Method in class com.github.kaktushose.jda.commands.dispatching.events.interactions.AutoCompleteEvent
-
The query value that the user is currently typing.
- getValue() - Method in class com.github.kaktushose.jda.commands.embeds.EmbedDTO.Field
- getWrongChannelTypeMessage(ErrorMessageFactory.ErrorContext) - Method in class com.github.kaktushose.jda.commands.embeds.error.DefaultErrorMessageFactory
- getWrongChannelTypeMessage(ErrorMessageFactory.ErrorContext) - Method in interface com.github.kaktushose.jda.commands.embeds.error.ErrorMessageFactory
-
Gets a
MessageCreateData
to send when the channel type isn't suitable for the command. - getWrongChannelTypeMessage(ErrorMessageFactory.ErrorContext) - Method in class com.github.kaktushose.jda.commands.embeds.error.JsonErrorMessageFactory
- GLOBAL - Enum constant in enum class com.github.kaktushose.jda.commands.annotations.interactions.CommandScope
- globalReplyConfig(InteractionDefinition.ReplyConfig) - Method in class com.github.kaktushose.jda.commands.JDACommandsBuilder
- GUILD - Enum constant in enum class com.github.kaktushose.jda.commands.annotations.interactions.CommandScope
- GuildChannelAdapter - Class in com.github.kaktushose.jda.commands.dispatching.adapter.impl
-
Type adapter for JDAs
GuildChannel
. - GuildChannelAdapter() - Constructor for class com.github.kaktushose.jda.commands.dispatching.adapter.impl.GuildChannelAdapter
- GuildMessageChannelAdapter - Class in com.github.kaktushose.jda.commands.dispatching.adapter.impl
-
Type adapter for JDAs
GuildMessageChannel
. - GuildMessageChannelAdapter() - Constructor for class com.github.kaktushose.jda.commands.dispatching.adapter.impl.GuildMessageChannelAdapter
- guildOnly() - Method in interface com.github.kaktushose.jda.commands.definitions.interactions.command.CommandDefinition
-
Whether this command can only be executed in guilds.
- guildOnly() - Method in record class com.github.kaktushose.jda.commands.definitions.interactions.command.ContextCommandDefinition
-
Returns the value of the
guildOnly
record component. - guildOnly() - Method in record class com.github.kaktushose.jda.commands.definitions.interactions.command.SlashCommandDefinition
-
Returns the value of the
guildOnly
record component. - guildScopeProvider(GuildScopeProvider) - Method in class com.github.kaktushose.jda.commands.JDACommandsBuilder
- GuildScopeProvider - Interface in com.github.kaktushose.jda.commands.scope
-
Interface for declaring on which Guilds a guild scoped command should be registered.
H
- hashCode() - Method in record class com.github.kaktushose.jda.commands.definitions.description.ClassDescription
-
Returns a hash code value for this object.
- hashCode() - Method in record class com.github.kaktushose.jda.commands.definitions.description.MethodDescription
-
Returns a hash code value for this object.
- hashCode() - Method in record class com.github.kaktushose.jda.commands.definitions.description.ParameterDescription
-
Returns a hash code value for this object.
- hashCode() - Method in record class com.github.kaktushose.jda.commands.definitions.interactions.AutoCompleteDefinition
-
Returns a hash code value for this object.
- hashCode() - Method in record class com.github.kaktushose.jda.commands.definitions.interactions.command.ContextCommandDefinition
-
Returns a hash code value for this object.
- hashCode() - Method in record class com.github.kaktushose.jda.commands.definitions.interactions.command.OptionDataDefinition.ConstraintDefinition
-
Returns a hash code value for this object.
- hashCode() - Method in record class com.github.kaktushose.jda.commands.definitions.interactions.command.OptionDataDefinition
-
Returns a hash code value for this object.
- hashCode() - Method in record class com.github.kaktushose.jda.commands.definitions.interactions.command.SlashCommandDefinition.CooldownDefinition
-
Returns a hash code value for this object.
- hashCode() - Method in record class com.github.kaktushose.jda.commands.definitions.interactions.command.SlashCommandDefinition
-
Returns a hash code value for this object.
- hashCode() - Method in record class com.github.kaktushose.jda.commands.definitions.interactions.component.ButtonDefinition
-
Returns a hash code value for this object.
- hashCode() - Method in record class com.github.kaktushose.jda.commands.definitions.interactions.component.menu.EntitySelectMenuDefinition
-
Returns a hash code value for this object.
- hashCode() - Method in record class com.github.kaktushose.jda.commands.definitions.interactions.component.menu.StringSelectMenuDefinition
-
Returns a hash code value for this object.
- hashCode() - Method in record class com.github.kaktushose.jda.commands.definitions.interactions.component.menu.StringSelectMenuDefinition.SelectOptionDefinition
-
Returns a hash code value for this object.
- hashCode() - Method in record class com.github.kaktushose.jda.commands.definitions.interactions.CustomId
-
Returns a hash code value for this object.
- hashCode() - Method in record class com.github.kaktushose.jda.commands.definitions.interactions.InteractionDefinition.ReplyConfig
-
Returns a hash code value for this object.
- hashCode() - Method in record class com.github.kaktushose.jda.commands.definitions.interactions.InteractionRegistry
-
Returns a hash code value for this object.
- hashCode() - Method in record class com.github.kaktushose.jda.commands.definitions.interactions.MethodBuildContext
-
Returns a hash code value for this object.
- hashCode() - Method in record class com.github.kaktushose.jda.commands.definitions.interactions.ModalDefinition
-
Returns a hash code value for this object.
- hashCode() - Method in record class com.github.kaktushose.jda.commands.definitions.interactions.ModalDefinition.TextInputDefinition
-
Returns a hash code value for this object.
- hashCode() - Method in record class com.github.kaktushose.jda.commands.dispatching.context.InvocationContext
-
Returns a hash code value for this object.
- hashCode() - Method in record class com.github.kaktushose.jda.commands.dispatching.expiration.ExpirationStrategy.Explicit
-
Returns a hash code value for this object.
- hashCode() - Method in record class com.github.kaktushose.jda.commands.dispatching.expiration.ExpirationStrategy.Inactivity
-
Returns a hash code value for this object.
- hashCode() - Method in record class com.github.kaktushose.jda.commands.dispatching.reply.Component
-
Returns a hash code value for this object.
- hasPermission(Member, InvocationContext<?>) - Method in class com.github.kaktushose.jda.commands.permissions.DefaultPermissionsProvider
-
Checks against the default Discord permissions.
- hasPermission(Member, InvocationContext<?>) - Method in interface com.github.kaktushose.jda.commands.permissions.PermissionsProvider
-
Checks if a
Member
has permissions. - hasPermission(User, InvocationContext<?>) - Method in class com.github.kaktushose.jda.commands.permissions.DefaultPermissionsProvider
-
Doesn't perform checks and will always return
true
. - hasPermission(User, InvocationContext<?>) - Method in interface com.github.kaktushose.jda.commands.permissions.PermissionsProvider
-
Checks if a
User
has permissions. - HIGH - Enum constant in enum class com.github.kaktushose.jda.commands.dispatching.middleware.Priority
-
Highest priority for custom implementation, will be executed right after internal middlewares.
I
- id() - Method in record class com.github.kaktushose.jda.commands.definitions.interactions.CustomId
-
The String representation of this custom id.
- Image(EmbedDTO.Image) - Constructor for class com.github.kaktushose.jda.commands.embeds.EmbedDTO.Image
- Image(String) - Constructor for class com.github.kaktushose.jda.commands.embeds.EmbedDTO.Image
- Implementation - Annotation Interface in com.github.kaktushose.jda.commands.annotations
-
Indicates that the annotated class is a custom implementation that should replace the default implementation.
- Inactivity(long) - Constructor for record class com.github.kaktushose.jda.commands.dispatching.expiration.ExpirationStrategy.Inactivity
-
Creates an instance of a
Inactivity
record class. - independent() - Method in record class com.github.kaktushose.jda.commands.dispatching.reply.Component
-
Returns the value of the
independent
record component. - independent(String) - Static method in record class com.github.kaktushose.jda.commands.definitions.interactions.CustomId
-
Constructs a new runtime-independent
CustomId
from the given definition id. - independent(String) - Static method in record class com.github.kaktushose.jda.commands.dispatching.reply.Component
-
Adds enabled, runtime-independent
Component
s to the reply. - INDEPENDENT_CUSTOM_ID_REGEX - Static variable in record class com.github.kaktushose.jda.commands.definitions.interactions.CustomId
- index(Class<?>, String...) - Method in class com.github.kaktushose.jda.commands.dependency.DefaultDependencyInjector
- index(Class<?>, String...) - Method in interface com.github.kaktushose.jda.commands.dependency.DependencyInjector
-
Scans the whole classpath for methods annotated with
Produces
. - index(Iterable<Class<?>>) - Method in record class com.github.kaktushose.jda.commands.definitions.interactions.InteractionRegistry
-
Scans all given classes and registers the interactions defined in them.
- inject(Object) - Method in class com.github.kaktushose.jda.commands.dependency.DefaultDependencyInjector
- inject(Object) - Method in interface com.github.kaktushose.jda.commands.dependency.DependencyInjector
-
Injects all registered dependencies with the corresponding value.
- Inject - Annotation Interface in com.github.kaktushose.jda.commands.annotations
-
Fields annotated with Inject will be assigned a value that is provided by a
Produces
method. - injectFields(Object...) - Method in class com.github.kaktushose.jda.commands.embeds.EmbedDTO
-
Attempts to inject
{placeholders}
with the values of the given object fields. - injectValue(String, Object) - Method in class com.github.kaktushose.jda.commands.embeds.EmbedDTO
-
Attempts to inject a
{placeholder}
with the given value. - injectValues(Map<String, Object>) - Method in class com.github.kaktushose.jda.commands.embeds.EmbedDTO
-
Attempts to inject
{placeholders}
with the given values. - IntegerAdapter - Class in com.github.kaktushose.jda.commands.dispatching.adapter.impl
-
Type adapter for integer values.
- IntegerAdapter() - Constructor for class com.github.kaktushose.jda.commands.dispatching.adapter.impl.IntegerAdapter
- interaction() - Method in record class com.github.kaktushose.jda.commands.definitions.interactions.MethodBuildContext
-
Returns the value of the
interaction
record component. - Interaction - Annotation Interface in com.github.kaktushose.jda.commands.annotations.interactions
-
Classes annotated with
Interaction
are responsible for defining and handling interactions. - InteractionDefinition - Interface in com.github.kaktushose.jda.commands.definitions.interactions
-
Common interface for all definitions that represent an interaction.
- InteractionDefinition.ReplyConfig - Record Class in com.github.kaktushose.jda.commands.definitions.interactions
-
Stores the configuration values for sending replies.
- InteractionRegistry - Record Class in com.github.kaktushose.jda.commands.definitions.interactions
-
Central registry for all
InteractionDefinition
s. - InteractionRegistry(DependencyInjector, Validators, LocalizationFunction, Descriptor, Set<Definition>) - Constructor for record class com.github.kaktushose.jda.commands.definitions.interactions.InteractionRegistry
-
Creates an instance of a
InteractionRegistry
record class. - InteractionRegistry(DependencyInjector, Validators, LocalizationFunction, Descriptor) - Constructor for record class com.github.kaktushose.jda.commands.definitions.interactions.InteractionRegistry
-
Constructs a new
InteractionRegistry
- InvocationContext<T> - Record Class in com.github.kaktushose.jda.commands.dispatching.context
-
Bundles data that is important for the execution of an interaction, especially for invoking the user defined method.
- InvocationContext(T, KeyValueStore, InteractionDefinition, SequencedCollection<Object>) - Constructor for record class com.github.kaktushose.jda.commands.dispatching.context.InvocationContext
-
Creates an instance of a
InvocationContext
record class. - invoke(Object, SequencedCollection<Object>) - Method in interface com.github.kaktushose.jda.commands.definitions.description.Invoker
- invoker() - Method in record class com.github.kaktushose.jda.commands.definitions.description.MethodDescription
-
Returns the value of the
invoker
record component. - Invoker - Interface in com.github.kaktushose.jda.commands.definitions.description
-
A functional interface, that allows the invocation of a
MethodDescription
. - isAcknowledged() - Method in class com.github.kaktushose.jda.commands.dispatching.events.Event
- isAutoComplete() - Method in record class com.github.kaktushose.jda.commands.definitions.interactions.command.SlashCommandDefinition
-
Returns the value of the
isAutoComplete
record component. - isBound() - Method in record class com.github.kaktushose.jda.commands.definitions.interactions.CustomId
-
Checks if the passed custom id is runtime-bound.
- isDefault() - Element in annotation interface com.github.kaktushose.jda.commands.annotations.interactions.SelectOption
-
Gets whether this option is a default option.
- isDefault() - Method in record class com.github.kaktushose.jda.commands.definitions.interactions.component.menu.StringSelectMenuDefinition.SelectOptionDefinition
-
Returns the value of the
isDefault
record component. - isEmpty() - Method in class com.github.kaktushose.jda.commands.embeds.EmbedCache
-
Returns
true
if this cache contains noEmbedDTO
s. - isGuildOnly() - Element in annotation interface com.github.kaktushose.jda.commands.annotations.interactions.ContextCommand
-
Returns whether this command is only usable in a guild.
- isGuildOnly() - Element in annotation interface com.github.kaktushose.jda.commands.annotations.interactions.SlashCommand
-
Returns whether this command is only usable in a guild.
- isIndependent() - Method in record class com.github.kaktushose.jda.commands.definitions.interactions.CustomId
-
Checks if the passed custom id is runtime-independent.
- isInline() - Method in class com.github.kaktushose.jda.commands.embeds.EmbedDTO.Field
- isInvalid(String) - Static method in record class com.github.kaktushose.jda.commands.definitions.interactions.CustomId
-
Checks if the passed custom id doesn't conform to the defined format of jda-commands.
- isNSFW() - Element in annotation interface com.github.kaktushose.jda.commands.annotations.interactions.ContextCommand
-
Returns whether this command can only be executed in NSFW channels.
- isNSFW() - Element in annotation interface com.github.kaktushose.jda.commands.annotations.interactions.SlashCommand
-
Returns whether this command can only be executed in NSFW channels.
J
- jda.commands - module jda.commands
-
The base module of jda-commands
- JDACommands - Class in com.github.kaktushose.jda.commands
-
The main entry point of the JDA-Commands framework.
- JDACommandsBuilder - Class in com.github.kaktushose.jda.commands
-
This builder is used to build instances of
JDACommands
. - JDAEntity<T> - Interface in com.github.kaktushose.jda.commands.definitions.features
-
Indicates that the implementing
Definition
can be transformed into a JDA entity. - jdaEvent() - Method in class com.github.kaktushose.jda.commands.dispatching.events.Event
-
Returns the underlying
GenericInteractionCreateEvent
of this event - jdaEvent(Class<T>) - Method in class com.github.kaktushose.jda.commands.dispatching.events.interactions.CommandEvent
-
Returns the underlying
GenericCommandInteractionEvent
and casts it to the given type. - jdaEvent(Class<T>) - Method in class com.github.kaktushose.jda.commands.dispatching.events.interactions.ComponentEvent
-
Returns the underlying
GenericComponentInteractionCreateEvent
and casts it to the given type. - JsonErrorMessageFactory - Class in com.github.kaktushose.jda.commands.embeds.error
-
Subtype of
DefaultErrorMessageFactory
that can load the embeds from anEmbedCache
. - JsonErrorMessageFactory(EmbedCache) - Constructor for class com.github.kaktushose.jda.commands.embeds.error.JsonErrorMessageFactory
K
- keepComponents - Variable in class com.github.kaktushose.jda.commands.dispatching.reply.MessageReply
- keepComponents() - Element in annotation interface com.github.kaktushose.jda.commands.annotations.interactions.ReplyConfig
-
Whether to keep the original components when editing a message.
- keepComponents() - Method in record class com.github.kaktushose.jda.commands.definitions.interactions.InteractionDefinition.ReplyConfig
-
Returns the value of the
keepComponents
record component. - keepComponents(boolean) - Method in class com.github.kaktushose.jda.commands.dispatching.reply.ConfigurableReply
-
Whether to edit the original message or to send a new one.
- keyValueStore() - Method in record class com.github.kaktushose.jda.commands.dispatching.context.InvocationContext
-
Returns the value of the
keyValueStore
record component. - KeyValueStore - Class in com.github.kaktushose.jda.commands.dispatching.context
-
A simple key-value-store to store variables between events.
- KeyValueStore() - Constructor for class com.github.kaktushose.jda.commands.dispatching.context.KeyValueStore
- kv() - Method in class com.github.kaktushose.jda.commands.dispatching.events.Event
-
Returns the
KeyValueStore
of thisRuntime
.
L
- label() - Element in annotation interface com.github.kaktushose.jda.commands.annotations.interactions.SelectOption
-
Gets the label of an option.
- label() - Element in annotation interface com.github.kaktushose.jda.commands.annotations.interactions.TextInput
-
The label shown above this text input box
- label() - Method in record class com.github.kaktushose.jda.commands.definitions.interactions.component.ButtonDefinition
-
Returns the value of the
label
record component. - label() - Method in record class com.github.kaktushose.jda.commands.definitions.interactions.component.menu.StringSelectMenuDefinition.SelectOptionDefinition
-
Returns the value of the
label
record component. - label() - Method in record class com.github.kaktushose.jda.commands.definitions.interactions.ModalDefinition.TextInputDefinition
-
Returns the value of the
label
record component. - link() - Element in annotation interface com.github.kaktushose.jda.commands.annotations.interactions.Button
-
Gets the link of the button.
- link() - Method in record class com.github.kaktushose.jda.commands.definitions.interactions.component.ButtonDefinition
-
Returns the value of the
link
record component. - loadEmbeds() - Method in class com.github.kaktushose.jda.commands.embeds.EmbedCache
-
Loads all embeds from a file and stores them.
- localizationFunction() - Method in interface com.github.kaktushose.jda.commands.definitions.interactions.command.CommandDefinition
-
The
LocalizationFunction
to use for this command. - localizationFunction() - Method in record class com.github.kaktushose.jda.commands.definitions.interactions.command.ContextCommandDefinition
-
Returns the value of the
localizationFunction
record component. - localizationFunction() - Method in record class com.github.kaktushose.jda.commands.definitions.interactions.command.SlashCommandDefinition
-
Returns the value of the
localizationFunction
record component. - localizationFunction() - Method in record class com.github.kaktushose.jda.commands.definitions.interactions.InteractionRegistry
-
Returns the value of the
localizationFunction
record component. - localizationFunction() - Method in record class com.github.kaktushose.jda.commands.definitions.interactions.MethodBuildContext
-
Returns the value of the
localizationFunction
record component. - localizationFunction(LocalizationFunction) - Method in class com.github.kaktushose.jda.commands.JDACommandsBuilder
- log - Static variable in class com.github.kaktushose.jda.commands.dispatching.reply.MessageReply
- LongAdapter - Class in com.github.kaktushose.jda.commands.dispatching.adapter.impl
-
Type adapter for long values.
- LongAdapter() - Constructor for class com.github.kaktushose.jda.commands.dispatching.adapter.impl.LongAdapter
- LOW - Enum constant in enum class com.github.kaktushose.jda.commands.dispatching.middleware.Priority
-
Lowest priority, will be executed at the end
M
- Max - Annotation Interface in com.github.kaktushose.jda.commands.annotations.constraints
-
The annotated element must be a number whose value must be less or equal to the specified maximum.
- maxValue() - Element in annotation interface com.github.kaktushose.jda.commands.annotations.interactions.EntitySelectMenu
-
The maximum amount of values a user can select.
- maxValue() - Element in annotation interface com.github.kaktushose.jda.commands.annotations.interactions.StringSelectMenu
-
The maximum amount of values a user can select.
- maxValue() - Element in annotation interface com.github.kaktushose.jda.commands.annotations.interactions.TextInput
-
The maximum length.
- maxValue() - Method in record class com.github.kaktushose.jda.commands.definitions.interactions.component.menu.EntitySelectMenuDefinition
-
Returns the value of the
maxValue
record component. - maxValue() - Method in interface com.github.kaktushose.jda.commands.definitions.interactions.component.menu.SelectMenuDefinition
-
the maximum amount of choices
- maxValue() - Method in record class com.github.kaktushose.jda.commands.definitions.interactions.component.menu.StringSelectMenuDefinition
-
Returns the value of the
maxValue
record component. - maxValue() - Method in record class com.github.kaktushose.jda.commands.definitions.interactions.ModalDefinition.TextInputDefinition
-
Returns the value of the
maxValue
record component. - MemberAdapter - Class in com.github.kaktushose.jda.commands.dispatching.adapter.impl
-
Type adapter for JDAs
Member
. - MemberAdapter() - Constructor for class com.github.kaktushose.jda.commands.dispatching.adapter.impl.MemberAdapter
- message() - Element in annotation interface com.github.kaktushose.jda.commands.annotations.constraints.Max
-
Returns the error message that will be displayed if the constraint fails.
- message() - Element in annotation interface com.github.kaktushose.jda.commands.annotations.constraints.Min
-
Returns the error message that will be displayed if the constraint fails.
- message() - Element in annotation interface com.github.kaktushose.jda.commands.annotations.constraints.NotPerm
-
Returns the error message that will be displayed if the constraint fails.
- message() - Element in annotation interface com.github.kaktushose.jda.commands.annotations.constraints.NotRole
-
Returns the error message that will be displayed if the constraint fails.
- message() - Element in annotation interface com.github.kaktushose.jda.commands.annotations.constraints.NotUser
-
Returns the error message that will be displayed if the constraint fails.
- message() - Element in annotation interface com.github.kaktushose.jda.commands.annotations.constraints.Perm
-
Returns the error message that will be displayed if the constraint fails.
- message() - Element in annotation interface com.github.kaktushose.jda.commands.annotations.constraints.Role
-
Returns the error message that will be displayed if the constraint fails.
- message() - Element in annotation interface com.github.kaktushose.jda.commands.annotations.constraints.User
-
Returns the error message that will be displayed if the constraint fails.
- message() - Method in record class com.github.kaktushose.jda.commands.definitions.interactions.command.OptionDataDefinition.ConstraintDefinition
-
Returns the value of the
message
record component. - MessageReply - Class in com.github.kaktushose.jda.commands.dispatching.reply
-
Simple builder for sending text messages based on a
GenericInteractionCreateEvent
. - MessageReply(MessageReply) - Constructor for class com.github.kaktushose.jda.commands.dispatching.reply.MessageReply
-
Constructs a new MessageReply.
- MessageReply(GenericInteractionCreateEvent, InteractionDefinition, InteractionDefinition.ReplyConfig) - Constructor for class com.github.kaktushose.jda.commands.dispatching.reply.MessageReply
-
Constructs a new MessageReply.
- method() - Method in record class com.github.kaktushose.jda.commands.definitions.interactions.MethodBuildContext
-
Returns the value of the
method
record component. - MethodBuildContext - Record Class in com.github.kaktushose.jda.commands.definitions.interactions
-
Holds all objects needed to create an
InteractionDefinition
. - MethodBuildContext(Validators, LocalizationFunction, Interaction, Set<String>, SlashCommandDefinition.CooldownDefinition, ClassDescription, MethodDescription, Collection<AutoCompleteDefinition>) - Constructor for record class com.github.kaktushose.jda.commands.definitions.interactions.MethodBuildContext
-
Creates an instance of a
MethodBuildContext
record class. - methodDescription() - Method in record class com.github.kaktushose.jda.commands.definitions.interactions.AutoCompleteDefinition
-
Returns the value of the
methodDescription
record component. - methodDescription() - Method in record class com.github.kaktushose.jda.commands.definitions.interactions.command.ContextCommandDefinition
-
Returns the value of the
methodDescription
record component. - methodDescription() - Method in record class com.github.kaktushose.jda.commands.definitions.interactions.command.SlashCommandDefinition
-
Returns the value of the
methodDescription
record component. - methodDescription() - Method in record class com.github.kaktushose.jda.commands.definitions.interactions.component.ButtonDefinition
-
Returns the value of the
methodDescription
record component. - methodDescription() - Method in interface com.github.kaktushose.jda.commands.definitions.interactions.component.ComponentDefinition
-
The
MethodDescription
of the method this definition is bound to - methodDescription() - Method in record class com.github.kaktushose.jda.commands.definitions.interactions.component.menu.EntitySelectMenuDefinition
-
Returns the value of the
methodDescription
record component. - methodDescription() - Method in record class com.github.kaktushose.jda.commands.definitions.interactions.component.menu.StringSelectMenuDefinition
-
Returns the value of the
methodDescription
record component. - methodDescription() - Method in record class com.github.kaktushose.jda.commands.definitions.interactions.ModalDefinition
-
Returns the value of the
methodDescription
record component. - MethodDescription - Record Class in com.github.kaktushose.jda.commands.definitions.description
-
A
Description
that describes a method. - MethodDescription(Class<?>, Class<?>, String, SequencedCollection<ParameterDescription>, Collection<Annotation>, Invoker) - Constructor for record class com.github.kaktushose.jda.commands.definitions.description.MethodDescription
-
Creates an instance of a
MethodDescription
record class. - methods() - Method in record class com.github.kaktushose.jda.commands.definitions.description.ClassDescription
-
Returns the value of the
methods
record component. - middleware(Priority, Middleware) - Method in class com.github.kaktushose.jda.commands.JDACommandsBuilder
- Middleware - Interface in com.github.kaktushose.jda.commands.dispatching.middleware
-
Middlewares run just before an interaction event gets dispatched.
- Min - Annotation Interface in com.github.kaktushose.jda.commands.annotations.constraints
-
The annotated element must be a number whose value must be greater or equal to the specified minimum.
- minValue() - Element in annotation interface com.github.kaktushose.jda.commands.annotations.interactions.EntitySelectMenu
-
The minimum amount of values a user has to select.
- minValue() - Element in annotation interface com.github.kaktushose.jda.commands.annotations.interactions.StringSelectMenu
-
The minimum amount of values a user has to select.
- minValue() - Element in annotation interface com.github.kaktushose.jda.commands.annotations.interactions.TextInput
-
The minimum length.
- minValue() - Method in record class com.github.kaktushose.jda.commands.definitions.interactions.component.menu.EntitySelectMenuDefinition
-
Returns the value of the
minValue
record component. - minValue() - Method in interface com.github.kaktushose.jda.commands.definitions.interactions.component.menu.SelectMenuDefinition
-
the minimum amount of choices
- minValue() - Method in record class com.github.kaktushose.jda.commands.definitions.interactions.component.menu.StringSelectMenuDefinition
-
Returns the value of the
minValue
record component. - minValue() - Method in record class com.github.kaktushose.jda.commands.definitions.interactions.ModalDefinition.TextInputDefinition
-
Returns the value of the
minValue
record component. - Modal - Annotation Interface in com.github.kaktushose.jda.commands.annotations.interactions
-
Methods annotated with
Modal
will be registered as a modal at startup. - ModalDefinition - Record Class in com.github.kaktushose.jda.commands.definitions.interactions
-
Representation of a modal.
- ModalDefinition(ClassDescription, MethodDescription, Collection<String>, String, SequencedCollection<ModalDefinition.TextInputDefinition>) - Constructor for record class com.github.kaktushose.jda.commands.definitions.interactions.ModalDefinition
-
Creates an instance of a
ModalDefinition
record class. - ModalDefinition.TextInputDefinition - Record Class in com.github.kaktushose.jda.commands.definitions.interactions
-
Representation of a modal text input defined by
TextInput
- ModalEvent - Class in com.github.kaktushose.jda.commands.dispatching.events.interactions
-
This class is a subclass of
Event
. - ModalEvent(ModalInteractionEvent, InteractionRegistry, Runtime, InteractionDefinition, InteractionDefinition.ReplyConfig) - Constructor for class com.github.kaktushose.jda.commands.dispatching.events.interactions.ModalEvent
-
Constructs a new CommandEvent.
- ModalReplyableEvent<T> - Class in com.github.kaktushose.jda.commands.dispatching.events
-
Subtype of
ReplyableEvent
that also supports replying with aModal
. - ModalReplyableEvent(T, InteractionRegistry, Runtime, InteractionDefinition, InteractionDefinition.ReplyConfig) - Constructor for class com.github.kaktushose.jda.commands.dispatching.events.ModalReplyableEvent
-
Constructs a new ModalReplyableEvent.
N
- name() - Element in annotation interface com.github.kaktushose.jda.commands.annotations.interactions.Param
-
Returns the name of the parameter.
- name() - Method in record class com.github.kaktushose.jda.commands.definitions.description.ClassDescription
-
Returns the value of the
name
record component. - name() - Method in record class com.github.kaktushose.jda.commands.definitions.description.MethodDescription
-
Returns the value of the
name
record component. - name() - Method in record class com.github.kaktushose.jda.commands.definitions.description.ParameterDescription
-
Returns the value of the
name
record component. - name() - Method in interface com.github.kaktushose.jda.commands.definitions.interactions.command.CommandDefinition
-
The name of the command.
- name() - Method in record class com.github.kaktushose.jda.commands.definitions.interactions.command.ContextCommandDefinition
-
Returns the value of the
name
record component. - name() - Method in record class com.github.kaktushose.jda.commands.definitions.interactions.command.OptionDataDefinition
-
Returns the value of the
name
record component. - name() - Method in record class com.github.kaktushose.jda.commands.definitions.interactions.command.SlashCommandDefinition
-
Returns the value of the
name
record component. - name() - Method in record class com.github.kaktushose.jda.commands.dispatching.reply.Component
-
Returns the value of the
name
record component. - newInstance() - Method in interface com.github.kaktushose.jda.commands.definitions.interactions.InteractionDefinition
-
Creates a new instance of the
Interaction
class. - NewsChannelAdapter - Class in com.github.kaktushose.jda.commands.dispatching.adapter.impl
-
Type adapter for JDAs
NewsChannel
. - NewsChannelAdapter() - Constructor for class com.github.kaktushose.jda.commands.dispatching.adapter.impl.NewsChannelAdapter
- NORMAL - Enum constant in enum class com.github.kaktushose.jda.commands.dispatching.middleware.Priority
-
Default priority.
- NotPerm - Annotation Interface in com.github.kaktushose.jda.commands.annotations.constraints
-
The annotated element must be a user or member that doesn't have the specified discord permission.
- NotRole - Annotation Interface in com.github.kaktushose.jda.commands.annotations.constraints
-
The annotated element must be member that doesn't have the specified guild role.
- NotUser - Annotation Interface in com.github.kaktushose.jda.commands.annotations.constraints
-
The annotated element must not be the specified user or member.
- nsfw() - Method in interface com.github.kaktushose.jda.commands.definitions.interactions.command.CommandDefinition
-
Whether this command is nsfw.
- nsfw() - Method in record class com.github.kaktushose.jda.commands.definitions.interactions.command.ContextCommandDefinition
-
Returns the value of the
nsfw
record component. - nsfw() - Method in record class com.github.kaktushose.jda.commands.definitions.interactions.command.SlashCommandDefinition
-
Returns the value of the
nsfw
record component.
O
- of(boolean, boolean, String) - Static method in record class com.github.kaktushose.jda.commands.dispatching.reply.Component
-
Adds
Component
s with the passed configuration to the reply. - optional() - Method in record class com.github.kaktushose.jda.commands.definitions.interactions.command.OptionDataDefinition
-
Returns the value of the
optional
record component. - Optional - Annotation Interface in com.github.kaktushose.jda.commands.annotations.interactions
-
Parameters annotated with Optional are as the name says optional.
- OptionDataDefinition - Record Class in com.github.kaktushose.jda.commands.definitions.interactions.command
-
Representation of a slash command parameter.
- OptionDataDefinition(Class<?>, boolean, boolean, String, String, String, SequencedCollection<Command.Choice>, Collection<OptionDataDefinition.ConstraintDefinition>) - Constructor for record class com.github.kaktushose.jda.commands.definitions.interactions.command.OptionDataDefinition
-
Creates an instance of a
OptionDataDefinition
record class. - OptionDataDefinition.ConstraintDefinition - Record Class in com.github.kaktushose.jda.commands.definitions.interactions.command
-
Representation of a parameter constraint defined by a constraint annotation.
P
- Param - Annotation Interface in com.github.kaktushose.jda.commands.annotations.interactions
-
Annotation used to add a name and description to slash command parameters.
- ParameterDescription - Record Class in com.github.kaktushose.jda.commands.definitions.description
-
A
Description
that describes a parameter. - ParameterDescription(Class<?>, String, Collection<Annotation>) - Constructor for record class com.github.kaktushose.jda.commands.definitions.description.ParameterDescription
-
Creates an instance of a
ParameterDescription
record class. - parameters() - Method in record class com.github.kaktushose.jda.commands.definitions.description.MethodDescription
-
Returns the value of the
parameters
record component. - Perm - Annotation Interface in com.github.kaktushose.jda.commands.annotations.constraints
-
The annotated element must be a user or member that have the specified discord permission.
- permissions() - Method in record class com.github.kaktushose.jda.commands.definitions.interactions.AutoCompleteDefinition
- permissions() - Method in record class com.github.kaktushose.jda.commands.definitions.interactions.command.ContextCommandDefinition
-
Returns the value of the
permissions
record component. - permissions() - Method in record class com.github.kaktushose.jda.commands.definitions.interactions.command.SlashCommandDefinition
-
Returns the value of the
permissions
record component. - permissions() - Method in record class com.github.kaktushose.jda.commands.definitions.interactions.component.ButtonDefinition
-
Returns the value of the
permissions
record component. - permissions() - Method in record class com.github.kaktushose.jda.commands.definitions.interactions.component.menu.EntitySelectMenuDefinition
-
Returns the value of the
permissions
record component. - permissions() - Method in record class com.github.kaktushose.jda.commands.definitions.interactions.component.menu.StringSelectMenuDefinition
-
Returns the value of the
permissions
record component. - permissions() - Method in interface com.github.kaktushose.jda.commands.definitions.interactions.InteractionDefinition
-
A possibly-empty
Collection
of permissions for this interaction. - permissions() - Method in record class com.github.kaktushose.jda.commands.definitions.interactions.MethodBuildContext
-
Returns the value of the
permissions
record component. - permissions() - Method in record class com.github.kaktushose.jda.commands.definitions.interactions.ModalDefinition
-
Returns the value of the
permissions
record component. - Permissions - Annotation Interface in com.github.kaktushose.jda.commands.annotations.interactions
-
Interaction
classes or interaction methods (commands, components or modals) annotated with Permission will require the user to have the given permissions in order to execute the command. - PERMISSIONS - Enum constant in enum class com.github.kaktushose.jda.commands.dispatching.middleware.Priority
-
Middlewares with priority PERMISSIONS will always be executed first
- permissionsProvider(PermissionsProvider) - Method in class com.github.kaktushose.jda.commands.JDACommandsBuilder
- PermissionsProvider - Interface in com.github.kaktushose.jda.commands.permissions
-
Interface for performing permission checks.
- placeholder() - Element in annotation interface com.github.kaktushose.jda.commands.annotations.interactions.EntitySelectMenu
-
Configure the placeholder which is displayed when no selections have been made yet.
- placeholder() - Method in record class com.github.kaktushose.jda.commands.definitions.interactions.component.menu.EntitySelectMenuDefinition
-
Returns the value of the
placeholder
record component. - placeholder() - Method in interface com.github.kaktushose.jda.commands.definitions.interactions.component.menu.SelectMenuDefinition
-
the placeholder text of this menu
- placeholder() - Method in record class com.github.kaktushose.jda.commands.definitions.interactions.component.menu.StringSelectMenuDefinition
-
Returns the value of the
placeholder
record component. - placeholder() - Method in record class com.github.kaktushose.jda.commands.definitions.interactions.ModalDefinition.TextInputDefinition
-
Returns the value of the
placeholder
record component. - priority() - Element in annotation interface com.github.kaktushose.jda.commands.annotations.Implementation
-
Gets the
Priority
to register theMiddleware
with. - Priority - Enum Class in com.github.kaktushose.jda.commands.dispatching.middleware
-
Enum to define with witch priority a
Middleware
should be executed. - Produces - Annotation Interface in com.github.kaktushose.jda.commands.annotations
-
Methods annotated with Produces will be used to get the instance of a dependency.
- put(String, Object) - Method in class com.github.kaktushose.jda.commands.dispatching.context.KeyValueStore
-
Associates the specified value with the specified key.
R
- reflective(Class<?>, String...) - Static method in interface com.github.kaktushose.jda.commands.definitions.description.ClassFinder
-
This provides a reflections based implementation of
ClassFinder
- ReflectiveClassFinder - Class in com.github.kaktushose.jda.commands.definitions.description.reflective
- ReflectiveClassFinder(Class<?>, String[]) - Constructor for class com.github.kaktushose.jda.commands.definitions.description.reflective.ReflectiveClassFinder
- ReflectiveDescriptor - Class in com.github.kaktushose.jda.commands.definitions.description.reflective
- ReflectiveDescriptor() - Constructor for class com.github.kaktushose.jda.commands.definitions.description.reflective.ReflectiveDescriptor
- registerDependencies(Class<?>, List<Field>) - Method in class com.github.kaktushose.jda.commands.dependency.DefaultDependencyInjector
- registerDependencies(Class<?>, List<Field>) - Method in interface com.github.kaktushose.jda.commands.dependency.DependencyInjector
-
Registers fields inside a class as dependencies.
- registerProvider(Object) - Method in class com.github.kaktushose.jda.commands.dependency.DefaultDependencyInjector
- registerProvider(Object) - Method in interface com.github.kaktushose.jda.commands.dependency.DependencyInjector
-
Takes an instance of a class and scans it for methods annotated with
Produces
. - registry - Variable in class com.github.kaktushose.jda.commands.dispatching.events.Event
- registry - Variable in class com.github.kaktushose.jda.commands.dispatching.reply.ConfigurableReply
- remove(String) - Method in class com.github.kaktushose.jda.commands.dispatching.context.KeyValueStore
-
Removes the value mapping for a key.
- removeComponents() - Method in class com.github.kaktushose.jda.commands.dispatching.events.ReplyableEvent
-
Removes all components from the original message.
- reply() - Method in class com.github.kaktushose.jda.commands.dispatching.reply.ComponentReply
-
Sends the reply to Discord.
- reply(EmbedDTO) - Method in interface com.github.kaktushose.jda.commands.dispatching.reply.Reply
-
Acknowledgement of this event with a text message.
- reply(String) - Method in class com.github.kaktushose.jda.commands.dispatching.events.ReplyableEvent
- reply(String) - Method in class com.github.kaktushose.jda.commands.dispatching.reply.MessageReply
- reply(String) - Method in interface com.github.kaktushose.jda.commands.dispatching.reply.Reply
-
Acknowledgement of this event with a text message.
- reply(String, Object...) - Method in interface com.github.kaktushose.jda.commands.dispatching.reply.Reply
-
Acknowledgement of this event with a text message.
- reply(EmbedBuilder) - Method in class com.github.kaktushose.jda.commands.dispatching.events.ReplyableEvent
- reply(EmbedBuilder) - Method in class com.github.kaktushose.jda.commands.dispatching.reply.MessageReply
- reply(EmbedBuilder) - Method in interface com.github.kaktushose.jda.commands.dispatching.reply.Reply
-
Acknowledgement of this event with a text message.
- reply(MessageCreateData) - Method in class com.github.kaktushose.jda.commands.dispatching.events.ReplyableEvent
- reply(MessageCreateData) - Method in class com.github.kaktushose.jda.commands.dispatching.reply.MessageReply
- reply(MessageCreateData) - Method in interface com.github.kaktushose.jda.commands.dispatching.reply.Reply
-
Acknowledgement of this event with a text message.
- Reply - Interface in com.github.kaktushose.jda.commands.dispatching.reply
-
Common interface for classes that support simple message replies to
GenericInteractionCreateEvent
. - ReplyableEvent<T> - Class in com.github.kaktushose.jda.commands.dispatching.events
-
Subtype of
Event
that supports replying to theGenericInteractionCreateEvent
with text messages. - ReplyableEvent(T, InteractionRegistry, Runtime, InteractionDefinition, InteractionDefinition.ReplyConfig) - Constructor for class com.github.kaktushose.jda.commands.dispatching.events.ReplyableEvent
-
Constructs a new ReplyableEvent.
- replyChoice(String, double) - Method in class com.github.kaktushose.jda.commands.dispatching.events.interactions.AutoCompleteEvent
-
Reply with up to 25 choices which can be picked from by the user.
- replyChoice(String, long) - Method in class com.github.kaktushose.jda.commands.dispatching.events.interactions.AutoCompleteEvent
-
Reply with up to 25 choices which can be picked from by the user.
- replyChoice(String, String) - Method in class com.github.kaktushose.jda.commands.dispatching.events.interactions.AutoCompleteEvent
-
Reply with up to 25 choices which can be picked from by the user.
- replyChoiceDoubles(double...) - Method in class com.github.kaktushose.jda.commands.dispatching.events.interactions.AutoCompleteEvent
-
Reply with up to 25 choices which can be picked from by the user.
- replyChoiceDoubles(Collection<Double>) - Method in class com.github.kaktushose.jda.commands.dispatching.events.interactions.AutoCompleteEvent
-
Reply with up to 25 choices which can be picked from by the user.
- replyChoiceLongs(long...) - Method in class com.github.kaktushose.jda.commands.dispatching.events.interactions.AutoCompleteEvent
-
Reply with up to 25 choices which can be picked from by the user.
- replyChoiceLongs(Collection<Long>) - Method in class com.github.kaktushose.jda.commands.dispatching.events.interactions.AutoCompleteEvent
-
Reply with up to 25 choices which can be picked from by the user.
- replyChoices(Collection<Command.Choice>) - Method in class com.github.kaktushose.jda.commands.dispatching.events.interactions.AutoCompleteEvent
-
Reply with up to 25 choices which can be picked from by the user.
- replyChoices(Command.Choice...) - Method in class com.github.kaktushose.jda.commands.dispatching.events.interactions.AutoCompleteEvent
-
Reply with up to 25 choices which can be picked from by the user.
- replyChoiceStrings(String...) - Method in class com.github.kaktushose.jda.commands.dispatching.events.interactions.AutoCompleteEvent
-
Reply with up to 25 choices which can be picked from by the user.
- replyChoiceStrings(Collection<String>) - Method in class com.github.kaktushose.jda.commands.dispatching.events.interactions.AutoCompleteEvent
-
Reply with up to 25 choices which can be picked from by the user.
- replyConfig(InteractionDefinition.ReplyConfig) - Method in interface com.github.kaktushose.jda.commands.definitions.interactions.InteractionDefinition
-
The
InteractionDefinition.ReplyConfig
that should be used when sending replies. - ReplyConfig - Annotation Interface in com.github.kaktushose.jda.commands.annotations.interactions
-
Used to configure the reply behaviour of interaction replies.
- ReplyConfig() - Constructor for record class com.github.kaktushose.jda.commands.definitions.interactions.InteractionDefinition.ReplyConfig
-
Constructs a new
InteractionDefinition.ReplyConfig
using the following default values: - ReplyConfig(boolean, boolean, boolean) - Constructor for record class com.github.kaktushose.jda.commands.definitions.interactions.InteractionDefinition.ReplyConfig
-
Creates an instance of a
ReplyConfig
record class. - ReplyConfig(ReplyConfig) - Constructor for record class com.github.kaktushose.jda.commands.definitions.interactions.InteractionDefinition.ReplyConfig
-
Constructs a new ReplyConfig.
- replyModal(String) - Method in class com.github.kaktushose.jda.commands.dispatching.events.ModalReplyableEvent
-
Acknowledgement of this event with a
Modal
. - required() - Element in annotation interface com.github.kaktushose.jda.commands.annotations.interactions.TextInput
-
Whether this TextInput is required.
- required() - Method in record class com.github.kaktushose.jda.commands.definitions.interactions.ModalDefinition.TextInputDefinition
-
Returns the value of the
required
record component. - returnType() - Method in record class com.github.kaktushose.jda.commands.definitions.description.MethodDescription
-
Returns the value of the
returnType
record component. - Role - Annotation Interface in com.github.kaktushose.jda.commands.annotations.constraints
-
The annotated element must be member that have the specified guild role.
- RoleAdapter - Class in com.github.kaktushose.jda.commands.dispatching.adapter.impl
-
Type adapter for JDAs
Role
. - RoleAdapter() - Constructor for class com.github.kaktushose.jda.commands.dispatching.adapter.impl.RoleAdapter
- runtimeId - Variable in class com.github.kaktushose.jda.commands.dispatching.reply.ConfigurableReply
- runtimeId() - Method in record class com.github.kaktushose.jda.commands.definitions.interactions.CustomId
-
Gets the runtime id of this custom id.
- runtimeId() - Method in class com.github.kaktushose.jda.commands.dispatching.events.Event
-
Returns the id of the
Runtime
this event is dispatched in.
S
- scope() - Element in annotation interface com.github.kaktushose.jda.commands.annotations.interactions.ContextCommand
-
Returns whether this command should be registered as a global or as a guild command.
- scope() - Element in annotation interface com.github.kaktushose.jda.commands.annotations.interactions.SlashCommand
-
Returns whether this command should be registered as a global or as a guild command.
- scope() - Method in interface com.github.kaktushose.jda.commands.definitions.interactions.command.CommandDefinition
-
The
CommandScope
of this command. - scope() - Method in record class com.github.kaktushose.jda.commands.definitions.interactions.command.ContextCommandDefinition
-
Returns the value of the
scope
record component. - scope() - Method in record class com.github.kaktushose.jda.commands.definitions.interactions.command.SlashCommandDefinition
-
Returns the value of the
scope
record component. - SelectMenuDefinition<T> - Interface in com.github.kaktushose.jda.commands.definitions.interactions.component.menu
-
Common interface for select menu definitions.
- SelectOption - Annotation Interface in com.github.kaktushose.jda.commands.annotations.interactions
-
Used to define
SelectOptions
forStringSelectMenu
s. - SelectOptionDefinition(String, String, String, Emoji, boolean) - Constructor for record class com.github.kaktushose.jda.commands.definitions.interactions.component.menu.StringSelectMenuDefinition.SelectOptionDefinition
-
Creates an instance of a
SelectOptionDefinition
record class. - selectOptions() - Method in record class com.github.kaktushose.jda.commands.definitions.interactions.component.menu.StringSelectMenuDefinition
-
Returns the value of the
selectOptions
record component. - selectTargets() - Method in record class com.github.kaktushose.jda.commands.definitions.interactions.component.menu.EntitySelectMenuDefinition
-
Returns the value of the
selectTargets
record component. - setAuthor(EmbedDTO.Author) - Method in class com.github.kaktushose.jda.commands.embeds.EmbedDTO
- setColor(String) - Method in class com.github.kaktushose.jda.commands.embeds.EmbedDTO
- setDescription(String) - Method in class com.github.kaktushose.jda.commands.embeds.EmbedDTO
- setFields(EmbedDTO.Field[]) - Method in class com.github.kaktushose.jda.commands.embeds.EmbedDTO
- setFooter(EmbedDTO.Footer) - Method in class com.github.kaktushose.jda.commands.embeds.EmbedDTO
- setImage(EmbedDTO.Image) - Method in class com.github.kaktushose.jda.commands.embeds.EmbedDTO
- setThumbnail(EmbedDTO.Thumbnail) - Method in class com.github.kaktushose.jda.commands.embeds.EmbedDTO
- setTimestamp(String) - Method in class com.github.kaktushose.jda.commands.embeds.EmbedDTO
- setTitle(String) - Method in class com.github.kaktushose.jda.commands.embeds.EmbedDTO
- setUrl(String) - Method in class com.github.kaktushose.jda.commands.embeds.EmbedDTO
- ShortAdapter - Class in com.github.kaktushose.jda.commands.dispatching.adapter.impl
-
Type adapter for short values.
- ShortAdapter() - Constructor for class com.github.kaktushose.jda.commands.dispatching.adapter.impl.ShortAdapter
- shutdown() - Method in class com.github.kaktushose.jda.commands.JDACommands
-
Shuts down this JDACommands instance, making it unable to receive any events from Discord.
- size() - Method in class com.github.kaktushose.jda.commands.embeds.EmbedCache
-
Returns the number of
EmbedDTO
s in this cache. - skipIndexing() - Element in annotation interface com.github.kaktushose.jda.commands.annotations.Produces
-
Whether jda-commands should ignore this method at indexing during startup.
- SlashCommand - Annotation Interface in com.github.kaktushose.jda.commands.annotations.interactions
-
Methods annotated with SlashCommand will be registered as a slash command at startup.
- SlashCommandDefinition - Record Class in com.github.kaktushose.jda.commands.definitions.interactions.command
-
Representation of a slash command.
- SlashCommandDefinition(ClassDescription, MethodDescription, Collection<String>, String, CommandScope, boolean, boolean, Set<Permission>, LocalizationFunction, String, SequencedCollection<OptionDataDefinition>, SlashCommandDefinition.CooldownDefinition, boolean) - Constructor for record class com.github.kaktushose.jda.commands.definitions.interactions.command.SlashCommandDefinition
-
Creates an instance of a
SlashCommandDefinition
record class. - SlashCommandDefinition.CooldownDefinition - Record Class in com.github.kaktushose.jda.commands.definitions.interactions.command
-
Representation of a cooldown definition defined by
Cooldown
. - StageChannelAdapter - Class in com.github.kaktushose.jda.commands.dispatching.adapter.impl
-
Type adapter for JDAs
StageChannel
. - StageChannelAdapter() - Constructor for class com.github.kaktushose.jda.commands.dispatching.adapter.impl.StageChannelAdapter
- start() - Method in class com.github.kaktushose.jda.commands.JDACommandsBuilder
-
This method instantiates an instance of
JDACommands
and starts the framework. - start(JDA, Class<?>, String...) - Static method in class com.github.kaktushose.jda.commands.JDACommands
-
Creates a new JDACommands instance and starts the frameworks, including scanning the classpath for annotated classes.
- start(ShardManager, Class<?>, String...) - Static method in class com.github.kaktushose.jda.commands.JDACommands
-
Creates a new JDACommands instance and starts the frameworks, including scanning the classpath for annotated classes.
- StringSelectMenu - Annotation Interface in com.github.kaktushose.jda.commands.annotations.interactions
-
Methods annotated with StringSelectMenu will be registered as a StringSelectMenu at startup.
- StringSelectMenuDefinition - Record Class in com.github.kaktushose.jda.commands.definitions.interactions.component.menu
-
Representation of a string select menu.
- StringSelectMenuDefinition(ClassDescription, MethodDescription, Collection<String>, Set<StringSelectMenuDefinition.SelectOptionDefinition>, String, int, int) - Constructor for record class com.github.kaktushose.jda.commands.definitions.interactions.component.menu.StringSelectMenuDefinition
-
Creates an instance of a
StringSelectMenuDefinition
record class. - StringSelectMenuDefinition.SelectOptionDefinition - Record Class in com.github.kaktushose.jda.commands.definitions.interactions.component.menu
-
Representation of a select option for a string select menu defined by a
SelectOption
. - style() - Element in annotation interface com.github.kaktushose.jda.commands.annotations.interactions.Button
-
Gets the
ButtonStyle
. - style() - Element in annotation interface com.github.kaktushose.jda.commands.annotations.interactions.TextInput
-
The
TextInputStyle
. - style() - Method in record class com.github.kaktushose.jda.commands.definitions.interactions.component.ButtonDefinition
-
Returns the value of the
style
record component. - style() - Method in record class com.github.kaktushose.jda.commands.definitions.interactions.ModalDefinition.TextInputDefinition
-
Returns the value of the
style
record component.
T
- TextChannelAdapter - Class in com.github.kaktushose.jda.commands.dispatching.adapter.impl
-
Type adapter for JDAs
TextChannel
. - TextChannelAdapter() - Constructor for class com.github.kaktushose.jda.commands.dispatching.adapter.impl.TextChannelAdapter
- TextInput - Annotation Interface in com.github.kaktushose.jda.commands.annotations.interactions
-
Annotation used to add TextInputs to
Modal
s. - TextInputDefinition(String, String, String, int, int, TextInputStyle, boolean) - Constructor for record class com.github.kaktushose.jda.commands.definitions.interactions.ModalDefinition.TextInputDefinition
-
Creates an instance of a
TextInputDefinition
record class. - textInputs() - Method in record class com.github.kaktushose.jda.commands.definitions.interactions.ModalDefinition
-
Returns the value of the
textInputs
record component. - ThreadChannelAdapter - Class in com.github.kaktushose.jda.commands.dispatching.adapter.impl
-
Type adapter for JDAs
ThreadChannel
. - ThreadChannelAdapter() - Constructor for class com.github.kaktushose.jda.commands.dispatching.adapter.impl.ThreadChannelAdapter
- Thumbnail(EmbedDTO.Thumbnail) - Constructor for class com.github.kaktushose.jda.commands.embeds.EmbedDTO.Thumbnail
- Thumbnail(String) - Constructor for class com.github.kaktushose.jda.commands.embeds.EmbedDTO.Thumbnail
- timeUnit() - Element in annotation interface com.github.kaktushose.jda.commands.annotations.interactions.Cooldown
-
Returns the
TimeUnit
of the specified delay. - timeUnit() - Method in record class com.github.kaktushose.jda.commands.definitions.interactions.command.SlashCommandDefinition.CooldownDefinition
-
Returns the value of the
timeUnit
record component. - title() - Method in record class com.github.kaktushose.jda.commands.definitions.interactions.ModalDefinition
-
Returns the value of the
title
record component. - toEmbedBuilder() - Method in class com.github.kaktushose.jda.commands.embeds.EmbedDTO
-
Transfers this object to a
EmbedBuilder
. - toJDAEntity() - Method in interface com.github.kaktushose.jda.commands.definitions.features.JDAEntity
-
Transforms this
Definition
into a JDA entity of the given typeJDAEntity
. - toJDAEntity() - Method in record class com.github.kaktushose.jda.commands.definitions.interactions.command.ContextCommandDefinition
-
Transforms this definition into
CommandData
. - toJDAEntity() - Method in record class com.github.kaktushose.jda.commands.definitions.interactions.command.OptionDataDefinition
-
Transforms this definition into
OptionData
. - toJDAEntity() - Method in record class com.github.kaktushose.jda.commands.definitions.interactions.command.SlashCommandDefinition
-
Transforms this definition into
SlashCommandData
. - toJDAEntity() - Method in record class com.github.kaktushose.jda.commands.definitions.interactions.component.ButtonDefinition
-
Transforms this definition to an
Button
with an independent custom id. - toJDAEntity() - Method in record class com.github.kaktushose.jda.commands.definitions.interactions.component.menu.EntitySelectMenuDefinition
-
Transforms this definition to an
EntitySelectMenu
with an independent custom id. - toJDAEntity() - Method in record class com.github.kaktushose.jda.commands.definitions.interactions.component.menu.StringSelectMenuDefinition.SelectOptionDefinition
-
Transforms this definition into a
SelectOption
. - toJDAEntity() - Method in record class com.github.kaktushose.jda.commands.definitions.interactions.component.menu.StringSelectMenuDefinition
-
Transforms this definition to an
StringSelectMenu
with an independent custom id. - toJDAEntity() - Method in record class com.github.kaktushose.jda.commands.definitions.interactions.ModalDefinition.TextInputDefinition
-
Transforms this definition into a
TextInput
. - toJDAEntity(CustomId) - Method in interface com.github.kaktushose.jda.commands.definitions.features.CustomIdJDAEntity
-
Transforms this
Definition
into a JDA entity of the given typeCustomIdJDAEntity
. - toJDAEntity(CustomId) - Method in record class com.github.kaktushose.jda.commands.definitions.interactions.component.ButtonDefinition
- toJDAEntity(CustomId) - Method in record class com.github.kaktushose.jda.commands.definitions.interactions.component.menu.EntitySelectMenuDefinition
-
Transforms this definition to an
EntitySelectMenu
with the givenCustomId
. - toJDAEntity(CustomId) - Method in record class com.github.kaktushose.jda.commands.definitions.interactions.component.menu.StringSelectMenuDefinition
-
Transforms this definition to an
StringSelectMenu
with the givenCustomId
. - toJDAEntity(CustomId) - Method in record class com.github.kaktushose.jda.commands.definitions.interactions.ModalDefinition
-
Transforms this definition to an
Modal
with the given custom id. - toMessageCreateData() - Method in class com.github.kaktushose.jda.commands.embeds.EmbedDTO
-
Transfers this object to a
MessageCreateBuilder
. - toMessageEmbed() - Method in class com.github.kaktushose.jda.commands.embeds.EmbedDTO
-
Transfers this object to a
MessageEmbed
. - toString() - Method in record class com.github.kaktushose.jda.commands.definitions.description.ClassDescription
-
Returns a string representation of this record class.
- toString() - Method in record class com.github.kaktushose.jda.commands.definitions.description.MethodDescription
-
Returns a string representation of this record class.
- toString() - Method in record class com.github.kaktushose.jda.commands.definitions.description.ParameterDescription
-
Returns a string representation of this record class.
- toString() - Method in record class com.github.kaktushose.jda.commands.definitions.interactions.AutoCompleteDefinition
-
Returns a string representation of this record class.
- toString() - Method in record class com.github.kaktushose.jda.commands.definitions.interactions.command.ContextCommandDefinition
-
Returns a string representation of this record class.
- toString() - Method in record class com.github.kaktushose.jda.commands.definitions.interactions.command.OptionDataDefinition.ConstraintDefinition
-
Returns a string representation of this record class.
- toString() - Method in record class com.github.kaktushose.jda.commands.definitions.interactions.command.OptionDataDefinition
-
Returns a string representation of this record class.
- toString() - Method in record class com.github.kaktushose.jda.commands.definitions.interactions.command.SlashCommandDefinition.CooldownDefinition
-
Returns a string representation of this record class.
- toString() - Method in record class com.github.kaktushose.jda.commands.definitions.interactions.command.SlashCommandDefinition
-
Returns a string representation of this record class.
- toString() - Method in record class com.github.kaktushose.jda.commands.definitions.interactions.component.ButtonDefinition
-
Returns a string representation of this record class.
- toString() - Method in record class com.github.kaktushose.jda.commands.definitions.interactions.component.menu.EntitySelectMenuDefinition
-
Returns a string representation of this record class.
- toString() - Method in record class com.github.kaktushose.jda.commands.definitions.interactions.component.menu.StringSelectMenuDefinition.SelectOptionDefinition
-
Returns a string representation of this record class.
- toString() - Method in record class com.github.kaktushose.jda.commands.definitions.interactions.component.menu.StringSelectMenuDefinition
-
Returns a string representation of this record class.
- toString() - Method in record class com.github.kaktushose.jda.commands.definitions.interactions.CustomId
-
Returns a string representation of this record class.
- toString() - Method in record class com.github.kaktushose.jda.commands.definitions.interactions.InteractionDefinition.ReplyConfig
-
Returns a string representation of this record class.
- toString() - Method in record class com.github.kaktushose.jda.commands.definitions.interactions.InteractionRegistry
-
Returns a string representation of this record class.
- toString() - Method in record class com.github.kaktushose.jda.commands.definitions.interactions.MethodBuildContext
-
Returns a string representation of this record class.
- toString() - Method in record class com.github.kaktushose.jda.commands.definitions.interactions.ModalDefinition.TextInputDefinition
-
Returns a string representation of this record class.
- toString() - Method in record class com.github.kaktushose.jda.commands.definitions.interactions.ModalDefinition
-
Returns a string representation of this record class.
- toString() - Method in record class com.github.kaktushose.jda.commands.dispatching.context.InvocationContext
-
Returns a string representation of this record class.
- toString() - Method in record class com.github.kaktushose.jda.commands.dispatching.expiration.ExpirationStrategy.Explicit
-
Returns a string representation of this record class.
- toString() - Method in record class com.github.kaktushose.jda.commands.dispatching.expiration.ExpirationStrategy.Inactivity
-
Returns a string representation of this record class.
- toString() - Method in record class com.github.kaktushose.jda.commands.dispatching.reply.Component
-
Returns a string representation of this record class.
- toString() - Method in class com.github.kaktushose.jda.commands.embeds.EmbedDTO.Author
- toString() - Method in class com.github.kaktushose.jda.commands.embeds.EmbedDTO.Field
- toString() - Method in class com.github.kaktushose.jda.commands.embeds.EmbedDTO.Footer
- toString() - Method in class com.github.kaktushose.jda.commands.embeds.EmbedDTO.Image
- toString() - Method in class com.github.kaktushose.jda.commands.embeds.EmbedDTO.Thumbnail
- toString() - Method in class com.github.kaktushose.jda.commands.embeds.EmbedDTO
- toSubCommandData(String) - Method in record class com.github.kaktushose.jda.commands.definitions.interactions.command.SlashCommandDefinition
-
Transforms this definition into
SubcommandData
. - type() - Element in annotation interface com.github.kaktushose.jda.commands.annotations.interactions.ContextCommand
-
Gets the type of this command.
- type() - Method in record class com.github.kaktushose.jda.commands.definitions.description.ParameterDescription
-
Returns the value of the
type
record component. - type() - Method in record class com.github.kaktushose.jda.commands.definitions.interactions.command.OptionDataDefinition
-
Returns the value of the
type
record component. - TypeAdapter<T> - Interface in com.github.kaktushose.jda.commands.dispatching.adapter
-
Generic top level interface for type adapting.
U
- updateGuildCommands() - Method in class com.github.kaktushose.jda.commands.JDACommands
-
Updates all slash commands that are registered with
CommandScope.GUILD
- User - Annotation Interface in com.github.kaktushose.jda.commands.annotations.constraints
-
The annotated element must be the specified user or member.
- UserAdapter - Class in com.github.kaktushose.jda.commands.dispatching.adapter.impl
-
Type adapter for JDAs
User
. - UserAdapter() - Constructor for class com.github.kaktushose.jda.commands.dispatching.adapter.impl.UserAdapter
V
- validator() - Method in record class com.github.kaktushose.jda.commands.definitions.interactions.command.OptionDataDefinition.ConstraintDefinition
-
Returns the value of the
validator
record component. - validator(Class<? extends Annotation>, Validator) - Method in class com.github.kaktushose.jda.commands.JDACommandsBuilder
- Validator - Interface in com.github.kaktushose.jda.commands.dispatching.validation
-
Generic top level interface for validators.
- validators() - Method in record class com.github.kaktushose.jda.commands.definitions.interactions.InteractionRegistry
-
Returns the value of the
validators
record component. - validators() - Method in record class com.github.kaktushose.jda.commands.definitions.interactions.MethodBuildContext
-
Returns the value of the
validators
record component. - value() - Element in annotation interface com.github.kaktushose.jda.commands.annotations.constraints.Constraint
-
Returns an array of all types this annotation can be used for.
- value() - Element in annotation interface com.github.kaktushose.jda.commands.annotations.constraints.Max
-
Returns the value the element must be less or equal to.
- value() - Element in annotation interface com.github.kaktushose.jda.commands.annotations.constraints.Min
-
Returns the value the element must be greater or equal to.
- value() - Element in annotation interface com.github.kaktushose.jda.commands.annotations.constraints.NotPerm
-
Returns the discord permission(s) the element must not have.
- value() - Element in annotation interface com.github.kaktushose.jda.commands.annotations.constraints.NotRole
-
Returns the guild role the element must not have.
- value() - Element in annotation interface com.github.kaktushose.jda.commands.annotations.constraints.NotUser
-
Returns the user or member the element must not be equals to.
- value() - Element in annotation interface com.github.kaktushose.jda.commands.annotations.constraints.Perm
-
Returns the discord permission(s) the element must have.
- value() - Element in annotation interface com.github.kaktushose.jda.commands.annotations.constraints.Role
-
Returns the guild role the element must have.
- value() - Element in annotation interface com.github.kaktushose.jda.commands.annotations.constraints.User
-
Returns the user or member the element must be equals to.
- value() - Element in annotation interface com.github.kaktushose.jda.commands.annotations.interactions.AutoComplete
-
Returns the name of the slash commands this autocomplete should handle.
- value() - Element in annotation interface com.github.kaktushose.jda.commands.annotations.interactions.Button
-
Gets the label of the button.
- value() - Element in annotation interface com.github.kaktushose.jda.commands.annotations.interactions.Choices
-
Returns the choices of a parameter.
- value() - Element in annotation interface com.github.kaktushose.jda.commands.annotations.interactions.ContextCommand
-
Returns the name of the command.
- value() - Element in annotation interface com.github.kaktushose.jda.commands.annotations.interactions.Cooldown
-
Returns the delay of the cooldown.
- value() - Element in annotation interface com.github.kaktushose.jda.commands.annotations.interactions.EntitySelectMenu
-
Supported
EntitySelectMenu.SelectTarget
s. - value() - Element in annotation interface com.github.kaktushose.jda.commands.annotations.interactions.Interaction
-
Returns the base name for slash commands.
- value() - Element in annotation interface com.github.kaktushose.jda.commands.annotations.interactions.Modal
-
Gets the title of this modal.
- value() - Element in annotation interface com.github.kaktushose.jda.commands.annotations.interactions.Optional
-
Returns the default value.
- value() - Element in annotation interface com.github.kaktushose.jda.commands.annotations.interactions.Param
-
Returns the description of the parameter.
- value() - Element in annotation interface com.github.kaktushose.jda.commands.annotations.interactions.Permissions
-
Returns a String array of all required permissions.
- value() - Element in annotation interface com.github.kaktushose.jda.commands.annotations.interactions.SelectOption
-
Gets the value of an option.
- value() - Element in annotation interface com.github.kaktushose.jda.commands.annotations.interactions.SlashCommand
-
Returns the name of the command.
- value() - Element in annotation interface com.github.kaktushose.jda.commands.annotations.interactions.StringSelectMenu
-
Configure the placeholder which is displayed when no selections have been made yet.
- value() - Element in annotation interface com.github.kaktushose.jda.commands.annotations.interactions.TextInput
-
The placeholder of this TextInput
- value() - Method in record class com.github.kaktushose.jda.commands.definitions.interactions.component.menu.StringSelectMenuDefinition.SelectOptionDefinition
-
Returns the value of the
value
record component. - valueOf(String) - Static method in enum class com.github.kaktushose.jda.commands.annotations.interactions.CommandScope
-
Returns the enum constant of this class with the specified name.
- valueOf(String) - Static method in enum class com.github.kaktushose.jda.commands.dispatching.middleware.Priority
-
Returns the enum constant of this class with the specified name.
- values() - Static method in enum class com.github.kaktushose.jda.commands.annotations.interactions.CommandScope
-
Returns an array containing the constants of this enum class, in the order they are declared.
- values() - Static method in enum class com.github.kaktushose.jda.commands.dispatching.middleware.Priority
-
Returns an array containing the constants of this enum class, in the order they are declared.
- values() - Method in class com.github.kaktushose.jda.commands.embeds.EmbedCache
-
Returns an unmodifiable List containing all
EmbedDTO
of this cache. - VoiceChannelAdapter - Class in com.github.kaktushose.jda.commands.dispatching.adapter.impl
-
Type adapter for JDAs
VoiceChannel
. - VoiceChannelAdapter() - Constructor for class com.github.kaktushose.jda.commands.dispatching.adapter.impl.VoiceChannelAdapter
W
- with() - Method in class com.github.kaktushose.jda.commands.dispatching.events.ReplyableEvent
-
Entry point for configuring a reply.
All Classes and Interfaces|All Packages|Constant Field Values|Serialized Form