Package com.ringcentral.definitions

Class ListLocationsParameters

java.lang.Object

com.ringcentral.definitions.ListLocationsParameters

public class ListLocationsParameters
extends Object

Query parameters for operation listLocations

Field Summary

Fields

Modifier and Type	Field	Description
String	orderBy	Sorts results by the property specified Default: City Enum: Npa, City
Long	page	Indicates a page number to retrieve.
Long	perPage	Indicates a page size (number of items) Format: int32 Default: 100
String	stateId	Internal identifier of a state
Boolean	withNxx	Specifies if `nxx` codes are returned

Constructor Summary

Constructors

Constructor	Description
ListLocationsParameters()

Method Summary

Modifier and Type	Method	Description
ListLocationsParameters	orderBy(String orderBy)
ListLocationsParameters	page(Long page)
ListLocationsParameters	perPage(Long perPage)
ListLocationsParameters	stateId(String stateId)
ListLocationsParameters	withNxx(Boolean withNxx)

Methods inherited from class java.lang.Object

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

Field Details

orderBy

public String orderBy

Sorts results by the property specified Default: City Enum: Npa, City

page

public Long page

Indicates a page number to retrieve. Only positive number values are accepted Format: int32 Default: 1

perPage

public Long perPage

Indicates a page size (number of items) Format: int32 Default: 100

stateId

public String stateId

Internal identifier of a state

withNxx

public Boolean withNxx

Specifies if `nxx` codes are returned

Constructor Details

ListLocationsParameters

public ListLocationsParameters()

Method Details

orderBy

public ListLocationsParameters orderBy(String orderBy)

page

public ListLocationsParameters page(Long page)

perPage

public ListLocationsParameters perPage(Long perPage)

stateId

public ListLocationsParameters stateId(String stateId)

withNxx

public ListLocationsParameters withNxx(Boolean withNxx)