Changes the set of user names for a watch of their Filtered Status Message list.
Namespace: ININ.IceLib.PeopleAssembly: ININ.IceLib.People (in ININ.IceLib.People.dll) Version: 0.0.0.0 (22.3.0.218)
Syntax
C# |
---|
public void ChangeWatchedUsers( string[] userIDsToAdd, string[] userIDsToRemove, bool replaceExisting ) |
Visual Basic |
---|
Public Sub ChangeWatchedUsers ( _ userIDsToAdd As String(), _ userIDsToRemove As String(), _ replaceExisting As Boolean _ ) |
Parameters
- userIDsToAdd
- Type: array<System..::..String>[]()[][]
The user IDs to add. (Can be nullNothingnullptra null reference (Nothing in Visual Basic).)
- userIDsToRemove
- Type: array<System..::..String>[]()[][]
The user IDs 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.
Note |
---|
For more information on watches see How Watches Work. |
Exceptions
Exception | Condition |
---|---|
System..::..ArgumentNullException | An item in userIDsToAdd or userIDsToRemove is nullNothingnullptra null reference (Nothing in Visual Basic) or Empty. |
ININ.IceLib.Connection..::..RequestTimeoutException | The request timed out while waiting for a response. |
ININ.IceLib.Connection..::..SessionDisconnectedException | The Session does not have a valid connection. |
System..::..ObjectDisposedException | The Session has been disposed. |
System..::..InvalidOperationException | A watch is not in progress. |
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.
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.