Gets the status for a User from the server.
Namespace: ININ.IceLib.PeopleAssembly: ININ.IceLib.People (in ININ.IceLib.People.dll) Version: 0.0.0.0 (22.3.0.218)
Syntax
C# |
---|
public UserStatus GetUserStatus( string userId ) |
Visual Basic |
---|
Public Function GetUserStatus ( _ userId As String _ ) As UserStatus |
Parameters
- userId
- Type: System..::..String
The user ID.
Return Value
The UserStatus.Remarks
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.
Note |
---|
This method can be particularly inefficient if neither a UserStatusList watch nor a StatusMessageList watch is active since both the UserStatus and its StatusMessageDetails must be queried from the server. If neither of these watches is active, please consider maintaining a StatusMessageList watch. |
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.
Exceptions
Exception | Condition |
---|---|
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.