asdoc/mx/rpc/CallResponder.swf.json

{ "type": "class",
  "qname": "mx.rpc.CallResponder",
  "baseClassname": "flash.events.EventDispatcher"
  ,
    "description": "This component helps you manage the results for asynchronous calls made from RPC based services, typically from MXML components.  While each individual service and operation dispatches result and fault events, it is common to need to use the same operation in different parts of your application.  Using one event listener or lastResult value across the entire application can be awkward.  Rather than creating two service components which refer to the same service, you can use a simple lightweight CallResponder to manage the event listeners and lastResult value for a specific invocation of a service. <p> You set the token property of this component to the AsyncToken returned by the service.  You can then add event listeners on this component instead of having to add them to each AsyncToken returned.   This component also maintains the lastResult property which is a copy of the value returned by the last successful result event dispatched by a token monitored by this service.  Though you can bind to either the <code>callResponder.token.result</code> or <code>callResponder.lastResult</code>, the latter will be preserved while a second call to the same service is in progress while the former will be reset as soon as a new service invocation is started. </p>",
  "tags": [
  {  "tagName": "playerversion",
         "values": ["Flash 9", "AIR 1.1"]},
      {  "tagName": "productversion",
         "values": ["Flex 3"]},
      {  "tagName": "langversion",
         "values": ["3.0"]}  ],
  "members": [
  { "type": "accessor",
        "access": "read-write",
        "return": "mx.rpc.AsyncToken",
        "qname": "token",
        "namespace": "public",
        "bindable": [],
        "details": [],
        "deprecated": {},
          "description": "Each CallResponder dispatches result and fault events received from a single token.  This property value specifies that token.  You typically set this property to the AsyncToken object returned by the service.",
        "tags": [
        {  "tagName": "playerversion",
               "values": ["Flash 9", "AIR 1.1"]},
            {  "tagName": "productversion",
               "values": ["Flex 3"]},
            {  "tagName": "langversion",
               "values": ["3.0"]}  ]},
      { "type": "method",
        "qname": "result",
        "namespace": "public",
        "bindable": [],
        "details": [],
        "deprecated": {},
          "description": "This method is called by the AsyncToken when it wants to deliver a <code>ResultEvent</code> to the CallResponder.  You do not call this method directly.",
        "tags": [
        {  "tagName": "param",
               "values": ["data The ResultEvent delivered by the AsyncToken"]},
            {  "tagName": "playerversion",
               "values": ["Flash 9", "AIR 1.1"]},
            {  "tagName": "productversion",
               "values": ["Flex 3"]},
            {  "tagName": "langversion",
               "values": ["3.0"]}  ],
          "return": "void",
          "params": [{ "name": "data", "type": "Object"}]}
      ,
      { "type": "method",
        "qname": "fault",
        "namespace": "public",
        "bindable": [],
        "details": [],
        "deprecated": {},
          "description": "This method is called by the AsyncToken when it wants to deliver a <code>FaultEvent</code> to the CallResponder.  You do not call this method directly.",
        "tags": [
        {  "tagName": "param",
               "values": ["data The FaultEvent delivered by the AsyncToken"]},
            {  "tagName": "playerversion",
               "values": ["Flash 9", "AIR 1.1"]},
            {  "tagName": "productversion",
               "values": ["Flex 3"]},
            {  "tagName": "langversion",
               "values": ["3.0"]}  ],
          "return": "void",
          "params": [{ "name": "data", "type": "Object"}]}
      ,
      { "type": "field",
        "qname": "lastResult",
        "return": "*",
        "namespace": "public",
        "bindable": [],
        "details": [],
        "deprecated": {},
          "description": "This property stores the result property of the token each time it delivers a successful result.  You can bind to or access this property instead of the token.result property to keep your code from seeing that value cleared out on the second and subsequent call to a particular service method.  Additionally, if a fault occurs this value will still be set to the last successful result returned by a token monitored by this CallResponder.",
        "tags": [
        {  "tagName": "playerversion",
               "values": ["Flash 9", "AIR 1.1"]},
            {  "tagName": "productversion",
               "values": ["Flex 3"]},
            {  "tagName": "langversion",
               "values": ["3.0"]}  ]}]
  ,
  "events": [
  { "qname": "result",
        "type": "mx.rpc.events.ResultEvent"
      ,
          "description": "Dispatched when an Operation invocation successfully returns.",
        "tags": [
        {  "tagName": "playerversion",
               "values": ["Flash 9", "AIR 1.1"]},
            {  "tagName": "eventType",
               "values": ["mx.rpc.events.ResultEvent.RESULT"]},
            {  "tagName": "productversion",
               "values": ["Flex 3"]},
            {  "tagName": "langversion",
               "values": ["3.0"]}  ]},
      { "qname": "fault",
        "type": "mx.rpc.events.FaultEvent"
      ,
          "description": "Dispatched when an Operation call fails.",
        "tags": [
        {  "tagName": "playerversion",
               "values": ["Flash 9", "AIR 1.1"]},
            {  "tagName": "eventType",
               "values": ["mx.rpc.events.FaultEvent.FAULT"]},
            {  "tagName": "productversion",
               "values": ["Flex 3"]},
            {  "tagName": "langversion",
               "values": ["3.0"]}  ]}]
  }