Synchronous request to change the watched 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 ChangeWatchedAlerts(
	AlertFilterKey[] keysToAdd,
	AlertFilterKey[] keysToRemove,
	bool replaceExisting,
	AlertListenerFilter filter
)
Visual Basic
Public Sub ChangeWatchedAlerts ( _
	keysToAdd As AlertFilterKey(), _
	keysToRemove As AlertFilterKey(), _
	replaceExisting As Boolean, _
	filter As AlertListenerFilter _
)

Parameters

keysToAdd
Type: array<ININ.IceLib.Statistics.Alerts..::..AlertFilterKey>[]()[][]
The keys of the alert filters to add. (Can be nullNothingnullptra null reference (Nothing in Visual Basic).)
keysToRemove
Type: array<ININ.IceLib.Statistics.Alerts..::..AlertFilterKey>[]()[][]
The keys of the alert filters to remove. (Can be nullNothingnullptra null reference (Nothing in Visual Basic).)
replaceExisting
Type: System..::..Boolean
if set to trueTruetruetrue (True in Visual Basic), replace the existing list.
filter
Type: ININ.IceLib.Statistics.Alerts..::..AlertListenerFilter
The filter to apply to the AlertChanged event.

Remarks

Note
For more information on watches see How Watches Work.

Exceptions

ExceptionCondition
System..::..InvalidOperationExceptionThis AlertListener is not watched.
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