Class PagesBuilder

Hierarchy

EmbedBuilder
Hierarchy
- PagesBuilder

Constructors

constructor

new PagesBuilder(interaction: ChatInputCommandInteraction<CacheType>): PagesBuilder
Parameters
- interaction: ChatInputCommandInteraction<CacheType>
Returns PagesBuilder
Overrides EmbedBuilder.constructor
- Defined in src/builder.ts:85

Properties

`Private` autoResetTimeout

autoResetTimeout: boolean = true

`Private` buildMethod

buildMethod: "reply" | "editReply" | "followUp"

`Private` collector

collector: InteractionCollector<SelectMenuInteraction<CacheType> | ButtonInteraction<CacheType>>

`Protected` components

components: ActionRowBuilder<MessageActionRowComponentBuilder>[] = []

Components

`Private` currentPage

currentPage: number = 1

`Readonly` data

data: APIEmbed

`Private` defaultButtons

defaultButtons: ActionRowBuilder<MessageActionRowComponentBuilder>[] = []

`Private` endColor

endColor: ColorResolvable = 'Grey'

`Private` endMethod

`Private` files

`Readonly` interaction

interaction: ChatInputCommandInteraction<CacheType>

Common

`Private` listenTimeout

listenTimeout: number = ...

Listen

`Private` listenUsers

listenUsers: string[]

`Private` loop

loop: boolean = true

`Private` message

message: Message<boolean>

`Private` `Optional` messageComponent

messageComponent?: MessageComponentInteraction<CacheType>

`Private` pages

pages: Page[] = []

Pages

`Private` paginationFormat

paginationFormat: string = '%c / %m'

`Private` timeout

timeout: Timeout

`Private` triggers

triggers: TriggersMap = ...

Triggers

Accessors

appendedComponents

get appendedComponents(): ActionRowBuilder<MessageActionRowComponentBuilder>[]
Returns ActionRowBuilder<MessageActionRowComponentBuilder>[]
- Defined in src/builder.ts:509

Methods

addComponents

addComponents(components: AllowArray<MessageActionRowComponentBuilder | ActionRowBuilder<MessageActionRowComponentBuilder>>): PagesBuilder
Method for adding components to available row
Parameters
- components: AllowArray<MessageActionRowComponentBuilder | ActionRowBuilder<MessageActionRowComponentBuilder>>
Returns PagesBuilder
- Defined in src/builder.ts:424

addFields

addFields(...fields: RestOrArray<APIEmbedField>): PagesBuilder
Appends fields to the embed

Remarks
This method accepts either an array of fields or a variable number of field parameters. The maximum amount of fields that can be added is 25.

Example
Using an array
```
const fields: APIEmbedField[] = ...;
const embed = new EmbedBuilder()
    .addFields(fields);
```
Example
Using rest parameters (variadic)
```
const embed = new EmbedBuilder()
    .addFields(
        { name: 'Field 1', value: 'Value 1' },
        { name: 'Field 2', value: 'Value 2' },
    );
```
Parameters
- Rest ...fields: RestOrArray<APIEmbedField>
  
  The fields to add
Returns PagesBuilder
Inherited from EmbedBuilder.addFields
- Defined in node_modules/@discordjs/builders/dist/messages/embed/Embed.d.ts:57

addFiles

addFiles(files: Stream | Attachment | BufferResolvable | AttachmentPayload | JSONEncodable<APIAttachment> | AttachmentBuilder | (Stream | Attachment | BufferResolvable | AttachmentPayload | JSONEncodable<APIAttachment> | AttachmentBuilder)[]): PagesBuilder
Method for adding files to the end
Parameters
- files: Stream | Attachment | BufferResolvable | AttachmentPayload | JSONEncodable<APIAttachment> | AttachmentBuilder | (Stream | Attachment | BufferResolvable | AttachmentPayload | JSONEncodable<APIAttachment> | AttachmentBuilder)[]
Returns PagesBuilder
- Defined in src/builder.ts:150

addListenUsers

addListenUsers(users: AllowArray<string>): PagesBuilder
Method for adding listening to specific users
Parameters
- users: AllowArray<string>
Returns PagesBuilder
- Defined in src/builder.ts:380

addPages

addPages(pages: Page | Page[]): PagesBuilder
Method for adding pages to the end
Parameters
- pages: Page | Page[]
Returns PagesBuilder
- Defined in src/builder.ts:128

addTriggers

addTriggers<T>(triggers: Trigger<T> | Trigger<T>[]): PagesBuilder
Method for adding triggers
Type Parameters
Type Parameters
- T extends ButtonComponent | SelectMenuComponent
Parameters
- triggers: Trigger<T> | Trigger<T>[]
Returns PagesBuilder
- Defined in src/builder.ts:531

