asdoc/mx/messaging/config/ServerConfig.swf.json

{ "type": "class",
  "qname": "mx.messaging.config.ServerConfig",
  "baseClassname": ""
  ,
    "description": "This class provides access to the server messaging configuration information. This class encapsulates information from the services-config.xml file on the client and is used by the messaging system to provide configured ChannelSets and Channels to the messaging framework.  <p>The XML source is provided during the compilation process. However, there is currently no internal restriction preventing the acquisition of this XML data by other means, such as network, local file system, or shared object at runtime.</p>",
  "tags": [
  {  "tagName": "playerversion",
         "values": ["Flash 9", "AIR 1.1"]},
      {  "tagName": "productversion",
         "values": ["BlazeDS 4", "LCDS 3"]},
      {  "tagName": "langversion",
         "values": ["3.0"]},
      {  "tagName": "royalesuppresspublicvarwarning",
         "values": []}  ],
  "members": [
  { "type": "accessor",
        "access": "read-write",
        "return": "XML",
        "qname": "xml",
        "namespace": "public",
        "bindable": [],
        "details": ["static"],
        "deprecated": {},
          "description": "The XML configuration; this value must contain the relevant portions of the &lt;services&gt; tag from the services-config.xml file.",
        "tags": [
        {  "tagName": "playerversion",
               "values": ["Flash 9", "AIR 1.1"]},
            {  "tagName": "productversion",
               "values": ["BlazeDS 4", "LCDS 3"]},
            {  "tagName": "langversion",
               "values": ["3.0"]}  ]},
      { "type": "method",
        "qname": "checkChannelConsistency",
        "namespace": "public",
        "bindable": [],
        "details": ["static"],
        "deprecated": {},
          "description": "This method ensures that the destinations specified contain identical channel definitions. If the channel definitions between the two destinations specified are not identical this method will throw an ArgumentError.  destinations aren't identical.",
        "tags": [
        {  "tagName": "param",
               "values": ["destinationA:String first destination to compare against", "destinationB:String second destination to compare channels with"]},
            {  "tagName": "throw",
               "values": ["ArgumentError if the channel definitions of the specified"]},
            {  "tagName": "playerversion",
               "values": ["Flash 9", "AIR 1.1"]},
            {  "tagName": "productversion",
               "values": ["BlazeDS 4", "LCDS 3"]},
            {  "tagName": "langversion",
               "values": ["3.0"]}  ],
          "return": "void",
          "params": [{ "name": "destinationA", "type": "String"},
        { "name": "destinationB", "type": "String"}]}
      ,
      { "type": "method",
        "qname": "getChannel",
        "namespace": "public",
        "bindable": [],
        "details": ["static"],
        "deprecated": {},
          "description": "Returns a shared instance of the configured Channel.   fashion; otherwise false.",
        "tags": [
        {  "tagName": "param",
               "values": ["id The id of the desired Channel.", "clustered True if the Channel will be used in a clustered"]},
            {  "tagName": "playerversion",
               "values": ["Flash 9", "AIR 1.1"]},
            {  "tagName": "productversion",
               "values": ["BlazeDS 4", "LCDS 3"]},
            {  "tagName": "throws",
               "values": ["mx.messaging.errors.InvalidChannelError If no Channel has the specified id."]},
            {  "tagName": "return",
               "values": ["The Channel instance."]},
            {  "tagName": "langversion",
               "values": ["3.0"]}  ],
          "return": "mx.messaging.Channel",
          "params": [{ "name": "id", "type": "String"},
        { "name": "clustered", "type": "Boolean"}]}
      ,
      { "type": "method",
        "qname": "getChannelSet",
        "namespace": "public",
        "bindable": [],
        "details": ["static"],
        "deprecated": {},
          "description": "Returns a shared ChannelSet for use with the specified destination belonging to the service that handles the specified message type.    does not have channels and the application did not define default channels.",
        "tags": [
        {  "tagName": "param",
               "values": ["destinationId The target destination id."]},
            {  "tagName": "playerversion",
               "values": ["Flash 9", "AIR 1.1"]},
            {  "tagName": "productversion",
               "values": ["BlazeDS 4", "LCDS 3"]},
            {  "tagName": "throws",
               "values": ["mx.messaging.errors.InvalidDestinationError If the specified destination"]},
            {  "tagName": "return",
               "values": ["The ChannelSet."]},
            {  "tagName": "langversion",
               "values": ["3.0"]}  ],
          "return": "mx.messaging.ChannelSet",
          "params": [{ "name": "destinationId", "type": "String"}]}
      ,
      { "type": "method",
        "qname": "getProperties",
        "namespace": "public",
        "bindable": [],
        "details": ["static"],
        "deprecated": {},
          "description": "Returns the property information for the specified destination",
        "tags": [
        {  "tagName": "param",
               "values": ["destinationId The id of the desired destination."]},
            {  "tagName": "playerversion",
               "values": ["Flash 9", "AIR 1.1"]},
            {  "tagName": "productversion",
               "values": ["BlazeDS 4", "LCDS 3"]},
            {  "tagName": "throws",
               "values": ["mx.messaging.errors.InvalidDestinationError If the specified destination is not found."]},
            {  "tagName": "return",
               "values": ["XMLList containing the &lt;property&gt; tag information."]},
            {  "tagName": "langversion",
               "values": ["3.0"]}  ],
          "return": "XMLList",
          "params": [{ "name": "destinationId", "type": "String"}]}
      ,
      { "type": "method",
        "qname": "channelSetMatchesDestinationConfig",
        "namespace": "mx_internal",
        "bindable": [],
        "details": ["static"],
        "deprecated": {},
          "description": "This method returns true iff the channelset specified has channels with ids or uris that match those found in the destination specified.",
        "tags": [
        {  "tagName": "playerversion",
               "values": ["Flash 9", "AIR 1.1"]},
            {  "tagName": "productversion",
               "values": ["BlazeDS 4", "LCDS 3"]},
            {  "tagName": "langversion",
               "values": ["3.0"]}  ],
          "return": "Boolean",
          "params": [{ "name": "channelSet", "type": "mx.messaging.ChannelSet"},
        { "name": "destination", "type": "String"}]}
      ]
  }