AsyncPageCollection<T> Class

Definition

Namespace:

System.ClientModel

Assembly:

System.ClientModel.dll

Package:

System.ClientModel v1.1.0-beta.7

Source:

AsyncPageCollectionOfT.cs

An asynchronous collection of page results returned by a cloud service. Cloud services use pagination to return a collection of items over multiple responses. Each response from the service returns a page of items in the collection, as well as the information needed to obtain the next page of items, until all the items in the requested collection have been returned. To enumerate the items in the collection, instead of the pages in the collection, call GetAllValuesAsync(CancellationToken). To get the current collection page, call GetCurrentPageAsync().

public abstract class AsyncPageCollection<T> : System.Collections.Generic.IAsyncEnumerable<System.ClientModel.PageResult<T>>

type AsyncPageCollection<'T> = class
    interface IAsyncEnumerable<PageResult<'T>>

Public MustInherit Class AsyncPageCollection(Of T)
Implements IAsyncEnumerable(Of PageResult(Of T))

Type Parameters

T

Inheritance

Object

AsyncPageCollection<T>

Implements

IAsyncEnumerable<PageResult<T>>

Constructors

AsyncPageCollection<T>()

Create a new instance of AsyncPageCollection<T>.

Methods

GetAllValuesAsync(CancellationToken)	Get a collection of all the values in the collection requested from the cloud service, rather than the pages of values.
GetAsyncEnumeratorCore(CancellationToken)	Get an async enumerator that can enumerate the pages of values returned by the cloud service.
GetCurrentPageAsync()	Get the current page of the collection.
GetCurrentPageAsyncCore()	Get the current page of the collection.

Explicit Interface Implementations

IAsyncEnumerable<PageResult<T>>.GetAsyncEnumerator(CancellationToken)

Returns an enumerator that iterates asynchronously through the collection.