(Adobe® Flex™ Data Services 2 only)
Packagemx.messaging.events
Classpublic class ChannelFaultEvent
InheritanceChannelFaultEvent Inheritance ChannelEvent Inheritance Event Inheritance Object

The ChannelFaultEvent class is used to propagate channel fault events 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
 Inheritedchannel : Channel
The Channel that generated this event.
ChannelEvent
 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
Provides access to the destination-specific failure code.
ChannelFaultEvent
  faultDetail : String
Provides destination-specific details of the failure.
ChannelFaultEvent
  faultString : String
Provides access to the destination-specific reason for the failure.
ChannelFaultEvent
 Inheritedprototype : Object
[static] A reference to the prototype object of a class or function object.
Object
 Inheritedreconnecting : Boolean
Indicates whether the Channel that generated this event is reconnecting.
ChannelEvent
 Inheritedrejected : Boolean
Indicates whether the Channel that generated this event was rejected.
ChannelEvent
  rootCause : Object
Provides access to the underlying reason for the failure if the channel did not raise the failure itself.
ChannelFaultEvent
 Inheritedtarget : Object
The event target.
Event
 Inheritedtype : String
The type of event.
Event
Public Methods
 MethodDefined by
  
ChannelFaultEvent(type:String, bubbles:Boolean = false, cancelable:Boolean = false, channel:Channel = null, reconnecting:Boolean = false, code:String = null, level:String = null, description:String = null)
Constructs an instance of this event with the specified type.
ChannelFaultEvent
  
clone():Event
Clones the ChannelFaultEvent.
ChannelFaultEvent
  
createErrorMessage():ErrorMessage
Creates an ErrorMessage based on the ChannelFaultEvent by copying over the faultCode, faultString, faultDetail and rootCause to the new ErrorMessage.
ChannelFaultEvent
  
createEvent(channel:Channel, reconnecting:Boolean = false, code:String = null, level:String = null, description:String = null):ChannelFaultEvent
[static] Utility method to create a new ChannelFaultEvent that doesn't bubble and is not cancelable.
ChannelFaultEvent
 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 ChannelFaultEvent.
ChannelFaultEvent
 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 = "channelConnect"
[static] The CONNECT event type; indicates that the Channel connected to its endpoint.
ChannelEvent
 InheritedDEACTIVATE : String = "deactivate"
[static] Defines the value of the type property of a deactivate event object.
Event
 InheritedDISCONNECT : String = "channelDisconnect"
[static] The DISCONNECT event type; indicates that the Channel disconnected from its endpoint.
ChannelEvent
 InheritedENTER_FRAME : String = "enterFrame"
[static] Defines the value of the type property of an enterFrame event object.
Event
  FAULT : String = "channelFault"
[static] The FAULT event type; indicates that the Channel faulted.
ChannelFaultEvent
 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
public var faultCode:String

Provides access to the destination-specific failure code. For more specific details see the 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 e.g. "Server.Connect.Failed"

See also

faultString
faultDetail
faultDetailproperty 
public var faultDetail:String

Provides destination-specific details of the failure.

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

See also

faultString
faultCode
faultStringproperty 
public var faultString:String

Provides access to the destination-specific reason for the failure.

See also

faultCode
faultDetail
rootCauseproperty 
public var rootCause:Object

Provides access to the underlying reason for the failure if the channel did not raise the failure itself.

Constructor detail
ChannelFaultEvent()constructor
public function ChannelFaultEvent(type:String, bubbles:Boolean = false, cancelable:Boolean = false, channel:Channel = null, reconnecting:Boolean = false, code:String = null, level:String = null, description:String = null)

Constructs an instance of this event with the specified type.

Parameters
type:String — The Channel generating the event.
 
bubbles:Boolean (default = false) — Indicates whether the Channel is in the process of reconnecting or not.
 
cancelable:Boolean (default = false) — The fault code.
 
channel:Channel (default = null) — The fault level.
 
reconnecting:Boolean (default = false) — The fault description.
 
code:String (default = null)
 
level:String (default = null)
 
description:String (default = null)
Method detail
clone()method
public override function clone():Event

Clones the ChannelFaultEvent.

Returns
Event — Copy of this ChannelFaultEvent.
createErrorMessage()method 
public function createErrorMessage():ErrorMessage

Creates an ErrorMessage based on the ChannelFaultEvent by copying over the faultCode, faultString, faultDetail and rootCause to the new ErrorMessage.

Returns
ErrorMessage — The ErrorMessage.
createEvent()method 
public static function createEvent(channel:Channel, reconnecting:Boolean = false, code:String = null, level:String = null, description:String = null):ChannelFaultEvent

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

Parameters
channel:Channel — The Channel generating the event.
 
reconnecting:Boolean (default = false) — Indicates whether the Channel is in the process of reconnecting or not.
 
code:String (default = null) — The fault code.
 
level:String (default = null) — The fault level.
 
description:String (default = null) — The fault description.

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

Returns a string representation of the ChannelFaultEvent.

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

The FAULT event type; indicates that the Channel faulted.

The value of this constant is "channelFault".

The properties of the event object have the following values:

PropertyValue
bubblesfalse
cancelablefalse
channelThe Channel that generated this event.
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.
reconnecting Indicates whether the channel that generated this event is reconnecting.
rootCause Provides access to the underlying reason for the failure if the channel did not raise the failure itself.
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