(Adobe® Flex™ Data Services 2 only)
Packagemx.messaging.events
Classpublic class MessageFaultEvent
InheritanceMessageFaultEvent Inheritance Event Inheritance Object

The MessageFaultEvent class is used to propagate fault messages within the messaging system.


Public Properties
 PropertyDefined by
 Inheritedbubbles : Boolean
Indicates whether an event is a bubbling event.
Event
 Inheritedcancelable : Boolean
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
The object that is actively processing the Event object with an event listener.
Event
 InheritedeventPhase : uint
The current phase in the event flow.
Event
  faultCode : String
[read-only] Provides access to the destination specific failure code.
MessageFaultEvent
  faultDetail : String
[read-only] Provides destination specific details of the failure.
MessageFaultEvent
  faultString : String
[read-only] Provides access to the destination specific reason for the failure.
MessageFaultEvent
  message : ErrorMessage
The ErrorMessage for this event.
MessageFaultEvent
 Inheritedprototype : Object
[static] A reference to the prototype object of a class or function object.
Object
  rootCause : Object
[read-only] Provides access to the root cause of the failure, if one exists.
MessageFaultEvent
 Inheritedtarget : Object
The event target.
Event
 Inheritedtype : String
The type of event.
Event
Public Methods
 MethodDefined by
  
MessageFaultEvent(type:String, bubbles:Boolean = false, cancelable:Boolean = false, message:ErrorMessage = null)
Constructs an instance of a fault message event for the specified message and fault information.
MessageFaultEvent
  
clone():Event
Clones the MessageFaultEvent.
MessageFaultEvent
  
createEvent(msg:ErrorMessage):MessageFaultEvent
[static] Utility method to create a new MessageFaultEvent that doesn't bubble and is not cancelable.
MessageFaultEvent
 Inherited
formatToString(className:String, ... arguments):String
A utility function for implementing the toString() method in your custom Event class.
Event
 Inherited
hasOwnProperty(name:String):Boolean
Indicates whether an object has a specified property defined.
Object
 Inherited
isDefaultPrevented():Boolean
Checks whether preventDefault() 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
  
toString():String
Returns a string representation of the MessageFaultEvent.
MessageFaultEvent
 Inherited
valueOf():Object
Returns the primitive value of the specified object.
Object
Public Constants
 ConstantDefined by
 InheritedACTIVATE : String = "activate"
[static] Defines the value of the type property of an activate event object.
Event
 InheritedADDED : String = "added"
[static] Defines the value of the type property of an added event object.
Event
 InheritedCANCEL : String = "cancel"
[static] Defines the value of the type property of a cancel event object.
Event
 InheritedCHANGE : String = "change"
[static] Defines the value of the type property of a change event object.
Event
 InheritedCLOSE : String = "close"
[static] Defines the value of the type property of a close event object.
Event
 InheritedCOMPLETE : String = "complete"
[static] Defines the value of the type property of a complete event object.
Event
 InheritedCONNECT : String = "connect"
[static] Defines the value of the type property of a connect event object.
Event
 InheritedDEACTIVATE : String = "deactivate"
[static] Defines the value of the type property of a deactivate event object.
Event
 InheritedENTER_FRAME : String = "enterFrame"
[static] Defines the value of the type property of an enterFrame event object.
Event
  FAULT : String = "fault"
[static] The FAULT event type; dispatched for a message fault.
MessageFaultEvent
 InheritedID3 : String = "id3"
[static] Defines the value of the type property of an id3 event object.
Event
 InheritedINIT : String = "init"
[static] Defines the value of the type property of an init event object.
Event
 InheritedMOUSE_LEAVE : String = "mouseLeave"
[static] Defines the value of the type property of a mouseLeave event object.
Event
 InheritedOPEN : String = "open"
[static] Defines the value of the type property of an open event object.
Event
 InheritedREMOVED : String = "removed"
[static] Defines the value of the type property of a removed event object.
Event
 InheritedRENDER : String = "render"
[static] Defines the value of the type property of a render event object.
Event
 InheritedRESIZE : String = "resize"
[static] Defines the value of the type property of a resize event object.
Event
 InheritedSCROLL : String = "scroll"
[static] Defines the value of the type property of a scroll event object.
Event
 InheritedSELECT : String = "select"