autoGeneratePages

autoGeneratePages(__namedParameters: AutoGeneratePagesOptions): PagesBuilder

Method for auto generating pages

Example

builder.autoGeneratePages({
    items: [
        'Player 1',
        'Player 2',
        'Player 3'
    ],
    countPerPage: 2
});

Parameters

__namedParameters: AutoGeneratePagesOptions

Returns PagesBuilder

build

build(options?: Pick<InteractionReplyOptions, "ephemeral">): Promise<void | APIMessage | Message<boolean>>
Build method
Parameters
- options: Pick<InteractionReplyOptions, "ephemeral"> = {}
Returns Promise<void | APIMessage | Message<boolean>>
- Defined in src/builder.ts:553

executeAction

executeAction(action: string): void
Method for invoking quick actions
Parameters
- action: string
Returns void
- Defined in src/builder.ts:760

getPage

getPage(pageNumber?: number): Promise<EmbedBuilder[]>
Method for getting the page
Parameters
- pageNumber: number = ...
Returns Promise<EmbedBuilder[]>
- Defined in src/builder.ts:231

rerender

rerender(): Promise<any>
Rerender current page

Returns Promise<any>
- Defined in src/builder.ts:546

resetListenTimeout

resetListenTimeout(__namedParameters?: ResetListenTimeoutOptions): void
Description
Method for resetting the current listening timer
Parameters
- __namedParameters: ResetListenTimeoutOptions = {}
Returns void
- Defined in src/builder.ts:342

setAuthor

setAuthor(options: null | EmbedAuthorOptions): PagesBuilder
Sets the author of this embed
Parameters
- options: null | EmbedAuthorOptions
  
  The options for the author
Returns PagesBuilder
Inherited from EmbedBuilder.setAuthor
- Defined in node_modules/@discordjs/builders/dist/messages/embed/Embed.d.ts:109

setAutoResetTimeout

setAutoResetTimeout(status?: boolean): PagesBuilder
Method for setting the timer to automatically reset when switching between pages
Parameters
- status: boolean = true
Returns PagesBuilder
- Defined in src/builder.ts:389

setColor

setColor(color: null | ColorResolvable): PagesBuilder
Parameters
- color: null | ColorResolvable
Returns PagesBuilder
Inherited from EmbedBuilder.setColor
- Defined in node_modules/discord.js/typings/index.d.ts:698

setComponents

setComponents(components: AllowArray<ActionRowBuilder<MessageActionRowComponentBuilder>>): PagesBuilder
Method for setting components rows
Parameters
- components: AllowArray<ActionRowBuilder<MessageActionRowComponentBuilder>>
Returns PagesBuilder
- Defined in src/builder.ts:409

setDefaultButtons

setDefaultButtons(buttons?: Button[]): PagesBuilder

Method for setting default buttons

Example

builder.setDefaultButtons(['first', {
  stop: new ButtonComponent()
     .setLabel('Stop')
     .setStyle('PRIMARY')
}]);

Parameters

buttons: Button[] = ...

Returns PagesBuilder

setDescription

setDescription(description: null | string): PagesBuilder
Sets the description of this embed
Parameters
- description: null | string
  
  The description
Returns PagesBuilder
Inherited from EmbedBuilder.setDescription
- Defined in node_modules/@discordjs/builders/dist/messages/embed/Embed.d.ts:121

setFields

setFields(...fields: RestOrArray<APIEmbedField>): PagesBuilder
Sets the embed's fields

Remarks
This method is an alias for EmbedBuilder.spliceFields. More specifically, it splices the entire array of fields, replacing them with the provided fields.

You can set a maximum of 25 fields.
Parameters
- Rest ...fields: RestOrArray<APIEmbedField>
  
  The fields to set
Returns PagesBuilder
Inherited from EmbedBuilder.setFields
- Defined in node_modules/@discordjs/builders/dist/messages/embed/Embed.d.ts:103

setFiles

setFiles(files: Stream | Attachment | BufferResolvable | AttachmentPayload | JSONEncodable<APIAttachment> | AttachmentBuilder | (Stream | Attachment | BufferResolvable | AttachmentPayload | JSONEncodable<APIAttachment> | AttachmentBuilder)[]): PagesBuilder
Method for initial files setup
Parameters
- files: Stream | Attachment | BufferResolvable | AttachmentPayload | JSONEncodable<APIAttachment> | AttachmentBuilder | (Stream | Attachment | BufferResolvable | AttachmentPayload | JSONEncodable<APIAttachment> | AttachmentBuilder)[]
Returns PagesBuilder
- Defined in src/builder.ts:137

setFooter

