Class: Prismic::Response

Inherits:
Object
  • Object
show all
Includes:
Enumerable
Defined in:
lib/prismic.rb

Overview

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.

Instance Attribute Summary collapse

Instance Method Summary collapse

Constructor Details

#initialize(page, results_per_page, results_size, total_results_size, total_pages, next_page, prev_page, results) ⇒ Response

Returns a new instance of Response



400
401
402
403
404
405
406
407
408
409
 
# File 'lib/prismic.rb', line 400

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

Instance Attribute Details

#next_page ⇒ String

Returns URL to the next page - nil if current page is the last page

Returns:

  • (String) —

    URL to the next page - nil if current page is the last page



390
391
392
 
# File 'lib/prismic.rb', line 390

def next_page
  @next_page
end

#page ⇒ Number Also known as: current_page

Returns current page, starting at 1

Returns:

  • (Number) —

    current page, starting at 1



380
381
382
 
# File 'lib/prismic.rb', line 380

def page
  @page
end

#prev_page ⇒ String

Returns URL to the previous page - nil if current page is the first page

Returns:

  • (String) —

    URL to the previous page - nil if current page is the first page



392
393
394
 
# File 'lib/prismic.rb', line 392

def prev_page
  @prev_page
end

#results ⇒ Array<Document>

Returns Documents of the current page

Returns:

  • (Array<Document>) —

    Documents of the current page



394
395
396
 
# File 'lib/prismic.rb', line 394

def results
  @results
end

#results_per_page ⇒ Number Also known as: limit_value

Returns:

  • (Number) 


382
383
384
 
# File 'lib/prismic.rb', line 382

def results_per_page
  @results_per_page
end

#results_size ⇒ Number

Returns:

  • (Number) 


384
385
386
 
# File 'lib/prismic.rb', line 384

def results_size
  @results_size
end

#total_pages ⇒ Number

Returns:

  • (Number) 


388
389
390
 
# File 'lib/prismic.rb', line 388

def total_pages
  @total_pages
end

#total_results_size ⇒ Number

Returns:

  • (Number) 


386
387
388
 
# File 'lib/prismic.rb', line 386

def total_results_size
  @total_results_size
end

Instance Method Details

#[](i) ⇒ Document Also known as: get

Accessing the i-th document in the results

Returns:



413
414
415
 
# File 'lib/prismic.rb', line 413

def [](i)
  @results[i]
end

#each {|document| ... } ⇒ Object

Iterates over received documents

This method does not paginates by itself. So only the received document will be returned.

Yield Parameters:



424
425
426
 
# File 'lib/prismic.rb', line 424

def each(&blk)
  @results.each(&blk)
end

#length ⇒ Fixum Also known as: size

Return the number of returned documents

Returns:

  • (Fixum) 


432
433
434
 
# File 'lib/prismic.rb', line 432

def length
  @results.length
end