BotCommands/io.github.freya022.botcommands.api.pagination.menu/AbstractMenuBuilder

AbstractMenuBuilder

abstract class AbstractMenuBuilder<E, T : AbstractMenuBuilder<E, T, R>, R : AbstractMenu<E, R>> : AbstractPaginatorBuilder<T, R> (source)

Provides base for a menu builder

Parameters

Type of the menu entries

Type of the pagination builder

Type of the built pagination

Inheritors

MenuBuilder

ButtonMenuBuilder

Properties

cleanAfterRefresh

var cleanAfterRefresh: Boolean

constraints

var constraints: InteractionConstraints

deleteContent

var deleteContent: ButtonContent

entries

val entries: List<E>

firstContent

var firstContent: ButtonContent

hasDeleteButton

var hasDeleteButton: Boolean

lastContent

var lastContent: ButtonContent

maxEntriesPerPage

var maxEntriesPerPage: Int

nextContent

var nextContent: ButtonContent

pageEditor

var pageEditor: PageEditor<R>?

previousContent

var previousContent: ButtonContent

rowPrefixSupplier

var rowPrefixSupplier: RowPrefixSupplier

timeout

var timeout: TimeoutInfo<R>?

transformer

var transformer: EntryTransformer<E>

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

setMaxEntriesPerPage

fun setMaxEntriesPerPage(maxEntriesPerPage: Int): T

Sets the maximum number of entries per page.

setNextContent

fun setNextContent(nextContent: ButtonContent): T

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

setPageEditor

fun setPageEditor(pageEditor: PageEditor<R>?): T

Sets an optional the PageEditor for this menu.

setPreviousContent

fun setPreviousContent(previousContent: ButtonContent): T

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

setRowPrefixSupplier

fun setRowPrefixSupplier(rowPrefixSupplier: RowPrefixSupplier): T

Sets the row prefix supplier for this menu.

setTimeout

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

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

Sets the timeout for this pagination instance.

setTransformer

fun setTransformer(transformer: EntryTransformer<E>): T

Sets the entry transformer for this menu

useDeleteButton

fun useDeleteButton(hasDeleteButton: Boolean): T

Specifies whether this paginator should have a delete button.