Class PaginationWrapper

Class that wraps pagination.

Hierarchy

  • PaginationWrapper

Implements

Constructors

Properties

_afterSendingAction: AfterSendingAction
_afterStopAction: StopAction
_beforeStopAction: StopAction
_buttons: ButtonWrapper[] = []
_embeds: MessageEmbed[] = []
_filterOptions: FilterOptions = {}
_time: number

Accessors

  • get afterStopAction(): StopAction
  • Returns

    Action that is called after the pagination is stopped.

    Returns StopAction

  • get beforeStopAction(): StopAction
  • Returns

    Action that is called before the pagination will be stopped.

    Returns StopAction

  • get embeds(): MessageEmbed[]
  • Returns

    Embeds for pagination.

    Returns MessageEmbed[]

  • get time(): number
  • Returns

    Time that the pagination will be alive for.

    Returns number

Methods

  • Adds user(-s) to allowed list.

    Returns

    Parameters

    • users: string | string[]

      User(-s).

    Returns PaginationWrapper

  • Gets button by it's customId.

    Returns

    Button.

    Parameters

    • customId: string

      Custom id.

    Returns ButtonWrapper

  • Sends pagination as a reply to interaction.

    Returns

    Class that represents pagination that is already sent.

    Parameters

    • interaction: Interaction<CacheType> & InteractionResponseFields<CacheType>

      Interaction.

    • options: InteractionReplyOptions = {}

      Reply options.

    • page: number = 0

      Page number which will be the starting point.

    Returns Promise<PaginationSent>

  • Overrides pagination data.

    Returns

    Parameters

    Returns void

  • Sends pagination as a reply to message.

    Returns

    Class that represents pagination that is already sent.

    Parameters

    • replyTo: Message<boolean>

      Message.

    • options: ReplyMessageOptions = {}

      Message options.

    • page: number = 0

      Page number which will be the starting point.

    Returns Promise<PaginationSent>

  • Sends pagination to the channel.

    Returns

    Class that represents pagination that is already sent.

    Parameters

    • channel: TextBasedChannel

      Channel.

    • options: MessageOptions = {}

      Message options.

    • page: number = 0

      Page number which will be the starting point.

    Returns Promise<PaginationSent>

  • Sets time that the pagination will be alive for.

    Returns

    Parameters

    • time: number

      Time.

    • bypassLimits: boolean = false

      Should the time bypass limits or not.

    Returns PaginationWrapper

Generated using TypeDoc