BotCommands/io.github.freya022.botcommands.api.components.builder/IEphemeralActionableComponent

IEphemeralActionableComponent

interface IEphemeralActionableComponent<T : IEphemeralActionableComponent<T, E>, E : GenericComponentInteractionCreateEvent> : IActionableComponent<T> (source)

Allows components to have ephemeral handlers bound to them.

These handlers will not exist anymore after a restart.

Inheritors

Properties

Link copied to clipboard
abstract val context: BContext
Link copied to clipboard
abstract val filters: MutableList<ComponentInteractionFilter<*>>

List of filters applied to this component.

Link copied to clipboard
abstract val handler: ComponentHandler?
Link copied to clipboard
abstract val instance: T
Link copied to clipboard
abstract val rateLimitGroup: String?

Functions

Link copied to clipboard
@CheckReturnValue
open fun addFilter(filter: ComponentInteractionFilter<*>): T
@CheckReturnValue
open fun addFilter(filterType: Class<out ComponentInteractionFilter<*>>): T

Applies a filter to this component.

Link copied to clipboard
@CheckReturnValue
open fun bindTo(handler: Consumer<E>): T
open fun bindTo(handler: suspend (E) -> Unit): T
@CheckReturnValue
open fun bindTo(handler: Consumer<E>, block: ReceiverConsumer<EphemeralHandlerBuilder<E>>): T
abstract fun bindTo(handler: suspend (E) -> Unit, block: ReceiverConsumer<EphemeralHandlerBuilder<E>>): T

Binds the given handler to this component.

Link copied to clipboard
inline fun <T : ComponentInteractionFilter<*>> IActionableComponent<*>.filter(): T

Convenience extension to load an ComponentInteractionFilter service.

Link copied to clipboard
@CheckReturnValue
abstract fun rateLimitReference(group: String): T

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