Package com.ringcentral.definitions

Class ListDevicesAutomaticLocationUpdatesParameters

java.lang.Object

com.ringcentral.definitions.ListDevicesAutomaticLocationUpdatesParameters

public class ListDevicesAutomaticLocationUpdatesParameters
extends Object

Query parameters for operation listDevicesAutomaticLocationUpdates

Field Summary

Fields

Modifier and Type	Field	Description
Boolean	compatibleOnly	Filters devices which support HELD protocol
Boolean	featureEnabled	Filters entries by their status of Automatic Location Updates feature
String	modelId	Internal identifier of a device model for filtering.
String	orderBy	Comma-separated list of fields to order results prefixed by plus sign '+' (ascending order) or minus sign '-' (descending order).
Long	page	Indicates a page number to retrieve.
Long	perPage	Indicates a page size (number of items).
String	searchString	Filters entries which have device name or model name containing the mentioned substring.
String[]	siteId	Internal identifier of a site for filtering.

Constructor Summary

Constructors

Constructor	Description
ListDevicesAutomaticLocationUpdatesParameters()

Method Summary

Modifier and Type	Method	Description
ListDevicesAutomaticLocationUpdatesParameters	compatibleOnly(Boolean compatibleOnly)
ListDevicesAutomaticLocationUpdatesParameters	featureEnabled(Boolean featureEnabled)
ListDevicesAutomaticLocationUpdatesParameters	modelId(String modelId)
ListDevicesAutomaticLocationUpdatesParameters	orderBy(String orderBy)
ListDevicesAutomaticLocationUpdatesParameters	page(Long page)
ListDevicesAutomaticLocationUpdatesParameters	perPage(Long perPage)
ListDevicesAutomaticLocationUpdatesParameters	searchString(String searchString)
ListDevicesAutomaticLocationUpdatesParameters	siteId(String[] siteId)

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.

featureEnabled

public Boolean featureEnabled

Filters entries by their status of Automatic Location Updates feature

modelId

public String modelId

Internal identifier of a device model for filtering. Multiple values are supported

compatibleOnly

public Boolean compatibleOnly

Filters devices which support HELD protocol

searchString

public String searchString

Filters entries which have device name or model name containing the mentioned substring. The value should be split by spaces; the range is 0 - 64 characters, not case-sensitive. If empty the filter is ignored

orderBy

public String orderBy

Comma-separated list of fields to order results prefixed by plus sign '+' (ascending order) or minus sign '-' (descending order). Supported values: 'name', 'modelName', 'siteName', 'featureEnabled'. The default sorting is by `name`

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

page

public Long page

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

Constructor Details

ListDevicesAutomaticLocationUpdatesParameters

public ListDevicesAutomaticLocationUpdatesParameters()

Method Details

siteId

public ListDevicesAutomaticLocationUpdatesParameters siteId(String[] siteId)

featureEnabled

public ListDevicesAutomaticLocationUpdatesParameters featureEnabled(Boolean featureEnabled)

modelId

public ListDevicesAutomaticLocationUpdatesParameters modelId(String modelId)

compatibleOnly

public ListDevicesAutomaticLocationUpdatesParameters compatibleOnly(Boolean compatibleOnly)

searchString

public ListDevicesAutomaticLocationUpdatesParameters searchString(String searchString)

orderBy

public ListDevicesAutomaticLocationUpdatesParameters orderBy(String orderBy)

perPage

public ListDevicesAutomaticLocationUpdatesParameters perPage(Long perPage)

page

public ListDevicesAutomaticLocationUpdatesParameters page(Long page)