PaginatorBuilder

class PaginatorBuilder(var locale: Locale? = null, val defaultGroup: Key = EMPTY_KEY)

Wrapping builder for easily creating paginators using DSL functions defined in the context classes.

locale

Locale to use for the paginator

defaultGroup

Default page group, if any

Constructors

constructor(locale: Locale? = null, defaultGroup: Key = EMPTY_KEY)

How many "pages" should be displayed at once, from 1 to 9.

Whether to keep the paginator content on Discord when the paginator is destroyed.

Object containing paginator mutation functions.

var owner: UserBehavior?

Paginator owner, if only one person should be able to interact.

Pages container object.

var switchEmoji: ReactionEmoji?

Alternative switch button emoji, if needed.

Paginator timeout, in seconds. When elapsed, the paginator will be destroyed.

suspend fun mutate(body: suspend PageTransitionCallback.() -> Unit)

Mutate the paginator and pages, as pages are generated and sent.

fun page(page: Page)

fun page(builder: suspend EmbedBuilder.() -> Unit)

Add a page to pages, using the default group.

fun page(group: Key, page: Page)

fun page(group: Key, builder: suspend EmbedBuilder.() -> Unit)

Add a page to pages, using the given group.