com.freya02.botcommands.api.commands.application.annotations.AppOption Maven / Gradle / Ivy
package com.freya02.botcommands.api.commands.application.annotations;
import com.freya02.botcommands.api.commands.CommandPath;
import com.freya02.botcommands.api.commands.annotations.Optional;
import com.freya02.botcommands.api.commands.application.GuildApplicationSettings;
import com.freya02.botcommands.api.commands.application.slash.annotations.*;
import com.freya02.botcommands.api.commands.application.slash.autocomplete.annotations.AutocompleteHandler;
import com.freya02.botcommands.api.core.config.BApplicationConfigBuilder;
import com.freya02.botcommands.api.parameters.SlashParameterResolver;
import com.freya02.botcommands.internal.annotations.DiscordNamePattern;
import net.dv8tion.jda.api.entities.Guild;
import net.dv8tion.jda.api.interactions.DiscordLocale;
import net.dv8tion.jda.api.interactions.commands.OptionType;
import net.dv8tion.jda.api.interactions.commands.build.OptionData;
import net.dv8tion.jda.api.interactions.commands.localization.LocalizationFunction;
import org.jetbrains.annotations.Nullable;
import java.lang.annotation.ElementType;
import java.lang.annotation.Retention;
import java.lang.annotation.RetentionPolicy;
import java.lang.annotation.Target;
/**
* Annotation used to specify an application command parameter is supplied from Discord.
*
This also can set name and description of {@linkplain JDASlashCommand slash commands} parameters.
*
* {@linkplain #name()} is optional if the parameter name is available (add -parameters to your java compiler)
*
* @see Optional @Optional
* @see Nullable @Nullable (same as @Optional but better)
* @see LongRange @LongRange
* @see DoubleRange @DoubleRange
* @see Length @Length
* @see ChannelTypes @ChannelTypes
* @see AutocompleteHandler @AutocompleteHandler
* @see VarArgs @VarArgs
*/
@Retention(RetentionPolicy.RUNTIME)
@Target({ElementType.PARAMETER})
public @interface AppOption { //TODO separate this into specialised options, why use AppOption for things that don't support descriptions / autocomplete ?
/**
* Name of the option, must follow the Discord specifications, see {@link OptionData#OptionData(OptionType, String, String)} for details.
*
*
* This can be a localization property, see {@link LocalizationFunction} on how options are mapped.
*
This is optional if the parameter name is found, see the wiki for more details.
*
* @return Name of the option
*/
@DiscordNamePattern
String name() default "";
/**
* Description of the option, must follow the Discord specifications, see {@link OptionData#OptionData(OptionType, String, String)} for details.
*
*
* If this description is omitted, a default localization is
* searched in {@link BApplicationConfigBuilder#addLocalizations(String, DiscordLocale...) the command localization bundles}
* using the root locale, for example: MyCommands.json.
*
If none is found then it is defaulted to "No Description".
*
*
* This can be a localization property, see {@link LocalizationFunction} on how options are mapped, example: ban.options.user.description.
*
This is optional if the parameter is not a slash command parameter.
*
* @return Description of the option
*/
String description() default "";
/**
* Enables using choices from {@link SlashParameterResolver#getPredefinedChoices(Guild)}.
*
*
Note: Predefined choices can still be overridden by {@link GuildApplicationSettings#getOptionChoices(Guild, CommandPath, String)}.
*
* @return {@code true} to enable using choices from {@link SlashParameterResolver#getPredefinedChoices(Guild)}
*/
boolean usePredefinedChoices() default false;
/**
* Name of the autocomplete handler, must match a method annotated with {@link AutocompleteHandler} with the same name in it
*/
String autocomplete() default "";
}