| Package | mx.messaging.messages |
| Class | public class ErrorMessage |
| Inheritance | ErrorMessage  AcknowledgeMessage AsyncMessage AbstractMessage Object |
| Language Version : | ActionScript 3.0 |
| Product Versions : | BlazeDS 4, LCDS 3 |
| Runtime Versions : | Flash Player 9, AIR 1.1 |
| 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 | |
| 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 | ||
| toString():String
Returns a string representation of the message. | AbstractMessage | |
| Constant | Defined By | ||
|---|---|---|---|
| DESTINATION_CLIENT_ID_HEADER : String = DSDstClientId [static]
Messages pushed from the server may arrive in a batch, with messages in the
batch potentially targeted to different Consumer instances. | AbstractMessage | |
| ENDPOINT_HEADER : String = DSEndpoint [static]
Messages are tagged with the endpoint id for the Channel they are sent over. | AbstractMessage | |
| ERROR_HINT_HEADER : String = DSErrorHint [static]
Header name for the error hint header. | AcknowledgeMessage | |
| FLEX_CLIENT_ID_HEADER : String = DSId [static]
This header is used to transport the global FlexClient Id value in outbound
messages once it has been assigned by the server. | AbstractMessage | |
| MESSAGE_DELIVERY_IN_DOUBT : String = Client.Error.DeliveryInDoubt [static]
If a message may not have been delivered, the faultCode will
contain this constant. | ErrorMessage | ||
| PRIORITY_HEADER : String = DSPriority [static]
Messages sent by a MessageAgent can have a priority header with a 0-9
numerical value (0 being lowest) and the server can choose to use this
numerical value to prioritize messages to clients. | AbstractMessage | |
| REMOTE_CREDENTIALS_CHARSET_HEADER : String = DSRemoteCredentialsCharset [static]
Messages that need to set remote credentials for a destination
may also need to report the character-set encoding that was used to
create the credentials String using this header. | AbstractMessage | |
| REMOTE_CREDENTIALS_HEADER : String = DSRemoteCredentials [static]
Messages that need to set remote credentials for a destination
carry the Base64 encoded credentials in this header. | AbstractMessage | |
| REQUEST_TIMEOUT_HEADER : String = DSRequestTimeout [static]
Messages sent with a defined request timeout use this header. | AbstractMessage | |
| RETRYABLE_HINT_HEADER : String = DSRetryableErrorHint [static]
Header name for the retryable hint header. | ErrorMessage | ||
| STATUS_CODE_HEADER : String = DSStatusCode [static]
A status code can provide context about the nature of a response
message. | AbstractMessage | |
| SUBTOPIC_HEADER : String = DSSubtopic [static]
Messages sent by a MessageAgent with a defined subtopic
property indicate their target subtopic in this header. | AsyncMessage | |
| extendedData | property |
Hide Inherited Public Properties
Show Inherited Public Propertiespublic var extendedData:Object| Language Version : | ActionScript 3.0 |
| Product Versions : | BlazeDS 4, LCDS 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, LCDS 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, LCDS 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, LCDS 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, LCDS 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, LCDS 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, LCDS 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, LCDS 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.