ActionScript® 3.0 Reference for the Adobe® Flash® Platform
Home  |  Show Packages and Classes List |  Packages  |  Classes  |  What's New  |  Index  |  Appendixes
com.adobe.mosaic.om.events 

OpenSessionEvent  - AS3 ADEP Composite Application
Packagecom.adobe.mosaic.om.events
Classpublic class OpenSessionEvent
InheritanceOpenSessionEvent Inheritance BaseEvent Inheritance Event Inheritance Object

Language Version: ActionScript 3.0
Product Version: Adobe Digital Enterprise Platform Experience Services - Composite Application Framework 10
Runtime Versions: AIR 2.6, Flash Player 10.2

The OpenSessionEvent class defines a transient notification of opening an ISession.


Public Properties
 PropertyDefined By
 Inheritedbubbles : Boolean
[read-only] Indicates whether an event is a bubbling event.
Event
 Inheritedcancelable : Boolean
[read-only] Indicates whether the behavior associated with the event can be prevented.
Event
 Inheritedconstructor : Object
A reference to the class object or constructor function for a given object instance.
Object
 InheritedcurrentTarget : Object
[read-only] The object that is actively processing the Event object with an event listener.
Event
 InheritedeventPhase : uint
[read-only] The current phase in the event flow.
Event
 Inheritedmessage : String
[read-only] Returns a message string.
BaseEvent
  NAMESPACE : String
[static] [read-only] The namespace for messages of this type.
OpenSessionEvent
 Inheritedobject : *
[read-only] Returns the node that was added.
BaseEvent
  session : ISession
[read-only] The ISession that was opened if successful.
OpenSessionEvent
 Inheritedtarget : Object
[read-only] The event target.
Event
 Inheritedtype : String
[read-only] The type of event.
Event
Public Methods
 MethodDefined By
  
OpenSessionEvent(type:String, sess:ISession = null, msg:String = null)
Constructor.
OpenSessionEvent
 Inherited
clone():Event
Duplicates an instance of an Event subclass.
Event
 Inherited
formatToString(className:String, ... arguments):String
A utility function for implementing the toString() method in custom ActionScript 3.0 Event classes.
Event
 Inherited
hasOwnProperty(name:String):Boolean
Indicates whether an object has a specified property defined.
Object
 Inherited
isDefaultPrevented():Boolean
Checks whether the preventDefault() method has been called on the event.
Event
 Inherited
isPrototypeOf(theClass:Object):Boolean
Indicates whether an instance of the Object class is in the prototype chain of the object specified as the parameter.
Object
 Inherited
preventDefault():void
Cancels an event's default behavior if that behavior can be canceled.
Event
 Inherited
propertyIsEnumerable(name:String):Boolean
Indicates whether the specified property exists and is enumerable.
Object
 Inherited
setPropertyIsEnumerable(name:String, isEnum:Boolean = true):void
Sets the availability of a dynamic property for loop operations.
Object
 Inherited
stopImmediatePropagation():void
Prevents processing of any event listeners in the current node and any subsequent nodes in the event flow.
Event
 Inherited
stopPropagation():void
Prevents processing of any event listeners in nodes subsequent to the current node in the event flow.
Event
 Inherited
toLocaleString():String
Returns the string representation of this object, formatted according to locale-specific conventions.
Object
 Inherited
toString():String
Returns a string containing all the properties of the Event object.
Event
 Inherited
valueOf():Object
Returns the primitive value of the specified object.
Object
Public Constants
 ConstantDefined By
  FAILURE : String = "openSessionEventFailure"
[static] This type is sent when handling failed in opening an ISession
OpenSessionEvent
  SUCCESS : String = "openSessionEventSuccess"
[static] This type is sent when handling succeeded in opening an ISession
OpenSessionEvent
Property Detail

NAMESPACE

property
NAMESPACE:String  [read-only]

Language Version: ActionScript 3.0
Product Version: Adobe Digital Enterprise Platform Experience Services - Composite Application Framework 10
Runtime Versions: AIR 2.6, Flash Player 10.2

The namespace for messages of this type.



Implementation
    public static function get NAMESPACE():String

session

property 
session:ISession  [read-only]

Language Version: ActionScript 3.0
Product Version: Adobe Digital Enterprise Platform Experience Services - Composite Application Framework 10
Runtime Versions: AIR 2.6, Flash Player 10.2

The ISession that was opened if successful.



Implementation
    public function get session():ISession

Related API Elements

com.adobe.mosaic.om.interfaces.ISession
Constructor Detail

OpenSessionEvent

()Constructor
public function OpenSessionEvent(type:String, sess:ISession = null, msg:String = null)

Language Version: ActionScript 3.0
Product Version: Adobe Digital Enterprise Platform Experience Services - Composite Application Framework 10
Runtime Versions: AIR 2.6, Flash Player 10.2

Constructor.

Parameters
type:String — - event type
 
sess:ISession (default = null) — - event ISession
 
msg:String (default = null) — - event message

Related API Elements

com.adobe.mosaic.om.interfaces.ISession
Constant Detail

FAILURE

Constant
public static const FAILURE:String = "openSessionEventFailure"

Language Version: ActionScript 3.0
Product Version: Adobe Digital Enterprise Platform Experience Services - Composite Application Framework 10
Runtime Versions: AIR 2.6, Flash Player 10.2

This type is sent when handling failed in opening an ISession

SUCCESS

Constant 
public static const SUCCESS:String = "openSessionEventSuccess"

Language Version: ActionScript 3.0
Product Version: Adobe Digital Enterprise Platform Experience Services - Composite Application Framework 10
Runtime Versions: AIR 2.6, Flash Player 10.2

This type is sent when handling succeeded in opening an ISession




© 2014 Adobe Systems Incorporated. All rights reserved.
Thu Dec 4 2014, 05:50 PM -08:00
 

 

Legal Notices | Online Privacy Policy