asdoc/mx/messaging/MessageResponder.js.json

{ "type": "class",
  "qname": "mx.messaging.MessageResponder",
  "baseClassname": "mx.net.Responder"
  ,
    "description": "The MessageResponder class handles a successful result or fault from a message destination. For each message that a Channel sends, the Channel creates a MessageResponder to handle the result. Upon a response, the Channel will invoke either the <code>result()</code> or <code>status()</code> callback on the MessageResponder. MessageResponder subclasses should override these methods to perform any necessary processing. For every response, whether a successful result or an error, the MessageResponder should invoke <code>acknowledge()</code> on its agent. If the response was a fault, the MessageResponder should also invoke <code>fault()</code> on its agent.",
  "tags": [
  {  "tagName": "playerversion",
         "values": ["Flash 9", "AIR 1.1"]},
      {  "tagName": "productversion",
         "values": ["BlazeDS 4", "LCDS 3"]},
      {  "tagName": "langversion",
         "values": ["3.0"]}  ],
  "members": [
  { "type": "method",
        "qname": "mx.messaging.MessageResponder",
        "namespace": "",
        "bindable": [],
        "details": [],
        "deprecated": {},
          "description": "Constructs a MessageResponder to handle the response for the specified Message for the specified MessageAgent.",
        "tags": [
        {  "tagName": "param",
               "values": ["agent The MessageAgent sending the Message.", "message The Message being sent.", "channel The Channel used to send."]},
            {  "tagName": "playerversion",
               "values": ["Flash 9", "AIR 1.1"]},
            {  "tagName": "productversion",
               "values": ["BlazeDS 4", "LCDS 3"]},
            {  "tagName": "langversion",
               "values": ["3.0"]}  ],
          "return": "",
          "params": [{ "name": "agent", "type": "mx.messaging.MessageAgent"},
        { "name": "message", "type": "mx.messaging.messages.IMessage"},
        { "name": "channel", "type": "mx.messaging.Channel"}]}
      ,
      { "type": "accessor",
        "access": "read-only",
        "return": "mx.messaging.MessageAgent",
        "qname": "agent",
        "namespace": "public",
        "bindable": [],
        "details": [],
        "deprecated": {},
          "description": "Provides access to the MessageAgent that sent the message.",
        "tags": [
        {  "tagName": "playerversion",
               "values": ["Flash 9", "AIR 1.1"]},
            {  "tagName": "productversion",
               "values": ["BlazeDS 4", "LCDS 3"]},
            {  "tagName": "langversion",
               "values": ["3.0"]}  ]},
      { "type": "accessor",
        "access": "read-only",
        "return": "mx.messaging.Channel",
        "qname": "channel",
        "namespace": "public",
        "bindable": [],
        "details": [],
        "deprecated": {},
          "description": "Provides access to the Channel used to send the message.",
        "tags": [
        {  "tagName": "playerversion",
               "values": ["Flash 9", "AIR 1.1"]},
            {  "tagName": "productversion",
               "values": ["BlazeDS 4", "LCDS 3"]},
            {  "tagName": "langversion",
               "values": ["3.0"]}  ]},
      { "type": "accessor",
        "access": "read-write",
        "return": "mx.messaging.messages.IMessage",
        "qname": "message",
        "namespace": "public",
        "bindable": [],
        "details": [],
        "deprecated": {},
          "description": "Provides access to the sent Message.",
        "tags": [
        {  "tagName": "playerversion",
               "values": ["Flash 9", "AIR 1.1"]},
            {  "tagName": "productversion",
               "values": ["BlazeDS 4", "LCDS 3"]},
            {  "tagName": "langversion",
               "values": ["3.0"]}  ]},
      { "type": "method",
        "qname": "result",
        "namespace": "public",
        "bindable": [],
        "details": ["final"],
        "deprecated": {},
          "description": "Called by the channel that created this MessageResponder when a response returns from the destination. This method performs core result processing and then invokes the <code>resultHandler()</code> method that subclasses may override to perform any necessary custom processing.",
        "tags": [
        {  "tagName": "param",
               "values": ["message The result Message returned by the destination."]},
            {  "tagName": "playerversion",
               "values": ["Flash 9", "AIR 1.1"]},
            {  "tagName": "productversion",
               "values": ["BlazeDS 4", "LCDS 3"]},
            {  "tagName": "langversion",
               "values": ["3.0"]}  ],
          "return": "void",
          "params": [{ "name": "message", "type": "mx.messaging.messages.IMessage"}]}
      ,
      { "type": "method",
        "qname": "status",
        "namespace": "public",
        "bindable": [],
        "details": ["final"],
        "deprecated": {},
          "description": "Called by the channel that created this MessageResponder when a fault response returns from the destination. This method performs core result processing and then invokes the <code>statusHandler()</code> method that subclasses may override to perform any necessary custom processing.",
        "tags": [
        {  "tagName": "param",
               "values": ["message The fault Message returned by the destination."]},
            {  "tagName": "playerversion",
               "values": ["Flash 9", "AIR 1.1"]},
            {  "tagName": "productversion",
               "values": ["BlazeDS 4", "LCDS 3"]},
            {  "tagName": "langversion",
               "values": ["3.0"]}  ],
          "return": "void",
          "params": [{ "name": "message", "type": "mx.messaging.messages.IMessage"}]}
      ,
      { "type": "method",
        "qname": "createRequestTimeoutErrorMessage",
        "namespace": "protected",
        "bindable": [],
        "details": [],
        "deprecated": {},
          "description": "Constructs an ErrorMessage that can be passed to the associated MessageAgent's callbacks upon a request timeout.  MessageAgent's callbacks upon a request timeout.",
        "tags": [
        {  "tagName": "playerversion",
               "values": ["Flash 9", "AIR 1.1"]},
            {  "tagName": "productversion",
               "values": ["BlazeDS 4", "LCDS 3"]},
            {  "tagName": "return",
               "values": ["Returns an ErrorMessage that can be passed to the associated"]},
            {  "tagName": "langversion",
               "values": ["3.0"]}  ],
          "return": "mx.messaging.messages.ErrorMessage",
          "params": []}
      ,
      { "type": "method",
        "qname": "resultHandler",
        "namespace": "protected",
        "bindable": [],
        "details": [],
        "deprecated": {},
          "description": "Subclasses must override this method to perform custom processing of the result and invoke the proper callbacks on the associated MessageAgent.",
        "tags": [
        {  "tagName": "param",
               "values": ["message The result Message returned by the destination."]},
            {  "tagName": "playerversion",
               "values": ["Flash 9", "AIR 1.1"]},
            {  "tagName": "productversion",
               "values": ["BlazeDS 4", "LCDS 3"]},
            {  "tagName": "langversion",
               "values": ["3.0"]}  ],
          "return": "void",
          "params": [{ "name": "message", "type": "mx.messaging.messages.IMessage"}]}
      ,
      { "type": "method",
        "qname": "requestTimedOut",
        "namespace": "protected",
        "bindable": [],
        "details": [],
        "deprecated": {},
          "description": "Subclasses must override this method to handle a request timeout and invoke the proper callbacks on the associated MessageAgent.",
        "tags": [
        {  "tagName": "playerversion",
               "values": ["Flash 9", "AIR 1.1"]},
            {  "tagName": "productversion",
               "values": ["BlazeDS 4", "LCDS 3"]},
            {  "tagName": "langversion",
               "values": ["3.0"]}  ],
          "return": "void",
          "params": []}
      ,
      { "type": "method",
        "qname": "statusHandler",
        "namespace": "protected",
        "bindable": [],
        "details": [],
        "deprecated": {},
          "description": "Subclasses must override this method to perform custom processing of the status and invoke the proper callbacks on the associated MessageAgent.",
        "tags": [
        {  "tagName": "param",
               "values": ["message The fault Message returned by the destination."]},
            {  "tagName": "playerversion",
               "values": ["Flash 9", "AIR 1.1"]},
            {  "tagName": "productversion",
               "values": ["BlazeDS 4", "LCDS 3"]},
            {  "tagName": "langversion",
               "values": ["3.0"]}  ],
          "return": "void",
          "params": [{ "name": "message", "type": "mx.messaging.messages.IMessage"}]}
      ]
  }