Package com.ringcentral.definitions

Class ListDirectoryEntriesParameters

java.lang.Object

com.ringcentral.definitions.ListDirectoryEntriesParameters

public class ListDirectoryEntriesParameters
extends Object

Query parameters for operation listDirectoryEntries

Field Summary

Fields

Modifier and Type	Field	Description
Long	page	Page number Format: int32 Default: 1
String	perPage	Records count to be returned per one page.
Boolean	showFederated	If `true` then contacts of all accounts in federation are returned.
String	siteId	Internal identifier of the business site to which extensions belong
String	type	Type of an extension.
String	typeGroup	Type of extension group Enum: User, NonUser

Constructor Summary

Constructors

Constructor	Description
ListDirectoryEntriesParameters()

Method Summary

Modifier and Type	Method	Description
ListDirectoryEntriesParameters	page(Long page)
ListDirectoryEntriesParameters	perPage(String perPage)
ListDirectoryEntriesParameters	showFederated(Boolean showFederated)
ListDirectoryEntriesParameters	siteId(String siteId)
ListDirectoryEntriesParameters	type(String type)
ListDirectoryEntriesParameters	typeGroup(String typeGroup)

Methods inherited from class java.lang.Object

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

Field Details

showFederated

public Boolean showFederated

If `true` then contacts of all accounts in federation are returned. If `false` then only contacts of the current account are returned, and account section is eliminated in this case Default: true

type

public String type

Type of an extension. Please note that legacy 'Department' extension type corresponds to 'Call Queue' extensions in modern RingCentral product terminology Enum: User, Department, Announcement, Voicemail, SharedLinesGroup, PagingOnly, IvrMenu, ParkLocation, Limited, External

typeGroup

public String typeGroup

Type of extension group Enum: User, NonUser

page

public Long page

Page number Format: int32 Default: 1

perPage

public String perPage

Records count to be returned per one page. It can be either integer or string with the specific keyword values: - `all` - all records are returned in one page - `max` - maximum count of records that can be returned in one page Maximum: 2000 Format: int32 Default: 1000 Enum: max, all

siteId

public String siteId

Internal identifier of the business site to which extensions belong

Constructor Details

ListDirectoryEntriesParameters

public ListDirectoryEntriesParameters()

Method Details

showFederated

public ListDirectoryEntriesParameters showFederated(Boolean showFederated)

type

public ListDirectoryEntriesParameters type(String type)

typeGroup

public ListDirectoryEntriesParameters typeGroup(String typeGroup)

page

public ListDirectoryEntriesParameters page(Long page)

perPage

public ListDirectoryEntriesParameters perPage(String perPage)

siteId

public ListDirectoryEntriesParameters siteId(String siteId)