Package com.ringcentral.definitions

Class ListContactsParameters

java.lang.Object

com.ringcentral.definitions.ListContactsParameters

public class ListContactsParameters
extends Object

Query parameters for operation listContacts

Field Summary

Fields

Modifier and Type	Field	Description
Long	page	The result set page number (1-indexed) to return Maximum: 1000 Minimum: 1 Format: int32 Example: 1 Default: 1
Long	perPage	The number of items per page.
String[]	phoneNumber	Phone number in e.164 format
String[]	sortBy	Sorts results by the specified property Enum: FirstName, LastName, Company
String	startsWith	If specified, only contacts which 'First name' or 'Last name' start with the mentioned substring will be returned.

Constructor Summary

Constructors

Constructor	Description
ListContactsParameters()

Method Summary

Modifier and Type	Method	Description
ListContactsParameters	page(Long page)
ListContactsParameters	perPage(Long perPage)
ListContactsParameters	phoneNumber(String[] phoneNumber)
ListContactsParameters	sortBy(String[] sortBy)
ListContactsParameters	startsWith(String startsWith)

Methods inherited from class java.lang.Object

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

Field Details

startsWith

public String startsWith

If specified, only contacts which 'First name' or 'Last name' start with the mentioned substring will be returned. Case-insensitive

sortBy

public String[] sortBy

Sorts results by the specified property Enum: FirstName, LastName, Company

page

public Long page

The result set page number (1-indexed) to return Maximum: 1000 Minimum: 1 Format: int32 Example: 1 Default: 1

perPage

public Long perPage

The number of items per page. If provided value in the request is greater than a maximum, the maximum value is applied Maximum: 1000 Minimum: 1 Format: int32 Example: 100 Default: 100

phoneNumber

public String[] phoneNumber

Phone number in e.164 format

Constructor Details

ListContactsParameters

public ListContactsParameters()

Method Details

startsWith

public ListContactsParameters startsWith(String startsWith)

sortBy

public ListContactsParameters sortBy(String[] sortBy)

page

public ListContactsParameters page(Long page)

perPage

public ListContactsParameters perPage(Long perPage)

phoneNumber

public ListContactsParameters phoneNumber(String[] phoneNumber)