Package com.ringcentral.definitions

Class RSPagingModel

java.lang.Object

com.ringcentral.definitions.RSPagingModel

public class RSPagingModel
extends Object

Field Summary

Fields

Modifier and Type	Field	Description
Long	page	The current page number.
Long	pageEnd	The zero-based index of the last element on the current page.
Long	pageStart	The zero-based number of the first element on the current page.
Long	perPage	Current page size, describes how many items are in each page.
String[]	sortableFields	Required
Long	totalElements	The total number of elements in a dataset.
Long	totalPages	The total number of pages in a dataset.

Constructor Summary

Constructors

Constructor	Description
RSPagingModel()

Method Summary

Modifier and Type	Method	Description
RSPagingModel	page(Long page)
RSPagingModel	pageEnd(Long pageEnd)
RSPagingModel	pageStart(Long pageStart)
RSPagingModel	perPage(Long perPage)
RSPagingModel	sortableFields(String[] sortableFields)
RSPagingModel	totalElements(Long totalElements)
RSPagingModel	totalPages(Long totalPages)

Methods inherited from class java.lang.Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

Field Details

perPage

public Long perPage

Current page size, describes how many items are in each page. Matches "perPage" parameter from the request. Required Maximum: 1000 Minimum: 1 Format: int32 Example: 50

page

public Long page

The current page number. 1-indexed, so the first page is 1 by default. May be omitted if result is empty (because non-existent page was specified or perPage=0 was requested) Required Maximum: 1000 Minimum: 1 Format: int32 Example: 5

pageStart

public Long pageStart

The zero-based number of the first element on the current page. Omitted if the page is omitted or result is empty Required Format: int32

pageEnd

public Long pageEnd

The zero-based index of the last element on the current page. Omitted if the page is omitted or result is empty Required Format: int32 Example: 5

totalPages

public Long totalPages

The total number of pages in a dataset. May be omitted for some resources due to performance reasons Format: int32 Example: 25

totalElements

public Long totalElements

The total number of elements in a dataset. May be omitted for some resource due to performance reasons Required Format: int32 Example: 25

sortableFields

public String[] sortableFields

Required

Constructor Details

RSPagingModel

public RSPagingModel()

Method Details

perPage

public RSPagingModel perPage(Long perPage)

page

public RSPagingModel page(Long page)

pageStart

public RSPagingModel pageStart(Long pageStart)

pageEnd

public RSPagingModel pageEnd(Long pageEnd)

totalPages

public RSPagingModel totalPages(Long totalPages)

totalElements

public RSPagingModel totalElements(Long totalElements)

sortableFields

public RSPagingModel sortableFields(String[] sortableFields)