Class AsyncCollectionResult

Represents a collection of values returned from a cloud service operation. The collection values may be delivered over one or more service responses.

Inheritance

System.Object

AsyncCollectionResult

AsyncCollectionResult<T>

Namespace: System.Dynamic.ExpandoObject

Assembly: System.ClientModel.dll

Syntax

[System.Runtime.CompilerServices.Nullable(0)]
[System.Runtime.CompilerServices.NullableContext(1)]
public abstract class AsyncCollectionResult

Constructors

AsyncCollectionResult()

Creates a new instance of AsyncCollectionResult.

Declaration

protected AsyncCollectionResult ();

Methods

GetContinuationToken(ClientResult)

Gets a ContinuationToken that can be passed to a client method to obtain a collection holding the items remaining in this AsyncCollectionResult.

Declaration

public abstract System.ClientModel.ContinuationToken GetContinuationToken (System.ClientModel.ClientResult page);

Parameters

ClientResult page The raw page to obtain a continuation token for.

Returns

ContinuationToken A ContinuationToken that a client can use to obtain an AsyncCollectionResult whose items start at the first item after the last item in page, or null if page is the last page in the sequence of page responses delivering the items in the collection.

GetRawPagesAsync()

Gets the collection of page responses that contain the items in this collection.

Declaration

public abstract System.Collections.Generic.IAsyncEnumerable<System.ClientModel.ClientResult> GetRawPagesAsync ();

Returns

System.Collections.Generic.IAsyncEnumerable<ClientResult> A collection of service responses where each ClientResult holds a subset of items in the full collection.

Remarks

This method does not take a System.Threading.CancellationToken parameter. AsyncCollectionResult implementations must store the System.Threading.CancellationToken passed to the service method that creates them and pass that token to any async methods called from this method. For protocol methods, this System.Threading.CancellationToken will come from the CancellationToken property.