class

XIVAPI::Dataclasses::Pagination

Inherits JSON::Serializable < Reference < Object

Dataclass for pagination data that is returned for paginated lists that come from certain API endpoints.

Constructors

new(pull : JSON::PullParser)
Source
new(*, __pull_for_json_serializable pull : JSON::PullParser)
Source

Instance methods

next_page

The number of the next page, or nil if there are none

Source
page

The number of the current page

Source
prev_page

The number of the previous page, or nil if there are none

Source
results

The number of results on the current page

Source
results_per_page

The limit of results per page

Source
total_pages

The total number of pages for the request

Source
total_results

The total number of results retrieved for the request

Source