Options
All
  • Public
  • Public/Protected
  • All
Menu

Class RichMenu

Klasa's RichMenu, for helping paginated embeds with reaction buttons

Hierarchy

Index

Constructors

constructor

Properties

Protected _emojis

_emojis: Cache<ReactionMethods, string> = new Cache()

The emojis to use for this display

since

0.4.0

Protected _footered

_footered: boolean = false

If footers have been applied to all pages

since

0.4.0

Protected _template

_template: Embed

The embed template

since

0.4.0

choices

choices: Choice[] = []

The menu choices

since

0.6.0

infoPage

infoPage: Embed | null = null

An optional Info page/embed

since

0.4.0

pages

pages: Embed[] = []

The stored pages of the display

since

0.4.0

Private paginated

paginated: boolean = false

If options have been paginated yet

since

0.4.0

Accessors

Protected template

  • get template(): Embed

Methods

addChoice

  • addChoice(name: string, body: string, inline?: boolean): this
  • Adds a menu choice

    since

    0.6.0

    Parameters

    • name: string

      The name of the choice

    • body: string

      The description of the choice

    • Default value inline: boolean = false

      Whether the choice should be inline

    Returns this

addPage

  • addPage(): never

Private paginate

  • paginate(): null

run

setEmojis

setFooterPrefix

  • setFooterPrefix(prefix: string): this

setFooterSuffix

  • setFooterSuffix(suffix: string): this

setInfoPage

useCustomFooters

  • useCustomFooters(): this

Generated using TypeDoc