API version:
Show / Hide Table of Contents

Class CollectionAsyncEnumerator<T>

Enumerates an Okta API collection for use with LINQ. This is an internal class; use PagedCollectionEnumerator<T> if you need to page collections yourself.

Inheritance
System.Object
CollectionAsyncEnumerator<T>
Implements
System.Collections.Generic.IAsyncEnumerator<T>
System.IAsyncDisposable
Inherited Members
System.Object.Equals(System.Object)
System.Object.Equals(System.Object, System.Object)
System.Object.GetHashCode()
System.Object.GetType()
System.Object.MemberwiseClone()
System.Object.ReferenceEquals(System.Object, System.Object)
System.Object.ToString()
Namespace: Okta.Sdk.Internal
Assembly: Okta.Sdk.dll
Syntax
public sealed class CollectionAsyncEnumerator<T> : IAsyncEnumerator<T>, IAsyncDisposable where T : IResource
Type Parameters
Name Description
T

The type of items in the collection.

Remarks

See the API documentation on pagination.

Constructors

CollectionAsyncEnumerator(IDataStore, HttpRequest, RequestContext, CancellationToken)

Initializes a new instance of the CollectionAsyncEnumerator<T> class.

Declaration
public CollectionAsyncEnumerator(IDataStore dataStore, HttpRequest initialRequest, RequestContext requestContext, CancellationToken cancellationToken)
Parameters
Type Name Description
IDataStore dataStore

The IDataStore to use.

HttpRequest initialRequest

The initial HTTP request options.

RequestContext requestContext

The request context.

System.Threading.CancellationToken cancellationToken

The cancellation token.

Properties

Current

Declaration
public T Current { get; }
Property Value
Type Description
T

Methods

DisposeAsync()

Declaration
public ValueTask DisposeAsync()
Returns
Type Description
System.Threading.Tasks.ValueTask

MoveNextAsync()

Declaration
public ValueTask<bool> MoveNextAsync()
Returns
Type Description
System.Threading.Tasks.ValueTask<System.Boolean>

Implements

System.Collections.Generic.IAsyncEnumerator<T>
System.IAsyncDisposable
Back to top Copyright © 2021 Okta, Inc.
Generated with DocFx.