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

MenuBuilder

class MenuBuilder<E> : AbstractMenuBuilder<E, MenuBuilder<E>, Menu<E>> (source)

Builds a Menu.

Parameters

Type of the entries

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<Menu<E>>?

previousContent

var previousContent: ButtonContent

rowPrefixSupplier

var rowPrefixSupplier: RowPrefixSupplier

timeout

var timeout: TimeoutInfo<Menu<E>>?

transformer

var transformer: EntryTransformer<E>

Functions

build

open override fun build(): Menu<E>

Builds this pagination instance

cleanAfterRefresh

fun cleanAfterRefresh(cleanAfterRefresh: Boolean): MenuBuilder<E>

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(): MenuBuilder<E>

Disables the timeout for this pagination instance.

setConstraints

fun setConstraints(constraints: InteractionConstraints): MenuBuilder<E>

Sets the interaction constraints for this pagination object

setDeleteContent

fun setDeleteContent(deleteContent: ButtonContent): MenuBuilder<E>

Sets the content for the button which deletes this paginator

setFirstContent

fun setFirstContent(firstContent: ButtonContent): MenuBuilder<E>

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

setLastContent

fun setLastContent(lastContent: ButtonContent): MenuBuilder<E>

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

setMaxEntriesPerPage

fun setMaxEntriesPerPage(maxEntriesPerPage: Int): MenuBuilder<E>

Sets the maximum number of entries per page.

setNextContent

fun setNextContent(nextContent: ButtonContent): MenuBuilder<E>

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

setPageEditor

fun setPageEditor(pageEditor: PageEditor<Menu<E>>?): MenuBuilder<E>

Sets an optional the PageEditor for this menu.

setPreviousContent

fun setPreviousContent(previousContent: ButtonContent): MenuBuilder<E>

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

setRowPrefixSupplier

fun setRowPrefixSupplier(rowPrefixSupplier: RowPrefixSupplier): MenuBuilder<E>

Sets the row prefix supplier for this menu.

setTimeout

fun setTimeout(timeout: Duration, onTimeout: BlockingPaginationTimeoutConsumer<Menu<E>>?): MenuBuilder<E>

fun setTimeout(timeout: Duration, onTimeout: SuspendingPaginationTimeoutConsumer<Menu<E>>?): MenuBuilder<E>

Sets the timeout for this pagination instance.

setTransformer

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

Sets the entry transformer for this menu

useDeleteButton

fun useDeleteButton(hasDeleteButton: Boolean): MenuBuilder<E>

Specifies whether this paginator should have a delete button.

MenuBuilder

Parameters

See also

Properties

Functions