| Package | mx.messaging.messages |
| Class | public class ErrorMessage |
| Inheritance | ErrorMessage  AcknowledgeMessage AsyncMessage AbstractMessage Object |
| Subclasses | DataErrorMessage |
| 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 | ||
|---|---|---|---|
 | body : Object
The body of a message contains the specific data that needs to be
delivered to the remote destination. | AbstractMessage | |
| clientId : String
The clientId indicates which MessageAgent sent the message. | AbstractMessage | |
| constructor : Object
A reference to the class object or constructor function for a given object instance. | Object | |
| correlationId : String
Provides access to the correlation id of the message. | AsyncMessage | |
| destination : String
The message destination. | AbstractMessage | |
| extendedData : Object
Extended data that the remote destination has chosen to associate
with this error to facilitate custom error processing on the client. | ErrorMessage | ||
| faultCode : String
The fault code for the error. | ErrorMessage | ||
| faultDetail : String
Detailed description of what caused the error. | ErrorMessage | ||
| faultString : String
A simple description of the error. | ErrorMessage | ||
| headers : Object
The headers of a message are an associative array where the key is the
header name and the value is the header value. | AbstractMessage | |
| messageId : String
The unique id for the message. | AbstractMessage | |
| rootCause : Object
Should a root cause exist for the error, this property contains those details. | ErrorMessage | ||
| timestamp : Number
Provides access to the time stamp for the message. | AbstractMessage | |
| timeToLive : Number
The time to live value of a message indicates how long the message
should be considered valid and deliverable. | AbstractMessage | |
| Method | Defined By | ||
|---|---|---|---|
Constructs an ErrorMessage instance. | ErrorMessage | ||
|
Indicates whether an object has a specified property defined. | Object | |
|
Indicates whether an instance of the Object class is in the prototype chain of the object specified
as the parameter. | Object | |
|
Indicates whether the specified property exists and is enumerable. | Object | |
|
Sets the availability of a dynamic property for loop operations. | Object | |
|
Returns the string representation of this object, formatted according to locale-specific conventions. | Object | |
|
Returns a string representation of the message. | AbstractMessage | |
|
Returns the primitive value of the specified object. | Object | |
| Constant | Defined By | ||
|---|---|---|---|
| MESSAGE_DELIVERY_IN_DOUBT : String = "Client.Error.DeliveryInDoubt" [static]
If a message may not have been delivered, the faultCode will
contain this constant. | ErrorMessage | ||
| RETRYABLE_HINT_HEADER : String = "DSRetryableErrorHint" [static]
Header name for the retryable hint header. | ErrorMessage | ||
extendedData | property |
public var extendedData: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 |
Extended data that the remote destination has chosen to associate with this error to facilitate custom error processing on the client.
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 |
The fault code for the error. This value typically follows the convention of "[outer_context].[inner_context].[issue]". For example: "Channel.Connect.Failed", "Server.Call.Failed", etc.
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 |
Detailed description of what caused the error. This is typically a stack trace from the remote destination.
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 |
A simple description of the error.
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 |
Should a root cause exist for the error, this property contains those details. This may be an ErrorMessage, a NetStatusEvent info Object, or an underlying Flash error event: ErrorEvent, IOErrorEvent, or SecurityErrorEvent.
ErrorMessage | () | Constructor |
public function 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 |
Constructs an ErrorMessage instance.
MESSAGE_DELIVERY_IN_DOUBT | Constant |
public static const MESSAGE_DELIVERY_IN_DOUBT:String = "Client.Error.DeliveryInDoubt"| Language Version: | ActionScript 3.0 |
| Product Versions: | BlazeDS 4, LiveCycle Data Services for Java EE 3 |
| Runtime Versions: | Flash Player 9, AIR 1.1 |
If a message may not have been delivered, the faultCode will
contain this constant.
RETRYABLE_HINT_HEADER | Constant |
public static const RETRYABLE_HINT_HEADER:String = "DSRetryableErrorHint"| Language Version: | ActionScript 3.0 |
| Product Versions: | BlazeDS 4, LiveCycle Data Services for Java EE 3 |
| Runtime Versions: | Flash Player 9, AIR 1.1 |
Header name for the retryable hint header. This is used to indicate that the operation that generated the error may be retryable rather than fatal.
Wed Nov 21 2018, 06:34 AM -08:00