3.0.0-beta.6

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

ModalBuilder

abstract class ModalBuilder : Modal.Builder(source)

Properties

abstract val modals: Modals

Functions

open override fun addComponents(vararg components: ModalTopLevelComponent): ModalBuilder

open override fun addComponents(components: Collection<ModalTopLevelComponent>): ModalBuilder

open override fun addComponents(tree: ComponentTree<out ModalTopLevelComponent>): ModalBuilder

@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.

@CheckReturnValue

abstract override fun build(): Modal

@Nonnull

open fun getComponents(): MutableList<ModalTopLevelComponentUnion>

@Nonnull

open fun getId(): String

@Nonnull

open fun getTitle(): String

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

open override fun setTitle(title: String): ModalBuilder

@CheckReturnValue

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

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

@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.