| Package | mx.messaging.messages |
| Class | public class AsyncMessage |
| Inheritance | AsyncMessage  AbstractMessage Object |
| Implements | ISmallMessage |
| Subclasses | AcknowledgeMessage, CommandMessage, DataMessage |
| Language Version: | ActionScript 3.0 |
| Product Versions: | BlazeDS 4, LiveCycle Data Services 3 |
| Runtime Versions: | Flash Player 9, AIR 1.1 |
Public Properties
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 | |
| 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 | |
| prototype : Object [static]
A reference to the prototype object of a class or function object. | Object | |
| 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 | |
Public Methods
| Method | Defined By | ||
|---|---|---|---|
Constructs an instance of an AsyncMessage with an empty body and header. | AsyncMessage | ||
|
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 | |
Public Constants
| 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 | |
| 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 | |
| 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 | |
| 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 | ||
Property Detail
correlationId | property |
correlationId:String| Language Version: | ActionScript 3.0 |
| Product Versions: | BlazeDS 4, LiveCycle Data Services 3 |
| Runtime Versions: | Flash Player 9, AIR 1.1 |
Provides access to the correlation id of the message.
Used for acknowledgement and for segmentation of messages.
The correlationId contains the messageId of the
previous message that this message refers to.
Implementation
public function get correlationId():String public function set correlationId(value:String):voidSee also
Constructor Detail
AsyncMessage | () | Constructor |
public function AsyncMessage(body:Object = null, headers:Object = null)| Language Version: | ActionScript 3.0 |
| Product Versions: | BlazeDS 4, LiveCycle Data Services 3 |
| Runtime Versions: | Flash Player 9, AIR 1.1 |
Constructs an instance of an AsyncMessage with an empty body and header.
In addition to this default behavior, the body and the headers for the
message may also be passed to the constructor as a convenience.
An example of this invocation approach for the body is:
var msg:AsyncMessage = new AsyncMessage("Body text");
An example that provides both the body and headers is:
var msg:AsyncMessage = new AsyncMessage("Body text", {"customerHeader":"customValue"});
body:Object (default = null) | |
headers:Object (default = null) |
Constant Detail
SUBTOPIC_HEADER | Constant |
public static const SUBTOPIC_HEADER:String = "DSSubtopic"| Language Version: | ActionScript 3.0 |
| Product Versions: | BlazeDS 4, LiveCycle Data Services 3 |
| Runtime Versions: | Flash Player 9, AIR 1.1 |
Messages sent by a MessageAgent with a defined subtopic
property indicate their target subtopic in this header.
Thu May 20 2010, 02:19 AM -07:00