BotCommands/io.github.freya022.botcommands.api.commands.text.annotations/TextCommandData

TextCommandData

@Target(allowedTargets = [AnnotationTarget.FUNCTION])
annotation class TextCommandData(val path: Array<out String> = [], val aliases: Array<String> = [], val description: String = "")(source)

Additional annotation for text commands.

This is only used to specify properties on the annotated text command, if the path this annotation applies to is omitted, then the path of the variation is used.

This can be specified at most once per slash command path, e.g., if you have tag create and tag edit, you can annotate at most one of them.

See also

@JDATextCommandVariation

@BotPermissions

@UserPermissions

@RateLimit

Properties

Link copied to clipboard
val aliases: Array<String>

Alternative names for this command's path fragment, must not contain any spaces, and must follow the same format as slash commands such as name group subcommand

Link copied to clipboard
val description: String

Short description of the command, displayed in the description of the built-in help command.

Link copied to clipboard
val path: Array<out String>

Path components of the command this annotation applies to, limited to three components and composed of a-zA-Z1-9_-