Table of Contents

Class PageResponse<T>

Namespace
Vonage.Common
Assembly
Vonage.dll

Represents a paginated API response following the HAL (Hypertext Application Language) standard.

public class PageResponse<T> where T : class

Type Parameters

T

The type of the embedded content (typically a collection wrapper).

Inheritance
PageResponse<T>
Inherited Members

Remarks

HAL responses include navigation links for pagination and embedded content.

Use the Links property to navigate between pages.

Properties

Count

Gets or sets the total number of records across all pages.

[JsonProperty("count")]
public int Count { get; set; }

Property Value

int

Embedded

Gets or sets the embedded content containing the actual data records.

[JsonProperty("_embedded")]
public T Embedded { get; set; }

Property Value

T

Gets or sets the HAL navigation links for pagination (self, next, previous, first, last).

[JsonProperty("_links")]
public HALLinks Links { get; set; }

Property Value

HALLinks

PageIndex

Gets or sets the current page index (zero-based).

[JsonProperty("page_index")]
public int PageIndex { get; set; }

Property Value

int

PageSize

Gets or sets the number of records per page.

[JsonProperty("page_size")]
public int PageSize { get; set; }

Property Value

int