This class represents settings for a directory watch that provides a filtered and sorted view of contact entries. This view can be returned in increments or pages at a time.

Namespace: ININ.IceLib.Directories
Assembly: ININ.IceLib.Directories (in ININ.IceLib.Directories.dll) Version: 0.0.0.0 (22.3.0.218)

Syntax

C#
public class ContactDirectoryWatchSettings
Visual Basic
Public Class ContactDirectoryWatchSettings

Remarks

The initial watch is established supplying an instance of this object to StartWatching(ContactDirectoryWatchSettings) or StartWatchingAsync(ContactDirectoryWatchSettings, AsyncCompletedEventHandler, Object). This class represents an immutable object. Once it is created it can not be modified. Convenience methods (Next and Previous for example,) are available to create slightly altered versions of this object that can be used to change the watch via ChangeWatched(ContactDirectoryWatchSettings) or ChangeWatchedAsync(ContactDirectoryWatchSettings, AsyncCompletedEventHandler, Object).

Once the start or change watch is completed, the watched values are available via a call to GetList()()()().

Examples

CopyC#
Collection<ContactFilterItem> filterItems = new Collection<ContactFilterItem>();
Collection<ContactSortItem> sortItems = new Collection<ContactSortItem>();

// Match all entries that are part of Acme Inc, with a last name starting with the letter 'S'.
filterItems.Add( new ContactFilterMatch(ContactProperty.Company, ContactFilterType.Exact, "Acme Inc.") );
filterItems.Add( new ContactFilterMatch(ContactProperty.LastName, ContactFilterType.Prefix, "S") ); 

sortItems.Add( new ContactSortItem(ContactProperty.LastName, ListSortDirection.Ascending) );
sortItems.Add( new ContactSortItem(ContactProperty.FirstName, ListSortDirection.Descending) );

ContactDirectoryWatchSettings watchSettings = new ContactDirectoryWatchSettings(0, 50, filterItems, sortItems);

_ContactDirectory.StartWatchingAsync( watchSettings );

Inheritance Hierarchy

System..::..Object
  ININ.IceLib.Directories..::..ContactDirectoryWatchSettings

Version Information

Supported for IC Server version 2015 R1 and beyond.
For 4.0, supported for IC Server version 4.0 GA and beyond.
For 3.0, supported for IC Server version 3.0 GA and beyond.

See Also