asdoc/mx/rpc/xml/IXMLEncoder.js.json

{ "type": "interface",
  "qname": "mx.rpc.xml.IXMLEncoder",
    "description": "Encodes an ActionScript object graph to XML based on an XML schema.",
  "tags": [
  {  "tagName": "playerversion",
         "values": ["Flash 9", "AIR 1.1"]},
      {  "tagName": "productversion",
         "values": ["Flex 3"]},
      {  "tagName": "langversion",
         "values": ["3.0"]}  ],
  "members": [
  { "type": "method",
    "qname": "encode",
    "namespace": "public",
    "bindable": [],
    "details": [],
    "deprecated": {},
      "description": "Encodes an ActionScript value as XML.   describes how to encode the value, or the name to be used for the encoded XML node when a type parameter is also specified.  <code>complexType</code> definition that describes how to encode the value.  schema to describe how to encode this value, a custom element definition can be provided.",
    "tags": [
    {  "tagName": "param",
           "values": ["value The ActionScript value to encode as XML.", "name The QName of an XML Schema <code>element</code> that", "type The QName of an XML Schema <code>simpleType</code> or", "definition If neither a top-level element nor type exists in the"]},
        {  "tagName": "playerversion",
           "values": ["Flash 9", "AIR 1.1"]},
        {  "tagName": "productversion",
           "values": ["Flex 3"]},
        {  "tagName": "return",
           "values": ["Returns an XML encoding of the given ActionScript value."]},
        {  "tagName": "langversion",
           "values": ["3.0"]}  ],
      "return": "XMLList",
      "params": [{ "name": "value", "type": "*"},
    { "name": "name", "type": "QName"},
    { "name": "type", "type": "QName"},
    { "name": "definition", "type": "XML"}]}
  ,
  { "type": "method",
    "qname": "reset",
    "namespace": "public",
    "bindable": [],
    "details": [],
    "deprecated": {},
      "description": "Resets the encoder to its initial state, including resetting any Schema scope to the top level.",
    "tags": [
    {  "tagName": "playerversion",
           "values": ["Flash 9", "AIR 1.1"]},
        {  "tagName": "productversion",
           "values": ["Flex 3"]},
        {  "tagName": "langversion",
           "values": ["3.0"]}  ],
      "return": "void",
      "params": []}
  ,
  { "type": "accessor",
    "access": "read-write",
    "return": "Function",
    "qname": "xmlSpecialCharsFilter",
    "namespace": "public",
    "bindable": [],
    "details": [],
    "deprecated": {},
      "description": "The function to be used to escape XML special characters before encoding any simple content.",
    "tags": [
    {  "tagName": "playerversion",
           "values": ["Flash 9", "AIR 1.1"]},
        {  "tagName": "productversion",
           "values": ["Flex 3"]},
        {  "tagName": "langversion",
           "values": ["3.0"]}  ]},
  { "type": "accessor",
    "access": "read-write",
    "return": "Boolean",
    "qname": "strictNillability",
    "namespace": "public",
    "bindable": [],
    "details": [],
    "deprecated": {},
      "description": "When strictNillability is set to <code>true</code>, null values are encoded according to XML Schema rules (requires nillable=true to be set in the definition). When strictNillability is set to <code>false</code>, null values are always encoded with the <code>xsi:nil=&quot;true&quot;</code> attribute. The default is <code>false</code>.",
    "tags": [
    {  "tagName": "playerversion",
           "values": ["Flash 9", "AIR 1.1"]},
        {  "tagName": "productversion",
           "values": ["Flex 3"]},
        {  "tagName": "langversion",
           "values": ["3.0"]}  ]}]
  }