BotCommands/io.github.freya022.botcommands.api.pagination.custom/CustomPaginationBuilder

CustomPaginationBuilder

class CustomPaginationBuilder : AbstractCustomPaginationBuilder<CustomPaginationBuilder, CustomPagination> (source)

Builds a CustomPagination.

See also

Paginators.customPagination

Paginators.singlePage

Properties

cleanAfterRefresh

var cleanAfterRefresh: Boolean

var constraints: InteractionConstraints

val maxPages: Int

val pageEditor: CustomPageEditor<CustomPagination>

var timeout: TimeoutInfo<CustomPagination>?

Functions

open override fun build(): CustomPagination

Builds this pagination instance

cleanAfterRefresh

fun cleanAfterRefresh(cleanAfterRefresh: Boolean): CustomPaginationBuilder

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(): CustomPaginationBuilder

Disables the timeout for this pagination instance.

fun setConstraints(constraints: InteractionConstraints): CustomPaginationBuilder

Sets the interaction constraints for this pagination object

fun setTimeout(timeout: Duration, onTimeout: BlockingPaginationTimeoutConsumer<CustomPagination>?): CustomPaginationBuilder

fun setTimeout(timeout: Duration, onTimeout: SuspendingPaginationTimeoutConsumer<CustomPagination>?): CustomPaginationBuilder

Sets the timeout for this pagination instance.