(Adobe® Flex™ Data Services 2 only)
Packagemx.messaging.messages
Classpublic class SOAPMessage
InheritanceSOAPMessage Inheritance HTTPRequestMessage Inheritance AbstractMessage Inheritance Object

SOAPMessages are similar to HTTPRequestMessages. However, they always contain a SOAP XML envelope request body that will always be sent using HTTP POST. They also allow a SOAP action to be specified.


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
 InheritedcontentType : String
Indicates the content type of this message.
HTTPRequestMessage
 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
 InheritedhttpHeaders : Object
Contains specific HTTP headers that should be placed on the request made to the destination.
HTTPRequestMessage
 InheritedmessageId : String
The unique id for the message.
AbstractMessage
 Inheritedmethod : String
Indicates what method should be used for the request.
HTTPRequestMessage
 Inheritedprototype : Object
[static] A reference to the prototype object of a class or function object.
Object
 InheritedrecordHeaders : Boolean
Only used when going through the proxy, should the proxy send back the request and response headers it used.
HTTPRequestMessage
  SOAP_ACTION_HEADER : String = "SOAPAction"
[static] The HTTP header that stores the SOAP action for the SOAPMessage.
SOAPMessage
 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
 Inheritedurl : String
Contains the final destination for this request.
HTTPRequestMessage
Public Methods
 MethodDefined by
  
SOAPMessage()
Constructs an uninitialized SOAPMessage.
SOAPMessage
  
getSOAPAction():String
Provides access to the name of the remote method/operation that will be called.
SOAPMessage
 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
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
 InheritedCONTENT_TYPE_FORM : String = "application/x-www-form-urlencoded"
[static] Indicates that the content of this message is a form.
HTTPRequestMessage
 InheritedCONTENT_TYPE_SOAP_XML : String = "text/xml; charset=utf-8"
[static] Indicates that the content of this message is XML meant for a SOAP request.
HTTPRequestMessage
 InheritedCONTENT_TYPE_XML : String = "application/xml"
[static] Indicates that the content of this message is XML.
HTTPRequestMessage
 InheritedDELETE_METHOD : String = "DELETE"
[static] Indicates that the method used for this request should be "delete".
HTTPRequestMessage
 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
 InheritedGET_METHOD : String = "GET"
[static] Indicates that the method used for this request should be "get".
HTTPRequestMessage
 InheritedHEAD_METHOD : String = "HEAD"
[static] Indicates that the method used for this request should be "head".
HTTPRequestMessage
 InheritedOPTIONS_METHOD : String = "OPTIONS"
[static] Indicates that the method used for this request should be "options".
HTTPRequestMessage
 InheritedPOST_METHOD : String = "POST"
[static] Indicates that the method used for this request should be "post".
HTTPRequestMessage
 InheritedPUT_METHOD : String = "PUT"
[static] Indicates that the method used for this request should be "put".
HTTPRequestMessage
 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
 InheritedTRACE_METHOD : String = "TRACE"
[static] Indicates that the method used for this request should be "trace".
HTTPRequestMessage
Property detail
SOAP_ACTION_HEADERproperty
public static var SOAP_ACTION_HEADER:String = "SOAPAction"

The HTTP header that stores the SOAP action for the SOAPMessage.

Constructor detail
SOAPMessage()constructor
public function SOAPMessage()

Constructs an uninitialized SOAPMessage.

Method detail
getSOAPAction()method
public function getSOAPAction():String

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

Returns
String



© 2004-2006 Adobe Systems Incorporated. All rights reserved.
Thu Jun 22 2006, 10:21 PM GMT-07:00

 

Send me an e-mail when comments are added to this page | Comment Report

Current page: http://livedocs.adobe.com/flex/2/langref/mx/messaging/messages/SOAPMessage.html