Package com.ringcentral.definitions

Class MessagingPagingInfo

java.lang.Object

com.ringcentral.definitions.MessagingPagingInfo

public class MessagingPagingInfo
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 are in each page.
Long	totalElements	Total number of elements in a dataset.
Long	totalPages	Total number of pages in a dataset.

Constructor Summary

Constructors

Constructor	Description
MessagingPagingInfo()

Method Summary

Modifier and Type	Method	Description
MessagingPagingInfo	page(Long page)
MessagingPagingInfo	pageEnd(Long pageEnd)
MessagingPagingInfo	pageStart(Long pageStart)
MessagingPagingInfo	perPage(Long perPage)
MessagingPagingInfo	totalElements(Long totalElements)
MessagingPagingInfo	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 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 are in each page. 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 the page is omitted or result is empty Format: int32

pageEnd

public Long pageEnd

Zero-based index of the last element on the current page. Omitted if the page is omitted or 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

MessagingPagingInfo

public MessagingPagingInfo()

Method Details

page

public MessagingPagingInfo page(Long page)

perPage

public MessagingPagingInfo perPage(Long perPage)

pageStart

public MessagingPagingInfo pageStart(Long pageStart)

pageEnd

public MessagingPagingInfo pageEnd(Long pageEnd)

totalPages

public MessagingPagingInfo totalPages(Long totalPages)

totalElements

public MessagingPagingInfo totalElements(Long totalElements)