Package com.ringcentral.definitions

Class Grouping

java.lang.Object

com.ringcentral.definitions.Grouping

public class Grouping
extends Object

This grouping allows to specify the `groupByMembers` option. The response data will be grouped by users and will only include users that belong to the scope selected in `groupByMembers` field

Field Summary

Fields

Modifier and Type	Field	Description
String	groupBy	The selected grouping option Required Enum: Company, CompanyNumbers, Users, Queues, IVRs, SharedLines, UserGroups, Sites, Departments
String	groupByMembers	The selected data scope Required Enum: Department, UserGroup, Queue, Site
String[]	keys	This field can be used to further limit the users selection by specifying unique identifiers of corresponding entities.

Constructor Summary

Constructors

Constructor	Description
Grouping()

Method Summary

Modifier and Type	Method	Description
Grouping	groupBy(String groupBy)
Grouping	groupByMembers(String groupByMembers)
Grouping	keys(String[] keys)

Methods inherited from class java.lang.Object

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

Field Details

groupBy

public String groupBy

The selected grouping option Required Enum: Company, CompanyNumbers, Users, Queues, IVRs, SharedLines, UserGroups, Sites, Departments

keys

public String[] keys

This field can be used to further limit the users selection by specifying unique identifiers of corresponding entities. For example, providing unique queue ids along with `Queue` in `groupByMembers` field will limit the response to users that are queue agents in at least one of these queues

groupByMembers

public String groupByMembers

The selected data scope Required Enum: Department, UserGroup, Queue, Site

Constructor Details

Grouping

public Grouping()

Method Details

groupBy

public Grouping groupBy(String groupBy)

keys

public Grouping keys(String[] keys)

groupByMembers

public Grouping groupByMembers(String groupByMembers)