| Package | com.vmware.usersession |
| Class | public class UserSession |
| Inheritance | UserSession  Object |
| Implements | flash.events.IEventDispatcher |
The current UserSession can be retrieved through the UserSessionService
Note: this class was generated from its Java counterpart UserSession
| Property | Defined By | ||
|---|---|---|---|
| clientId : String
Id used to uniquely identify a client session. | UserSession | ||
| locale : String
Locale for the session. | UserSession | ||
| samlTokenXml : String
The XML value of the SAML Token representing the current user. | UserSession | ||
| serversInfo : Array
List of all the servers in the current session. | UserSession | ||
| userName : String
Name of the user who owns the session. | UserSession | ||
| Method | Defined By | ||
|---|---|---|---|
addEventListener(type:String, listener:Function, useCapture:Boolean = false, priority:int = 0, weakRef:Boolean = false):void | UserSession | ||
dispatchEvent(event:Event):Boolean | UserSession | ||
hasEventListener(type:String):Boolean | UserSession | ||
removeEventListener(type:String, listener:Function, useCapture:Boolean = false):void | UserSession | ||
willTrigger(type:String):Boolean | UserSession | ||
| clientId | property |
clientId:StringId used to uniquely identify a client session.
You can use it for instance to keep track of session specific resources and clean
them up when you are notified of the session ending in your
ClientSessionEndListener. Note that the HttpSession id cannot be used in
place of clientId because the same client session can involve multiple Http sessions.
clientId is only set by the framework when UserSession is accessed in one of two ways:
BaseProxy, as shown in the SDK samples.This property can be used as the source for data binding.
public function get clientId():String public function set clientId(value:String):voidSee also
| locale | property |
locale:StringLocale for the session.
This property can be used as the source for data binding.
public function get locale():String public function set locale(value:String):void| samlTokenXml | property |
samlTokenXml:StringThe XML value of the SAML Token representing the current user. A plug-in can use that information to check the user's authentication if necessary. See the vSphere Single Sign-On documentation.
samlTokenXml can be null if for some reason the UserSession didn't use a proper SSO authentication, but this should not happen in production mode.
This property can be used as the source for data binding.
public function get samlTokenXml():String public function set samlTokenXml(value:String):void| serversInfo | property |
serversInfo:ArrayList of all the servers in the current session.
This property can be used as the source for data binding.
public function get serversInfo():Array public function set serversInfo(value:Array):voidSee also
| userName | property |
userName:StringName of the user who owns the session.
This property can be used as the source for data binding.
public function get userName():String public function set userName(value:String):void| addEventListener | () | method |
public function addEventListener(type:String, listener:Function, useCapture:Boolean = false, priority:int = 0, weakRef:Boolean = false):void
Parameters
type:String | |
listener:Function | |
useCapture:Boolean (default = false) | |
priority:int (default = 0) | |
weakRef:Boolean (default = false) |
| dispatchEvent | () | method |
public function dispatchEvent(event:Event):Boolean
Parameters
event:Event |
Boolean |
| hasEventListener | () | method |
public function hasEventListener(type:String):Boolean
Parameters
type:String |
Boolean |
| removeEventListener | () | method |
public function removeEventListener(type:String, listener:Function, useCapture:Boolean = false):void
Parameters
type:String | |
listener:Function | |
useCapture:Boolean (default = false) |
| willTrigger | () | method |
public function willTrigger(type:String):Boolean
Parameters
type:String |
Boolean |