Module: ZendeskAPI::Collection::Pagination

Included in:
ZendeskAPI::Collection
Defined in:
lib/zendesk_api/pagination.rb

Overview

Contains all methods related to pagination in an attempt to slim down collection.rb

Constant Summary collapse

DEFAULT_PAGE_SIZE = 
100

Instance Method Summary collapse

Instance Method Details

#first_page? ⇒ Boolean

Returns:

  • (Boolean) 
 27 28 29
 
# File 'lib/zendesk_api/pagination.rb', line 27 def first_page? !@prev_page end

#last_page? ⇒ Boolean

Returns:

  • (Boolean) 
 31 32 33
 
# File 'lib/zendesk_api/pagination.rb', line 31 def last_page? !@next_page || @next_page == @query end

#more_results?(response) ⇒ Boolean Also known as: has_more_results?

Returns:

  • (Boolean) 
 6 7 8
 
# File 'lib/zendesk_api/pagination.rb', line 6 def more_results?(response) Helpers.present?(response["meta"]) && response["meta"]["has_more"] end

#page(number) ⇒ Collection

Changes the page option. Returns self, so it can be chained. No execution.

Returns:

 21 22 23 24 25
 
# File 'lib/zendesk_api/pagination.rb', line 21 def page(number) clear_cache if number @options["page"] = number self end

#per_page(count) ⇒ Collection

Changes the per_page option. Returns self, so it can be chained. No execution.

Returns:

 13 14 15 16 17
 
# File 'lib/zendesk_api/pagination.rb', line 13 def per_page(count) clear_cache if count @options["per_page"] = count self end