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

AbstractPaginationBuilder

abstract class AbstractPaginationBuilder<T : AbstractPaginationBuilder<T, R>, R : AbstractPagination<R>>(source)

Most basic pagination builder.

Parameters

T

Type of the pagination builder

R

Type of the built pagination

Inheritors

AbstractCustomPaginationBuilder

AbstractPaginatorBuilder

Properties

cleanAfterRefresh

var cleanAfterRefresh: Boolean

var constraints: InteractionConstraints

var timeout: TimeoutInfo<R>?

Functions

abstract fun build(): R

Builds this pagination instance

cleanAfterRefresh

fun cleanAfterRefresh(cleanAfterRefresh: Boolean): T

Sets whether the components of the pagination should be invalidated after a refresh, enabling you to save memory when a new page is requested.

fun noTimeout(): T

Disables the timeout for this pagination instance.

fun setConstraints(constraints: InteractionConstraints): T

Sets the interaction constraints for this pagination object

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

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

Sets the timeout for this pagination instance.