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

Package | mx.rpc.events
Class | public class FaultEvent
Inheritance | FaultEvent AbstractEvent MessageEvent flash.events.Event

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
--- | --- | ---
|  | 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
|  | token : AsyncToken [read-only] The token that represents the call to the method. | AbstractEvent

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:AsyncToken = null, message:IMessage = null) Creates a new FaultEvent. | FaultEvent
|  | clone():Event [override] Clones the MessageEvent. | MessageEvent
|  | createEvent(fault:Fault, token:AsyncToken = null, msg:IMessage = null):FaultEvent [static] Given a Fault, this method constructs and returns a FaultEvent. | FaultEvent
|  | createEventFromMessageFault(value:MessageFaultEvent, token:AsyncToken = null):FaultEvent [static] Given a MessageFaultEvent, this method constructs and returns a FaultEvent. | FaultEvent
|  | toString():String [override] Returns a string representation of the FaultEvent. | FaultEvent

Public Constants
Hide Inherited Public Constants
Show Inherited Public Constants

| Constant | Defined By
--- | --- | ---
|  | FAULT : String = fault [static] The FAULT event type. | FaultEvent
|  | MESSAGE : String = message [static] The MESSAGE event type; dispatched upon receipt of a message. | MessageEvent
|  | RESULT : String = result [static] The RESULT event type; dispatched when an RPC agent receives a result from a remote service destination. | MessageEvent

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: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: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: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: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: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: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.

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