[static] Defines the value of the type property of a select event object.
Event
 InheritedSOUND_COMPLETE : String = "soundComplete"
[static] Defines the value of the type property of a soundComplete event object.
Event
 InheritedTAB_CHILDREN_CHANGE : String = "tabChildrenChange"
[static] Defines the value of the type property of a tabChildrenChange event object.
Event
 InheritedTAB_ENABLED_CHANGE : String = "tabEnabledChange"
[static] Defines the value of the type property of a tabEnabledChange event object.
Event
 InheritedTAB_INDEX_CHANGE : String = "tabIndexChange"
[static] Defines the value of the type property of a tabIndexChange event object.
Event
 InheritedUNLOAD : String = "unload"
[static] Defines the value of the type property of an unload event object.
Event
Property detail
faultCodeproperty
faultCode:String  [read-only]

Provides access to the destination specific failure code. For more specific details see faultString and faultDetails properties.

The format of the fault codes are provided by the remote destination, but, will typically have the following form: host.operation.error For example, "Server.Connect.Failed"

Implementation
    public function get faultCode():String

See also

faultString
faultDetail
faultDetailproperty 
faultDetail:String  [read-only]

Provides destination specific details of the failure.

Typically fault details are a stack trace of an exception thrown at the remote destination.

Implementation
    public function get faultDetail():String

See also

faultString
faultCode
faultStringproperty 
faultString:String  [read-only]

Provides access to the destination specific reason for the failure.

Implementation
    public function get faultString():String

See also

faultCode
faultDetail
messageproperty 
public var message:ErrorMessage

The ErrorMessage for this event.

rootCauseproperty 
rootCause:Object  [read-only]

Provides access to the root cause of the failure, if one exists. In the case of custom exceptions thrown by a destination, the root cause represents the top level failure that is merely transported by the ErrorMessage.

Implementation
    public function get rootCause():Object

See also

MessageFaultEvent.rootCause
Constructor detail
MessageFaultEvent()constructor
public function MessageFaultEvent(type:String, bubbles:Boolean = false, cancelable:Boolean = false, message:ErrorMessage = null)

Constructs an instance of a fault message event for the specified message and fault information.

Parameters
type:String — The type for the MessageAckEvent.
 
bubbles:Boolean (default = false) — Specifies whether the event can bubble up the display list hierarchy.
 
cancelable:Boolean (default = false) — Indicates whether the behavior associated with the event can be prevented.
 
message:ErrorMessage (default = null) — The ErrorMessage associated with the fault.
Method detail
clone()method
public override function clone():Event

Clones the MessageFaultEvent.

Returns
Event — Copy of this MessageFaultEvent.
createEvent()method 
public static function createEvent(msg:ErrorMessage):MessageFaultEvent

Utility method to create a new MessageFaultEvent that doesn't bubble and is not cancelable.

Parameters
msg:ErrorMessage — The ErrorMessage associated with the fault.

Returns
MessageFaultEvent — New MessageFaultEvent.
toString()method 
public override function toString():String

Returns a string representation of the MessageFaultEvent.

Returns
String — String representation of the MessageFaultEvent.
Constant detail
FAULTconstant
public static const FAULT:String = "fault"

The FAULT event type; dispatched for a message fault.

The value of this constant is "fault".

The properties of the event object have the following values:

PropertyValue
bubblesfalse
cancelablefalse
currentTargetThe Object that defines the event listener that handles the event. For example, if you use myButton.addEventListener() to register an event listener, myButton is the value of the currentTarget.
faultCodeProvides destination-specific details of the failure.
faultDetailProvides access to the destination-specific reason for the failure.
faultStringProvides access to the underlying reason for the failure if the channel did not raise the failure itself.
messageThe ErrorMessage for this event.
rootCause Provides access to the underlying reason for the failure, if one exists.
targetThe Object that dispatched the event; it is not always the Object listening for the event. Use the currentTarget property to always access the Object listening for the event.



© 2004-2006 Adobe Systems Incorporated. All rights reserved.
Thu Jun 22 2006, 10:21 PM GMT-07:00

 

Send me an e-mail when comments are added to this page | Comment Report

Current page: http://livedocs.adobe.com/flex/2/langref/mx/messaging/events/MessageFaultEvent.html