setFooter(options: null | EmbedFooterOptions): PagesBuilder
Sets the footer of this embed
Parameters
- options: null | EmbedFooterOptions
  
  The options for the footer
Returns PagesBuilder
Inherited from EmbedBuilder.setFooter
- Defined in node_modules/@discordjs/builders/dist/messages/embed/Embed.d.ts:127

setImage

setImage(url: null | string): PagesBuilder
Sets the image of this embed
Parameters
- url: null | string
  
  The URL of the image
Returns PagesBuilder
Inherited from EmbedBuilder.setImage
- Defined in node_modules/@discordjs/builders/dist/messages/embed/Embed.d.ts:133

setListenEndColor

setListenEndColor(color?: ColorResolvable): PagesBuilder
Method for setting embed color at the end of listening
Parameters
- color: ColorResolvable = 'Grey'
Returns PagesBuilder
- Defined in src/builder.ts:353

setListenEndMethod

setListenEndMethod(method: "none" | "delete" | "edit" | EndMethod | "remove_components" | "remove_embeds"): PagesBuilder
Method for setting the method of working with a message when you finish listening for reactions
Parameters
- method: "none" | "delete" | "edit" | EndMethod | "remove_components" | "remove_embeds"
Returns PagesBuilder
- Defined in src/builder.ts:362

setListenTimeout

setListenTimeout(timeout?: number): PagesBuilder
Method for setting the time to listen for updates to switch pages
Parameters
- timeout: number = ...
Returns PagesBuilder
- Defined in src/builder.ts:333

setListenUsers

setListenUsers(users?: AllowArray<string>): PagesBuilder
Method for setting listening to specific users
Parameters
- users: AllowArray<string> = []
Returns PagesBuilder
- Defined in src/builder.ts:371

setLoop

setLoop(status?: boolean): PagesBuilder
Method for setting endless page switching when reaching the end
Parameters
- status: boolean = true
Returns PagesBuilder
- Defined in src/builder.ts:278

setPage

setPage(pageNumber: number): Promise<Promise<Message<boolean>> | Promise<InteractionResponse<boolean>>>
Method for opening a specific page
Parameters
- pageNumber: number
Returns Promise<Promise<Message<boolean>> | Promise<InteractionResponse<boolean>>>
- Defined in src/builder.ts:189

setPages

setPages(pages: Page | Page[]): PagesBuilder

Method for initial pages setup

Example

builder.setPages(
    new Embed()
        .setTitle('Hello World!')
);

builder.setPages([
    new Embed()
        .setTitle('Hello World!'),
    () => (
        new Embed()
            .setTitle('Function page')
    )
]);

Parameters

pages: Page | Page[]

Returns PagesBuilder

setPaginationFormat

setPaginationFormat(format?: string): PagesBuilder
Method for setting the pagination format

Example
%c - Current page %m - Max page
```
builder.setPaginationFormat('Current page: %c, Max: %m');
```
Parameters
- format: string = '%c / %m'
Returns PagesBuilder
- Defined in src/builder.ts:269

setThumbnail

setThumbnail(url: null | string): PagesBuilder
Sets the thumbnail of this embed
Parameters
- url: null | string
  
  The URL of the thumbnail
Returns PagesBuilder
Inherited from EmbedBuilder.setThumbnail
- Defined in node_modules/@discordjs/builders/dist/messages/embed/Embed.d.ts:139

setTimestamp

setTimestamp(timestamp?: null | number | Date): PagesBuilder
Sets the timestamp of this embed
Parameters
- Optional timestamp: null | number | Date
  
  The timestamp or date
Returns PagesBuilder
Inherited from EmbedBuilder.setTimestamp
- Defined in node_modules/@discordjs/builders/dist/messages/embed/Embed.d.ts:145

setTitle

setTitle(title: null | string): PagesBuilder
Sets the title of this embed
Parameters
- title: null | string
  
  The title
Returns PagesBuilder
Inherited from EmbedBuilder.setTitle
- Defined in node_modules/@discordjs/builders/dist/messages/embed/Embed.d.ts:151

setTriggers

setTriggers<T>(triggers?: Trigger<T> | Trigger<T>[]): PagesBuilder
Method for initial setting of triggers
Type Parameters
Type Parameters
- T extends ButtonComponent | SelectMenuComponent
Parameters
- triggers: Trigger<T> | Trigger<T>[] = []
Returns PagesBuilder
- Defined in src/builder.ts:516

setURL

setURL(url: null | string): PagesBuilder
Sets the URL of this embed
Parameters
- url: null | string
  
  The URL
Returns PagesBuilder
Inherited from EmbedBuilder.setURL
- Defined in node_modules/@discordjs/builders/dist/messages/embed/Embed.d.ts:157

spliceFields

