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

AbstractNestedPaginator

abstract class AbstractNestedPaginator<T : AbstractNestedPaginator<T>> : AbstractPaginator<T> (source)

Parameters

Type of the implementor

Inheritors

NestedPaginator

Properties

constraints

val constraints: InteractionConstraints

context

val context: BContext

isFirstPage

val isFirstPage: Boolean

isLastPage

val isLastPage: Boolean

maxPages

open override var maxPages: Int

message

var message: Message?

The Message associated to this paginator

page

var page: Int

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

selectedItem

val selectedItem: NestedPaginationItem<T>

selectedItemIndex

var selectedItemIndex: Int

usePaginatorControls

val usePaginatorControls: Boolean

Functions

cancelTimeout

open fun cancelTimeout()

Cancels the timeout action for this pagination instance

cleanup

suspend fun cleanup()

Cleans up the button IDs used in this paginator

cleanupJava

@JvmName(name = "cleanup")

fun cleanupJava()

Cleans up the button IDs used in this paginator

getCurrentMessage

fun getCurrentMessage(): MessageEditData

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

getInitialMessage

fun getInitialMessage(): MessageCreateData

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

restartTimeout

open fun restartTimeout()

Restarts the timeout of this pagination instance

setSelectedItem

fun setSelectedItem(index: Int): T

fun setSelectedItem(itemLabel: String): T

Sets the selected wrapped pagination.