Class Page<TItem>

Namespace

Auth0.ManagementApi.Core

Assembly

Auth0.ManagementApi.dll

A single Page<TItem> of items from a request that may return zero or more Page<TItem>s of items.

public class Page<TItem> : IEnumerable<TItem>, IEnumerable

Type Parameters

TItem

The type of items.

Inheritance

object

Page<TItem>

Implements

IEnumerable<TItem>

IEnumerable

Inherited Members

object.ToString()

object.Equals(object)

object.Equals(object, object)

object.ReferenceEquals(object, object)

object.GetHashCode()

object.GetType()

object.MemberwiseClone()

Extension Methods

OptionalExtensions.AddIfNotNull<T>(T?, Dictionary<string, object?>, string)

Constructors

Page(IReadOnlyList<TItem>)

Creates a new Page<TItem> with the specified items.

public Page(IReadOnlyList<TItem> items)

Parameters

items IReadOnlyList<TItem>

Page(IReadOnlyList<TItem>, object?, HttpStatusCode, ResponseHeaders?)

Creates a new Page<TItem> with the specified items and response metadata.

public Page(IReadOnlyList<TItem> items, object? response, HttpStatusCode statusCode, ResponseHeaders? headers)

Parameters

items IReadOnlyList<TItem>

response object

statusCode HttpStatusCode

headers ResponseHeaders?

Properties

Empty

An empty Page<TItem>.

public static Page<TItem> Empty { get; }

Property Value

Page<TItem>

Headers

The HTTP response headers from the response that produced this page.

public ResponseHeaders? Headers { get; }

Property Value

ResponseHeaders?

IsEmpty

Indicates whether this Page<TItem> is empty.

public bool IsEmpty { get; }

Property Value

bool

Items

Gets the items in this Page<TItem>.

public IReadOnlyList<TItem> Items { get; }

Property Value

IReadOnlyList<TItem>

Response

The full API response object for this page. Cast to the endpoint's response type to access fields beyond the paginated items (e.g., TotalCount, metadata).

public object? Response { get; }

Property Value

object

StatusCode

The HTTP status code of the response that produced this page.

public HttpStatusCode StatusCode { get; }

Property Value

HttpStatusCode

Methods

GetEnumerator()

Enumerate the items in this Page<TItem>.

public IEnumerator<TItem> GetEnumerator()

Returns

IEnumerator<TItem>