spliceFields(index: number, deleteCount: number, ...fields: APIEmbedField[]): PagesBuilder
Removes, replaces, or inserts fields in the embed.

Remarks
This method behaves similarly to Array.prototype.splice. The maximum amount of fields that can be added is 25.

It's useful for modifying and adjusting order of the already-existing fields of an embed.

Example
Remove the first field
```
embed.spliceFields(0, 1);
```
Example
Remove the first n fields
```
const n = 4
embed.spliceFields(0, n);
```
Example
Remove the last field
```
embed.spliceFields(-1, 1);
```
Parameters
- index: number
  
  The index to start at
- deleteCount: number
  
  The number of fields to remove
- Rest ...fields: APIEmbedField[]
  
  The replacing field objects
Returns PagesBuilder
Inherited from EmbedBuilder.spliceFields
- Defined in node_modules/@discordjs/builders/dist/messages/embed/Embed.d.ts:91

stopListen

stopListen(): void
Method for early stopping listening

Returns void
- Defined in src/builder.ts:398

toJSON

toJSON(): APIEmbed
Transforms the embed to a plain object

Returns APIEmbed
Inherited from EmbedBuilder.toJSON
- Defined in node_modules/@discordjs/builders/dist/messages/embed/Embed.d.ts:161

updateComponents

updateComponents(rows: AllowArray<ActionRowBuilder<MessageActionRowComponentBuilder>>): PagesBuilder

Method for update existing components

Example

const button = new ButtonComponent()
   .setCustomId('test')
   .setLabel('Test button')
   .setStyle('PRIMARY');

builder.addComponents(button);

button.setLabel('Primary button');

builder.updateComponents(button);

builder.rerender();

Parameters

rows: AllowArray<ActionRowBuilder<MessageActionRowComponentBuilder>>

Returns PagesBuilder

`Static` from

from(other: APIEmbed | JSONEncodable<APIEmbed>): EmbedBuilder
Parameters
- other: APIEmbed | JSONEncodable<APIEmbed>
Returns EmbedBuilder
Inherited from EmbedBuilder.from
- Defined in node_modules/discord.js/typings/index.d.ts:699

Class PagesBuilder

Hierarchy

Hierarchy

Index

Constructors

Properties

Accessors

Methods

Constructors

constructor

Parameters

interaction: ChatInputCommandInteraction<CacheType>

Returns PagesBuilder

Properties

Private autoResetTimeout

Private buildMethod

Private collector

Protected components

Private currentPage

Readonly data

Private defaultButtons

Private endColor

Private endMethod

Private files

Readonly interaction

Private listenTimeout

Private listenUsers

Private loop

Private message

Private Optional messageComponent

Private pages

Private paginationFormat

Private timeout

Private triggers

Accessors

appendedComponents

Returns ActionRowBuilder<MessageActionRowComponentBuilder>[]

Methods

addComponents

Parameters

components: AllowArray<MessageActionRowComponentBuilder | ActionRowBuilder<MessageActionRowComponentBuilder>>

Returns PagesBuilder

addFields

Remarks

Example

Example

Parameters

Rest ...fields: RestOrArray<APIEmbedField>

Returns PagesBuilder

addFiles

Parameters

files: Stream | Attachment | BufferResolvable | AttachmentPayload | JSONEncodable<APIAttachment> | AttachmentBuilder | (Stream | Attachment | BufferResolvable | AttachmentPayload | JSONEncodable<APIAttachment> | AttachmentBuilder)[]

Returns PagesBuilder

addListenUsers

Parameters

users: AllowArray<string>

Returns PagesBuilder

addPages

Parameters

pages: Page | Page[]

Returns PagesBuilder

addTriggers

Type Parameters

Type Parameters

T extends ButtonComponent | SelectMenuComponent

Parameters

triggers: Trigger<T> | Trigger<T>[]

Returns PagesBuilder

autoGeneratePages

Example

Parameters

__namedParameters: AutoGeneratePagesOptions

Returns PagesBuilder

build

Parameters

options: Pick<InteractionReplyOptions, "ephemeral"> = {}

Returns Promise<void | APIMessage | Message<boolean>>

executeAction

Parameters

action: string

`Private` autoResetTimeout

`Private` buildMethod

`Private` collector

`Protected` components

`Private` currentPage

`Readonly` data

`Private` defaultButtons

`Private` endColor

`Private` endMethod

`Private` files

`Readonly` interaction

`Private` listenTimeout

`Private` listenUsers

`Private` loop

`Private` message

`Private` `Optional` messageComponent

`Private` pages

`Private` paginationFormat

`Private` timeout

`Private` triggers

`Rest` ...fields: RestOrArray<APIEmbedField>

`Rest` ...fields: RestOrArray<APIEmbedField>