Constructor
-
new ContactSearchRequest(searchString, searchField, searchSource, maxResults, maxChunkSize, searchNetworkSource)
-
This class defines the parameters of the contact search request.
Parameters:
Name Type Description searchStringstring String to search for.
searchFieldAvayaClientServices.Services.Contacts.SearchFieldType Field the search should be done against (name, phone number, etc.).
searchSourceAvayaClientServices.Services.Contacts.SearchSourceType Specifies the source the search should be done in (cache, network or both).
maxResultsnumber Max number of results to return in total.
maxChunkSizenumber Number of results to return in each onProgress callback of DataRetrieval.
searchNetworkSourceAvayaClientServices.Services.Contacts.SearchNetworkSource Specifies where to search users (conference only or anywhere).
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 }