The ININ.IceLib.Directories namespace contains classes for accessing Interaction Center directories.

The namespace is organized around tasks one would typically want to perform, such as:

1. Retrieving and managing the list of directories
2. Retrieving and managing the entries within a specific directory

Retrieving and managing the list of directories

Use the DirectoryConfiguration class to retrieve and manage a list of available directories, and to watch for changes to that list. Calling GetList()()()() or GetEntry(String) on a DirectoryConfiguration instance will retrieve one or more DirectoryMetadata elements, each one representing a specific directory, workgroup, speed dial list, etc. A DirectoryMetadata instance describes everything there is to know about a particular directory. It is also used to create a ContactDirectory which in turn is used to retrieve the entries within the specific directory.

Retrieving and managing the entries within a specific directory

To retrieve a list of entries within a directory, start by determining the DirectoryMetadata that describes the directory you are interested in. Construct a ContactDirectory instance using this metadata, call StartWatching()()()() to start the watch and then call GetList()()()() or GetEntry(String) to return one or more ContactEntry elements. Each returned ContactEntry instance represents a particular entry in the directory.

If you are dealing with large directories, it is advised that you using the paged view interface. The paged view interface requires setting up a ContactDirectoryWatchSettings instance that allows you to set a filter, sort order, start position and number of items to retrieve. The initial paged watched view is established by supplying an instance of ContactDirectoryWatchSettings to StartWatching(ContactDirectoryWatchSettings). Once the watch is established you can page back or forth by making a call to ChangeWatched(ContactDirectoryWatchSettings).

Synchronous Example

The following is an example of synchronously retrieving a list of all available directories and displaying the first and last name of each user in each directory.

Note
Using these classes in a synchronous manner is not recommended for client applications since the main thread will be blocked. It is shown here for a brief example. It is recommended to only use the synchronous methods if it is applicable to your application scenario (e.g. ASP.NET) or your application is making synchronous calls within a background thread.

CopyC#

static void PrintAllDirectories (ININ.IceLib.Connection.Session session)
{
    DirectoriesManager dirManager = DirectoriesManager.GetInstance(session);
    DirectoryConfiguration dirConfig = new DirectoryConfiguration(dirManager);

    dirConfig.StartWatching();
    System.Collections.ObjectModel.ReadOnlyCollection<DirectoryMetadata> metaData = dirConfig.GetList();

    foreach (DirectoryMetadata dirMetadata in metaData)
    {
        System.Console.Out.WriteLine("====== {0} Entries ======", dirMetadata.DisplayName);

        ContactDirectory contactDir = new ContactDirectory(dirManager, dirMetadata);
        contactDir.StartWatching();

        System.Collections.ObjectModel.ReadOnlyCollection<ContactEntry> contactEntries = contactDir.GetList();
        foreach (ContactEntry entry in contactEntries) 
        {
            System.Console.Out.WriteLine("{0}, {1}", entry.LastName, entry.FirstName);
        }
    }
}