BotCommands/io.github.freya022.botcommands.api.pagination.menu.buttonized/ButtonMenu

ButtonMenu

class ButtonMenu<E> : AbstractMenu<E, ButtonMenu<E>> (source)

A paginator where each page is filled with a list of entries.

Parameters

E

Type of the entries

See also

Types

Link copied to clipboard
fun interface ButtonContentSupplier<T>

A ButtonContent supplier for use in different paginators, allowing you to use your own text and emojis on buttons.

Link copied to clipboard
object Defaults

Properties

Link copied to clipboard
Link copied to clipboard
Link copied to clipboard
Link copied to clipboard
Link copied to clipboard
open override var maxPages: Int
Link copied to clipboard
var message: Message?

The Message associated to this paginator

Link copied to clipboard
var page: Int

The page number, after changing this value, you can update the message with the new content from getCurrentMessage.

Functions

Link copied to clipboard
open fun cancelTimeout()

Cancels the timeout action for this pagination instance

Link copied to clipboard
suspend fun cleanup()

Cleans up the button IDs used in this paginator

Link copied to clipboard
@JvmName(name = "cleanup")
fun cleanupJava()

Cleans up the button IDs used in this paginator

Link copied to clipboard
fun getCurrentMessage(): MessageEditData

Returns the message data that represents the current state of this pagination.

Link copied to clipboard
fun getInitialMessage(): MessageCreateData

Returns the message data that represents the initial state of this pagination.

Link copied to clipboard
open fun restartTimeout()

Restarts the timeout of this pagination instance