kord-extensions/dev.kordex.core.pagination

Package-level declarations

Types

abstract class BaseButtonPaginator(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) : BasePaginator

Abstract class containing some common functionality needed by interactive button-based paginators.

BasePaginator

abstract class BasePaginator(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) : KordExKoinComponent

Abstract class intended for building paginators.

EphemeralResponsePaginator

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

Class representing a button-based paginator that operates by editing the given ephemeral interaction response.

MessageButtonPaginator

class MessageButtonPaginator(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 pingInReply: Boolean = true, val targetChannel: MessageChannelBehavior? = null, val targetMessage: Message? = null) : BaseButtonPaginator

Class representing a button-based paginator that operates on standard messages.

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.

PublicResponsePaginator

class PublicResponsePaginator(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: PublicMessageInteractionResponseBehavior) : BaseButtonPaginator

Class representing a button-based paginator that operates by editing the given public interaction response.

Properties

DELETE_EMOJI

val DELETE_EMOJI: ReactionEmoji.Unicode

Emoji used to destroy the paginator and delete the message.

EXPAND_EMOJI

val EXPAND_EMOJI: ReactionEmoji.Unicode

Group switch emoji, information icon.

FINISH_EMOJI

val FINISH_EMOJI: ReactionEmoji.Unicode

Emoji used to destroy the paginator without deleting the message.

FIRST_PAGE_EMOJI

val FIRST_PAGE_EMOJI: ReactionEmoji.Unicode

Emoji used to jump to the first page.

LAST_PAGE_EMOJI

val LAST_PAGE_EMOJI: ReactionEmoji.Unicode

Emoji used to jump to the last page.

LEFT_EMOJI

val LEFT_EMOJI: ReactionEmoji.Unicode

Emoji used to jump to the previous page.

RIGHT_EMOJI

val RIGHT_EMOJI: ReactionEmoji.Unicode

Emoji used to jump to the next page.

SWITCH_EMOJI

val SWITCH_EMOJI: ReactionEmoji.Unicode

Group switch emoji, counter-clockwise arrows icon.

Functions

editingPaginator

inline fun EphemeralMessageInteractionResponseBehavior.editingPaginator(defaultGroup: Key = EMPTY_KEY, locale: Locale? = null, builder: PaginatorBuilder.() -> Unit): EphemeralResponsePaginator

Create a paginator that edits the original interaction. This is the only option for an ephemeral interaction, as it's impossible to edit an ephemeral follow-up.

inline fun PublicMessageInteractionResponseBehavior.editingPaginator(defaultGroup: Key = EMPTY_KEY, locale: Locale? = null, builder: PaginatorBuilder.() -> Unit): PublicResponsePaginator

Create a paginator that edits the original interaction.

EphemeralResponsePaginator

fun EphemeralResponsePaginator(builder: PaginatorBuilder, interaction: EphemeralMessageInteractionResponseBehavior): EphemeralResponsePaginator

Convenience function for creating an interaction button paginator from a paginator builder.

MessageButtonPaginator

fun MessageButtonPaginator(pingInReply: Boolean = true, targetChannel: MessageChannelBehavior? = null, targetMessage: Message? = null, builder: PaginatorBuilder): MessageButtonPaginator

Convenience function for creating a message button paginator from a paginator builder.

PublicFollowUpPaginator

fun PublicFollowUpPaginator(builder: PaginatorBuilder, interaction: FollowupPermittingInteractionResponseBehavior): PublicFollowUpPaginator

Convenience function for creating an interaction button paginator from a paginator builder.

PublicResponsePaginator

fun PublicResponsePaginator(builder: PaginatorBuilder, interaction: PublicMessageInteractionResponseBehavior): PublicResponsePaginator

Convenience function for creating an interaction button paginator from a paginator builder.

respondingPaginator

inline fun FollowupPermittingInteractionResponseBehavior.respondingPaginator(defaultGroup: Key = EMPTY_KEY, locale: Locale? = null, builder: PaginatorBuilder.() -> Unit): PublicFollowUpPaginator

Create a paginator that creates a follow-up message, and edits that.