Interface: PaginatedMessageOptions

Defined in: projects/utilities/packages/discord.js-utilities/src/lib/PaginatedMessages/PaginatedMessageTypes.ts:205

Options for configuring a paginated message.

Properties

actions?

optional actions: PaginatedMessageAction[]

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

Custom actions to provide when sending the paginated message.

---

embedFooterSeparator?

optional embedFooterSeparator: string

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

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

Seealso

PaginatedMessage.embedFooterSeparator

---

pageIndexPrefix?

optional pageIndexPrefix: string

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

The prefix to display before the page index.

Seealso

PaginatedMessage.pageIndexPrefix

---

pages?

optional pages: PaginatedMessagePage[]

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

The pages to display in this PaginatedMessage.

---

paginatedMessageData?

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

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

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

---

template?

optional template: BaseMessageOptions | EmbedBuilder

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

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