Class: FinchAPI::Models::Paging

Inherits:

BaseModel

• Object
• FinchAPI::Models::Paging

Defined in:

lib/finch-api/models/paging.rb

Instance Attribute Summary

• #count ⇒ Integer^?

  The total number of elements for the entire query (not just the given page).

• #offset ⇒ Integer^?

  The current start index of the returned list of elements.

Instance Method Summary

• #initialize(count: nil, offset: nil) ⇒ Paging constructor

  A new instance of Paging.

Constructor Details

#initialize(count: nil, offset: nil) ⇒ Paging

Returns a new instance of Paging.

Parameters:

• count (Integer) (defaults to: nil)
• offset (Integer) (defaults to: nil)

# File 'lib/finch-api/models/paging.rb', line 4

def initialize(count: nil, offset: nil, **) = super

Instance Attribute Details

#count ⇒ Integer^?

The total number of elements for the entire query (not just the given page)

Returns:

• (Integer, nil)

# File 'lib/finch-api/models/paging.rb', line 10

optional :count, Integer

#offset ⇒ Integer^?

The current start index of the returned list of elements

Returns:

• (Integer, nil)

# File 'lib/finch-api/models/paging.rb', line 20

optional :offset, Integer