Represents a watched list of status messages. Use StatusMessageDetails to get the details of a status message watched object.

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 StatusMessageList
Visual Basic
Public Class StatusMessageList

Remarks

The list of status messages can be modified in Interaction Administrator. To start watching the list of status messages, call the StartWatching()()()() or StartWatchingAsync(AsyncCompletedEventHandler, Object) methods. 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.

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()()()() or StartWatchingAsync(AsyncCompletedEventHandler, Object) when a watch is already in place, 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..::..StatusMessageList

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