kord-extensions/dev.kordex.core.pagination.pages/Pages

Pages

open class Pages(var defaultGroup: Key = EMPTY_KEY)

Class representing a set of pages in a paginator. You can subclass this to customize it if you wish!

Parameters

defaultGroup

Default page group, if you have more than one.

Constructors

Link copied to clipboard
constructor(defaultGroup: Key = EMPTY_KEY)

Properties

Link copied to clipboard
open var defaultGroup: Key
Link copied to clipboard
open val groups: <Error class: unknown class><Key, MutableList<Page>>

All groups of pages stored in this class.

Functions

Link copied to clipboard
open fun addPage(page: Page)

Add a page to the default group.

open fun addPage(group: Key, page: Page)

Add a page to a given group.

Link copied to clipboard
open fun get(page: Int): Page

Retrieve the page at the given index, from the default group.

open fun get(group: Key, page: Int): Page

Retrieve the page at the given index, from a given group.

Link copied to clipboard
open fun validate()

Check that this Pages object is valid, throwing if it isn't..