Options
All
  • Public
  • Public/Protected
  • All
Menu

Hierarchy

  • EventEmitter
    • Menu

Index

Constructors

  • new Menu(channel: TextBasedChannel, userID: string, pages: Page[], ms?: number): Menu
  • Parameters

    • channel: TextBasedChannel

      A channel that the menu will be displayed in

    • userID: string

      The userId that the bot will assign the menu to

    • pages: Page[]

      Array of pages to display

    • ms: number = 180000

      Time before the menu stops

    Returns Menu

Properties

buttonCollector: InteractionCollector<ButtonInteraction<CacheType>>
buttons: MenuOption[]
channel: TextBasedChannel
components: MessageActionRow[]
currentPage: Page
menu: Message<boolean>
ms: number
pageIndex: number
pages: Page[]
selectCollector: InteractionCollector<SelectMenuInteraction<CacheType>>
userID: string

Methods

  • addRows(): void
  • Add all of the rows to the page

    Returns void

  • awaitButtons(): void
  • Start an interaction collector and switch pages where required.

    Returns void

  • awaitMenu(): void
  • Start an interaction collector and switch pages where required

    Returns void

  • clearButtons(): Promise<void | Message<boolean>>
  • Remove all reactions from the menu message.

    Returns Promise<void | Message<boolean>>

  • delete(): Promise<void>
  • Delete the menu message.

    Returns Promise<void>

  • forceCallback(rowIndex: number, buttonIndex: number, i: any): void
  • Parameters

    • rowIndex: number

      The row index that contains the button

    • buttonIndex: number

      Index of the button/select menu option

    • i: any

      A value to pass into the callback since no interaction data is created

    Returns void

  • setPage(page?: number): Promise<void | Message<boolean>>
  • Jump to a new page in the Menu.

    Parameters

    • page: number = 0

      The index of the page the Menu should jump to.

    Returns Promise<void | Message<boolean>>

  • start(): Promise<void | Message<boolean>>
  • Send the message with all of the buttons in the page, then listen for events

    Returns Promise<void | Message<boolean>>

  • stop(): void
  • Stop listening for new events

    Returns void

  • stopWithoutClearingButtons(): void
  • Stop listening for new events but without clearing buttons

    Returns void

Generated using TypeDoc