Adobe® Flex® 4 Language Reference
Show Packages and Classes List |  Packages  |  Classes  |  Index  |  Appendixes
mx.messaging.messages 
AcknowledgeMessage 
Packagemx.messaging.messages
Classpublic class AcknowledgeMessage
InheritanceAcknowledgeMessage Inheritance AsyncMessage Inheritance AbstractMessage Inheritance Object
Implements ISmallMessage
Subclasses ErrorMessage, SequencedMessage

Language Version: ActionScript 3.0
Product Versions: BlazeDS 4, LiveCycle Data Services 3
Runtime Versions: Flash Player 9, AIR 1.1

An AcknowledgeMessage acknowledges the receipt of a message that was sent previously. Every message sent within the messaging system must receive an acknowledgement.


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
 InheritedcorrelationId : 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
 Inheritedprototype : Object
[static] A reference to the prototype object of a class or function object.
Object
 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
  
AcknowledgeMessage()
Constructs an instance of an AcknowledgeMessage with an empty body and header.
AcknowledgeMessage
 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
 InheritedDESTINATION_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
 InheritedENDPOINT_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
 InheritedFLEX_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
 InheritedPRIORITY_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
 InheritedREMOTE_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
 InheritedREMOTE_CREDENTIALS_HEADER : String = "DSRemoteCredentials"
[static] Messages that need to set remote credentials for a destination carry the Base64 encoded credentials in this header.
AbstractMessage
 InheritedREQUEST_TIMEOUT_HEADER : String = "DSRequestTimeout"
[static] Messages sent with a defined request timeout use this header.
AbstractMessage
 InheritedSTATUS_CODE_HEADER : String = "DSStatusCode"
[static] A status code can provide context about the nature of a response message.
AbstractMessage
 InheritedSUBTOPIC_HEADER : String = "DSSubtopic"
[static] Messages sent by a MessageAgent with a defined subtopic property indicate their target subtopic in this header.
AsyncMessage
Constructor Detail

AcknowledgeMessage

()Constructor
public function AcknowledgeMessage()

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 AcknowledgeMessage with an empty body and header.

Constant Detail

ERROR_HINT_HEADER

Constant
public static const ERROR_HINT_HEADER:String = "DSErrorHint"

Language Version: ActionScript 3.0
Product Versions: BlazeDS 4, LiveCycle Data Services 3
Runtime Versions: Flash Player 9, AIR 1.1

Header name for the error hint header. Used to indicate that the acknowledgement is for a message that generated an error.




© 2010 Adobe Systems Incorporated. All rights reserved.
Thu May 20 2010, 02:19 AM -07:00