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 

SyncFaultEvent  - AS3 CF

Packagecoldfusion.air.events
Classpublic class SyncFaultEvent
InheritanceSyncFaultEvent Inheritance FaultEvent Inheritance AbstractEvent Inheritance MessageEvent 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 SyncManager.



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
 Inheritedfault : Fault
[read-only] The Fault object that contains the details of what caused this event.
FaultEvent
 Inheritedheaders : Object
In certain circumstances, headers may also be returned with a fault to provide further context to the failure.
FaultEvent
 Inheritedmessage : IMessage
The Message associated with this event.
MessageEvent
 InheritedstatusCode : int
[read-only] If the source message was sent via HTTP, this property provides access to the HTTP response status code (if available), otherwise the value is 0.
FaultEvent
 Inheritedtarget : Object
[read-only] The event target.
Event
 Inheritedtoken : mx.rpc:AsyncToken
[read-only] The token that represents the call to the method.
AbstractEvent
 Inheritedtype : String
[read-only] The type of event.
Event
Public Methods
 MethodDefined By
  
SyncFaultEvent(type:String, bubbles:Boolean = false, cancelable:Boolean = true, fault:Fault = null, token:mx.rpc:AsyncToken = null, message:IMessage = null)
Creates a SyncFaultEvent object.
SyncFaultEvent
 Inherited
[override] Clones the MessageEvent.
MessageEvent
  
[static] Given a fault, this function constructs and returns a SyncFaultEvent.
SyncFaultEvent
 Inherited
[static] Given a MessageFaultEvent, this method constructs and returns a FaultEvent.
FaultEvent
 Inherited
formatToString(className:String, ... arguments):String
A utility function for implementing the toString() method in custom ActionScript 3.0 Event classes.
Event
 Inherited
Indicates whether an object has a specified property defined.
Object
 Inherited
Checks whether the preventDefault() method has been called on the event.
Event
 Inherited
Indicates whether an instance of the Object class is in the prototype chain of the object specified as the parameter.
Object
 Inherited
Cancels an event's default behavior if that behavior can be canceled.
Event
 Inherited
Indicates whether the specified property exists and is enumerable.
Object
 Inherited
Sets the availability of a dynamic property for loop operations.
Object
 Inherited
Prevents processing of any event listeners in the current node and any subsequent nodes in the event flow.
Event
 Inherited
Prevents processing of any event listeners in nodes subsequent to the current node in the event flow.
Event
 Inherited
Returns the string representation of this object, formatted according to locale-specific conventions.
Object
 Inherited
[override] Returns a string representation of the FaultEvent.
FaultEvent
 Inherited
Returns the primitive value of the specified object.
Object
Public Constants
 ConstantDefined By
  FAULT : String = "fault"
[static] The type of the event.
SyncFaultEvent
Constructor Detail

SyncFaultEvent

()Constructor
public function SyncFaultEvent(type:String, bubbles:Boolean = false, cancelable:Boolean = true, fault:Fault = null, token:mx.rpc:AsyncToken = null, message:IMessage = null)

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

Creates a SyncFaultEvent object.

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.
 
fault:Fault (default = null) — Object that holds details of the fault, including a faultCode and faultString.
 
token:mx.rpc:AsyncToken (default = null) — Token representing the call to the method. Used in the asynchronous completion token pattern.
 
message:IMessage (default = null) — Source Message of the fault.
Method Detail

createEvent

()method
public static function createEvent(fault:Fault, token:mx.rpc:AsyncToken, message:IMessage = null):SyncFaultEvent

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

Given a fault, this function constructs and returns a SyncFaultEvent.

Parameters

fault:Fault — Fault that contains the details of the FaultEvent.
 
token:mx.rpc:AsyncToken — AsyncTokAsyncToken en [optional] associated with this fault.
 
message:IMessage (default = null)

Returns
SyncFaultEvent
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

The type of the event.