ItemPaged 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	Return the next item from the iterator. When exhausted, raise StopIteration

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

continuation_token

str

default value: None

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.

Returns

An iterator of pages (themselves iterator of objects)

next

Return the next item from the iterator. When exhausted, raise StopIteration

next() -> ReturnType