Assembly: ININ.IceLib.People (in ININ.IceLib.People.dll) Version: 0.0.0.0 (22.3.0.218)
Syntax
C# |
---|
public LookupEntriesDetails GetLookupEntries( LookupParameters queryParameters ) |
Visual Basic |
---|
Public Function GetLookupEntries ( _ queryParameters As LookupParameters _ ) As LookupEntriesDetails |
Parameters
- queryParameters
- Type: ININ.IceLib.People..::..LookupParameters
The search criteria.
Return Value
A collection of LookupEntry objects.Remarks
The logged in user must have the appropriate search rights configured in Interaction Administrator for results to be included. These search rights can be found in the Access Control container under the Search column.
When specifying AttendantProfile, attendant profiles can only be included in the lookup results if the logged in user has the sufficient search rights assigned. From within Interaction Administrator, the logged in user must have the search rights for the appropriate Email/Inbound/Operator/Outbound profiles set in the Access Control container. Additionally, the attendant profile must also be setup to be a transfer target from within Interaction Attendant.
Examples
using ININ.IceLib.People; PeopleManager peopleManager = PeopleManager.GetInstance(session); LookupParameters queryParameters = new LookupParameters(); queryParameters.DirectoriesToSearch = new List<LookupEntryType> {LookupEntryType.User}; queryParameters.ColumnsToMatch = new List<LookupEntryProperty> {LookupEntryProperty.DisplayName, LookupEntryProperty.EntryId}; queryParameters.LookupString = "John"; queryParameters.ComparisonType = LookupComparisonType.StartsWith; queryParameters.MaxEntries = 50; queryParameters.IncludeUsersExcludedFromCompanyDirectory = true; LookupEntriesDetails entries = peopleManager.GetLookupEntries(queryParameters);
Exceptions
Exception | Condition |
---|---|
System..::..ArgumentNullException | A parameter is nullNothingnullptra null reference (Nothing in Visual Basic). |
System..::..ArgumentException | A parameter is empty. |
ININ.IceLib.Connection..::..RequestTimeoutException | The request timed out while waiting for a response. |
ININ.IceLib.Connection..::..SessionDisconnectedException | The Session does not have a valid connection. |
System..::..ObjectDisposedException | The Session has been disposed. |
Version Information
For 4.0, supported for IC Server version 4.0 SU 3 and beyond.