Changes what attributes of the UserSettings are being watch.

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

Syntax

C#
public void ChangeWatchedAttributes(
	string[] attributeNamesToAdd,
	string[] attributeNamesToRemove,
	bool replaceExisting
)
Visual Basic
Public Sub ChangeWatchedAttributes ( _
	attributeNamesToAdd As String(), _
	attributeNamesToRemove As String(), _
	replaceExisting As Boolean _
)

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.

Remarks

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

Derived classes have attribute classes which define the attributeNamesToAdd and attributeNamesToRemove strings each derived class can support. Custom strings may also be used for custom handlers. For a list of derived classes and their associated attribute classes see the StartWatching(array<String>[]()[][]) method.

Note
For more information on watches see How Watches Work.

Exceptions

ExceptionCondition
System..::..ArgumentNullExceptionA parameter is nullNothingnullptra null reference (Nothing in Visual Basic).
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.
System..::..InvalidOperationExceptionThe object is already being watched.

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