MicroStrategy ONE
UserConnection
The UserConnection interface represents a single user connection. This object contains details about the single user connection. A user connection can be uniquely identified by a combination of the session ID and the project to which it is connected. There can be multiple connections to multiple projects that have the same session ID.
In the current implementation, if either the browse or detail flag is set for database connections, all of the information on the interface is populated.
The following methods are exposed on the UserConnection interface:
Method Name | Return Type | Description |
---|---|---|
getUserName |
string |
Returns the full name of the owner of the connection |
getProjectName |
string |
Returns the name of the project to which the user is connected |
getOpenJobs |
int |
Returns the number of open jobs on the session |
getClientType |
int |
Returns the type of the client, from EnumDSSXMLClientType |
getConnectionTime |
string |
Returns the time that the user connection was made |
getFirstJobTime |
string |
Returns the time the first job was submitted |
getLastJobTime |
string |
Returns the time the last job was submitted |
getDuration |
int |
Returns the duration of the connection, in seconds |
getProjectID |
int |
Returns the project ID of the project to which the user is connected |
getProjectDSSID |
string |
Returns the DSSID of the project to which the user is connected |
getSessionID |
string |
Returns the session ID of the connection. One session ID can have multiple connection. |
getClientID |
string |
Returns the client ID (that is, the client machine) |
getClientPort |
int |
Returns the port of the user machine |
getServerName |
string |
Returns the name of the server to which the connection exists |