Class MenuPage

This class that represent a page in a menu.

Hierarchy

MenuPage

Index

Constructors

constructor

Properties

Methods

Constructors

constructor

new MenuPage(): MenuPage

- Defined in src/Classes/Page.ts:23
Returns MenuPage

Properties

buttons

buttons: MenuButton[]

content

content: string

embeds

embeds: MessageEmbed[]

files

files: MessageAttachment[]

id

id: string

timeout

timeout: number

type

type: string

Methods

addButton

addButton(button: SingleButton): MenuPage

- Defined in src/Classes/Page.ts:70
A function for add a button to the page. The target is the ID of the page that will be displayed when the button is clicked.

Parameters
- button: SingleButton
Returns MenuPage

addEmbed

addEmbed(embed: MessageEmbed): MenuPage

- Defined in src/Classes/Page.ts:48
A function for add embed that will display in the message page

Parameters
- embed: MessageEmbed
Returns MenuPage

addFile

addFile(file: MessageAttachment): MenuPage

- Defined in src/Classes/Page.ts:99
A function for add a file that will displayed in the page.

Parameters
- file: MessageAttachment
Returns MenuPage

setContent

setContent(content: string): MenuPage

- Defined in src/Classes/Page.ts:58
A function for set the content of the Discord message.

Parameters
- content: string
Returns MenuPage

setId

setId(id: string): MenuPage

- Defined in src/Classes/Page.ts:38
The ID of the page. This ID will be used to identify the page in the button with target.

Parameters
- id: string
Returns MenuPage

setTimeout

setTimeout(timeout: number): MenuPage

- Defined in src/Classes/Page.ts:89
A function for set the timeout before that you are unable to interact with the page.

Parameters
- timeout: number
Returns MenuPage

Generated using TypeDoc