Adobe® Flex® 4 Language Reference
Show Packages and Classes List |  Packages  |  Classes  |  Index  |  Appendixes
mx.rpc.soap 
SOAPHeader 
Packagemx.rpc.soap
Classpublic class SOAPHeader
InheritanceSOAPHeader Inheritance Object

Language Version: ActionScript 3.0
Product Version: Flex 3
Runtime Versions: Flash Player 9, AIR 1.1

You use a SOAPHeader to specify the headers that need to be added to a SOAP envelope of a WebService Operation request.



Public Properties
 PropertyDefined By
 Inheritedconstructor : Object
A reference to the class object or constructor function for a given object instance.
Object
  content : Object
The content to send for the header value.
SOAPHeader
  mustUnderstand : Boolean
Specifies whether the header must be understood by the endpoint.
SOAPHeader
 Inheritedprototype : Object
[static] A reference to the prototype object of a class or function object.
Object
  qname : QName
The qualified name of the SOAP header.
SOAPHeader
  role : String
Specifies the URI for the role that this header is intended in a potential chain of endpoints processing a SOAP request.
SOAPHeader
Public Methods
 MethodDefined By
  
SOAPHeader(qname:QName, content:Object)
Constructs a new SOAPHeader.
SOAPHeader
 Inherited
Indicates whether an object has a specified property defined.
Object
 Inherited
Indicates whether an instance of the Object class is in the prototype chain of the object specified as the parameter.
Object
 Inherited
Indicates whether the specified property exists and is enumerable.
Object
 Inherited
Sets the availability of a dynamic property for loop operations.
Object
 Inherited
Returns the string representation of this object, formatted according to locale-specific conventions.
Object
 Inherited
Returns the string representation of the specified object.
Object
 Inherited
Returns the primitive value of the specified object.
Object
Property Detail

content

property
public var content:Object

Language Version: ActionScript 3.0
Product Version: Flex 3
Runtime Versions: Flash Player 9, AIR 1.1

The content to send for the header value. If you provide an XML or flash.xml.XMLNode instance for the header, it is used directly as pre-encoded content and appended as a child to the soap:header element. Otherwise, you can provide the value as a String or Number, etc. and the underlying SOAP encoder attempts to encode the value correctly based on the QName provided in the SOAPHeader (with the last resort being xsd:anyType if a type definition is not present).

mustUnderstand

property 
public var mustUnderstand:Boolean

Language Version: ActionScript 3.0
Product Version: Flex 3
Runtime Versions: Flash Player 9, AIR 1.1

Specifies whether the header must be understood by the endpoint. If the header is handled but must be understood the endpoint should return a SOAP fault.

qname

property 
public var qname:QName

Language Version: ActionScript 3.0
Product Version: Flex 3
Runtime Versions: Flash Player 9, AIR 1.1

The qualified name of the SOAP header.

role

property 
public var role:String

Language Version: ActionScript 3.0
Product Version: Flex 3
Runtime Versions: Flash Player 9, AIR 1.1

Specifies the URI for the role that this header is intended in a potential chain of endpoints processing a SOAP request. If defined, this value is used to specify the actor for the SOAP header.

Constructor Detail

SOAPHeader

()Constructor
public function SOAPHeader(qname:QName, content:Object)

Language Version: ActionScript 3.0
Product Version: Flex 3
Runtime Versions: Flash Player 9, AIR 1.1

Constructs a new SOAPHeader. The qualified name and content for the SOAP header are required.

Parameters
qname:QName — The qualified name of the SOAP header.
 
content:Object — The content to send for the header value.