BotCommands/io.github.freya022.botcommands.api.components.builder.button/EphemeralButtonBuilder

EphemeralButtonBuilder

class EphemeralButtonBuilder : AbstractButtonBuilder<EphemeralButtonBuilder> , IEphemeralActionableComponent<EphemeralButtonBuilder, ButtonEvent> , IEphemeralTimeoutableComponent<EphemeralButtonBuilder> (source)

Properties

componentType

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: EphemeralButtonBuilder

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

@CheckReturnValue

open override fun addFilter(filterType: Class<out ComponentInteractionFilter<*>>): EphemeralButtonBuilder

Applies a filter to this component.

addPermissions

@CheckReturnValue

open override fun addPermissions(vararg permissions: Permission): EphemeralButtonBuilder

@CheckReturnValue

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

Adds permissions to the constraints

addRoleIds

@CheckReturnValue

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

@CheckReturnValue

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

Adds role IDs to the constraints

addRoles

@CheckReturnValue

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

@CheckReturnValue

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

Adds role IDs to the constraints

addUserIds

@CheckReturnValue

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

@CheckReturnValue

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

Adds user IDs to the constraints

addUsers

@CheckReturnValue

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

@CheckReturnValue

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

Adds user IDs to the constraints

bindTo

@CheckReturnValue

open override fun bindTo(handler: Consumer<ButtonEvent>): EphemeralButtonBuilder

open override fun bindTo(handler: suspend (ButtonEvent) -> Unit): EphemeralButtonBuilder

@CheckReturnValue

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

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

Binds the given handler to this component.

build

@CheckReturnValue

fun build(): Button

constraints

@CheckReturnValue

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

Allows manipulating the InteractionConstraints instance

@CheckReturnValue

open override fun constraints(constraints: InteractionConstraints): EphemeralButtonBuilder

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

open override fun noTimeout(): EphemeralButtonBuilder

Removes the timeout from this component.

oneUse

@CheckReturnValue

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

Sets this component as being usable once.

rateLimitReference

@CheckReturnValue

open override fun rateLimitReference(group: String): EphemeralButtonBuilder

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

resetTimeoutOnUse

open override fun resetTimeoutOnUse(resetTimeoutOnUse: Boolean): EphemeralButtonBuilder

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

singleUse

@CheckReturnValue

open override fun singleUse(singleUse: Boolean): EphemeralButtonBuilder

Sets this component as being usable once.

timeout

@CheckReturnValue

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

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

@CheckReturnValue

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

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

@CheckReturnValue

open override fun timeout(timeout: Duration): EphemeralButtonBuilder

@CheckReturnValue

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

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