Class MessagePagination<T>

constructor

• new MessagePagination<T extends ItemType>(
      currentPage: number,
      maxPage: number,
      items: readonly (readonly T[])[],
      accentColor: RGBTuple,
      header?: string,
      options?: PaginationOptions,
  ): MessagePagination<T>

  Type Parameters

  • T extends ItemType

  Parameters

  • currentPage: number
  • maxPage: number
  • items: readonly (readonly T[])[]
  • accentColor: RGBTuple
  • Optionalheader: string
  • options: PaginationOptions = {}

  Returns MessagePagination<T>

accentColor

context

Optionalheader

Readonlyitems

ReadonlymaxPage

currentPage

• get currentPage(): number

  Returns number

isStopped

• get isStopped(): boolean

  Returns boolean

createButtonListener

• createButtonListener(message: Message): void

  Parameters

  • message: Message

  Returns void

createContainer

• createContainer(): ContainerBuilder

  Build the current page without mutating the stored item templates.

  Returns ContainerBuilder

isSectionPagination

• isSectionPagination(): this is MessagePagination<SectionBuilder>

  Returns this is MessagePagination<SectionBuilder>

isTextDisplayPagination

• isTextDisplayPagination(): this is MessagePagination<TextDisplayBuilder>

  Returns this is MessagePagination<TextDisplayBuilder>

nextPage

• nextPage(): Promise<void>

  Returns Promise<void>

prevPage

• prevPage(): Promise<void>

  Returns Promise<void>

register

• register(ctx: CommandContext): Promise<void>

  Send a new reply or replace an existing/deferred reply.

  Parameters

  • ctx: CommandContext

  Returns Promise<void>

stop

• stop(): Promise<void>

  Stop collecting immediately, then disable the buttons. Safe to repeat.

  Returns Promise<void>

update

• update(): Promise<void>

  Refresh the active message. Does nothing after the pagination stops.

  Returns Promise<void>