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
  content : Object
The content to send for the header value.
SOAPHeader
  mustUnderstand : Boolean
Specifies whether the header must be understood by the endpoint.
SOAPHeader
  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
Property Detail
contentproperty
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).

mustUnderstandproperty 
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.

qnameproperty 
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.

roleproperty 
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.