BotCommands-core/io.github.freya022.botcommands.api.components.builder.select.ephemeral/EphemeralStringSelectBuilder

EphemeralStringSelectBuilder

abstract class EphemeralStringSelectBuilder : StringSelectMenu.Builder, BaseComponentBuilder<EphemeralStringSelectBuilder> , IConstrainableComponent<EphemeralStringSelectBuilder> , IUniqueComponent<EphemeralStringSelectBuilder> , IEphemeralActionableComponent<EphemeralStringSelectBuilder, StringSelectEvent> , IEphemeralTimeoutableComponent<EphemeralStringSelectBuilder> (source)

Constructors

constructor()

Properties

constraints

abstract var constraints: InteractionConstraints

context

abstract override val context: BContext

customId

@get:Nonnull

open override var customId: String

filters

abstract val filters: MutableList<ComponentInteractionFilter>

List of filters applied to this component.

isDisabled

@set:Nonnull

open override var isDisabled: Boolean

isRequired

@get:Nullable

@set:Nonnull

open override var isRequired: Boolean?

maxValues

@set:Nonnull

open override var maxValues: Int

minValues

@set:Nonnull

open override var minValues: Int

options

@get:Nonnull

open val options: List<SelectOption?>

placeholder

@get:Nullable

@set:Nonnull

open override var placeholder: String?

resetTimeoutOnUse

abstract var resetTimeoutOnUse: Boolean

When true, resets the timeout duration everytime this component is used.

singleUse

abstract var singleUse: Boolean

Sets this component as being usable once.

uniqueId

@set:Nonnull

open override var uniqueId: Int

Functions

addFilter

@CheckReturnValue

abstract fun addFilter(filter: ComponentInteractionFilter): EphemeralStringSelectBuilder

@CheckReturnValue

abstract fun addFilter(filterType: Class<out ComponentInteractionFilter>): EphemeralStringSelectBuilder

Applies a filter to this component.

addOption

@Nonnull

open fun addOption(@Nonnull label: String, @Nonnull value: String): StringSelectMenu.Builder

@Nonnull

open fun addOption(@Nonnull label: String, @Nonnull value: String, @Nonnull description: String): StringSelectMenu.Builder

@Nonnull

open fun addOption(@Nonnull label: String, @Nonnull value: String, @Nonnull emoji: Emoji): StringSelectMenu.Builder

@Nonnull

open fun addOption(@Nonnull label: String, @Nonnull value: String, @Nullable description: String?, @Nullable emoji: Emoji?): StringSelectMenu.Builder

addOptions

@Nonnull

open fun addOptions(@Nonnull options: Collection<out SelectOption?>): StringSelectMenu.Builder

@Nonnull

open fun addOptions(@Nonnull vararg options: SelectOption?): StringSelectMenu.Builder

addPermissions

@CheckReturnValue

abstract fun addPermissions(permissions: Collection<Permission>): EphemeralStringSelectBuilder

@CheckReturnValue

open fun addPermissions(vararg permissions: Permission): EphemeralStringSelectBuilder

Adds permissions to the constraints

addRoleIds

@CheckReturnValue

open fun addRoleIds(vararg roleIds: Long): EphemeralStringSelectBuilder

@CheckReturnValue

abstract fun addRoleIds(roleIds: Collection<Long>): EphemeralStringSelectBuilder

Adds role IDs to the constraints

addRoles

@CheckReturnValue

abstract fun addRoles(roles: Collection<Role>): EphemeralStringSelectBuilder

@CheckReturnValue

open fun addRoles(vararg roles: Role): EphemeralStringSelectBuilder

Adds role IDs to the constraints

addUserIds

@CheckReturnValue

open fun addUserIds(vararg userIds: Long): EphemeralStringSelectBuilder

@CheckReturnValue

abstract fun addUserIds(userIds: Collection<Long>): EphemeralStringSelectBuilder

Adds user IDs to the constraints

addUsers

@CheckReturnValue

abstract fun addUsers(users: Collection<UserSnowflake>): EphemeralStringSelectBuilder

