Class MessagePagination

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

Index

Constructors

Properties

accentColor context currentPage header? maxPage sections

Methods

createButtonListener createContainer nextPage prevPage register stop update

Constructors

constructor

new MessagePagination(
    currentPage: number,
    maxPage: number,
    sections: SectionBuilder[][],
    accentColor: RGBTuple,
    header?: string,
): MessagePagination
Parameters
- currentPage: number
- maxPage: number
- sections: SectionBuilder[][]
- accentColor: RGBTuple
- Optionalheader: string
Returns MessagePagination
- Defined in pagination.ts:39

Properties

accentColor

accentColor: RGBTuple

context

context: CommandContext

currentPage

currentPage: number

`Optional`header

header?: string

maxPage

maxPage: number

sections

sections: SectionBuilder[][]

Methods

createButtonListener

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

createContainer

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

nextPage

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

prevPage

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

register

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

stop

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

update

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