Class PaginationMetadata

Namespace

CivitaiSharp.Core.Models.Common

Assembly

CivitaiSharp.Core.dll

Simple pagination metadata used by paged responses.

public sealed record PaginationMetadata : IEquatable<PaginationMetadata>

Inheritance

object

PaginationMetadata

Implements

IEquatable<PaginationMetadata>

Inherited Members

object.Equals(object)

object.Equals(object, object)

object.GetHashCode()

object.GetType()

object.ReferenceEquals(object, object)

object.ToString()

Constructors

PaginationMetadata(int?, int?, int?, int?, string?, string?, string?)

Simple pagination metadata used by paged responses.

public PaginationMetadata(int? TotalItems = null, int? CurrentPage = null, int? PageSize = null, int? TotalPages = null, string? NextPage = null, string? PreviousPage = null, string? NextCursor = null)

Parameters

TotalItems int?

The total number of items available across all pages. Maps to JSON property "totalItems".

CurrentPage int?

The current page number being returned. Maps to JSON property "currentPage".

PageSize int?

The number of items per page in this response. Maps to JSON property "pageSize".

TotalPages int?

The total number of pages available. Maps to JSON property "totalPages".

NextPage string

URL to retrieve the next page of results. Maps to JSON property "nextPage".

PreviousPage string

URL to retrieve the previous page of results. Maps to JSON property "prevPage".

NextCursor string

Cursor for pagination systems. Used instead of page numbers for cursor-based pagination. Maps to JSON property "nextCursor".

Properties

CurrentPage

The current page number being returned. Maps to JSON property "currentPage".

[JsonPropertyName("currentPage")]
public int? CurrentPage { get; init; }

Property Value

int?

NextCursor

Cursor for pagination systems. Used instead of page numbers for cursor-based pagination. Maps to JSON property "nextCursor".

[JsonPropertyName("nextCursor")]
public string? NextCursor { get; init; }

Property Value

string

NextPage

URL to retrieve the next page of results. Maps to JSON property "nextPage".

[JsonPropertyName("nextPage")]
public string? NextPage { get; init; }

Property Value

string

PageSize

The number of items per page in this response. Maps to JSON property "pageSize".

[JsonPropertyName("pageSize")]
public int? PageSize { get; init; }

Property Value

int?

PreviousPage

URL to retrieve the previous page of results. Maps to JSON property "prevPage".

[JsonPropertyName("prevPage")]
public string? PreviousPage { get; init; }

Property Value

string

TotalItems

The total number of items available across all pages. Maps to JSON property "totalItems".

[JsonPropertyName("totalItems")]
public int? TotalItems { get; init; }

Property Value

int?

TotalPages

The total number of pages available. Maps to JSON property "totalPages".

[JsonPropertyName("totalPages")]
public int? TotalPages { get; init; }

Property Value

int?