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

EphemeralComponentGroupBuilder

class EphemeralComponentGroupBuilder : ComponentGroupBuilder<EphemeralComponentGroupBuilder> , IEphemeralTimeoutableComponent<EphemeralComponentGroupBuilder> (source)

Properties

open override val componentType: ComponentType

open override val instance: EphemeralComponentGroupBuilder

open override val lifetimeType: LifetimeType

resetTimeoutOnUse

open override var resetTimeoutOnUse: Boolean

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

open override val timeout: ComponentTimeout?

timeoutDuration

open override val timeoutDuration: Duration?

Functions

fun build(): ComponentGroup

@CheckReturnValue

open override fun noTimeout(): EphemeralComponentGroupBuilder

Removes the timeout from this component.

resetTimeoutOnUse

open override fun resetTimeoutOnUse(resetTimeoutOnUse: Boolean): EphemeralComponentGroupBuilder

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

@CheckReturnValue

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

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

@CheckReturnValue

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

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

@CheckReturnValue

open override fun timeout(timeout: Duration): EphemeralComponentGroupBuilder

open override fun timeout(timeout: Duration): EphemeralComponentGroupBuilder

@CheckReturnValue

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

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