asdoc/mx/rpc/soap/SOAPHeader.js.json

{ "type": "class",
  "qname": "mx.rpc.soap.SOAPHeader",
  "baseClassname": ""
  ,
    "description": "You use a SOAPHeader to specify the headers that need to be added to a SOAP envelope of a WebService Operation request.",
  "tags": [
  {  "tagName": "playerversion",
         "values": ["Flash 9", "AIR 1.1"]},
      {  "tagName": "productversion",
         "values": ["Flex 3"]},
      {  "tagName": "langversion",
         "values": ["3.0"]}  ],
  "members": [
  { "type": "method",
        "qname": "mx.rpc.soap.SOAPHeader",
        "namespace": "",
        "bindable": [],
        "details": [],
        "deprecated": {},
          "description": "Constructs a new SOAPHeader. The qualified name and content for the SOAP header are required.",
        "tags": [
        {  "tagName": "param",
               "values": ["qname The qualified name of the SOAP header.", "content The content to send for the header value."]},
            {  "tagName": "playerversion",
               "values": ["Flash 9", "AIR 1.1"]},
            {  "tagName": "productversion",
               "values": ["Flex 3"]},
            {  "tagName": "langversion",
               "values": ["3.0"]}  ],
          "return": "",
          "params": [{ "name": "qname", "type": "QName"},
        { "name": "content", "type": "Object"}]}
      ,
      { "type": "field",
        "qname": "content",
        "return": "Object",
        "namespace": "public",
        "bindable": [],
        "details": [],
        "deprecated": {},
          "description": "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).",
        "tags": [
        {  "tagName": "playerversion",
               "values": ["Flash 9", "AIR 1.1"]},
            {  "tagName": "productversion",
               "values": ["Flex 3"]},
            {  "tagName": "langversion",
               "values": ["3.0"]}  ]},
      { "type": "field",
        "qname": "qname",
        "return": "QName",
        "namespace": "public",
        "bindable": [],
        "details": [],
        "deprecated": {},
          "description": "The qualified name of the SOAP header.",
        "tags": [
        {  "tagName": "playerversion",
               "values": ["Flash 9", "AIR 1.1"]},
            {  "tagName": "productversion",
               "values": ["Flex 3"]},
            {  "tagName": "langversion",
               "values": ["3.0"]}  ]},
      { "type": "field",
        "qname": "mustUnderstand",
        "return": "Boolean",
        "namespace": "public",
        "bindable": [],
        "details": [],
        "deprecated": {},
          "description": "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.",
        "tags": [
        {  "tagName": "playerversion",
               "values": ["Flash 9", "AIR 1.1"]},
            {  "tagName": "productversion",
               "values": ["Flex 3"]},
            {  "tagName": "langversion",
               "values": ["3.0"]}  ]},
      { "type": "field",
        "qname": "role",
        "return": "String",
        "namespace": "public",
        "bindable": [],
        "details": [],
        "deprecated": {},
          "description": "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 <code>actor</code> for the SOAP header.",
        "tags": [
        {  "tagName": "playerversion",
               "values": ["Flash 9", "AIR 1.1"]},
            {  "tagName": "productversion",
               "values": ["Flex 3"]},
            {  "tagName": "langversion",
               "values": ["3.0"]}  ]}]
  }