asdoc/org/apache/royale/net/remoting/messages/IMessage.js.json

{ "type": "interface",
  "qname": "org.apache.royale.net.remoting.messages.IMessage",
    "description": "This interface defines the contract for message objects.",
  "tags": [
  {  "tagName": "playerversion",
         "values": ["Flash 9", "AIR 1.1"]},
      {  "tagName": "productversion",
         "values": ["BlazeDS 4", "LCDS 3"]},
      {  "tagName": "langversion",
         "values": ["3.0"]}  ],
  "members": [
  { "type": "accessor",
    "access": "read-write",
    "return": "Object",
    "qname": "body",
    "namespace": "public",
    "bindable": [],
    "details": [],
    "deprecated": {},
      "description": "The body of a message contains the specific data that needs to be delivered to the remote destination.",
    "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": "String",
    "qname": "clientId",
    "namespace": "public",
    "bindable": [],
    "details": [],
    "deprecated": {},
      "description": "The clientId indicates which client 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-write",
    "return": "String",
    "qname": "destination",
    "namespace": "public",
    "bindable": [],
    "details": [],
    "deprecated": {},
      "description": "The message destination.",
    "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": "Object",
    "qname": "headers",
    "namespace": "public",
    "bindable": [],
    "details": [],
    "deprecated": {},
      "description": "Provides access to the headers of the message. The headers of a message are an associative array where the key is the header name. This property provides access to specialized meta information for the specific message instance.",
    "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": "String",
    "qname": "messageId",
    "namespace": "public",
    "bindable": [],
    "details": [],
    "deprecated": {},
      "description": "The unique id for the message. The message id can be used to correlate a response to the original request message in request-response messaging scenarios.",
    "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": "Number",
    "qname": "timestamp",
    "namespace": "public",
    "bindable": [],
    "details": [],
    "deprecated": {},
      "description": "Provides access to the time stamp for the message. A time stamp is the date and time that the message was sent. The time stamp is used for tracking the message through the system, ensuring quality of service levels and providing a mechanism for expiration.",
    "tags": [
    {  "tagName": "see",
           "values": ["#timeToLive"]},
        {  "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": "Number",
    "qname": "timeToLive",
    "namespace": "public",
    "bindable": [],
    "details": [],
    "deprecated": {},
      "description": "The time to live value of a message indicates how long the message should be considered valid and deliverable. This value works in conjunction with the <code>timestamp</code> value. Time to live is the number of milliseconds that this message remains valid starting from the specified <code>timestamp</code> value. For example, if the <code>timestamp</code> value is 04/05/05 1:30:45 PST and the <code>timeToLive</code> value is 5000, then this message will expire at 04/05/05 1:30:50 PST. Once a message expires it will not be delivered to any other clients.",
    "tags": [
    {  "tagName": "playerversion",
           "values": ["Flash 9", "AIR 1.1"]},
        {  "tagName": "productversion",
           "values": ["BlazeDS 4", "LCDS 3"]},
        {  "tagName": "langversion",
           "values": ["3.0"]}  ]},
  { "type": "method",
    "qname": "toString",
    "namespace": "public",
    "bindable": [],
    "details": [],
    "deprecated": {},
      "description": "This method will return a string representation of the message.",
    "tags": [
    {  "tagName": "playerversion",
           "values": ["Flash 9", "AIR 1.1"]},
        {  "tagName": "productversion",
           "values": ["BlazeDS 4", "LCDS 3"]},
        {  "tagName": "return",
           "values": ["String representation of the message."]},
        {  "tagName": "langversion",
           "values": ["3.0"]}  ],
      "return": "String",
      "params": []}
  ]
  }