MessageFaultEvent

Package	mx.messaging.events
Class	public class MessageFaultEvent
Inheritance	MessageFaultEvent Event Object

Language Version:

ActionScript 3.0

Product Versions:

BlazeDS 4, Adobe Digital Enterprise Platform Data Services for Java EE 3

Runtime Versions:

Flash Player 9, AIR 1.1

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

Public Properties

	Property		Defined By
		bubbles : Boolean [read-only] Indicates whether an event is a bubbling event.	Event
		cancelable : Boolean [read-only] Indicates whether the behavior associated with the event can be prevented.	Event
		constructor : Object A reference to the class object or constructor function for a given object instance.	Object
		currentTarget : Object [read-only] The object that is actively processing the Event object with an event listener.	Event
		eventPhase : uint [read-only] 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
		rootCause : Object [read-only] Provides access to the root cause of the failure, if one exists.	MessageFaultEvent
		target : Object [read-only] The event target.	Event
		type : String [read-only] The type of event.	Event

Public Methods

	Method		Defined 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 [override] 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
		formatToString(className:String, ... arguments):String A utility function for implementing the toString() method in custom ActionScript 3.0 Event classes.	Event
		hasOwnProperty(name:String):Boolean Indicates whether an object has a specified property defined.	Object
		isDefaultPrevented():Boolean Checks whether the preventDefault() method has been called on the event.	Event
		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
		preventDefault():void Cancels an event's default behavior if that behavior can be canceled.	Event
		propertyIsEnumerable(name:String):Boolean Indicates whether the specified property exists and is enumerable.	Object
		setPropertyIsEnumerable(name:String, isEnum:Boolean = true):void Sets the availability of a dynamic property for loop operations.	Object
		stopImmediatePropagation():void Prevents processing of any event listeners in the current node and any subsequent nodes in the event flow.	Event
		stopPropagation():void Prevents processing of any event listeners in nodes subsequent to the current node in the event flow.	Event
		toLocaleString():String Returns the string representation of this object, formatted according to locale-specific conventions.	Object
		toString():String [override] Returns a string representation of the MessageFaultEvent.	MessageFaultEvent
		valueOf():Object Returns the primitive value of the specified object.	Object

Public Constants

	Constant		Defined By
		FAULT : String = "fault" [static] The FAULT event type; dispatched for a message fault.	MessageFaultEvent

Property Detail

faultCode

property

faultCode:String [read-only]

Language Version:

ActionScript 3.0

Product Versions:

BlazeDS 4, Adobe Digital Enterprise Platform Data Services for Java EE 3

Runtime Versions:

Flash Player 9, AIR 1.1

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

Related API Elements

faultString
faultDetail

faultDetail

property

faultDetail:String [read-only]

Language Version:

ActionScript 3.0

Product Versions:

BlazeDS 4, Adobe Digital Enterprise Platform Data Services for Java EE 3

Runtime Versions:

Flash Player 9, AIR 1.1

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

Related API Elements

faultString
faultCode

faultString

property

faultString:String [read-only]

Language Version:

ActionScript 3.0

Product Versions:

BlazeDS 4, Adobe Digital Enterprise Platform Data Services for Java EE 3

Runtime Versions:

Flash Player 9, AIR 1.1

Provides access to the destination specific reason for the failure.

Implementation
public function get faultString():String

Related API Elements

faultCode
faultDetail

message

property

public var message:ErrorMessage

Language Version:

ActionScript 3.0

Product Versions:

BlazeDS 4, Adobe Digital Enterprise Platform Data Services for Java EE 3

Runtime Versions:

Flash Player 9, AIR 1.1

The ErrorMessage for this event.

rootCause

property

rootCause:Object [read-only]

Language Version:

ActionScript 3.0

Product Versions:

BlazeDS 4, Adobe Digital Enterprise Platform Data Services for Java EE 3

Runtime Versions:

Flash Player 9, AIR 1.1

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

Related API Elements

MessageFaultEvent.rootCause

Constructor Detail

MessageFaultEvent

()

Constructor

public function MessageFaultEvent(type:String, bubbles:Boolean = false, cancelable:Boolean = false, message:ErrorMessage = null)

Language Version:

ActionScript 3.0

Product Versions:

BlazeDS 4, Adobe Digital Enterprise Platform Data Services for Java EE 3

Runtime Versions:

Flash Player 9, AIR 1.1

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

override public function clone():Event

Language Version:

ActionScript 3.0

Product Versions:

BlazeDS 4, Adobe Digital Enterprise Platform Data Services for Java EE 3

Runtime Versions:

Flash Player 9, AIR 1.1

Clones the MessageFaultEvent.

Returns

Event — Copy of this MessageFaultEvent.

createEvent

()

method

public static function createEvent(msg:ErrorMessage):MessageFaultEvent

Language Version:

ActionScript 3.0

Product Versions:

BlazeDS 4, Adobe Digital Enterprise Platform Data Services for Java EE 3

Runtime Versions:

Flash Player 9, AIR 1.1

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

override public function toString():String

Language Version:

ActionScript 3.0

Product Versions:

BlazeDS 4, Adobe Digital Enterprise Platform Data Services for Java EE 3

Runtime Versions:

Flash Player 9, AIR 1.1

Returns a string representation of the MessageFaultEvent.

Returns

String — String representation of the MessageFaultEvent.

Constant Detail

FAULT

Constant

public static const FAULT:String = "fault"

Language Version:

ActionScript 3.0

Product Versions:

BlazeDS 4, Adobe Digital Enterprise Platform Data Services for Java EE 3

Runtime Versions:

Flash Player 9, AIR 1.1

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:

Property	Value
`bubbles`	false
`cancelable`	false
`currentTarget`	The 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`.
`faultCode`	Provides destination-specific details of the failure.
`faultDetail`	Provides access to the destination-specific reason for the failure.
`faultString`	Provides access to the underlying reason for the failure if the channel did not raise the failure itself.
`message`	The ErrorMessage for this event.
`rootCause`	Provides access to the underlying reason for the failure, if one exists.
`target`	The 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.

Legal Notices | Online Privacy Policy

MessageFaultEvent - AS3 BlazeDS LCDS

Classes x

faultCode

faultDetail

faultString

message

rootCause

MessageFaultEvent

clone

createEvent

toString

FAULT