Index
All Classes and Interfaces|All Packages|Constant Field Values|Serialized Form
A
- accept(InvocationContext<?>) - Method in class com.github.kaktushose.jda.commands.dispatching.middleware.impl.ConstraintMiddleware
-
Checks if all parameters fulfill their constraints.
- accept(InvocationContext<?>) - Method in class com.github.kaktushose.jda.commands.dispatching.middleware.impl.CooldownMiddleware
-
Checks if an active cooldown for the given
SlashCommandDefinitionexists and will eventually cancel the context. - accept(InvocationContext<?>) - Method in class com.github.kaktushose.jda.commands.dispatching.middleware.impl.PermissionsMiddleware
- accept(InvocationContext<?>) - Method in interface com.github.kaktushose.jda.commands.dispatching.middleware.Middleware
-
Executes this middleware with the given
InvocationContext. - accept(T, Runtime) - Method in class com.github.kaktushose.jda.commands.dispatching.handling.EventHandler
- adapter() - Method in record class com.github.kaktushose.jda.commands.extension.Implementation.TypeAdapterContainer
-
Returns the value of the
adapterrecord component. - adapter(Class<?>, Class<?>, TypeAdapter<?, ?>) - Method in class com.github.kaktushose.jda.commands.JDACBuilder
- adapterRegistry - Variable in class com.github.kaktushose.jda.commands.dispatching.handling.EventHandler
- adapterRegistry() - Method in record class com.github.kaktushose.jda.commands.dispatching.DispatchingContext
-
Returns the value of the
adapterRegistryrecord component. - add(boolean) - Method in interface com.github.kaktushose.jda.commands.embeds.Embed.Fields
-
Adds a blank (empty) Field to the embed.
- add(String, String) - Method in interface com.github.kaktushose.jda.commands.embeds.Embed.Fields
-
Adds a Field to the embed that isn't inlined.
- add(String, String, boolean) - Method in interface com.github.kaktushose.jda.commands.embeds.Embed.Fields
-
Adds a Field to the embed.
- add(MessageEmbed.Field) - Method in interface com.github.kaktushose.jda.commands.embeds.Embed.Fields
-
Copies the provided Field into a new Field for this builder.
- addChild(String[], SlashCommandDefinition) - Method in record class com.github.kaktushose.jda.commands.internal.register.TreeNode
- addComponents(LayoutComponent...) - Method in class com.github.kaktushose.jda.commands.dispatching.reply.internal.ReplyAction
- addEmbeds(MessageEmbed...) - Method in class com.github.kaktushose.jda.commands.dispatching.reply.internal.ReplyAction
- AFTER_15_MINUTES - Static variable in interface com.github.kaktushose.jda.commands.dispatching.expiration.ExpirationStrategy
-
Default
ExpirationStrategyofExpirationStrategy.Inactivity, that closesRuntimesafter 15 minutes of inactivity. - afterMinutes() - Method in record class com.github.kaktushose.jda.commands.dispatching.expiration.ExpirationStrategy.Inactivity
-
Returns the value of the
afterMinutesrecord component. - annotation() - Method in record class com.github.kaktushose.jda.commands.definitions.interactions.command.OptionDataDefinition.ConstraintDefinition
-
Returns the value of the
annotationrecord component. - annotation() - Method in record class com.github.kaktushose.jda.commands.extension.Implementation.ValidatorContainer
-
Returns the value of the
annotationrecord component. - annotation() - Element in annotation interface com.github.kaktushose.jda.commands.guice.Implementation.Validator
-
Gets the annotation the
Validatorshould be mapped to. - annotation(Class<T>) - Method in interface com.github.kaktushose.jda.commands.definitions.description.Description
-
Gets this elements
Annotationfor the specified type if such an annotation is present - AnnotationDescription<T> - Record Class in com.github.kaktushose.jda.commands.definitions.description
-
A
Descriptionthat describes an annotation - AnnotationDescription(T, Collection<AnnotationDescription<?>>) - Constructor for record class com.github.kaktushose.jda.commands.definitions.description.AnnotationDescription
-
Creates an instance of a
AnnotationDescriptionrecord class. - annotations() - Method in record class com.github.kaktushose.jda.commands.definitions.description.AnnotationDescription
-
Returns the value of the
annotationsrecord component. - annotations() - Method in record class com.github.kaktushose.jda.commands.definitions.description.ClassDescription
-
Returns the value of the
annotationsrecord component. - annotations() - Method in interface com.github.kaktushose.jda.commands.definitions.description.Description
-
a possibly-empty
Collectionof allAnnotations this element is annotated with. - annotations() - Method in record class com.github.kaktushose.jda.commands.definitions.description.MethodDescription
-
Returns the value of the
annotationsrecord component. - annotations() - Method in record class com.github.kaktushose.jda.commands.definitions.description.PackageDescription
-
Returns the value of the
annotationsrecord component. - annotations() - Method in record class com.github.kaktushose.jda.commands.definitions.description.ParameterDescription
-
Returns the value of the
annotationsrecord component. - applicationEmojis() - Method in class com.github.kaktushose.jda.commands.JDAContext
- apply(String) - Method in class com.github.kaktushose.jda.commands.message.i18n.internal.JDACLocalizationFunction
- apply(Member, NotPerm, Validator.Context) - Method in class com.github.kaktushose.jda.commands.dispatching.validation.impl.NotPermissionValidator
-
Validates an argument.
- apply(Member, Perm, Validator.Context) - Method in class com.github.kaktushose.jda.commands.dispatching.validation.impl.PermissionValidator
-
Validates an argument.
- 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.
- apply(T, A, Validator.Context) - Method in interface com.github.kaktushose.jda.commands.dispatching.validation.Validator
-
Validates an argument.
- arguments() - Method in record class com.github.kaktushose.jda.commands.dispatching.context.InvocationContext
- author(String) - Method in class com.github.kaktushose.jda.commands.embeds.Embed
-
Sets the Author of the embed.
- author(String, String) - Method in class com.github.kaktushose.jda.commands.embeds.Embed
-
Sets the Author of the embed.
- author(String, String, String) - Method in class com.github.kaktushose.jda.commands.embeds.Embed
-
Sets the Author of the embed.
- autoComplete() - Method in record class com.github.kaktushose.jda.commands.definitions.interactions.command.OptionDataDefinition
-
Returns the value of the
autoCompleterecord component. - AutoComplete - Annotation Interface in com.github.kaktushose.jda.commands.annotations.interactions
-
Methods annotated with AutoComplete will be registered as a handler for
AutoCompleteEvents for the givenCommands. - AutoCompleteDefinition - Record Class in com.github.kaktushose.jda.commands.definitions.interactions
-
Representation of an auto complete handler.
- AutoCompleteDefinition(ClassDescription, MethodDescription, Set<AutoCompleteDefinition.AutoCompleteRule>) - Constructor for record class com.github.kaktushose.jda.commands.definitions.interactions.AutoCompleteDefinition
-
Creates an instance of a
AutoCompleteDefinitionrecord class. - AutoCompleteDefinition.AutoCompleteRule - Record Class in com.github.kaktushose.jda.commands.definitions.interactions
-
Representation of an auto complete rule.
- autoCompleteDefinitions() - Method in record class com.github.kaktushose.jda.commands.definitions.interactions.MethodBuildContext
-
Returns the value of the
autoCompleteDefinitionsrecord 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.
- AutoCompleteHandler - Class in com.github.kaktushose.jda.commands.dispatching.handling
- AutoCompleteHandler(DispatchingContext) - Constructor for class com.github.kaktushose.jda.commands.dispatching.handling.AutoCompleteHandler
- AutoCompleteRule(String, Set<String>) - Constructor for record class com.github.kaktushose.jda.commands.definitions.interactions.AutoCompleteDefinition.AutoCompleteRule
-
Creates an instance of a
AutoCompleteRulerecord class.
B
- baseClass - Variable in class com.github.kaktushose.jda.commands.extension.JDACBuilderData
- baseClass() - Method in class com.github.kaktushose.jda.commands.extension.JDACBuilderData
-
the base class provided by the user for classpath scanning
- BOUND_CUSTOM_ID_REGEX - Static variable in record class com.github.kaktushose.jda.commands.definitions.interactions.CustomId
- build() - Method in class com.github.kaktushose.jda.commands.dispatching.reply.dynamic.ModalBuilder
-
Builds the
Modal. - build() - Method in class com.github.kaktushose.jda.commands.embeds.Embed
-
Returns a
MessageEmbedjust likeEmbedBuilder.build(), but will also localize this embed based on theEmbed.locale(Locale)andplaceholdersprovided. - build(Cooldown) - Static method in record class com.github.kaktushose.jda.commands.definitions.interactions.command.SlashCommandDefinition.CooldownDefinition
-
Builds a new
SlashCommandDefinition.CooldownDefinitionfrom the givenCooldownannotation. - build(MenuOption) - Static method in record class com.github.kaktushose.jda.commands.definitions.interactions.component.menu.StringSelectMenuDefinition.MenuOptionDefinition
-
Constructs a new
StringSelectMenuDefinition.MenuOptionDefinitionfrom the givenMenuOption. - build(ClassDescription, MethodDescription) - Static method in record class com.github.kaktushose.jda.commands.definitions.interactions.AutoCompleteDefinition
-
Builds a new
AutoCompleteDefinitionfrom the given class and method description. - build(ParameterDescription) - Static method in record class com.github.kaktushose.jda.commands.definitions.interactions.ModalDefinition.TextInputDefinition
-
Builds a new
ModalDefinition.TextInputDefinitionfrom the givenParameterDescription - build(ParameterDescription, AutoCompleteDefinition, Validators) - Static method in record class com.github.kaktushose.jda.commands.definitions.interactions.command.OptionDataDefinition
-
Builds a new
OptionDataDefinition. - build(ButtonDefinition) - Method in class com.github.kaktushose.jda.commands.dispatching.reply.dynamic.ButtonComponent
- build(ComponentDefinition<ActionComponent>) - Method in class com.github.kaktushose.jda.commands.dispatching.reply.dynamic.internal.UnspecificComponent
- build(EntitySelectMenuDefinition) - Method in class com.github.kaktushose.jda.commands.dispatching.reply.dynamic.menu.EntitySelectMenuComponent
- build(StringSelectMenuDefinition) - Method in class com.github.kaktushose.jda.commands.dispatching.reply.dynamic.menu.StringSelectComponent
- build(MethodBuildContext) - Static method in record class com.github.kaktushose.jda.commands.definitions.interactions.command.ContextCommandDefinition
-
Builds a new
ContextCommandDefinitionfrom the givenMethodBuildContext. - build(MethodBuildContext) - Static method in record class com.github.kaktushose.jda.commands.definitions.interactions.command.SlashCommandDefinition
-
Builds a new
SlashCommandDefinitionfrom the givenMethodBuildContext. - build(MethodBuildContext) - Static method in record class com.github.kaktushose.jda.commands.definitions.interactions.component.ButtonDefinition
-
Constructs a new
ButtonDefinitionfrom the givenMethodBuildContext. - build(MethodBuildContext) - Static method in record class com.github.kaktushose.jda.commands.definitions.interactions.component.menu.EntitySelectMenuDefinition
-
Builds a new
EntitySelectMenuDefinitionfrom the givenMethodBuildContext. - build(MethodBuildContext) - Static method in record class com.github.kaktushose.jda.commands.definitions.interactions.component.menu.StringSelectMenuDefinition
-
Builds a new
StringSelectMenuDefinitionfrom the givenMethodBuildContext. - build(MethodBuildContext) - Static method in record class com.github.kaktushose.jda.commands.definitions.interactions.ModalDefinition
-
Builds a new
ModalDefinitionfrom the givenMethodBuildContext. - build(D) - Method in class com.github.kaktushose.jda.commands.dispatching.reply.Component
- buildDefault() - Method in class com.github.kaktushose.jda.commands.embeds.internal.Embeds.Configuration
-
Converts this configuration into an
Embedsinstance that should be used globally. - builder(Consumer<MessageCreateBuilder>) - Method in class com.github.kaktushose.jda.commands.dispatching.reply.ConfigurableReply
-
Access the underlying
MessageCreateBuilderfor configuration steps not covered byConfigurableReply. - builder(Consumer<MessageCreateBuilder>) - Method in class com.github.kaktushose.jda.commands.dispatching.reply.internal.ReplyAction
- 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.
- Builder() - Constructor for class com.github.kaktushose.jda.commands.definitions.interactions.command.CommandDefinition.CommandConfig.Builder
-
Constructs a new Builder.
- Builder() - Constructor for class com.github.kaktushose.jda.commands.definitions.interactions.InteractionDefinition.ReplyConfig.Builder
-
Constructs a new Builder.
- buildError() - Method in class com.github.kaktushose.jda.commands.embeds.internal.Embeds.Configuration
-
Converts this configuration into an
Embedsinstance that should only be used byDefaultErrorMessageFactory. - Bundle - Annotation Interface in com.github.kaktushose.jda.commands.annotations.i18n
-
The bundle annotation states which localization bundle is to be used in a certain scope.
- button(Class<?>, String, Entry...) - Static method in class com.github.kaktushose.jda.commands.dispatching.reply.Component
-
Adds a
ButtonComponentto the reply. - button(String, Entry...) - Static method in class com.github.kaktushose.jda.commands.dispatching.reply.Component
-
Adds a
ButtonComponentto the reply. - Button - Annotation Interface in com.github.kaktushose.jda.commands.annotations.interactions
-
Methods annotated with
Buttonwill be registered as a button at startup. - ButtonComponent - Class in com.github.kaktushose.jda.commands.dispatching.reply.dynamic
- ButtonComponent(String, Class<?>, Entry[]) - Constructor for class com.github.kaktushose.jda.commands.dispatching.reply.dynamic.ButtonComponent
- 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
ButtonDefinitionrecord class.
C
- callback() - Method in class com.github.kaktushose.jda.commands.dispatching.reply.Component
- 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.
- cancelled() - Method in record class com.github.kaktushose.jda.commands.dispatching.context.InvocationContext
- channelTypes() - Element in annotation interface com.github.kaktushose.jda.commands.annotations.interactions.EntitySelectMenu
-
The
ChannelTypes 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
channelTypesrecord component. - channelTypes(Set<ChannelType>) - Method in class com.github.kaktushose.jda.commands.dispatching.reply.dynamic.menu.EntitySelectMenuComponent
- channelTypes(ChannelType...) - Method in class com.github.kaktushose.jda.commands.dispatching.reply.dynamic.menu.EntitySelectMenuComponent
- checkDetached(IDetachableEntity, Class<?>) - Static method in class com.github.kaktushose.jda.commands.internal.Helpers
- checkParameterType(MethodDescription, int, Class<?>) - Static method in class com.github.kaktushose.jda.commands.internal.Helpers
-
Checks if the given parameter is present at the
Methodat the given index. - checkSignature(MethodDescription, SequencedCollection<Class<?>>) - Static method in class com.github.kaktushose.jda.commands.internal.Helpers
- checkSignatureUserContext(MethodDescription) - Static method in class com.github.kaktushose.jda.commands.internal.Helpers
- children() - Method in record class com.github.kaktushose.jda.commands.internal.register.TreeNode
-
Returns the value of the
childrenrecord component. - choices() - Method in record class com.github.kaktushose.jda.commands.definitions.interactions.command.OptionDataDefinition
-
Returns the value of the
choicesrecord component. - Choices - Annotation Interface in com.github.kaktushose.jda.commands.annotations.interactions
-
Annotation used to add choices to parameters.
- classDescription() - Method in interface com.github.kaktushose.jda.commands.definitions.features.internal.Invokable
-
The
ClassDescriptionof the declaring class of theInvokable.methodDescription(). - classDescription() - Method in record class com.github.kaktushose.jda.commands.definitions.interactions.AutoCompleteDefinition
-
Returns the value of the
classDescriptionrecord component. - classDescription() - Method in record class com.github.kaktushose.jda.commands.definitions.interactions.command.ContextCommandDefinition
-
Returns the value of the
classDescriptionrecord component. - classDescription() - Method in record class com.github.kaktushose.jda.commands.definitions.interactions.command.SlashCommandDefinition
-
Returns the value of the
classDescriptionrecord component. - classDescription() - Method in record class com.github.kaktushose.jda.commands.definitions.interactions.component.ButtonDefinition
-
Returns the value of the
classDescriptionrecord component. - classDescription() - Method in interface com.github.kaktushose.jda.commands.definitions.interactions.component.ComponentDefinition
-
The
ClassDescriptionof the declaring class of theComponentDefinition.methodDescription() - classDescription() - Method in record class com.github.kaktushose.jda.commands.definitions.interactions.component.menu.EntitySelectMenuDefinition
-
Returns the value of the
classDescriptionrecord component. - classDescription() - Method in record class com.github.kaktushose.jda.commands.definitions.interactions.component.menu.StringSelectMenuDefinition
-
Returns the value of the
classDescriptionrecord component. - classDescription() - Method in record class com.github.kaktushose.jda.commands.definitions.interactions.ModalDefinition
-
Returns the value of the
classDescriptionrecord component. - ClassDescription - Record Class in com.github.kaktushose.jda.commands.definitions.description
-
A
Descriptionthat describes a class. - ClassDescription(Class<?>, String, PackageDescription, Collection<AnnotationDescription<?>>, Collection<MethodDescription>) - Constructor for record class com.github.kaktushose.jda.commands.definitions.description.ClassDescription
-
Creates an instance of a
ClassDescriptionrecord class. - classes() - Method in record class com.github.kaktushose.jda.commands.extension.internal.ExtensionFilter
-
Returns the value of the
classesrecord component. - ClassFinder - Interface in com.github.kaktushose.jda.commands.definitions.description
-
ClassFinders search for classes annotated with a specific annotation - classFinders - Variable in class com.github.kaktushose.jda.commands.extension.JDACBuilderData
- classFinders() - Method in class com.github.kaktushose.jda.commands.extension.JDACBuilderData
- classFinders(ClassFinder...) - Method in class com.github.kaktushose.jda.commands.JDACBuilder
- clazz() - Method in record class com.github.kaktushose.jda.commands.definitions.description.ClassDescription
-
Returns the value of the
clazzrecord component. - clazz() - Method in record class com.github.kaktushose.jda.commands.definitions.interactions.MethodBuildContext
-
Returns the value of the
clazzrecord component. - clear() - Method in class com.github.kaktushose.jda.commands.dispatching.context.KeyValueStore
-
Removes all the value mappings.
- clear() - Method in class com.github.kaktushose.jda.commands.embeds.Embed
-
Resets this builder to default state.
- clear() - Method in interface com.github.kaktushose.jda.commands.embeds.Embed.Fields
-
Clears all fields from the embed.
- close() - Method in class com.github.kaktushose.jda.commands.dispatching.Runtime
- closeRuntime() - Method in class com.github.kaktushose.jda.commands.dispatching.events.Event
-
Closes the underlying
Runtime. - color(int) - Method in class com.github.kaktushose.jda.commands.embeds.Embed
-
Sets the Color of the embed.
- color(Color) - Method in class com.github.kaktushose.jda.commands.embeds.Embed
-
Sets the Color of the embed.
- com.github.kaktushose.jda.commands - package com.github.kaktushose.jda.commands
-
Root package of JDA-Commands.
- 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.i18n - package com.github.kaktushose.jda.commands.annotations.i18n
- 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
Descriptionsthat 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.features.internal - package com.github.kaktushose.jda.commands.definitions.features.internal
- com.github.kaktushose.jda.commands.definitions.interactions - package com.github.kaktushose.jda.commands.definitions.interactions
-
Definitionsthat represent any type interaction. - com.github.kaktushose.jda.commands.definitions.interactions.command - package com.github.kaktushose.jda.commands.definitions.interactions.command
-
Definitionsthat represent a command interaction. - com.github.kaktushose.jda.commands.definitions.interactions.component - package com.github.kaktushose.jda.commands.definitions.interactions.component
-
Definitionsthat represent component interactions. - com.github.kaktushose.jda.commands.definitions.interactions.component.menu - package com.github.kaktushose.jda.commands.definitions.interactions.component.menu
-
Definitionsthat represent select menu interactions. - com.github.kaktushose.jda.commands.dispatching - package com.github.kaktushose.jda.commands.dispatching
-
Top-level package for all parts of the execution chain.
- 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.internal - package com.github.kaktushose.jda.commands.dispatching.adapter.internal
- 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.handling - package com.github.kaktushose.jda.commands.dispatching.handling
- com.github.kaktushose.jda.commands.dispatching.handling.command - package com.github.kaktushose.jda.commands.dispatching.handling.command
- com.github.kaktushose.jda.commands.dispatching.instance - package com.github.kaktushose.jda.commands.dispatching.instance
-
This package contains logic needed to get instances of classes annotated with
Interaction - 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.middleware.impl - package com.github.kaktushose.jda.commands.dispatching.middleware.impl
-
Implementations of commonly used Middlewares, such as permissions or cooldown handling.
- com.github.kaktushose.jda.commands.dispatching.middleware.internal - package com.github.kaktushose.jda.commands.dispatching.middleware.internal
- 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.reply.dynamic - package com.github.kaktushose.jda.commands.dispatching.reply.dynamic
- com.github.kaktushose.jda.commands.dispatching.reply.dynamic.internal - package com.github.kaktushose.jda.commands.dispatching.reply.dynamic.internal
- com.github.kaktushose.jda.commands.dispatching.reply.dynamic.menu - package com.github.kaktushose.jda.commands.dispatching.reply.dynamic.menu
- com.github.kaktushose.jda.commands.dispatching.reply.internal - package com.github.kaktushose.jda.commands.dispatching.reply.internal
- com.github.kaktushose.jda.commands.dispatching.validation - package com.github.kaktushose.jda.commands.dispatching.validation
-
Command parameter validation system.
- com.github.kaktushose.jda.commands.dispatching.validation.impl - package com.github.kaktushose.jda.commands.dispatching.validation.impl
-
Implementations of frequently used validators.
- com.github.kaktushose.jda.commands.dispatching.validation.internal - package com.github.kaktushose.jda.commands.dispatching.validation.internal
- 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.embeds.internal - package com.github.kaktushose.jda.commands.embeds.internal
- com.github.kaktushose.jda.commands.exceptions - package com.github.kaktushose.jda.commands.exceptions
- com.github.kaktushose.jda.commands.exceptions.internal - package com.github.kaktushose.jda.commands.exceptions.internal
- com.github.kaktushose.jda.commands.extension - package com.github.kaktushose.jda.commands.extension
-
This package provides an additional way to configure jda-commands by providing implementations of
Extensiontrough Javas service provider interface. - com.github.kaktushose.jda.commands.extension.internal - package com.github.kaktushose.jda.commands.extension.internal
- com.github.kaktushose.jda.commands.guice - package com.github.kaktushose.jda.commands.guice
- com.github.kaktushose.jda.commands.guice.internal - package com.github.kaktushose.jda.commands.guice.internal
- com.github.kaktushose.jda.commands.internal - package com.github.kaktushose.jda.commands.internal
- com.github.kaktushose.jda.commands.internal.register - package com.github.kaktushose.jda.commands.internal.register
- com.github.kaktushose.jda.commands.message - package com.github.kaktushose.jda.commands.message
- com.github.kaktushose.jda.commands.message.emoji - package com.github.kaktushose.jda.commands.message.emoji
- com.github.kaktushose.jda.commands.message.i18n - package com.github.kaktushose.jda.commands.message.i18n
- com.github.kaktushose.jda.commands.message.i18n.internal - package com.github.kaktushose.jda.commands.message.i18n.internal
- com.github.kaktushose.jda.commands.message.placeholder - package com.github.kaktushose.jda.commands.message.placeholder
- 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.
- command() - Method in record class com.github.kaktushose.jda.commands.definitions.interactions.AutoCompleteDefinition.AutoCompleteRule
-
Returns the value of the
commandrecord component. - command() - Method in record class com.github.kaktushose.jda.commands.internal.register.TreeNode
-
Returns the value of the
commandrecord component. - Command - Annotation Interface in com.github.kaktushose.jda.commands.annotations.interactions
-
Methods annotated with Command will be registered as a slash command at startup.
- commandConfig() - Method in interface com.github.kaktushose.jda.commands.definitions.interactions.command.CommandDefinition
- commandConfig() - Method in record class com.github.kaktushose.jda.commands.definitions.interactions.command.ContextCommandDefinition
-
Returns the value of the
commandConfigrecord component. - commandConfig() - Method in record class com.github.kaktushose.jda.commands.definitions.interactions.command.SlashCommandDefinition
-
Returns the value of the
commandConfigrecord component. - commandConfig(MethodBuildContext) - Static method in class com.github.kaktushose.jda.commands.internal.Helpers
-
The
CommandDefinition.CommandConfigthat should be used when registering commands. - CommandConfig - Annotation Interface in com.github.kaktushose.jda.commands.annotations.interactions
-
Used to configure the registration of commands.
- CommandConfig() - Constructor for record class com.github.kaktushose.jda.commands.definitions.interactions.command.CommandDefinition.CommandConfig
-
Constructs a new CommandConfig using the following default values:
- CommandConfig(CommandConfig) - Constructor for record class com.github.kaktushose.jda.commands.definitions.interactions.command.CommandDefinition.CommandConfig
-
Constructs a new CommandConfig.
- CommandConfig(InteractionContextType[], IntegrationType[], CommandScope, boolean, Permission[]) - Constructor for record class com.github.kaktushose.jda.commands.definitions.interactions.command.CommandDefinition.CommandConfig
-
Compact constructor ensuring that
CommandDefinition.CommandConfig.contextandCommandDefinition.CommandConfig.integrationis always set. - CommandDefinition - Interface in com.github.kaktushose.jda.commands.definitions.interactions.command
-
Common interface for command interaction definitions.
- CommandDefinition.CommandConfig - Record Class in com.github.kaktushose.jda.commands.definitions.interactions.command
-
Stores the configuration values for registering commands.
- CommandDefinition.CommandConfig.Builder - Class in com.github.kaktushose.jda.commands.definitions.interactions.command
-
Builder for
CommandDefinition.CommandConfig. - 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, Embeds) - 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
commandOptionsrecord component. - CommandScope - Enum Class in com.github.kaktushose.jda.commands.annotations.interactions
-
Enum describing the two possible scopes a command can be registered for.
- CommandTree - Record Class in com.github.kaktushose.jda.commands.internal.register
-
A tree data structure representing slash commands sorted into Subcommands and SubcommandGroups.
- CommandTree(TreeNode) - Constructor for record class com.github.kaktushose.jda.commands.internal.register.CommandTree
-
Creates an instance of a
CommandTreerecord class. - CommandTree(Collection<SlashCommandDefinition>) - Constructor for record class com.github.kaktushose.jda.commands.internal.register.CommandTree
-
Constructs a new CommandTree from the given
SlashCommandDefinitions. - commandType() - Method in interface com.github.kaktushose.jda.commands.definitions.interactions.command.CommandDefinition
-
The
Command.Typeof this command. - commandType() - Method in record class com.github.kaktushose.jda.commands.definitions.interactions.command.ContextCommandDefinition
-
Returns the value of the
commandTyperecord component. - commandType() - Method in record class com.github.kaktushose.jda.commands.definitions.interactions.command.SlashCommandDefinition
- Component<S,
T, - Class in com.github.kaktushose.jda.commands.dispatching.replyB, D> -
Represents a component, namely
Button,StringSelectMenuorEntitySelectMenu, that should be added to a reply. - Component(String, Class<?>, Entry[]) - Constructor for class com.github.kaktushose.jda.commands.dispatching.reply.Component
- 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, Embeds) - Constructor for class com.github.kaktushose.jda.commands.dispatching.events.interactions.ComponentEvent
-
Constructs a new CommandEvent.
- ComponentHandler - Class in com.github.kaktushose.jda.commands.dispatching.handling
- ComponentHandler(DispatchingContext) - Constructor for class com.github.kaktushose.jda.commands.dispatching.handling.ComponentHandler
- components() - Method in class com.github.kaktushose.jda.commands.dispatching.reply.internal.ReplyAction
- 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
ActionRowto the reply and adds the passed components to it. - ConfigurableReply - Class in com.github.kaktushose.jda.commands.dispatching.reply
-
Builder for sending messages based on a
GenericInteractionCreateEventthat supports adding components to messages and changing theInteractionDefinition.ReplyConfig. - ConfigurableReply(ConfigurableReply) - Constructor for class com.github.kaktushose.jda.commands.dispatching.reply.ConfigurableReply
-
Constructs a new ConfigurableReply.
- ConfigurableReply(GenericInteractionCreateEvent, InteractionDefinition, MessageResolver, ReplyAction, Embeds, InteractionRegistry, String) - Constructor for class com.github.kaktushose.jda.commands.dispatching.reply.ConfigurableReply
-
Constructs a new ConfigurableReply.
- Configuration(MessageResolver) - Constructor for class com.github.kaktushose.jda.commands.embeds.internal.Embeds.Configuration
-
Constructs a new embed configuration builder.
- ConfigurationException - Exception Class in com.github.kaktushose.jda.commands.exceptions
-
Will be thrown if anything goes wrong while configuring jda-commands.
- ConfigurationException(String) - Constructor for exception class com.github.kaktushose.jda.commands.exceptions.ConfigurationException
- ConfigurationException(String, Entry...) - Constructor for exception class com.github.kaktushose.jda.commands.exceptions.ConfigurationException
- ConfigurationException(String, Throwable) - Constructor for exception class com.github.kaktushose.jda.commands.exceptions.ConfigurationException
- ConfigurationException(String, Throwable, Entry...) - Constructor for exception class com.github.kaktushose.jda.commands.exceptions.ConfigurationException
- configure() - Method in class com.github.kaktushose.jda.commands.guice.internal.GuiceExtensionModule
- configure() - Method in class com.github.kaktushose.jda.commands.guice.internal.InteractionControllerInstantiatorModule
- Constraint - Annotation Interface in com.github.kaktushose.jda.commands.annotations.constraints
-
Indicates that an annotation type can be used for parameter validation.
- ConstraintDefinition(Validator<?, ?>, AnnotationDescription<?>) - Constructor for record class com.github.kaktushose.jda.commands.definitions.interactions.command.OptionDataDefinition.ConstraintDefinition
-
Creates an instance of a
ConstraintDefinitionrecord class. - ConstraintMiddleware - Class in com.github.kaktushose.jda.commands.dispatching.middleware.impl
-
A
Middlewareimplementation that will check the parameter constraints aSlashCommandDefinitionmight have. - ConstraintMiddleware(ErrorMessageFactory) - Constructor for class com.github.kaktushose.jda.commands.dispatching.middleware.impl.ConstraintMiddleware
- constraints() - Method in record class com.github.kaktushose.jda.commands.definitions.interactions.command.OptionDataDefinition
-
Returns the value of the
constraintsrecord component. - contains(String) - Method in class com.github.kaktushose.jda.commands.dispatching.context.KeyValueStore
-
Whether this StateSection has a value mapped to the key.
- context - Variable in class com.github.kaktushose.jda.commands.extension.JDACBuilderData
- context() - Element in annotation interface com.github.kaktushose.jda.commands.annotations.interactions.CommandConfig
-
The
InteractionContextTypes to use. - context() - Method in record class com.github.kaktushose.jda.commands.definitions.interactions.command.CommandDefinition.CommandConfig
-
Returns the value of the
contextrecord component. - context() - Method in class com.github.kaktushose.jda.commands.extension.JDACBuilderData
-
the
JDAContextto be used - context(Collection<InteractionContextType>) - Method in class com.github.kaktushose.jda.commands.definitions.interactions.command.CommandDefinition.CommandConfig.Builder
-
The
InteractionContextTypes to use. - context(InteractionContextType...) - Method in class com.github.kaktushose.jda.commands.definitions.interactions.command.CommandDefinition.CommandConfig.Builder
-
The
InteractionContextTypes to use. - Context(InvocationContext<?>, ErrorMessageFactory) - Constructor for class com.github.kaktushose.jda.commands.dispatching.validation.Validator.Context
- Context(Runtime) - Constructor for class com.github.kaktushose.jda.commands.dispatching.instance.InteractionControllerInstantiator.Context
- CONTEXT - Static variable in exception class com.github.kaktushose.jda.commands.exceptions.InvalidDeclarationException
- 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, CommandDefinition.CommandConfig, LocalizationFunction) - Constructor for record class com.github.kaktushose.jda.commands.definitions.interactions.command.ContextCommandDefinition
-
Creates an instance of a
ContextCommandDefinitionrecord class. - ContextCommandHandler - Class in com.github.kaktushose.jda.commands.dispatching.handling.command
- ContextCommandHandler(DispatchingContext) - Constructor for class com.github.kaktushose.jda.commands.dispatching.handling.command.ContextCommandHandler
- controllerInstantiator - Variable in class com.github.kaktushose.jda.commands.extension.JDACBuilderData
- controllerInstantiator() - Method in class com.github.kaktushose.jda.commands.extension.JDACBuilderData
- cooldown() - Method in record class com.github.kaktushose.jda.commands.definitions.interactions.command.SlashCommandDefinition
-
Returns the value of the
cooldownrecord 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
cooldownDefinitionrecord component. - CooldownDefinition(long, TimeUnit) - Constructor for record class com.github.kaktushose.jda.commands.definitions.interactions.command.SlashCommandDefinition.CooldownDefinition
-
Creates an instance of a
CooldownDefinitionrecord class. - CooldownMiddleware - Class in com.github.kaktushose.jda.commands.dispatching.middleware.impl
-
A
Middlewareimplementation that contains the business logic behind command cooldowns. - CooldownMiddleware(ErrorMessageFactory) - Constructor for class com.github.kaktushose.jda.commands.dispatching.middleware.impl.CooldownMiddleware
- createDefinitionId(String, String) - Static method in interface com.github.kaktushose.jda.commands.definitions.interactions.InteractionDefinition
-
Creates a definition id from the classname and method name
- 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
CustomIdrecord class. - CustomIdJDAEntity<T> - Interface in com.github.kaktushose.jda.commands.definitions.features
-
Indicates that the implementing
Definitioncan be transformed into a JDA entity that has aCustomId.
D
- dataObject(DataObject) - Static method in interface com.github.kaktushose.jda.commands.embeds.EmbedDataSource
-
Constructs a new
EmbedDataSourceusing aDataObjectas its source. - dataType() - Method in interface com.github.kaktushose.jda.commands.extension.Extension
- dataType() - Method in class com.github.kaktushose.jda.commands.guice.GuiceExtension
- declaredType() - Method in record class com.github.kaktushose.jda.commands.definitions.interactions.command.OptionDataDefinition
-
Returns the value of the
declaredTyperecord component. - declaringClass() - Method in record class com.github.kaktushose.jda.commands.definitions.description.MethodDescription
-
Returns the value of the
declaringClassrecord component. - DEFAULT_BUNDLE - Variable in class com.github.kaktushose.jda.commands.message.i18n.I18n
- 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.
- DefaultErrorMessageFactory - Record Class in com.github.kaktushose.jda.commands.embeds.error
-
The default implementation of
ErrorMessageFactory. - DefaultErrorMessageFactory(Embeds) - Constructor for record class com.github.kaktushose.jda.commands.embeds.error.DefaultErrorMessageFactory
-
Creates an instance of a
DefaultErrorMessageFactoryrecord class. - DefaultGuildScopeProvider - Class in com.github.kaktushose.jda.commands.scope
-
Default implementation of
GuildScopeProvider. - DefaultGuildScopeProvider() - Constructor for class com.github.kaktushose.jda.commands.scope.DefaultGuildScopeProvider
- defaultOptions(Collection<? extends SelectOption>) - Method in class com.github.kaktushose.jda.commands.dispatching.reply.dynamic.menu.StringSelectComponent
- defaultOptions(SelectOption...) - Method in class com.github.kaktushose.jda.commands.dispatching.reply.dynamic.menu.StringSelectComponent
- DefaultPermissionsProvider - Class in com.github.kaktushose.jda.commands.permissions
-
Default implementation of
PermissionsProviderwith 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.ModalDefinition.TextInputDefinition
-
Returns the value of the
defaultValuerecord component. - defaultValues() - Method in record class com.github.kaktushose.jda.commands.definitions.interactions.component.menu.EntitySelectMenuDefinition
-
Returns the value of the
defaultValuesrecord component. - defaultValues(String...) - Method in class com.github.kaktushose.jda.commands.dispatching.reply.dynamic.menu.StringSelectComponent
- defaultValues(Collection<String>) - Method in class com.github.kaktushose.jda.commands.dispatching.reply.dynamic.menu.StringSelectComponent
- defaultValues(Collection<EntitySelectMenu.DefaultValue>) - Method in class com.github.kaktushose.jda.commands.dispatching.reply.dynamic.menu.EntitySelectMenuComponent
- defaultValues(EntitySelectMenu.DefaultValue...) - Method in class com.github.kaktushose.jda.commands.dispatching.reply.dynamic.menu.EntitySelectMenuComponent
- deferEdit() - Method in class com.github.kaktushose.jda.commands.dispatching.events.interactions.ComponentEvent
-
No-op acknowledgement of this interaction.
- deferEdit() - Method in class com.github.kaktushose.jda.commands.dispatching.events.interactions.ModalEvent
-
No-op acknowledgement of this interaction.
- deferReply() - Method in class com.github.kaktushose.jda.commands.dispatching.events.ReplyableEvent
-
Acknowledge this interaction and defer the reply to a later time.
- deferReply(boolean) - Method in class com.github.kaktushose.jda.commands.dispatching.events.interactions.CommandEvent
- deferReply(boolean) - Method in class com.github.kaktushose.jda.commands.dispatching.events.interactions.ComponentEvent
- deferReply(boolean) - Method in class com.github.kaktushose.jda.commands.dispatching.events.interactions.ModalEvent
- deferReply(boolean) - Method in class com.github.kaktushose.jda.commands.dispatching.events.ReplyableEvent
-
Acknowledge this interaction and defer the reply to a later time.
- definition - Variable in class com.github.kaktushose.jda.commands.dispatching.events.ReplyableEvent
- definition() - Method in record class com.github.kaktushose.jda.commands.dispatching.context.InvocationContext
-
Returns the value of the
definitionrecord component. - definition() - Method in interface com.github.kaktushose.jda.commands.embeds.error.ErrorMessageFactory.ErrorContext
-
The
InteractionDefinitionthat 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.
- definitionClass() - Method in class com.github.kaktushose.jda.commands.dispatching.reply.Component
- definitionClass() - Method in class com.github.kaktushose.jda.commands.dispatching.reply.dynamic.ButtonComponent
- definitionClass() - Method in class com.github.kaktushose.jda.commands.dispatching.reply.dynamic.internal.UnspecificComponent
- definitionClass() - Method in class com.github.kaktushose.jda.commands.dispatching.reply.dynamic.menu.EntitySelectMenuComponent
- definitionClass() - Method in class com.github.kaktushose.jda.commands.dispatching.reply.dynamic.menu.StringSelectComponent
- 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
definitionIdrecord 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
definitionsrecord component. - delay() - Method in record class com.github.kaktushose.jda.commands.definitions.interactions.command.SlashCommandDefinition.CooldownDefinition
-
Returns the value of the
delayrecord component. - desc() - Element in annotation interface com.github.kaktushose.jda.commands.annotations.interactions.Command
-
Returns the description of the command.
- describe(Class<?>) - Method in interface com.github.kaktushose.jda.commands.definitions.description.Descriptor
-
Transforms the given
Classinto aClassDescription. - describe(Class<?>) - Method in class com.github.kaktushose.jda.commands.definitions.description.reflective.ReflectiveDescriptor
- description() - Element in annotation interface com.github.kaktushose.jda.commands.annotations.interactions.MenuOption
-
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
descriptionrecord component. - description() - Method in record class com.github.kaktushose.jda.commands.definitions.interactions.command.SlashCommandDefinition
-
Returns the value of the
descriptionrecord component. - description() - Method in record class com.github.kaktushose.jda.commands.definitions.interactions.component.menu.StringSelectMenuDefinition.MenuOptionDefinition
-
Returns the value of the
descriptionrecord component. - description(CharSequence) - Method in class com.github.kaktushose.jda.commands.embeds.Embed
-
Sets the Description of the embed.
- Description - Interface in com.github.kaktushose.jda.commands.definitions.description
-
The common interface of all
Descriptiontypes. - descriptor - Variable in class com.github.kaktushose.jda.commands.extension.JDACBuilderData
- descriptor() - Method in record class com.github.kaktushose.jda.commands.definitions.interactions.InteractionRegistry
-
Returns the value of the
descriptorrecord component. - descriptor() - Method in class com.github.kaktushose.jda.commands.extension.JDACBuilderData
- descriptor(Descriptor) - Method in class com.github.kaktushose.jda.commands.JDACBuilder
- Descriptor - Interface in com.github.kaktushose.jda.commands.definitions.description
- disabled(Class<?>, String, Entry...) - Static method in class com.github.kaktushose.jda.commands.dispatching.reply.Component
-
Adds a disabled
Componentto the reply that is defined in a different class. - disabled(String, Entry...) - Static method in class com.github.kaktushose.jda.commands.dispatching.reply.Component
-
Adds disabled, runtime-bound
Components to the reply. - dispatchingContext - Variable in class com.github.kaktushose.jda.commands.dispatching.handling.EventHandler
- DispatchingContext - Record Class in com.github.kaktushose.jda.commands.dispatching
-
A collection of classes relevant for
EventHandlers. - DispatchingContext(Middlewares, ErrorMessageFactory, InteractionRegistry, TypeAdapters, ExpirationStrategy, InteractionControllerInstantiator, InteractionDefinition.ReplyConfig, Embeds, I18n, MessageResolver) - Constructor for record class com.github.kaktushose.jda.commands.dispatching.DispatchingContext
-
Creates an instance of a
DispatchingContextrecord class. - 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.MenuOptionDefinition
- 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
E
- 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
editReplyrecord component. - editReply(boolean) - Method in class com.github.kaktushose.jda.commands.definitions.interactions.InteractionDefinition.ReplyConfig.Builder
-
Whether to edit the original message or to send a new one.
- editReply(boolean) - Method in class com.github.kaktushose.jda.commands.dispatching.reply.ConfigurableReply
-
Whether to keep the original components when editing a message.
- editReply(boolean) - Method in class com.github.kaktushose.jda.commands.dispatching.reply.internal.ReplyAction
- embed(String) - Method in class com.github.kaktushose.jda.commands.dispatching.events.ReplyableEvent
-
Gets an
Embedbased on the given name. - embed(String) - Method in class com.github.kaktushose.jda.commands.JDACommands
-
Gets an
Embedbased on the given name. - Embed - Class in com.github.kaktushose.jda.commands.embeds
-
Builder for
MessageEmbedthat supports placeholders, localization and easier manipulation ofMessageEmbed.Fields. - Embed.Fields - Interface in com.github.kaktushose.jda.commands.embeds
-
Methods for manipulating the fields of an
Embed. - EmbedConfig - Interface in com.github.kaktushose.jda.commands.embeds
-
Builder for configuring the Embed API of JDA-Commands.
- EmbedDataSource - Interface in com.github.kaktushose.jda.commands.embeds
-
An
EmbedDataSourceis used to retrieveEmbeds based on a unique name from various sources. - embeds - Variable in class com.github.kaktushose.jda.commands.extension.JDACBuilderData
- embeds() - Method in record class com.github.kaktushose.jda.commands.dispatching.DispatchingContext
-
Returns the value of the
embedsrecord component. - embeds() - Method in record class com.github.kaktushose.jda.commands.embeds.error.DefaultErrorMessageFactory
-
Returns the value of the
embedsrecord component. - embeds(Embed...) - Method in class com.github.kaktushose.jda.commands.dispatching.reply.ConfigurableReply
-
Acknowledgement of this event with one or more
Embeds. - embeds(MessageResolver) - Method in class com.github.kaktushose.jda.commands.extension.JDACBuilderData
- embeds(String...) - Method in class com.github.kaktushose.jda.commands.dispatching.reply.ConfigurableReply
-
Acknowledgement of this event with one or more
Embeds. - embeds(String, Entry, Entry...) - Method in class com.github.kaktushose.jda.commands.dispatching.reply.ConfigurableReply
-
Acknowledgement of this event with an
Embed. - embeds(String, Consumer<Embed>) - Method in class com.github.kaktushose.jda.commands.dispatching.reply.ConfigurableReply
-
Acknowledgement of this event with an
Embed. - embeds(Consumer<EmbedConfig>) - Method in class com.github.kaktushose.jda.commands.JDACBuilder
-
Configuration step for the Embed API of JDA-Commands.
- Embeds - Record Class in com.github.kaktushose.jda.commands.embeds.internal
-
Container for immutably holding the embed configuration made by
EmbedConfig. - Embeds(Collection<EmbedDataSource>, Map<String, Object>, MessageResolver) - Constructor for record class com.github.kaktushose.jda.commands.embeds.internal.Embeds
-
Creates an instance of a
Embedsrecord class. - Embeds.Configuration - Class in com.github.kaktushose.jda.commands.embeds.internal
- emoji() - Element in annotation interface com.github.kaktushose.jda.commands.annotations.interactions.Button
-
Gets the
Emojiof the button. - emoji() - Element in annotation interface com.github.kaktushose.jda.commands.annotations.interactions.MenuOption
-
Gets the
Emojiof an option. - emoji() - Method in record class com.github.kaktushose.jda.commands.definitions.interactions.component.ButtonDefinition
-
Returns the value of the
emojirecord component. - emoji() - Method in record class com.github.kaktushose.jda.commands.definitions.interactions.component.menu.StringSelectMenuDefinition.MenuOptionDefinition
-
Returns the value of the
emojirecord component. - emoji(Emoji) - Method in class com.github.kaktushose.jda.commands.dispatching.reply.dynamic.ButtonComponent
- emojiResolver() - Method in class com.github.kaktushose.jda.commands.message.MessageResolver
-
Gets the underlying
EmojiResolverinstance - EmojiResolver - Class in com.github.kaktushose.jda.commands.message.emoji
-
The
EmojiResolverreplaces emoji aliases in strings with their formatted value. - EmojiResolver(Collection<ApplicationEmoji>) - Constructor for class com.github.kaktushose.jda.commands.message.emoji.EmojiResolver
-
Constructs a new instance of
EmojiResolverwith the given application emojis and all Unicode emojis supported by discord. - EmojiSource - Interface in com.github.kaktushose.jda.commands.message.emoji
-
Emojis loaded from an implementation of
EmojiSourceare automatically registered upon startup. - emojiSources - Variable in class com.github.kaktushose.jda.commands.extension.JDACBuilderData
- emojiSources() - Method in class com.github.kaktushose.jda.commands.extension.JDACBuilderData
- emojiSources(EmojiSource...) - Method in class com.github.kaktushose.jda.commands.JDACBuilder
-
Application emojis loaded from
EmojiSources will be registered upon startup with help ofJDA.createApplicationEmoji(String, Icon). - enabled() - Method in class com.github.kaktushose.jda.commands.dispatching.reply.Component
- enabled(boolean) - Method in class com.github.kaktushose.jda.commands.dispatching.reply.Component
- enabled(Class<?>, String, Entry...) - Static method in class com.github.kaktushose.jda.commands.dispatching.reply.Component
-
Adds an enabled
Componentto the reply that is defined in a different class. - enabled(String, Entry...) - Static method in class com.github.kaktushose.jda.commands.dispatching.reply.Component
-
Adds an enabled, runtime-bound
Componentto the reply. - enabledFor() - Element in annotation interface com.github.kaktushose.jda.commands.annotations.interactions.CommandConfig
-
Returns an array of
Permissionthis command should be enabled for by default. - enabledPermissions() - Method in record class com.github.kaktushose.jda.commands.definitions.interactions.command.CommandDefinition.CommandConfig
-
Returns the value of the
enabledPermissionsrecord component. - enabledPermissions(Collection<Permission>) - Method in class com.github.kaktushose.jda.commands.definitions.interactions.command.CommandDefinition.CommandConfig.Builder
- enabledPermissions(Permission...) - Method in class com.github.kaktushose.jda.commands.definitions.interactions.command.CommandDefinition.CommandConfig.Builder
- entitySelect(Class<?>, String, Entry...) - Static method in class com.github.kaktushose.jda.commands.dispatching.reply.Component
-
Adds an
EntitySelectMenuComponentto the reply. - entitySelect(String, Entry...) - Static method in class com.github.kaktushose.jda.commands.dispatching.reply.Component
-
Adds an
EntitySelectMenuComponentto the reply. - EntitySelectMenu - Annotation Interface in com.github.kaktushose.jda.commands.annotations.interactions
-
Methods annotated with EntitySelectMenu will be registered as a EntitySelectMenu at startup.
- EntitySelectMenuComponent - Class in com.github.kaktushose.jda.commands.dispatching.reply.dynamic.menu
-
An implementation of
Componentspecific toEntitySelectMenu - EntitySelectMenuComponent(String, Class<?>, Entry[]) - Constructor for class com.github.kaktushose.jda.commands.dispatching.reply.dynamic.menu.EntitySelectMenuComponent
- 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
EntitySelectMenuDefinitionrecord class. - entityTypes(Set<EntitySelectMenu.SelectTarget>) - Method in class com.github.kaktushose.jda.commands.dispatching.reply.dynamic.menu.EntitySelectMenuComponent
- entityTypes(EntitySelectMenu.SelectTarget...) - Method in class com.github.kaktushose.jda.commands.dispatching.reply.dynamic.menu.EntitySelectMenuComponent
- entry(String, Object) - Static method in record class com.github.kaktushose.jda.commands.message.placeholder.Entry
-
This method returns an
Entrycontaining the name and value provided. - Entry - Record Class in com.github.kaktushose.jda.commands.message.placeholder
-
A placeholder identified by its name with the value to be substituted.
- Entry(String, Object) - Constructor for record class com.github.kaktushose.jda.commands.message.placeholder.Entry
-
Creates an instance of a
Entryrecord class. - 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
ephemeralrecord component. - ephemeral(boolean) - Method in class com.github.kaktushose.jda.commands.definitions.interactions.InteractionDefinition.ReplyConfig.Builder
-
Whether to send ephemeral replies.
- ephemeral(boolean) - Method in class com.github.kaktushose.jda.commands.dispatching.reply.ConfigurableReply
-
Whether to send ephemeral replies.
- ephemeral(boolean) - Method in class com.github.kaktushose.jda.commands.dispatching.reply.internal.ReplyAction
- equals(Object) - Method in record class com.github.kaktushose.jda.commands.definitions.description.AnnotationDescription
-
Indicates whether some other object is "equal to" this one.
- 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.PackageDescription
-
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.AutoCompleteRule
-
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.CommandDefinition.CommandConfig
-
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.MenuOptionDefinition
-
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.DispatchingContext
-
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.embeds.error.DefaultErrorMessageFactory
-
Indicates whether some other object is "equal to" this one.
- equals(Object) - Method in record class com.github.kaktushose.jda.commands.embeds.internal.Embeds
-
Indicates whether some other object is "equal to" this one.
- equals(Object) - Method in record class com.github.kaktushose.jda.commands.extension.Implementation
-
Indicates whether some other object is "equal to" this one.
- equals(Object) - Method in record class com.github.kaktushose.jda.commands.extension.Implementation.MiddlewareContainer
-
Indicates whether some other object is "equal to" this one.
- equals(Object) - Method in record class com.github.kaktushose.jda.commands.extension.Implementation.TypeAdapterContainer
-
Indicates whether some other object is "equal to" this one.
- equals(Object) - Method in record class com.github.kaktushose.jda.commands.extension.Implementation.ValidatorContainer
-
Indicates whether some other object is "equal to" this one.
- equals(Object) - Method in record class com.github.kaktushose.jda.commands.extension.internal.ExtensionFilter
-
Indicates whether some other object is "equal to" this one.
- equals(Object) - Method in record class com.github.kaktushose.jda.commands.guice.GuiceExtensionData
-
Indicates whether some other object is "equal to" this one.
- equals(Object) - Method in record class com.github.kaktushose.jda.commands.internal.register.CommandTree
-
Indicates whether some other object is "equal to" this one.
- equals(Object) - Method in record class com.github.kaktushose.jda.commands.internal.register.TreeNode
-
Indicates whether some other object is "equal to" this one.
- equals(Object) - Method in record class com.github.kaktushose.jda.commands.message.placeholder.Entry
-
Indicates whether some other object is "equal to" this one.
- errorContext(GenericInteractionCreateEvent, InteractionDefinition) - Static method in class com.github.kaktushose.jda.commands.internal.Helpers
- errorMessage(String) - Static method in exception class com.github.kaktushose.jda.commands.exceptions.internal.JDACException
-
Retrieves an error message from the error bundle.
- errorMessage(String, Entry...) - Static method in exception class com.github.kaktushose.jda.commands.exceptions.internal.JDACException
-
Retrieves an error message from the error bundle and inserts the placeholders.
- errorMessageFactory - Variable in class com.github.kaktushose.jda.commands.dispatching.handling.EventHandler
- errorMessageFactory - Variable in class com.github.kaktushose.jda.commands.extension.JDACBuilderData
- errorMessageFactory() - Method in record class com.github.kaktushose.jda.commands.dispatching.DispatchingContext
-
Returns the value of the
errorMessageFactoryrecord component. - errorMessageFactory() - Method in class com.github.kaktushose.jda.commands.extension.JDACBuilderData
- errorMessageFactory(ErrorMessageFactory) - Method in class com.github.kaktushose.jda.commands.JDACBuilder
- ErrorMessageFactory - Interface in com.github.kaktushose.jda.commands.embeds.error
-
Generic interface for factory classes that provide
MessageCreateDatathat should be sent for common errors that happen during an interaction execution, such as missing permissions or failing constraints. - ErrorMessageFactory.ErrorContext - Interface in com.github.kaktushose.jda.commands.embeds.error
-
Holds the respective
GenericInteractionCreateEventandInteractionDefinitionof an error. - errorMessages - Static variable in exception class com.github.kaktushose.jda.commands.exceptions.internal.JDACException
- errorSource(EmbedDataSource) - Method in interface com.github.kaktushose.jda.commands.embeds.EmbedConfig
-
Adds a new
EmbedDataSourcethat will be used by theDefaultErrorMessageFactoryto load the error messages from. - errorSource(EmbedDataSource) - Method in class com.github.kaktushose.jda.commands.embeds.internal.Embeds.Configuration
- event - Variable in class com.github.kaktushose.jda.commands.dispatching.events.Event
- event() - Method in record class com.github.kaktushose.jda.commands.dispatching.context.InvocationContext
-
Returns the value of the
eventrecord component. - event() - Method in interface com.github.kaktushose.jda.commands.embeds.error.ErrorMessageFactory.ErrorContext
-
The
GenericInteractionCreateEventin 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.
- EventHandler<T> - Class in com.github.kaktushose.jda.commands.dispatching.handling
-
Implementations of this class are handling specific
GenericInteractionCreateEvents. - EventHandler(DispatchingContext) - Constructor for class com.github.kaktushose.jda.commands.dispatching.handling.EventHandler
- EXCLUDE - Enum constant in enum class com.github.kaktushose.jda.commands.JDACBuilder.FilterStrategy
-
excludes the defined classes
- exists(String) - Method in record class com.github.kaktushose.jda.commands.embeds.internal.Embeds
-
Checks whether an
Embedwith the given name exists in one of theEmbeds.sources(). - expirationStrategy - Variable in class com.github.kaktushose.jda.commands.extension.JDACBuilderData
- expirationStrategy() - Method in record class com.github.kaktushose.jda.commands.dispatching.DispatchingContext
-
Returns the value of the
expirationStrategyrecord component. - expirationStrategy() - Method in class com.github.kaktushose.jda.commands.extension.JDACBuilderData
- expirationStrategy(ExpirationStrategy) - Method in class com.github.kaktushose.jda.commands.JDACBuilder
- ExpirationStrategy - Interface in com.github.kaktushose.jda.commands.dispatching.expiration
-
Classes implementing
ExpirationStrategydefine a strategy when aRuntimeshould 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
-
ExpirationStrategythat closes aRuntimeafter 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
ClassFinderthat 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
Explicitrecord class. - EXPLICIT - Static variable in interface com.github.kaktushose.jda.commands.dispatching.expiration.ExpirationStrategy
-
Default
ExpirationStrategyofExpirationStrategy.Explicit. - Extension<T> - Interface in com.github.kaktushose.jda.commands.extension
-
Implementations of this interface, that are registered by Javas service provider interface, will be called in
JDACBuilderto configure the framework. - Extension.Data - Interface in com.github.kaktushose.jda.commands.extension
-
Implementations of this interface are providing additional configuration to implementations of
Extension. - extensionData - Variable in class com.github.kaktushose.jda.commands.extension.JDACBuilderData
- extensionData(Extension.Data...) - Method in class com.github.kaktushose.jda.commands.JDACBuilder
-
Registers
Extension.Datathat will be passed to the respectiveExtensions to configure them properly. - extensionFilter - Variable in class com.github.kaktushose.jda.commands.extension.JDACBuilderData
- ExtensionFilter - Record Class in com.github.kaktushose.jda.commands.extension.internal
- ExtensionFilter(JDACBuilder.FilterStrategy, Collection<String>) - Constructor for record class com.github.kaktushose.jda.commands.extension.internal.ExtensionFilter
-
Creates an instance of a
ExtensionFilterrecord class.
F
- fail(String, Entry...) - Method in class com.github.kaktushose.jda.commands.dispatching.validation.Validator.Context
-
Used to fail a validation and cancel the
InvocationContext - failMessage(String, Entry...) - Method in class com.github.kaktushose.jda.commands.dispatching.validation.Validator.Context
-
This method returns a formatted, optionally resolved (and localized), error message based on
ErrorMessageFactory.getConstraintFailedMessage(ErrorMessageFactory.ErrorContext, String). - fields() - Method in class com.github.kaktushose.jda.commands.embeds.Embed
-
Used to modify the fields of this embed.
- file(Path) - Static method in interface com.github.kaktushose.jda.commands.embeds.EmbedDataSource
-
Constructs a new
EmbedDataSourceusing aPathpointing to a JSON file as its source. - filterExtensions(JDACBuilder.FilterStrategy, String...) - Method in class com.github.kaktushose.jda.commands.JDACBuilder
-
Specifies a way to filter found implementations of
Extensionif you have clashing or cycling dependencies for example. - filterStrategy() - Method in record class com.github.kaktushose.jda.commands.extension.internal.ExtensionFilter
-
Returns the value of the
filterStrategyrecord component. - 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
- findEmbed(String) - Method in class com.github.kaktushose.jda.commands.dispatching.events.ReplyableEvent
- findEmbed(String) - Method in class com.github.kaktushose.jda.commands.JDACommands
- FluavaLocalizer - Class in com.github.kaktushose.jda.commands.message.i18n
-
The default variant of
Localizerwhich implements it with help of the amazing java implementation of project fluent. - FluavaLocalizer(Fluava) - Constructor for class com.github.kaktushose.jda.commands.message.i18n.FluavaLocalizer
- footer(String) - Method in class com.github.kaktushose.jda.commands.embeds.Embed
-
Sets the Footer of the embed.
- footer(String, String) - Method in class com.github.kaktushose.jda.commands.embeds.Embed
-
Sets the Footer of the embed.
- forAllOrdered(Consumer<Middleware>) - Method in class com.github.kaktushose.jda.commands.dispatching.middleware.internal.Middlewares
-
Executed the given task for all registered
Middlewares ordered by theirPriority - forOrdered(Class<?>, Consumer<Middleware>) - Method in class com.github.kaktushose.jda.commands.dispatching.middleware.internal.Middlewares
-
Executed the given task registered
Middlewares that should run for this interaction controller ordered by theirPriority. - forRuntime(String, JDA) - Method in interface com.github.kaktushose.jda.commands.dispatching.instance.InteractionControllerInstantiator
-
Called each time a new
Runtimeis created. - forRuntime(String, JDA) - Method in class com.github.kaktushose.jda.commands.guice.internal.GuiceInteractionControllerInstantiator
-
Creates a new child injector with its own
InteractionControllerInstantiatorModulefor each runtime. - fromIcon(String, Icon) - Static method in interface com.github.kaktushose.jda.commands.message.emoji.EmojiSource
-
Loads an emoji from a given
Iconinstance, allowing interop with JDAs system - fromMerged(String) - Static method in record class com.github.kaktushose.jda.commands.definitions.interactions.CustomId
-
Constructs a new
CustomIdfrom the given String. - fromUrl(String, URL) - Static method in interface com.github.kaktushose.jda.commands.message.emoji.EmojiSource
-
Loads an emoji from a given URL.
G
- get() - Method in interface com.github.kaktushose.jda.commands.message.emoji.EmojiSource
-
This method is called during startup to load the to be registered application emojis.
- get(AnnotationDescription<A>, Class<T>) - Method in class com.github.kaktushose.jda.commands.dispatching.validation.internal.Validators
-
Gets a
Validatorbased on the annotation and the type to validate. - get(String) - Method in record class com.github.kaktushose.jda.commands.embeds.internal.Embeds
-
Gets an
Embedbased on the given name. - get(String, Class<? extends T>) - Method in class com.github.kaktushose.jda.commands.dispatching.context.KeyValueStore
-
Gets a value.
- get(String, Locale) - Method in record class com.github.kaktushose.jda.commands.embeds.internal.Embeds
- get(String, Map<String, Object>, MessageResolver) - Method in interface com.github.kaktushose.jda.commands.embeds.EmbedDataSource
-
Retrieves an
Embedbased on the given name. - getButton(Class<?>, String) - Method in class com.github.kaktushose.jda.commands.dispatching.events.ReplyableEvent
- getButton(Class<?>, String) - Method in class com.github.kaktushose.jda.commands.JDACommands
- getButton(String) - Method in class com.github.kaktushose.jda.commands.dispatching.events.ReplyableEvent
- getChannel() - Method in class com.github.kaktushose.jda.commands.dispatching.events.Event
- getChannelIdLong() - Method in class com.github.kaktushose.jda.commands.dispatching.events.Event
- getChild(String) - Method in record class com.github.kaktushose.jda.commands.internal.register.TreeNode
-
Gets a child
TreeNodebased on its name. - getCommandExecutionFailedMessage(ErrorMessageFactory.ErrorContext, Throwable) - Method in record class com.github.kaktushose.jda.commands.embeds.error.DefaultErrorMessageFactory
-
Gets a
MessageCreateDatato send when the command execution failed. - getCommandExecutionFailedMessage(ErrorMessageFactory.ErrorContext, Throwable) - Method in interface com.github.kaktushose.jda.commands.embeds.error.ErrorMessageFactory
-
Gets a
MessageCreateDatato send when the command execution failed. - getConstraintFailedMessage(ErrorMessageFactory.ErrorContext, String) - Method in record class com.github.kaktushose.jda.commands.embeds.error.DefaultErrorMessageFactory
-
Gets a
MessageCreateDatato send when a parameter constraint fails. - getConstraintFailedMessage(ErrorMessageFactory.ErrorContext, String) - Method in interface com.github.kaktushose.jda.commands.embeds.error.ErrorMessageFactory
-
Gets a
MessageCreateDatato send when a parameter constraint fails. - getContext() - Method in class com.github.kaktushose.jda.commands.dispatching.events.Event
- getCooldownMessage(ErrorMessageFactory.ErrorContext, long) - Method in record class com.github.kaktushose.jda.commands.embeds.error.DefaultErrorMessageFactory
-
Gets a
Messageto send when a command still has a cooldown. - getCooldownMessage(ErrorMessageFactory.ErrorContext, long) - Method in interface com.github.kaktushose.jda.commands.embeds.error.ErrorMessageFactory
-
Gets a
Messageto send when a command still has a cooldown. - getEntitlements() - Method in class com.github.kaktushose.jda.commands.dispatching.events.Event
- getGuild() - Method in class com.github.kaktushose.jda.commands.dispatching.events.Event
- getGuildCache() - Method in class com.github.kaktushose.jda.commands.JDAContext
-
SnowflakeCacheViewof all cachedGuilds. - getIdLong() - Method in class com.github.kaktushose.jda.commands.dispatching.events.Event
- getInsufficientPermissionsMessage(ErrorMessageFactory.ErrorContext) - Method in record class com.github.kaktushose.jda.commands.embeds.error.DefaultErrorMessageFactory
-
Gets a
MessageCreateDatato send when a user is missing permissions. - getInsufficientPermissionsMessage(ErrorMessageFactory.ErrorContext) - Method in interface com.github.kaktushose.jda.commands.embeds.error.ErrorMessageFactory
-
Gets a
MessageCreateDatato send when a user is missing permissions. - getIntegrationOwners() - Method in class com.github.kaktushose.jda.commands.dispatching.events.Event
- getJDA() - Method in class com.github.kaktushose.jda.commands.dispatching.events.Event
- getMember() - Method in class com.github.kaktushose.jda.commands.dispatching.events.Event
- getMessage() - Method in exception class com.github.kaktushose.jda.commands.exceptions.ConfigurationException
- getMessage() - Method in exception class com.github.kaktushose.jda.commands.exceptions.InternalException
- getMessage() - Method in exception class com.github.kaktushose.jda.commands.exceptions.InvalidDeclarationException
- 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. - getOptionType() - Method in class com.github.kaktushose.jda.commands.dispatching.events.interactions.AutoCompleteEvent
-
The expected option type for this query.
- getSelectMenu(Class<?>, String) - Method in class com.github.kaktushose.jda.commands.dispatching.events.ReplyableEvent
-
Gets a
StringSelectMenuorEntitySelectMenubased on the method name and transforms it into a JDASelectMenu. - getSelectMenu(Class<?>, String) - Method in class com.github.kaktushose.jda.commands.JDACommands
-
Gets a
StringSelectMenuorEntitySelectMenubased on the method name and the given class and transforms it into a JDASelectMenu. - getSelectMenu(String) - Method in class com.github.kaktushose.jda.commands.dispatching.events.ReplyableEvent
-
Gets a
StringSelectMenuorEntitySelectMenubased on the method name and transforms it into a JDASelectMenu. - getSlashCommandData(LocalizationFunction) - Method in record class com.github.kaktushose.jda.commands.internal.register.CommandTree
-
Transforms this CommandTree to
SlashCommandDatabased on the tree structure. - getTimedOutComponentMessage(GenericInteractionCreateEvent) - Method in record class com.github.kaktushose.jda.commands.embeds.error.DefaultErrorMessageFactory
-
Gets a
MessageCreateDatato send when an incoming component interaction already timed out. - getTimedOutComponentMessage(GenericInteractionCreateEvent) - Method in interface com.github.kaktushose.jda.commands.embeds.error.ErrorMessageFactory
-
Gets a
MessageCreateDatato send when an incoming component interaction already timed out. - getToken() - Method in class com.github.kaktushose.jda.commands.dispatching.events.Event
- getTypeAdaptingFailedMessage(ErrorMessageFactory.ErrorContext, ConversionResult.Failure<?>) - Method in record class com.github.kaktushose.jda.commands.embeds.error.DefaultErrorMessageFactory
-
Gets a
MessageCreateDatato send when type adapting of the user input failed. - getTypeAdaptingFailedMessage(ErrorMessageFactory.ErrorContext, ConversionResult.Failure<?>) - Method in interface com.github.kaktushose.jda.commands.embeds.error.ErrorMessageFactory
-
Gets a
MessageCreateDatato send when type adapting of the user input failed. - getTypeRaw() - Method in class com.github.kaktushose.jda.commands.dispatching.events.Event
- 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.
- GLOBAL - Enum constant in enum class com.github.kaktushose.jda.commands.annotations.interactions.CommandScope
- globalCommandConfig - Variable in class com.github.kaktushose.jda.commands.extension.JDACBuilderData
- globalCommandConfig() - Method in record class com.github.kaktushose.jda.commands.definitions.interactions.MethodBuildContext
-
Returns the value of the
globalCommandConfigrecord component. - globalCommandConfig() - Method in class com.github.kaktushose.jda.commands.extension.JDACBuilderData
- globalCommandConfig(CommandDefinition.CommandConfig) - Method in class com.github.kaktushose.jda.commands.JDACBuilder
- globalReplyConfig - Variable in class com.github.kaktushose.jda.commands.extension.JDACBuilderData
- globalReplyConfig() - Method in record class com.github.kaktushose.jda.commands.dispatching.DispatchingContext
-
Returns the value of the
globalReplyConfigrecord component. - globalReplyConfig() - Method in class com.github.kaktushose.jda.commands.extension.JDACBuilderData
- globalReplyConfig(InteractionDefinition.ReplyConfig) - Method in class com.github.kaktushose.jda.commands.JDACBuilder
- GuiceExtension - Class in com.github.kaktushose.jda.commands.guice
- GuiceExtension() - Constructor for class com.github.kaktushose.jda.commands.guice.GuiceExtension
- GuiceExtensionData - Record Class in com.github.kaktushose.jda.commands.guice
-
Custom
Extension.Datato be used to configure this extension. - GuiceExtensionData(Injector) - Constructor for record class com.github.kaktushose.jda.commands.guice.GuiceExtensionData
-
Creates an instance of a
GuiceExtensionDatarecord class. - GuiceExtensionModule - Class in com.github.kaktushose.jda.commands.guice.internal
- GuiceExtensionModule() - Constructor for class com.github.kaktushose.jda.commands.guice.internal.GuiceExtensionModule
- GuiceInteractionControllerInstantiator - Class in com.github.kaktushose.jda.commands.guice.internal
- GuiceInteractionControllerInstantiator(I18n, Injector) - Constructor for class com.github.kaktushose.jda.commands.guice.internal.GuiceInteractionControllerInstantiator
- GUILD - Enum constant in enum class com.github.kaktushose.jda.commands.annotations.interactions.CommandScope
- guildScopeProvider - Variable in class com.github.kaktushose.jda.commands.extension.JDACBuilderData
- guildScopeProvider() - Method in class com.github.kaktushose.jda.commands.extension.JDACBuilderData
- guildScopeProvider(GuildScopeProvider) - Method in class com.github.kaktushose.jda.commands.JDACBuilder
- 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.AnnotationDescription
-
Returns a hash code value for this object.
- 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.PackageDescription
-
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.AutoCompleteRule
-
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.CommandDefinition.CommandConfig
-
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.MenuOptionDefinition
-
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.DispatchingContext
-
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.embeds.error.DefaultErrorMessageFactory
-
Returns a hash code value for this object.
- hashCode() - Method in record class com.github.kaktushose.jda.commands.embeds.internal.Embeds
-
Returns a hash code value for this object.
- hashCode() - Method in record class com.github.kaktushose.jda.commands.extension.Implementation
-
Returns a hash code value for this object.
- hashCode() - Method in record class com.github.kaktushose.jda.commands.extension.Implementation.MiddlewareContainer
-
Returns a hash code value for this object.
- hashCode() - Method in record class com.github.kaktushose.jda.commands.extension.Implementation.TypeAdapterContainer
-
Returns a hash code value for this object.
- hashCode() - Method in record class com.github.kaktushose.jda.commands.extension.Implementation.ValidatorContainer
-
Returns a hash code value for this object.
- hashCode() - Method in record class com.github.kaktushose.jda.commands.extension.internal.ExtensionFilter
-
Returns a hash code value for this object.
- hashCode() - Method in record class com.github.kaktushose.jda.commands.guice.GuiceExtensionData
-
Returns a hash code value for this object.
- hashCode() - Method in record class com.github.kaktushose.jda.commands.internal.register.CommandTree
-
Returns a hash code value for this object.
- hashCode() - Method in record class com.github.kaktushose.jda.commands.internal.register.TreeNode
-
Returns a hash code value for this object.
- hashCode() - Method in record class com.github.kaktushose.jda.commands.message.placeholder.Entry
-
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
Memberhas 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
Userhas permissions. - Helpers - Class in com.github.kaktushose.jda.commands.internal
-
Collection of helper methods that are used inside the framework.
- Helpers() - Constructor for class com.github.kaktushose.jda.commands.internal.Helpers
- 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.
- humanReadableType(OptionMapping) - Static method in class com.github.kaktushose.jda.commands.internal.Helpers
-
Gets the human-readable representation of an
OptionMapping.
I
- i18n() - Method in record class com.github.kaktushose.jda.commands.dispatching.context.InvocationContext
-
Returns the value of the
i18nrecord component. - i18n() - Method in record class com.github.kaktushose.jda.commands.dispatching.DispatchingContext
-
Returns the value of the
i18nrecord component. - i18n() - Method in class com.github.kaktushose.jda.commands.dispatching.events.Event
-
Gets the
I18ninstance. - i18n() - Method in class com.github.kaktushose.jda.commands.dispatching.Runtime
- i18n() - Method in class com.github.kaktushose.jda.commands.extension.JDACBuilderData
- i18n() - Method in class com.github.kaktushose.jda.commands.guice.internal.InteractionControllerInstantiatorModule
- i18n() - Method in class com.github.kaktushose.jda.commands.JDACommands
-
Exposes the localization functionality of JDA-Commands to be used elsewhere in the application
- i18n() - Method in class com.github.kaktushose.jda.commands.message.MessageResolver
-
Gets the underlying
I18ninstance - I18n - Class in com.github.kaktushose.jda.commands.message.i18n
-
This class serves as an interface for application localization.
- I18n(Descriptor, Localizer) - Constructor for class com.github.kaktushose.jda.commands.message.i18n.I18n
- id() - Method in class com.github.kaktushose.jda.commands.dispatching.Runtime
- image(String) - Method in class com.github.kaktushose.jda.commands.embeds.Embed
-
Sets the Image of the embed.
- Implementation<T> - Record Class in com.github.kaktushose.jda.commands.extension
-
Instances of
Implementationare used to provide custom implementations ofImplementation.ExtensionProvidableinterfaces, namely: - Implementation - Annotation Interface in com.github.kaktushose.jda.commands.guice
-
Indicates that the annotated class is a custom implementation that should replace the default implementation.
- Implementation(Class<T>, Function<JDACBuilderData, SequencedCollection<T>>) - Constructor for record class com.github.kaktushose.jda.commands.extension.Implementation
-
Creates an instance of a
Implementationrecord class. - Implementation.ExtensionProvidable - Interface in com.github.kaktushose.jda.commands.extension
-
A marker interface that all types providable by an
Extensionshare. - Implementation.Middleware - Annotation Interface in com.github.kaktushose.jda.commands.guice
-
A class annotated with
Implementation.Middlewarewill be automatically searched for and instantiated as aMiddlewareby guice. - Implementation.MiddlewareContainer - Record Class in com.github.kaktushose.jda.commands.extension
-
A container type for providing
Middlewares. - Implementation.ProvidableContainer - Interface in com.github.kaktushose.jda.commands.extension
- Implementation.TypeAdapter - Annotation Interface in com.github.kaktushose.jda.commands.guice
-
A class annotated with
Implementation.TypeAdapterwill be automatically searched for and instantiated as aTypeAdapterby guice. - Implementation.TypeAdapterContainer<S,
T> - Record Class in com.github.kaktushose.jda.commands.extension -
A container type for providing
TypeAdapters. - Implementation.Validator - Annotation Interface in com.github.kaktushose.jda.commands.guice
-
A class annotated with
Implementation.Validatorwill be automatically searched for and instantiated as aValidatorby guice. - Implementation.ValidatorContainer - Record Class in com.github.kaktushose.jda.commands.extension
-
A container type for providing
Validators. - Inactivity(long) - Constructor for record class com.github.kaktushose.jda.commands.dispatching.expiration.ExpirationStrategy.Inactivity
-
Creates an instance of a
Inactivityrecord class. - INCLUDE - Enum constant in enum class com.github.kaktushose.jda.commands.JDACBuilder.FilterStrategy
-
includes the defined classes
- independent() - Method in class com.github.kaktushose.jda.commands.dispatching.reply.Component
- independent(boolean) - Method in class com.github.kaktushose.jda.commands.dispatching.reply.Component
- independent(String) - Static method in record class com.github.kaktushose.jda.commands.definitions.interactions.CustomId
-
Constructs a new runtime-independent
CustomIdfrom the given definition id. - independent(String, Entry...) - Static method in class com.github.kaktushose.jda.commands.dispatching.reply.Component
-
Adds an enabled, runtime-independent
Componentto the reply. - INDEPENDENT_CUSTOM_ID_REGEX - Static variable in record class com.github.kaktushose.jda.commands.definitions.interactions.CustomId
- index(Iterable<Class<?>>, CommandDefinition.CommandConfig) - Method in record class com.github.kaktushose.jda.commands.definitions.interactions.InteractionRegistry
-
Scans all given classes and registers the interactions defined in them.
- init(T) - Method in interface com.github.kaktushose.jda.commands.extension.Extension
-
Initialises the
Extensionwith the providedExtension.Data. - init(GuiceExtensionData) - Method in class com.github.kaktushose.jda.commands.guice.GuiceExtension
- inputStream(InputStream) - Static method in interface com.github.kaktushose.jda.commands.embeds.EmbedDataSource
-
Constructs a new
EmbedDataSourceusing an JSONInputStreamas its source. - instance(Class<T>, InteractionControllerInstantiator.Context) - Method in interface com.github.kaktushose.jda.commands.dispatching.instance.InteractionControllerInstantiator
-
This method will be called each time an instance of a class annotated with
Interactionis needed. - instance(Class<T>, InteractionControllerInstantiator.Context) - Method in class com.github.kaktushose.jda.commands.guice.internal.GuiceInteractionControllerInstantiator
- instanceProvider() - Method in record class com.github.kaktushose.jda.commands.dispatching.DispatchingContext
-
Returns the value of the
instanceProviderrecord component. - instanceProvider(InteractionControllerInstantiator) - Method in class com.github.kaktushose.jda.commands.JDACBuilder
- integration() - Element in annotation interface com.github.kaktushose.jda.commands.annotations.interactions.CommandConfig
-
The
IntegrationTypes to use. - integration() - Method in record class com.github.kaktushose.jda.commands.definitions.interactions.command.CommandDefinition.CommandConfig
-
Returns the value of the
integrationrecord component. - integration(Collection<IntegrationType>) - Method in class com.github.kaktushose.jda.commands.definitions.interactions.command.CommandDefinition.CommandConfig.Builder
-
The
IntegrationTypes to use. - integration(IntegrationType...) - Method in class com.github.kaktushose.jda.commands.definitions.interactions.command.CommandDefinition.CommandConfig.Builder
-
The
IntegrationTypes to use. - interaction() - Method in record class com.github.kaktushose.jda.commands.definitions.interactions.MethodBuildContext
-
Returns the value of the
interactionrecord component. - Interaction - Annotation Interface in com.github.kaktushose.jda.commands.annotations.interactions
-
Classes annotated with
Interactionare responsible for defining and handling interactions. - InteractionControllerInstantiator - Interface in com.github.kaktushose.jda.commands.dispatching.instance
-
An
InteractionControllerInstantiatoris used get instances of classes annotated withInteraction, if needed creating those. - InteractionControllerInstantiator.Context - Class in com.github.kaktushose.jda.commands.dispatching.instance
- InteractionControllerInstantiatorModule - Class in com.github.kaktushose.jda.commands.guice.internal
- InteractionControllerInstantiatorModule(I18n, JDA) - Constructor for class com.github.kaktushose.jda.commands.guice.internal.InteractionControllerInstantiatorModule
- 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.
- InteractionDefinition.ReplyConfig.Builder - Class in com.github.kaktushose.jda.commands.definitions.interactions
-
Builder for
InteractionDefinition.ReplyConfig. - interactionInstance(Class<I>) - Method in class com.github.kaktushose.jda.commands.dispatching.events.Event
-
Returns an instance of a class annotated with
Interaction, that is bound to the underlyingRuntime. - interactionInstance(Class<T>) - Method in class com.github.kaktushose.jda.commands.dispatching.Runtime
- InteractionRegistry - Record Class in com.github.kaktushose.jda.commands.definitions.interactions
-
Central registry for all
InteractionDefinitions. - InteractionRegistry(Validators, LocalizationFunction, Descriptor) - Constructor for record class com.github.kaktushose.jda.commands.definitions.interactions.InteractionRegistry
-
Constructs a new
InteractionRegistry - InteractionRegistry(Validators, LocalizationFunction, Descriptor, Set<Definition>) - Constructor for record class com.github.kaktushose.jda.commands.definitions.interactions.InteractionRegistry
-
Creates an instance of a
InteractionRegistryrecord class. - InternalException - Exception Class in com.github.kaktushose.jda.commands.exceptions
-
Will be thrown if anything goes wrong internally.
- InternalException(String) - Constructor for exception class com.github.kaktushose.jda.commands.exceptions.InternalException
- InternalException(String, Entry...) - Constructor for exception class com.github.kaktushose.jda.commands.exceptions.InternalException
- InternalException(String, Throwable) - Constructor for exception class com.github.kaktushose.jda.commands.exceptions.InternalException
- InvalidDeclarationException - Exception Class in com.github.kaktushose.jda.commands.exceptions
-
Will be thrown if any errors are made in the declaration of interactions.
- InvalidDeclarationException(String) - Constructor for exception class com.github.kaktushose.jda.commands.exceptions.InvalidDeclarationException
- InvalidDeclarationException(String, Entry...) - Constructor for exception class com.github.kaktushose.jda.commands.exceptions.InvalidDeclarationException
- INVOCATION_PERMITTED - Static variable in class com.github.kaktushose.jda.commands.dispatching.handling.EventHandler
- invocationContext() - Method in class com.github.kaktushose.jda.commands.dispatching.validation.Validator.Context
- 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, I18n, MessageResolver, KeyValueStore, InteractionDefinition, InteractionDefinition.ReplyConfig, SequencedCollection<Object>) - Constructor for record class com.github.kaktushose.jda.commands.dispatching.context.InvocationContext
-
Creates an instance of a
InvocationContextrecord class. - Invokable - Interface in com.github.kaktushose.jda.commands.definitions.features.internal
-
Indicates that the implementing
Definitionis bound to a method that can be invoked. - invoke(Object, InvocationContext<?>) - Method in interface com.github.kaktushose.jda.commands.definitions.features.internal.Invokable
-
Invokes the method that this
Definitionis bound to. - 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
invokerrecord component. - Invoker - Interface in com.github.kaktushose.jda.commands.definitions.description
-
A functional interface, that allows the invocation of a
MethodDescription. - io.github.kaktushose.jda.commands.core - module io.github.kaktushose.jda.commands.core
-
The base module of jda-commands.
- io.github.kaktushose.jda.commands.extension.guice - module io.github.kaktushose.jda.commands.extension.guice
-
An extension to JDA-Commands providing Google's Guice as a dependency injection framework.
- isAcknowledged() - Method in class com.github.kaktushose.jda.commands.dispatching.events.Event
- isBound() - Method in record class com.github.kaktushose.jda.commands.definitions.interactions.CustomId
-
Checks if the passed custom id is runtime-bound.
- isClosed() - Method in class com.github.kaktushose.jda.commands.dispatching.Runtime
- isDefault() - Element in annotation interface com.github.kaktushose.jda.commands.annotations.interactions.MenuOption
-
Gets whether this option is a default option.
- isDefault() - Method in record class com.github.kaktushose.jda.commands.definitions.interactions.component.menu.StringSelectMenuDefinition.MenuOptionDefinition
-
Returns the value of the
isDefaultrecord component. - isIndependent() - Method in record class com.github.kaktushose.jda.commands.definitions.interactions.CustomId
-
Checks if the passed custom id is runtime-independent.
- 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.CommandConfig
-
Whether the configured command(s) can only be executed in NSFW channels.
- isNSFW() - Method in record class com.github.kaktushose.jda.commands.definitions.interactions.command.CommandDefinition.CommandConfig
-
Returns the value of the
isNSFWrecord component. - iterator() - Method in record class com.github.kaktushose.jda.commands.internal.register.TreeNode
J
- jda() - Method in class com.github.kaktushose.jda.commands.guice.internal.InteractionControllerInstantiatorModule
- JDACBuilder - Class in com.github.kaktushose.jda.commands
-
This builder is used to build instances of
JDACommands. - JDACBuilder.FilterStrategy - Enum Class in com.github.kaktushose.jda.commands
-
The two available filter strategies
- JDACBuilderData - Class in com.github.kaktushose.jda.commands.extension
-
Readonly view of a
JDACBuilder. - JDACBuilderData(Class<?>, String[], JDAContext) - Constructor for class com.github.kaktushose.jda.commands.extension.JDACBuilderData
- JDACException - Exception Class in com.github.kaktushose.jda.commands.exceptions.internal
-
Base exception for all exceptions thrown by JDA-Commands.
- JDACException(String) - Constructor for exception class com.github.kaktushose.jda.commands.exceptions.internal.JDACException
-
Creates a new JDACException and loads the error message from the given key.
- JDACException(String, Entry...) - Constructor for exception class com.github.kaktushose.jda.commands.exceptions.internal.JDACException
-
Creates a new JDACException, loads the error message from the given key and inserts the placeholders.
- JDACException(String, Throwable) - Constructor for exception class com.github.kaktushose.jda.commands.exceptions.internal.JDACException
-
Creates a new JDACException and loads the error message from the given key and cause.
- JDACException(String, Throwable, Entry...) - Constructor for exception class com.github.kaktushose.jda.commands.exceptions.internal.JDACException
-
Creates a new JDACException with the given cause, loads the error message from the given key and inserts the placeholders.
- JDACLocalizationFunction - Class in com.github.kaktushose.jda.commands.message.i18n.internal
- JDACLocalizationFunction(I18n) - Constructor for class com.github.kaktushose.jda.commands.message.i18n.internal.JDACLocalizationFunction
- JDACommands - Class in com.github.kaktushose.jda.commands
-
The main entry point of the JDA-Commands framework.
- JDAContext - Class in com.github.kaktushose.jda.commands
-
Wrapper class for
JDAandShardManager. - JDAEntity<T> - Interface in com.github.kaktushose.jda.commands.definitions.features
-
Indicates that the implementing
Definitioncan be transformed into a JDA entity. - jdaEvent() - Method in class com.github.kaktushose.jda.commands.dispatching.events.Event
-
Returns the underlying
GenericInteractionCreateEventof this event - jdaEvent(Class<T>) - Method in class com.github.kaktushose.jda.commands.dispatching.events.interactions.CommandEvent
-
Returns the underlying
GenericCommandInteractionEventand casts it to the given type. - jdaEvent(Class<T>) - Method in class com.github.kaktushose.jda.commands.dispatching.events.interactions.ComponentEvent
-
Returns the underlying
GenericComponentInteractionCreateEventand casts it to the given type. - JDAEventListener - Class in com.github.kaktushose.jda.commands.dispatching
-
Handles incoming
GenericInteractionCreateEvents and maps them to their correspondingRuntime, creating new ones if needed. - JDAEventListener(DispatchingContext) - Constructor for class com.github.kaktushose.jda.commands.dispatching.JDAEventListener
- json(String) - Static method in interface com.github.kaktushose.jda.commands.embeds.EmbedDataSource
-
Constructs a new
EmbedDataSourceusing a JSON payload as its source.
K
- 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
keepComponentsrecord component. - keepComponents(boolean) - Method in class com.github.kaktushose.jda.commands.definitions.interactions.InteractionDefinition.ReplyConfig.Builder
-
Whether to keep the original components when editing a message.
- 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.
- keepComponents(boolean) - Method in class com.github.kaktushose.jda.commands.dispatching.reply.internal.ReplyAction
- keepSelections() - Element in annotation interface com.github.kaktushose.jda.commands.annotations.interactions.ReplyConfig
-
Whether to keep the selections of a string select menu when sending edits.
- keepSelections() - Method in record class com.github.kaktushose.jda.commands.definitions.interactions.InteractionDefinition.ReplyConfig
-
Returns the value of the
keepSelectionsrecord component. - keepSelections(boolean) - Method in class com.github.kaktushose.jda.commands.definitions.interactions.InteractionDefinition.ReplyConfig.Builder
-
Whether to keep the selections of a string select menu when sending edits.
- keepSelections(boolean) - Method in class com.github.kaktushose.jda.commands.dispatching.reply.ConfigurableReply
-
Whether to keep the selections of a string select menu when sending edits.
- keepSelections(boolean) - Method in class com.github.kaktushose.jda.commands.dispatching.reply.internal.ReplyAction
- keyValueStore() - Method in record class com.github.kaktushose.jda.commands.dispatching.context.InvocationContext
-
Returns the value of the
keyValueStorerecord component. - keyValueStore() - Method in class com.github.kaktushose.jda.commands.dispatching.Runtime
- 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
KeyValueStoreof thisRuntime.
L
- label() - Element in annotation interface com.github.kaktushose.jda.commands.annotations.interactions.MenuOption
-
Gets the label of an option.
- label() - Method in record class com.github.kaktushose.jda.commands.definitions.interactions.component.ButtonDefinition
-
Returns the value of the
labelrecord component. - label() - Method in record class com.github.kaktushose.jda.commands.definitions.interactions.component.menu.StringSelectMenuDefinition.MenuOptionDefinition
-
Returns the value of the
labelrecord component. - label() - Method in record class com.github.kaktushose.jda.commands.definitions.interactions.ModalDefinition.TextInputDefinition
-
Returns the value of the
labelrecord component. - label(String) - Method in class com.github.kaktushose.jda.commands.dispatching.reply.dynamic.ButtonComponent
- 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
linkrecord component. - loadedExtensions - Variable in class com.github.kaktushose.jda.commands.extension.JDACBuilderData
- locale(Locale) - Method in class com.github.kaktushose.jda.commands.embeds.Embed
- localizationFunction() - Method in interface com.github.kaktushose.jda.commands.definitions.interactions.command.CommandDefinition
-
The
LocalizationFunctionto use for this command. - localizationFunction() - Method in record class com.github.kaktushose.jda.commands.definitions.interactions.command.ContextCommandDefinition
-
Returns the value of the
localizationFunctionrecord component. - localizationFunction() - Method in record class com.github.kaktushose.jda.commands.definitions.interactions.command.SlashCommandDefinition
-
Returns the value of the
localizationFunctionrecord component. - localizationFunction() - Method in record class com.github.kaktushose.jda.commands.definitions.interactions.InteractionRegistry
-
Returns the value of the
localizationFunctionrecord component. - localizationFunction() - Method in record class com.github.kaktushose.jda.commands.definitions.interactions.MethodBuildContext
-
Returns the value of the
localizationFunctionrecord component. - localizationFunction() - Method in class com.github.kaktushose.jda.commands.message.i18n.I18n
- localize(String, Entry...) - Method in class com.github.kaktushose.jda.commands.dispatching.events.Event
-
Gets a localization message for the given key using the underlying
I18ninstance. - localize(Locale, String, Entry...) - Method in class com.github.kaktushose.jda.commands.message.i18n.I18n
-
This method returns the localized message found by the provided
Localeand key in the given bundle. - localize(Locale, String, String, Map<String, Object>) - Method in interface com.github.kaktushose.jda.commands.message.i18n.Localizer
-
This method localizes a given key for a specific bundle and locale.
- localize(Locale, String, String, Map<String, Object>) - Method in class com.github.kaktushose.jda.commands.message.i18n.FluavaLocalizer
-
This method localizes a given key for a specific bundle and locale.
- localize(Locale, String, Map<String, Object>) - Method in class com.github.kaktushose.jda.commands.message.i18n.I18n
-
This method returns the localized method found by the provided
Localeand key in the given bundle. - localizeCommands - Variable in class com.github.kaktushose.jda.commands.extension.JDACBuilderData
- localizeCommands() - Method in class com.github.kaktushose.jda.commands.extension.JDACBuilderData
- localizeCommands(boolean) - Method in class com.github.kaktushose.jda.commands.JDACBuilder
-
Whether JDA-Commands should use the
I18nfeature to localize commands. - localizer - Variable in class com.github.kaktushose.jda.commands.extension.JDACBuilderData
- localizer() - Method in class com.github.kaktushose.jda.commands.extension.JDACBuilderData
- localizer(Localizer) - Method in class com.github.kaktushose.jda.commands.JDACBuilder
- Localizer - Interface in com.github.kaktushose.jda.commands.message.i18n
-
A
Localizeris used to localize a given key for a specific bundle and locale. - log - Static variable in interface com.github.kaktushose.jda.commands.definitions.features.internal.Invokable
- log - Static variable in class com.github.kaktushose.jda.commands.dispatching.handling.EventHandler
- log - Static variable in class com.github.kaktushose.jda.commands.extension.JDACBuilderData
- log - Static variable in class com.github.kaktushose.jda.commands.JDAContext
- log - Static variable in interface com.github.kaktushose.jda.commands.message.emoji.EmojiSource
- 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
maxValuerecord 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
maxValuerecord component. - maxValue() - Method in record class com.github.kaktushose.jda.commands.definitions.interactions.ModalDefinition.TextInputDefinition
-
Returns the value of the
maxValuerecord component. - maxValues - Variable in class com.github.kaktushose.jda.commands.dispatching.reply.dynamic.menu.SelectMenuComponent
- maxValues(int) - Method in class com.github.kaktushose.jda.commands.dispatching.reply.dynamic.menu.SelectMenuComponent
- MenuOption - Annotation Interface in com.github.kaktushose.jda.commands.annotations.interactions
-
Used to define
SelectOptionsforStringSelectMenus. - MenuOptionContainer - Annotation Interface in com.github.kaktushose.jda.commands.annotations.interactions
-
InternalException wrapper for repeating
MenuOptions. - MenuOptionDefinition(String, String, String, Emoji, boolean) - Constructor for record class com.github.kaktushose.jda.commands.definitions.interactions.component.menu.StringSelectMenuDefinition.MenuOptionDefinition
-
Creates an instance of a
MenuOptionDefinitionrecord class. - MenuOptionDefinition(SelectOption) - Constructor for record class com.github.kaktushose.jda.commands.definitions.interactions.component.menu.StringSelectMenuDefinition.MenuOptionDefinition
- merged() - Method in record class com.github.kaktushose.jda.commands.definitions.interactions.CustomId
-
The String representation of this custom id.
- mergedClassFinder() - Method in class com.github.kaktushose.jda.commands.extension.JDACBuilderData
- messageResolver() - Method in record class com.github.kaktushose.jda.commands.dispatching.context.InvocationContext
-
Returns the value of the
messageResolverrecord component. - messageResolver() - Method in record class com.github.kaktushose.jda.commands.dispatching.DispatchingContext
-
Returns the value of the
messageResolverrecord component. - messageResolver() - Method in class com.github.kaktushose.jda.commands.dispatching.events.Event
-
Gets the
MessageResolverinstance - messageResolver() - Method in class com.github.kaktushose.jda.commands.dispatching.Runtime
- messageResolver() - Method in record class com.github.kaktushose.jda.commands.embeds.internal.Embeds
-
Returns the value of the
messageResolverrecord component. - messageResolver() - Method in class com.github.kaktushose.jda.commands.extension.JDACBuilderData
- messageResolver() - Method in class com.github.kaktushose.jda.commands.JDACommands
-
Exposes the message resolver functionality of JDA-Commands to be used elsewhere in the application.
- MessageResolver - Class in com.github.kaktushose.jda.commands.message
-
The MessageResolver combines
I18n.localize(Locale, String, Entry...)andEmojiResolver.resolve(String). - MessageResolver(I18n, EmojiResolver) - Constructor for class com.github.kaktushose.jda.commands.message.MessageResolver
- method() - Method in record class com.github.kaktushose.jda.commands.definitions.interactions.MethodBuildContext
-
Returns the value of the
methodrecord 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>, CommandDefinition.CommandConfig) - Constructor for record class com.github.kaktushose.jda.commands.definitions.interactions.MethodBuildContext
-
Creates an instance of a
MethodBuildContextrecord class. - methodDescription() - Method in interface com.github.kaktushose.jda.commands.definitions.features.internal.Invokable
-
The
MethodDescriptionof the method thisDefinitionis bound to. - methodDescription() - Method in record class com.github.kaktushose.jda.commands.definitions.interactions.AutoCompleteDefinition
-
Returns the value of the
methodDescriptionrecord component. - methodDescription() - Method in record class com.github.kaktushose.jda.commands.definitions.interactions.command.ContextCommandDefinition
-
Returns the value of the
methodDescriptionrecord component. - methodDescription() - Method in record class com.github.kaktushose.jda.commands.definitions.interactions.command.SlashCommandDefinition
-
Returns the value of the
methodDescriptionrecord component. - methodDescription() - Method in record class com.github.kaktushose.jda.commands.definitions.interactions.component.ButtonDefinition
-
Returns the value of the
methodDescriptionrecord component. - methodDescription() - Method in interface com.github.kaktushose.jda.commands.definitions.interactions.component.ComponentDefinition
-
The
MethodDescriptionof 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
methodDescriptionrecord component. - methodDescription() - Method in record class com.github.kaktushose.jda.commands.definitions.interactions.component.menu.StringSelectMenuDefinition
-
Returns the value of the
methodDescriptionrecord component. - methodDescription() - Method in record class com.github.kaktushose.jda.commands.definitions.interactions.ModalDefinition
-
Returns the value of the
methodDescriptionrecord component. - MethodDescription - Record Class in com.github.kaktushose.jda.commands.definitions.description
-
A
Descriptionthat describes a method. - MethodDescription(Class<?>, Class<?>, String, SequencedCollection<ParameterDescription>, Collection<AnnotationDescription<?>>, Invoker) - Constructor for record class com.github.kaktushose.jda.commands.definitions.description.MethodDescription
-
Creates an instance of a
MethodDescriptionrecord class. - methods() - Method in record class com.github.kaktushose.jda.commands.definitions.description.ClassDescription
-
Returns the value of the
methodsrecord component. - middleware() - Method in record class com.github.kaktushose.jda.commands.extension.Implementation.MiddlewareContainer
-
Returns the value of the
middlewarerecord component. - middleware(Priority, Middleware) - Method in class com.github.kaktushose.jda.commands.JDACBuilder
- Middleware - Interface in com.github.kaktushose.jda.commands.dispatching.middleware
-
Middlewares run just before an interaction event gets dispatched.
- MiddlewareContainer(Priority, Middleware) - Constructor for record class com.github.kaktushose.jda.commands.extension.Implementation.MiddlewareContainer
-
Creates an instance of a
MiddlewareContainerrecord class. - middlewares - Variable in class com.github.kaktushose.jda.commands.dispatching.handling.EventHandler
- middlewares - Variable in class com.github.kaktushose.jda.commands.extension.JDACBuilderData
- middlewares() - Method in record class com.github.kaktushose.jda.commands.dispatching.DispatchingContext
-
Returns the value of the
middlewaresrecord component. - middlewares() - Method in class com.github.kaktushose.jda.commands.extension.JDACBuilderData
- Middlewares - Class in com.github.kaktushose.jda.commands.dispatching.middleware.internal
-
Central registry for all
Middlewares. - Middlewares(Collection<Map.Entry<Priority, Middleware>>, ErrorMessageFactory, PermissionsProvider) - Constructor for class com.github.kaktushose.jda.commands.dispatching.middleware.internal.Middlewares
- 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
minValuerecord 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
minValuerecord component. - minValue() - Method in record class com.github.kaktushose.jda.commands.definitions.interactions.ModalDefinition.TextInputDefinition
-
Returns the value of the
minValuerecord component. - minValues - Variable in class com.github.kaktushose.jda.commands.dispatching.reply.dynamic.menu.SelectMenuComponent
- minValues(int) - Method in class com.github.kaktushose.jda.commands.dispatching.reply.dynamic.menu.SelectMenuComponent
- Modal - Annotation Interface in com.github.kaktushose.jda.commands.annotations.interactions
-
Methods annotated with
Modalwill be registered as a modal at startup. - ModalBuilder - Class in com.github.kaktushose.jda.commands.dispatching.reply.dynamic
-
Builder for
Modals. - ModalBuilder(ReplyableEvent<?>, CustomId, ModalDefinition) - Constructor for class com.github.kaktushose.jda.commands.dispatching.reply.dynamic.ModalBuilder
-
Constructs a new
ModalBuilder. - 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
ModalDefinitionrecord 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, Embeds) - Constructor for class com.github.kaktushose.jda.commands.dispatching.events.interactions.ModalEvent
-
Constructs a new CommandEvent.
- ModalHandler - Class in com.github.kaktushose.jda.commands.dispatching.handling
- ModalHandler(DispatchingContext) - Constructor for class com.github.kaktushose.jda.commands.dispatching.handling.ModalHandler
- ModalReplyableEvent<T> - Class in com.github.kaktushose.jda.commands.dispatching.events
-
Subtype of
ReplyableEventthat also supports replying with aModal. - ModalReplyableEvent(T, InteractionRegistry, Runtime, InteractionDefinition, InteractionDefinition.ReplyConfig, Embeds) - Constructor for class com.github.kaktushose.jda.commands.dispatching.events.ModalReplyableEvent
-
Constructs a new ModalReplyableEvent.
- modify(Function<B, B>) - Method in class com.github.kaktushose.jda.commands.dispatching.reply.Component
- modify(Function<Modal.Builder, Modal.Builder>) - Method in class com.github.kaktushose.jda.commands.dispatching.reply.dynamic.ModalBuilder
N
- name() - Element in annotation interface com.github.kaktushose.jda.commands.annotations.interactions.Param
-
Returns the name of the command option.
- name() - Method in record class com.github.kaktushose.jda.commands.definitions.description.ClassDescription
-
Returns the value of the
namerecord component. - name() - Method in record class com.github.kaktushose.jda.commands.definitions.description.MethodDescription
-
Returns the value of the
namerecord component. - name() - Method in record class com.github.kaktushose.jda.commands.definitions.description.PackageDescription
-
Returns the value of the
namerecord component. - name() - Method in record class com.github.kaktushose.jda.commands.definitions.description.ParameterDescription
-
Returns the value of the
namerecord 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
namerecord component. - name() - Method in record class com.github.kaktushose.jda.commands.definitions.interactions.command.OptionDataDefinition
-
Returns the value of the
namerecord component. - name() - Method in record class com.github.kaktushose.jda.commands.definitions.interactions.command.SlashCommandDefinition
-
Returns the value of the
namerecord component. - name() - Method in class com.github.kaktushose.jda.commands.dispatching.reply.Component
- name() - Method in class com.github.kaktushose.jda.commands.embeds.Embed
-
Gets the name of this embed.
- name() - Method in record class com.github.kaktushose.jda.commands.internal.register.TreeNode
-
Returns the value of the
namerecord component. - name() - Method in record class com.github.kaktushose.jda.commands.message.placeholder.Entry
-
Returns the value of the
namerecord component. - 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.
- NotPermissionValidator - Class in com.github.kaktushose.jda.commands.dispatching.validation.impl
- NotPermissionValidator() - Constructor for class com.github.kaktushose.jda.commands.dispatching.validation.impl.NotPermissionValidator
- nsfw(boolean) - Method in class com.github.kaktushose.jda.commands.definitions.interactions.command.CommandDefinition.CommandConfig.Builder
O
- of(boolean, boolean, Class<?>, String, Entry...) - Static method in class com.github.kaktushose.jda.commands.dispatching.reply.Component
-
Adds a
Componentwith the passed configuration to the reply. - of(boolean, boolean, String, Entry...) - Static method in class com.github.kaktushose.jda.commands.dispatching.reply.Component
-
Adds a
Componentwith the passed configuration to the reply. - of(boolean, Class<?>, String, Entry...) - Static method in class com.github.kaktushose.jda.commands.dispatching.reply.Component
-
Adds a
Componentwith the passed configuration to the reply. - of(Consumer<CommandDefinition.CommandConfig.Builder>) - Static method in record class com.github.kaktushose.jda.commands.definitions.interactions.command.CommandDefinition.CommandConfig
-
Constructs a new CommandConfig after the given
Consumermodified theCommandDefinition.CommandConfig.Builder. - of(Consumer<InteractionDefinition.ReplyConfig.Builder>) - Static method in record class com.github.kaktushose.jda.commands.definitions.interactions.InteractionDefinition.ReplyConfig
-
Constructs a new ReplyConfig after the given
Consumermodified theInteractionDefinition.ReplyConfig.Builder. - of(EmbedBuilder, String, Map<String, Object>, MessageResolver) - Static method in class com.github.kaktushose.jda.commands.embeds.Embed
-
Constructs a new
Embed. - of(DataObject, String, Map<String, Object>, MessageResolver) - Static method in class com.github.kaktushose.jda.commands.embeds.Embed
-
Constructs a new
Embed. - onGenericInteractionCreate(GenericInteractionCreateEvent) - Method in class com.github.kaktushose.jda.commands.dispatching.JDAEventListener
- option(String, String) - Method in class com.github.kaktushose.jda.commands.dispatching.reply.dynamic.menu.StringSelectComponent
- option(String, String, String, Emoji) - Method in class com.github.kaktushose.jda.commands.dispatching.reply.dynamic.menu.StringSelectComponent
- option(String, String, String) - Method in class com.github.kaktushose.jda.commands.dispatching.reply.dynamic.menu.StringSelectComponent
- option(String, String, Emoji) - Method in class com.github.kaktushose.jda.commands.dispatching.reply.dynamic.menu.StringSelectComponent
- optional() - Element in annotation interface com.github.kaktushose.jda.commands.annotations.interactions.Param
-
Returns whether this command option is optional.
- optional() - Method in record class com.github.kaktushose.jda.commands.definitions.interactions.command.OptionDataDefinition
-
Returns the value of the
optionalrecord component. - OptionDataDefinition - Record Class in com.github.kaktushose.jda.commands.definitions.interactions.command
-
Representation of a slash command option.
- OptionDataDefinition(Class<?>, Class<?>, OptionType, boolean, AutoCompleteDefinition, 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
OptionDataDefinitionrecord class. - OptionDataDefinition.ConstraintDefinition - Record Class in com.github.kaktushose.jda.commands.definitions.interactions.command
-
Representation of a parameter constraint defined by a constraint annotation.
- options() - Element in annotation interface com.github.kaktushose.jda.commands.annotations.interactions.AutoComplete
-
Returns the name of the command options this autocomplete should handle
- options() - Method in record class com.github.kaktushose.jda.commands.definitions.interactions.AutoCompleteDefinition.AutoCompleteRule
-
Returns the value of the
optionsrecord component. - optionType() - Method in record class com.github.kaktushose.jda.commands.definitions.interactions.command.OptionDataDefinition
-
Returns the value of the
optionTyperecord component. - origin() - Method in class com.github.kaktushose.jda.commands.dispatching.reply.Component
- override(T, T) - Static method in interface com.github.kaktushose.jda.commands.definitions.interactions.component.ComponentDefinition
-
Overrides the oldValue with the newValue if present, else returns the oldValue
- override(Supplier<T>, T, T) - Static method in interface com.github.kaktushose.jda.commands.definitions.interactions.component.ComponentDefinition
-
If present adds the newValues to the collection provided by the supplier, else returns the oldValue.
P
- packageDescription() - Method in record class com.github.kaktushose.jda.commands.definitions.description.ClassDescription
-
Returns the value of the
packageDescriptionrecord component. - PackageDescription - Record Class in com.github.kaktushose.jda.commands.definitions.description
-
A
Descriptionthat describes aPackage. - PackageDescription(String, Collection<AnnotationDescription<?>>) - Constructor for record class com.github.kaktushose.jda.commands.definitions.description.PackageDescription
-
Creates an instance of a
PackageDescriptionrecord class. - packages - Variable in class com.github.kaktushose.jda.commands.extension.JDACBuilderData
- packages() - Method in class com.github.kaktushose.jda.commands.extension.JDACBuilderData
-
the packages provided by the user for classpath scanning
- Param - Annotation Interface in com.github.kaktushose.jda.commands.annotations.interactions
-
Annotation used to add metadata, e.g.
- parameter() - Method in record class com.github.kaktushose.jda.commands.definitions.interactions.ModalDefinition.TextInputDefinition
-
Returns the value of the
parameterrecord component. - ParameterDescription - Record Class in com.github.kaktushose.jda.commands.definitions.description
-
A
Descriptionthat describes a parameter. - ParameterDescription(Class<?>, Class<?>[], String, Collection<AnnotationDescription<?>>) - Constructor for record class com.github.kaktushose.jda.commands.definitions.description.ParameterDescription
-
Creates an instance of a
ParameterDescriptionrecord class. - parameters() - Method in record class com.github.kaktushose.jda.commands.definitions.description.MethodDescription
-
Returns the value of the
parametersrecord component. - performTask(Consumer<JDA>, boolean) - Method in class com.github.kaktushose.jda.commands.JDAContext
-
Performs an operation on either the
JDAobject or on all shards. - 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
permissionsrecord component. - permissions() - Method in record class com.github.kaktushose.jda.commands.definitions.interactions.command.SlashCommandDefinition
-
Returns the value of the
permissionsrecord component. - permissions() - Method in record class com.github.kaktushose.jda.commands.definitions.interactions.component.ButtonDefinition
-
Returns the value of the
permissionsrecord component. - permissions() - Method in record class com.github.kaktushose.jda.commands.definitions.interactions.component.menu.EntitySelectMenuDefinition
-
Returns the value of the
permissionsrecord component. - permissions() - Method in record class com.github.kaktushose.jda.commands.definitions.interactions.component.menu.StringSelectMenuDefinition
-
Returns the value of the
permissionsrecord component. - permissions() - Method in interface com.github.kaktushose.jda.commands.definitions.interactions.InteractionDefinition
-
A possibly-empty
Collectionof permissions for this interaction. - permissions() - Method in record class com.github.kaktushose.jda.commands.definitions.interactions.MethodBuildContext
-
Returns the value of the
permissionsrecord component. - permissions() - Method in record class com.github.kaktushose.jda.commands.definitions.interactions.ModalDefinition
-
Returns the value of the
permissionsrecord component. - permissions(MethodBuildContext) - Static method in class com.github.kaktushose.jda.commands.internal.Helpers
-
Extracts the permissions from a
MethodBuildContext. - Permissions - Annotation Interface in com.github.kaktushose.jda.commands.annotations.interactions
-
Interactionclasses 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
- PermissionsMiddleware - Class in com.github.kaktushose.jda.commands.dispatching.middleware.impl
-
A
Middlewareimplementation that will check permissions. - PermissionsMiddleware(PermissionsProvider, ErrorMessageFactory) - Constructor for class com.github.kaktushose.jda.commands.dispatching.middleware.impl.PermissionsMiddleware
- permissionsProvider - Variable in class com.github.kaktushose.jda.commands.extension.JDACBuilderData
- permissionsProvider() - Method in class com.github.kaktushose.jda.commands.extension.JDACBuilderData
- permissionsProvider(PermissionsProvider) - Method in class com.github.kaktushose.jda.commands.JDACBuilder
- PermissionsProvider - Interface in com.github.kaktushose.jda.commands.permissions
-
Interface for performing permission checks.
- PermissionValidator - Class in com.github.kaktushose.jda.commands.dispatching.validation.impl
- PermissionValidator() - Constructor for class com.github.kaktushose.jda.commands.dispatching.validation.impl.PermissionValidator
- PerModuleScope - Class in com.github.kaktushose.jda.commands.guice.internal
- PerModuleScope() - Constructor for class com.github.kaktushose.jda.commands.guice.internal.PerModuleScope
- placeholder - Variable in class com.github.kaktushose.jda.commands.dispatching.reply.dynamic.menu.SelectMenuComponent
- 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() - Element in annotation interface com.github.kaktushose.jda.commands.annotations.interactions.TextInput
-
The placeholder of this TextInput.
- placeholder() - Method in record class com.github.kaktushose.jda.commands.definitions.interactions.component.menu.EntitySelectMenuDefinition
-
Returns the value of the
placeholderrecord 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
placeholderrecord component. - placeholder() - Method in record class com.github.kaktushose.jda.commands.definitions.interactions.ModalDefinition.TextInputDefinition
-
Returns the value of the
placeholderrecord component. - placeholder() - Method in class com.github.kaktushose.jda.commands.dispatching.reply.Component
- placeholder(Entry...) - Method in class com.github.kaktushose.jda.commands.dispatching.reply.dynamic.ModalBuilder
- placeholder(String) - Method in class com.github.kaktushose.jda.commands.dispatching.reply.dynamic.menu.SelectMenuComponent
- PlaceholderResolver - Class in com.github.kaktushose.jda.commands.message.placeholder
-
The placeholder resolver is used to do simple placeholder/variable resolution.
- PlaceholderResolver() - Constructor for class com.github.kaktushose.jda.commands.message.placeholder.PlaceholderResolver
- placeholders() - Method in record class com.github.kaktushose.jda.commands.embeds.internal.Embeds
-
Returns the value of the
placeholdersrecord component. - placeholders(Entry...) - Method in class com.github.kaktushose.jda.commands.embeds.Embed
-
Adds all the provided
placeholdersto this embed instance. - placeholders(Entry...) - Method in interface com.github.kaktushose.jda.commands.embeds.EmbedConfig
-
Adds one or more new global placeholders.
- placeholders(Entry...) - Method in class com.github.kaktushose.jda.commands.embeds.internal.Embeds.Configuration
- placeholders(Map<String, Object>) - Method in class com.github.kaktushose.jda.commands.embeds.Embed
-
Adds all the provided placeholders to this embed instance.
- placeholders(Map<String, Object>) - Method in interface com.github.kaktushose.jda.commands.embeds.EmbedConfig
-
Adds global placeholders with the values of the given map, where the key of the map represents the name of the placeholder and the value of the map the value to replace the placeholder with.
- placeholders(Map<String, Object>) - Method in class com.github.kaktushose.jda.commands.embeds.internal.Embeds.Configuration
- prepare(CommandAutoCompleteInteractionEvent, Runtime) - Method in class com.github.kaktushose.jda.commands.dispatching.handling.AutoCompleteHandler
- prepare(GenericContextInteractionEvent<?>, Runtime) - Method in class com.github.kaktushose.jda.commands.dispatching.handling.command.ContextCommandHandler
- prepare(SlashCommandInteractionEvent, Runtime) - Method in class com.github.kaktushose.jda.commands.dispatching.handling.command.SlashCommandHandler
- prepare(GenericComponentInteractionCreateEvent, Runtime) - Method in class com.github.kaktushose.jda.commands.dispatching.handling.ComponentHandler
- prepare(ModalInteractionEvent, Runtime) - Method in class com.github.kaktushose.jda.commands.dispatching.handling.ModalHandler
- prepare(T, Runtime) - Method in class com.github.kaktushose.jda.commands.dispatching.handling.EventHandler
- priority() - Method in record class com.github.kaktushose.jda.commands.extension.Implementation.MiddlewareContainer
-
Returns the value of the
priorityrecord component. - priority() - Element in annotation interface com.github.kaktushose.jda.commands.guice.Implementation.Middleware
-
Gets the
Priorityto register theMiddlewarewith. - Priority - Enum Class in com.github.kaktushose.jda.commands.dispatching.middleware
-
Enum to define with witch priority a
Middlewareshould be executed. - providedImplementations() - Method in interface com.github.kaktushose.jda.commands.extension.Extension
-
Gets a collection of
Implementations thisExtensionprovides. - providedImplementations() - Method in class com.github.kaktushose.jda.commands.guice.GuiceExtension
- providedInjector() - Method in record class com.github.kaktushose.jda.commands.guice.GuiceExtensionData
-
Returns the value of the
providedInjectorrecord component. - put(String, Object) - Method in class com.github.kaktushose.jda.commands.dispatching.context.KeyValueStore
-
Associates the specified value with the specified key.
Q
- queueEvent(GenericInteractionCreateEvent) - Method in class com.github.kaktushose.jda.commands.dispatching.Runtime
R
- rawArguments() - Method in record class com.github.kaktushose.jda.commands.dispatching.context.InvocationContext
-
Returns the value of the
rawArgumentsrecord component. - reflective(String...) - Static method in interface com.github.kaktushose.jda.commands.definitions.description.ClassFinder
-
This provides a reflections based implementation of
ClassFinder - reflective(String...) - Static method in interface com.github.kaktushose.jda.commands.message.emoji.EmojiSource
-
This implementation of
EmojiSourcescans the classpath for emoji files under the given paths. - REFLECTIVE - Static variable in interface com.github.kaktushose.jda.commands.definitions.description.Descriptor
- ReflectiveClassFinder - Class in com.github.kaktushose.jda.commands.definitions.description.reflective
- ReflectiveClassFinder(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
- registry - Variable in class com.github.kaktushose.jda.commands.dispatching.events.Event
- registry - Variable in class com.github.kaktushose.jda.commands.dispatching.handling.EventHandler
- registry() - Method in record class com.github.kaktushose.jda.commands.dispatching.DispatchingContext
-
Returns the value of the
registryrecord component. - remove(String) - Method in class com.github.kaktushose.jda.commands.dispatching.context.KeyValueStore
-
Removes the value mapping for a key.
- remove(String) - Method in interface com.github.kaktushose.jda.commands.embeds.Embed.Fields
-
Removes all fields with the given value.
- remove(String, String) - Method in interface com.github.kaktushose.jda.commands.embeds.Embed.Fields
-
Removes all fields with the given name and value.
- removeByName(String) - Method in interface com.github.kaktushose.jda.commands.embeds.Embed.Fields
-
Removes all fields with the given name.
- removeComponents() - Method in class com.github.kaktushose.jda.commands.dispatching.events.ReplyableEvent
-
Removes all components from the original message.
- removeIf(String, Predicate<MessageEmbed.Field>) - Method in interface com.github.kaktushose.jda.commands.embeds.Embed.Fields
-
Removes all fields with the given name of this embed based on the given
Predicate. - removeIf(Predicate<MessageEmbed.Field>) - Method in interface com.github.kaktushose.jda.commands.embeds.Embed.Fields
-
Removes all fields of this embed based on the given
Predicate. - replace(String, MessageEmbed.Field) - Method in interface com.github.kaktushose.jda.commands.embeds.Embed.Fields
-
Replaces all fields of this embed with the given
MessageEmbed.Fieldbased on the given name. - replace(Predicate<MessageEmbed.Field>, MessageEmbed.Field) - Method in interface com.github.kaktushose.jda.commands.embeds.Embed.Fields
-
Replaces all fields of this embed based on the
Predicatewith the givenMessageEmbed.Field. - replaceByValue(String, MessageEmbed.Field) - Method in interface com.github.kaktushose.jda.commands.embeds.Embed.Fields
-
Replaces all fields of this embed with the given
MessageEmbed.Fieldbased on the given value. - reply() - Method in class com.github.kaktushose.jda.commands.dispatching.reply.internal.ReplyAction
- reply() - Method in class com.github.kaktushose.jda.commands.dispatching.reply.SendableReply
-
Sends the reply to Discord and blocks the current thread until the message was sent.
- reply(String, Entry...) - Method in class com.github.kaktushose.jda.commands.dispatching.events.ReplyableEvent
-
Acknowledgement of this event with a text message.
- reply(String, Entry...) - Method in class com.github.kaktushose.jda.commands.dispatching.reply.ConfigurableReply
-
Acknowledgement of this event with a text message.
- reply(String, Entry...) - Method in interface com.github.kaktushose.jda.commands.dispatching.reply.internal.Reply
-
Acknowledgement of this event with a text message.
- reply(String, Entry...) - Method in class com.github.kaktushose.jda.commands.dispatching.reply.internal.ReplyAction
- reply(MessageEmbed, MessageEmbed...) - Method in class com.github.kaktushose.jda.commands.dispatching.events.ReplyableEvent
-
Acknowledgement of this event with a
MessageEmbed. - reply(MessageEmbed, MessageEmbed...) - Method in interface com.github.kaktushose.jda.commands.dispatching.reply.internal.Reply
-
Acknowledgement of this event with a
MessageEmbed. - reply(MessageEmbed, MessageEmbed...) - Method in class com.github.kaktushose.jda.commands.dispatching.reply.internal.ReplyAction
- reply(MessageCreateData) - Method in class com.github.kaktushose.jda.commands.dispatching.events.ReplyableEvent
-
Acknowledgement of this event with a
MessageCreateData. - reply(MessageCreateData) - Method in interface com.github.kaktushose.jda.commands.dispatching.reply.internal.Reply
-
Acknowledgement of this event with a
MessageCreateData. - reply(MessageCreateData) - Method in class com.github.kaktushose.jda.commands.dispatching.reply.internal.ReplyAction
- Reply - Interface in com.github.kaktushose.jda.commands.dispatching.reply.internal
-
Common interface for classes that support simple message replies to
GenericInteractionCreateEvent. - ReplyableEvent<T> - Class in com.github.kaktushose.jda.commands.dispatching.events
-
Subtype of
Eventthat supports replying to theGenericInteractionCreateEventwith text messages. - ReplyableEvent(T, InteractionRegistry, Runtime, InteractionDefinition, InteractionDefinition.ReplyConfig, Embeds) - Constructor for class com.github.kaktushose.jda.commands.dispatching.events.ReplyableEvent
-
Constructs a new ReplyableEvent.
- replyAction - Variable in class com.github.kaktushose.jda.commands.dispatching.reply.ConfigurableReply
- ReplyAction - Class in com.github.kaktushose.jda.commands.dispatching.reply.internal
-
Implementation of
Replyhandling all the business logic of sending messages. - ReplyAction(GenericInteractionCreateEvent, InteractionDefinition, MessageResolver, InteractionDefinition.ReplyConfig) - Constructor for class com.github.kaktushose.jda.commands.dispatching.reply.internal.ReplyAction
-
Constructs a new ReplyAction.
- 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() - Method in record class com.github.kaktushose.jda.commands.dispatching.context.InvocationContext
-
Returns the value of the
replyConfigrecord component. - replyConfig(Invokable, InteractionDefinition.ReplyConfig) - Static method in class com.github.kaktushose.jda.commands.internal.Helpers
-
The
InteractionDefinition.ReplyConfigthat 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.ReplyConfigusing the following default values: - ReplyConfig(boolean, boolean, boolean, boolean) - Constructor for record class com.github.kaktushose.jda.commands.definitions.interactions.InteractionDefinition.ReplyConfig
-
Creates an instance of a
ReplyConfigrecord class. - ReplyConfig(ReplyConfig) - Constructor for record class com.github.kaktushose.jda.commands.definitions.interactions.InteractionDefinition.ReplyConfig
-
Constructs a new ReplyConfig.
- replyModal(String, Entry...) - Method in class com.github.kaktushose.jda.commands.dispatching.events.ModalReplyableEvent
-
Acknowledgement of this event with a
Modal. - replyModal(String, Function<ModalBuilder, ModalBuilder>) - 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
requiredrecord component. - requiresRange(int, int) - Method in class com.github.kaktushose.jda.commands.dispatching.reply.dynamic.menu.SelectMenuComponent
- resolve(String) - Method in class com.github.kaktushose.jda.commands.message.emoji.EmojiResolver
-
Resolves the emoji aliases of a string according to the javadocs of this class.
- resolve(String, Entry...) - Method in class com.github.kaktushose.jda.commands.dispatching.events.Event
-
Resolved the given message with help of the underlying
MessageResolverinstance, thus performing localization and emoji resolution. - resolve(String, Locale, Entry...) - Method in class com.github.kaktushose.jda.commands.message.MessageResolver
-
First resolves the variables in the given message (see
PlaceholderResolver.resolve(String, Map)), then localizes the resulting message (seeI18n.localize(Locale, String, Entry...)) and lastly attempts to resolve emojis (seeEmojiResolver.resolve(String)). - resolve(String, Locale, Map<String, Object>) - Method in class com.github.kaktushose.jda.commands.message.MessageResolver
-
First resolves the variables in the given message (see
PlaceholderResolver.resolve(String, Map)), then localizes the resulting message (seeI18n.localize(Locale, String, Entry...)) and lastly attempts to resolve emojis (seeEmojiResolver.resolve(String)). - resolve(String, Map<String, Object>) - Static method in class com.github.kaktushose.jda.commands.message.placeholder.PlaceholderResolver
-
Resolves the given string according to the class docs.
- resolvedType() - Method in record class com.github.kaktushose.jda.commands.definitions.interactions.command.OptionDataDefinition
-
Returns the value of the
resolvedTyperecord component. - resource(String) - Static method in interface com.github.kaktushose.jda.commands.embeds.EmbedDataSource
-
Constructs a new
EmbedDataSourceusing a JSON file that is located inside the resources folder. - RESOURCE_PATTERN - Static variable in interface com.github.kaktushose.jda.commands.message.emoji.EmojiSource
- returnType() - Method in record class com.github.kaktushose.jda.commands.definitions.description.MethodDescription
-
Returns the value of the
returnTyperecord component. - root() - Method in record class com.github.kaktushose.jda.commands.internal.register.CommandTree
-
Returns the value of the
rootrecord component. - rules() - Method in record class com.github.kaktushose.jda.commands.definitions.interactions.AutoCompleteDefinition
-
Returns the value of the
rulesrecord component. - runFor() - Method in interface com.github.kaktushose.jda.commands.dispatching.middleware.Middleware
-
Declares the interaction controllers for which this middleware should run.
- Runtime - Class in com.github.kaktushose.jda.commands.dispatching
-
A
Runtimedelegates the jda events to their correspondingEventHandlerand manages the used virtual threads. - 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
Runtimethis event is dispatched in. - runtimeId() - Method in class com.github.kaktushose.jda.commands.dispatching.instance.InteractionControllerInstantiator.Context
-
the runtime id
S
- scope() - Element in annotation interface com.github.kaktushose.jda.commands.annotations.interactions.CommandConfig
-
The
CommandScopeto use. - scope() - Method in record class com.github.kaktushose.jda.commands.definitions.interactions.command.CommandDefinition.CommandConfig
-
Returns the value of the
scoperecord component. - scope(CommandScope) - Method in class com.github.kaktushose.jda.commands.definitions.interactions.command.CommandDefinition.CommandConfig.Builder
- scope(Key<T>, Provider<T>) - Method in class com.github.kaktushose.jda.commands.guice.internal.PerModuleScope
- search(Class<? extends Annotation>) - Method in interface com.github.kaktushose.jda.commands.definitions.description.ClassFinder
-
This method searches for classes annotated with the given annotation.
- search(Class<? extends Annotation>) - Method in class com.github.kaktushose.jda.commands.definitions.description.reflective.ReflectiveClassFinder
- search(Class<? extends Annotation>, Class<T>) - Method in interface com.github.kaktushose.jda.commands.definitions.description.ClassFinder
-
This method searches for classes annotated with the given annotation, which have the given super type.
- SelectMenuComponent<S,
T, - Class in com.github.kaktushose.jda.commands.dispatching.reply.dynamic.menuB, D> -
An implementation of
Componentspecific toSelectMenu. - SelectMenuComponent(String, Class<?>, Entry[]) - Constructor for class com.github.kaktushose.jda.commands.dispatching.reply.dynamic.menu.SelectMenuComponent
- SelectMenuDefinition<T> - Interface in com.github.kaktushose.jda.commands.definitions.interactions.component.menu
-
Common interface for select menu definitions.
- selectOptions() - Method in record class com.github.kaktushose.jda.commands.definitions.interactions.component.menu.StringSelectMenuDefinition
-
Returns the value of the
selectOptionsrecord component. - selectOptions(Collection<SelectOption>) - Method in class com.github.kaktushose.jda.commands.dispatching.reply.dynamic.menu.StringSelectComponent
- selectOptions(SelectOption...) - Method in class com.github.kaktushose.jda.commands.dispatching.reply.dynamic.menu.StringSelectComponent
- selectTargets() - Method in record class com.github.kaktushose.jda.commands.definitions.interactions.component.menu.EntitySelectMenuDefinition
-
Returns the value of the
selectTargetsrecord component. - self() - Method in class com.github.kaktushose.jda.commands.dispatching.reply.Component
- SendableReply - Class in com.github.kaktushose.jda.commands.dispatching.reply
-
Subtype of
ConfigurableReplythat allows replying without message content (SendableReply.reply()). - SendableReply(ConfigurableReply) - Constructor for class com.github.kaktushose.jda.commands.dispatching.reply.SendableReply
-
Constructs a new SendableReply.
- shutdown() - Method in class com.github.kaktushose.jda.commands.JDACommands
-
Shuts down this JDACommands instance, making it unable to receive any events from Discord.
- shutdown() - Method in class com.github.kaktushose.jda.commands.JDAContext
-
Shutdown the underlying
JDAorShardManagerinstance - shutdownJDA - Variable in class com.github.kaktushose.jda.commands.extension.JDACBuilderData
- shutdownJDA() - Method in class com.github.kaktushose.jda.commands.extension.JDACBuilderData
- shutdownJDA(boolean) - Method in class com.github.kaktushose.jda.commands.JDACBuilder
-
Whether the JDA instance should be shutdown if the configuration/start of JDA-Commands fails or if
JDACommands.shutdown()is called - single(Class<T>, Function<JDACBuilderData, T>) - Static method in record class com.github.kaktushose.jda.commands.extension.Implementation
- SlashCommandDefinition - Record Class in com.github.kaktushose.jda.commands.definitions.interactions.command
-
Representation of a slash command.
- SlashCommandDefinition(ClassDescription, MethodDescription, Collection<String>, String, CommandDefinition.CommandConfig, LocalizationFunction, String, SequencedCollection<OptionDataDefinition>, SlashCommandDefinition.CooldownDefinition) - Constructor for record class com.github.kaktushose.jda.commands.definitions.interactions.command.SlashCommandDefinition
-
Creates an instance of a
SlashCommandDefinitionrecord class. - SlashCommandDefinition.CooldownDefinition - Record Class in com.github.kaktushose.jda.commands.definitions.interactions.command
-
Representation of a cooldown definition defined by
Cooldown. - SlashCommandHandler - Class in com.github.kaktushose.jda.commands.dispatching.handling.command
- SlashCommandHandler(DispatchingContext) - Constructor for class com.github.kaktushose.jda.commands.dispatching.handling.command.SlashCommandHandler
- SlashCommandUpdater - Class in com.github.kaktushose.jda.commands.internal.register
-
Class that sends the
CommandDatato Discord. - SlashCommandUpdater(JDAContext, GuildScopeProvider, InteractionRegistry) - Constructor for class com.github.kaktushose.jda.commands.internal.register.SlashCommandUpdater
-
Constructs a new SlashCommandUpdater.
- source() - Method in record class com.github.kaktushose.jda.commands.extension.Implementation.TypeAdapterContainer
-
Returns the value of the
sourcerecord component. - source() - Element in annotation interface com.github.kaktushose.jda.commands.guice.Implementation.TypeAdapter
-
Gets the
ClassthisTypeAdapterwill convert from. - sources() - Method in record class com.github.kaktushose.jda.commands.embeds.internal.Embeds
-
Returns the value of the
sourcesrecord component. - sources(EmbedDataSource...) - Method in interface com.github.kaktushose.jda.commands.embeds.EmbedConfig
-
Adds a new
EmbedDataSourcethatEmbeds can be loaded from. - sources(EmbedDataSource...) - Method in class com.github.kaktushose.jda.commands.embeds.internal.Embeds.Configuration
- start() - Method in class com.github.kaktushose.jda.commands.JDACBuilder
-
This method applies all found implementations of
Extension, instantiates an instance ofJDACommandsand 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.
- startNew(String, DispatchingContext, JDA) - Static method in class com.github.kaktushose.jda.commands.dispatching.Runtime
- stringSelect(Class<?>, String, Entry...) - Static method in class com.github.kaktushose.jda.commands.dispatching.reply.Component
-
Adds a
StringSelectComponentto the reply. - stringSelect(String, Entry...) - Static method in class com.github.kaktushose.jda.commands.dispatching.reply.Component
-
Adds a
StringSelectComponentto the reply. - StringSelectComponent - Class in com.github.kaktushose.jda.commands.dispatching.reply.dynamic.menu
-
An implementation of
Componentspecific toStringSelectMenu - StringSelectComponent(String, Class<?>, Entry[]) - Constructor for class com.github.kaktushose.jda.commands.dispatching.reply.dynamic.menu.StringSelectComponent
- 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.MenuOptionDefinition>, String, int, int) - Constructor for record class com.github.kaktushose.jda.commands.definitions.interactions.component.menu.StringSelectMenuDefinition
-
Creates an instance of a
StringSelectMenuDefinitionrecord class. - StringSelectMenuDefinition.MenuOptionDefinition - 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
MenuOption. - 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
stylerecord component. - style() - Method in record class com.github.kaktushose.jda.commands.definitions.interactions.ModalDefinition.TextInputDefinition
-
Returns the value of the
stylerecord component. - style(ButtonStyle) - Method in class com.github.kaktushose.jda.commands.dispatching.reply.dynamic.ButtonComponent
- supplier() - Method in record class com.github.kaktushose.jda.commands.extension.Implementation
-
Returns the value of the
supplierrecord component.
T
- target() - Method in record class com.github.kaktushose.jda.commands.extension.Implementation.TypeAdapterContainer
-
Returns the value of the
targetrecord component. - target() - Element in annotation interface com.github.kaktushose.jda.commands.guice.Implementation.TypeAdapter
-
Gets the
ClassthisTypeAdapterwill convert into. - test(ServiceLoader.Provider<Extension>) - Method in record class com.github.kaktushose.jda.commands.extension.internal.ExtensionFilter
- textInput(String, Function<TextInput.Builder, TextInput.Builder>) - Method in class com.github.kaktushose.jda.commands.dispatching.reply.dynamic.ModalBuilder
-
Allows modification of a text input with the given callback.
- TextInput - Annotation Interface in com.github.kaktushose.jda.commands.annotations.interactions
-
Annotation used to add TextInputs to
Modals. - TextInputDefinition(ParameterDescription, 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
TextInputDefinitionrecord class. - textInputs() - Method in record class com.github.kaktushose.jda.commands.definitions.interactions.ModalDefinition
-
Returns the value of the
textInputsrecord component. - thumbnail(String) - Method in class com.github.kaktushose.jda.commands.embeds.Embed
-
Sets the Thumbnail of the embed.
- timestamp(TemporalAccessor) - Method in class com.github.kaktushose.jda.commands.embeds.Embed
-
Sets the Timestamp of the embed.
- timeUnit() - Element in annotation interface com.github.kaktushose.jda.commands.annotations.interactions.Cooldown
-
Returns the
TimeUnitof the specified delay. - timeUnit() - Method in record class com.github.kaktushose.jda.commands.definitions.interactions.command.SlashCommandDefinition.CooldownDefinition
-
Returns the value of the
timeUnitrecord component. - title() - Method in record class com.github.kaktushose.jda.commands.definitions.interactions.ModalDefinition
-
Returns the value of the
titlerecord component. - title(String) - Method in class com.github.kaktushose.jda.commands.embeds.Embed
-
Sets the Title of the embed.
- title(String, String) - Method in class com.github.kaktushose.jda.commands.embeds.Embed
-
Sets the Title of the embed.
- title(String) - Method in class com.github.kaktushose.jda.commands.dispatching.reply.dynamic.ModalBuilder
- toBuilder() - Method in record class com.github.kaktushose.jda.commands.definitions.interactions.ModalDefinition.TextInputDefinition
-
Transforms this definition into a
TextInput.Builder. - toJDAEntity() - Method in interface com.github.kaktushose.jda.commands.definitions.features.JDAEntity
-
Transforms this
Definitioninto a JDA entity of the given typeT. - 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
Buttonwith an independent custom id. - toJDAEntity() - Method in record class com.github.kaktushose.jda.commands.definitions.interactions.component.menu.EntitySelectMenuDefinition
-
Transforms this definition to an
EntitySelectMenuwith an independent custom id. - toJDAEntity() - Method in record class com.github.kaktushose.jda.commands.definitions.interactions.component.menu.StringSelectMenuDefinition.MenuOptionDefinition
-
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
StringSelectMenuwith 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
Definitioninto a JDA entity of the given typeT. - 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
EntitySelectMenuwith the givenCustomId. - toJDAEntity(CustomId) - Method in record class com.github.kaktushose.jda.commands.definitions.interactions.component.menu.StringSelectMenuDefinition
-
Transforms this definition to an
StringSelectMenuwith the givenCustomId. - toJDAEntity(CustomId) - Method in record class com.github.kaktushose.jda.commands.definitions.interactions.ModalDefinition
-
Transforms this definition to an
Modalwith the given custom id. - toMap(Entry...) - Static method in record class com.github.kaktushose.jda.commands.message.placeholder.Entry
-
Takes a varargs array of Entries and transforms it into a
Map, whereEntry.name()is the keyEntry.value()will be mapped to. - toMessageCreateData() - Method in class com.github.kaktushose.jda.commands.embeds.Embed
-
Transforms this embed into
MessageCreateData. - toMessageEditData() - Method in class com.github.kaktushose.jda.commands.embeds.Embed
-
Transforms this embed into
MessageEditData. - toMethodType() - Method in record class com.github.kaktushose.jda.commands.definitions.description.MethodDescription
- toSlashCommandData(LocalizationFunction) - Method in record class com.github.kaktushose.jda.commands.internal.register.TreeNode
-
Transforms this
TreeNodeintoSlashCommandData. - toString() - Method in record class com.github.kaktushose.jda.commands.definitions.description.AnnotationDescription
-
Returns a string representation of this record class.
- 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.PackageDescription
-
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.AutoCompleteRule
-
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.CommandDefinition.CommandConfig
-
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.MenuOptionDefinition
-
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.DispatchingContext
-
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.embeds.error.DefaultErrorMessageFactory
-
Returns a string representation of this record class.
- toString() - Method in record class com.github.kaktushose.jda.commands.embeds.internal.Embeds
-
Returns a string representation of this record class.
- toString() - Method in record class com.github.kaktushose.jda.commands.extension.Implementation.MiddlewareContainer
-
Returns a string representation of this record class.
- toString() - Method in record class com.github.kaktushose.jda.commands.extension.Implementation
-
Returns a string representation of this record class.
- toString() - Method in record class com.github.kaktushose.jda.commands.extension.Implementation.TypeAdapterContainer
-
Returns a string representation of this record class.
- toString() - Method in record class com.github.kaktushose.jda.commands.extension.Implementation.ValidatorContainer
-
Returns a string representation of this record class.
- toString() - Method in record class com.github.kaktushose.jda.commands.extension.internal.ExtensionFilter
-
Returns a string representation of this record class.
- toString() - Method in record class com.github.kaktushose.jda.commands.guice.GuiceExtensionData
-
Returns a string representation of this record class.
- toString() - Method in record class com.github.kaktushose.jda.commands.internal.register.CommandTree
-
Returns a string representation of this record class.
- toString() - Method in record class com.github.kaktushose.jda.commands.internal.register.TreeNode
-
Returns a string representation of this record class.
- toString() - Method in record class com.github.kaktushose.jda.commands.message.placeholder.Entry
-
Returns a string representation of this record class.
- toSubcommandData(String) - Method in record class com.github.kaktushose.jda.commands.definitions.interactions.command.SlashCommandDefinition
-
Transforms this definition into
SubcommandData. - TreeNode - Record Class in com.github.kaktushose.jda.commands.internal.register
-
Single node inside the
CommandTree. - TreeNode(String, SlashCommandDefinition) - Constructor for record class com.github.kaktushose.jda.commands.internal.register.TreeNode
-
Constructs a new TreeNode.
- TreeNode(String, SlashCommandDefinition, List<TreeNode>) - Constructor for record class com.github.kaktushose.jda.commands.internal.register.TreeNode
-
Creates an instance of a
TreeNoderecord class. - type() - Element in annotation interface com.github.kaktushose.jda.commands.annotations.interactions.Command
-
Gets the type of this command.
- type() - Element in annotation interface com.github.kaktushose.jda.commands.annotations.interactions.Param
-
Returns the
OptionTypeof this command option. - type() - Method in record class com.github.kaktushose.jda.commands.definitions.description.AnnotationDescription
- type() - Method in record class com.github.kaktushose.jda.commands.definitions.description.ParameterDescription
-
Returns the value of the
typerecord component. - type() - Method in record class com.github.kaktushose.jda.commands.extension.Implementation
-
Returns the value of the
typerecord component. - TypeAdapter<S,
T> - Interface in com.github.kaktushose.jda.commands.dispatching.adapter -
Generic top level interface for type adapting.
- TypeAdapterContainer(Type<S>, Type<T>, TypeAdapter<S, T>) - Constructor for record class com.github.kaktushose.jda.commands.extension.Implementation.TypeAdapterContainer
-
Creates an instance of a
TypeAdapterContainerrecord class. - typeAdapters - Variable in class com.github.kaktushose.jda.commands.extension.JDACBuilderData
- typeAdapters() - Method in class com.github.kaktushose.jda.commands.extension.JDACBuilderData
- TypeAdapters - Class in com.github.kaktushose.jda.commands.dispatching.adapter.internal
-
Central registry for all type adapters.
- TypeAdapters(Map<Map.Entry<Type<?>, Type<?>>, TypeAdapter<?, ?>>) - Constructor for class com.github.kaktushose.jda.commands.dispatching.adapter.internal.TypeAdapters
-
Constructs a new TypeAdapters.
- typeArguments() - Method in record class com.github.kaktushose.jda.commands.definitions.description.ParameterDescription
-
Returns the value of the
typeArgumentsrecord component.
U
- UnspecificComponent - Class in com.github.kaktushose.jda.commands.dispatching.reply.dynamic.internal
- UnspecificComponent(boolean, boolean, String, Class<?>, Entry[]) - Constructor for class com.github.kaktushose.jda.commands.dispatching.reply.dynamic.internal.UnspecificComponent
- updateAllCommands() - Method in class com.github.kaktushose.jda.commands.internal.register.SlashCommandUpdater
-
Sends the
SlashCommandDatato Discord. - updateGlobalCommands() - Method in class com.github.kaktushose.jda.commands.internal.register.SlashCommandUpdater
-
Registers all
CommandDefinitions withCommandScope.GLOBAL. - updateGuildCommands() - Method in class com.github.kaktushose.jda.commands.internal.register.SlashCommandUpdater
-
Sends the guild scope
SlashCommandDatato Discord. - updateGuildCommands() - Method in class com.github.kaktushose.jda.commands.JDACommands
-
Updates all slash commands that are registered with
CommandScope.GUILD - url(String) - Method in class com.github.kaktushose.jda.commands.embeds.Embed
-
Sets the URL of the embed.
- url(String) - Method in class com.github.kaktushose.jda.commands.dispatching.reply.dynamic.ButtonComponent
V
- validator() - Method in record class com.github.kaktushose.jda.commands.definitions.interactions.command.OptionDataDefinition.ConstraintDefinition
-
Returns the value of the
validatorrecord component. - validator() - Method in record class com.github.kaktushose.jda.commands.extension.Implementation.ValidatorContainer
-
Returns the value of the
validatorrecord component. - validator(Class<? extends Annotation>, Validator<?, ?>) - Method in class com.github.kaktushose.jda.commands.JDACBuilder
- Validator<T,
A> - Interface in com.github.kaktushose.jda.commands.dispatching.validation -
Validators check if a command option fulfills the given constraint.
- Validator.Context - Class in com.github.kaktushose.jda.commands.dispatching.validation
-
This context provides access to the
InvocationContextof this interaction and has some utility methods useful for error messages. - ValidatorContainer(Class<? extends Annotation>, Validator<?, ?>) - Constructor for record class com.github.kaktushose.jda.commands.extension.Implementation.ValidatorContainer
-
Creates an instance of a
ValidatorContainerrecord class. - validators - Variable in class com.github.kaktushose.jda.commands.extension.JDACBuilderData
- validators() - Method in record class com.github.kaktushose.jda.commands.definitions.interactions.InteractionRegistry
-
Returns the value of the
validatorsrecord component. - validators() - Method in record class com.github.kaktushose.jda.commands.definitions.interactions.MethodBuildContext
-
Returns the value of the
validatorsrecord component. - validators() - Method in class com.github.kaktushose.jda.commands.extension.JDACBuilderData
- Validators - Class in com.github.kaktushose.jda.commands.dispatching.validation.internal
-
Central registry for all
Validators. - Validators(Map<Class<? extends Annotation>, Validator<?, ?>>) - Constructor for class com.github.kaktushose.jda.commands.dispatching.validation.internal.Validators
-
Constructs a new Validators.
- 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.Perm
-
Returns the discord permission(s) the element must have.
- value() - Element in annotation interface com.github.kaktushose.jda.commands.annotations.i18n.Bundle
-
the name of the bundle to use
- 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.Command
-
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.SelectTargets. - 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.MenuOption
-
Gets the value of an option.
- value() - Element in annotation interface com.github.kaktushose.jda.commands.annotations.interactions.MenuOptionContainer
- 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.Param
-
Returns the description of the command option.
- 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.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 label shown above this text input box.
- value() - Method in record class com.github.kaktushose.jda.commands.definitions.description.AnnotationDescription
-
Returns the value of the
valuerecord component. - value() - Method in record class com.github.kaktushose.jda.commands.definitions.interactions.component.menu.StringSelectMenuDefinition.MenuOptionDefinition
-
Returns the value of the
valuerecord component. - value() - Method in record class com.github.kaktushose.jda.commands.message.placeholder.Entry
-
Returns the value of the
valuerecord 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.
- valueOf(String) - Static method in enum class com.github.kaktushose.jda.commands.JDACBuilder.FilterStrategy
-
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() - Static method in enum class com.github.kaktushose.jda.commands.JDACBuilder.FilterStrategy
-
Returns an array containing the constants of this enum class, in the order they are declared.
W
- with() - Method in class com.github.kaktushose.jda.commands.dispatching.events.ReplyableEvent
-
Entry point for configuring a reply.
- with(String, List<ModalDefinition.TextInputDefinition>) - Method in record class com.github.kaktushose.jda.commands.definitions.interactions.ModalDefinition
-
Builds a new
ModalDefinitionwith the given values. - with(String, Emoji, String, ButtonStyle) - Method in record class com.github.kaktushose.jda.commands.definitions.interactions.component.ButtonDefinition
-
Builds a new
ButtonDefinitionwith the given values - with(Set<EntitySelectMenu.SelectTarget>, Set<EntitySelectMenu.DefaultValue>, Set<ChannelType>, String, Integer, Integer) - Method in record class com.github.kaktushose.jda.commands.definitions.interactions.component.menu.EntitySelectMenuDefinition
-
Builds a new
EntitySelectMenuDefinitionwith the given values. - with(Set<SelectOption>, Collection<String>, String, Integer, Integer) - Method in record class com.github.kaktushose.jda.commands.definitions.interactions.component.menu.StringSelectMenuDefinition
-
Builds a new
StringSelectMenuDefinitionwith the given values. - with(TextInput.Builder) - Method in record class com.github.kaktushose.jda.commands.definitions.interactions.ModalDefinition.TextInputDefinition
-
Builds a new
ModalDefinition.TextInputDefinitionfrom the givenTextInput.Builder.
All Classes and Interfaces|All Packages|Constant Field Values|Serialized Form