kord-extensions/dev.kordex.core.components/ComponentContainer

ComponentContainer

open class ComponentContainer(val timeout: Duration? = null, startTimeoutNow: Boolean = false) : KordExKoinComponent

Class representing a single set of components that can be applied to any message.

A timeout is supported by this class. If a timeout is provided, the components stored within this container will be unregistered from the ComponentRegistry. If this container contains actionable components, the timeout will be reset whenever an actionable component is interacted with.

The startTimeoutNow parameter defaults to false, but will be set to true automatically if you're using a components DSL function provided in the message creation/modification builders. When this is true, the timeout task will be started immediately - when it's false, you'll have to call the timeoutTask start function yourself.

Parameters

timeout

Optional timeout duration.

startTimeoutNow

Whether to start the timeout immediately.

Constructors

ComponentContainer

constructor(timeout: Duration? = null, startTimeoutNow: Boolean = false)

Properties

rows

open val rows: Array<MutableList<Component>>

Array containing sorted rows of components.

timeout

val timeout: Duration? = null

timeoutCallback

open var timeoutCallback: suspend ComponentContainer.() -> Unit?

Extra callback to run when this container times out, if any.

timeoutTask

open val timeoutTask: Task?

If a timeout was provided, the scheduled timeout task will be stored here.

unsortedComponents

open val unsortedComponents: MutableList<Component>

Components that haven't been sorted into rows by sort yet.

Functions

add

open suspend fun add(component: Component, rowNum: Int? = null)

Add a component. New components will be unsorted, or placed in the numbered row denoted by rowNum if possible.

applyToMessage

open suspend fun MessageBuilder.applyToMessage()

Apply the components in this container to a message that's being created or edited.

cancel

open suspend fun cancel()

Cancel the timeout task, and remove all components from this component container.

disabledButton

suspend fun ComponentContainer.disabledButton(row: Int? = null, builder: suspend DisabledInteractionButton.() -> Unit): DisabledInteractionButton

DSL function for creating a disabled button and adding it to the current ComponentContainer.

ephemeralButton

suspend fun ComponentContainer.ephemeralButton(row: Int? = null, builder: suspend EphemeralInteractionButton<ModalForm>.() -> Unit): EphemeralInteractionButton<ModalForm>

DSL function for creating an ephemeral button and adding it to the current ComponentContainer.

suspend fun <M : ModalForm> ComponentContainer.ephemeralButton(modal: () -> M?, row: Int? = null, builder: suspend EphemeralInteractionButton<M>.() -> Unit): EphemeralInteractionButton<M>

DSL function for creating an ephemeral button with modal, and adding it to the current ComponentContainer.

ephemeralChannelSelectMenu

suspend fun ComponentContainer.ephemeralChannelSelectMenu(row: Int? = null, builder: suspend EphemeralChannelSelectMenu<ModalForm>.() -> Unit): EphemeralChannelSelectMenu<ModalForm>

suspend fun <M : ModalForm> ComponentContainer.ephemeralChannelSelectMenu(modal: () -> M?, row: Int? = null, builder: suspend EphemeralChannelSelectMenu<M>.() -> Unit): EphemeralChannelSelectMenu<M>

DSL function for creating an ephemeral channel select menu and adding it to the current ComponentContainer.

ephemeralMentionableSelectMenu

suspend fun ComponentContainer.ephemeralMentionableSelectMenu(row: Int? = null, builder: suspend EphemeralMentionableSelectMenu<ModalForm>.() -> Unit): EphemeralMentionableSelectMenu<ModalForm>

suspend fun <M : ModalForm> ComponentContainer.ephemeralMentionableSelectMenu(modal: () -> M?, row: Int? = null, builder: suspend EphemeralMentionableSelectMenu<M>.() -> Unit): EphemeralMentionableSelectMenu<M>

DSL function for creating an ephemeral mentionable select menu, and adding it to the current ComponentContainer.

ephemeralRoleSelectMenu

suspend fun ComponentContainer.ephemeralRoleSelectMenu(row: Int? = null, builder: suspend EphemeralRoleSelectMenu<ModalForm>.() -> Unit): EphemeralRoleSelectMenu<ModalForm>

suspend fun <M : ModalForm> ComponentContainer.ephemeralRoleSelectMenu(modal: () -> M?, row: Int? = null, builder: suspend EphemeralRoleSelectMenu<M>.() -> Unit): EphemeralRoleSelectMenu<M>

DSL function for creating an ephemeral role select menu and adding it to the current ComponentContainer.

ephemeralStringSelectMenu

suspend fun ComponentContainer.ephemeralStringSelectMenu(row: Int? = null, builder: suspend EphemeralStringSelectMenu<ModalForm>.() -> Unit): EphemeralStringSelectMenu<ModalForm>

suspend fun <M : ModalForm> ComponentContainer.ephemeralStringSelectMenu(modal: () -> M?, row: Int? = null, builder: suspend EphemeralStringSelectMenu<M>.() -> Unit): EphemeralStringSelectMenu<M>

