Synchronous 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 StartWatching(
	AlertFilterKey[] keysToAdd,
	AlertListenerFilter filter
)
Visual Basic
Public Sub StartWatching ( _
	keysToAdd As AlertFilterKey(), _
	filter As AlertListenerFilter _
)

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.

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.
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..::..ArgumentOutOfRangeExceptionfilter has an invalid value.
System..::..InvalidOperationExceptionThe watch is already watching.
ININ.IceLib.Connection..::..RequestTimeoutExceptionThe request timed out while waiting for a response.
ININ.IceLib.Connection..::..SessionDisconnectedExceptionThe Session does not have a valid connection.
System..::..ObjectDisposedExceptionThe Session has been disposed.

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