Documentation

Mistake on this page? Email us

List Response

Most listing operations are paginated and respond with truncated results. This object comprises the information related to one page. For operations over a full collection, it is recommended to use the Paginator instead.

Type parameters

  • T

Hierarchy

  • ListResponse

Index

Constructors

constructor

  • new ListResponse(from: any, data?: Array<T>, mapper?: function): ListResponse
  • Parameters

    • from: any
    • Optional data: Array<T>
    • Optional mapper: function
        • (key: any): T
        • Parameters

          • key: any

          Returns T

    Returns ListResponse

Properties

after

after: string

Entity id for fetch after it

continuationMarker

continuationMarker: string

Entity id for fetch after it

data

data: Array<T>

List of results.

hasMore

hasMore: boolean

Whether there are more results to display

order

order: Order

Order of returned records

pageSize

pageSize: number

The page size

totalCount

totalCount: number

Total number of records (Approximate number of results according to the API)