Class: PaginatedMessageEmbedFields
discord.js-utilities/src.PaginatedMessageEmbedFields
Hierarchy
↳
PaginatedMessageEmbedFields
Constructors
constructor
• new PaginatedMessageEmbedFields(__namedParameters?
)
Parameters
Name | Type | Description |
---|---|---|
__namedParameters | PaginatedMessageOptions |
Inherited from
Defined in
projects/utilities/packages/discord.js-utilities/src/lib/PaginatedMessages/PaginatedMessage.ts:224
Properties
#thisMazeWasNotMeantForYouContent
• Private
#thisMazeWasNotMeantForYouContent: Object
Type declaration
Name | Type |
---|---|
content | string |
Inherited from
PaginatedMessage.#thisMazeWasNotMeantForYouContent
Defined in
projects/utilities/packages/discord.js-utilities/src/lib/PaginatedMessages/PaginatedMessage.ts:119
actions
• actions: Map
<string
, PaginatedMessageAction
>
Inherited from
Defined in
projects/utilities/packages/discord.js-utilities/src/lib/PaginatedMessages/PaginatedMessage.ts:145
collector
• collector: null
| InteractionCollector
<MessageComponentInteraction
<CacheType
>> = null
Inherited from
Defined in
projects/utilities/packages/discord.js-utilities/src/lib/PaginatedMessages/PaginatedMessage.ts:135
constructor
• constructor: typeof PaginatedMessage
Inherited from
PaginatedMessage.constructor
Defined in
projects/utilities/packages/discord.js-utilities/src/lib/PaginatedMessages/PaginatedMessage.ts:1524
embedFooterSeparator
• embedFooterSeparator: string
= PaginatedMessage.embedFooterSeparator
Inherited from
PaginatedMessage.embedFooterSeparator
Defined in
projects/utilities/packages/discord.js-utilities/src/lib/PaginatedMessages/PaginatedMessage.ts:177
embedTemplate
• Private
embedTemplate: MessageEmbed
Defined in
emitPartialDMChannelWarning
• emitPartialDMChannelWarning: boolean
= PaginatedMessage.emitPartialDMChannelWarning
Inherited from
PaginatedMessage.emitPartialDMChannelWarning
Defined in
projects/utilities/packages/discord.js-utilities/src/lib/PaginatedMessages/PaginatedMessage.ts:191
hasEmittedMaxPageWarning
• Protected
hasEmittedMaxPageWarning: boolean
= false
Inherited from
PaginatedMessage.hasEmittedMaxPageWarning
Defined in
projects/utilities/packages/discord.js-utilities/src/lib/PaginatedMessages/PaginatedMessage.ts:207
hasEmittedPartialDMChannelWarning
• Protected
hasEmittedPartialDMChannelWarning: boolean
= false
Inherited from
PaginatedMessage.hasEmittedPartialDMChannelWarning
Defined in
projects/utilities/packages/discord.js-utilities/src/lib/PaginatedMessages/PaginatedMessage.ts:216
idle
• idle: number
Inherited from
Defined in
projects/utilities/packages/discord.js-utilities/src/lib/PaginatedMessages/PaginatedMessage.ts:157
index
• index: number
= 0
Inherited from
Defined in
projects/utilities/packages/discord.js-utilities/src/lib/PaginatedMessages/PaginatedMessage.ts:150
items
• Private
items: EmbedFieldData
[] = []
Defined in
itemsPerPage
• Private
itemsPerPage: number
= 10
Defined in
messages
• messages: (null
| PaginatedMessagePage
)[] = []
Inherited from
Defined in
projects/utilities/packages/discord.js-utilities/src/lib/PaginatedMessages/PaginatedMessage.ts:140
pageIndexPrefix
• pageIndexPrefix: string
= PaginatedMessage.pageIndexPrefix
Inherited from
PaginatedMessage.pageIndexPrefix
Defined in
projects/utilities/packages/discord.js-utilities/src/lib/PaginatedMessages/PaginatedMessage.ts:170
pages
• pages: PaginatedMessagePage
[]
Inherited from
Defined in
projects/utilities/packages/discord.js-utilities/src/lib/PaginatedMessages/PaginatedMessage.ts:125
paginatedMessageData
• Protected
paginatedMessageData: null
| Omit
<PaginatedMessageMessageOptionsUnion
, "components"
> = null
Inherited from
PaginatedMessage.paginatedMessageData
Defined in
projects/utilities/packages/discord.js-utilities/src/lib/PaginatedMessages/PaginatedMessage.ts:195
response
• response: null
| Message
<boolean
> | APIMessage
| CommandInteraction
<CacheType
> | ContextMenuInteraction
<CacheType
> | ButtonInteraction
<CacheType
> | SelectMenuInteraction
<CacheType
> = null
Inherited from
Defined in
projects/utilities/packages/discord.js-utilities/src/lib/PaginatedMessages/PaginatedMessage.ts:130
selectMenuOptions
• Protected
selectMenuOptions: PaginatedMessageSelectMenuOptionsFunction
= PaginatedMessage.selectMenuOptions
Inherited from
PaginatedMessage.selectMenuOptions
Defined in
projects/utilities/packages/discord.js-utilities/src/lib/PaginatedMessages/PaginatedMessage.ts:197
selectMenuPlaceholder
• Protected
selectMenuPlaceholder: undefined
| string
= undefined
Inherited from
PaginatedMessage.selectMenuPlaceholder
Defined in
projects/utilities/packages/discord.js-utilities/src/lib/PaginatedMessages/PaginatedMessage.ts:199
stopPaginatedMessageCustomIds
• stopPaginatedMessageCustomIds: string
[] = PaginatedMessage.stopPaginatedMessageCustomIds
Inherited from
PaginatedMessage.stopPaginatedMessageCustomIds
Defined in
projects/utilities/packages/discord.js-utilities/src/lib/PaginatedMessages/PaginatedMessage.ts:183
template
• template: PaginatedMessageMessageOptionsUnion
Inherited from
Defined in
projects/utilities/packages/discord.js-utilities/src/lib/PaginatedMessages/PaginatedMessage.ts:163
totalPages
• Private
totalPages: number
= 0
Defined in
wrongUserInteractionReply
• Protected
wrongUserInteractionReply: PaginatedMessageWrongUserInteractionReplyFunction
= PaginatedMessage.wrongUserInteractionReply
Inherited from
PaginatedMessage.wrongUserInteractionReply
Defined in
projects/utilities/packages/discord.js-utilities/src/lib/PaginatedMessages/PaginatedMessage.ts:201
defaultActions
▪ Static
defaultActions: PaginatedMessageAction
[]
Inherited from
PaginatedMessage.defaultActions
Defined in
projects/utilities/packages/discord.js-utilities/src/lib/PaginatedMessages/PaginatedMessage.ts:1300
deletionStopReasons
▪ Static
deletionStopReasons: string
[]
Inherited from
PaginatedMessage.deletionStopReasons
Defined in
projects/utilities/packages/discord.js-utilities/src/lib/PaginatedMessages/PaginatedMessage.ts:1385
embedFooterSeparator
▪ Static
embedFooterSeparator: string
= '•'
Inherited from
PaginatedMessage.embedFooterSeparator
Defined in
projects/utilities/packages/discord.js-utilities/src/lib/PaginatedMessages/PaginatedMessage.ts:1415
emitPartialDMChannelWarning
▪ Static
emitPartialDMChannelWarning: boolean
= true
Inherited from
PaginatedMessage.emitPartialDMChannelWarning
Defined in
projects/utilities/packages/discord.js-utilities/src/lib/PaginatedMessages/PaginatedMessage.ts:1365
handlers
▪ Static
Readonly
handlers: Map
<string
, PaginatedMessage
>
Inherited from
Defined in
projects/utilities/packages/discord.js-utilities/src/lib/PaginatedMessages/PaginatedMessage.ts:1433
messages
▪ Static
Readonly
messages: Map
<string
, PaginatedMessage
>
Inherited from
Defined in
projects/utilities/packages/discord.js-utilities/src/lib/PaginatedMessages/PaginatedMessage.ts:1424
pageIndexPrefix
▪ Static
pageIndexPrefix: string
= ''
Inherited from
PaginatedMessage.pageIndexPrefix
Defined in
projects/utilities/packages/discord.js-utilities/src/lib/PaginatedMessages/PaginatedMessage.ts:1400
selectMenuOptions
▪ Static
selectMenuOptions: PaginatedMessageSelectMenuOptionsFunction
Inherited from
PaginatedMessage.selectMenuOptions
Defined in
projects/utilities/packages/discord.js-utilities/src/lib/PaginatedMessages/PaginatedMessage.ts:1460
stopPaginatedMessageCustomIds
▪ Static
stopPaginatedMessageCustomIds: string
[]
Inherited from
PaginatedMessage.stopPaginatedMessageCustomIds
Defined in
projects/utilities/packages/discord.js-utilities/src/lib/PaginatedMessages/PaginatedMessage.ts:1379
wrongUserInteractionReply
▪ Static
wrongUserInteractionReply: PaginatedMessageWrongUserInteractionReplyFunction
Inherited from
PaginatedMessage.wrongUserInteractionReply
Defined in
projects/utilities/packages/discord.js-utilities/src/lib/PaginatedMessages/PaginatedMessage.ts:1504
Methods
addAction
▸ addAction(action
): PaginatedMessageEmbedFields
Parameters
Name | Type | Description |
---|---|---|
action | PaginatedMessageAction |
Returns
Inherited from
Defined in
projects/utilities/packages/discord.js-utilities/src/lib/PaginatedMessages/PaginatedMessage.ts:415
addActions
▸ addActions(actions
): PaginatedMessageEmbedFields
Parameters
Name | Type | Description |
---|---|---|
actions | PaginatedMessageAction [] |
Returns
Inherited from
Defined in
projects/utilities/packages/discord.js-utilities/src/lib/PaginatedMessages/PaginatedMessage.ts:405
addAsyncPageBuilder
▸ addAsyncPageBuilder(builder
): PaginatedMessageEmbedFields
Parameters
Name | Type | Description |
---|---|---|
builder | MessageBuilder | (builder : MessageBuilder ) => Promise <MessageBuilder > |
Returns
Inherited from
PaginatedMessage.addAsyncPageBuilder
Defined in
projects/utilities/packages/discord.js-utilities/src/lib/PaginatedMessages/PaginatedMessage.ts:542
addAsyncPageEmbed
▸ addAsyncPageEmbed(embed
): PaginatedMessageEmbedFields
Parameters
Name | Type | Description |
---|---|---|
embed | MessageEmbed | (builder : MessageEmbed ) => Promise <MessageEmbed > |
Returns
Inherited from
PaginatedMessage.addAsyncPageEmbed
Defined in
projects/utilities/packages/discord.js-utilities/src/lib/PaginatedMessages/PaginatedMessage.ts:612
addAsyncPageEmbeds
▸ addAsyncPageEmbeds(embeds
): PaginatedMessageEmbedFields
Parameters
Name | Type | Description |
---|---|---|
embeds | MessageEmbed [] | (embed1 : MessageEmbed , embed2 : MessageEmbed , embed3 : MessageEmbed , embed4 : MessageEmbed , embed5 : MessageEmbed , embed6 : MessageEmbed , embed7 : MessageEmbed , embed8 : MessageEmbed , embed9 : MessageEmbed , embed10 : MessageEmbed ) => Promise <MessageEmbed []> |
Returns
Inherited from
PaginatedMessage.addAsyncPageEmbeds
Defined in
projects/utilities/packages/discord.js-utilities/src/lib/PaginatedMessages/PaginatedMessage.ts:754
addPage
▸ addPage(page
): PaginatedMessageEmbedFields
Parameters
Name | Type | Description |
---|---|---|
page | PaginatedMessagePage |
Returns
Inherited from
Defined in
projects/utilities/packages/discord.js-utilities/src/lib/PaginatedMessages/PaginatedMessage.ts:457
addPageBuilder
▸ addPageBuilder(builder
): PaginatedMessageEmbedFields
Parameters
Name | Type | Description |
---|---|---|
builder | MessageBuilder | (builder : MessageBuilder ) => MessageBuilder |
Returns
Inherited from
PaginatedMessage.addPageBuilder
Defined in
projects/utilities/packages/discord.js-utilities/src/lib/PaginatedMessages/PaginatedMessage.ts:516
addPageContent
▸ addPageContent(content
): PaginatedMessageEmbedFields
Parameters
Name | Type | Description |
---|---|---|
content | string |
Returns
Inherited from
PaginatedMessage.addPageContent
Defined in
projects/utilities/packages/discord.js-utilities/src/lib/PaginatedMessages/PaginatedMessage.ts:557
addPageEmbed
▸ addPageEmbed(embed
): PaginatedMessageEmbedFields
Parameters
Name | Type | Description |
---|---|---|
embed | MessageEmbed | (embed : MessageEmbed ) => MessageEmbed |
Returns
Inherited from
Defined in
projects/utilities/packages/discord.js-utilities/src/lib/PaginatedMessages/PaginatedMessage.ts:589
addPageEmbeds
▸ addPageEmbeds(embeds
): PaginatedMessageEmbedFields
Parameters
Name | Type | Description |
---|---|---|
embeds | MessageEmbed [] | (embed1 : MessageEmbed , embed2 : MessageEmbed , embed3 : MessageEmbed , embed4 : MessageEmbed , embed5 : MessageEmbed , embed6 : MessageEmbed , embed7 : MessageEmbed , embed8 : MessageEmbed , embed9 : MessageEmbed , embed10 : MessageEmbed ) => MessageEmbed [] |
Returns
Inherited from
PaginatedMessage.addPageEmbeds
Defined in
projects/utilities/packages/discord.js-utilities/src/lib/PaginatedMessages/PaginatedMessage.ts:663
addPages
▸ addPages(pages
): PaginatedMessageEmbedFields
Parameters
Name | Type | Description |
---|---|---|
pages | PaginatedMessagePage [] |
Returns
Inherited from
Defined in
projects/utilities/packages/discord.js-utilities/src/lib/PaginatedMessages/PaginatedMessage.ts:798
applyFooter
▸ Protected
applyFooter(message
, index
): PaginatedMessageMessageOptionsUnion
Parameters
Name | Type | Description |
---|---|---|
message | PaginatedMessageMessageOptionsUnion | |
index | number |
Returns
PaginatedMessageMessageOptionsUnion
Inherited from
Defined in
projects/utilities/packages/discord.js-utilities/src/lib/PaginatedMessages/PaginatedMessage.ts:1176
clone
▸ clone(): PaginatedMessage
Returns
Inherited from
Defined in
projects/utilities/packages/discord.js-utilities/src/lib/PaginatedMessages/PaginatedMessage.ts:960
generatePages
▸ Private
generatePages(): void
Returns
void
Defined in
handleCollect
▸ Protected
handleCollect(targetUser
, channel
, interaction
): Promise
<void
>
Parameters
Name | Type | Description |
---|---|---|
targetUser | User | |
channel | DMChannel | PartialDMChannel | NewsChannel | TextChannel | ThreadChannel | VoiceChannel | |
interaction | ButtonInteraction <CacheType > | SelectMenuInteraction <CacheType > |
Returns
Promise
<void
>
Inherited from
PaginatedMessage.handleCollect
Defined in
projects/utilities/packages/discord.js-utilities/src/lib/PaginatedMessages/PaginatedMessage.ts:1098
handleEnd
▸ Protected
handleEnd(_
, reason
): void
Parameters
Name | Type | Description |
---|---|---|
_ | Collection <string , ButtonInteraction <CacheType > | SelectMenuInteraction <CacheType >> | - |
reason | string |
Returns
void
Inherited from
Defined in
projects/utilities/packages/discord.js-utilities/src/lib/PaginatedMessages/PaginatedMessage.ts:1153
handlePageLoad
▸ Protected
handlePageLoad(page
, index
): Promise
<PaginatedMessageMessageOptionsUnion
>
Parameters
Name | Type | Description |
---|---|---|
page | PaginatedMessagePage | |
index | number |
Returns
Promise
<PaginatedMessageMessageOptionsUnion
>
Inherited from
PaginatedMessage.handlePageLoad
Defined in
projects/utilities/packages/discord.js-utilities/src/lib/PaginatedMessages/PaginatedMessage.ts:1078
hasPage
▸ hasPage(index
): boolean
Parameters
Name | Type | Description |
---|---|---|
index | number |
Returns
boolean
Inherited from
Defined in
projects/utilities/packages/discord.js-utilities/src/lib/PaginatedMessages/PaginatedMessage.ts:432
make
▸ make(): PaginatedMessageEmbedFields
Returns
Defined in
paginateArray
▸ Private
paginateArray(items
, currentPage
, perPageItems
): EmbedFieldData
[]
Parameters
Name | Type |
---|---|
items | EmbedFieldData [] |
currentPage | number |
perPageItems | number |
Returns
Defined in
resolvePage
▸ resolvePage(index
): Promise
<PaginatedMessagePage
>
Parameters
Name | Type | Description |
---|---|---|
index | number |
Returns
Inherited from
Defined in
projects/utilities/packages/discord.js-utilities/src/lib/PaginatedMessages/PaginatedMessage.ts:943
resolvePagesOnRun
▸ resolvePagesOnRun(): Promise
<void
>
Returns
Promise
<void
>
Inherited from
PaginatedMessage.resolvePagesOnRun
Defined in
projects/utilities/packages/discord.js-utilities/src/lib/PaginatedMessages/PaginatedMessage.ts:933
resolvePaginatedMessageInternationalizationContext
▸ Protected
resolvePaginatedMessageInternationalizationContext(messageOrInteraction
, targetUser
): PaginatedMessageInternationalizationContext
Parameters
Name | Type | Description |
---|---|---|
messageOrInteraction | Message <boolean > | CommandInteraction <CacheType > | ContextMenuInteraction <CacheType > | ButtonInteraction <CacheType > | SelectMenuInteraction <CacheType > | |
targetUser | User |
Returns
PaginatedMessageInternationalizationContext
Inherited from
PaginatedMessage.resolvePaginatedMessageInternationalizationContext
Defined in
projects/utilities/packages/discord.js-utilities/src/lib/PaginatedMessages/PaginatedMessage.ts:1201
resolveTemplate
▸ Private
resolveTemplate(template
): MessageEmbed
Parameters
Name | Type |
---|---|
template | MessageEmbed | MessageEmbedOptions | (embed : MessageEmbed ) => MessageEmbed |
Returns
Defined in
run
▸ run(messageOrInteraction
, target?
): Promise
<PaginatedMessageEmbedFields
>
Parameters
Name | Type | Description |
---|---|---|
messageOrInteraction | Message <boolean > | CommandInteraction <CacheType > | ContextMenuInteraction <CacheType > | ButtonInteraction <CacheType > | SelectMenuInteraction <CacheType > | |
target? | User |
Returns
Promise
<PaginatedMessageEmbedFields
>
Inherited from
Defined in
projects/utilities/packages/discord.js-utilities/src/lib/PaginatedMessages/PaginatedMessage.ts:821
setActions
▸ setActions(actions
, includeDefaultActions?
): PaginatedMessageEmbedFields
Parameters
Name | Type | Default value | Description |
---|---|---|---|
actions | PaginatedMessageAction [] | undefined | |
includeDefaultActions | boolean | false |
Returns
Inherited from
Defined in
projects/utilities/packages/discord.js-utilities/src/lib/PaginatedMessages/PaginatedMessage.ts:395
setEmitPartialDMChannelWarning
▸ setEmitPartialDMChannelWarning(emitPartialDMChannelWarning
): PaginatedMessageEmbedFields
Parameters
Name | Type | Description |
---|---|---|
emitPartialDMChannelWarning | boolean |
Returns
Inherited from
PaginatedMessage.setEmitPartialDMChannelWarning
Defined in
projects/utilities/packages/discord.js-utilities/src/lib/PaginatedMessages/PaginatedMessage.ts:306
setIdle
▸ setIdle(idle
): PaginatedMessageEmbedFields
Parameters
Name | Type | Description |
---|---|---|
idle | number |
Returns
Inherited from
Defined in
projects/utilities/packages/discord.js-utilities/src/lib/PaginatedMessages/PaginatedMessage.ts:324
setIndex
▸ setIndex(index
): PaginatedMessageEmbedFields
Parameters
Name | Type | Description |
---|---|---|
index | number |
Returns
Inherited from
Defined in
projects/utilities/packages/discord.js-utilities/src/lib/PaginatedMessages/PaginatedMessage.ts:315
setItems
▸ setItems(items
): PaginatedMessageEmbedFields
Parameters
Name | Type | Description |
---|---|---|
items | EmbedFieldData [] |
Returns
Defined in
setItemsPerPage
▸ setItemsPerPage(itemsPerPage
): PaginatedMessageEmbedFields
Parameters
Name | Type | Description |
---|---|---|
itemsPerPage | number |
Returns
Defined in
setPages
▸ setPages(pages
): PaginatedMessageEmbedFields
Parameters
Name | Type | Description |
---|---|---|
pages | PaginatedMessagePage [] |
Returns
Inherited from
Defined in
projects/utilities/packages/discord.js-utilities/src/lib/PaginatedMessages/PaginatedMessage.ts:440
setSelectMenuOptions
▸ setSelectMenuOptions(newOptions
): PaginatedMessageEmbedFields
Parameters
Name | Type | Description |
---|---|---|
newOptions | PaginatedMessageSelectMenuOptionsFunction |
Returns
Inherited from
PaginatedMessage.setSelectMenuOptions
Defined in
projects/utilities/packages/discord.js-utilities/src/lib/PaginatedMessages/PaginatedMessage.ts:262
setSelectMenuPlaceholder
▸ setSelectMenuPlaceholder(placeholder
): PaginatedMessageEmbedFields
Parameters
Name | Type | Description |
---|---|---|
placeholder | undefined | string |
Returns
Inherited from
PaginatedMessage.setSelectMenuPlaceholder
Defined in
projects/utilities/packages/discord.js-utilities/src/lib/PaginatedMessages/PaginatedMessage.ts:273
setStopPaginatedMessageCustomIds
▸ setStopPaginatedMessageCustomIds(stopPaginatedMessageCustomIds
): PaginatedMessageEmbedFields
Parameters
Name | Type | Description |
---|---|---|
stopPaginatedMessageCustomIds | string [] |
Returns
Inherited from
PaginatedMessage.setStopPaginatedMessageCustomIds
Defined in
projects/utilities/packages/discord.js-utilities/src/lib/PaginatedMessages/PaginatedMessage.ts:295
setTemplate
▸ setTemplate(template
): PaginatedMessageEmbedFields
Parameters
Name | Type | Description |
---|---|---|
template | MessageEmbed | MessageEmbedOptions | (embed : MessageEmbed ) => MessageEmbed |
Returns
Defined in
setUpCollector
▸ Protected
setUpCollector(channel
, targetUser
): void
Parameters
Name | Type | Description |
---|---|---|
channel | TextBasedChannel | |
targetUser | User |
Returns
void
Inherited from
PaginatedMessage.setUpCollector
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 > | CommandInteraction <CacheType > | ContextMenuInteraction <CacheType > | ButtonInteraction <CacheType > | SelectMenuInteraction <CacheType > | |
targetUser | User |
Returns
Promise
<void
>
Inherited from
Defined in
projects/utilities/packages/discord.js-utilities/src/lib/PaginatedMessages/PaginatedMessage.ts:978
setWrongUserInteractionReply
▸ setWrongUserInteractionReply(wrongUserInteractionReply
): PaginatedMessageEmbedFields
Parameters
Name | Type | Description |
---|---|---|
wrongUserInteractionReply | PaginatedMessageWrongUserInteractionReplyFunction |
Returns
Inherited from
PaginatedMessage.setWrongUserInteractionReply
Defined in
projects/utilities/packages/discord.js-utilities/src/lib/PaginatedMessages/PaginatedMessage.ts:284