Package com.vonage.client.common

Class HalPageResponse

java.lang.Object

com.vonage.client.JsonableBaseObject

com.vonage.client.common.HalPageResponse

All Implemented Interfaces:

Jsonable

Direct Known Subclasses:

ApplicationList, ListConversationsResponse, ListEventsResponse, ListItemsResponse, ListListsResponse, ListMembersResponse, ListSecretsResponse, ListTemplateFragmentsResponse, ListTemplatesResponse, ListUserConversationsResponse, ListUsersResponse

public abstract class HalPageResponse
extends JsonableBaseObject

Abstract base class for responses that conform to the HAL specification.

Field Summary

Fields

Modifier and Type	Field	Description
protected Integer	page
protected Integer	pageSize
protected Integer	totalItems
protected Integer	totalPages

Constructor Summary

Constructors

Constructor	Description
HalPageResponse()

Method Summary

Modifier and Type	Method	Description
HalLinks	getLinks()	The _links property in the HAL response.
Integer	getPage()	Current page.
Integer	getPageSize()	Size of each page.
Integer	getTotalItems()	Size of this page.
Integer	getTotalPages()	Number of results pages.

Methods inherited from class com.vonage.client.JsonableBaseObject

createJsonObjectMapper, equals, hashCode, toString

Methods inherited from class java.lang.Object

clone, finalize, getClass, notify, notifyAll, wait, wait, wait

Methods inherited from interface com.vonage.client.Jsonable

toJson, updateFromJson

Field Details

page

protected Integer page

pageSize

protected Integer pageSize

totalItems

protected Integer totalItems

totalPages

protected Integer totalPages

Constructor Details

HalPageResponse

public HalPageResponse()

Method Details

getPage

public Integer getPage()

Current page.

Returns:

The current page number, or null if not applicable.

getPageSize

public Integer getPageSize()

Size of each page.

Returns:

Number of results per page, or null if not applicable.

getTotalItems

public Integer getTotalItems()

Size of this page.

Returns:

Number of results on this page, or null if not applicable.

getTotalPages

public Integer getTotalPages()

Number of results pages.

Returns:

Total number of available pages, or null if not applicable.

getLinks

public HalLinks getLinks()

The _links property in the HAL response.

Returns:

Navigation links wrapped in an object, or null if not applicable.