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

NestedPaginator

class NestedPaginator : AbstractNestedPaginator<NestedPaginator> (source)

A paginator which wraps a paginator, with a select menu to switch between them.

See also

Types

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.

Link copied to clipboard
Link copied to clipboard
Link copied to clipboard

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

Link copied to clipboard
fun setSelectedItem(index: Int): NestedPaginator
fun setSelectedItem(itemLabel: String): NestedPaginator

Sets the selected wrapped pagination.