Assembly: ININ.IceLib.People (in ININ.IceLib.People.dll) Version: 0.0.0.0 (22.3.0.218)
Syntax
C# |
---|
public LookupEntriesDetails GetLookupEntries( IEnumerable<LookupEntryType> directoriesToSearch, IEnumerable<LookupEntryProperty> columnsToMatch, LookupComparisonType comparisonType, string lookupString, int maxEntries ) |
Visual Basic |
---|
Public Function GetLookupEntries ( _ directoriesToSearch As IEnumerable(Of LookupEntryType), _ columnsToMatch As IEnumerable(Of LookupEntryProperty), _ comparisonType As LookupComparisonType, _ lookupString As String, _ maxEntries As Integer _ ) As LookupEntriesDetails |
Parameters
- directoriesToSearch
- Type: System.Collections.Generic..::..IEnumerable<(Of <(<'LookupEntryType>)>)>
The directories to search.
- columnsToMatch
- Type: System.Collections.Generic..::..IEnumerable<(Of <(<'LookupEntryProperty>)>)>
The columns to match with the lookupString, using the specified comparisonType.
- comparisonType
- Type: ININ.IceLib.People..::..LookupComparisonType
The comparison type.
- lookupString
- Type: System..::..String
The lookup string that the server needs to match.
- maxEntries
- Type: System..::..Int32
The maximum number of lookup entries that the application would like to receive.
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); LookupEntryType[] directoriesToSearch = {LookupEntryType.User}; LookupEntryProperty[] columnsToMatch = {LookupEntryProperty.DisplayName, LookupEntryProperty.EntryId}; string lookupString = "John"; LookupEntriesDetails entries = peopleManager.GetLookupEntries(directoriesToSearch, columnsToMatch, LookupComparisonType.StartsWith, lookupString, 50);
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 GA and beyond.
For 3.0, supported for IC Server version 3.0 SU 1 and beyond.