io.github.freya022.botcommands.api.modals.annotations.ModalInput.kt Maven / Gradle / Ivy

Go to download

Show more of this group Show more artifacts with this name
Show all versions of BotCommands Show documentation

A Kotlin-first (and Java) framework that makes creating Discord bots a piece of cake, using the JDA library.

There is a newer version: 3.0.0-alpha.18

package io.github.freya022.botcommands.api.modals.annotations

import io.github.freya022.botcommands.api.modals.Modals

/**
 * Set this parameter as a modal input.
 *
 * The specified input name must be the same as the input name given in, for example, [Modals.createTextInput].
 *
 * @see ModalData @ModalData
 * @see ModalHandler @ModalHandler
 */
@Target(AnnotationTarget.VALUE_PARAMETER)
@Retention(AnnotationRetention.RUNTIME)
annotation class ModalInput(
    /**
     * The name of the modal input.

     * Must match the input name provided in, for example, [Modals.createTextInput].
     */
    @get:JvmName("value") val name: String
)