This object manages a watched list of DirectoryMetadata objects. The DirectoryMetadata is required by a ContactDirectory instance in order to get a list of contact entries (ContactEntry). In addition, an instance of this object provides support for updating directory configuration for tasks like creating, modifying and deleting directory entries.

Getting a list of watched objects

A watched object is maintained internally within a cache. The cache is constructed so that only one instance of a DirectoryMetadata object is shared between other instances of a DirectoryConfiguration object.

This object contains synchronous as well as asynchronous counterpart methods for any method that could potentially block a thread by running a lengthy operation. Synchronous methods block the thread that they are performed on. Asynchronous methods will not block. When an asynchronous method completes, an event is raised on a thread appropriate to the application-model, such as the GUI thread in a UI application. By convention, synchronous calls are invoked by a method, such as DoSomething(). Their asynchronous counterparts are invoked via DoSomethingAsync() with the result returned in a DoSomethingCompleted event.

A start watch, via a call to StartWatching()()()() or StartWatchingAsync(AsyncCompletedEventHandler, Object) is required to obtain the available directories. Once the start watch has successfully completed, call GetList()()()() to obtain the available directories.

Change notifications to metadata can be subscribed to via the DirectoryConfigurationChanged event handler. Change events are not raised on a thread appropriate to the application mode, such as the GUI thread in a UI application.

A watch can be stopped via a call to StopWatching()()()() or StopWatchingAsync(AsyncCompletedEventHandler, Object).

Directory updates

Speed dial directories can be created, renamed and deleted with the following synchronous and asynchronous methods.

• CreateSpeedDialDirectory(String, DirectoryMetadataAccessRights) or CreateSpeedDialDirectoryAsync(String, DirectoryMetadataAccessRights, EventHandler<(Of <<'(CreateDirectoryCompletedEventArgs>)>>), Object)
• RenameDirectory(DirectoryMetadata, String) or RenameDirectoryAsync(DirectoryMetadata, String, AsyncCompletedEventHandler, Object)
• DeleteDirectory(DirectoryMetadata) or DeleteDirectoryAsync(DirectoryMetadata, AsyncCompletedEventHandler, Object)