Class: PaginatedMessage
discord.js-utilities/src.PaginatedMessage
Hierarchy
PaginatedMessage
Constructors
constructor
• new PaginatedMessage(«destructured»?
)
Parameters
Name | Type | Description |
---|---|---|
«destructured» | PaginatedMessageOptions |
Defined in
projects/utilities/packages/discord.js-utilities/src/lib/PaginatedMessages/PaginatedMessage.ts:230
Properties
#thisMazeWasNotMeantForYouContent
• Private
#thisMazeWasNotMeantForYouContent: Object
Type declaration
Name | Type |
---|---|
content | string |
Defined in
projects/utilities/packages/discord.js-utilities/src/lib/PaginatedMessages/PaginatedMessage.ts:224
actions
• actions: Map
<string
, PaginatedMessageAction
>
Defined in
projects/utilities/packages/discord.js-utilities/src/lib/PaginatedMessages/PaginatedMessage.ts:148
collector
• collector: null
| InteractionCollector
<StringSelectMenuInteraction
<CacheType
> | ButtonInteraction
<CacheType
>> = null
Defined in
projects/utilities/packages/discord.js-utilities/src/lib/PaginatedMessages/PaginatedMessage.ts:138
constructor
• constructor: typeof PaginatedMessage
Defined in
projects/utilities/packages/discord.js-utilities/src/lib/PaginatedMessages/PaginatedMessage.ts:1538
embedFooterSeparator
• embedFooterSeparator: string
= PaginatedMessage.embedFooterSeparator
Defined in
projects/utilities/packages/discord.js-utilities/src/lib/PaginatedMessages/PaginatedMessage.ts:180
emitPartialDMChannelWarning
• emitPartialDMChannelWarning: boolean
= PaginatedMessage.emitPartialDMChannelWarning
Defined in
projects/utilities/packages/discord.js-utilities/src/lib/PaginatedMessages/PaginatedMessage.ts:194
hasEmittedMaxPageWarning
• Protected
hasEmittedMaxPageWarning: boolean
= false
Defined in
projects/utilities/packages/discord.js-utilities/src/lib/PaginatedMessages/PaginatedMessage.ts:210
hasEmittedPartialDMChannelWarning
• Protected
hasEmittedPartialDMChannelWarning: boolean
= false
Defined in
projects/utilities/packages/discord.js-utilities/src/lib/PaginatedMessages/PaginatedMessage.ts:219
idle
• idle: number
Defined in
projects/utilities/packages/discord.js-utilities/src/lib/PaginatedMessages/PaginatedMessage.ts:160
index
• index: number
= 0
Defined in
projects/utilities/packages/discord.js-utilities/src/lib/PaginatedMessages/PaginatedMessage.ts:153
messages
• messages: (null
| PaginatedMessagePage
)[] = []
Defined in
projects/utilities/packages/discord.js-utilities/src/lib/PaginatedMessages/PaginatedMessage.ts:143
pageIndexPrefix
• pageIndexPrefix: string
= PaginatedMessage.pageIndexPrefix
Defined in
projects/utilities/packages/discord.js-utilities/src/lib/PaginatedMessages/PaginatedMessage.ts:173
pages
• pages: PaginatedMessagePage
[]
Defined in
projects/utilities/packages/discord.js-utilities/src/lib/PaginatedMessages/PaginatedMessage.ts:128
paginatedMessageData
• Protected
paginatedMessageData: null
| Omit
<PaginatedMessageMessageOptionsUnion
, "components"
> = null
Defined in
projects/utilities/packages/discord.js-utilities/src/lib/PaginatedMessages/PaginatedMessage.ts:198
response
• response: null
| Message
<boolean
> | APIMessage
| AnyInteractableInteraction
= null
Defined in
projects/utilities/packages/discord.js-utilities/src/lib/PaginatedMessages/PaginatedMessage.ts:133
selectMenuOptions
• Protected
selectMenuOptions: PaginatedMessageSelectMenuOptionsFunction
= PaginatedMessage.selectMenuOptions
Defined in
projects/utilities/packages/discord.js-utilities/src/lib/PaginatedMessages/PaginatedMessage.ts:200
selectMenuPlaceholder
• Protected
selectMenuPlaceholder: undefined
| string
= undefined
Defined in
projects/utilities/packages/discord.js-utilities/src/lib/PaginatedMessages/PaginatedMessage.ts:202
stopPaginatedMessageCustomIds
• stopPaginatedMessageCustomIds: string
[] = PaginatedMessage.stopPaginatedMessageCustomIds
Defined in
projects/utilities/packages/discord.js-utilities/src/lib/PaginatedMessages/PaginatedMessage.ts:186
template
• template: PaginatedMessageMessageOptionsUnion
Defined in
projects/utilities/packages/discord.js-utilities/src/lib/PaginatedMessages/PaginatedMessage.ts:166
wrongUserInteractionReply
• Protected
wrongUserInteractionReply: PaginatedMessageWrongUserInteractionReplyFunction
= PaginatedMessage.wrongUserInteractionReply
Defined in
projects/utilities/packages/discord.js-utilities/src/lib/PaginatedMessages/PaginatedMessage.ts:204
defaultActions
▪ Static
defaultActions: PaginatedMessageAction
[]
Defined in
projects/utilities/packages/discord.js-utilities/src/lib/PaginatedMessages/PaginatedMessage.ts:1311
deletionStopReasons
▪ Static
deletionStopReasons: string
[]
Defined in
projects/utilities/packages/discord.js-utilities/src/lib/PaginatedMessages/PaginatedMessage.ts:1396
embedFooterSeparator
▪ Static
embedFooterSeparator: string
= '•'
Defined in
projects/utilities/packages/discord.js-utilities/src/lib/PaginatedMessages/PaginatedMessage.ts:1426
emitPartialDMChannelWarning
▪ Static
emitPartialDMChannelWarning: boolean
= true
Defined in
projects/utilities/packages/discord.js-utilities/src/lib/PaginatedMessages/PaginatedMessage.ts:1376
handlers
▪ Static
Readonly
handlers: Map
<string
, PaginatedMessage
>
Defined in
projects/utilities/packages/discord.js-utilities/src/lib/PaginatedMessages/PaginatedMessage.ts:1444
messages
▪ Static
Readonly
messages: Map
<string
, PaginatedMessage
>
Defined in
projects/utilities/packages/discord.js-utilities/src/lib/PaginatedMessages/PaginatedMessage.ts:1435
pageIndexPrefix
▪ Static
pageIndexPrefix: string
= ''
Defined in
projects/utilities/packages/discord.js-utilities/src/lib/PaginatedMessages/PaginatedMessage.ts:1411
selectMenuOptions
▪ Static
selectMenuOptions: PaginatedMessageSelectMenuOptionsFunction
Defined in
projects/utilities/packages/discord.js-utilities/src/lib/PaginatedMessages/PaginatedMessage.ts:1471
stopPaginatedMessageCustomIds
▪ Static
stopPaginatedMessageCustomIds: string
[]
Defined in
projects/utilities/packages/discord.js-utilities/src/lib/PaginatedMessages/PaginatedMessage.ts:1390
wrongUserInteractionReply
▪ Static
wrongUserInteractionReply: PaginatedMessageWrongUserInteractionReplyFunction
Defined in
projects/utilities/packages/discord.js-utilities/src/lib/PaginatedMessages/PaginatedMessage.ts:1518
Methods
addAction
▸ addAction(action
): PaginatedMessage
Parameters
Name | Type | Description |
---|---|---|
action | PaginatedMessageAction |
Returns
Defined in
projects/utilities/packages/discord.js-utilities/src/lib/PaginatedMessages/PaginatedMessage.ts:421
addActions
▸ addActions(actions
): PaginatedMessage
Parameters
Name | Type | Description |
---|---|---|
actions | PaginatedMessageAction [] |
Returns
Defined in
projects/utilities/packages/discord.js-utilities/src/lib/PaginatedMessages/PaginatedMessage.ts:411
addAsyncPageBuilder
▸ addAsyncPageBuilder(builder
): PaginatedMessage
Parameters
Name | Type | Description |
---|---|---|
builder | MessageBuilder | (builder : MessageBuilder ) => Promise <MessageBuilder > |
Returns
Defined in
projects/utilities/packages/discord.js-utilities/src/lib/PaginatedMessages/PaginatedMessage.ts:548
addAsyncPageEmbed
▸ addAsyncPageEmbed(embed
): PaginatedMessage
Parameters
Name | Type | Description |
---|---|---|
embed | EmbedBuilder | (builder : EmbedBuilder ) => Promise <EmbedBuilder > |
Returns
Defined in
projects/utilities/packages/discord.js-utilities/src/lib/PaginatedMessages/PaginatedMessage.ts:618
addAsyncPageEmbeds
▸ addAsyncPageEmbeds(embeds
): PaginatedMessage
Parameters
Name | Type | Description |
---|---|---|
embeds | EmbedBuilder [] | (embed1 : EmbedBuilder , embed2 : EmbedBuilder , embed3 : EmbedBuilder , embed4 : EmbedBuilder , embed5 : EmbedBuilder , embed6 : EmbedBuilder , embed7 : EmbedBuilder , embed8 : EmbedBuilder , embed9 : EmbedBuilder , embed10 : EmbedBuilder ) => Promise <EmbedBuilder []> |
Returns
Defined in
projects/utilities/packages/discord.js-utilities/src/lib/PaginatedMessages/PaginatedMessage.ts:760
addPage
▸ addPage(page
): PaginatedMessage
Parameters
Name | Type | Description |
---|---|---|
page | PaginatedMessagePage |
Returns
Defined in
projects/utilities/packages/discord.js-utilities/src/lib/PaginatedMessages/PaginatedMessage.ts:463
addPageBuilder
▸ addPageBuilder(builder
): PaginatedMessage
Parameters
Name | Type | Description |
---|---|---|
builder | MessageBuilder | (builder : MessageBuilder ) => MessageBuilder |
Returns
Defined in
projects/utilities/packages/discord.js-utilities/src/lib/PaginatedMessages/PaginatedMessage.ts:522
addPageContent
▸ addPageContent(content
): PaginatedMessage
Parameters
Name | Type | Description |
---|---|---|
content | string |
Returns
Defined in
projects/utilities/packages/discord.js-utilities/src/lib/PaginatedMessages/PaginatedMessage.ts:563
addPageEmbed
▸ addPageEmbed(embed
): PaginatedMessage
Parameters
Name | Type | Description |
---|---|---|
embed | EmbedBuilder | (embed : EmbedBuilder ) => EmbedBuilder |
Returns
Defined in
projects/utilities/packages/discord.js-utilities/src/lib/PaginatedMessages/PaginatedMessage.ts:595
addPageEmbeds
▸ addPageEmbeds(embeds
): PaginatedMessage
Parameters
Name | Type | Description |
---|---|---|
embeds | EmbedBuilder [] | (embed1 : EmbedBuilder , embed2 : EmbedBuilder , embed3 : EmbedBuilder , embed4 : EmbedBuilder , embed5 : EmbedBuilder , embed6 : EmbedBuilder , embed7 : EmbedBuilder , embed8 : EmbedBuilder , embed9 : EmbedBuilder , embed10 : EmbedBuilder ) => EmbedBuilder [] |
Returns
Defined in
projects/utilities/packages/discord.js-utilities/src/lib/PaginatedMessages/PaginatedMessage.ts:669
addPages
▸ addPages(pages
): PaginatedMessage
Parameters
Name | Type | Description |
---|---|---|
pages | PaginatedMessagePage [] |
Returns
Defined in
projects/utilities/packages/discord.js-utilities/src/lib/PaginatedMessages/PaginatedMessage.ts:804
applyFooter
▸ Protected
applyFooter(message
, index
): PaginatedMessageMessageOptionsUnion
Parameters
Name | Type | Description |
---|---|---|
message | PaginatedMessageMessageOptionsUnion | |
index | number |
Returns
PaginatedMessageMessageOptionsUnion
Defined in
projects/utilities/packages/discord.js-utilities/src/lib/PaginatedMessages/PaginatedMessage.ts:1188
applyTemplate
▸ Private
applyTemplate(template
, options
): PaginatedMessageMessageOptionsUnion
Parameters
Name | Type |
---|---|
template | PaginatedMessageMessageOptionsUnion |
options | PaginatedMessageMessageOptionsUnion |
Returns
PaginatedMessageMessageOptionsUnion
Defined in
projects/utilities/packages/discord.js-utilities/src/lib/PaginatedMessages/PaginatedMessage.ts:1240
applyTemplateEmbed
▸ Private
applyTemplateEmbed(templateEmbed
, pageEmbeds
): undefined
| (APIEmbed
| JSONEncodable
<APIEmbed
>)[]
Parameters
Name | Type |
---|---|
templateEmbed | undefined | (APIEmbed | JSONEncodable <APIEmbed >)[] |
pageEmbeds | undefined | (APIEmbed | JSONEncodable <APIEmbed >)[] |
Returns
undefined
| (APIEmbed
| JSONEncodable
<APIEmbed
>)[]
Defined in
projects/utilities/packages/discord.js-utilities/src/lib/PaginatedMessages/PaginatedMessage.ts:1249
clone
▸ clone(): PaginatedMessage
Returns
Defined in
projects/utilities/packages/discord.js-utilities/src/lib/PaginatedMessages/PaginatedMessage.ts:963
handleCollect
▸ Protected
handleCollect(targetUser
, channel
, interaction
): Promise
<void
>
Parameters
Name | Type | Description |
---|---|---|
targetUser | User | |
channel | DMChannel | PartialDMChannel | NewsChannel | TextChannel | VoiceChannel | PrivateThreadChannel | PublicThreadChannel <boolean > | |
interaction | StringSelectMenuInteraction <CacheType > | ButtonInteraction <CacheType > |
Returns
Promise
<void
>
Defined in
projects/utilities/packages/discord.js-utilities/src/lib/PaginatedMessages/PaginatedMessage.ts:1097
handleEnd
▸ Protected
handleEnd(_
, reason
): Promise
<void
>
Parameters
Name | Type | Description |
---|---|---|
_ | Collection <string , StringSelectMenuInteraction <CacheType > | ButtonInteraction <CacheType >> | - |
reason | PaginatedMessageStopReasons |
Returns
Promise
<void
>
Defined in
projects/utilities/packages/discord.js-utilities/src/lib/PaginatedMessages/PaginatedMessage.ts:1152
handlePageLoad
▸ Protected
handlePageLoad(page
, index
): Promise
<PaginatedMessageMessageOptionsUnion
>
Parameters
Name | Type | Description |
---|---|---|
page | PaginatedMessagePage | |
index | number |
Returns
Promise
<PaginatedMessageMessageOptionsUnion
>
Defined in
projects/utilities/packages/discord.js-utilities/src/lib/PaginatedMessages/PaginatedMessage.ts:1077
hasPage
▸ hasPage(index
): boolean
Parameters
Name | Type | Description |
---|---|---|
index | number |
Returns
boolean
Defined in
projects/utilities/packages/discord.js-utilities/src/lib/PaginatedMessages/PaginatedMessage.ts:438
mergeArrays
▸ Private
mergeArrays<T
>(template?
, array?
): undefined
| T
[]
Type parameters
Name |
---|
T |
Parameters
Name | Type |
---|---|
template? | T [] |
array? | T [] |
Returns
undefined
| T
[]
Defined in
projects/utilities/packages/discord.js-utilities/src/lib/PaginatedMessages/PaginatedMessage.ts:1296
mergeEmbeds
▸ Private
mergeEmbeds(templateEmbed
, pageEmbeds
): (APIEmbed
| JSONEncodable
<APIEmbed
>)[]
Parameters
Name | Type |
---|---|
templateEmbed | APIEmbed | JSONEncodable <APIEmbed > |
pageEmbeds | (APIEmbed | JSONEncodable <APIEmbed >)[] |
Returns
(APIEmbed
| JSONEncodable
<APIEmbed
>)[]
Defined in
projects/utilities/packages/discord.js-utilities/src/lib/PaginatedMessages/PaginatedMessage.ts:1264
resolvePage
▸ resolvePage(index
): Promise
<PaginatedMessagePage
>
Parameters
Name | Type | Description |
---|---|---|
index | number |
Returns
Promise
<PaginatedMessagePage
>
Defined in
projects/utilities/packages/discord.js-utilities/src/lib/PaginatedMessages/PaginatedMessage.ts:946
resolvePagesOnRun
▸ resolvePagesOnRun(): Promise
<void
>
Returns
Promise
<void
>
Defined in
projects/utilities/packages/discord.js-utilities/src/lib/PaginatedMessages/PaginatedMessage.ts:936
resolvePaginatedMessageInternationalizationContext
▸ Protected
resolvePaginatedMessageInternationalizationContext(messageOrInteraction
, targetUser
): PaginatedMessageInternationalizationContext
Parameters
Name | Type | Description |
---|---|---|
messageOrInteraction | Message <boolean > | AnyInteractableInteraction | |
targetUser | User |
Returns
PaginatedMessageInternationalizationContext
Defined in
projects/utilities/packages/discord.js-utilities/src/lib/PaginatedMessages/PaginatedMessage.ts:1225
run
▸ run(messageOrInteraction
, target?
): Promise
<PaginatedMessage
>
Parameters
Name | Type | Description |
---|---|---|
messageOrInteraction | Message <boolean > | AnyInteractableInteraction | |
target? | User |
Returns
Promise
<PaginatedMessage
>
Defined in
projects/utilities/packages/discord.js-utilities/src/lib/PaginatedMessages/PaginatedMessage.ts:827
setActions
▸ setActions(actions
, includeDefaultActions?
): PaginatedMessage
Parameters
Name | Type | Default value | Description |
---|---|---|---|
actions | PaginatedMessageAction [] | undefined | |
includeDefaultActions | boolean | false |
Returns
Defined in
projects/utilities/packages/discord.js-utilities/src/lib/PaginatedMessages/PaginatedMessage.ts:401
setEmitPartialDMChannelWarning
▸ setEmitPartialDMChannelWarning(emitPartialDMChannelWarning
): PaginatedMessage
Parameters
Name | Type | Description |
---|---|---|
emitPartialDMChannelWarning | boolean |
Returns
Defined in
projects/utilities/packages/discord.js-utilities/src/lib/PaginatedMessages/PaginatedMessage.ts:312
setIdle
▸ setIdle(idle
): PaginatedMessage
Parameters
Name | Type | Description |
---|---|---|
idle | number |
Returns
Defined in
projects/utilities/packages/discord.js-utilities/src/lib/PaginatedMessages/PaginatedMessage.ts:330
setIndex
▸ setIndex(index
): PaginatedMessage
Parameters
Name | Type | Description |
---|---|---|
index | number |
Returns
Defined in
projects/utilities/packages/discord.js-utilities/src/lib/PaginatedMessages/PaginatedMessage.ts:321
setPages
▸ setPages(pages
): PaginatedMessage
Parameters
Name | Type | Description |
---|---|---|
pages | PaginatedMessagePage [] |
Returns
Defined in
projects/utilities/packages/discord.js-utilities/src/lib/PaginatedMessages/PaginatedMessage.ts:446
setSelectMenuOptions
▸ setSelectMenuOptions(newOptions
): PaginatedMessage
Parameters
Name | Type | Description |
---|---|---|
newOptions | PaginatedMessageSelectMenuOptionsFunction |
Returns
Defined in
projects/utilities/packages/discord.js-utilities/src/lib/PaginatedMessages/PaginatedMessage.ts:268
setSelectMenuPlaceholder
▸ setSelectMenuPlaceholder(placeholder
): PaginatedMessage
Parameters
Name | Type | Description |
---|---|---|
placeholder | undefined | string |
Returns
Defined in
projects/utilities/packages/discord.js-utilities/src/lib/PaginatedMessages/PaginatedMessage.ts:279
setStopPaginatedMessageCustomIds
▸ setStopPaginatedMessageCustomIds(stopPaginatedMessageCustomIds
): PaginatedMessage
Parameters
Name | Type | Description |
---|---|---|
stopPaginatedMessageCustomIds | string [] |
Returns
Defined in
projects/utilities/packages/discord.js-utilities/src/lib/PaginatedMessages/PaginatedMessage.ts:301
setUpCollector
▸ Protected
setUpCollector(channel
, targetUser
): void
Parameters
Name | Type | Description |
---|---|---|
channel | TextBasedChannel | |
targetUser | User |
Returns
void
Defined in
projects/utilities/packages/discord.js-utilities/src/lib/PaginatedMessages/PaginatedMessage.ts:1045
setUpMessage
▸ Protected
setUpMessage(messageOrInteraction
, targetUser
): Promise
<void
>
Parameters
Name | Type | Description |
---|---|---|
messageOrInteraction | Message <boolean > | AnyInteractableInteraction | |
targetUser | User |
Returns
Promise
<void
>
Defined in
projects/utilities/packages/discord.js-utilities/src/lib/PaginatedMessages/PaginatedMessage.ts:981
setWrongUserInteractionReply
▸ setWrongUserInteractionReply(wrongUserInteractionReply
): PaginatedMessage
Parameters
Name | Type | Description |
---|---|---|
wrongUserInteractionReply | PaginatedMessageWrongUserInteractionReplyFunction |
Returns
Defined in
projects/utilities/packages/discord.js-utilities/src/lib/PaginatedMessages/PaginatedMessage.ts:290
resolveTemplate
▸ Static
Private
resolveTemplate(template?
): BaseMessageOptions
Parameters
Name | Type |
---|---|
template? | BaseMessageOptions | EmbedBuilder |
Returns
BaseMessageOptions
Defined in
projects/utilities/packages/discord.js-utilities/src/lib/PaginatedMessages/PaginatedMessage.ts:1524