Interface PaginatedResult<T>

Contains a page of results for message or presence history, stats, or REST presence requests. A PaginatedResult response from a REST API paginated query is also accompanied by metadata that indicates the relative queries available to the PaginatedResult object.

Type Parameters

  • T

Hierarchy

Properties

Methods

Properties

items: T[]

Contains the current page of results; for example, an array of InboundMessage or PresenceMessage objects for a channel history request.

Methods

  • Returns a new PaginatedResult for the first page of results.

    Returns Promise<PaginatedResult<T>>

    A promise which, upon success, will be fulfilled with a page of results for message and presence history, stats, and REST presence requests. Upon failure, the promise will be rejected with an ErrorInfo object which explains the error.

  • Returns true if there are more pages available by calling next and returns false if this page is the last page available.

    Returns boolean

    Whether or not there are more pages of results.

  • Returns true if this page is the last page and returns false if there are more pages available by calling next available.

    Returns boolean

    Whether or not this is the last page of results.

  • Returns a new PaginatedResult loaded with the next page of results. If there are no further pages, then null is returned.

    Returns Promise<null | PaginatedResult<T>>

    A promise which, upon success, will be fulfilled with a page of results for message and presence history, stats, and REST presence requests. Upon failure, the promise will be rejected with an ErrorInfo object which explains the error.

Generated using TypeDoc