| Package | mx.messaging.events |
| Class | public class ChannelFaultEvent |
| Inheritance | ChannelFaultEvent  ChannelEvent Event Object |
| Language Version: | ActionScript 3.0 |
| Product Versions: | BlazeDS 4, LiveCycle Data Services for Java EE 3 |
| Runtime Versions: | Flash Player 9, AIR 1.1 |
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 | |
| channel : Channel
The Channel that generated this event. | ChannelEvent | |
| connected : Boolean
Indicates whether the Channel that generated this event is already connected. | ChannelEvent | |
| 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
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 | ||
| reconnecting : Boolean
Indicates whether the Channel that generated this event is reconnecting. | ChannelEvent | |
| rejected : 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 | ||
| target : Object [read-only]
The event target. | Event | |
| type : String [read-only]
The type of event. | Event | |
| Method | Defined 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, rejected:Boolean = false, connected:Boolean = false)
Constructs an instance of this event with the specified type. | ChannelFaultEvent | ||
[override]
Clones the ChannelFaultEvent. | ChannelFaultEvent | ||
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, rejected:Boolean = false, connected:Boolean = false):ChannelFaultEvent [static]
Utility method to create a new ChannelFaultEvent that doesn't bubble and
is not cancelable. | ChannelFaultEvent | ||
|
A utility function for implementing the toString() method in custom
ActionScript 3.0 Event classes. | Event | |
|
Indicates whether an object has a specified property defined. | Object | |
|
Checks whether the preventDefault() method has been called on the event. | Event | |
|
Indicates whether an instance of the Object class is in the prototype chain of the object specified
as the parameter. | Object | |
|
Cancels an event's default behavior if that behavior can be canceled. | Event | |
|
Indicates whether the specified property exists and is enumerable. | Object | |
|
Sets the availability of a dynamic property for loop operations. | Object | |
|
Prevents processing of any event listeners in the current node and any subsequent nodes in
the event flow. | Event | |
|
Prevents processing of any event listeners in nodes subsequent to the current node in the
event flow. | Event | |
|
Returns the string representation of this object, formatted according to locale-specific conventions. | Object | |
[override]
Returns a string representation of the ChannelFaultEvent. | ChannelFaultEvent | ||
|
Returns the primitive value of the specified object. | Object | |
| Constant | Defined By | ||
|---|---|---|---|
| FAULT : String = "channelFault" [static]
The FAULT event type; indicates that the Channel faulted. | ChannelFaultEvent | ||
faultCode | property |
public var faultCode:String| Language Version: | ActionScript 3.0 |
| Product Versions: | BlazeDS 4, LiveCycle 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 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
or Channel.operation.error.
For example, "Server.Connect.Failed" and Channel.Connect.Failed.
Channel.Connect.Failed is issued by the Channel class and its subclasses (RTMPChannel, AMFChannel, HTTPChannel, and so forth) whenever there is an issue in a Channel's connect attempts to the remote destination. Channel.Call.Failed is issued by the AMFChannel when the channel is already connected but it gets a Call.Failed code from its underlying NetConnection. Only the AMFChannel class listens for NetConnection.Call.Failed, which gets converted to Channel.Call.Failed.
Related API Elements
faultDetail | property |
public var faultDetail:String| Language Version: | ActionScript 3.0 |
| Product Versions: | BlazeDS 4, LiveCycle 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.
Related API Elements
faultString | property |
public var faultString:String| Language Version: | ActionScript 3.0 |
| Product Versions: | BlazeDS 4, LiveCycle Data Services for Java EE 3 |
| Runtime Versions: | Flash Player 9, AIR 1.1 |
Provides access to the destination-specific reason for the failure.
Related API Elements
rootCause | property |
public var rootCause:Object| Language Version: | ActionScript 3.0 |
| Product Versions: | BlazeDS 4, LiveCycle Data Services for Java EE 3 |
| Runtime Versions: | Flash Player 9, AIR 1.1 |
Provides access to the underlying reason for the failure if the channel did not raise the failure itself.
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, rejected:Boolean = false, connected:Boolean = false)| Language Version: | ActionScript 3.0 |
| Product Versions: | BlazeDS 4, LiveCycle Data Services for Java EE 3 |
| Runtime Versions: | Flash Player 9, AIR 1.1 |
Constructs an instance of this event with the specified type.
Note that the rejected and connected arguments that correspond to properties
defined by the super-class ChannelEvent were not originally included in this method signature and have been
added at the end of the argument list to preserve backward compatibility even though this signature differs from
ChannelEvent's constructor.
type:String — The type of the event.
| |
bubbles:Boolean (default = false) | |
cancelable:Boolean (default = false) | |
channel:Channel (default = null) | |
reconnecting:Boolean (default = false) | |
code:String (default = null) | |
level:String (default = null) | |
description:String (default = null) | |
rejected:Boolean (default = false) | |
connected:Boolean (default = false) |
clone | () | method |
createErrorMessage | () | method |
public function createErrorMessage():ErrorMessage| Language Version: | ActionScript 3.0 |
| Product Versions: | BlazeDS 4, LiveCycle Data Services for Java EE 3 |
| Runtime Versions: | Flash Player 9, AIR 1.1 |
Creates an ErrorMessage based on the ChannelFaultEvent by copying over the faultCode, faultString, faultDetail and rootCause to the new ErrorMessage.
ReturnsErrorMessage — The ErrorMessage.
|
createEvent | () | method |
public static function createEvent(channel:Channel, reconnecting:Boolean = false, code:String = null, level:String = null, description:String = null, rejected:Boolean = false, connected:Boolean = false):ChannelFaultEvent| Language Version: | ActionScript 3.0 |
| Product Versions: | BlazeDS 4, LiveCycle Data Services for Java EE 3 |
| Runtime Versions: | Flash Player 9, AIR 1.1 |
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) | |
code:String (default = null) | |
level:String (default = null) | |
description:String (default = null) | |
rejected:Boolean (default = false) | |
connected:Boolean (default = false) |
ChannelFaultEvent — New ChannelFaultEvent.
|
toString | () | method |
override public function toString():String| Language Version: | ActionScript 3.0 |
| Product Versions: | BlazeDS 4, LiveCycle Data Services for Java EE 3 |
| Runtime Versions: | Flash Player 9, AIR 1.1 |
Returns a string representation of the ChannelFaultEvent.
ReturnsString — String representation of the ChannelFaultEvent.
|
FAULT | Constant |
public static const FAULT:String = "channelFault"| Language Version: | ActionScript 3.0 |
| Product Versions: | BlazeDS 4, LiveCycle Data Services for Java EE 3 |
| Runtime Versions: | Flash Player 9, AIR 1.1 |
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:
| Property | Value |
|---|---|
bubbles | false |
cancelable | false |
channel | The Channel that generated 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. |
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. |
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. |
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. |
Wed Nov 21 2018, 06:34 AM -08:00