Class MessagePagination<T>

Handles interactive paginated messages using components v2 buttons.

Create an instance via paginate(...) which will build pages and register the message component collector automatically.

Methods:

nextPage() / prevPage() to change the page
stop() to disable buttons and stop listening

Type Parameters

T extends ItemType

Index

Constructors

Properties

accentColor context currentPage header? items maxPage

Accessors

Methods

createButtonListener createContainer isSectionPagination isTextDisplayPagination nextPage prevPage register stop update

Constructors

constructor

new MessagePagination<T extends ItemType>(
    currentPage: number,
    maxPage: number,
    items: T[][],
    accentColor: RGBTuple,
    header?: string,
): MessagePagination<T>
Type Parameters
- T extends ItemType
Parameters
- currentPage: number
- maxPage: number
- items: T[][]
- accentColor: RGBTuple
- Optionalheader: string
Returns MessagePagination<T>
- Defined in pagination.ts:56

Properties

accentColor

accentColor: RGBTuple

context

context: CommandContext

currentPage

currentPage: number

`Optional`header

header?: string

items

items: T[][]

maxPage

maxPage: number

Accessors

isStopped

get isStopped(): boolean
Returns boolean
- Defined in pagination.ts:76

Methods

createButtonListener

createButtonListener(message: Message<boolean>): void
Parameters
- message: Message<boolean>
Returns void
- Defined in pagination.ts:204

createContainer

createContainer(): ContainerBuilder
Returns ContainerBuilder
- Defined in pagination.ts:145

isSectionPagination

isSectionPagination(): this is MessagePagination<SectionBuilder>
Returns this is MessagePagination<SectionBuilder>
- Defined in pagination.ts:86

isTextDisplayPagination

isTextDisplayPagination(): this is MessagePagination<TextDisplayBuilder>
Returns this is MessagePagination<TextDisplayBuilder>
- Defined in pagination.ts:80

nextPage

nextPage(): Promise<void>
Returns Promise<void>
- Defined in pagination.ts:131

prevPage

prevPage(): Promise<void>
Returns Promise<void>
- Defined in pagination.ts:138

register

register(ctx: CommandContext): Promise<void>
Parameters
- ctx: CommandContext
Returns Promise<void>
- Defined in pagination.ts:176

stop

stop(): Promise<void>
Returns Promise<void>
- Defined in pagination.ts:105

update

update(): Promise<void>
Returns Promise<void>
- Defined in pagination.ts:92