Interface IPaginationContext

Namespace

JsonApiDotNetCore.Queries

Assembly

JsonApiDotNetCore.dll

Tracks values used for top-level pagination, which is a combined effort from options, query string parsing, resource definition callbacks and fetching the total number of rows.

public interface IPaginationContext

Properties

IsPageFull

Indicates whether the number of resources on the current page equals the page size. When true, a subsequent page might exist (assuming TotalResourceCount is unknown).

bool IsPageFull { get; set; }

Property Value

bool

PageNumber

The value 1, unless overridden from query string or resource definition. Should not be higher than MaximumPageNumber.

PageNumber PageNumber { get; set; }

Property Value

PageNumber

PageSize

The default page size from options, unless overridden from query string or resource definition. Should not be higher than MaximumPageSize. Can be null, which means pagination is disabled.

PageSize? PageSize { get; set; }

Property Value

PageSize

TotalPageCount

The total number of resource pages, or null when IncludeTotalResourceCount is set to false or PageSize is null.

int? TotalPageCount { get; }

Property Value

int?

TotalResourceCount

The total number of resources, or null when IncludeTotalResourceCount is set to false.

int? TotalResourceCount { get; set; }

Property Value

int?