Package com.ringcentral.definitions

Class ListEmergencyLocationsParameters

java.lang.Object

com.ringcentral.definitions.ListEmergencyLocationsParameters

public class ListEmergencyLocationsParameters
extends Object

Query parameters for operation listEmergencyLocations

Field Summary

Fields

Modifier and Type	Field	Description
String	addressStatus	Enum: Valid, Invalid, Provisioning
String	domesticCountryId
String	orderBy	Comma-separated list of fields to order results, prefixed by plus sign '+' (ascending order) or minus sign '-' (descending order) Default: +address Enum: +name, +siteName, +address, +addressStatus, +usageStatus, -name, -siteName, -address, -addressStatus, -usageStatus
Long	page	Indicates the page number to retrieve.
Long	perPage	Indicates a page size (number of items).
String	searchString	Filters entries containing the specified substring in 'address' and 'name' fields.
String[]	siteId	Internal identifier of a site for filtering.
String	usageStatus	Enum: Active, Inactive

Constructor Summary

Constructors

Constructor	Description
ListEmergencyLocationsParameters()

Method Summary

Modifier and Type	Method	Description
ListEmergencyLocationsParameters	addressStatus(String addressStatus)
ListEmergencyLocationsParameters	domesticCountryId(String domesticCountryId)
ListEmergencyLocationsParameters	orderBy(String orderBy)
ListEmergencyLocationsParameters	page(Long page)
ListEmergencyLocationsParameters	perPage(Long perPage)
ListEmergencyLocationsParameters	searchString(String searchString)
ListEmergencyLocationsParameters	siteId(String[] siteId)
ListEmergencyLocationsParameters	usageStatus(String usageStatus)

Methods inherited from class java.lang.Object

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

Field Details

siteId

public String[] siteId

Internal identifier of a site for filtering. To indicate company main site `main-site` value should be specified. Supported only if multi-site feature is enabled for the account. Multiple values are supported.

searchString

public String searchString

Filters entries containing the specified substring in 'address' and 'name' fields. The character range is 0-64; not case-sensitive. If empty then the filter is ignored

addressStatus

public String addressStatus

Enum: Valid, Invalid, Provisioning

usageStatus

public String usageStatus

Enum: Active, Inactive

domesticCountryId

public String domesticCountryId

orderBy

public String orderBy

Comma-separated list of fields to order results, prefixed by plus sign '+' (ascending order) or minus sign '-' (descending order) Default: +address Enum: +name, +siteName, +address, +addressStatus, +usageStatus, -name, -siteName, -address, -addressStatus, -usageStatus

perPage

public Long perPage

Indicates a page size (number of items). The values supported: `Max` or numeric value. If not specified, 100 records are returned per one page Format: int32 Default: 100

page

public Long page

Indicates the page number to retrieve. Only positive number values are supported Format: int32 Default: 1

Constructor Details

ListEmergencyLocationsParameters

public ListEmergencyLocationsParameters()

Method Details

siteId

public ListEmergencyLocationsParameters siteId(String[] siteId)

searchString

public ListEmergencyLocationsParameters searchString(String searchString)

addressStatus

public ListEmergencyLocationsParameters addressStatus(String addressStatus)

usageStatus

public ListEmergencyLocationsParameters usageStatus(String usageStatus)

domesticCountryId

public ListEmergencyLocationsParameters domesticCountryId(String domesticCountryId)

orderBy

public ListEmergencyLocationsParameters orderBy(String orderBy)

perPage

public ListEmergencyLocationsParameters perPage(Long perPage)

page

public ListEmergencyLocationsParameters page(Long page)