Interface IPagedEnvelope<TItem>

Namespace

MassiveDotNet.Http

Assembly

MassiveDotNet.dll

A response envelope that carries one page of results and, when more exist, a cursor to the next page.

public interface IPagedEnvelope<TItem>

Type Parameters

TItem

The result item type.

Remarks

Implemented by generated response envelopes for the operations whose OpenAPI success schema declares next_url. It exists so that EnumerateAsync<TEnvelope, TItem>(string, JsonTypeInfo<TEnvelope>, CancellationToken) can traverse any of them with a single implementation, rather than the generator emitting one traversal loop per endpoint.

Properties

NextUrl

The absolute URL of the next page, or null on the final page.

string? NextUrl { get; }

Property Value

string

Results

The results in this page, or null when the server sent none.

TItem[]? Results { get; }

Property Value

TItem[]