Skip to main content

Class: PaginatedFieldMessageEmbed<T>

discord.js-utilities/src.PaginatedFieldMessageEmbed

Type parameters

Name
T

Hierarchy

Constructors

constructor

new PaginatedFieldMessageEmbed<T>(__namedParameters?)

Type parameters

Name
T

Parameters

NameTypeDescription
__namedParametersPaginatedMessageOptions

Inherited from

PaginatedMessage.constructor

Defined in

projects/utilities/packages/discord.js-utilities/src/lib/PaginatedMessages/PaginatedMessage.ts:224

Properties

#thisMazeWasNotMeantForYouContent

Private #thisMazeWasNotMeantForYouContent: Object

Type declaration

NameType
contentstring

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

PaginatedMessage.actions

Defined in

projects/utilities/packages/discord.js-utilities/src/lib/PaginatedMessages/PaginatedMessage.ts:145


collector

collector: null | InteractionCollector<MessageComponentInteraction<CacheType>> = null

Inherited from

PaginatedMessage.collector

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

projects/utilities/packages/discord.js-utilities/src/lib/PaginatedMessages/PaginatedFieldMessageEmbed.ts:32


emitPartialDMChannelWarning

emitPartialDMChannelWarning: boolean = PaginatedMessage.emitPartialDMChannelWarning

Inherited from

PaginatedMessage.emitPartialDMChannelWarning

Defined in

projects/utilities/packages/discord.js-utilities/src/lib/PaginatedMessages/PaginatedMessage.ts:191


fieldTitle

Private fieldTitle: string = ''

Defined in

projects/utilities/packages/discord.js-utilities/src/lib/PaginatedMessages/PaginatedFieldMessageEmbed.ts:36


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

PaginatedMessage.idle

Defined in

projects/utilities/packages/discord.js-utilities/src/lib/PaginatedMessages/PaginatedMessage.ts:157


index

index: number = 0

Inherited from

PaginatedMessage.index

Defined in

projects/utilities/packages/discord.js-utilities/src/lib/PaginatedMessages/PaginatedMessage.ts:150


items

Private items: T[] = []

Defined in

projects/utilities/packages/discord.js-utilities/src/lib/PaginatedMessages/PaginatedFieldMessageEmbed.ts:34


itemsPerPage

Private itemsPerPage: number = 10

Defined in

projects/utilities/packages/discord.js-utilities/src/lib/PaginatedMessages/PaginatedFieldMessageEmbed.ts:35


messages

messages: (null | PaginatedMessagePage)[] = []

Inherited from

PaginatedMessage.messages

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

PaginatedMessage.pages

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

PaginatedMessage.response

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

PaginatedMessage.template

Defined in

projects/utilities/packages/discord.js-utilities/src/lib/PaginatedMessages/PaginatedMessage.ts:163


totalPages

Private totalPages: number = 0

Defined in

projects/utilities/packages/discord.js-utilities/src/lib/PaginatedMessages/PaginatedFieldMessageEmbed.ts:33


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

PaginatedMessage.handlers

Defined in

projects/utilities/packages/discord.js-utilities/src/lib/PaginatedMessages/PaginatedMessage.ts:1433


messages

Static Readonly messages: Map<string, PaginatedMessage>

Inherited from

PaginatedMessage.messages

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): PaginatedFieldMessageEmbed<T>

Parameters

NameTypeDescription
actionPaginatedMessageAction

Returns

PaginatedFieldMessageEmbed<T>

Inherited from

PaginatedMessage.addAction

Defined in

projects/utilities/packages/discord.js-utilities/src/lib/PaginatedMessages/PaginatedMessage.ts:415


addActions

addActions(actions): PaginatedFieldMessageEmbed<T>

Parameters

NameTypeDescription
actionsPaginatedMessageAction[]

Returns

PaginatedFieldMessageEmbed<T>

Inherited from

PaginatedMessage.addActions

Defined in

projects/utilities/packages/discord.js-utilities/src/lib/PaginatedMessages/PaginatedMessage.ts:405


addAsyncPageBuilder

addAsyncPageBuilder(builder): PaginatedFieldMessageEmbed<T>

Parameters

NameTypeDescription
builderMessageBuilder | (builder: MessageBuilder) => Promise<MessageBuilder>

Returns

PaginatedFieldMessageEmbed<T>

Inherited from

PaginatedMessage.addAsyncPageBuilder

Defined in

projects/utilities/packages/discord.js-utilities/src/lib/PaginatedMessages/PaginatedMessage.ts:542


addAsyncPageEmbed

addAsyncPageEmbed(embed): PaginatedFieldMessageEmbed<T>

Parameters

NameTypeDescription
embedMessageEmbed | (builder: MessageEmbed) => Promise<MessageEmbed>

Returns

