asdoc/org/apache/royale/net/remoting/messages/AsyncMessage.js.json

{ "type": "class",
  "qname": "org.apache.royale.net.remoting.messages.AsyncMessage",
  "baseClassname": "org.apache.royale.net.remoting.messages.AbstractMessage"
  ,
    "description": "AsyncMessage is the base class for all asynchronous messages. Note: readExternal and writeExternal methods compile but are not tested and maybe not work but is an initial work",
  "tags": [
  {  "tagName": "playerversion",
         "values": ["Flash 9", "AIR 1.1"]},
      {  "tagName": "productversion",
         "values": ["BlazeDS 4", "LCDS 3"]},
      {  "tagName": "langversion",
         "values": ["3.0"]}  ],
  "members": [
  { "type": "field",
        "qname": "SUBTOPIC_HEADER",
        "return": "String",
        "namespace": "public",
        "bindable": [],
        "details": ["static"],
        "deprecated": {},
          "description": "Messages sent by a MessageAgent with a defined <code>subtopic</code> property indicate their target subtopic in this header.",
        "tags": [
        {  "tagName": "playerversion",
               "values": ["Flash 9", "AIR 1.1"]},
            {  "tagName": "productversion",
               "values": ["BlazeDS 4", "LCDS 3"]},
            {  "tagName": "langversion",
               "values": ["3.0"]}  ]},
      { "type": "method",
        "qname": "org.apache.royale.net.remoting.messages.AsyncMessage",
        "namespace": "",
        "bindable": [],
        "details": [],
        "deprecated": {},
          "description": "Constructs an instance of an AsyncMessage with an empty body and header. In addition to this default behavior, the body and the headers for the message may also be passed to the constructor as a convenience. An example of this invocation approach for the body is: <code>var msg:AsyncMessage = new AsyncMessage(&quot;Body text&quot;);</code> An example that provides both the body and headers is: <code>var msg:AsyncMessage = new AsyncMessage(&quot;Body text&quot;, {&quot;customerHeader&quot;:&quot;customValue&quot;});</code>",
        "tags": [
        {  "tagName": "param",
               "values": ["body The optional body to assign to the message.", "headers The optional headers to assign to the message."]},
            {  "tagName": "playerversion",
               "values": ["Flash 9", "AIR 1.1"]},
            {  "tagName": "productversion",
               "values": ["BlazeDS 4", "LCDS 3"]},
            {  "tagName": "langversion",
               "values": ["3.0"]}  ],
          "return": "",
          "params": [{ "name": "body", "type": "Object"},
        { "name": "headers", "type": "Object"}]}
      ,
      { "type": "accessor",
        "access": "read-write",
        "return": "String",
        "qname": "correlationId",
        "namespace": "public",
        "bindable": [],
        "details": [],
        "deprecated": {},
          "description": "Provides access to the correlation id of the message. Used for acknowledgement and for segmentation of messages. The <code>correlationId</code> contains the <code>messageId</code> of the previous message that this message refers to.",
        "tags": [
        {  "tagName": "see",
               "values": ["mx.messaging.messages.AbstractMessage#messageId"]},
            {  "tagName": "playerversion",
               "values": ["Flash 9", "AIR 1.1"]},
            {  "tagName": "productversion",
               "values": ["BlazeDS 4", "LCDS 3"]},
            {  "tagName": "langversion",
               "values": ["3.0"]}  ]}]
  }