BotCommands/io.github.freya022.botcommands.api.pagination.paginator/AbstractPaginatorBuilder

AbstractPaginatorBuilder

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

Most basic paginator builder.

Parameters

Type of the pagination builder

Type of the built pagination

Inheritors

AbstractMenuBuilder

AbstractNestedPaginatorBuilder

PaginatorBuilder

Constructors

AbstractPaginatorBuilder

constructor(context: BContext)

Properties

cleanAfterRefresh

var cleanAfterRefresh: Boolean

constraints

var constraints: InteractionConstraints

deleteContent

var deleteContent: ButtonContent

firstContent

var firstContent: ButtonContent

hasDeleteButton

var hasDeleteButton: Boolean

lastContent

var lastContent: ButtonContent

nextContent

var nextContent: ButtonContent

previousContent

var previousContent: ButtonContent

timeout

var timeout: TimeoutInfo<R>?

Functions

build

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.

noTimeout

fun noTimeout(): T

Disables the timeout for this pagination instance.

setConstraints

fun setConstraints(constraints: InteractionConstraints): T

Sets the interaction constraints for this pagination object

setDeleteContent

fun setDeleteContent(deleteContent: ButtonContent): T

Sets the content for the button which deletes this paginator

setFirstContent

fun setFirstContent(firstContent: ButtonContent): T

Sets the content for the button which goes to the first page

setLastContent

fun setLastContent(lastContent: ButtonContent): T

Sets the content for the button which goes to the last page

setNextContent

fun setNextContent(nextContent: ButtonContent): T

Sets the content for the button which goes to the next page

setPreviousContent

fun setPreviousContent(previousContent: ButtonContent): T

Sets the content for the button which goes to the previous page

setTimeout

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

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

Sets the timeout for this pagination instance.

useDeleteButton

fun useDeleteButton(hasDeleteButton: Boolean): T

Specifies whether this paginator should have a delete button.