Condividi tramite

ItemPaged Class

  • Reference

Return an iterator of items.

args and kwargs will be passed to the PageIterator constructor directly, except page_iterator_class

Inheritance
Iterator
ItemPaged
Generic
ItemPaged

Constructor

ItemPaged(*args: Any, **kwargs: Any)

Methods

by_page

Get an iterator of pages of objects, instead of an iterator of objects.
next

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
str

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 

next() -> ReturnType