Class ChannelPagination

Pagination that is sent to a text channel.

Hierarchy

Constructors

constructor

Accessors

afterSending buttons collector collectorOptions currentPage embeds filterOptions isActive messageOptions onStop time

Methods

_collected _formCollector _getActionRowsByPage _setActive _setCollector _setCurrentPage _setTime _stop getButtonByCustomId insertEmbeds removeEmbeds send setAfterSendingAction setButtons setCollectorOptions setEmbeds setFilterOptions setMessageOptions setOnStopAction setTime

Constructors

constructor

Accessors

afterSending

  • get afterSending(): null | AfterSending

  • Action that will be completed after the pagination was sent.

    Returns null | AfterSending

buttons

  • get buttons(): null | ButtonData[]

  • The buttons of this pagination. By default is an empty array.

    Returns null | ButtonData[]

collector

  • get collector(): null | InteractionCollector<ButtonInteraction<CacheType>>

  • Collector that collects button interactions.

    Returns null | InteractionCollector<ButtonInteraction<CacheType>>

collectorOptions

  • get collectorOptions(): null | CollectorOptions

  • Options for collecting button interactions.

    Returns null | CollectorOptions

currentPage

  • get currentPage(): number

  • Current page number. Zero-based. By default is zero.

    Returns number

embeds

  • get embeds(): null | EmbedBuilder[]

  • Embeds of this pagination. By default is an empty array.

    Returns null | EmbedBuilder[]

filterOptions

  • get filterOptions(): null | FilterOptions

  • Options for filtering button interactions. By default singleUserAccess and noAccessReply are true. And noAccessReplyContent is "You're disallowed to use this very pagination!".

    Returns null | FilterOptions

isActive

  • get isActive(): boolean

  • Indicates whether this pagination sent or not. By default is false.

    Returns boolean

messageOptions

  • get messageOptions(): null | T

  • Options for sending out message.

    Returns null | T

onStop

  • get onStop(): null | OnStop

  • Action that will be completed after the pagination was stopped.

    Returns null | OnStop

time

  • get time(): null | number

  • How long the pagination will exist (in milliseconds). By default is zero.

    Returns null | number

Methods

Protected _collected

  • _collected(interaction: ButtonInteraction<CacheType>): Promise<void>

  • Method that handles collect event.

    Returns

    Updates pagination.

    Parameters

    • interaction: ButtonInteraction<CacheType>

      Interaction that the collector got.

    Returns Promise<void>

Protected _formCollector

  • _formCollector(message: Message<boolean>, user?: User): InteractionCollector<ButtonInteraction<CacheType>>

  • Forms collector.

    Returns

    Interaction Collector.

    Parameters

    • message: Message<boolean>

      Message that collector should stick to.

    • Optional user: User

      Used only if singleUserAccess is true. Needed only if only one user should be able to use pagination.

    Returns InteractionCollector<ButtonInteraction<CacheType>>

Protected _getActionRowsByPage

  • _getActionRowsByPage(page: number): Promise<ActionRowBuilder<ButtonBuilder>[]>

  • Gets actionRows with buttons for specific page.

    Returns

    ActionRows.

    Parameters

    • page: number

      Page number.

    Returns Promise<ActionRowBuilder<ButtonBuilder>[]>

Protected _setActive

  • _setActive(active?: boolean): boolean

  • Sets active state.

    Returns

    Active state.

    Parameters

    • active: boolean = true

      Whether to set pagination as active.

    Returns boolean

Protected _setCollector

  • _setCollector(collector: InteractionCollector<ButtonInteraction<CacheType>>): InteractionCollector<ButtonInteraction<CacheType>>

  • Sets collector of the pagination.

    Returns

    Collector that collects button interactions.

    Parameters

    • collector: InteractionCollector<ButtonInteraction<CacheType>>

      Collector that collects button interactions.

    Returns InteractionCollector<ButtonInteraction<CacheType>>

Protected _setCurrentPage

  • _setCurrentPage(page?: number): number

  • Sets current page number.

    Returns

    Number of the current page.

    Parameters

    • page: number = 0

      Number of the page.

    Returns number

Protected _setTime

  • _setTime(time: number): number

  • Sets life-time of pagination.

    Returns

    Time in milliseconds.

    Parameters

    • time: number

      Time in milliseconds.

    Returns number

Protected _stop

  • _stop(reason: string, message: Message<boolean> | Interaction<CacheType>): Promise<void>

  • Method that handles stop event.

    Returns

    Updates pagination.

    Parameters

    • reason: string

      Reason of collector's stop event.

    • message: Message<boolean> | Interaction<CacheType>

      Message that was sent or Interaction that was replied.

    Returns Promise<void>

getButtonByCustomId

insertEmbeds

  • Inserts embeds.

    Returns

    Pagination.

    Parameters

    • embeds: Embed | EmbedBuilder | (Embed | EmbedBuilder)[]

      Embed(-s) that is/are meant to be inserted.

    • Optional index: number

      Zero-based location in the array there the embed(-s) should be inserted.

    Returns ChannelPagination

removeEmbeds

  • Removes embed(-s) by it's/theirs index(-es) in the array of embeds.

    Returns

    Pagination.

    Parameters

    • index: number

      Zero-based location in the array from which to start removing embeds.

    • count: number = 1

      Quantity of embeds to remove.

    Returns ChannelPagination

send

  • Sends pagination to the specified channel.

    Returns

    Sends pagination.

    Parameters

    • sendTo: TextBasedChannel

      Channel where the pagination should be sent.

    • Optional user: User

      Needed only if one user should be able to use pagination.

    Returns Promise<void>

setAfterSendingAction

setButtons

setCollectorOptions

setEmbeds

  • Sets embed(-s). Overrides current embed(-s).

    Returns

    Pagination.

    Parameters

    • embeds: Embed | EmbedBuilder | (Embed | EmbedBuilder)[]

      Embed(-s) that is/are meant to be set.

    Returns ChannelPagination

setFilterOptions

setMessageOptions

setOnStopAction

setTime

  • Sets pagination active phase duration.

    Returns

    Pagination.

    Parameters

    • time: number

      Time in milliseconds.

    • Optional bypassLibraryLimits: boolean

      Should the time bypass library limit or not.

    Returns ChannelPagination

Settings

Member Visibility

Theme

Generated using TypeDoc