Asynchronous request to start watching alert filters.

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 void StartWatchingAsync(
	AlertFilterKey[] keysToAdd,
	AlertListenerFilter filter,
	AsyncCompletedEventHandler completedCallback,
	Object userState
)
Visual Basic
Public Sub StartWatchingAsync ( _
	keysToAdd As AlertFilterKey(), _
	filter As AlertListenerFilter, _
	completedCallback As AsyncCompletedEventHandler, _
	userState As Object _
)

Parameters

keysToAdd
Type: array<ININ.IceLib.Statistics.Alerts..::..AlertFilterKey>[]()[][]
The keys of the alert filters to start watching.
filter
Type: ININ.IceLib.Statistics.Alerts..::..AlertListenerFilter
The filter to apply to the AlertChanged event.
completedCallback
Type: System.ComponentModel..::..AsyncCompletedEventHandler
The callback to invoke when the asynchronous operation completes.
userState
Type: System..::..Object
An optional object that contains state information for this request. This object is a way for the caller to store context information which will be provided to the AsyncCompleted event. If no context information is desired then nullNothingnullptra null reference (Nothing in Visual Basic) may be supplied.

Remarks

Starting an alert listener watch will allow AlertReceived events to trigger when the state of an alert changes, either into or out of alert and for AlertChanged events to trigger when an alert catalog change occurs on an alert we're interested in.

When completed, the completedCallback delegate is invoked on a thread appropriate to the application-model, such as the GUI thread in a UI application. The Error property of the AsyncCompletedEventArgs-derived object passed to the delegate will contain any exceptions thrown while executing the asynchronous task. See the synchronous version of this method for more detailed error information. For more information on async method calls, see How Async Calls Work.

Note
All event handlers should be added before calling StartWatching(array<AlertFilterKey>[]()[][], AlertListenerFilter) or StartWatchingAsync(array<AlertFilterKey>[]()[][], AlertListenerFilter, AsyncCompletedEventHandler, Object).
Note
For more information on watches see How Watches Work.

Exceptions

ExceptionCondition
System..::..ArgumentNullExceptionkeysToAdd is nullNothingnullptra null reference (Nothing in Visual Basic) or contains an element that is nullNothingnullptra null reference (Nothing in Visual Basic).
System..::..ArgumentExceptionkeysToAdd is empty.
System..::..InvalidOperationExceptionThe watch is already watching.
System..::..ArgumentOutOfRangeExceptionfilter has an invalid value.

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