kord-extensions/dev.kordex.core.pagination/PublicFollowUpPaginator

PublicFollowUpPaginator

class PublicFollowUpPaginator(val pages: Pages, val chunkedPages: Int = 1, val owner: UserBehavior? = null, val timeoutSeconds: Long? = null, val keepEmbed: Boolean = true, val switchEmoji: ReactionEmoji = if (pages.groups.size == 2) EXPAND_EMOJI else SWITCH_EMOJI, val mutator: PageTransitionCallback? = null, locale: Locale? = null, val interaction: FollowupPermittingInteractionResponseBehavior) : BaseButtonPaginator

Class representing a button-based paginator that operates by creating and editing a follow-up message for the given public interaction response.

Parameters

interaction

Interaction response behaviour to work with.

Constructors

PublicFollowUpPaginator

constructor(pages: Pages, chunkedPages: Int = 1, owner: UserBehavior? = null, timeoutSeconds: Long? = null, keepEmbed: Boolean = true, switchEmoji: ReactionEmoji = if (pages.groups.size == 2) EXPAND_EMOJI else SWITCH_EMOJI, mutator: PageTransitionCallback? = null, locale: Locale? = null, interaction: FollowupPermittingInteractionResponseBehavior)

Properties

open var active: Boolean

Whether this paginator is currently active and processing events.

open var allGroups: List<Key>

Set of all page groups.

open var backButton: PublicInteractionButton<*>?

Button builder representing the button that switches to the previous page.

val bot: ExtensibleBot

Current instance of the bot.

canUseSwitchingButtons

val canUseSwitchingButtons: Boolean

Whether it's possible for us to have a row of group-switching buttons.

open val chunkedPages: Int = 1

open var components: ComponentContainer

ComponentContainer instance managing the buttons for this paginator.

var currentGroup: Key

Currently-displayed page group.

var currentPageNum: Int

Currently-displayed page index.

open var currentPages: List<Page>

Currently-displayed page object.

val defaultCheck: CheckWithCache<ComponentInteractionCreateEvent>

A button-oriented check function that matches based on the owner property.

embedInteraction

var embedInteraction: PublicFollowupMessage?

Follow-up interaction to use for this paginator's embeds. Will be created by send.

firstPageButton

open var firstPageButton: PublicInteractionButton<*>?

Button builder representing the button that switches to the first page.

open val groupButtons: MutableMap<Key, PublicInteractionButton<*>>

Group-specific buttons, if any.

val interaction: FollowupPermittingInteractionResponseBehavior

open val keepEmbed: Boolean = true

val kord: Kord

Kord instance, backing the ExtensibleBot.

open var lastPageButton: PublicInteractionButton<*>?

Button builder representing the button that switches to the last page.

open val localeObj: Locale

Locale to use for translations.

open val mutator: PageTransitionCallback? = null

open var nextButton: PublicInteractionButton<*>?

Button builder representing the button that switches to the next page.

open val owner: UserBehavior? = null

open val pages: Pages

var scheduler: Scheduler

Scheduler used to schedule the paginator's timeout.

open var switchButton: PublicInteractionButton<*>?

Button builder representing the button that switches between groups.

open val switchEmoji: ReactionEmoji

var task: Task?

Scheduler used to schedule the paginator's timeout.

timeoutCallbacks

val timeoutCallbacks: MutableList<suspend () -> Unit>

What to do after the paginator times out.

open val timeoutSeconds: Long? = null

Functions

open suspend fun MessageBuilder.applyPage()

Builder that generates an embed for the paginator's current context.

open suspend override fun destroy()

Destroy this paginator, removing its buttons and deleting its message if required..

open fun getChunk(): List<Page>

open override fun getKoin(): Koin

Get the associated Koin instance.

open suspend override fun goToPage(page: Int)

Switch to a specific page. Should not call send.

open suspend override fun nextGroup()

Switch to the next group. Should not call send.

open suspend fun nextPage()

Convenience function to go to call goToPage with the next page number, if we're not at the last page.

open fun onTimeout(body: suspend () -> Unit): BasePaginator

Register a callback that is called after the paginator times out.

open suspend fun previousPage()

Convenience function to go to call goToPage with the previous page number, if we're not at the first page.

open suspend override fun send()

Send the paginator, given the current context. If it's already sent, update it.

setDisabledButton

fun setDisabledButton(button: PublicInteractionButton<*>?)

Replace an enabled interactive button in components with a disabled button of the same ID.

setEnabledButton

fun setEnabledButton(button: PublicInteractionButton<*>?)

Replace a disabled button in components with the given interactive button of the same ID.

open suspend override fun setup()

Should be called as part of send in order to create buttons and get other things set up.

suspend fun switchGroup(group: Key)

Convenience function to switch to a specific group.

fun updateButtons()

Convenience function that enables and disables buttons as necessary, depending on the current page number.