WebSessionInfoEvent
Properties | Methods | Constants
| Package | qnx.events |
| Class | public class WebSessionInfoEvent |
| Inheritance | WebSessionInfoEvent  flash.events.Event |
A
QNXStageWebView object dispatches a WebSessionInfoEvent object with information
about a Web Session that was asynchronously created with a requestSession call.
There is only one type of WebSessionInfoEvent:
-
WebSessionInfoEvent.WEB_SESSION_INFO: dispatched after arequestSession successfully completes. Cannot be cancelled.
| Class information: |
|---|
| PlayBook Tablet OS Version: 1.0.6 |
See also
Public Properties
| Property | Defined By | ||
|---|---|---|---|
| data : String
The web session data string. | WebSessionInfoEvent | ||
| version : String
The version of the web session string's format, eg. | WebSessionInfoEvent | ||
Public Methods
| Method | Defined By | ||
|---|---|---|---|
WebSessionInfoEvent(type:String, bubbles:Boolean = false, cancelable:Boolean = false, version:String = null, data:String = null)
Creates a WebSessionInfoEvent object. | WebSessionInfoEvent | ||
clone():Event [override]
Duplicates an instance of an Event subclass. | WebSessionInfoEvent | ||
toString():String [override]
Returns a String that contains all the properties of the WebSessionInfoEvent object. | WebSessionInfoEvent | ||
Public Constants
| Constant | Defined By | ||
|---|---|---|---|
| WEB_SESSION_INFO : String = webSessionInfo [static]
Dispatched when a requestSession call has been completed. | WebSessionInfoEvent | ||
Property Detail
data
| data:String |
The web session data string.
Implementation
| public function get data():String |
| public function set data(value:String):void |
version
| version:String |
The version of the web session string's format, eg. "1.0".
Implementation
| public function get version():String |
| public function set version(value:String):void |
Constructor Detail
WebSessionInfoEvent()
| public function WebSessionInfoEvent(type:String, bubbles:Boolean = false, cancelable:Boolean = false, version:String = null, data:String = null) |
Creates a WebSessionInfoEvent object.
Parameters
type:String |
bubbles:Boolean (default = false) |
cancelable:Boolean (default = false) |
version:String (default = null) |
data:String (default = null) |
Method Detail
clone()
| override public function clone():Event |
Duplicates an instance of an Event subclass.
Returns a new Event object that is a copy of the original instance of the Event object.
You do not normally call clone(); the EventDispatcher class calls it automatically
when you redispatch an event—that is, when you call dispatchEvent(event) from a handler
that is handling event.
The new Event object includes all the properties of the original.
When creating your own custom Event class, you must override the
inherited Event.clone() method in order for it to duplicate the
properties of your custom class. If you do not set all the properties that you add
in your event subclass, those properties will not have the correct values when listeners
handle the redispatched event.
Returns
Event |
toString()
| override public function toString():String |
Returns a String that contains all the properties of the WebSessionInfoEvent object.
The String is in the following format:
[WebSessionInfoEvent type=value bubbles=value
cancelable=value eventPhase=value version=value
data=value
Returns
String |
Constant Detail
WEB_SESSION_INFO
| public static const WEB_SESSION_INFO:String = webSessionInfo |
Dispatched when a requestSession call has been completed.
The version property of the event helps in parsing the session data string.
The data property is a string containing all required information about
a web session, and can be used to identify it uniquely in a restoreSession call.