Interface IPagedCollectionEnumerator<T>

Enumerates an Okta collection by retrieving pages of results.

Namespace: Okta.Sdk

Assembly: Okta.Sdk.dll

Syntax

public interface IPagedCollectionEnumerator<T>
    where T : IResource

Type Parameters

Name	Description
T	The type of items in the collection.

Remarks

See the API documentation on pagination.

Properties

CurrentPage

Gets the current page of items, or null if MoveNextAsync() has not yet been called.

Declaration

CollectionPage<T> CurrentPage { get; }

Property Value

Type	Description
CollectionPage<T>	The current page of items, if any.

Methods

MoveNextAsync()

Asynchronously retrieves the next page of results and updates CurrentPage. If there are no more pages, this method returns false.

Declaration

Task<bool> MoveNextAsync()

Returns

Type	Description
System.Threading.Tasks.Task<System.Boolean>	true if CurrentPage has been updated with new items, false if the collection has been exhausted.