Package com.ringcentral.definitions

Class UserContactsPagingInfo

java.lang.Object

com.ringcentral.definitions.UserContactsPagingInfo

public class UserContactsPagingInfo
extends Object

Information on paging

Field Summary

Fields

Modifier and Type	Field	Description
Long	page	Current page number.
Long	pageEnd	Zero-based index of the last element on the current page.
Long	pageStart	Zero-based number of the first element on the current page.
Long	perPage	Current page size, describes how many items each page contains.
Long	totalElements	Total number of elements in a dataset.
Long	totalPages	Total number of pages in a dataset.

Constructor Summary

Constructors

Constructor	Description
UserContactsPagingInfo()

Method Summary

Modifier and Type	Method	Description
UserContactsPagingInfo	page(Long page)
UserContactsPagingInfo	pageEnd(Long pageEnd)
UserContactsPagingInfo	pageStart(Long pageStart)
UserContactsPagingInfo	perPage(Long perPage)
UserContactsPagingInfo	totalElements(Long totalElements)
UserContactsPagingInfo	totalPages(Long totalPages)

Methods inherited from class java.lang.Object

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

Field Details

page

public Long page

Current page number. 1-indexed, so the first page is 1 by default. May be omitted if the result is empty (because non-existent page was specified or perPage=0 was requested) Format: int32

perPage

public Long perPage

Current page size, describes how many items each page contains. Default value is 100. Maximum value is 1000. If perPage value in the request is greater than 1000, the maximum value (1000) is applied Format: int32

pageStart

public Long pageStart

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

pageEnd

public Long pageEnd

Zero-based index of the last element on the current page. Omitted if a page is omitted or the result is empty Format: int32

totalPages

public Long totalPages

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

totalElements

public Long totalElements

Total number of elements in a dataset. May be omitted for some resource due to performance reasons Format: int32

Constructor Details

UserContactsPagingInfo

public UserContactsPagingInfo()

Method Details

page

public UserContactsPagingInfo page(Long page)

perPage

public UserContactsPagingInfo perPage(Long perPage)

pageStart

public UserContactsPagingInfo pageStart(Long pageStart)

pageEnd

public UserContactsPagingInfo pageEnd(Long pageEnd)

totalPages

public UserContactsPagingInfo totalPages(Long totalPages)

totalElements

public UserContactsPagingInfo totalElements(Long totalElements)