BotCommands/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

filters

abstract val filters: MutableList<ComponentInteractionFilter>

List of filters applied to this component.

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.

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 p0: String, @Nonnull p1: String): StringSelectMenu.Builder

@Nonnull

open fun addOption(@Nonnull p0: String, @Nonnull p1: String, @Nonnull p2: String): StringSelectMenu.Builder

@Nonnull

open fun addOption(@Nonnull p0: String, @Nonnull p1: String, @Nonnull p2: Emoji): StringSelectMenu.Builder

@Nonnull

open fun addOption(@Nonnull p0: String, @Nonnull p1: String, @Nullable p2: String?, @Nullable p3: Emoji?): StringSelectMenu.Builder

addOptions

@Nonnull

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

@Nonnull

open fun addOptions(@Nonnull p0: MutableCollection<out SelectOption>): StringSelectMenu.Builder

addPermissions

@CheckReturnValue

open fun addPermissions(vararg permissions: Permission): EphemeralStringSelectBuilder

@CheckReturnValue

abstract fun addPermissions(permissions: Collection<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

open fun addRoles(vararg roles: Role): EphemeralStringSelectBuilder

@CheckReturnValue

abstract fun addRoles(roles: Collection<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

open fun addUsers(vararg users: UserSnowflake): EphemeralStringSelectBuilder

@CheckReturnValue

abstract fun addUsers(users: Collection<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.

getId

abstract override fun ~~getId~~(): Nothing

getMaxValues

open fun getMaxValues(): Int

getMinValues

open fun getMinValues(): Int

getOptions

@Nonnull

open fun getOptions(): MutableList<SelectOption>

getPlaceholder

@Nullable

open fun getPlaceholder(): String?

isDisabled

open fun isDisabled(): Boolean

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.

setDefaultOptions

@Nonnull

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

@Nonnull

open fun setDefaultOptions(@Nonnull p0: MutableCollection<out SelectOption>): StringSelectMenu.Builder

setDefaultValues

@Nonnull

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

@Nonnull

open fun setDefaultValues(@Nonnull p0: MutableCollection<String>): StringSelectMenu.Builder

setDisabled

@Nonnull

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

setId

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

setMaxValues

@Nonnull

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

setMinValues

@Nonnull

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

setPlaceholder

@Nonnull

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

setRequiredRange

@Nonnull

open fun setRequiredRange(p0: Int, p1: Int): StringSelectMenu.Builder

setRequiredRange

fun <B : SelectMenu.Builder<*, B>> SelectMenu.Builder<*, B>.setRequiredRange(range: IntRange): B

The minimum and maximum amount of values a user can select.

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.