| <!DOCTYPE HTML PUBLIC "-//W3C//DTD HTML 4.01 Transitional//EN" "http://www.w3.org/TR/html4/loose.dtd"><!-- saved from url=(0014)about:internet --><html><head><meta http-equiv="Content-Type" content="text/html; charset=UTF-8"><link rel="stylesheet" href="../../../style.css" type="text/css" media="screen"><link rel="stylesheet" href="../../../print.css" type="text/css" media="print"><link rel="stylesheet" href="../../../override.css" type="text/css"><meta name="keywords" content="IMessage,mx.messaging.messages.IMessage,ADD_SUBSCRIPTIONS,AUTHENTICATION_MESSAGE_REF_TYPE,CLIENT_PING_OPERATION,CLIENT_SYNC_OPERATION,CLUSTER_REQUEST_OPERATION,CONTENT_TYPE_FORM,CONTENT_TYPE_SOAP_XML,CONTENT_TYPE_XML,CREDENTIALS_CHARSET_HEADER,DELETE_METHOD,DESTINATION_CLIENT_ID_HEADER,DISCONNECT_OPERATION,ENDPOINT_HEADER,ERROR_HINT_HEADER,FLEX_CLIENT_ID_HEADER,GET_METHOD,HEAD_METHOD,HEARTBEAT_HEADER,LOGIN_OPERATION,LOGOUT_OPERATION,MAX_FREQUENCY_HEADER,MESSAGE_DELIVERY_IN_DOUBT,MESSAGING_VERSION,MULTI_SUBSCRIBE_OPERATION,NEEDS_CONFIG_HEADER,NO_OP_POLL_HEADER,OPTIONS_METHOD,POLL_OPERATION,POLL_WAIT_HEADER,POST_METHOD,PRESERVE_DURABLE_HEADER,PRIORITY_HEADER,PUT_METHOD,REMOTE_CREDENTIALS_CHARSET_HEADER,REMOTE_CREDENTIALS_HEADER,REMOVE_SUBSCRIPTIONS,REQUEST_TIMEOUT_HEADER,RETRYABLE_HINT_HEADER,SELECTOR_HEADER,SOAP_ACTION_HEADER,STATUS_CODE_HEADER,SUBSCRIBE_OPERATION,SUBSCRIPTION_INVALIDATE_OPERATION,SUBTOPIC_HEADER,SUBTOPIC_SEPARATOR,TRACE_METHOD,TRIGGER_CONNECT_OPERATION,UNKNOWN_OPERATION,UNSUBSCRIBE_OPERATION,body,body,clientId,clientId,clientReceiveTime,contentType,correlationId,destination,destination,extendedData,faultCode,faultDetail,faultString,headers,headers,httpHeaders,messageId,messageId,messageSize,method,networkRTT,operation,operation,originatingMessageSentTime,originatingMessageSize,pushOneWayTime,pushedMessageFlag,recordHeaders,responseMessageSize,rootCause,serverAdapterExternalTime,serverAdapterTime,serverNonAdapterTime,serverPollDelay,serverPrePushTime,serverProcessingTime,serverSendTime,source,timeToLive,timeToLive,timestamp,timestamp,totalPushTime,totalTime,url,getOperationAsString,getSOAPAction,getSmallMessage,prettyPrint,toString,toString,toString"><title>mx.messaging.messages.IMessage</title></head><body><script language="javascript" type="text/javascript" src="../../../asdoc.js"></script><script language="javascript" type="text/javascript" src="../../../help.js"></script><script language="javascript" type="text/javascript" src="../../../cookies.js"></script><script language="javascript" type="text/javascript"><!-- |
| asdocTitle = 'IMessage - ApacheFlex API Reference'; |
| var baseRef = '../../../'; |
| window.onload = configPage; |
| --></script> |
| <script type="text/javascript"> |
| scrollToNameAnchor(); |
| </script><table class="titleTable" cellpadding="0" cellspacing="0" id="titleTable" style="display:none"><tr><td class="titleTableTitle" align="left">Apache Flex 4.16.1 API Reference </td><td class="titleTableTopNav" align="right"><a href="../../../package-summary.html" onclick="loadClassListFrame('../../../all-classes.html')">All Packages</a> | <a href="../../../class-summary.html" onclick="loadClassListFrame('../../../all-classes.html')">All Classes</a> | <a href="../../../all-index-A.html" onclick="loadClassListFrame('../../../index-list.html')">Index</a> | <a id="framesLink1" href="../../../index.html?mx/messaging/messages/IMessage.html&mx/messaging/messages/class-list.html">Frames</a><a id="noFramesLink1" style="display:none" href="" onclick="parent.location=document.location"> No Frames </a></td><td class="titleTableLogo" align="right" rowspan="3"><img src="../../../images/logo.jpg" class="logoImage" alt="AdobeLogo" title="AdobeLogo"></td></tr><tr class="titleTableRow2"><td class="titleTableSubTitle" id="subTitle" align="left">IMessage</td><td class="titleTableSubNav" id="subNav" align="right"><a href="#propertySummary">Properties</a> | <a href="#methodSummary">Methods</a></td></tr><tr class="titleTableRow3"><td colspan="3"> </td></tr></table><script language="javascript" type="text/javascript" xml:space="preserve"> |
| <!-- |
| |
| if (!isEclipse() || window.name != ECLIPSE_FRAME_NAME) {titleBar_setSubTitle("IMessage"); titleBar_setSubNav(false,true,false,false,false,false,false,false,true,false,false ,false,false,false,false,false);} |
| --> |
| </script><div xmlns:fn="http://www.w3.org/2005/xpath-functions" class="MainContent"><table class="classHeaderTable" cellpadding="0" cellspacing="0"><tr><td class="classHeaderTableLabel">Package</td><td><a href="package-detail.html" onclick="javascript:loadClassListFrame('class-list.html')">mx.messaging.messages</a></td></tr><tr><td class="classHeaderTableLabel">Interface</td><td class="classSignature">public interface IMessage</td></tr><tr><td class="classHeaderTableLabel">Implementors</td><td> <a href="../../../mx/messaging/messages/AbstractMessage.html">AbstractMessage</a></td></tr></table><p></p><table cellpadding="0" cellspacing="0" border="0"><tr><td style="white-space:nowrap" valign="top"><b> Language Version : </b></td><td>ActionScript 3.0</td></tr></table><table cellpadding="0" cellspacing="0" border="0"><tr><td style="white-space:nowrap" valign="top"><b> Product Versions : </b></td><td>BlazeDS 4, LCDS 3</td></tr></table><table cellpadding="0" cellspacing="0" border="0"><tr><td style="white-space:nowrap" valign="top"><b> Runtime Versions : </b></td><td>Flash Player 9, AIR 1.1</td></tr></table><p></p><p></p><p></p><p></p> |
| This interface defines the contract for message objects. |
| |
| <p></p><br/><hr></div><a name="propertySummary"></a><div class="summarySection"><div class="summaryTableTitle">Public Properties</div><table cellspacing="0" cellpadding="3" class="summaryTable " id="summaryTableProperty"><tr><th> </th><th colspan="2">Property</th><th class="summaryTableOwnerCol">Defined By</th></tr><tr class=""><td class="summaryTablePaddingCol"> </td><td class="summaryTableInheritanceCol"> </td><td class="summaryTableSignatureCol"><a href="#body" class="signatureLink">body</a> : Object<div class="summaryTableDescription"> |
| The body of a message contains the specific data that needs to be |
| delivered to the remote destination.</div></td><td class="summaryTableOwnerCol">IMessage</td></tr><tr class=""><td class="summaryTablePaddingCol"> </td><td class="summaryTableInheritanceCol"> </td><td class="summaryTableSignatureCol"><a href="#clientId" class="signatureLink">clientId</a> : String<div class="summaryTableDescription"> |
| The clientId indicates which client sent the message.</div></td><td class="summaryTableOwnerCol">IMessage</td></tr><tr class=""><td class="summaryTablePaddingCol"> </td><td class="summaryTableInheritanceCol"> </td><td class="summaryTableSignatureCol"><a href="#destination" class="signatureLink">destination</a> : String<div class="summaryTableDescription"> |
| The message destination.</div></td><td class="summaryTableOwnerCol">IMessage</td></tr><tr class=""><td class="summaryTablePaddingCol"> </td><td class="summaryTableInheritanceCol"> </td><td class="summaryTableSignatureCol"><a href="#headers" class="signatureLink">headers</a> : Object<div class="summaryTableDescription"> |
| Provides access to the headers of the message.</div></td><td class="summaryTableOwnerCol">IMessage</td></tr><tr class=""><td class="summaryTablePaddingCol"> </td><td class="summaryTableInheritanceCol"> </td><td class="summaryTableSignatureCol"><a href="#messageId" class="signatureLink">messageId</a> : String<div class="summaryTableDescription"> |
| The unique id for the message.</div></td><td class="summaryTableOwnerCol">IMessage</td></tr><tr class=""><td class="summaryTablePaddingCol"> </td><td class="summaryTableInheritanceCol"> </td><td class="summaryTableSignatureCol"><a href="#timestamp" class="signatureLink">timestamp</a> : Number<div class="summaryTableDescription"> |
| Provides access to the time stamp for the message.</div></td><td class="summaryTableOwnerCol">IMessage</td></tr><tr class=""><td class="summaryTablePaddingCol"> </td><td class="summaryTableInheritanceCol"> </td><td class="summaryTableSignatureCol"><a href="#timeToLive" class="signatureLink">timeToLive</a> : Number<div class="summaryTableDescription"> |
| The time to live value of a message indicates how long the message |
| should be considered valid and deliverable.</div></td><td class="summaryTableOwnerCol">IMessage</td></tr></table></div><a name="methodSummary"></a><div class="summarySection"><div class="summaryTableTitle">Public Methods </div><table cellspacing="0" cellpadding="3" class="summaryTable " id="summaryTableMethod"><tr><th> </th><th colspan="2">Method</th><th class="summaryTableOwnerCol">Defined By</th></tr><tr class=""><td class="summaryTablePaddingCol"> </td><td class="summaryTableInheritanceCol"> </td><td class="summaryTableSignatureCol"><div class="summarySignature"><a href="#toString()" class="signatureLink">toString</a>():String</div><div class="summaryTableDescription"> |
| This method will return a string representation of the message.</div></td><td class="summaryTableOwnerCol">IMessage</td></tr></table></div><script language="javascript" type="text/javascript"><!-- |
| showHideInherited(); |
| --></script><div class="MainContent"><div class="detailSectionHeader">Property Detail</div><a name="propertyDetail"></a><a name="body"></a><table class="detailHeader" cellpadding="0" cellspacing="0"><tr><td class="detailHeaderName">body</td><td class="detailHeaderType">property</td></tr></table><div class="detailBody"><code>body:Object</code><p></p><table cellpadding="0" cellspacing="0" border="0"><tr><td style="white-space:nowrap" valign="top"><b> Language Version : </b></td><td>ActionScript 3.0</td></tr></table><table cellpadding="0" cellspacing="0" border="0"><tr><td style="white-space:nowrap" valign="top"><b> Product Versions : </b></td><td>BlazeDS 4, LCDS 3</td></tr></table><table cellpadding="0" cellspacing="0" border="0"><tr><td style="white-space:nowrap" valign="top"><b> Runtime Versions : </b></td><td>Flash Player 9, AIR 1.1</td></tr></table><p></p><p></p><p> |
| The body of a message contains the specific data that needs to be |
| delivered to the remote destination. |
| |
| </p><br/><span class="label"> Implementation </span><br/><code> public function get body():Object</code><br/><code> public function set body(value:Object):void</code><br/></div><a name="propertyDetail"></a><a name="clientId"></a><table class="detailHeader" cellpadding="0" cellspacing="0"><tr><td class="detailHeaderName">clientId</td><td class="detailHeaderType">property</td><td class="detailHeaderRule"> </td></tr></table><div class="detailBody"><code>clientId:String</code><p></p><table cellpadding="0" cellspacing="0" border="0"><tr><td style="white-space:nowrap" valign="top"><b> Language Version : </b></td><td>ActionScript 3.0</td></tr></table><table cellpadding="0" cellspacing="0" border="0"><tr><td style="white-space:nowrap" valign="top"><b> Product Versions : </b></td><td>BlazeDS 4, LCDS 3</td></tr></table><table cellpadding="0" cellspacing="0" border="0"><tr><td style="white-space:nowrap" valign="top"><b> Runtime Versions : </b></td><td>Flash Player 9, AIR 1.1</td></tr></table><p></p><p></p><p> |
| The clientId indicates which client sent the message. |
| |
| </p><br/><span class="label"> Implementation </span><br/><code> public function get clientId():String</code><br/><code> public function set clientId(value:String):void</code><br/></div><a name="propertyDetail"></a><a name="destination"></a><table class="detailHeader" cellpadding="0" cellspacing="0"><tr><td class="detailHeaderName">destination</td><td class="detailHeaderType">property</td><td class="detailHeaderRule"> </td></tr></table><div class="detailBody"><code>destination:String</code><p></p><table cellpadding="0" cellspacing="0" border="0"><tr><td style="white-space:nowrap" valign="top"><b> Language Version : </b></td><td>ActionScript 3.0</td></tr></table><table cellpadding="0" cellspacing="0" border="0"><tr><td style="white-space:nowrap" valign="top"><b> Product Versions : </b></td><td>BlazeDS 4, LCDS 3</td></tr></table><table cellpadding="0" cellspacing="0" border="0"><tr><td style="white-space:nowrap" valign="top"><b> Runtime Versions : </b></td><td>Flash Player 9, AIR 1.1</td></tr></table><p></p><p></p><p> |
| The message destination. |
| |
| </p><br/><span class="label"> Implementation </span><br/><code> public function get destination():String</code><br/><code> public function set destination(value:String):void</code><br/></div><a name="propertyDetail"></a><a name="headers"></a><table class="detailHeader" cellpadding="0" cellspacing="0"><tr><td class="detailHeaderName">headers</td><td class="detailHeaderType">property</td><td class="detailHeaderRule"> </td></tr></table><div class="detailBody"><code>headers:Object</code><p></p><table cellpadding="0" cellspacing="0" border="0"><tr><td style="white-space:nowrap" valign="top"><b> Language Version : </b></td><td>ActionScript 3.0</td></tr></table><table cellpadding="0" cellspacing="0" border="0"><tr><td style="white-space:nowrap" valign="top"><b> Product Versions : </b></td><td>BlazeDS 4, LCDS 3</td></tr></table><table cellpadding="0" cellspacing="0" border="0"><tr><td style="white-space:nowrap" valign="top"><b> Runtime Versions : </b></td><td>Flash Player 9, AIR 1.1</td></tr></table><p></p><p></p><p> |
| 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. |
| |
| </p><br/><span class="label"> Implementation </span><br/><code> public function get headers():Object</code><br/><code> public function set headers(value:Object):void</code><br/></div><a name="propertyDetail"></a><a name="messageId"></a><table class="detailHeader" cellpadding="0" cellspacing="0"><tr><td class="detailHeaderName">messageId</td><td class="detailHeaderType">property</td><td class="detailHeaderRule"> </td></tr></table><div class="detailBody"><code>messageId:String</code><p></p><table cellpadding="0" cellspacing="0" border="0"><tr><td style="white-space:nowrap" valign="top"><b> Language Version : </b></td><td>ActionScript 3.0</td></tr></table><table cellpadding="0" cellspacing="0" border="0"><tr><td style="white-space:nowrap" valign="top"><b> Product Versions : </b></td><td>BlazeDS 4, LCDS 3</td></tr></table><table cellpadding="0" cellspacing="0" border="0"><tr><td style="white-space:nowrap" valign="top"><b> Runtime Versions : </b></td><td>Flash Player 9, AIR 1.1</td></tr></table><p></p><p></p><p> |
| 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. |
| |
| </p><br/><span class="label"> Implementation </span><br/><code> public function get messageId():String</code><br/><code> public function set messageId(value:String):void</code><br/></div><a name="propertyDetail"></a><a name="timestamp"></a><table class="detailHeader" cellpadding="0" cellspacing="0"><tr><td class="detailHeaderName">timestamp</td><td class="detailHeaderType">property</td><td class="detailHeaderRule"> </td></tr></table><div class="detailBody"><code>timestamp:Number</code><p></p><table cellpadding="0" cellspacing="0" border="0"><tr><td style="white-space:nowrap" valign="top"><b> Language Version : </b></td><td>ActionScript 3.0</td></tr></table><table cellpadding="0" cellspacing="0" border="0"><tr><td style="white-space:nowrap" valign="top"><b> Product Versions : </b></td><td>BlazeDS 4, LCDS 3</td></tr></table><table cellpadding="0" cellspacing="0" border="0"><tr><td style="white-space:nowrap" valign="top"><b> Runtime Versions : </b></td><td>Flash Player 9, AIR 1.1</td></tr></table><p></p><p></p><p> |
| 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. |
| </p><br/><span class="label"> Implementation </span><br/><code> public function get timestamp():Number</code><br/><code> public function set timestamp(value:Number):void</code><br/><p><span class="label">See also</span></p><div class="seeAlso"><a href="IMessage.html#timeToLive" target="">timeToLive</a></div></div><a name="propertyDetail"></a><a name="timeToLive"></a><table class="detailHeader" cellpadding="0" cellspacing="0"><tr><td class="detailHeaderName">timeToLive</td><td class="detailHeaderType">property</td><td class="detailHeaderRule"> </td></tr></table><div class="detailBody"><code>timeToLive:Number</code><p></p><table cellpadding="0" cellspacing="0" border="0"><tr><td style="white-space:nowrap" valign="top"><b> Language Version : </b></td><td>ActionScript 3.0</td></tr></table><table cellpadding="0" cellspacing="0" border="0"><tr><td style="white-space:nowrap" valign="top"><b> Product Versions : </b></td><td>BlazeDS 4, LCDS 3</td></tr></table><table cellpadding="0" cellspacing="0" border="0"><tr><td style="white-space:nowrap" valign="top"><b> Runtime Versions : </b></td><td>Flash Player 9, AIR 1.1</td></tr></table><p></p><p></p><p> |
| 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. |
| |
| </p><br/><span class="label"> Implementation </span><br/><code> public function get timeToLive():Number</code><br/><code> public function set timeToLive(value:Number):void</code><br/></div><a name="methodDetail"></a><div class="detailSectionHeader">Method Detail</div><a name="toString()"></a><table class="detailHeader" cellpadding="0" cellspacing="0"><tr><td class="detailHeaderName">toString</td><td class="detailHeaderParens">()</td><td class="detailHeaderType">method</td></tr></table><div class="detailBody"><code> public function toString():String</code><p></p><table cellpadding="0" cellspacing="0" border="0"><tr><td style="white-space:nowrap" valign="top"><b> Language Version : </b></td><td>ActionScript 3.0</td></tr></table><table cellpadding="0" cellspacing="0" border="0"><tr><td style="white-space:nowrap" valign="top"><b> Product Versions : </b></td><td>BlazeDS 4, LCDS 3</td></tr></table><table cellpadding="0" cellspacing="0" border="0"><tr><td style="white-space:nowrap" valign="top"><b> Runtime Versions : </b></td><td>Flash Player 9, AIR 1.1</td></tr></table><p></p><p></p><p> |
| This method will return a string representation of the message. |
| </p><p></p><span class="label">Returns</span><table cellpadding="0" cellspacing="0" border="0"><tr><td width="20"></td><td><code>String</code> — String representation of the message. |
| |
| </td></tr></table></div><br/><br/><hr><br/><p></p><center class="copyright"><footer>The Apache Software Foundation</footer><br/>Wed Nov 15 2017, 09:50 AM +01:00 </center></div></body></html><!--The Apache Software Foundation<br/>Wed Nov 15 2017, 09:50 AM +01:00 --> |
