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


embedFooterSeparator

โ€ข Optional embedFooterSeparator: string

seealso PaginatedMessage.embedFooterSeparator

Defined in

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


pageIndexPrefix

โ€ข Optional pageIndexPrefix: string

seealso PaginatedMessage.pageIndexPrefix

Defined in

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


pages

โ€ข Optional pages: PaginatedMessagePage[]

The pages to display in this PaginatedMessage

Defined in

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


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


template

โ€ข Optional template: MessageOptions | MessageEmbed

The {@link MessageEmbed} or {@link MessageOptions} options to apply to the entire PaginatedMessage

Defined in

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