Interface ICollectionClient<T>
A collection of Resource that can be enumerated asynchronously.
Inherited Members
System.Collections.Generic.IAsyncEnumerable<T>.GetAsyncEnumerator(System.Threading.CancellationToken)
Namespace: Okta.Sdk
Assembly: Okta.Sdk.dll
Syntax
public interface ICollectionClient<T> : IAsyncEnumerable<T> where T : IResourceType Parameters
| Name | Description |
|---|---|
| T | The Resource type in the collection. |
Remarks
Using this object with LINQ will automatically enumerate a paginated Okta collection. See the API documentation on pagination.
Methods
GetPagedEnumerator(CancellationToken)
Returns an enumerator that can be used to retrieve items from an Okta collection page-by-page. Use this only if you need to enumerate collections manually; otherwise, use LINQ.
Declaration
IPagedCollectionEnumerator<T> GetPagedEnumerator(CancellationToken cancellationToken = default(CancellationToken))Parameters
| Type | Name | Description |
|---|---|---|
| System.Threading.CancellationToken | cancellationToken | The cancellation token. |
Returns
| Type | Description |
|---|---|
| IPagedCollectionEnumerator<T> | An enumerator that retrieves items from an Okta collection page-by-page. |
Remarks
/// See the API documentation on pagination.