kord-extensions/dev.kordex.core.components.forms/ModalForm

ModalForm

abstract class ModalForm : Form, KordExKoinComponent

Class representing a modal form.

This should be extended by classes representing individual modals.

Constructors

ModalForm

constructor()

Properties

grid

open val grid: WidgetGrid

A grid containing rows of widgets.

var id: String

ID representing this modal on Discord.

timeout

open override val timeout: Duration

How long to wait before we stop waiting for this modal to be submitted.

title

abstract var title: Key

The modal's title, shown on Discord.

Functions

applyToBuilder

suspend fun applyToBuilder(builder: ModalBuilder, locale: Locale)

Given a ModalBuilder, apply this modal's widgets for display on Discord.

awaitCompletion

suspend fun <T> awaitCompletion(callback: suspend (ModalSubmitInteraction?) -> T): T

Wait for this modal to be completed and call the callback. Parameter will be null if timed out.

getKoin

open override fun getKoin(): Koin

Get the associated Koin instance.

lineText

fun lineText(coordinate: CoordinatePair? = null, builder: LineTextWidget.() -> Unit): LineTextWidget

A widget representing a single-line text input.

paragraphText

fun paragraphText(coordinate: CoordinatePair? = null, builder: ParagraphTextWidget.() -> Unit): ParagraphTextWidget

A widget representing a multi-line paragraph input.

sendAndAwait

suspend fun <T> sendAndAwait(context: ApplicationCommandContext, callback: suspend (ModalSubmitInteraction?) -> T): T

Convenience function that calls the basic sendAndAwait function with parameters taken from the current command context.

suspend fun <T> sendAndAwait(context: ComponentContext<*>, callback: suspend (ModalSubmitInteraction?) -> T): T

Convenience function that calls the basic sendAndAwait function with parameters taken from the current component context.

suspend fun <T, E : InteractionCreateEvent> sendAndAwait(context: EventContext<E>, callback: suspend (ModalSubmitInteraction?) -> T): T

Convenience function that calls the basic sendAndAwait function with parameters taken from the current event context.

suspend fun <T> sendAndAwait(locale: Locale, interaction: ModalParentInteractionBehavior, callback: suspend (ModalSubmitInteraction?) -> T): T

Convenience function to send this modal to the given interaction and await its completion, running the provided callback.

sendAndDeferEphemeral

suspend fun sendAndDeferEphemeral(context: ApplicationCommandContext): EphemeralMessageInteractionResponseBehavior?

suspend fun sendAndDeferEphemeral(context: ComponentContext<*>): EphemeralMessageInteractionResponseBehavior?

suspend fun <E : InteractionCreateEvent> sendAndDeferEphemeral(context: EventContext<E>): EphemeralMessageInteractionResponseBehavior?

Convenience function that sends the modal, awaits its completion, and returns a deferred ephemeral interaction response.

sendAndDeferPublic

suspend fun sendAndDeferPublic(context: ApplicationCommandContext): PublicMessageInteractionResponseBehavior?

suspend fun sendAndDeferPublic(context: ComponentContext<*>): PublicMessageInteractionResponseBehavior?

suspend fun <E : InteractionCreateEvent> sendAndDeferPublic(context: EventContext<E>): PublicMessageInteractionResponseBehavior?

Convenience function that sends the modal, awaits its completion, and returns a deferred public interaction response.

translateTitle

fun translateTitle(locale: Locale): String

Return a translated modal title using the given locale.