Packagemx.messaging.messages
Classpublic class RemotingMessage
InheritanceRemotingMessage Inheritance AbstractMessage Inheritance Object

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

RemotingMessages are used to send RPC requests to a remote endpoint. These messages use the operation property to specify which method to call on the remote object. The destination property indicates what object/service should be used.



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
 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
  operation : String
Provides access to the name of the remote method/operation that should be called.
RemotingMessage
  source : String
This property is provided for backwards compatibility.
RemotingMessage
 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
  
Constructs an uninitialized RemotingMessage.
RemotingMessage
 Inherited
toString():String
Returns a string representation of the message.
AbstractMessage
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
 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
Property Detail
operationproperty
public var operation:String

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

Provides access to the name of the remote method/operation that should be called.

sourceproperty 
public var source:String

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

This property is provided for backwards compatibility. The best practice, however, is to not expose the underlying source of a RemoteObject destination on the client and only one source to a destination. Some types of Remoting Services may even ignore this property for security reasons.

Constructor Detail
RemotingMessage()Constructor
public function RemotingMessage()

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

Constructs an uninitialized RemotingMessage.