PagedListResponse
class PagedListResponse
Response object for paged results from a list API method
The PagedListResponse object is returned by API methods that implement pagination, and makes it easier to access multiple pages of results without having to manually manipulate page tokens. Pages are retrieved lazily, with additional API calls being made as additional results are required.
The list elements can be accessed in the following ways: - As a single iterable using the iterateAllElements method - As pages of elements, using the getPage and iteratePages methods - As fixed size collections of elements, using the getFixedSizeCollection and iterateFixedSizeCollections methods
Methods
Returns an iterator over the full list of elements. Elements of the list are retrieved lazily using the underlying API.
Returns an iterator over pages of results. The pages are retrieved lazily from the underlying API.
Returns a collection of elements with a fixed size set by the collectionSize parameter. The collection will only contain fewer than collectionSize elements if there are no more pages to be retrieved from the server.
Returns an iterator over fixed size collections of results.
Details
at line 60
__construct(Page $firstPage)
PagedListResponse constructor.
at line 72
Generator
iterateAllElements()
Returns an iterator over the full list of elements. Elements of the list are retrieved lazily using the underlying API.
at line 86
Page
getPage()
Return the current page of results.
at line 97
Page[]
iteratePages()
Returns an iterator over pages of results. The pages are retrieved lazily from the underlying API.
at line 117
FixedSizeCollection
expandToFixedSizeCollection($collectionSize)
Returns a collection of elements with a fixed size set by the collectionSize parameter. The collection will only contain fewer than collectionSize elements if there are no more pages to be retrieved from the server.
NOTE: it is an error to call this method if an optional parameter to set the page size is not supported or has not been set in the original API call. It is also an error if the collectionSize parameter is less than the page size that has been set.
at line 139
Generator|FixedSizeCollection[]
iterateFixedSizeCollections($collectionSize)
Returns an iterator over fixed size collections of results.
The collections are retrieved lazily from the underlying API.
Each collection will have collectionSize elements, with the exception of the final collection which may contain fewer elements.
NOTE: it is an error to call this method if an optional parameter to set the page size is not supported or has not been set in the original API call. It is also an error if the collectionSize parameter is less than the page size that has been set.