class Prismic::Response
Paginated response to a Prismic.io query. Note that you may not get all documents in the first page, and may need to retrieve more pages or increase the page size.
Attributes
@return [Number] current page, starting at 1
@return [Number]
@return [String] URL to the next page - nil if current page is the last page
@return [Number] current page, starting at 1
@return [String] URL to the previous page - nil if current page is the first page
@return [Array<Document>] Documents of the current page
@return [Number]
@return [Number]
@return [Number]
@return [Number]
Public Class Methods
# File lib/prismic.rb, line 414 def initialize(page, results_per_page, results_size, total_results_size, total_pages, next_page, prev_page, results) @page = page @results_per_page = results_per_page @results_size = results_size @total_results_size = total_results_size @total_pages = total_pages @next_page = next_page @prev_page = prev_page @results = results end
Public Instance Methods
Accessing the i-th document in the results @return [Document]
# File lib/prismic.rb, line 427 def [](i) @results[i] end
Iterates over received documents
@yieldparam document [Document]
This method _does not_ paginates by itself. So only the received document will be returned.
# File lib/prismic.rb, line 438 def each(&blk) @results.each(&blk) end
Return the number of returned documents
@return [Fixum]
# File lib/prismic.rb, line 446 def length @results.length end