mx.rpc.events

# FaultEvent - AS3 Flex

Package | mx.rpc.events
Class | public class FaultEvent
Inheritance | FaultEvent AbstractEvent MessageEvent Event Object
Subclasses | ColdFusionServiceFaultEvent, DataServiceFaultEvent, SyncFaultEvent

Language Version: | ActionScript 3.0

Product Version: | Flex 3

Runtime Versions: | Flash Player 9, AIR 1.1

This event is dispatched when an RPC call has a fault.

Public Properties
Hide Inherited Public Properties
Show Inherited 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
|  | fault : Fault [read-only] The Fault object that contains the details of what caused this event. | FaultEvent
|  | headers : Object In certain circumstances, headers may also be returned with a fault to provide further context to the failure. | FaultEvent
|  | message : IMessage The Message associated with this event. | MessageEvent
|  | statusCode : 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
|  | target : Object [read-only] The event target. | Event
|  | token : mx.rpc:AsyncToken [read-only] The token that represents the call to the method. | AbstractEvent
|  | type : String [read-only] The type of event. | Event

Public Methods
Hide Inherited Public Methods
Show Inherited Public Methods

| Method | Defined By
--- | --- | ---
|  | FaultEvent(type:String, bubbles:Boolean = false, cancelable:Boolean = true, fault:Fault = null, token:mx.rpc:AsyncToken = null, message:IMessage = null) Creates a new FaultEvent. | FaultEvent
|  | clone():Event [override] Clones the MessageEvent. | MessageEvent
|  | createEvent(fault:Fault, token:mx.rpc:AsyncToken = null, msg:IMessage = null):FaultEvent [static] Given a Fault, this method constructs and returns a FaultEvent. | FaultEvent
|  | createEventFromMessageFault(value:MessageFaultEvent, token:mx.rpc:AsyncToken = null):FaultEvent [static] Given a MessageFaultEvent, this method constructs and returns a FaultEvent. | FaultEvent
|  | 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 FaultEvent. | FaultEvent
|  | valueOf():Object Returns the primitive value of the specified object. | Object

Public Constants
Hide Inherited Public Constants
Show Inherited Public Constants

| Constant | Defined By
--- | --- | ---
|  | FAULT : String = "fault" [static] The FAULT event type. | FaultEvent

Property Detail

### fault

property

`fault:Fault` [read-only]

Language Version: | ActionScript 3.0

Product Version: | Flex 3

Runtime Versions: | Flash Player 9, AIR 1.1

The Fault object that contains the details of what caused this event.

Implementation
`public function get fault():Fault`

### headers

property

`headers:Object`

Language Version: | ActionScript 3.0

Product Version: | Flex 3

Runtime Versions: | Flash Player 9, AIR 1.1

In certain circumstances, headers may also be returned with a fault to provide further context to the failure.

Implementation
`public function get headers():Object`
`public function set headers(value:Object):void`

### statusCode

property

`statusCode:int` [read-only]

Language Version: | ActionScript 3.0

Product Version: | Flex 3

Runtime Versions: | Flash Player 9, AIR 1.1

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.

Implementation
`public function get statusCode():int`
Constructor Detail

### FaultEvent

()
Constructor

`public function FaultEvent(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: | Flex 3

Runtime Versions: | Flash Player 9, AIR 1.1

Creates a new FaultEvent. The fault is a required parameter while the call and message are optional.

Parameters

| `type:String` — The event type; indicates the action that triggered the event.
| `bubbles:Boolean` (default = `false`)`` — Specifies whether the event can bubble up the display list hierarchy.
| `cancelable:Boolean` (default = `true`)`` — Specifies whether the behavior associated with the event can be prevented.
| `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 = null, msg:IMessage = null):FaultEvent`

Language Version: | ActionScript 3.0

Product Version: | Flex 3

Runtime Versions: | Flash Player 9, AIR 1.1

Given a Fault, this method constructs and returns a FaultEvent.

Parameters

| `fault:Fault` — Fault that contains the details of the FaultEvent.
| `token:mx.rpc:AsyncToken` (default = `null`)`` — AsyncToken [optional] associated with this fault.
| `msg:IMessage` (default = `null`)`` — Message [optional] associated with this fault.

Returns

| `FaultEvent` — Returns a FaultEvent.

### createEventFromMessageFault

()
method

`public static function createEventFromMessageFault(value:MessageFaultEvent, token:mx.rpc:AsyncToken = null):FaultEvent`

Language Version: | ActionScript 3.0

Product Version: | Flex 3

Runtime Versions: | Flash Player 9, AIR 1.1

Given a MessageFaultEvent, this method constructs and returns a FaultEvent.

Parameters

| `value:MessageFaultEvent` — MessageFaultEvent reference to extract the appropriate fault information from.
| `token:mx.rpc:AsyncToken` (default = `null`)`` — AsyncToken [optional] associated with this fault.

Returns

| `FaultEvent` — Returns a FaultEvent.

### toString

()
method

`override public function toString():String`

Language Version: | ActionScript 3.0

Product Version: | Flex 3

Runtime Versions: | Flash Player 9, AIR 1.1

Returns a string representation of the FaultEvent.

Returns

| `String` — String representation of the FaultEvent.

Constant Detail

### FAULT

Constant

`public static const FAULT:String = "fault"`

Language Version: | ActionScript 3.0

Product Version: | Flex 3

Runtime Versions: | Flash Player 9, AIR 1.1

The FAULT event type.

The properties of the event object have the following values:

Property | Value
--- | ---
`bubbles` | false
`cancelable` | true, calling preventDefault() from the associated token's responder.fault method will prevent the service or operation from dispatching this event
`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`.
`fault` | The Fault object that contains the details of what caused this event.
`message` | The Message associated with this event.
`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.
`token` | The token that represents the call to the method. Used in the asynchronous completion token pattern.

© 2015 Adobe Systems Incorporated. All rights reserved.
Mon Apr 10 2017, 12:28 PM -07:00