BotCommands/io.github.freya022.botcommands.api.components.builder.select.persistent/PersistentEntitySelectBuilder

PersistentEntitySelectBuilder

abstract class PersistentEntitySelectBuilder : EntitySelectMenu.Builder, BaseComponentBuilder<PersistentEntitySelectBuilder> , IConstrainableComponent<PersistentEntitySelectBuilder> , IUniqueComponent<PersistentEntitySelectBuilder> , IPersistentActionableComponent<PersistentEntitySelectBuilder> , IPersistentTimeoutableComponent<PersistentEntitySelectBuilder> (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.

oneUse

open var ~~oneUse~~: Boolean

Sets this component as being usable once.

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<*>): PersistentEntitySelectBuilder

@CheckReturnValue

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

Applies a filter to this component.

addPermissions

@CheckReturnValue

open fun addPermissions(vararg permissions: Permission): PersistentEntitySelectBuilder

@CheckReturnValue

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

Adds permissions to the constraints

addRoleIds

@CheckReturnValue

open fun addRoleIds(vararg roleIds: Long): PersistentEntitySelectBuilder

@CheckReturnValue

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

Adds role IDs to the constraints

addRoles

@CheckReturnValue

open fun addRoles(vararg roles: Role): PersistentEntitySelectBuilder

@CheckReturnValue

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

Adds role IDs to the constraints

addUserIds

@CheckReturnValue

open fun addUserIds(vararg userIds: Long): PersistentEntitySelectBuilder

@CheckReturnValue

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

Adds user IDs to the constraints

addUsers

@CheckReturnValue

open fun addUsers(vararg users: UserSnowflake): PersistentEntitySelectBuilder

@CheckReturnValue

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

Adds user IDs to the constraints

bindTo

@CheckReturnValue

abstract fun ~~bindTo~~(handlerName: String, block: ReceiverConsumer<PersistentHandlerBuilder>): PersistentEntitySelectBuilder

@CheckReturnValue

open fun bindTo(handlerName: String, vararg data: Any?): PersistentEntitySelectBuilder

@CheckReturnValue

open fun bindTo(handlerName: String, data: List<Any?>): PersistentEntitySelectBuilder

Binds the given handler name with its arguments to this component.

build

abstract override fun build(): EntitySelectMenu

constraints

@CheckReturnValue

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

Allows manipulating the InteractionConstraints instance

@CheckReturnValue

abstract fun constraints(constraints: InteractionConstraints): PersistentEntitySelectBuilder

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

getPlaceholder

@Nullable

open fun getPlaceholder(): String?

isDisabled

open fun isDisabled(): Boolean

noTimeout

@CheckReturnValue

abstract fun noTimeout(): PersistentEntitySelectBuilder

Removes the timeout from this component.

oneUse

@CheckReturnValue

open fun ~~oneUse~~(oneUse: Boolean): PersistentEntitySelectBuilder

Sets this component as being usable once.

rateLimitReference

@CheckReturnValue

abstract fun rateLimitReference(reference: ComponentRateLimitReference): PersistentEntitySelectBuilder

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

resetTimeoutOnUse

abstract fun resetTimeoutOnUse(resetTimeoutOnUse: Boolean): PersistentEntitySelectBuilder

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

setChannelTypes

@Nonnull

open fun setChannelTypes(@Nonnull vararg p0: ChannelType): EntitySelectMenu.Builder

@Nonnull

open fun setChannelTypes(@Nonnull p0: MutableCollection<ChannelType>): EntitySelectMenu.Builder

setDefaultValues

@Nonnull

open fun setDefaultValues(@Nonnull vararg p0: EntitySelectMenu.DefaultValue): EntitySelectMenu.Builder

@Nonnull

open fun setDefaultValues(@Nonnull p0: MutableCollection<out EntitySelectMenu.DefaultValue>): EntitySelectMenu.Builder

setDisabled

@Nonnull

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

setEntityTypes

@Nonnull

open fun setEntityTypes(@Nonnull p0: MutableCollection<EntitySelectMenu.SelectTarget>): EntitySelectMenu.Builder

@Nonnull

open fun setEntityTypes(@Nonnull p0: EntitySelectMenu.SelectTarget, @Nonnull vararg p1: EntitySelectMenu.SelectTarget): EntitySelectMenu.Builder

setId

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

setMaxValues

@Nonnull

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

setMinValues

@Nonnull

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

setPlaceholder

@Nonnull

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

setRequiredRange

@Nonnull

open fun setRequiredRange(p0: Int, p1: Int): EntitySelectMenu.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): PersistentEntitySelectBuilder

Sets this component as being usable once.

timeout

@CheckReturnValue

open fun timeout(timeout: Duration, handlerName: String, vararg data: Any?): PersistentEntitySelectBuilder

abstract fun timeout(timeout: Duration, handlerName: String, vararg data: Any?): PersistentEntitySelectBuilder

@CheckReturnValue

open fun timeout(timeout: Long, timeoutUnit: TimeUnit, handlerName: String, vararg data: Any?): PersistentEntitySelectBuilder

Sets the timeout on this component, invalidating the component on expiration, and running the timeout handler with the given name and its arguments.

@CheckReturnValue

open fun timeout(timeout: Duration): PersistentEntitySelectBuilder

abstract fun timeout(timeout: Duration): PersistentEntitySelectBuilder

@CheckReturnValue

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

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