Class HttpPaginatedResponse<T>

A superset of PaginatedResult which represents a page of results plus metadata indicating the relative queries available to it. HttpPaginatedResponse additionally carries information about the response to an HTTP request.

Type Parameters

  • T = any

Hierarchy

Constructors

constructor

Properties

errorCode errorMessage headers items statusCode success

Methods

current first hasNext isLast next

Constructors

constructor

Properties

errorCode

errorCode: number

The error code if the X-Ably-Errorcode HTTP header is sent in the response.

errorMessage

errorMessage: string

The error message if the X-Ably-Errormessage HTTP header is sent in the response.

headers

headers: any

The headers of the response.

items

items: T[]

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

statusCode

statusCode: number

The HTTP status code of the response.

success

success: boolean

Whether statusCode indicates success. This is equivalent to 200 <= statusCode < 300.

Methods

current

first

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

    Parameters

    • results: paginatedResultCallback<T>

      A function which, upon success, will be called with a page of results for message and presence history, stats, and REST presence requests. Upon failure, the function will be called with information about the error.

    Returns void

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

    Returns

    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 Promise<PaginatedResult<T>>

hasNext

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

    Returns

    Whether or not there are more pages of results.

    Returns boolean

isLast

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

    Returns

    Whether or not this is the last page of results.

    Returns boolean

next

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

    Parameters

    • results: StandardCallback<null | PaginatedResult<T>>

      A function which, upon success, will be fulfilled with a page of results for message and presence history, stats, and REST presence requests. Upon failure, the function will be called with information about the error.

    Returns void

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

    Returns

    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 Promise<null | PaginatedResult<T>>

Settings

Member Visibility

Theme

Generated using TypeDoc