BotCommands/io.github.freya022.botcommands.api.pagination/AbstractPaginationBuilder/setTimeout

setTimeout

fun setTimeout(timeout: Duration, onTimeout: BlockingPaginationTimeoutConsumer<R>?): T(source)
fun setTimeout(timeout: Duration, onTimeout: SuspendingPaginationTimeoutConsumer<R>?): T(source)

Sets the timeout for this pagination instance.

On timeout, only the consumer is called, no messages are deleted, and it is up to you to clean up components with AbstractPagination.cleanup.

See AbstractPagination.message to get the message in the timeout consumer.

The default timeout is set to Components.defaultTimeout.

Return

This builder for chaining convenience

Parameters

timeout

Duration before the pagination expires

onTimeout

The consumer fired on timeout, long operations should not run here