class XIVAPI::Dataclasses::Pagination

Overview

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

Defined in:

dataclasses/other/pagination.cr

Constructors

Instance Method Summary

Constructor Detail

def self.new(__temp_468 : JSON::PullParser) #

Instance Method Detail

def next_page : Int32? #

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


[View source]
def next_page=(_next_page : ::Union(Int32, Nil)) #

def page : Int32 #

The number of the current page


[View source]
def page=(_page : Int32) #

def prev_page : Int32? #

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


[View source]
def prev_page=(_prev_page : ::Union(Int32, Nil)) #

def results : Int32 #

The number of results on the current page


[View source]
def results=(_results : Int32) #

def results_per_page : Int32 #

The limit of results per page


[View source]
def results_per_page=(_results_per_page : Int32) #

def to_json(json : JSON::Builder) #

def total_pages : Int32 #

The total number of pages for the request


[View source]
def total_pages=(_total_pages : Int32) #

def total_results : Int32 #

The total number of results retrieved for the request


[View source]
def total_results=(_total_results : Int32) #