DSL function for creating an ephemeral string select menu and adding it to the current ComponentContainer.

ephemeralUserSelectMenu

suspend fun ComponentContainer.ephemeralUserSelectMenu(row: Int? = null, builder: suspend EphemeralUserSelectMenu<ModalForm>.() -> Unit): EphemeralUserSelectMenu<ModalForm>

suspend fun <M : ModalForm> ComponentContainer.ephemeralUserSelectMenu(modal: () -> M?, row: Int? = null, builder: suspend EphemeralUserSelectMenu<M>.() -> Unit): EphemeralUserSelectMenu<M>

DSL function for creating an ephemeral user select menu and adding it to the current ComponentContainer.

getKoin

open override fun getKoin(): Koin

Get the associated Koin instance.

linkButton

suspend fun ComponentContainer.linkButton(row: Int? = null, builder: suspend LinkInteractionButton.() -> Unit): LinkInteractionButton

DSL function for creating a link button and adding it to the current ComponentContainer.

onTimeout

open fun onTimeout(callback: suspend ComponentContainer.() -> Unit)

publicButton

suspend fun ComponentContainer.publicButton(row: Int? = null, builder: suspend PublicInteractionButton<ModalForm>.() -> Unit): PublicInteractionButton<ModalForm>

DSL function for creating a public button and adding it to the current ComponentContainer.

suspend fun <M : ModalForm> ComponentContainer.publicButton(modal: () -> M?, row: Int? = null, builder: suspend PublicInteractionButton<M>.() -> Unit): PublicInteractionButton<M>

DSL function for creating a public button with modal, and adding it to the current ComponentContainer.

publicChannelSelectMenu

suspend fun ComponentContainer.publicChannelSelectMenu(row: Int? = null, builder: suspend PublicChannelSelectMenu<ModalForm>.() -> Unit): PublicChannelSelectMenu<ModalForm>

suspend fun <M : ModalForm> ComponentContainer.publicChannelSelectMenu(modal: () -> M?, row: Int? = null, builder: suspend PublicChannelSelectMenu<M>.() -> Unit): PublicChannelSelectMenu<M>

DSL function for creating a public channel select menu and adding it to the current ComponentContainer.

publicMentionableSelectMenu

suspend fun ComponentContainer.publicMentionableSelectMenu(row: Int? = null, builder: suspend PublicMentionableSelectMenu<ModalForm>.() -> Unit): PublicMentionableSelectMenu<ModalForm>

suspend fun <M : ModalForm> ComponentContainer.publicMentionableSelectMenu(modal: () -> M?, row: Int? = null, builder: suspend PublicMentionableSelectMenu<M>.() -> Unit): PublicMentionableSelectMenu<M>

DSL function for creating a public mentionable select menu and adding it to the current ComponentContainer.

publicRoleSelectMenu

suspend fun ComponentContainer.publicRoleSelectMenu(row: Int? = null, builder: suspend PublicRoleSelectMenu<ModalForm>.() -> Unit): PublicRoleSelectMenu<ModalForm>

suspend fun <M : ModalForm> ComponentContainer.publicRoleSelectMenu(modal: () -> M?, row: Int? = null, builder: suspend PublicRoleSelectMenu<M>.() -> Unit): PublicRoleSelectMenu<M>

DSL function for creating a public role select menu and adding it to the current ComponentContainer.

publicStringSelectMenu

suspend fun ComponentContainer.publicStringSelectMenu(row: Int? = null, builder: suspend PublicStringSelectMenu<ModalForm>.() -> Unit): PublicStringSelectMenu<ModalForm>

suspend fun <M : ModalForm> ComponentContainer.publicStringSelectMenu(modal: () -> M?, row: Int? = null, builder: suspend PublicStringSelectMenu<M>.() -> Unit): PublicStringSelectMenu<M>

DSL function for creating a public string select menu and adding it to the current ComponentContainer.

publicUserSelectMenu

suspend fun ComponentContainer.publicUserSelectMenu(row: Int? = null, builder: suspend PublicUserSelectMenu<ModalForm>.() -> Unit): PublicUserSelectMenu<ModalForm>

suspend fun <M : ModalForm> ComponentContainer.publicUserSelectMenu(modal: () -> M?, row: Int? = null, builder: suspend PublicUserSelectMenu<M>.() -> Unit): PublicUserSelectMenu<M>

DSL function for creating a public user select menu and adding it to the current ComponentContainer.

remove

open suspend fun remove(component: Component): Boolean

Remove the given component, and unregister it from the ComponentRegistry.

removeAll

open suspend fun removeAll()

Remove all components, and unregister them from the ComponentRegistry.

replace

open suspend fun replace(old: Component, new: Component): Boolean

Given two components, replace the old component with the new one and likewise handle registration.

open suspend fun replace(id: String, new: Component): Boolean

Given an old component ID and new component, replace the old component with the new one and likewise handle registration.

sort

open suspend fun sort()

Sort all components in unsortedComponents by packing them into rows as tightly as possible.