ActionScript® 3.0 Reference for the Adobe® Flash® Platform
Home  |  Show Packages and Classes List |  Packages  |  Classes  |  What's New  |  Index  |  Appendixes
mx.messaging.messages 

AsyncMessage  - AS3 BlazeDS LCDS
Packagemx.messaging.messages
Classpublic class AsyncMessage
InheritanceAsyncMessage Inheritance AbstractMessage Inheritance Object
Implements ISmallMessage
Subclasses AcknowledgeMessage, CommandMessage, DataMessage, ManagedRemotingMessage

Language Version: ActionScript 3.0
Product Versions: BlazeDS 4, Adobe Digital Enterprise Platform Data Services for Java EE 3
Runtime Versions: Flash Player 9, AIR 1.1

AsyncMessage is the base class for all asynchronous messages.


Public Properties
 PropertyDefined By
 Inheritedbody : Object
The body of a message contains the specific data that needs to be delivered to the remote destination.
AbstractMessage
 InheritedclientId : String
The clientId indicates which MessageAgent sent the message.
AbstractMessage
 Inheritedconstructor : 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
 Inheriteddestination : String
The message destination.
AbstractMessage
 Inheritedheaders : 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
 InheritedmessageId : String
The unique id for the message.
AbstractMessage
 Inheritedtimestamp : Number
Provides access to the time stamp for the message.
AbstractMessage
 InheritedtimeToLive : Number
The time to live value of a message indicates how long the message should be considered valid and deliverable.
AbstractMessage
Public Methods
 MethodDefined By
  
AsyncMessage(body:Object = null, headers:Object = null)
Constructs an instance of an AsyncMessage with an empty body and header.
AsyncMessage
 Inherited
hasOwnProperty(name:String):Boolean
Indicates whether an object has a specified property defined.
Object
 Inherited
isPrototypeOf(theClass:Object):Boolean
Indicates whether an instance of the Object class is in the prototype chain of the object specified as the parameter.
Object
 Inherited
propertyIsEnumerable(name:String):Boolean
Indicates whether the specified property exists and is enumerable.
Object
 Inherited
setPropertyIsEnumerable(name:String, isEnum:Boolean = true):void
Sets the availability of a dynamic property for loop operations.
Object
 Inherited
toLocaleString():String
Returns the string representation of this object, formatted according to locale-specific conventions.
Object
 Inherited
toString():String
Returns a string representation of the message.
AbstractMessage
 Inherited
valueOf():Object
Returns the primitive value of the specified object.
Object
Public Constants
 ConstantDefined By
  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, Adobe Digital Enterprise Platform Data Services for Java EE 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):void

Related API Elements

mx.messaging.messages.AbstractMessage.messageId
Constructor Detail

AsyncMessage

()Constructor
public function AsyncMessage(body:Object = null, headers:Object = null)

Language Version: ActionScript 3.0
Product Versions: BlazeDS 4, Adobe Digital Enterprise Platform Data Services for Java EE 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"});

Parameters
body:Object (default = null) — The optional body to assign to the message.
 
headers:Object (default = null) — The optional headers to assign to the message.
Constant Detail

SUBTOPIC_HEADER

Constant
public static const SUBTOPIC_HEADER:String = "DSSubtopic"

Language Version: ActionScript 3.0
Product Versions: BlazeDS 4, Adobe Digital Enterprise Platform Data Services for Java EE 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.




© 2014 Adobe Systems Incorporated. All rights reserved.
Thu Dec 4 2014, 05:50 PM -08:00
 

 

Legal Notices | Online Privacy Policy