Class: PaginatedMessage
@sapphire/discord.js-utilities.PaginatedMessage
This is a PaginatedMessage, a utility to paginate messages (usually embeds). You must either use this class directly or extend it.
Remark
Please note that for PaginatedMessage to work in DMs to your client, you need to add the 'CHANNEL'
partial to your client.options.partials
.
Message based commands can always be used in DMs, whereas Chat Input interactions can only be used in DMs when they are registered globally.
PaginatedMessage uses MessageComponent buttons that perform the specified action when clicked. You can either use your own actions or the PaginatedMessage.defaultActions. PaginatedMessage.defaultActions is also static so you can modify these directly.
PaginatedMessage also uses pages via Messages.
Example
const myPaginatedMessage = new PaginatedMessage();
// Once you have an instance of PaginatedMessage you can call various methods on it to add pages to it.
// For more details see each method's documentation.
myPaginatedMessage.addPageEmbed((embed) => {
embed
.setColor('#FF0000')
.setDescription('example description');
return embed;
});
myPaginatedMessage.addPageBuilder((builder) => {
const embed = new EmbedBuilder()
.setColor('#FF0000')
.setDescription('example description');
return builder
.setContent('example content')
.setEmbeds([embed]);
});
myPaginatedMessage.addPageContent('Example');
myPaginatedMessage.run(message)
Remark
You can also provide a EmbedBuilder template. This will be applied to every page. If a page itself has an embed then the two will be merged, with the content of the page's embed taking priority over the template.
Furthermore, if the template has a footer then it will be applied after the page index part of the footer
with a space preceding the template. For example, when setting - Powered by Sapphire Framework
the resulting footer will be 1/2 - Powered by Sapphire Framework
Example
const myPaginatedMessage = new PaginatedMessage({
template: new EmbedBuilder().setColor('#FF0000').setFooter('- Powered by Sapphire framework')
});
Remark
To utilize actions you can implement IPaginatedMessageAction into a class.
Example
class ForwardAction implements IPaginatedMessageAction {
public id = '▶️';
public run({ handler }) {
if (handler.index !== handler.pages.length - 1) ++handler.index;
}
}
// You can also give the object directly.
const StopAction: IPaginatedMessageAction = {
customId: 'CustomStopAction',
run: ({ collector }) => {
collector.stop();
}
}
Hierarchy
-
PaginatedMessage
Constructors
constructor
• new PaginatedMessage(«destructured»?
): PaginatedMessage
Constructor for the PaginatedMessage class
Parameters
Name | Type | Description |
---|---|---|
«destructured» | PaginatedMessageOptions | The PaginatedMessageOptions for this instance of the PaginatedMessage class |
Returns
Defined in
projects/utilities/packages/discord.js-utilities/src/lib/PaginatedMessages/PaginatedMessage.ts:516
Properties
#thisMazeWasNotMeantForYouContent
• Private
#thisMazeWasNotMeantForYouContent: Object
The response we send when someone gets into an invalid flow
Type declaration
Name | Type |
---|---|
content | string |
Defined in
projects/utilities/packages/discord.js-utilities/src/lib/PaginatedMessages/PaginatedMessage.ts:509
actions
• actions: Map
<string
, PaginatedMessageAction
>
The actions which are to be used.
Defined in
projects/utilities/packages/discord.js-utilities/src/lib/PaginatedMessages/PaginatedMessage.ts:401
collector
• collector: null
| InteractionCollector
<PaginatedMessageInteractionUnion
> = null
The collector used for handling component interactions.
Defined in
projects/utilities/packages/discord.js-utilities/src/lib/PaginatedMessages/PaginatedMessage.ts:391
constructor
• constructor: typeof PaginatedMessage
The constructor
field represents the constructor of the PaginatedMessage
interface.
It is of type typeof PaginatedMessage
, which means it refers to the type of the PaginatedMessage
interface itself.
Defined in
projects/utilities/packages/discord.js-utilities/src/lib/PaginatedMessages/PaginatedMessage.ts:1844
embedFooterSeparator
• embedFooterSeparator: string
= PaginatedMessage.embedFooterSeparator
Custom separator to show after the page index in the embed footer.
PaginatedMessage will automatically add a space (
) after the given text. You do not have to add it yourself.
Default
PaginatedMessage.embedFooterSeparator
(static property)
Defined in
projects/utilities/packages/discord.js-utilities/src/lib/PaginatedMessages/PaginatedMessage.ts:438
emitPartialDMChannelWarning
• emitPartialDMChannelWarning: boolean
= PaginatedMessage.emitPartialDMChannelWarning
Whether to emit the warning about running a PaginatedMessage in a DM channel without the client having the 'CHANNEL'
partial.
Remark
When using message based commands (as opposed to Application Commands) then you will also need to specify the DIRECT_MESSAGE
intent for PaginatedMessage to work.
Default
PaginatedMessage.emitPartialDMChannelWarning
(static property)
Defined in
projects/utilities/packages/discord.js-utilities/src/lib/PaginatedMessages/PaginatedMessage.ts:452
hasEmittedMaxPageWarning
• Protected
hasEmittedMaxPageWarning: boolean
= false
Tracks whether a warning was already emitted for this PaginatedMessage concerning the maximum amount of pages in the SelectMenu.
Default
false
Defined in
projects/utilities/packages/discord.js-utilities/src/lib/PaginatedMessages/PaginatedMessage.ts:472
hasEmittedPartialDMChannelWarning
• Protected
hasEmittedPartialDMChannelWarning: boolean
= false
Tracks whether a warning was already emitted for this PaginatedMessage
concerning the PaginatedMessage being called in a DMChannel
without the client having the 'Channel'
partial.
Remark
When using message based commands (as opposed to Application Commands) then you will also need to specify the DIRECT_MESSAGE
intent for PaginatedMessage to work.
Default
false
Defined in
projects/utilities/packages/discord.js-utilities/src/lib/PaginatedMessages/PaginatedMessage.ts:482
idle
• idle: number
The amount of milliseconds to idle before the paginator is closed.
Default
14.5 minutes
Remark
This is to ensure it is a bit before interactions expire.
Defined in
projects/utilities/packages/discord.js-utilities/src/lib/PaginatedMessages/PaginatedMessage.ts:418
index
• index: number
= 0
The handler's current page/message index.
Defined in
projects/utilities/packages/discord.js-utilities/src/lib/PaginatedMessages/PaginatedMessage.ts:411
messages
• messages: (null
| PaginatedMessageResolvedPage
)[] = []
The pages which were converted from PaginatedMessage.pages
Defined in
projects/utilities/packages/discord.js-utilities/src/lib/PaginatedMessages/PaginatedMessage.ts:396
pageActions
• pageActions: (null
| Map
<string
, PaginatedMessageAction
>)[] = []
The page-specific actions which are to be used.
Defined in
projects/utilities/packages/discord.js-utilities/src/lib/PaginatedMessages/PaginatedMessage.ts:406
pageIndexPrefix
• pageIndexPrefix: string
= PaginatedMessage.pageIndexPrefix
Custom text to show in front of the page index in the embed footer.
PaginatedMessage will automatically add a space (
) after the given text. You do not have to add it yourself.
Default
PaginatedMessage.pageIndexPrefix
(static property)
Defined in
projects/utilities/packages/discord.js-utilities/src/lib/PaginatedMessages/PaginatedMessage.ts:431
pages
• pages: PaginatedMessagePage
[] = []
The pages to be converted to PaginatedMessage.messages
Defined in
projects/utilities/packages/discord.js-utilities/src/lib/PaginatedMessages/PaginatedMessage.ts:381
paginatedMessageData
• Protected
paginatedMessageData: null
| Omit
<PaginatedMessageMessageOptionsUnion
, "components"
> = null
Data for the paginated message.
Defined in
projects/utilities/packages/discord.js-utilities/src/lib/PaginatedMessages/PaginatedMessage.ts:459
response
• response: null
| Message
<boolean
> | AnyInteractableInteraction
= null
The response message used to edit on page changes.
Defined in
projects/utilities/packages/discord.js-utilities/src/lib/PaginatedMessages/PaginatedMessage.ts:386
selectMenuOptions
• Protected
selectMenuOptions: PaginatedMessageSelectMenuOptionsFunction
= PaginatedMessage.selectMenuOptions
Function that returns the select menu options for the paginated message.
Param
The paginated message.
Defined in
projects/utilities/packages/discord.js-utilities/src/lib/PaginatedMessages/PaginatedMessage.ts:499
selectMenuPlaceholder
• Protected
selectMenuPlaceholder: undefined
| string
= undefined
The placeholder for the select menu.
Defined in
projects/utilities/packages/discord.js-utilities/src/lib/PaginatedMessages/PaginatedMessage.ts:464
shouldAddFooterToEmbeds
• Protected
shouldAddFooterToEmbeds: boolean
= true
Determines whether the default footer that shows the current page number should be added to the embeds.
Note
If this is set to false, i.e.e through setShouldAddFooterToEmbeds, then embedFooterSeparator is never applied.
Default
true
Defined in
projects/utilities/packages/discord.js-utilities/src/lib/PaginatedMessages/PaginatedMessage.ts:492
stopPaginatedMessageCustomIds
• stopPaginatedMessageCustomIds: string
[] = PaginatedMessage.stopPaginatedMessageCustomIds
A list of customId
that are bound to actions that will stop the PaginatedMessage
Default
PaginatedMessage.stopPaginatedMessageCustomIds
(static property)
Defined in
projects/utilities/packages/discord.js-utilities/src/lib/PaginatedMessages/PaginatedMessage.ts:444
template
• template: PaginatedMessageMessageOptionsUnion
The template for this PaginatedMessage. You can use templates to set defaults that will apply to each and every page in the PaginatedMessage
Defined in
projects/utilities/packages/discord.js-utilities/src/lib/PaginatedMessages/PaginatedMessage.ts:424
wrongUserInteractionReply
• Protected
wrongUserInteractionReply: PaginatedMessageWrongUserInteractionReplyFunction
= PaginatedMessage.wrongUserInteractionReply
Function that handles the reply when a user interacts with the paginated message incorrectly.
Defined in
projects/utilities/packages/discord.js-utilities/src/lib/PaginatedMessages/PaginatedMessage.ts:504
defaultActions
▪ Static
defaultActions: PaginatedMessageAction
[]
The default actions of this handler.
Defined in
projects/utilities/packages/discord.js-utilities/src/lib/PaginatedMessages/PaginatedMessage.ts:142
deletionStopReasons
▪ Static
deletionStopReasons: string
[]
The reasons sent by InteractionCollector#end event when the message (or its owner) has been deleted.
Defined in
projects/utilities/packages/discord.js-utilities/src/lib/PaginatedMessages/PaginatedMessage.ts:228
embedFooterSeparator
▪ Static
embedFooterSeparator: string
= '•'
Custom separator for the page index in the embed footer.
Default
"•"
Remark
To overwrite this property change it somewhere in a "setup" file, i.e. where you also call client.login()
for your client.
Alternatively, you can also customize it on a per-PaginatedMessage basis by passing embedFooterSeparator
in the options of the constructor.
Example
import { PaginatedMessage } from '@sapphire/discord.js-utilities';
PaginatedMessage.embedFooterSeparator = '|';
// This will make the separator of the embed footer something like "Page 1/2 | Today at 4:20"
Defined in
projects/utilities/packages/discord.js-utilities/src/lib/PaginatedMessages/PaginatedMessage.ts:258
emitPartialDMChannelWarning
▪ Static
emitPartialDMChannelWarning: boolean
= true
Whether to emit the warning about running a PaginatedMessage in a DM channel without the client the 'CHANNEL'
partial.
Remark
When using message based commands (as opposed to Application Commands) then you will also need to specify the DIRECT_MESSAGE
intent for PaginatedMessage to work.
Remark
To overwrite this property change it somewhere in a "setup" file, i.e. where you also call client.login()
for your client.
Alternatively, you can also customize it on a per-PaginatedMessage basis by using paginatedMessageInstance.setEmitPartialDMChannelWarning(newBoolean)
Default
true
Defined in
projects/utilities/packages/discord.js-utilities/src/lib/PaginatedMessages/PaginatedMessage.ts:208
handlers
▪ Static
Readonly
handlers: Map
<string
, PaginatedMessage
>
The current InteractionCollector handlers that are active. The key is the ID of of the author who sent the message that triggered this PaginatedMessage
This is to ensure that any given author can only trigger 1 PaginatedMessage. This is important for performance reasons, and users should not have more than 1 PaginatedMessage open at once.
Defined in
projects/utilities/packages/discord.js-utilities/src/lib/PaginatedMessages/PaginatedMessage.ts:276
messages
▪ Static
Readonly
messages: Map
<string
, PaginatedMessage
>
The messages that are currently being handled by a PaginatedMessage The key is the ID of the message that triggered this PaginatedMessage
This is to ensure that only 1 PaginatedMessage can run on a specified message at once. This is important when having an editable commands solution.
Defined in
projects/utilities/packages/discord.js-utilities/src/lib/PaginatedMessages/PaginatedMessage.ts:267
pageIndexPrefix
▪ Static
pageIndexPrefix: string
= ''
Custom text to show in front of the page index in the embed footer.
PaginatedMessage will automatically add a space (
) after the given text. You do not have to add it yourself.
Default
""
Remark
To overwrite this property change it somewhere in a "setup" file, i.e. where you also call client.login()
for your client.
Example
import { PaginatedMessage } from '@sapphire/discord.js-utilities';
PaginatedMessage.pageIndexPrefix = 'Page';
// This will make the footer of the embed something like "Page 1/2"
Defined in
projects/utilities/packages/discord.js-utilities/src/lib/PaginatedMessages/PaginatedMessage.ts:243
selectMenuOptions
▪ Static
selectMenuOptions: PaginatedMessageSelectMenuOptionsFunction
A generator for MessageSelectOption that will be used to generate the options for the StringSelectMenuBuilder. We do not allow overwriting the MessageSelectOption#value property with this, as it is vital to how we handle select menu interactions.
Param
The index of the page to add to the StringSelectMenuBuilder. We will add 1 to this number because our pages are 0 based, so this will represent the pages as seen by the user.
Default
{
label: `Page ${pageIndex}`
}
Remark
To overwrite this property change it in a "setup" file prior to calling client.login()
for your client.
Example
import { PaginatedMessage } from '@sapphire/discord.js-utilities';
PaginatedMessage.selectMenuOptions = (pageIndex) => ({
label: `Go to page: ${pageIndex}`,
description: 'This is a description'
});
Defined in
projects/utilities/packages/discord.js-utilities/src/lib/PaginatedMessages/PaginatedMessage.ts:303
stopPaginatedMessageCustomIds
▪ Static
stopPaginatedMessageCustomIds: string
[]
A list of customId
that are bound to actions that will stop the PaginatedMessage
Default
['@sapphire/paginated-messages.stop']
Remark
To overwrite this property change it somewhere in a "setup" file, i.e. where you also call client.login()
for your client.
Alternatively, you can also customize it on a per-PaginatedMessage basis by using paginatedMessageInstance.setStopPaginatedMessageCustomIds(customIds)
Example
import { PaginatedMessage } from '@sapphire/discord.js-utilities';
PaginatedMessage.stopPaginatedMessageCustomIds = ['my-custom-stop-custom-id'];
Defined in
projects/utilities/packages/discord.js-utilities/src/lib/PaginatedMessages/PaginatedMessage.ts:222
wrongUserInteractionReply
▪ Static
wrongUserInteractionReply: PaginatedMessageWrongUserInteractionReplyFunction
A generator for MessageComponentInteraction#reply that will be called and sent whenever an untargeted user interacts with one of the buttons.
When modifying this it is recommended that the message is set to be ephemeral so only the user that is pressing the buttons can see them.
Furthermore, we also recommend setting allowedMentions: { users: [], roles: [] }
, so you don't have to worry about accidentally pinging anyone.
When setting just a string, we will add { ephemeral: true, allowedMentions: { users: [], roles: [] } }
for you.
Param
The User this PaginatedMessage was intended for.
Param
The User that actually clicked the button.
Default
import { userMention } from 'discord.js';
{
content: `Please stop interacting with the components on this message. They are only for ${userMention(targetUser.id)}.`,
ephemeral: true,
allowedMentions: { users: [], roles: [] }
}
Remark
To overwrite this property change it in a "setup" file prior to calling client.login()
for your client.
Example
import { PaginatedMessage } from '@sapphire/discord.js-utilities';
import { userMention } from 'discord.js';
// We will add ephemeral and no allowed mention for string only overwrites
PaginatedMessage.wrongUserInteractionReply = (targetUser) =>
`These buttons are only for ${userMention(targetUser.id)}. Press them as much as you want, but I won't do anything with your clicks.`;
Example
import { PaginatedMessage } from '@sapphire/discord.js-utilities';
import { userMention } from 'discord.js';
PaginatedMessage.wrongUserInteractionReply = (targetUser) => ({
content: `These buttons are only for ${userMention(
targetUser.id
)}. Press them as much as you want, but I won't do anything with your clicks.`,
ephemeral: true,
allowedMentions: { users: [], roles: [] }
});
Defined in
projects/utilities/packages/discord.js-utilities/src/lib/PaginatedMessages/PaginatedMessage.ts:350
Methods
addAction
▸ addAction(action
): this
Adds an action to the existing ones. This will be added as the last action.
Parameters
Name | Type | Description |
---|---|---|
action | PaginatedMessageAction | The action to add. |
Returns
this
See
PaginatedMessage.setActions for examples on how to structure the action.
Defined in
projects/utilities/packages/discord.js-utilities/src/lib/PaginatedMessages/PaginatedMessage.ts:707
addActions
▸ addActions(actions
): this
Adds actions to the existing ones. The order given is the order they will be used.
Parameters
Name | Type | Description |
---|---|---|
actions | PaginatedMessageAction [] | The actions to add. |
Returns
this
See
PaginatedMessage.setActions for examples on how to structure the actions.
Defined in
projects/utilities/packages/discord.js-utilities/src/lib/PaginatedMessages/PaginatedMessage.ts:697
addAsyncPageBuilder
▸ addAsyncPageBuilder(builder
): this
Adds a page to the existing ones asynchronously using a MessageBuilder. This wil be added as the last page.
Parameters
Name | Type | Description |
---|---|---|
builder | MessageBuilder | (builder : MessageBuilder ) => Promise <MessageBuilder > | Either a callback whose first parameter is new MessageBuilder() , or an already constructed MessageBuilder |
Returns
this
Example
const { PaginatedMessage } = require('@sapphire/discord.js-utilities');
const { EmbedBuilder } = require('discord.js');
const paginatedMessage = new PaginatedMessage()
.addAsyncPageBuilder(async (builder) => {
const someRemoteData = await fetch('https://contoso.com/api/users');
const embed = new EmbedBuilder()
.setColor('#FF0000')
.setDescription(someRemoteData.data);
return builder
.setContent('example content')
.setEmbeds([embed]);
});
Defined in
projects/utilities/packages/discord.js-utilities/src/lib/PaginatedMessages/PaginatedMessage.ts:857
addAsyncPageEmbed
▸ addAsyncPageEmbed(embed
): this
Adds a page to the existing ones asynchronously using a EmbedBuilder. This wil be added as the last page.
Parameters
Name | Type | Description |
---|---|---|
embed | EmbedResolvable | (builder : EmbedBuilder ) => Awaitable <EmbedResolvable > | Either a callback whose first parameter is new EmbedBuilder() , or an already constructed EmbedBuilder |
Returns
this
Example
const { PaginatedMessage } = require('@sapphire/discord.js-utilities');
const paginatedMessage = new PaginatedMessage()
.addAsyncPageEmbed(async (embed) => {
const someRemoteData = await fetch('https://contoso.com/api/users');
embed
.setColor('#FF0000')
.setDescription(someRemoteData.data);
return embed;
});
Defined in
projects/utilities/packages/discord.js-utilities/src/lib/PaginatedMessages/PaginatedMessage.ts:927
addAsyncPageEmbeds
▸ addAsyncPageEmbeds(embeds
): this
Adds a page to the existing ones using multiple EmbedBuilder's. This wil be added as the last page.
Parameters
Name | Type | Description |
---|---|---|
embeds | EmbedResolvable [] | (embed1 : EmbedBuilder , embed2 : EmbedBuilder , embed3 : EmbedBuilder , embed4 : EmbedBuilder , embed5 : EmbedBuilder , embed6 : EmbedBuilder , embed7 : EmbedBuilder , embed8 : EmbedBuilder , embed9 : EmbedBuilder , embed10 : EmbedBuilder ) => Awaitable <EmbedResolvable []> | Either a callback which receives 10 parameters of new EmbedBuilder() , or an array of already constructed EmbedBuilder's |
Returns
this
Remark
When using this with a callback this will construct 10 EmbedBuilder's in the callback parameters, regardless of how many are actually used. If this a performance impact you do not want to cope with then it is recommended to use PaginatedMessage.addPageBuilder instead, which will let you add as many embeds as you want, albeit manually
Example
const { PaginatedMessage } = require('@sapphire/discord.js-utilities');
const paginatedMessage = new PaginatedMessage().addAsyncPageEmbeds(async (embed0, embed1, embed2) => {
const someRemoteData = (await fetch('https://contoso.com/api/users')) as any;
for (const [index, user] of Object.entries(someRemoteData.users.slice(0, 10)) as [`${0 | 1 | 2 | 3 | 4 | 5 | 6 | 7 | 8 | 9 | 10}`, any][]) {
switch (index) {
case '0': {
embed0.setColor('#FF0000').setDescription('example description 1').setAuthor(user.name);
break;
}
case '1': {
embed1.setColor('#00FF00').setDescription('example description 2').setAuthor(user.name);
break;
}
case '2': {
embed2.setColor('#0000FF').setDescription('example description 3').setAuthor(user.name);
break;
}
}
}
return [embed0, embed1, embed2];
});
Example
const { PaginatedMessage } = require('@sapphire/discord.js-utilities');
const embed1 = new EmbedBuilder()
.setColor('#FF0000')
.setDescription('example description 1');
const embed2 = new EmbedBuilder()
.setColor('#00FF00')
.setDescription('example description 2');
const embed3 = new EmbedBuilder()
.setColor('#0000FF')
.setDescription('example description 3');
const paginatedMessage = new PaginatedMessage()
.addAsyncPageEmbeds([embed1, embed2, embed3]); // You can add up to 10 embeds
Defined in
projects/utilities/packages/discord.js-utilities/src/lib/PaginatedMessages/PaginatedMessage.ts:1069
addPage
▸ addPage(page
): this
Adds a page to the existing ones. This will be added as the last page.
Parameters
Name | Type | Description |
---|---|---|
page | PaginatedMessagePage | The page to add. |
Returns
this
Remark
While you can use this method you should first check out PaginatedMessage.addPageBuilder, PaginatedMessage.addPageContent and PaginatedMessage.addPageEmbed as these are easier functional methods of adding pages and will likely already suffice for your needs.
Defined in
projects/utilities/packages/discord.js-utilities/src/lib/PaginatedMessages/PaginatedMessage.ts:748
addPageAction
▸ addPageAction(action
, index
): this
Add the provided action to a page.
Parameters
Name | Type | Description |
---|---|---|
action | PaginatedMessageAction | The action to add. |
index | number | The index of the page to add the action to. |
Returns
this
See
PaginatedMessage.setActions for examples on how to structure the action.
Remark
Internally we check if the provided index exists. This means that calling this function before calling any of the methods below this will not work as the amount of pages will always be 0, thus the index will always be out of bounds. That said, make sure you first define your pages and then define your actions for those pages.
- PaginatedMessage.addAsyncPageEmbed
- PaginatedMessage.addPageBuilder
- PaginatedMessage.addPageContent
- PaginatedMessage.addPageEmbed
- PaginatedMessage.addPageEmbeds
- PaginatedMessage.addPages
- PaginatedMessage.setPages
Defined in
projects/utilities/packages/discord.js-utilities/src/lib/PaginatedMessages/PaginatedMessage.ts:1201
addPageActions
▸ addPageActions(actions
, index
): this
Add the provided actions to a page.
Parameters
Name | Type | Description |
---|---|---|
actions | PaginatedMessageAction [] | The actions to add. |
index | number | The index of the page to add the actions to. |
Returns
this
See
PaginatedMessage.setActions for examples on how to structure the actions.
Remark
Internally we check if the provided index exists. This means that calling this function before calling any of the methods below this will not work as the amount of pages will always be 0, thus the index will always be out of bounds. That said, make sure you first define your pages and then define your actions for those pages.
- PaginatedMessage.addAsyncPageEmbed
- PaginatedMessage.addPageBuilder
- PaginatedMessage.addPageContent
- PaginatedMessage.addPageEmbed
- PaginatedMessage.addPageEmbeds
- PaginatedMessage.addPages
- PaginatedMessage.setPages
Defined in
projects/utilities/packages/discord.js-utilities/src/lib/PaginatedMessages/PaginatedMessage.ts:1174
addPageBuilder
▸ addPageBuilder(builder
): this
Adds a page to the existing ones using a MessageBuilder. This will be added as the last page.
Parameters
Name | Type | Description |
---|---|---|
builder | MessageBuilder | (builder : MessageBuilder ) => MessageBuilder | Either a callback whose first parameter is new MessageBuilder() , or an already constructed MessageBuilder |
Returns
this
Example
const { PaginatedMessage } = require('@sapphire/discord.js-utilities');
const { EmbedBuilder } = require('discord.js');
const paginatedMessage = new PaginatedMessage()
.addPageBuilder((builder) => {
const embed = new EmbedBuilder()
.setColor('#FF0000')
.setDescription('example description');
return builder
.setContent('example content')
.setEmbeds([embed]);
});
Example
const { EmbedBuilder } = require('discord.js');
const { MessageBuilder, PaginatedMessage } = require('@sapphire/discord.js-utilities');
const embed = new EmbedBuilder()
.setColor('#FF0000')
.setDescription('example description');
const builder = new MessageBuilder()
.setContent('example content')
.setEmbeds([embed]);
const paginatedMessage = new PaginatedMessage()
.addPageBuilder(builder);
Defined in
projects/utilities/packages/discord.js-utilities/src/lib/PaginatedMessages/PaginatedMessage.ts:831
addPageContent
▸ addPageContent(content
): this
Adds a page to the existing ones using simple message content. This will be added as the last page.
Parameters
Name | Type | Description |
---|---|---|
content | string | The content to set. |
Returns
this
Example
const { PaginatedMessage } = require('@sapphire/discord.js-utilities');
const paginatedMessage = new PaginatedMessage()
.addPageContent('example content');
Defined in
projects/utilities/packages/discord.js-utilities/src/lib/PaginatedMessages/PaginatedMessage.ts:872
addPageEmbed
▸ addPageEmbed(embed
): this
Adds a page to the existing ones using a EmbedBuilder. This wil be added as the last page.
Parameters
Name | Type | Description |
---|---|---|
embed | EmbedResolvable | (embed : EmbedBuilder ) => EmbedResolvable | Either a callback whose first parameter is new EmbedBuilder() , or an already constructed EmbedBuilder |
Returns
this
Example
const { PaginatedMessage } = require('@sapphire/discord.js-utilities');
const paginatedMessage = new PaginatedMessage()
.addPageEmbed((embed) => {
embed
.setColor('#FF0000')
.setDescription('example description');
return embed;
});
Example
const { PaginatedMessage } = require('@sapphire/discord.js-utilities');
const embed = new EmbedBuilder()
.setColor('#FF0000')
.setDescription('example description');
const paginatedMessage = new PaginatedMessage()
.addPageEmbed(embed);
Defined in
projects/utilities/packages/discord.js-utilities/src/lib/PaginatedMessages/PaginatedMessage.ts:904
addPageEmbeds
▸ addPageEmbeds(embeds
): this
Adds a page to the existing ones asynchronously using multiple EmbedBuilder's. This wil be added as the last page.
Parameters
Name | Type | Description |
---|---|---|
embeds | EmbedResolvable [] | (embed1 : EmbedBuilder , embed2 : EmbedBuilder , embed3 : EmbedBuilder , embed4 : EmbedBuilder , embed5 : EmbedBuilder , embed6 : EmbedBuilder , embed7 : EmbedBuilder , embed8 : EmbedBuilder , embed9 : EmbedBuilder , embed10 : EmbedBuilder ) => EmbedResolvable [] | Either a callback which receives 10 parameters of new EmbedBuilder() , or an array of already constructed EmbedBuilder's |
Returns
this
Remark
When using this with a callback this will construct 10 EmbedBuilder's in the callback parameters, regardless of how many are actually used. If this a performance impact you do not want to cope with then it is recommended to use PaginatedMessage.addPageBuilder instead, which will let you add as many embeds as you want, albeit manually
Example
const { PaginatedMessage } = require('@sapphire/discord.js-utilities');
const paginatedMessage = new PaginatedMessage()
.addPageEmbeds((embed1, embed2, embed3) => { // You can add up to 10 embeds
embed1
.setColor('#FF0000')
.setDescription('example description 1');
embed2
.setColor('#00FF00')
.setDescription('example description 2');
embed3
.setColor('#0000FF')
.setDescription('example description 3');
return [embed1, embed2, embed3];
});
Example
const { PaginatedMessage } = require('@sapphire/discord.js-utilities');
const embed1 = new EmbedBuilder()
.setColor('#FF0000')
.setDescription('example description 1');
const embed2 = new EmbedBuilder()
.setColor('#00FF00')
.setDescription('example description 2');
const embed3 = new EmbedBuilder()
.setColor('#0000FF')
.setDescription('example description 3');
const paginatedMessage = new PaginatedMessage()
.addPageEmbeds([embed1, embed2, embed3]); // You can add up to 10 embeds
Defined in
projects/utilities/packages/discord.js-utilities/src/lib/PaginatedMessages/PaginatedMessage.ts:978
addPages
▸ addPages(pages
): this
Add pages to the existing ones. The order given is the order they will be used.
Parameters
Name | Type | Description |
---|---|---|
pages | PaginatedMessagePage [] | The pages to add. |
Returns
this
Defined in
projects/utilities/packages/discord.js-utilities/src/lib/PaginatedMessages/PaginatedMessage.ts:1113
applyFooter
▸ applyFooter(message
, index
): PaginatedMessageMessageOptionsUnion
Applies footer to the last embed of the page
Parameters
Name | Type | Description |
---|---|---|
message | PaginatedMessageMessageOptionsUnion | The message options |
index | number | The current index |
Returns
PaginatedMessageMessageOptionsUnion
The message options with the footer applied
Defined in
projects/utilities/packages/discord.js-utilities/src/lib/PaginatedMessages/PaginatedMessage.ts:1672
applyTemplate
▸ applyTemplate(template
, options
): PaginatedMessageMessageOptionsUnion
Applies a template to the provided options, merging them together and applying the template's embeds.
Parameters
Name | Type | Description |
---|---|---|
template | PaginatedMessageMessageOptionsUnion | The template to apply. |
options | PaginatedMessageMessageOptionsUnion | The options to merge with the template. |
Returns
PaginatedMessageMessageOptionsUnion
The merged options with the template's embeds applied.
Defined in
projects/utilities/packages/discord.js-utilities/src/lib/PaginatedMessages/PaginatedMessage.ts:1730
applyTemplateEmbed
▸ applyTemplateEmbed(templateEmbed
, pageEmbeds
): undefined
| (APIEmbed
| JSONEncodable
<APIEmbed
>)[]
Applies a template embed to the page embeds. If the page embeds are nullish, it returns the template embed as an array. If the template embed is nullish, it returns the page embeds. Otherwise, it merges the template embed with the first page embed.
Parameters
Name | Type | Description |
---|---|---|
templateEmbed | undefined | (APIEmbed | JSONEncodable <APIEmbed >)[] | The template embed to apply. |
pageEmbeds | undefined | (APIEmbed | JSONEncodable <APIEmbed >)[] | The page embeds to apply the template to. |
Returns
undefined
| (APIEmbed
| JSONEncodable
<APIEmbed
>)[]
The resulting embeds after applying the template.
Defined in
projects/utilities/packages/discord.js-utilities/src/lib/PaginatedMessages/PaginatedMessage.ts:1749
clone
▸ clone(): PaginatedMessage
Clones the current handler into a new instance.
Returns
Defined in
projects/utilities/packages/discord.js-utilities/src/lib/PaginatedMessages/PaginatedMessage.ts:1398
getAction
▸ getAction(customId
, index
): undefined
| PaginatedMessageAction
Retrieves the PaginatedMessageAction associated with the provided customId and index.
Parameters
Name | Type | Description |
---|---|---|
customId | string | The customId of the action. |
index | number | The index of the action in the pageActions array. |
Returns
undefined
| PaginatedMessageAction
The PaginatedMessageAction associated with the customId and index, or undefined if not found.
Defined in
projects/utilities/packages/discord.js-utilities/src/lib/PaginatedMessages/PaginatedMessage.ts:1829
getPageOptions
▸ getPageOptions(index
): Promise
<undefined
| PaginatedMessageMessageOptionsUnion
>
Get the options of a page.
Parameters
Name | Type | Description |
---|---|---|
index | number | The index of the page. |
Returns
Promise
<undefined
| PaginatedMessageMessageOptionsUnion
>
Defined in
projects/utilities/packages/discord.js-utilities/src/lib/PaginatedMessages/PaginatedMessage.ts:1411
handleActionLoad
▸ handleActionLoad(actions
, messageOrInteraction
, targetUser
): Promise
<MessageActionRowComponentBuilder
[]>
Handles the loading of actions.
Parameters
Name | Type | Description |
---|---|---|
actions | PaginatedMessageAction [] | The actions to be loaded. |
messageOrInteraction | Message <boolean > | AnyInteractableInteraction | The message or interaction that triggered this PaginatedMessage. |
targetUser | User | The user the handler is for. |
Returns
Promise
<MessageActionRowComponentBuilder
[]>
Defined in
projects/utilities/packages/discord.js-utilities/src/lib/PaginatedMessages/PaginatedMessage.ts:1526
handleCollect
▸ handleCollect(targetUser
, channel
, interaction
): Promise
<void
>
Handles the collect
event from the collector.
Parameters
Name | Type | Description |
---|---|---|
targetUser | User | The user the handler is for. |
channel | DMChannel | PartialDMChannel | NewsChannel | StageChannel | TextChannel | PrivateThreadChannel | PublicThreadChannel <boolean > | VoiceChannel | The channel the handler is running at. |
interaction | PaginatedMessageInteractionUnion | The button interaction that was received. |
Returns
Promise
<void
>
Defined in
projects/utilities/packages/discord.js-utilities/src/lib/PaginatedMessages/PaginatedMessage.ts:1586
handleEnd
▸ handleEnd(_
, reason
): Promise
<void
>
Handles the end
event from the collector.
Parameters
Name | Type | Description |
---|---|---|
_ | Collection <string , PaginatedMessageInteractionUnion > | - |
reason | PaginatedMessageStopReasons | The reason for which the collector was ended. |
Returns
Promise
<void
>
Defined in
projects/utilities/packages/discord.js-utilities/src/lib/PaginatedMessages/PaginatedMessage.ts:1639
handlePageLoad
▸ handlePageLoad(page
, index
): Promise
<PaginatedMessageMessageOptionsUnion
>
Handles the load of a page.
Parameters
Name | Type | Description |
---|---|---|
page | PaginatedMessagePage | The page to be loaded. |
index | number | The index of the current page. |
Returns
Promise
<PaginatedMessageMessageOptionsUnion
>
Defined in
projects/utilities/packages/discord.js-utilities/src/lib/PaginatedMessages/PaginatedMessage.ts:1506
hasPage
▸ hasPage(index
): boolean
Checks whether or not the handler has a specific page.
Parameters
Name | Type | Description |
---|---|---|
index | number | The index to check. |
Returns
boolean
Defined in
projects/utilities/packages/discord.js-utilities/src/lib/PaginatedMessages/PaginatedMessage.ts:723
mergeArrays
▸ mergeArrays<T
>(template?
, array?
): undefined
| T
[]
Merges two arrays together.
Type parameters
Name | Description |
---|---|
T | The type of elements in the arrays. |
Parameters
Name | Type | Description |
---|---|---|
template? | T [] | The first array to merge. |
array? | T [] | The second array to merge. |
Returns
undefined
| T
[]
- The merged array or undefined if both arrays are nullish.
Defined in
projects/utilities/packages/discord.js-utilities/src/lib/PaginatedMessages/PaginatedMessage.ts:1810
mergeEmbeds
▸ mergeEmbeds(templateEmbed
, pageEmbeds
): (APIEmbed
| JSONEncodable
<APIEmbed
>)[]
Merges the template embed with an array of page embeds.
Parameters
Name | Type | Description |
---|---|---|
templateEmbed | APIEmbed | JSONEncodable <APIEmbed > | The template embed to merge. |
pageEmbeds | (APIEmbed | JSONEncodable <APIEmbed >)[] | The array of page embeds to merge. |
Returns
(APIEmbed
| JSONEncodable
<APIEmbed
>)[]
The merged embeds.
Defined in
projects/utilities/packages/discord.js-utilities/src/lib/PaginatedMessages/PaginatedMessage.ts:1771
resolvePage
▸ resolvePage(messageOrInteraction
, target
, index
): Promise
<PaginatedMessageResolvedPage
>
Executed whenever an action is triggered and resolved.
Parameters
Name | Type | Description |
---|---|---|
messageOrInteraction | Message <boolean > | AnyInteractableInteraction | The message or interaction that triggered this PaginatedMessage. |
target | User | The user who will be able to interact with the buttons of this PaginatedMessage. |
index | number | The index to resolve. |
Returns
Promise
<PaginatedMessageResolvedPage
>
Defined in
projects/utilities/packages/discord.js-utilities/src/lib/PaginatedMessages/PaginatedMessage.ts:1355
resolvePagesOnRun
▸ resolvePagesOnRun(messageOrInteraction
, target
): Promise
<void
>
Executed whenever PaginatedMessage.run is called.
Parameters
Name | Type |
---|---|
messageOrInteraction | Message <boolean > | AnyInteractableInteraction |
target | User |
Returns
Promise
<void
>
Defined in
projects/utilities/packages/discord.js-utilities/src/lib/PaginatedMessages/PaginatedMessage.ts:1343
resolvePaginatedMessageInternationalizationContext
▸ resolvePaginatedMessageInternationalizationContext(messageOrInteraction
, targetUser
): PaginatedMessageInternationalizationContext
Constructs a PaginatedMessageInternationalizationContext
Parameters
Name | Type | Description |
---|---|---|
messageOrInteraction | Message <boolean > | AnyInteractableInteraction | The message or interaction for which the PaginatedMessageInternationalizationContext should be resolved. |
targetUser | User | The target user for whom this interaction is |
Returns
PaginatedMessageInternationalizationContext
A constructed PaginatedMessageInternationalizationContext
Defined in
projects/utilities/packages/discord.js-utilities/src/lib/PaginatedMessages/PaginatedMessage.ts:1708
run
▸ run(messageOrInteraction
, target?
): Promise
<PaginatedMessage
>
Executes the PaginatedMessage and sends the pages corresponding with PaginatedMessage.index. The handler will start collecting message component interactions.
Parameters
Name | Type | Description |
---|---|---|
messageOrInteraction | Message <boolean > | AnyInteractableInteraction | The message or interaction that triggered this PaginatedMessage. Generally this will be the command message or an interaction (either a CommandInteraction, ContextMenuInteraction, or an interaction from PaginatedMessageInteractionUnion), but it can also be another message from your client, i.e. to indicate a loading state. |
target? | User | The user who will be able to interact with the buttons of this PaginatedMessage. If messageOrInteraction is an instance of Message then this defaults to Message.author messageOrInteraction.author, and if it is an instance of CommandInteraction then it defaults to CommandInteraction.user messageOrInteraction.user. |
Returns
Remark
Please note that for PaginatedMessage to work in DMs to your client, you need to add the 'CHANNEL'
partial to your client.options.partials
.
Message based commands can always be used in DMs, whereas Chat Input interactions can only be used in DMs when they are registered globally.
Defined in
projects/utilities/packages/discord.js-utilities/src/lib/PaginatedMessages/PaginatedMessage.ts:1234
setActions
▸ setActions(actions
, includeDefaultActions?
): this
Clears all current actions and sets them. The order given is the order they will be used.
Parameters
Name | Type | Default value | Description |
---|---|---|---|
actions | PaginatedMessageAction [] | undefined | The actions to set. This can be either a Button, Link Button, or Select Menu. |
includeDefaultActions | boolean | false | Whether to merge in the PaginatedMessage.defaultActions when setting the actions. If you set this to true then you do not need to manually add ...PaginatedMessage.defaultActions as seen in the first example. The default value is false for backwards compatibility within the current major version. |
Returns
this
Remark
You can retrieve the default actions for the regular pagination
Example
const display = new PaginatedMessage();
display.setActions([
...PaginatedMessage.defaultActions,
])
Remark
You can add custom Message Buttons by providing style
, customId
, type
, run
and at least one of label
or emoji
.
Example
const display = new PaginatedMessage();
display.setActions([
{
style: 'PRIMARY',
label: 'My Button',
customId: 'custom_button',
type: ComponentType.Button,
run: (context) => console.log(context)
}
], true);
Remark
You can add custom Message Link Buttons by providing style
, url
, type
, and at least one of label
or emoji
.
Example
const display = new PaginatedMessage();
display.setActions([
{
style: 'LINK',
label: 'Sapphire Website',
emoji: '🔷',
url: 'https://sapphirejs.dev',
type: ComponentType.Button
}
], true);
Remark
You can add custom Select Menus by providing customId
, type
, and run
.
Example
const display = new PaginatedMessage();
display.setActions([
{
customId: 'custom_menu',
type: ComponentType.StringSelect,
run: (context) => console.log(context) // Do something here
}
], true);
Defined in
projects/utilities/packages/discord.js-utilities/src/lib/PaginatedMessages/PaginatedMessage.ts:687
setEmitPartialDMChannelWarning
▸ setEmitPartialDMChannelWarning(emitPartialDMChannelWarning
): this
Sets the PaginatedMessage.emitPartialDMChannelWarning for this instance of PaginatedMessage. This will only apply to this one instance and no others.