Starts watching the User Status 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 StartWatching( string[] userIds ) |
| Visual Basic |
|---|
Public Sub StartWatching ( _ userIds As String() _ ) |
Parameters
- userIds
- Type: array<System..::..String>[]()[][]
An array of user IDs for watching user status.
Remarks
 Note |
|---|
| All event handlers should be added before calling StartWatching(array<String>[]()[][]) or StartWatchingAsync(array<String>[]()[][], AsyncCompletedEventHandler, Object). |
| Note |
|---|
| Calls to GetList()()()() and GetUserStatus(String) after calling StartWatching(array<String>[]()[][]) should wait until after the first WatchedObjectsChanged event is fired. Otherwise IsInitialized will be false, indicating that the returned status is invalid. |
| Note |
|---|
| For more information on watches see How Watches Work. |
Exceptions
| Exception | Condition |
|---|---|
| System..::..ArgumentNullException | A parameter is nullNothingnullptra null reference (Nothing in Visual Basic). |
| System..::..InvalidOperationException | The object is already being watched. |
| System..::..ArgumentException | The parameter array is 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. |
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.
