Represents a watched list of (StatusMessageDetails) available for a set of users.

Namespace: ININ.IceLib.People
Assembly: ININ.IceLib.People (in ININ.IceLib.People.dll) Version: 0.0.0.0 (21.4.0.172)

Syntax

C#
public class FilteredStatusMessageList
Visual Basic
Public Class FilteredStatusMessageList

Remarks

The list of status messages that is available to a user is filtered by the available status messages for the workgroups to which the user belongs. To start watching the list of status messages available to a set of users, call the StartWatching(array<String>[]()[][]) or StartWatchingAsync(array<String>[]()[][], AsyncCompletedEventHandler, Object) methods, providing an array of user names that you want to watch. The completedCallback delegate is invoked when the asynchronous start watch operation completes. To stop watching, call the StopWatching()()()() or StopWatchingAsync(AsyncCompletedEventHandler, Object) methods. The completedCallback delegate is invoked when the asynchronous stop watch operation completes. To change the set of users you wish to watch, call ChangeWatchedUsers(array<String>[]()[][], array<String>[]()[][], Boolean) or ChangeWatchedUsersAsync(array<String>[]()[][], array<String>[]()[][], Boolean, AsyncCompletedEventHandler, Object) methods providing the new set of users you wish to watch. This replaces the former set of users with a new set of users to watch. The completedCallback delegate is invoked when the asynchronous change watch operation completes.

Once a watch is in place, any changes to the status message list trigger the WatchedObjectsChanged event. You can access the list of status messages by calling GetList()()()(). Calling GetList()()()() if a watch is not in progress raises the InvalidOperationException. Calling StartWatching(array<String>[]()[][]),StartWatchingAsync(array<String>[]()[][], AsyncCompletedEventHandler, Object), ChangeWatchedUsers(array<String>[]()[][], array<String>[]()[][], Boolean), or ChangeWatchedUsersAsync(array<String>[]()[][], array<String>[]()[][], Boolean, AsyncCompletedEventHandler, Object) when a watch is already in place for a given user, or calling StopWatching()()()() or StopWatchingAsync(AsyncCompletedEventHandler, Object) when a watch is not in place also raises the InvalidOperationException.

Note
The asynchronous methods are preferred since the start, change, and stop watch can be lengthy operations.

There are two classes in IceLib for watching status messages. The StatusMessageList class allows you to watch the list of all status messages defined in IC that the session user has the rights to view. The FilteredStatusMessageList class allows you to watch the status messages that are available for a particular IC user. The list of available status messages for a user can vary based on workgroup membership, role, and user settings in Interaction Administrator.

Inheritance Hierarchy

System..::..Object
  ININ.IceLib.People..::..FilteredStatusMessageList

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