Class: ContactSearchRequest

Constructor

new ContactSearchRequest(searchString, searchField, searchSource, maxResults, maxChunkSize, searchNetworkSource)

This class defines the parameters of the contact search request.

Parameters:
Name Type Description
searchString string

String to search for.

searchField AvayaClientServices.Services.Contacts.SearchFieldType

Field the search should be done against (name, phone number, etc.).

searchSource AvayaClientServices.Services.Contacts.SearchSourceType

Specifies the source the search should be done in (cache, network or both).

maxResults number

Max number of results to return in total.

maxChunkSize number

Number of results to return in each onProgress callback of DataRetrieval.

searchNetworkSource AvayaClientServices.Services.Contacts.SearchNetworkSource

Specifies where to search users (conference only or anywhere).

See:

Methods

getMaxChunkSize() → {number}

Returns the number of results to be returned in each onProgress callback of DataRetrieval returned by Contacts.searchContacts().

Returns:
{ number }

getMaxResults() → {number}

Returns the max number of results to be returned by the search.

Returns:
{ number }

getSearchField() → {AvayaClientServices.Services.Contacts.SearchFieldType}

Returns the field the search should be done against.

Returns:

getSearchNetworkSource() → {AvayaClientServices.Services.Contacts.SearchNetworkSource}

Returns the contact source the search should be done in.

Returns:

getSearchSource() → {AvayaClientServices.Services.Contacts.SearchSourceType}

Returns the contact source the search should be done in.

Returns:

getSearchString() → {string}

Returns the search string.

Returns:
{ string }

getUniqueSearchId() → {string}

Returns the unique ID of this search request. It is generated when creating a request.

Returns:
{ string }
©2016 Avaya Inc. All Rights Reserved.