The alert catalog is used to manage AlertSet configurations, retrieving, creating, editing, and deleting them.

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

Syntax

C#
public class AlertCatalog
Visual Basic
Public Class AlertCatalog

Remarks

This class allows you to start, stop, and change watches on on the entire alert catalog or a specified subset of it. StartWatching()()()() and StartWatchingAsync(AsyncCompletedEventHandler, Object) allow for watching the entire alert catalog. StartWatching(AlertSetCategories, IEnumerable<(Of <<'(AlertSet..::..Property>)>>)) and StartWatchingAsync(AlertSetCategories, IEnumerable<(Of <<'(AlertSet..::..Property>)>>), AsyncCompletedEventHandler, Object) allow for watching for specific property changes on alert sets in a given category. StartWatching(IEnumerable<(Of <<'(AlertSet>)>>), IEnumerable<(Of <<'(AlertSet..::..Property>)>>)) and StartWatchingAsync(IEnumerable<(Of <<'(AlertSet>)>>), IEnumerable<(Of <<'(AlertSet..::..Property>)>>), AsyncCompletedEventHandler, Object) allow for watching for specific property changes on the specified alerts. ChangeWatch(AlertSetCategories, IEnumerable<(Of <<'(AlertSet..::..Property>)>>)), ChangeWatchAsync(AlertSetCategories, IEnumerable<(Of <<'(AlertSet..::..Property>)>>), AsyncCompletedEventHandler, Object), ChangeWatch(IEnumerable<(Of <<'(AlertSet>)>>), IEnumerable<(Of <<'(AlertSet..::..Property>)>>)), and ChangeWatchAsync(IEnumerable<(Of <<'(AlertSet>)>>), IEnumerable<(Of <<'(AlertSet..::..Property>)>>), AsyncCompletedEventHandler, Object) allow for modifying existing watches. StopWatching()()()() and StopWatchingAsync(AsyncCompletedEventHandler, Object) allow for stopping the existing watch. AlertCatalogChanged will be triggered when there is a change in one of the watched alert sets and properties. GetWatchedAlertSets()()()(), GetWatchedOwnerDefaultAlertSet()()()(), and GetWatchedSharedAlertSets()()()() can be used to retrieve the list of all alert sets, alert sets in the owner default category, and alert sets in the shared category respectively. GetAlertSet(String) can be used to retrieve a specific alert set. GetAlertDefinitions(StatisticKey, Boolean) will retrieve the alert definitions for a given statistic key. There must be an active watch to retrieve alert sets and definitions.

To create an alert set, first instantiate a new EditableAlertSet, filling it out as needed. Then call either CreateAlertSet(EditableAlertSet) or CreateAlertSetAsync(EditableAlertSet, AsyncCompletedEventHandler, Object) to create the alert set.

To modify an alert set, first retrieve the alert set by starting a watch and calling GetAlertSet(String), GetWatchedAlertSets()()()(), GetWatchedOwnerDefaultAlertSet()()()(), or GetWatchedSharedAlertSets()()()(). Then create an EditableAlertSet out of the AlertSet you wish to modify. Make the changes and call UpdateAlertSet(EditableAlertSet) or UpdateAlertSetAsync(EditableAlertSet, AsyncCompletedEventHandler, Object) to commit the changes.

To remove an alert set, call RemoveAlertSet(String) or RemoveAlertSetAsync(String, AsyncCompletedEventHandler, Object) specifying the alert set ID to remove.

Subscribe(AlertSet, Boolean) and SubscribeAsync(AlertSet, Boolean, AsyncCompletedEventHandler, Object) allow for subscribing and unsubscribing to a specific alert set.

Note
For more information on getting started with statistics see Getting Started With Statistics.
Note
For for the list of available statistics see Statistics Catalog.

Inheritance Hierarchy

System..::..Object
  ININ.IceLib.Statistics.Alerts..::..AlertCatalog

Version Information

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

See Also