Interface: PaginatedMessageOptions

Options for configuring a paginated message.

Properties

actions?

optional actions: PaginatedMessageAction[]

Custom actions to provide when sending the paginated message.

Defined in

projects/utilities/packages/discord.js-utilities/src/lib/PaginatedMessages/PaginatedMessageTypes.ts:214

---

embedFooterSeparator?

optional embedFooterSeparator: string

The separator to display between the embed footer and the page index.

Seealso

PaginatedMessage.embedFooterSeparator

Defined in

projects/utilities/packages/discord.js-utilities/src/lib/PaginatedMessages/PaginatedMessageTypes.ts:231

---

pageIndexPrefix?

optional pageIndexPrefix: string

The prefix to display before the page index.

Seealso

PaginatedMessage.pageIndexPrefix

Defined in

projects/utilities/packages/discord.js-utilities/src/lib/PaginatedMessages/PaginatedMessageTypes.ts:225

---

pages?

optional pages: PaginatedMessagePage[]

The pages to display in this PaginatedMessage.

Defined in

projects/utilities/packages/discord.js-utilities/src/lib/PaginatedMessages/PaginatedMessageTypes.ts:209

---

paginatedMessageData?

optional paginatedMessageData: null | Omit<PaginatedMessageMessageOptionsUnion, "components">

Additional options that are applied to each message when sending it to Discord. Be careful with using this, misusing it can cause issues, such as sending empty messages.

Remark

This is for advanced usages only!

Default

null

Defined in

projects/utilities/packages/discord.js-utilities/src/lib/PaginatedMessages/PaginatedMessageTypes.ts:240

---

template?

optional template: BaseMessageOptions | EmbedBuilder

The EmbedBuilder or MessageOptions options to apply to the entire PaginatedMessage.

Defined in

projects/utilities/packages/discord.js-utilities/src/lib/PaginatedMessages/PaginatedMessageTypes.ts:219