Class OpenBiListResult<T>

Namespace

BiExcellence.OpenBi.Api

Assembly

BiExcellence.OpenBi.Api.Client.dll

The items returned by a list endpoint, together with the total number of matching items on the server when the request asked for it via IncludeTotalCount(bool).

public sealed class OpenBiListResult<T>

Type Parameters

T

Inheritance

object

OpenBiListResult<T>

Constructors

OpenBiListResult(IReadOnlyList<T>, int?)

Wraps the items of one list response.

public OpenBiListResult(IReadOnlyList<T> items, int? totalCount)

Parameters

items IReadOnlyList<T>

The items the server returned.

totalCount int?

The value of the X-Total-Count response header, or null when there was none.

Properties

Count

The number of items returned - the page size, not TotalCount.

public int Count { get; }

Property Value

int

this[int]

Gets the item at the given position of the returned page.

public T this[int index] { get; }

Parameters

index int

Property Value

T

TotalCount

The total number of items matching the request on the server (independent of $top/$skip paging), or null when the request did not ask for it.

public int? TotalCount { get; }

Property Value

int?

Methods

GetEnumerator()

Enumerates the returned items.

public IEnumerator<T> GetEnumerator()

Returns

IEnumerator<T>