asdoc/org/apache/royale/net/remoting/messages/RoyaleClient.swf.json

{ "type": "class",
  "qname": "org.apache.royale.net.remoting.messages.RoyaleClient",
  "baseClassname": "org.apache.royale.events.EventDispatcher"
  ,
    "description": "Singleton class that stores the global Id for this instance that is server assigned when the client makes its initial connection to the server.",
  "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": "getInstance",
        "namespace": "public",
        "bindable": [],
        "details": ["static"],
        "deprecated": {},
          "description": "Returns the sole instance of this singleton class, creating it if it does not already exist.  creating it if it does not already exist.",
        "tags": [
        {  "tagName": "playerversion",
               "values": ["Flash 9", "AIR 1.1"]},
            {  "tagName": "productversion",
               "values": ["BlazeDS 4", "LCDS 3"]},
            {  "tagName": "return",
               "values": ["Returns the sole instance of this singleton class,"]},
            {  "tagName": "langversion",
               "values": ["3.0"]}  ],
          "return": "org.apache.royale.net.remoting.messages.RoyaleClient",
          "params": []}
      ,
      { "type": "accessor",
        "access": "read-write",
        "return": "String",
        "qname": "id",
        "namespace": "public",
        "bindable": [],
        "details": [],
        "deprecated": {},
          "description": "The global RoyaleClient Id for this this instance. This value is server assigned and is set as part of the Channel connect process. Once set, it will not change for the duration of the instance's lifespan. If no Channel has connected to a server this value is null.",
        "tags": [
        {  "tagName": "playerversion",
               "values": ["Flash 9", "AIR 1.1"]},
            {  "tagName": "productversion",
               "values": ["BlazeDS 4", "LCDS 3"]},
            {  "tagName": "langversion",
               "values": ["3.0"]}  ]}]
  }