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

EphemeralStringSelectBuilder

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

Properties

componentType

open override val componentType: ComponentType

constraints

open override var constraints: InteractionConstraints

context

open override val context: BContext

filters

open override val filters: MutableList<ComponentInteractionFilter<*>>

List of filters applied to this component.

handler

open override val handler: ComponentHandler?

instance

open override val instance: EphemeralStringSelectBuilder

lifetimeType

open override val lifetimeType: LifetimeType

oneUse

open override var ~~oneUse~~: Boolean

Sets this component as being usable once.

rateLimitGroup

open override val rateLimitGroup: String?

resetTimeoutOnUse

open override var resetTimeoutOnUse: Boolean

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

singleUse

open override var singleUse: Boolean

Sets this component as being usable once.

timeout

open override val timeout: ComponentTimeout?

timeoutDuration

open override val timeoutDuration: Duration?

Functions

addFilter

@CheckReturnValue

open override fun addFilter(filter: ComponentInteractionFilter<*>): EphemeralStringSelectBuilder

@CheckReturnValue

open override 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 override fun addPermissions(vararg permissions: Permission): EphemeralStringSelectBuilder

@CheckReturnValue

open override fun addPermissions(permissions: Collection<Permission>): EphemeralStringSelectBuilder

Adds permissions to the constraints

addRoleIds

@CheckReturnValue

open override fun addRoleIds(vararg roleIds: Long): EphemeralStringSelectBuilder

@CheckReturnValue

open override fun addRoleIds(roleIds: Collection<Long>): EphemeralStringSelectBuilder

Adds role IDs to the constraints

addRoles

@CheckReturnValue

open override fun addRoles(vararg roles: Role): EphemeralStringSelectBuilder

@CheckReturnValue

open override fun addRoles(roles: Collection<Role>): EphemeralStringSelectBuilder

Adds role IDs to the constraints

addUserIds

@CheckReturnValue

open override fun addUserIds(vararg userIds: Long): EphemeralStringSelectBuilder

@CheckReturnValue

open override fun addUserIds(userIds: Collection<Long>): EphemeralStringSelectBuilder

Adds user IDs to the constraints

addUsers

@CheckReturnValue

open override fun addUsers(vararg users: UserSnowflake): EphemeralStringSelectBuilder

@CheckReturnValue

open override fun addUsers(users: Collection<UserSnowflake>): EphemeralStringSelectBuilder

Adds user IDs to the constraints

bindTo

@CheckReturnValue

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

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

@CheckReturnValue

open override fun ~~bindTo~~(handler: Consumer<StringSelectEvent>, block: ReceiverConsumer<EphemeralHandlerBuilder<StringSelectEvent>>): EphemeralStringSelectBuilder

open override fun ~~bindTo~~(handler: suspend (StringSelectEvent) -> Unit, block: ReceiverConsumer<EphemeralHandlerBuilder<StringSelectEvent>>): EphemeralStringSelectBuilder

Binds the given handler to this component.

build

open override fun build(): StringSelectMenu

constraints

@CheckReturnValue

open override fun constraints(block: ReceiverConsumer<InteractionConstraints>): EphemeralStringSelectBuilder

Allows manipulating the InteractionConstraints instance

@CheckReturnValue

open override 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

open 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

open override fun noTimeout(): EphemeralStringSelectBuilder

Removes the timeout from this component.

oneUse

@CheckReturnValue

open override fun ~~oneUse~~(oneUse: Boolean): EphemeralStringSelectBuilder

Sets this component as being usable once.

rateLimitReference

@CheckReturnValue

open override fun rateLimitReference(group: String): EphemeralStringSelectBuilder

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

resetTimeoutOnUse

open override 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

open 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

open override fun singleUse(singleUse: Boolean): EphemeralStringSelectBuilder

Sets this component as being usable once.

timeout

@CheckReturnValue

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

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

@CheckReturnValue

open override 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 override fun timeout(timeout: Duration): EphemeralStringSelectBuilder

@CheckReturnValue

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

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