Class: LazyPaginatedMessage
This is a LazyPaginatedMessage. Instead of resolving all pages that are functions on PaginatedMessage.run will resolve when requested.
Extends
Constructors
new LazyPaginatedMessage()
new LazyPaginatedMessage(
__namedParameters
:PaginatedMessageOptions
):LazyPaginatedMessage
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.
Parameters
Parameter | Type | Description |
---|---|---|
__namedParameters | PaginatedMessageOptions | The PaginatedMessageOptions for this instance of the PaginatedMessage class |
Returns
Inherited from
Defined in
projects/utilities/packages/discord.js-utilities/src/lib/PaginatedMessages/PaginatedMessage.ts:517
Properties
actions
actions:
Map
<string
,PaginatedMessageAction
>
The actions which are to be used.
Inherited from
Defined in
projects/utilities/packages/discord.js-utilities/src/lib/PaginatedMessages/PaginatedMessage.ts:402
collector
collector:
null
|InteractionCollector
<PaginatedMessageInteractionUnion
> =null
The collector used for handling component interactions.
Inherited from
Defined in
projects/utilities/packages/discord.js-utilities/src/lib/PaginatedMessages/PaginatedMessage.ts:392
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.
Inherited from
PaginatedMessage.constructor
Defined in
projects/utilities/packages/discord.js-utilities/src/lib/PaginatedMessages/PaginatedMessage.ts:1845
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)
Inherited from
PaginatedMessage
.embedFooterSeparator
Defined in
projects/utilities/packages/discord.js-utilities/src/lib/PaginatedMessages/PaginatedMessage.ts:439
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)
Inherited from
PaginatedMessage
.emitPartialDMChannelWarning
Defined in
projects/utilities/packages/discord.js-utilities/src/lib/PaginatedMessages/PaginatedMessage.ts:453
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
Inherited from
PaginatedMessage
.hasEmittedMaxPageWarning
Defined in
projects/utilities/packages/discord.js-utilities/src/lib/PaginatedMessages/PaginatedMessage.ts:473
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
Inherited from
PaginatedMessage
.hasEmittedPartialDMChannelWarning
Defined in
projects/utilities/packages/discord.js-utilities/src/lib/PaginatedMessages/PaginatedMessage.ts:483
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.
Inherited from
Defined in
projects/utilities/packages/discord.js-utilities/src/lib/PaginatedMessages/PaginatedMessage.ts:419
index
index:
number
=0
The handler's current page/message index.
Inherited from
Defined in
projects/utilities/packages/discord.js-utilities/src/lib/PaginatedMessages/PaginatedMessage.ts:412
messages
messages: (
null
|PaginatedMessageResolvedPage
)[] =[]
The pages which were converted from PaginatedMessage.pages
Inherited from
Defined in
projects/utilities/packages/discord.js-utilities/src/lib/PaginatedMessages/PaginatedMessage.ts:397
pageActions
pageActions: (
null
|Map
<string
,PaginatedMessageAction
>)[] =[]
The page-specific actions which are to be used.
Inherited from
Defined in
projects/utilities/packages/discord.js-utilities/src/lib/PaginatedMessages/PaginatedMessage.ts:407
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)
Inherited from
PaginatedMessage
.pageIndexPrefix
Defined in
projects/utilities/packages/discord.js-utilities/src/lib/PaginatedMessages/PaginatedMessage.ts:432
pages
pages:
PaginatedMessagePage
[] =[]
The pages to be converted to PaginatedMessage.messages