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

{ "type": "interface",
  "qname": "mx.rpc.soap.ISOAPEncoder",
"baseInterfaceNames": [
"mx.rpc.xml.IXMLEncoder"]
,
    "description": "An ISOAPEncoder is used to create SOAP 1.1 formatted requests for a web service operation. A WSDLOperation provides the definition of how a SOAP request should be formatted and therefore must be set before a call is made to encode().",
  "members": [
  { "type": "accessor",
    "access": "read-write",
    "return": "Boolean",
    "qname": "ignoreWhitespace",
    "namespace": "public",
    "bindable": [],
    "details": [],
    "deprecated": {},
      "description": "Determines whether the encoder should ignore whitespace when constructing an XML representation of a SOAP request. The default should be <code>true</code> and thus whitespace not preserved. If an XML Schema type definition specifies a <code>whiteSpace</code> restriction set to <code>preserve</code> then ignoreWhitespace must first be set to false. Conversely, if a type <code>whiteSpace</code> restriction is set to <code>replace</code> or <code>collapse</code> then that setting will be honored even if ignoreWhitespace is set to <code>false</code>."},
  { "type": "accessor",
    "access": "read-write",
    "return": "mx.rpc.wsdl.WSDLOperation",
    "qname": "wsdlOperation",
    "namespace": "public",
    "bindable": [],
    "details": [],
    "deprecated": {},
      "description": "A WSDLOperation defines the SOAP binding styles and specifies how to encode a SOAP request."},
  { "type": "method",
    "qname": "encodeRequest",
    "namespace": "public",
    "bindable": [],
    "details": [],
    "deprecated": {},
      "description": "Creates a SOAP-encoded request to an operation from the given input parameters and headers.",
    "tags": [
    {  "tagName": "param",
           "values": ["args values to be encoded in the body of the SOAP request.", "headers header values to be encoded in the SOAP envelope."]},
        {  "tagName": "return",
           "values": ["SOAP-encoded XML representation of the passed in arguments and headers."]}  ],
      "return": "XML",
      "params": [{ "name": "args", "type": "*"},
    { "name": "headers", "type": "Array"}]}
  ]
  }