@CheckReturnValue

open fun addUsers(vararg users: UserSnowflake): EphemeralStringSelectBuilder

Adds user IDs to the constraints

bindTo

@CheckReturnValue

open fun bindTo(handler: Consumer<StringSelectEvent>): EphemeralStringSelectBuilder

abstract fun bindTo(handler: suspend (StringSelectEvent) -> Unit): EphemeralStringSelectBuilder

Binds the given handler to this component.

build

abstract override fun build(): StringSelectMenu

constraints

@CheckReturnValue

abstract fun constraints(block: ReceiverConsumer<InteractionConstraints>): EphemeralStringSelectBuilder

Allows manipulating the InteractionConstraints instance

@CheckReturnValue

abstract fun constraints(constraints: InteractionConstraints): EphemeralStringSelectBuilder

Replaces the current interaction constraints with the given ones.

filter

inline fun <T : ComponentInteractionFilter> IActionableComponent<*>.filter(): T

Convenience extension to load an ComponentInteractionFilter service.

noTimeout

@CheckReturnValue

abstract fun noTimeout(): EphemeralStringSelectBuilder

Removes the timeout from this component.

rateLimitReference

@CheckReturnValue

abstract fun rateLimitReference(reference: ComponentRateLimitReference): EphemeralStringSelectBuilder

Sets the rate limiter of this component to one declared by a RateLimitProvider.

resetTimeoutOnUse

abstract fun resetTimeoutOnUse(resetTimeoutOnUse: Boolean): EphemeralStringSelectBuilder

When true, resets the timeout duration everytime this component is used.

setCustomId

abstract override fun ~~setCustomId~~(customId: String): StringSelectMenu.Builder

setDefaultOptions

@Nonnull

open fun setDefaultOptions(@Nonnull values: Collection<out SelectOption?>): StringSelectMenu.Builder

@Nonnull

open fun setDefaultOptions(@Nonnull vararg values: SelectOption?): StringSelectMenu.Builder

setDefaultValues

@Nonnull

open fun setDefaultValues(@Nonnull vararg values: String?): StringSelectMenu.Builder

@Nonnull

open fun setDefaultValues(@Nonnull values: Collection<String?>): StringSelectMenu.Builder

setDisabled

@Nonnull

open fun setDisabled(disabled: Boolean): StringSelectMenu.Builder

setMaxValues

@Nonnull

open fun setMaxValues(maxValues: Int): StringSelectMenu.Builder

setMinValues

@Nonnull

open fun setMinValues(minValues: Int): StringSelectMenu.Builder

setPlaceholder

@Nonnull

open fun setPlaceholder(@Nullable placeholder: String?): StringSelectMenu.Builder

setRequired

@Nonnull

open fun setRequired(@Nullable required: Boolean?): StringSelectMenu.Builder

setRequiredRange

@Nonnull

open fun setRequiredRange(min: Int, max: Int): StringSelectMenu.Builder

setUniqueId

@Nonnull

open fun setUniqueId(uniqueId: Int): StringSelectMenu.Builder

singleUse

@CheckReturnValue

abstract fun singleUse(singleUse: Boolean): EphemeralStringSelectBuilder

Sets this component as being usable once.

timeout

@CheckReturnValue

open fun timeout(timeout: Duration, handler: Runnable): EphemeralStringSelectBuilder

abstract fun timeout(timeout: Duration, handler: suspend () -> Unit): EphemeralStringSelectBuilder

@CheckReturnValue

open fun timeout(timeout: Long, timeoutUnit: TimeUnit, handler: Runnable): EphemeralStringSelectBuilder

Sets the timeout on this component, invalidating the component on expiration, and running the given timeout handler.

@CheckReturnValue

open fun timeout(timeout: Duration): EphemeralStringSelectBuilder

abstract fun timeout(timeout: Duration): EphemeralStringSelectBuilder

@CheckReturnValue

open fun timeout(timeout: Long, timeoutUnit: TimeUnit): EphemeralStringSelectBuilder

Sets the timeout on this component, invalidating the component on expiration.