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

ModalBuilder

abstract class ModalBuilder : Modal.Builder(source)

Functions

addActionRow

@Nonnull

open fun addActionRow(@Nonnull vararg p0: ItemComponent): Modal.Builder

@Nonnull

open fun addActionRow(@Nonnull p0: MutableCollection<out ItemComponent>): Modal.Builder

addComponents

@Nonnull

open fun addComponents(@Nonnull vararg p0: LayoutComponent): Modal.Builder

@Nonnull

open fun addComponents(@Nonnull p0: MutableCollection<out LayoutComponent>): Modal.Builder

bindTo

@CheckReturnValue

fun bindTo(handler: Consumer<ModalEvent>): ModalBuilder

Binds the action to the consumer.

abstract fun bindTo(handler: suspend (ModalEvent) -> Unit): ModalBuilder

Binds the action to the closure.

@CheckReturnValue

fun bindTo(handlerName: String, vararg userData: Any?): ModalBuilder

@CheckReturnValue

abstract fun bindTo(handlerName: String, userData: List<Any?>): ModalBuilder

Binds the action to a @ModalHandler with its arguments.

build

@CheckReturnValue

abstract override fun build(): Modal

getComponents

@Nonnull

open fun getComponents(): MutableList<LayoutComponent>

getId

@Nonnull

open fun getId(): String

getTitle

@Nonnull

open fun getTitle(): String

paragraphTextInput

fun ModalBuilder.paragraphTextInput(inputName: String, label: String, block: TextInputBuilder.() -> Unit = {}): TextInput

setId

abstract override fun ~~setId~~(customId: String): ModalBuilder

setTitle

@Nonnull

open fun setTitle(@Nonnull p0: String): Modal.Builder

shortTextInput

fun ModalBuilder.shortTextInput(inputName: String, label: String, block: TextInputBuilder.() -> Unit = {}): TextInput

textInput

fun ModalBuilder.textInput(inputName: String, label: String, inputStyle: TextInputStyle, block: TextInputBuilder.() -> Unit = {}): TextInput

timeout

@JvmOverloads

@CheckReturnValue

fun timeout(timeout: Duration, onTimeout: Runnable? = null): ModalBuilder

abstract fun timeout(timeout: Duration, onTimeout: suspend () -> Unit? = null): ModalBuilder

@JvmOverloads

@CheckReturnValue

fun timeout(timeout: Long, unit: TimeUnit, onTimeout: Runnable? = null): ModalBuilder

Sets the timeout for this modal, invalidating the modal after expiration, and running the given timeout handler.