BotCommands-core/io.github.freya022.botcommands.api.modals.annotations/ModalInput

ModalInput

@Target(allowedTargets = [AnnotationTarget.VALUE_PARAMETER])

annotation class ModalInput(val customId: String)(source)

Set this parameter as a modal input.

The specified input custom ID must be the same as the custom ID of a component in that modal. If an input with the specified custom ID cannot be found (i.e. the modal didn't have that input at all), and the parameter is neither nullable nor optional, an exception will be thrown.

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

Properties

customId

@get:JvmName(name = "value")

val customId: String

The custom ID this modal input will match against.

ModalInput

See also

Properties