RichMenu | klasa

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

Hierarchy

RichDisplay
- RichMenu

Index

Constructors

constructor

Properties

Accessors

template

Methods

Constructors

constructor

new RichMenu(options: RichDisplayOptions): RichMenu

Overrides RichDisplay.constructor
- Defined in src/lib/util/RichMenu.ts:41
Parameters
- options: RichDisplayOptions
  
  The RichDisplay options
Returns RichMenu

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

Private paginated

paginated: boolean = false

If options have been paginated yet

since: 0.4.0

Accessors

Protected template

get template(): Embed

Inherited from RichDisplay.template
- Defined in src/lib/util/RichDisplay.ts:193
A new instance of the template embed

since

0.4.0

Returns Embed

Methods

addChoice

addChoice(name: string, body: string, inline?: boolean): this

- Defined in src/lib/util/RichMenu.ts:79
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

Overrides RichDisplay.addPage
- Defined in src/lib/util/RichMenu.ts:68
You cannot directly add pages in a RichMenu

since

0.4.0

Returns never

Private paginate

paginate(): null

- Defined in src/lib/util/RichMenu.ts:102
Converts MenuOptions into display pages

since

0.4.0

Returns null

run

run(message: Message, options?: ReactionHandlerOptions): Promise<ReactionHandler>

Overrides RichDisplay.run
- Defined in src/lib/util/RichMenu.ts:90
Runs this RichMenu

since

0.4.0

Parameters
- message: Message
- Default value options: ReactionHandlerOptions = {}
  
  The options to use with this RichMenu
Returns Promise<ReactionHandler>

setEmojis

setEmojis(emojis: Record<ReactionMethods, string>): this

Inherited from RichDisplay.setEmojis
- Defined in src/lib/util/RichDisplay.ts:131
Sets emojis to a new set of emojis

since

0.4.0

Parameters
- emojis: Record<ReactionMethods, string>
  
  An object containing replacement emojis to use instead
Returns this

setFooterPrefix

setFooterPrefix(prefix: string): this

Inherited from RichDisplay.setFooterPrefix
- Defined in src/lib/util/RichDisplay.ts:143
Sets a prefix for all footers

since

0.5.0

Parameters
- prefix: string
  
  The prefix you want to add
Returns this

setFooterSuffix

setFooterSuffix(suffix: string): this

Inherited from RichDisplay.setFooterSuffix
- Defined in src/lib/util/RichDisplay.ts:154
Sets a suffix for all footers

since

0.5.0

Parameters
- suffix: string
  
  The suffix you want to add
Returns this

setInfoPage

setInfoPage(embed: EmbedOrCallback): this

Inherited from RichDisplay.setInfoPage
- Defined in src/lib/util/RichDisplay.ts:184
Adds an info page to the RichDisplay

since

0.4.0

Parameters
- embed: EmbedOrCallback
  
  A callback with the embed template passed and the embed returned, or an embed
Returns this

useCustomFooters

useCustomFooters(): this

Inherited from RichDisplay.useCustomFooters
- Defined in src/lib/util/RichDisplay.ts:164
Turns off the footer altering function

since

0.5.0

Returns this

Hierarchy

Index

Constructors

Properties

Accessors

Methods

Constructors

constructor

Parameters

options: RichDisplayOptions

Returns RichMenu

Properties

Protected _emojis

Protected _footered

Protected _template

choices

infoPage

pages

Private paginated

Accessors

Protected template

Returns Embed

Methods

addChoice

Parameters

name: string

body: string

Default value inline: boolean = false

Returns this

addPage

Returns never

Private paginate

Returns null

run

Parameters

message: Message

Default value options: ReactionHandlerOptions = {}

Returns Promise<ReactionHandler>

setEmojis

Parameters

emojis: Record<ReactionMethods, string>

Returns this

setFooterPrefix

Parameters

prefix: string

Returns this

setFooterSuffix

Parameters

suffix: string

Returns this

setInfoPage

Parameters

embed: EmbedOrCallback

Returns this

useCustomFooters

Returns this