ItemPaged Class
Return an iterator of items.
args and kwargs will be passed to the PageIterator constructor directly, except page_iterator_class
Constructor
ItemPaged(*args: Any, **kwargs: Any)Methods
| by_page |
Get an iterator of pages of objects, instead of an iterator of objects. |
| next |
Get the next item in the iterator. |
by_page
Get an iterator of pages of objects, instead of an iterator of objects.
by_page(continuation_token: str | None = None) -> Iterator[Iterator[ReturnType]]Parameters
| Name | Description |
|---|---|
|
continuation_token
|
An opaque continuation token. This value can be retrieved from the continuation_token field of a previous generator object. If specified, this generator will begin returning results from this point. Default value: None
|
Returns
| Type | Description |
|---|---|
|
<xref:iterator>[<xref:iterator>[<xref:ReturnType>]]
|
An iterator of pages (themselves iterator of objects) |
next
Get the next item in the iterator.
next() -> ReturnTypeReturns
| Type | Description |
|---|---|
|
<xref:ReturnType>
|
The next item in the iterator. |
Exceptions
| Type | Description |
|---|---|
|
If there are no more items to return. |
