BotCommands/io.github.freya022.botcommands.api.modals.annotations

Package-level declarations

Types

Link copied to clipboard
@Target(allowedTargets = [AnnotationTarget.VALUE_PARAMETER])
annotation class ModalData

Sets this parameter as data coming from ModalBuilder.bindTo.

Link copied to clipboard
@Target(allowedTargets = [AnnotationTarget.FUNCTION])
annotation class ModalHandler(val name: String)

Declares this function as a modal handler for the specified modal name.

Link copied to clipboard
@Target(allowedTargets = [AnnotationTarget.VALUE_PARAMETER])
annotation class ModalInput(val name: String)

Set this parameter as a modal input.

Link copied to clipboard
@Target(allowedTargets = [AnnotationTarget.CLASS, AnnotationTarget.FUNCTION, AnnotationTarget.PROPERTY_GETTER, AnnotationTarget.ANNOTATION_CLASS])
@Condition(type = RequiresModalsChecker::class)
@ConditionalOnProperty(value = ["botcommands.modals.enable"], matchIfMissing = true)
annotation class RequiresModals

Prevents usage of the annotated service if modals are not enabled.