mx.messaging.messages.SOAPMessage - Adobe® Flex® 4 Language Reference (Flex 4)

Package	mx.messaging.messages
Class	public class SOAPMessage
Inheritance	SOAPMessage HTTPRequestMessage AbstractMessage Object

Language Version:

ActionScript 3.0

Product Versions:

BlazeDS 4, LiveCycle Data Services 3

Runtime Versions:

Flash Player 9, AIR 1.1

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

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
		contentType : String Indicates the content type of this message.	HTTPRequestMessage
		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
		httpHeaders : Object Contains specific HTTP headers that should be placed on the request made to the destination.	HTTPRequestMessage
		messageId : String The unique id for the message.	AbstractMessage
		method : String Indicates what method should be used for the request.	HTTPRequestMessage
		prototype : Object [static] A reference to the prototype object of a class or function object.	Object
		recordHeaders : Boolean Only used when going through the proxy, should the proxy send back the request and response headers it used.	HTTPRequestMessage
		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
		url : String Contains the final destination for this request.	HTTPRequestMessage

Public Methods

Hide Inherited Public Methods

Show Inherited Public Methods

	Method		Defined By
		SOAPMessage() Constructs an uninitialized SOAPMessage.	SOAPMessage
		getSOAPAction():String Provides access to the name of the remote method/operation that will be called.	SOAPMessage
		hasOwnProperty(name:String):Boolean Indicates whether an object has a specified property defined.	Object
		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
		propertyIsEnumerable(name:String):Boolean Indicates whether the specified property exists and is enumerable.	Object
		setPropertyIsEnumerable(name:String, isEnum:Boolean = true):void Sets the availability of a dynamic property for loop operations.	Object
		toLocaleString():String Returns the string representation of this object, formatted according to locale-specific conventions.	Object
		toString():String Returns a string representation of the message.	AbstractMessage
		valueOf():Object Returns the primitive value of the specified object.	Object

Public Constants

Hide Inherited Public Constants

Show Inherited Public Constants

	Constant		Defined By
		CONTENT_TYPE_FORM : String = "application/x-www-form-urlencoded" [static] Indicates that the content of this message is a form.	HTTPRequestMessage
		CONTENT_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
		CONTENT_TYPE_XML : String = "application/xml" [static] Indicates that the content of this message is XML.	HTTPRequestMessage
		DELETE_METHOD : String = "DELETE" [static] Indicates that the method used for this request should be "delete".	HTTPRequestMessage
		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
		GET_METHOD : String = "GET" [static] Indicates that the method used for this request should be "get".	HTTPRequestMessage
		HEAD_METHOD : String = "HEAD" [static] Indicates that the method used for this request should be "head".	HTTPRequestMessage
		OPTIONS_METHOD : String = "OPTIONS" [static] Indicates that the method used for this request should be "options".	HTTPRequestMessage
		POST_METHOD : String = "POST" [static] Indicates that the method used for this request should be "post".	HTTPRequestMessage
		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
		PUT_METHOD : String = "PUT" [static] Indicates that the method used for this request should be "put".	HTTPRequestMessage
		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
		SOAP_ACTION_HEADER : String = "SOAPAction" [static] The HTTP header that stores the SOAP action for the SOAPMessage.	SOAPMessage
		STATUS_CODE_HEADER : String = "DSStatusCode" [static] A status code can provide context about the nature of a response message.	AbstractMessage
		TRACE_METHOD : String = "TRACE" [static] Indicates that the method used for this request should be "trace".	HTTPRequestMessage

Constructor Detail

SOAPMessage

()

Constructor

public function SOAPMessage()

Language Version:

ActionScript 3.0

Product Versions:

BlazeDS 4, LiveCycle Data Services 3

Runtime Versions:

Flash Player 9, AIR 1.1

Constructs an uninitialized SOAPMessage.

Method Detail

getSOAPAction

()

method

public function getSOAPAction():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 name of the remote method/operation that will be called.

Returns

String — Returns the name of the remote method/operation that will be called.

Constant Detail

SOAP_ACTION_HEADER

Constant

public static const SOAP_ACTION_HEADER:String = "SOAPAction"

Language Version:

ActionScript 3.0

Product Versions:

BlazeDS 4, LiveCycle Data Services 3

Runtime Versions:

Flash Player 9, AIR 1.1

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