welkin.pagination
=================

.. py:module:: welkin.pagination


Attributes
----------

.. autoapisummary::

   welkin.pagination.DEFAULT_PAGE_SIZE


Classes
-------

.. autoapisummary::

   welkin.pagination.PageIterator
   welkin.pagination.PageableIterator
   welkin.pagination.FormationIterator
   welkin.pagination.PageNumberIterator
   welkin.pagination.MetaInfoIterator
   welkin.pagination.MetaIterator
   welkin.pagination.CursorIterator


Module Contents
---------------

.. py:data:: DEFAULT_PAGE_SIZE
   :value: 20


.. py:class:: PageIterator(collection, resource, method, size=DEFAULT_PAGE_SIZE, *args, **kwargs)

   .. py:attribute:: collection


   .. py:attribute:: resource


   .. py:attribute:: method


   .. py:attribute:: size
      :value: 20



   .. py:attribute:: meta_key
      :value: None



   .. py:attribute:: meta_dict


   .. py:attribute:: args
      :value: ()



   .. py:attribute:: kwargs


   .. py:property:: resources


.. py:class:: PageableIterator(*args, **kwargs)

   Bases: :py:obj:`PageIterator`


   Most common paging class.


   .. py:attribute:: meta_key
      :value: 'pageable'



.. py:class:: FormationIterator(*args, **kwargs)

   Bases: :py:obj:`PageIterator`


   Specifically for paginating formations responses.

   Similar to PageableIterator but includes special behavior for single item formations,
   e.g. encounter disposition


   .. py:attribute:: meta_key
      :value: 'pageable'



.. py:class:: PageNumberIterator(*args, **kwargs)

   Bases: :py:obj:`PageableIterator`


   PageableIterator with a different key used for the page count.


.. py:class:: MetaInfoIterator(*args, **kwargs)

   Bases: :py:obj:`PageIterator`


   Functionally identical to PageableIterator with various renamed keys.


   .. py:attribute:: meta_key
      :value: 'metaInfo'



.. py:class:: MetaIterator(*args, **kwargs)

   Bases: :py:obj:`PageIterator`


   Paging class for token based paging.


   .. py:attribute:: meta_key
      :value: 'meta'



   .. py:attribute:: meta_dict


.. py:class:: CursorIterator(*args, **kwargs)

   Bases: :py:obj:`PageIterator`


   .. py:attribute:: meta_key
      :value: 'cursor'



   .. py:attribute:: meta_dict