Interface: PaginatedMessageOptions
Options for configuring a paginated message.
Properties
actions?
optionalactions:PaginatedMessageAction[]
Custom actions to provide when sending the paginated message.
Source
embedFooterSeparator?
optionalembedFooterSeparator:string
The separator to display between the embed footer and the page index.
Seealso
PaginatedMessage.embedFooterSeparator
Source
pageIndexPrefix?
optionalpageIndexPrefix:string
The prefix to display before the page index.
Seealso
PaginatedMessage.pageIndexPrefix
Source
pages?
optionalpages:PaginatedMessagePage[]
The pages to display in this PaginatedMessage.
Source
paginatedMessageData?
optionalpaginatedMessageData: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
Source
template?
optionaltemplate:BaseMessageOptions|EmbedBuilder
The EmbedBuilder or MessageOptions options to apply to the entire PaginatedMessage.