Interface: PaginatedMessageOptions
@sapphire/discord.js-utilities.PaginatedMessageOptions
Options for configuring a paginated message.
Properties
actions
• Optional actions: PaginatedMessageAction[]
Custom actions to provide when sending the paginated message.
Defined in
embedFooterSeparator
• Optional embedFooterSeparator: string
The separator to display between the embed footer and the page index.
Seealso
PaginatedMessage.embedFooterSeparator
Defined in
pageIndexPrefix
• Optional pageIndexPrefix: string
The prefix to display before the page index.
Seealso
PaginatedMessage.pageIndexPrefix
Defined in
pages
• Optional pages: PaginatedMessagePage[]
The pages to display in this PaginatedMessage.
Defined in
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
template
• Optional template: BaseMessageOptions | EmbedBuilder
The EmbedBuilder or MessageOptions options to apply to the entire PaginatedMessage.