Package com.ringcentral.definitions

Class ListAutomaticLocationUpdatesUsersParameters

java.lang.Object

com.ringcentral.definitions.ListAutomaticLocationUpdatesUsersParameters

public class ListAutomaticLocationUpdatesUsersParameters
extends Object

Query parameters for operation listAutomaticLocationUpdatesUsers

Field Summary

Fields

Modifier and Type	Field	Description
String[]	department	Department name to filter the users.
Boolean	featureEnabled	Filters entries by their status of Automatic Location Updates feature
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 containing the specified substring in user name, extension or department.
String[]	siteId	Internal identifier of a site for filtering.
String[]	type	Extension type.

Constructor Summary

Constructors

Constructor	Description
ListAutomaticLocationUpdatesUsersParameters()

Method Summary

Modifier and Type	Method	Description
ListAutomaticLocationUpdatesUsersParameters	department(String[] department)
ListAutomaticLocationUpdatesUsersParameters	featureEnabled(Boolean featureEnabled)
ListAutomaticLocationUpdatesUsersParameters	orderBy(String orderBy)
ListAutomaticLocationUpdatesUsersParameters	page(Long page)
ListAutomaticLocationUpdatesUsersParameters	perPage(Long perPage)
ListAutomaticLocationUpdatesUsersParameters	searchString(String searchString)
ListAutomaticLocationUpdatesUsersParameters	siteId(String[] siteId)
ListAutomaticLocationUpdatesUsersParameters	type(String[] type)

Methods inherited from class java.lang.Object

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

Field Details

type

public String[] type

Extension type. Multiple values are supported Enum: User, Limited

searchString

public String searchString

Filters entries containing the specified substring in user name, extension or department. The characters range is 0-64; not case-sensitive. If empty then the filter is ignored

department

public String[] department

Department name to filter the users. The value range is 0-64; not case-sensitive. If not specified then the parameter is ignored. Multiple values are supported

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

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

ListAutomaticLocationUpdatesUsersParameters

public ListAutomaticLocationUpdatesUsersParameters()

Method Details

type

public ListAutomaticLocationUpdatesUsersParameters type(String[] type)

searchString

public ListAutomaticLocationUpdatesUsersParameters searchString(String searchString)

department

public ListAutomaticLocationUpdatesUsersParameters department(String[] department)

siteId

public ListAutomaticLocationUpdatesUsersParameters siteId(String[] siteId)

featureEnabled

public ListAutomaticLocationUpdatesUsersParameters featureEnabled(Boolean featureEnabled)

orderBy

public ListAutomaticLocationUpdatesUsersParameters orderBy(String orderBy)

perPage

public ListAutomaticLocationUpdatesUsersParameters perPage(Long perPage)

page

public ListAutomaticLocationUpdatesUsersParameters page(Long page)