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

PersistentComponentGroupBuilder

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

Properties

Link copied to clipboard
abstract var resetTimeoutOnUse: Boolean

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

Functions

Link copied to clipboard
abstract fun build(): ComponentGroup
Link copied to clipboard
@CheckReturnValue
abstract fun noTimeout(): PersistentComponentGroupBuilder

Removes the timeout from this component.

Link copied to clipboard
abstract fun resetTimeoutOnUse(resetTimeoutOnUse: Boolean): PersistentComponentGroupBuilder

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

Link copied to clipboard
@CheckReturnValue
open fun timeout(timeout: Duration, handlerName: String, vararg data: Any?): PersistentComponentGroupBuilder
abstract fun timeout(timeout: Duration, handlerName: String, vararg data: Any?): PersistentComponentGroupBuilder
@CheckReturnValue
open 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 fun timeout(timeout: Duration): PersistentComponentGroupBuilder
abstract fun timeout(timeout: Duration): PersistentComponentGroupBuilder
@CheckReturnValue
open fun timeout(timeout: Long, timeoutUnit: TimeUnit): PersistentComponentGroupBuilder

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