3.0.0-beta.5

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

StringSelectMenu

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

Properties

abstract val group: ComponentGroup?

abstract val internalId: 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 override fun createCopy(): StringSelectMenu.Builder

@Nonnull

abstract override fun getCustomId(): String

@Nullable

@ReplaceWith(value = "getCustomId()")

open fun ~~getId~~(): String?

abstract fun getMaxValues(): Int

abstract fun getMinValues(): Int

@Nonnull

abstract fun getOptions(): MutableList<SelectOption>

@Nullable

abstract fun getPlaceholder(): String?

@Nonnull

abstract fun getType(): Component.Type

abstract fun getUniqueId(): Int

abstract override fun isDisabled(): Boolean

open fun isEnabled(): Boolean

isMessageCompatible

open fun isMessageCompatible(): Boolean

isModalCompatible

open fun isModalCompatible(): Boolean

toIdentifiableComponent

fun ActionComponent.toIdentifiableComponent(): IdentifiableComponent

toIdentifiableComponentOrNull

fun ActionComponent.toIdentifiableComponentOrNull(): IdentifiableComponent?

abstract override fun withDisabled(disabled: Boolean): StringSelectMenu

abstract override fun withUniqueId(uniqueId: Int): StringSelectMenu