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

SessionFaultEvent  - AS3 CF
Packagecoldfusion.air.events
Classpublic class SessionFaultEvent
InheritanceSessionFaultEvent Inheritance Event Inheritance Object

Language Version: ActionScript 3.0
Product Version: ColdFusion 9
Runtime Versions: Flash Player 9, AIR 1.0

The Fault Event that is dispatched if an error occurs when accessing the methods of the Session Class.


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
  error : Error
The Error Object that holds details of the error.
SessionFaultEvent
  errorSQL : String
The SQL statement used when the error occurred.
SessionFaultEvent
 InheritedeventPhase : uint
[read-only] The current phase in the event flow.
Event
  sessionToken : coldfusion.air:SessionToken
Token representing the call to the method.
SessionFaultEvent
 Inheritedtarget : Object
[read-only] The event target.
Event
 Inheritedtype : String
[read-only] The type of event.
Event
Public Methods
 MethodDefined By
  
SessionFaultEvent(type:String, bubbles:Boolean = false, cancelable:Boolean = true, error:Error = null, errorSQL:String = null, sessionToken:coldfusion.air:SessionToken = null)
Creates a SessionFaultEvent object, which contains information about the error that occurs when accessing the methods of the Session Class.
SessionFaultEvent
 Inherited
clone():Event
Duplicates an instance of an Event subclass.
Event
  
createEvent(error:Error, errorSQL:String, sessionToken:coldfusion.air:SessionToken):SessionFaultEvent
[static] Given an error, this function constructs and returns a SessionFaultEvent.
SessionFaultEvent
 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
  FAULT : String = "fault"
[static] Defines the value of the Type property of a SessionFaultEvent object.
SessionFaultEvent
Property Detail

error

property
public var error:Error

Language Version: ActionScript 3.0
Product Version: ColdFusion 9
Runtime Versions: Flash Player 9, AIR 1.0

The Error Object that holds details of the error.

errorSQL

property 
public var errorSQL:String

Language Version: ActionScript 3.0
Product Version: ColdFusion 9
Runtime Versions: Flash Player 9, AIR 1.0

The SQL statement used when the error occurred.

sessionToken

property 
public var sessionToken:coldfusion.air:SessionToken

Language Version: ActionScript 3.0
Product Version: ColdFusion 9
Runtime Versions: Flash Player 9, AIR 1.0

Token representing the call to the method. Used in the asynchronous completion token pattern.

Constructor Detail

SessionFaultEvent

()Constructor
public function SessionFaultEvent(type:String, bubbles:Boolean = false, cancelable:Boolean = true, error:Error = null, errorSQL:String = null, sessionToken:coldfusion.air:SessionToken = null)

Language Version: ActionScript 3.0
Product Version: ColdFusion 9
Runtime Versions: Flash Player 9, AIR 1.0

Creates a SessionFaultEvent object, which contains information about the error that occurs when accessing the methods of the Session Class.

Parameters
type:String — The type of the event. Event listeners can access this information through the inherited type property.
 
bubbles:Boolean (default = false) — Determines whether the Event object participates in the bubbling phase of the event flow.
 
cancelable:Boolean (default = true) — Determines whether the Event object can be canceled. Event listeners can access this information through the inherited cancelable property.
 
error:Error (default = null) — The Error Object that holds details of the error.
 
errorSQL:String (default = null) — The SQL statement used when the error occurred.
 
sessionToken:coldfusion.air:SessionToken (default = null) — Token representing the call to the method. Used in the asynchronous completion token pattern.
Method Detail

createEvent

()method
public static function createEvent(error:Error, errorSQL:String, sessionToken:coldfusion.air:SessionToken):SessionFaultEvent

Language Version: ActionScript 3.0
Product Version: ColdFusion 9
Runtime Versions: Flash Player 9, AIR 1.0

Given an error, this function constructs and returns a SessionFaultEvent.

Parameters

error:Error — Error that contains the details of the SessionFaultEvent.
 
errorSQL:String — The SQL statement used when the error occurred.
 
sessionToken:coldfusion.air:SessionToken — SessionToken [optional] associated with this error.

Returns
SessionFaultEvent
Constant Detail

FAULT

Constant
public static const FAULT:String = "fault"

Language Version: ActionScript 3.0
Product Version: ColdFusion 9
Runtime Versions: Flash Player 9, AIR 1.0

Defines the value of the Type property of a SessionFaultEvent object.




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

 

Legal Notices | Online Privacy Policy