PaginatedFieldMessageEmbed<T>

Inherited from

PaginatedMessage.addAsyncPageEmbed

Defined in

projects/utilities/packages/discord.js-utilities/src/lib/PaginatedMessages/PaginatedMessage.ts:612


addAsyncPageEmbeds

addAsyncPageEmbeds(embeds): PaginatedFieldMessageEmbed<T>

Parameters

NameTypeDescription
embedsMessageEmbed[] | (embed1: MessageEmbed, embed2: MessageEmbed, embed3: MessageEmbed, embed4: MessageEmbed, embed5: MessageEmbed, embed6: MessageEmbed, embed7: MessageEmbed, embed8: MessageEmbed, embed9: MessageEmbed, embed10: MessageEmbed) => Promise<MessageEmbed[]>

Returns

PaginatedFieldMessageEmbed<T>

Inherited from

PaginatedMessage.addAsyncPageEmbeds

Defined in

projects/utilities/packages/discord.js-utilities/src/lib/PaginatedMessages/PaginatedMessage.ts:754


addPage

addPage(page): PaginatedFieldMessageEmbed<T>

Parameters

NameTypeDescription
pagePaginatedMessagePage

Returns

PaginatedFieldMessageEmbed<T>

Inherited from

PaginatedMessage.addPage

Defined in

projects/utilities/packages/discord.js-utilities/src/lib/PaginatedMessages/PaginatedMessage.ts:457


addPageBuilder

addPageBuilder(builder): PaginatedFieldMessageEmbed<T>

Parameters

NameTypeDescription
builderMessageBuilder | (builder: MessageBuilder) => MessageBuilder

Returns

PaginatedFieldMessageEmbed<T>

Inherited from

PaginatedMessage.addPageBuilder

Defined in

projects/utilities/packages/discord.js-utilities/src/lib/PaginatedMessages/PaginatedMessage.ts:516


addPageContent

addPageContent(content): PaginatedFieldMessageEmbed<T>

Parameters

NameTypeDescription
contentstring

Returns

PaginatedFieldMessageEmbed<T>

Inherited from

PaginatedMessage.addPageContent

Defined in

projects/utilities/packages/discord.js-utilities/src/lib/PaginatedMessages/PaginatedMessage.ts:557


addPageEmbed

addPageEmbed(embed): PaginatedFieldMessageEmbed<T>

Parameters

NameTypeDescription
embedMessageEmbed | (embed: MessageEmbed) => MessageEmbed

Returns

PaginatedFieldMessageEmbed<T>

Inherited from

PaginatedMessage.addPageEmbed

Defined in

projects/utilities/packages/discord.js-utilities/src/lib/PaginatedMessages/PaginatedMessage.ts:589


addPageEmbeds

addPageEmbeds(embeds): PaginatedFieldMessageEmbed<T>

Parameters

NameTypeDescription
embedsMessageEmbed[] | (embed1: MessageEmbed, embed2: MessageEmbed, embed3: MessageEmbed, embed4: MessageEmbed, embed5: MessageEmbed, embed6: MessageEmbed, embed7: MessageEmbed, embed8: MessageEmbed, embed9: MessageEmbed, embed10: MessageEmbed) => MessageEmbed[]

Returns

PaginatedFieldMessageEmbed<T>

Inherited from

PaginatedMessage.addPageEmbeds

Defined in

projects/utilities/packages/discord.js-utilities/src/lib/PaginatedMessages/PaginatedMessage.ts:663


addPages

addPages(pages): PaginatedFieldMessageEmbed<T>

Parameters

NameTypeDescription
pagesPaginatedMessagePage[]

Returns

PaginatedFieldMessageEmbed<T>

Inherited from

PaginatedMessage.addPages

Defined in

projects/utilities/packages/discord.js-utilities/src/lib/PaginatedMessages/PaginatedMessage.ts:798


applyFooter

Protected applyFooter(message, index): PaginatedMessageMessageOptionsUnion

Parameters

NameTypeDescription
messagePaginatedMessageMessageOptionsUnion
indexnumber

Returns

PaginatedMessageMessageOptionsUnion

Inherited from

PaginatedMessage.applyFooter

Defined in

projects/utilities/packages/discord.js-utilities/src/lib/PaginatedMessages/PaginatedMessage.ts:1176


clone

clone(): PaginatedMessage

Returns

PaginatedMessage

Inherited from

PaginatedMessage.clone

Defined in

projects/utilities/packages/discord.js-utilities/src/lib/PaginatedMessages/PaginatedMessage.ts:960


formatItems

formatItems(formatter): PaginatedFieldMessageEmbed<T>

Parameters

NameType
formatter(item: T, index: number, array: T[]) => any

Returns

PaginatedFieldMessageEmbed<T>

Defined in

