Package com.ringcentral.definitions

Class SearchDirectoryEntriesParameters

java.lang.Object

com.ringcentral.definitions.SearchDirectoryEntriesParameters

public class SearchDirectoryEntriesParameters
extends Object

Query parameters for operation searchDirectoryEntries

Field Summary

Fields

Modifier and Type	Field	Description
Boolean	accessibleSitesOnly	Allows to make lookups across a whole directory skipping a filtering logic of Cross-Site access management feature.
String[]	accountId	A list of Account IDs.
String	department	Department name.
String[]	extensionStatus	List of extension current statuses.
String[]	extensionType	Types of extension to filter the contacts Enum: User, Department, Announcement, Voicemail, DigitalUser, VirtualUser, FaxUser, PagingOnly, SharedLinesGroup, IvrMenu, ApplicationExtension, ParkLocation, Limited, Bot, Site, Room, ProxyAdmin, DelegatedLinesGroup, FlexibleUser, GroupCallPickup, RoomConnector
String[]	siteId	A list of Site IDs.

Constructor Summary

Constructors

Constructor	Description
SearchDirectoryEntriesParameters()

Method Summary

Modifier and Type	Method	Description
SearchDirectoryEntriesParameters	accessibleSitesOnly(Boolean accessibleSitesOnly)
SearchDirectoryEntriesParameters	accountId(String[] accountId)
SearchDirectoryEntriesParameters	department(String department)
SearchDirectoryEntriesParameters	extensionStatus(String[] extensionStatus)
SearchDirectoryEntriesParameters	extensionType(String[] extensionType)
SearchDirectoryEntriesParameters	siteId(String[] siteId)

Methods inherited from class java.lang.Object

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

Field Details

accessibleSitesOnly

public Boolean accessibleSitesOnly

Allows to make lookups across a whole directory skipping a filtering logic of Cross-Site access management feature. Default: true

accountId

public String[] accountId

A list of Account IDs. Deprecated, use the appropriate body field 'accountIds' instead.

department

public String department

Department name. Deprecated, use the appropriate body field 'department' instead. Example: North office

siteId

public String[] siteId

A list of Site IDs. Deprecated, use the appropriate body field 'siteIds' instead.

extensionStatus

public String[] extensionStatus

List of extension current statuses. Deprecated, use the appropriate body field 'extensionStatuses' instead.

extensionType

public String[] extensionType

Types of extension to filter the contacts Enum: User, Department, Announcement, Voicemail, DigitalUser, VirtualUser, FaxUser, PagingOnly, SharedLinesGroup, IvrMenu, ApplicationExtension, ParkLocation, Limited, Bot, Site, Room, ProxyAdmin, DelegatedLinesGroup, FlexibleUser, GroupCallPickup, RoomConnector

Constructor Details

SearchDirectoryEntriesParameters

public SearchDirectoryEntriesParameters()

Method Details

accessibleSitesOnly

public SearchDirectoryEntriesParameters accessibleSitesOnly(Boolean accessibleSitesOnly)

accountId

public SearchDirectoryEntriesParameters accountId(String[] accountId)

department

public SearchDirectoryEntriesParameters department(String department)

siteId

public SearchDirectoryEntriesParameters siteId(String[] siteId)

extensionStatus

public SearchDirectoryEntriesParameters extensionStatus(String[] extensionStatus)

extensionType

public SearchDirectoryEntriesParameters extensionType(String[] extensionType)