Asynchronously 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 StartWatchingAsync( string[] userIds, AsyncCompletedEventHandler completedCallback, Object userState ) |
Visual Basic |
---|
Public Sub StartWatchingAsync ( _ userIds As String(), _ completedCallback As AsyncCompletedEventHandler, _ userState As Object _ ) |
Parameters
- userIds
- Type: array<System..::..String>[]()[][]
An array of user IDs for watching user status.
- 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 |
---|
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 StartWatchingAsync(array<String>[]()[][], AsyncCompletedEventHandler, Object) 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..::..ArgumentException | The parameter array is empty. |
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.