Skip to main content

Interface: PaginatedMessageOptions

@sapphire/discord.js-utilities.PaginatedMessageOptions

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:198


embedFooterSeparator

Optional embedFooterSeparator: string

Seealso

embedFooterSeparator

Defined in

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


pageIndexPrefix

Optional pageIndexPrefix: string

Seealso

pageIndexPrefix

Defined in

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


pages

Optional pages: PaginatedMessagePage[]

The pages to display in this PaginatedMessage

Defined in

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


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:218


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:202