BotCommands-core/io.github.freya022.botcommands.api.commands.text.annotations/TextOption

TextOption

@Target(allowedTargets = [AnnotationTarget.VALUE_PARAMETER])
annotation class TextOption(val name: String = "", val example: String = "")(source)

Sets a parameter as a text command option from the Discord message.

This also can set name and example of text commands parameters.

The supported data types can be seen in TextParameterResolver, more types can be supported by implementing it.

See also

@Optional

@Nullable

@ID

Properties

Link copied to clipboard
val example: String

The example input of this option displayed on the help content.

Link copied to clipboard
val name: String

The name of this option displayed on the help content.