BotCommands/io.github.freya022.botcommands.api.components.builder.group/PersistentComponentGroupBuilder

PersistentComponentGroupBuilder

class PersistentComponentGroupBuilder : ComponentGroupBuilder<PersistentComponentGroupBuilder> , IPersistentTimeoutableComponent<PersistentComponentGroupBuilder> (source)

Properties

Link copied to clipboard
open override val componentType: ComponentType
Link copied to clipboard
Link copied to clipboard
open override val lifetimeType: LifetimeType
Link copied to clipboard
open override var resetTimeoutOnUse: Boolean

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

Link copied to clipboard
open override val timeout: ComponentTimeout?
Link copied to clipboard
open override val timeoutDuration: Duration?

Functions

Link copied to clipboard
Link copied to clipboard
@CheckReturnValue
open override fun noTimeout(): PersistentComponentGroupBuilder

Removes the timeout from this component.

Link copied to clipboard
open override fun resetTimeoutOnUse(resetTimeoutOnUse: Boolean): PersistentComponentGroupBuilder

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

Link copied to clipboard
@CheckReturnValue
open override fun timeout(timeout: Duration, handlerName: String, vararg data: Any?): PersistentComponentGroupBuilder
open override fun timeout(timeout: Duration, handlerName: String, vararg data: Any?): PersistentComponentGroupBuilder
@CheckReturnValue
open override fun timeout(timeout: Long, timeoutUnit: TimeUnit, handlerName: String, vararg data: Any?): PersistentComponentGroupBuilder

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 override fun timeout(timeout: Duration): PersistentComponentGroupBuilder
open override fun timeout(timeout: Duration): PersistentComponentGroupBuilder
@CheckReturnValue
open override fun timeout(timeout: Long, timeoutUnit: TimeUnit): PersistentComponentGroupBuilder

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