Class EmbedPager

Page class for Navigation. Subclass this to get started.

Hierarchy (View Summary)

Page
- EmbedPager

Index

Constructors

Properties

additionalButtons embeds index log nav wrap

Methods

getButtons getEmbed getExtras updater useUpdater

Constructors

constructor

new EmbedPager(
embeds: EmbedBuilder[],
additionalButtons: CustomButtonInitializer<EmbedPager>[],
): EmbedPager
Parameters
- embeds: EmbedBuilder[]
- additionalButtons: CustomButtonInitializer<EmbedPager>[]
Returns EmbedPager
Overrides Page.constructor
- Defined in pages/embedPager.ts:9

Properties

additionalButtons

additionalButtons: CustomButton[]

embeds

embeds: EmbedBuilder[]

index

index: number = 0

`Readonly`log

log: Logger<ILogObj> = ...

nav

nav: Navigation

wrap

wrap: boolean = false

Methods

getButtons

getButtons(): CustomButton[]
Gets all the buttons this page uses.

Returns CustomButton[]
Overrides Page.getButtons
- Defined in pages/embedPager.ts:25

getEmbed

getEmbed(): EmbedBuilder
Get the base embed for this page.

Returns EmbedBuilder
Overrides Page.getEmbed
- Defined in pages/embedPager.ts:14

getExtras

getExtras(): ExtraElement[]
Gets all the extra message components this page uses.

Returns ExtraElement[]
Inherited from Page.getExtras
- Defined in navigation.ts:324

updater

updater(): Promise<EmbedBuilder>
If enabled, this function will be called every second to update the embed. The message is only updated if the new embed is different from the previous one.

Returns Promise<EmbedBuilder>
The updated embed.
Inherited from Page.updater
- Defined in navigation.ts:340

useUpdater

useUpdater(): boolean
Enable or disable the periodic updater for this page.

Returns boolean
Inherited from Page.useUpdater
- Defined in navigation.ts:331