kord-extensions/dev.kordex.core.components.forms.widgets.menus/ChannelSelectMenuWidget

ChannelSelectMenuWidget

class ChannelSelectMenuWidget : SelectMenuWidget<Snowflake, ChannelSelectMenuWidget> , ChannelSelectMenu

A select widget that supports channels as options.

Constructors

Link copied to clipboard
constructor()

Properties

Link copied to clipboard
open override var channelTypes: MutableList<ChannelType>

The types allowed in the select menu.

Link copied to clipboard
open override var defaultChannels: MutableList<Snowflake>

Default channels to preselect.

Link copied to clipboard
open override var description: Key?

An optional description for the Widget. Displayed on Discord.

Link copied to clipboard
open override var height: Int

How tall this widget is, in grid cells.

Link copied to clipboard
var id: String

The widget's unique ID on Discord, defaulting to a UUID.

Link copied to clipboard
open lateinit override var label: Key

The Widget's label, displayed on Discord.

Link copied to clipboard
var maxValues: Int

The maximum number of items that can be chosen. Default: 1.

Link copied to clipboard
var minValues: Int

The minimum number of items that must be chosen. Default: 1.

Link copied to clipboard
var placeholder: Key?

Placeholder text if nothing is selected, to be shown to the user on Discord.

Link copied to clipboard
var required: Boolean

Whether this widget must be filled out for the form to be valid.

Link copied to clipboard
open override var value: List<Snowflake?>

The final value stored in this widget, as provided by the user.

Link copied to clipboard
open override var width: Int

How wide this widget is, in grid cells.

Functions

Link copied to clipboard
open suspend override fun apply(builder: LabelComponentBuilder, locale: Locale)

Function called to apply this widget to a Discord action row.

Link copied to clipboard
open fun applyChannelSelectMenu(selectMenu: SelectMenu<*, *>, builder: ActionRowBuilder)

Apply the channel select menu to an action row builder.

Link copied to clipboard
open fun channelType(vararg types: ChannelType)

Add an allowed channel type to the selector.

Link copied to clipboard
open fun defaultChannel(vararg channels: Snowflake)
open fun defaultChannel(vararg channels: ChannelBehavior)
open fun defaultChannel(channels: Collection<Snowflake>)

Add default pre-selected channels to the selector.

Link copied to clipboard
open override fun getKoin(): Koin

Get the associated Koin instance.

Link copied to clipboard
open override fun toString(): String
Link copied to clipboard
open override fun validate()

Function called to ensure that this widget was set up correctly.