BotCommands-core/io.github.freya022.botcommands.api.components/StringSelectMenu

StringSelectMenu

interface StringSelectMenu : StringSelectMenu, AwaitableComponent<StringSelectEvent> , IGroupHolder(source)

Properties

@get:Nonnull

abstract val customId: String

abstract val group: ComponentGroup?

abstract val internalId: Int

abstract val isDisabled: Boolean

open val isEnabled: Boolean

isMessageCompatible

open val isMessageCompatible: Boolean

isModalCompatible

open val isModalCompatible: Boolean

@get:Nullable

abstract val isRequired: Boolean?

abstract val maxValues: Int

abstract val minValues: Int

@get:Nonnull

abstract val options: List<SelectOption?>

@get:Nullable

abstract val placeholder: String?

@get:Nonnull

abstract val type: Component.Type

abstract val uniqueId: Int

Functions

open override fun asDisabled(): StringSelectMenu

open override fun asEnabled(): StringSelectMenu

abstract suspend fun await(): StringSelectEvent

Suspends until the component is used and all checks passed, and returns the event.

suspend fun <T : ComponentInteraction> AwaitableComponent<T>.awaitOrNull(): T?

Suspends until the component is used and all checks passed, and returns the event, or null if the timeout has been reached.

@Nonnull

@CheckReturnValue

open fun createCopy(): StringSelectMenu.Builder

toIdentifiableComponent

fun ICustomId.toIdentifiableComponent(): IdentifiableComponent

toIdentifiableComponentOrNull

fun ICustomId.toIdentifiableComponentOrNull(): IdentifiableComponent?

abstract override fun withDisabled(disabled: Boolean): StringSelectMenu

abstract override fun withUniqueId(uniqueId: Int): StringSelectMenu