Asynchronously gets the status for a User from the server.

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 GetUserStatusAsync(
	string userId,
	EventHandler<GetUserStatusCompletedEventArgs> completedCallback,
	Object userState
)
Visual Basic
Public Sub GetUserStatusAsync ( _
	userId As String, _
	completedCallback As EventHandler(Of GetUserStatusCompletedEventArgs), _
	userState As Object _
)

Parameters

userId
Type: System..::..String
The user ID.
completedCallback
Type: System..::..EventHandler<(Of <(<'GetUserStatusCompletedEventArgs>)>)>
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.

This method will return the value from the cache, if the user's status is cached. If the user's status is not being cached, it will send a request to the server and get the status.

If StartWatching(array<String>[]()[][]) was recently called but has not finished updating the cache, the result's IsInitialized property will be false, indicating the returned value is invalid.

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