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

current_page[RW]

@return [Number] current page, starting at 1

limit_value[RW]

@return [Number]

next_page[RW]

@return [String] URL to the next page - nil if current page is the last page

page[RW]

@return [Number] current page, starting at 1

prev_page[RW]

@return [String] URL to the previous page - nil if current page is the first page

results[RW]

@return [Array<Document>] Documents of the current page

results_per_page[RW]

@return [Number]

results_size[RW]

@return [Number]

total_pages[RW]

@return [Number]

total_results_size[RW]

@return [Number]

Public Class Methods

new(page, results_per_page, results_size, total_results_size, total_pages, next_page, prev_page, results) click to toggle source
# 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

[](i) click to toggle source

Accessing the i-th document in the results @return [Document]

# File lib/prismic.rb, line 427
def [](i)
  @results[i]
end
Also aliased as: get
each(&blk) click to toggle source

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
get(i)
Alias for: []
length() click to toggle source

Return the number of returned documents

@return [Fixum]

# File lib/prismic.rb, line 446
def length
  @results.length
end
Also aliased as: size
size()
Alias for: length