Asynchronously changes what attributes of the InteractionQueue are being watched. (See InteractionAttributeName.)

Namespace: ININ.IceLib.Interactions
Assembly: ININ.IceLib.Interactions (in ININ.IceLib.Interactions.dll) Version: 0.0.0.0 (22.1.0.214)

Syntax

C#
public void ChangeWatchedAttributesAsync(
	string[] attributeNamesToAdd,
	string[] attributeNamesToRemove,
	bool replaceExisting,
	AsyncCompletedEventHandler completedCallback,
	Object userState
)
Visual Basic
Public Sub ChangeWatchedAttributesAsync ( _
	attributeNamesToAdd As String(), _
	attributeNamesToRemove As String(), _
	replaceExisting As Boolean, _
	completedCallback As AsyncCompletedEventHandler, _
	userState As Object _
)

Parameters

attributeNamesToAdd
Type: array<System..::..String>[]()[][]
The attribute names to add. (Can be nullNothingnullptra null reference (Nothing in Visual Basic).)
attributeNamesToRemove
Type: array<System..::..String>[]()[][]
The attribute names 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.
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

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
For information about the standard attributes defined by the Interaction Center System, see the "Interaction Attributes Technical Reference" in the Interaction Center Documentation Library. This document describes the attributes and the format of their values.

Note: This method silently ignores attempts to add items already being watched or to remove items not being watched.

Note
Strings for attributeNamesToAdd and attributeNamesToRemove are defined in InteractionAttributeName however custom strings may also be used for custom handlers.
Note
For more information on watches see How Watches Work.

Exceptions

ExceptionCondition
System..::..ArgumentNullExceptionA parameter is nullNothingnullptra null reference (Nothing in Visual Basic).

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