projects/utilities/packages/discord.js-utilities/src/lib/PaginatedMessages/PaginatedFieldMessageEmbed.ts:112


generatePages

Private generatePages(): void

Returns

void

Defined in

projects/utilities/packages/discord.js-utilities/src/lib/PaginatedMessages/PaginatedFieldMessageEmbed.ts:149


handleCollect

Protected handleCollect(targetUser, channel, interaction): Promise<void>

Parameters

NameTypeDescription
targetUserUser
channelDMChannel | PartialDMChannel | NewsChannel | TextChannel | ThreadChannel | VoiceChannel
interactionButtonInteraction<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

NameTypeDescription
_Collection<string, ButtonInteraction<CacheType> | SelectMenuInteraction<CacheType>>-
reasonstring

Returns

void

Inherited from

PaginatedMessage.handleEnd

Defined in

projects/utilities/packages/discord.js-utilities/src/lib/PaginatedMessages/PaginatedMessage.ts:1153


handlePageLoad

Protected handlePageLoad(page, index): Promise<PaginatedMessageMessageOptionsUnion>

Parameters

NameTypeDescription
pagePaginatedMessagePage
indexnumber

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

NameTypeDescription
indexnumber

Returns

boolean

Inherited from

PaginatedMessage.hasPage

Defined in

projects/utilities/packages/discord.js-utilities/src/lib/PaginatedMessages/PaginatedMessage.ts:432


make

make(): PaginatedFieldMessageEmbed<T>

Returns

PaginatedFieldMessageEmbed<T>

Defined in

projects/utilities/packages/discord.js-utilities/src/lib/PaginatedMessages/PaginatedFieldMessageEmbed.ts:139


paginateArray

Private paginateArray(items, currentPage, perPageItems): T[]

Parameters

NameType
itemsT[]
currentPagenumber
perPageItemsnumber

Returns

T[]

Defined in

projects/utilities/packages/discord.js-utilities/src/lib/PaginatedMessages/PaginatedFieldMessageEmbed.ts:165


resolvePage

resolvePage(index): Promise<PaginatedMessagePage>

Parameters

NameTypeDescription
indexnumber

Returns

Promise<PaginatedMessagePage>

Inherited from

PaginatedMessage.resolvePage

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

NameTypeDescription
messageOrInteractionMessage<boolean> | CommandInteraction<CacheType> | ContextMenuInteraction<CacheType> | ButtonInteraction<CacheType> | SelectMenuInteraction<CacheType>
targetUserUser

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

NameType
templateMessageEmbed | MessageEmbedOptions | (embed: MessageEmbed) => MessageEmbed

Returns

MessageEmbed

Defined in

projects/utilities/packages/discord.js-utilities/src/lib/PaginatedMessages/PaginatedFieldMessageEmbed.ts:170


run

run(messageOrInteraction, target?): Promise<PaginatedFieldMessageEmbed<T>>

Parameters

NameTypeDescription
messageOrInteractionMessage<boolean> | CommandInteraction<CacheType> | ContextMenuInteraction<CacheType> | ButtonInteraction<CacheType> | SelectMenuInteraction<CacheType>
target?User

Returns

Promise<PaginatedFieldMessageEmbed<T>>

Inherited from

PaginatedMessage.run

Defined in

projects/utilities/packages/discord.js-utilities/src/lib/PaginatedMessages/PaginatedMessage.ts:821


setActions

setActions(actions, includeDefaultActions?): PaginatedFieldMessageEmbed<T>

Parameters

NameTypeDefault valueDescription
actionsPaginatedMessageAction[]undefined
includeDefaultActionsbooleanfalse

Returns

PaginatedFieldMessageEmbed<T>

Inherited from

PaginatedMessage.setActions

Defined in

projects/utilities/packages/discord.js-utilities/src/lib/PaginatedMessages/PaginatedMessage.ts:395


setEmitPartialDMChannelWarning

setEmitPartialDMChannelWarning(emitPartialDMChannelWarning): PaginatedFieldMessageEmbed<T>

Parameters

NameTypeDescription
emitPartialDMChannelWarningboolean

Returns

PaginatedFieldMessageEmbed<T>

Inherited from

PaginatedMessage.setEmitPartialDMChannelWarning

Defined in

projects/utilities/packages/discord.js-utilities/src/lib/PaginatedMessages/PaginatedMessage.ts:306


setIdle

setIdle(idle): PaginatedFieldMessageEmbed<T>

Parameters

NameTypeDescription
idlenumber

Returns

PaginatedFieldMessageEmbed<T>

Inherited from

PaginatedMessage.setIdle

Defined in

projects/utilities/packages/discord.js-utilities/src/lib/PaginatedMessages/PaginatedMessage.ts:324


setIndex

setIndex(index): PaginatedFieldMessageEmbed<T>

