BotCommands/io.github.freya022.botcommands.api.pagination.nested/NestedPaginatorBuilder

NestedPaginatorBuilder

class NestedPaginatorBuilder : AbstractNestedPaginatorBuilder<NestedPaginatorBuilder, NestedPaginator> (source)

Builds a NestedPaginator.

Properties

cleanAfterRefresh

var cleanAfterRefresh: Boolean

constraints

var constraints: InteractionConstraints

deleteContent

var deleteContent: ButtonContent

firstContent

var firstContent: ButtonContent

hasDeleteButton

var hasDeleteButton: Boolean

items

val items: MutableList<NestedPaginationItem<NestedPaginator>>

lastContent

var lastContent: ButtonContent

nextContent

var nextContent: ButtonContent

previousContent

var previousContent: ButtonContent

timeout

var timeout: TimeoutInfo<NestedPaginator>?

usePaginatorControls

var usePaginatorControls: Boolean

Functions

addMenu

fun addMenu(content: SelectContent, maxPages: Int, pageEditor: PageEditor<NestedPaginator>): NestedPaginatorBuilder

Adds a menu to this pagination wrapper.

build

open override fun build(): NestedPaginator

Builds this pagination instance

cleanAfterRefresh

fun cleanAfterRefresh(cleanAfterRefresh: Boolean): NestedPaginatorBuilder

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

Disables the timeout for this pagination instance.

setConstraints

fun setConstraints(constraints: InteractionConstraints): NestedPaginatorBuilder

Sets the interaction constraints for this pagination object

setDeleteContent

fun setDeleteContent(deleteContent: ButtonContent): NestedPaginatorBuilder

Sets the content for the button which deletes this paginator

setFirstContent

fun setFirstContent(firstContent: ButtonContent): NestedPaginatorBuilder

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

setLastContent

fun setLastContent(lastContent: ButtonContent): NestedPaginatorBuilder

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

setNextContent

fun setNextContent(nextContent: ButtonContent): NestedPaginatorBuilder

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

setPreviousContent

fun setPreviousContent(previousContent: ButtonContent): NestedPaginatorBuilder

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

setTimeout

fun setTimeout(timeout: Duration, onTimeout: BlockingPaginationTimeoutConsumer<NestedPaginator>?): NestedPaginatorBuilder

fun setTimeout(timeout: Duration, onTimeout: SuspendingPaginationTimeoutConsumer<NestedPaginator>?): NestedPaginatorBuilder

Sets the timeout for this pagination instance.

useDeleteButton

fun useDeleteButton(hasDeleteButton: Boolean): NestedPaginatorBuilder

Specifies whether this paginator should have a delete button.

usePaginatorControls

fun usePaginatorControls(usePaginatorControls: Boolean): NestedPaginatorBuilder

Whether to display the buttons to navigate in a nested pagination

NestedPaginatorBuilder

See also

Properties

Functions