asdoc/mx/rpc/AsyncToken.swf.json

{ "type": "class",
  "qname": "mx.rpc.AsyncToken",
  "baseClassname": "org.apache.royale.events.EventDispatcher"
  ,
    "description": "This class provides a place to set additional or token-level data for asynchronous RPC operations.  It also allows an IResponder to be attached for an individual call. The AsyncToken can be referenced in <code>ResultEvent</code> and <code>FaultEvent</code> from the <code>token</code> property.",
  "tags": [
  {  "tagName": "playerversion",
         "values": ["Flash 9", "AIR 1.1"]},
      {  "tagName": "productversion",
         "values": ["Flex 3"]},
      {  "tagName": "langversion",
         "values": ["3.0"]}  ],
  "members": [
  { "type": "method",
        "qname": "mx.rpc.AsyncToken",
        "namespace": "",
        "bindable": [],
        "details": [],
        "deprecated": {},
          "description": "Constructs an instance of the token with the specified message.",
        "tags": [
        {  "tagName": "param",
               "values": ["message The message with which the token is associated."]},
            {  "tagName": "playerversion",
               "values": ["Flash 9", "AIR 1.1"]},
            {  "tagName": "productversion",
               "values": ["Flex 3"]},
            {  "tagName": "langversion",
               "values": ["3.0"]}  ],
          "return": "",
          "params": [{ "name": "message", "type": "mx.messaging.messages.IMessage"}]}
      ,
      { "type": "accessor",
        "access": "read-only",
        "return": "mx.messaging.messages.IMessage",
        "qname": "message",
        "namespace": "public",
        "bindable": [],
        "details": [],
        "deprecated": {},
          "description": "Provides access to the associated message.",
        "tags": [
        {  "tagName": "playerversion",
               "values": ["Flash 9", "AIR 1.1"]},
            {  "tagName": "productversion",
               "values": ["Flex 3"]},
            {  "tagName": "langversion",
               "values": ["3.0"]}  ]},
      { "type": "accessor",
        "access": "read-only",
        "return": "Array",
        "qname": "responders",
        "namespace": "public",
        "bindable": [],
        "details": [],
        "deprecated": {},
          "description": "An array of IResponder handlers that will be called when the asynchronous request completes.  Eaxh responder assigned to the token will have its  <code>result</code> or <code>fault</code> function called passing in the matching event <i>before</i> the operation or service dispatches the event itself.  A developer can prevent the service from subsequently dispatching the event by calling <code>event.preventDefault()</code>.  Note that this will not prevent the service or operation's <code>result</code> property from being assigned.",
        "tags": [
        {  "tagName": "playerversion",
               "values": ["Flash 9", "AIR 1.1"]},
            {  "tagName": "productversion",
               "values": ["Flex 3"]},
            {  "tagName": "langversion",
               "values": ["3.0"]}  ]},
      { "type": "accessor",
        "access": "read-only",
        "return": "Object",
        "qname": "result",
        "namespace": "public",
        "bindable": ["propertyChange"],
        "details": [],
        "deprecated": {},
          "description": "The result that was returned by the associated RPC call. Once the result property on the token has been assigned it will be strictly equal to the result property on the associated ResultEvent.",
        "tags": [
        {  "tagName": "playerversion",
               "values": ["Flash 9", "AIR 1.1"]},
            {  "tagName": "productversion",
               "values": ["Flex 3"]},
            {  "tagName": "langversion",
               "values": ["3.0"]}  ]},
      { "type": "method",
        "qname": "addResponder",
        "namespace": "public",
        "bindable": [],
        "details": [],
        "deprecated": {},
          "description": "Adds a responder to an Array of responders. The object assigned to the responder parameter must implement <code>mx.rpc.IResponder</code>.",
        "tags": [
        {  "tagName": "see",
               "values": ["mx.rpc.IResponder"]},
            {  "tagName": "param",
               "values": ["responder A handler which will be called when the asynchronous request completes."]},
            {  "tagName": "playerversion",
               "values": ["Flash 9", "AIR 1.1"]},
            {  "tagName": "productversion",
               "values": ["Flex 3"]},
            {  "tagName": "langversion",
               "values": ["3.0"]}  ],
          "return": "void",
          "params": [{ "name": "responder", "type": "mx.rpc.IResponder"}]}
      ,
      { "type": "method",
        "qname": "hasResponder",
        "namespace": "public",
        "bindable": [],
        "details": [],
        "deprecated": {},
          "description": "Determines if this token has at least one <code>mx.rpc.IResponder</code> registered.",
        "tags": [
        {  "tagName": "playerversion",
               "values": ["Flash 9", "AIR 1.1"]},
            {  "tagName": "productversion",
               "values": ["Flex 3"]},
            {  "tagName": "return",
               "values": ["true if at least one responder has been added to this token."]},
            {  "tagName": "langversion",
               "values": ["3.0"]}  ],
          "return": "Boolean",
          "params": []}
      ]
  ,
  "events": [
  { "qname": "propertyChange",
        "type": "mx.events.PropertyChangeEvent"
      ,
          "description": "Dispatched when a property of the channel set changes.",
        "tags": [
        {  "tagName": "playerversion",
               "values": ["Flash 9", "AIR 1.1"]},
            {  "tagName": "eventType",
               "values": ["mx.events.PropertyChangeEvent.PROPERTY_CHANGE"]},
            {  "tagName": "productversion",
               "values": ["Flex 3"]},
            {  "tagName": "langversion",
               "values": ["3.0"]}  ]}]
  }