Parameters

NameTypeDescription
indexnumber

Returns

PaginatedFieldMessageEmbed<T>

Inherited from

PaginatedMessage.setIndex

Defined in

projects/utilities/packages/discord.js-utilities/src/lib/PaginatedMessages/PaginatedMessage.ts:315


setItems

setItems(items): PaginatedFieldMessageEmbed<T>

Parameters

NameTypeDescription
itemsT[]

Returns

PaginatedFieldMessageEmbed<T>

Defined in

projects/utilities/packages/discord.js-utilities/src/lib/PaginatedMessages/PaginatedFieldMessageEmbed.ts:42


setItemsPerPage

setItemsPerPage(itemsPerPage): PaginatedFieldMessageEmbed<T>

Parameters

NameTypeDescription
itemsPerPagenumber

Returns

PaginatedFieldMessageEmbed<T>

Defined in

projects/utilities/packages/discord.js-utilities/src/lib/PaginatedMessages/PaginatedFieldMessageEmbed.ts:60


setPages

setPages(pages): PaginatedFieldMessageEmbed<T>

Parameters

NameTypeDescription
pagesPaginatedMessagePage[]

Returns

PaginatedFieldMessageEmbed<T>

Inherited from

PaginatedMessage.setPages

Defined in

projects/utilities/packages/discord.js-utilities/src/lib/PaginatedMessages/PaginatedMessage.ts:440


setSelectMenuOptions

setSelectMenuOptions(newOptions): PaginatedFieldMessageEmbed<T>

Parameters

NameTypeDescription
newOptionsPaginatedMessageSelectMenuOptionsFunction

Returns

PaginatedFieldMessageEmbed<T>

Inherited from

PaginatedMessage.setSelectMenuOptions

Defined in

projects/utilities/packages/discord.js-utilities/src/lib/PaginatedMessages/PaginatedMessage.ts:262


setSelectMenuPlaceholder

setSelectMenuPlaceholder(placeholder): PaginatedFieldMessageEmbed<T>

Parameters

NameTypeDescription
placeholderundefined | string

Returns

PaginatedFieldMessageEmbed<T>

Inherited from

PaginatedMessage.setSelectMenuPlaceholder

Defined in

projects/utilities/packages/discord.js-utilities/src/lib/PaginatedMessages/PaginatedMessage.ts:273


setStopPaginatedMessageCustomIds

setStopPaginatedMessageCustomIds(stopPaginatedMessageCustomIds): PaginatedFieldMessageEmbed<T>

Parameters

NameTypeDescription
stopPaginatedMessageCustomIdsstring[]

Returns

PaginatedFieldMessageEmbed<T>

Inherited from

PaginatedMessage.setStopPaginatedMessageCustomIds

Defined in

projects/utilities/packages/discord.js-utilities/src/lib/PaginatedMessages/PaginatedMessage.ts:295


setTemplate

setTemplate(template): PaginatedFieldMessageEmbed<T>

Parameters

NameTypeDescription
templateMessageEmbed | MessageEmbedOptions | (embed: MessageEmbed) => MessageEmbed

Returns

PaginatedFieldMessageEmbed<T>

Defined in

projects/utilities/packages/discord.js-utilities/src/lib/PaginatedMessages/PaginatedFieldMessageEmbed.ts:86


setTitleField

setTitleField(title): PaginatedFieldMessageEmbed<T>

Parameters

NameTypeDescription
titlestring

Returns

PaginatedFieldMessageEmbed<T>

Defined in

projects/utilities/packages/discord.js-utilities/src/lib/PaginatedMessages/PaginatedFieldMessageEmbed.ts:51


setUpCollector

Protected setUpCollector(channel, targetUser): void

Parameters

NameTypeDescription
channelTextBasedChannel
targetUserUser

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

NameTypeDescription
messageOrInteractionMessage<boolean> | CommandInteraction<CacheType> | ContextMenuInteraction<CacheType> | ButtonInteraction<CacheType> | SelectMenuInteraction<CacheType>
targetUserUser

Returns

Promise<void>

Inherited from

PaginatedMessage.setUpMessage

Defined in

projects/utilities/packages/discord.js-utilities/src/lib/PaginatedMessages/PaginatedMessage.ts:978


setWrongUserInteractionReply

setWrongUserInteractionReply(wrongUserInteractionReply): PaginatedFieldMessageEmbed<T>

Parameters

NameTypeDescription
wrongUserInteractionReplyPaginatedMessageWrongUserInteractionReplyFunction

Returns

PaginatedFieldMessageEmbed<T>

Inherited from

PaginatedMessage.setWrongUserInteractionReply

Defined in

projects/utilities/packages/discord.js-utilities/src/lib/PaginatedMessages/PaginatedMessage.ts:284