Apache Flex 4.16.0 API Reference | All Packages | All Classes | Index | Frames No Frames |
MessageFaultEvent

Package | mx.messaging.events
Class | public class MessageFaultEvent
Inheritance | MessageFaultEvent flash.events.Event

Language Version : | ActionScript 3.0

Product Versions : | BlazeDS 4, LCDS 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
--- | --- | ---
|  | 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

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
|  | toString():String [override] Returns a string representation of the MessageFaultEvent. | MessageFaultEvent

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, LCDS 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`

See also

faultString
faultDetail

faultDetail | property |

`faultDetail:String` [read-only]

Language Version : | ActionScript 3.0

Product Versions : | BlazeDS 4, LCDS 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`

See also

faultString
faultCode

faultString | property |

`faultString:String` [read-only]

Language Version : | ActionScript 3.0

Product Versions : | BlazeDS 4, LCDS 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`

See also

faultCode
faultDetail

message | property |

`public var message:ErrorMessage`

Language Version : | ActionScript 3.0

Product Versions : | BlazeDS 4, LCDS 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, LCDS 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`

See also

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, LCDS 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, LCDS 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, LCDS 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, LCDS 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, LCDS 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.

Sun Mar 5 2017, 03:42 PM +11:00