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

PaginatorBuilder

class PaginatorBuilder : AbstractPaginatorBuilder<PaginatorBuilder, Paginator> (source)

Builds a Paginator.

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

maxPages

val maxPages: Int

nextContent

var nextContent: ButtonContent

pageEditor

val pageEditor: PageEditor<Paginator>

previousContent

var previousContent: ButtonContent

timeout

var timeout: TimeoutInfo<Paginator>?

Functions

build

open override fun build(): Paginator

Builds this pagination instance

cleanAfterRefresh

fun cleanAfterRefresh(cleanAfterRefresh: Boolean): PaginatorBuilder

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

Disables the timeout for this pagination instance.

setConstraints

fun setConstraints(constraints: InteractionConstraints): PaginatorBuilder

Sets the interaction constraints for this pagination object

setDeleteContent

fun setDeleteContent(deleteContent: ButtonContent): PaginatorBuilder

Sets the content for the button which deletes this paginator

setFirstContent

fun setFirstContent(firstContent: ButtonContent): PaginatorBuilder

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

setLastContent

fun setLastContent(lastContent: ButtonContent): PaginatorBuilder

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

setNextContent

fun setNextContent(nextContent: ButtonContent): PaginatorBuilder

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

setPreviousContent

fun setPreviousContent(previousContent: ButtonContent): PaginatorBuilder

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

setTimeout

fun setTimeout(timeout: Duration, onTimeout: BlockingPaginationTimeoutConsumer<Paginator>?): PaginatorBuilder

fun setTimeout(timeout: Duration, onTimeout: SuspendingPaginationTimeoutConsumer<Paginator>?): PaginatorBuilder

Sets the timeout for this pagination instance.

useDeleteButton

fun useDeleteButton(hasDeleteButton: Boolean): PaginatorBuilder

Specifies whether this paginator should have a delete button.

PaginatorBuilder

See also

Properties

Functions