| <!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="RemoteObject,mx.rpc.remoting.RemoteObject,argumentNames,concurrency,concurrency,convertParametersHandler,convertResultHandler,endpoint,makeObjectsBindable,makeObjectsBindable,showBusyCursor,showBusyCursor,source,cancel,getOperation,send,setRemoteCredentials,toString"><title>mx.rpc.remoting.RemoteObject</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 = 'RemoteObject - 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/rpc/remoting/RemoteObject.html&mx/rpc/remoting/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">RemoteObject</td><td class="titleTableSubNav" id="subNav" align="right"><a href="#propertySummary">Properties</a> | <a href="#methodSummary">Methods</a> | <a href="#eventSummary">Events</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("RemoteObject"); titleBar_setSubNav(false,true,false,false,false,false,true,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.rpc.remoting</a></td></tr><tr><td class="classHeaderTableLabel">Class</td><td class="classSignature">public dynamic class RemoteObject</td></tr><tr><td class="classHeaderTableLabel">Inheritance</td><td class="inheritanceList">RemoteObject <img src="../../../images/inherit-arrow.gif" title="Inheritance" alt="Inheritance" class="inheritArrow"> <a href="../../../mx/rpc/AbstractService.html">AbstractService</a> <img src="../../../images/inherit-arrow.gif" title="Inheritance" alt="Inheritance" class="inheritArrow"> flash.utils.Proxy</td></tr><tr><td class="classHeaderTableLabel">Subclasses</td><td> <a href="../../../mx/rpc/remoting/mxml/RemoteObject.html">RemoteObject</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 Version : </b></td><td>Flex 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> |
| The RemoteObject class gives you access to classes on a remote application server. |
| |
| <p></p><br/><hr></div><a name="propertySummary"></a><div class="summarySection"><div class="summaryTableTitle">Public Properties</div><div class="showHideLinks"><div id="hideInheritedProperty" class="hideInheritedProperty"><a class="showHideLink" href="#propertySummary" onclick="javascript:setInheritedVisible(false,'Property');"><img class="showHideLinkImage" src="../../../images/expanded.gif"> Hide Inherited Public Properties</a></div><div id="showInheritedProperty" class="showInheritedProperty"><a class="showHideLink" href="#propertySummary" onclick="javascript:setInheritedVisible(true,'Property');"><img class="showHideLinkImage" src="../../../images/collapsed.gif"> Show Inherited Public Properties</a></div></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="hideInheritedProperty"><td class="summaryTablePaddingCol"> </td><td class="summaryTableInheritanceCol"><img src="../../../images/inheritedSummary.gif" alt="Inherited" title="Inherited" class="inheritedSummaryImage"></td><td class="summaryTableSignatureCol"><a href="../../../mx/rpc/AbstractService.html#channelSet" class="signatureLink">channelSet</a> : <a href="../../../mx/messaging/ChannelSet.html">ChannelSet</a><div class="summaryTableDescription"> |
| Provides access to the ChannelSet used by the service.</div></td><td class="summaryTableOwnerCol"><a href="../../../mx/rpc/AbstractService.html">AbstractService</a></td></tr><tr class=""><td class="summaryTablePaddingCol"> </td><td class="summaryTableInheritanceCol"> </td><td class="summaryTableSignatureCol"><a href="#concurrency" class="signatureLink">concurrency</a> : String<div class="summaryTableDescription"> |
| Value that indicates how to handle multiple calls to the same service.</div></td><td class="summaryTableOwnerCol">RemoteObject</td></tr><tr class=""><td class="summaryTablePaddingCol"> </td><td class="summaryTableInheritanceCol"> </td><td class="summaryTableSignatureCol"><a href="#convertParametersHandler" class="signatureLink">convertParametersHandler</a> : Function<div class="summaryTableDescription"> |
| An optional function, primarily intended for framework developers who need to install |
| a function to get called with the parameters passed to each remote object invocation.</div></td><td class="summaryTableOwnerCol">RemoteObject</td></tr><tr class=""><td class="summaryTablePaddingCol"> </td><td class="summaryTableInheritanceCol"> </td><td class="summaryTableSignatureCol"><a href="#convertResultHandler" class="signatureLink">convertResultHandler</a> : Function<div class="summaryTableDescription"> |
| An optional function, primarily intended for framework developers who need to install |
| a hook to process the results of an operation before notifying the result handlers.</div></td><td class="summaryTableOwnerCol">RemoteObject</td></tr><tr class="hideInheritedProperty"><td class="summaryTablePaddingCol"> </td><td class="summaryTableInheritanceCol"><img src="../../../images/inheritedSummary.gif" alt="Inherited" title="Inherited" class="inheritedSummaryImage"></td><td class="summaryTableSignatureCol"><a href="../../../mx/rpc/AbstractService.html#destination" class="signatureLink">destination</a> : String<div class="summaryTableDescription"> |
| The destination of the service.</div></td><td class="summaryTableOwnerCol"><a href="../../../mx/rpc/AbstractService.html">AbstractService</a></td></tr><tr class=""><td class="summaryTablePaddingCol"> </td><td class="summaryTableInheritanceCol"> </td><td class="summaryTableSignatureCol"><a href="#endpoint" class="signatureLink">endpoint</a> : String<div class="summaryTableDescription"> |
| This property allows the developer to quickly specify an endpoint for a RemoteObject |
| destination without referring to a services configuration file at compile time or programmatically creating |
| a ChannelSet.</div></td><td class="summaryTableOwnerCol">RemoteObject</td></tr><tr class="hideInheritedProperty"><td class="summaryTablePaddingCol"> </td><td class="summaryTableInheritanceCol"><img src="../../../images/inheritedSummary.gif" alt="Inherited" title="Inherited" class="inheritedSummaryImage"></td><td class="summaryTableSignatureCol"><a href="../../../mx/rpc/AbstractService.html#keepLastResult" class="signatureLink">keepLastResult</a> : Boolean<div class="summaryTableDescription"> Flag indicating whether the service's operations should keep their last call result for later access.</div></td><td class="summaryTableOwnerCol"><a href="../../../mx/rpc/AbstractService.html">AbstractService</a></td></tr><tr class=""><td class="summaryTablePaddingCol"> </td><td class="summaryTableInheritanceCol"> </td><td class="summaryTableSignatureCol"><a href="#makeObjectsBindable" class="signatureLink">makeObjectsBindable</a> : Boolean<div class="summaryTableDescription"> |
| When this value is true, anonymous objects returned are forced to bindable objects.</div></td><td class="summaryTableOwnerCol">RemoteObject</td></tr><tr class="hideInheritedProperty"><td class="summaryTablePaddingCol"> </td><td class="summaryTableInheritanceCol"><img src="../../../images/inheritedSummary.gif" alt="Inherited" title="Inherited" class="inheritedSummaryImage"></td><td class="summaryTableSignatureCol"><a href="../../../mx/rpc/AbstractService.html#managers" class="signatureLink">managers</a> : Array<div class="summaryTableDescription"> |
| The managers property stores a list of data managers which modify the |
| behavior of this service.</div></td><td class="summaryTableOwnerCol"><a href="../../../mx/rpc/AbstractService.html">AbstractService</a></td></tr><tr class="hideInheritedProperty"><td class="summaryTablePaddingCol"> </td><td class="summaryTableInheritanceCol"><img src="../../../images/inheritedSummary.gif" alt="Inherited" title="Inherited" class="inheritedSummaryImage"></td><td class="summaryTableSignatureCol"><a href="../../../mx/rpc/AbstractService.html#operations" class="signatureLink">operations</a> : Object<div class="summaryTableDescription"> |
| The Operations array is usually only set by the MXML compiler if you |
| create a service using an MXML tag.</div></td><td class="summaryTableOwnerCol"><a href="../../../mx/rpc/AbstractService.html">AbstractService</a></td></tr><tr class="hideInheritedProperty"><td class="summaryTablePaddingCol"> </td><td class="summaryTableInheritanceCol"><img src="../../../images/inheritedSummary.gif" alt="Inherited" title="Inherited" class="inheritedSummaryImage"></td><td class="summaryTableSignatureCol"><a href="../../../mx/rpc/AbstractService.html#requestTimeout" class="signatureLink">requestTimeout</a> : int<div class="summaryTableDescription"> |
| Provides access to the request timeout in seconds for sent messages.</div></td><td class="summaryTableOwnerCol"><a href="../../../mx/rpc/AbstractService.html">AbstractService</a></td></tr><tr class=""><td class="summaryTablePaddingCol"> </td><td class="summaryTableInheritanceCol"> </td><td class="summaryTableSignatureCol"><a href="#showBusyCursor" class="signatureLink">showBusyCursor</a> : Boolean<div class="summaryTableDescription"> |
| If true, a busy cursor is displayed while a service is executing.</div></td><td class="summaryTableOwnerCol">RemoteObject</td></tr><tr class=""><td class="summaryTablePaddingCol"> </td><td class="summaryTableInheritanceCol"> </td><td class="summaryTableSignatureCol"><a href="#source" class="signatureLink">source</a> : String<div class="summaryTableDescription"> |
| Lets you specify a source value on the client; not supported for destinations that use the JavaAdapter.</div></td><td class="summaryTableOwnerCol">RemoteObject</td></tr></table></div><a name="protectedPropertySummary"></a><div class="summarySection"><div class="summaryTableTitle">Protected Properties</div><div class="showHideLinks"><div id="hideInheritedProtectedProperty" class="hideInheritedProtectedProperty"><a class="showHideLink" href="#protectedPropertySummary" onclick="javascript:setInheritedVisible(false,'ProtectedProperty');"><img class="showHideLinkImage" src="../../../images/expanded.gif"> Hide Inherited Protected Properties</a></div><div id="showInheritedProtectedProperty" class="showInheritedProtectedProperty"><a class="showHideLink" href="#protectedPropertySummary" onclick="javascript:setInheritedVisible(true,'ProtectedProperty');"><img class="showHideLinkImage" src="../../../images/collapsed.gif"> Show Inherited Protected Properties</a></div></div><table cellspacing="0" cellpadding="3" class="summaryTable hideInheritedProtectedProperty" id="summaryTableProtectedProperty"><tr><th> </th><th colspan="2">Property</th><th class="summaryTableOwnerCol">Defined By</th></tr><tr class="hideInheritedProtectedProperty"><td class="summaryTablePaddingCol"> </td><td class="summaryTableInheritanceCol"><img src="../../../images/inheritedSummary.gif" alt="Inherited" title="Inherited" class="inheritedSummaryImage"></td><td class="summaryTableSignatureCol"><a href="../../../mx/rpc/AbstractService.html#_keepLastResult" class="signatureLink">_keepLastResult</a> : Boolean = true<div class="summaryTableDescription"></div></td><td class="summaryTableOwnerCol"><a href="../../../mx/rpc/AbstractService.html">AbstractService</a></td></tr></table></div><a name="methodSummary"></a><div class="summarySection"><div class="summaryTableTitle">Public Methods </div><div class="showHideLinks"><div id="hideInheritedMethod" class="hideInheritedMethod"><a class="showHideLink" href="#methodSummary" onclick="javascript:setInheritedVisible(false,'Method');"><img class="showHideLinkImage" src="../../../images/expanded.gif"> Hide Inherited Public Methods</a></div><div id="showInheritedMethod" class="showInheritedMethod"><a class="showHideLink" href="#methodSummary" onclick="javascript:setInheritedVisible(true,'Method');"><img class="showHideLinkImage" src="../../../images/collapsed.gif"> Show Inherited Public Methods</a></div></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="#RemoteObject()" class="signatureLink">RemoteObject</a>(destination:String = null)</div><div class="summaryTableDescription"> |
| Creates a new RemoteObject.</div></td><td class="summaryTableOwnerCol">RemoteObject</td></tr><tr class="hideInheritedMethod"><td class="summaryTablePaddingCol"> </td><td class="summaryTableInheritanceCol"><img src="../../../images/inheritedSummary.gif" alt="Inherited" title="Inherited" class="inheritedSummaryImage"></td><td class="summaryTableSignatureCol"><div class="summarySignature"><a href="../../../mx/rpc/AbstractService.html#disconnect()" class="signatureLink">disconnect</a>():void</div><div class="summaryTableDescription"> |
| Disconnects the service's network connection and removes any pending |
| request responders.</div></td><td class="summaryTableOwnerCol"><a href="../../../mx/rpc/AbstractService.html">AbstractService</a></td></tr><tr class=""><td class="summaryTablePaddingCol"> </td><td class="summaryTableInheritanceCol"> </td><td class="summaryTableSignatureCol"><div class="summarySignature"><a href="#getOperation()" class="signatureLink">getOperation</a>(name:String):<a href="../../../mx/rpc/AbstractOperation.html">AbstractOperation</a></div><div class="summaryTableDescription">[override] |
| Returns an Operation of the given name.</div></td><td class="summaryTableOwnerCol">RemoteObject</td></tr><tr class="hideInheritedMethod"><td class="summaryTablePaddingCol"> </td><td class="summaryTableInheritanceCol"><img src="../../../images/inheritedSummary.gif" alt="Inherited" title="Inherited" class="inheritedSummaryImage"></td><td class="summaryTableSignatureCol"><div class="summarySignature"><a href="../../../mx/rpc/AbstractService.html#initialize()" class="signatureLink">initialize</a>():void</div><div class="summaryTableDescription"> |
| Called to initialize the service.</div></td><td class="summaryTableOwnerCol"><a href="../../../mx/rpc/AbstractService.html">AbstractService</a></td></tr><tr class="hideInheritedMethod"><td class="summaryTablePaddingCol"> </td><td class="summaryTableInheritanceCol"><img src="../../../images/inheritedSummary.gif" alt="Inherited" title="Inherited" class="inheritedSummaryImage"></td><td class="summaryTableSignatureCol"><div class="summarySignature"><a href="../../../mx/rpc/AbstractService.html#logout()" class="signatureLink">logout</a>():void</div><div class="summaryTableDescription"> |
| Logs the user out of the destination.</div></td><td class="summaryTableOwnerCol"><a href="../../../mx/rpc/AbstractService.html">AbstractService</a></td></tr><tr class="hideInheritedMethod"><td class="summaryTablePaddingCol"> </td><td class="summaryTableInheritanceCol"><img src="../../../images/inheritedSummary.gif" alt="Inherited" title="Inherited" class="inheritedSummaryImage"></td><td class="summaryTableSignatureCol"><div class="summarySignature"><a href="../../../mx/rpc/AbstractService.html#setCredentials()" class="signatureLink">setCredentials</a>(username:String, password:String, charset:String = null):void</div><div class="summaryTableDescription"> |
| Sets the credentials for the destination accessed by the service when using Data Services on the server side.</div></td><td class="summaryTableOwnerCol"><a href="../../../mx/rpc/AbstractService.html">AbstractService</a></td></tr><tr class=""><td class="summaryTablePaddingCol"> </td><td class="summaryTableInheritanceCol"> </td><td class="summaryTableSignatureCol"><div class="summarySignature"><a href="#setRemoteCredentials()" class="signatureLink">setRemoteCredentials</a>(remoteUsername:String, remotePassword:String, charset:String = null):void</div><div class="summaryTableDescription">[override] |
| If a remote object is managed by an external service, such a ColdFusion Component (CFC), |
| a username and password can be set for the authentication mechanism of that remote service.</div></td><td class="summaryTableOwnerCol">RemoteObject</td></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"> |
| Represents an instance of RemoteObject as a String, describing |
| important properties such as the destination id and the set of |
| channels assigned.</div></td><td class="summaryTableOwnerCol">RemoteObject</td></tr></table></div><a name="eventSummary"></a><div class="summarySection"><div class="summaryTableTitle">Events</div><div class="showHideLinks"><div id="hideInheritedEvent" class="hideInheritedEvent"><a class="showHideLink" href="#eventSummary" onclick="javascript:setInheritedVisible(false,'Event');"><img class="showHideLinkImage" src="../../../images/expanded.gif"> Hide Inherited Events</a></div><div id="showInheritedEvent" class="showInheritedEvent"><a class="showHideLink" href="#eventSummary" onclick="javascript:setInheritedVisible(true,'Event');"><img class="showHideLinkImage" src="../../../images/collapsed.gif"> Show Inherited Events</a></div></div><table cellspacing="0" cellpadding="3" class="summaryTable hideInheritedEvent" id="summaryTableEvent"><tr><th> </th><th colspan="2">Event</th><th> Summary </th><th class="summaryTableOwnerCol">Defined By</th></tr><tr class="hideInheritedEvent"><td class="summaryTablePaddingCol"> </td><td class="summaryTableInheritanceCol"><img src="../../../images/inheritedSummary.gif" alt="Inherited" title="Inherited" class="inheritedSummaryImage"></td><td class="summaryTableSignatureCol"><div class="summarySignature"><a href="../../../mx/rpc/AbstractService.html#event:fault" class="signatureLink">fault</a></div></td><td class="summaryTableDescription summaryTableCol">The fault event is dispatched when a service call fails and isn't handled by the Operation itself.</td><td class="summaryTableOwnerCol"><a href="../../../mx/rpc/AbstractService.html">AbstractService</a></td></tr><tr class="hideInheritedEvent"><td class="summaryTablePaddingCol"> </td><td class="summaryTableInheritanceCol"><img src="../../../images/inheritedSummary.gif" alt="Inherited" title="Inherited" class="inheritedSummaryImage"></td><td class="summaryTableSignatureCol"><div class="summarySignature"><a href="../../../mx/rpc/AbstractService.html#event:invoke" class="signatureLink">invoke</a></div></td><td class="summaryTableDescription summaryTableCol">The invoke event is dispatched when a service Operation is invoked so long as an Error is not thrown before the Channel attempts to send the message.</td><td class="summaryTableOwnerCol"><a href="../../../mx/rpc/AbstractService.html">AbstractService</a></td></tr><tr class="hideInheritedEvent"><td class="summaryTablePaddingCol"> </td><td class="summaryTableInheritanceCol"><img src="../../../images/inheritedSummary.gif" alt="Inherited" title="Inherited" class="inheritedSummaryImage"></td><td class="summaryTableSignatureCol"><div class="summarySignature"><a href="../../../mx/rpc/AbstractService.html#event:result" class="signatureLink">result</a></div></td><td class="summaryTableDescription summaryTableCol">The result event is dispatched when a service call successfully returns and isn't handled by the Operation itself.</td><td class="summaryTableOwnerCol"><a href="../../../mx/rpc/AbstractService.html">AbstractService</a></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="concurrency"></a><table class="detailHeader" cellpadding="0" cellspacing="0"><tr><td class="detailHeaderName">concurrency</td><td class="detailHeaderType">property</td></tr></table><div class="detailBody"><code>concurrency: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 Version : </b></td><td>Flex 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> |
| Value that indicates how to handle multiple calls to the same service. The default |
| value is multiple. The following values are permitted: |
| <ul> |
| <li>multiple - Existing requests are not cancelled, and the developer is |
| responsible for ensuring the consistency of returned data by carefully |
| managing the event stream. This is the default.</li> |
| <li>single - Making only one request at a time is allowed on the method; additional requests made |
| while a request is outstanding are immediately faulted on the client and are not sent to the server.</li> |
| <li>last - Making a request causes the client to ignore a result or fault for any current outstanding request. |
| Only the result or fault for the most recent request will be dispatched on the client. |
| This may simplify event handling in the client application, but care should be taken to only use |
| this mode when results or faults for requests may be safely ignored.</li> |
| </ul> |
| |
| </p><br/><span class="label"> Implementation </span><br/><code> public function get concurrency():String</code><br/><code> public function set concurrency(value:String):void</code><br/></div><a name="propertyDetail"></a><a name="convertParametersHandler"></a><table class="detailHeader" cellpadding="0" cellspacing="0"><tr><td class="detailHeaderName">convertParametersHandler</td><td class="detailHeaderType">property</td><td class="detailHeaderRule"> </td></tr></table><div class="detailBody"><code>public var convertParametersHandler:Function</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 Version : </b></td><td>Flex 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> |
| An optional function, primarily intended for framework developers who need to install |
| a function to get called with the parameters passed to each remote object invocation. |
| The function takes an array of parameters and returns the potentially altered array. |
| The function definition should look like: |
| <code> |
| function myParametersFunction(parameters:Array):Array |
| </code> |
| |
| </p></div><a name="propertyDetail"></a><a name="convertResultHandler"></a><table class="detailHeader" cellpadding="0" cellspacing="0"><tr><td class="detailHeaderName">convertResultHandler</td><td class="detailHeaderType">property</td><td class="detailHeaderRule"> </td></tr></table><div class="detailBody"><code>public var convertResultHandler:Function</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 Version : </b></td><td>Flex 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> |
| An optional function, primarily intended for framework developers who need to install |
| a hook to process the results of an operation before notifying the result handlers. |
| The function definition should look like: |
| <code> |
| function myConvertResultsFunction(result: operation:AbstractOperation): </code> |
| |
| It is passed the result just after the makeObjectsBindable conversion has been done |
| but before the result event is created. |
| |
| </p></div><a name="propertyDetail"></a><a name="endpoint"></a><table class="detailHeader" cellpadding="0" cellspacing="0"><tr><td class="detailHeaderName">endpoint</td><td class="detailHeaderType">property</td><td class="detailHeaderRule"> </td></tr></table><div class="detailBody"><code>endpoint: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 Version : </b></td><td>Flex 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 property allows the developer to quickly specify an endpoint for a RemoteObject |
| destination without referring to a services configuration file at compile time or programmatically creating |
| a ChannelSet. It also overrides an existing ChannelSet if one has been set for the RemoteObject service. |
| <p>If the endpoint url starts with "https" a SecureAMFChannel will be used, otherwise an AMFChannel will |
| be used. Two special tokens, {server.name} and {server.port}, can be used in the endpoint url to specify |
| that the channel should use the server name and port that was used to load the SWF. </p> |
| <p><b>Note:</b> This property is required when creating AIR applications.</p> |
| |
| </p><br/><span class="label"> Implementation </span><br/><code> public function get endpoint():String</code><br/><code> public function set endpoint(value:String):void</code><br/></div><a name="propertyDetail"></a><a name="makeObjectsBindable"></a><table class="detailHeader" cellpadding="0" cellspacing="0"><tr><td class="detailHeaderName">makeObjectsBindable</td><td class="detailHeaderType">property</td><td class="detailHeaderRule"> </td></tr></table><div class="detailBody"><code>makeObjectsBindable:Boolean</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 Version : </b></td><td>Flex 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> |
| When this value is true, anonymous objects returned are forced to bindable objects. |
| |
| </p><br/><span class="label"> Implementation </span><br/><code> public function get makeObjectsBindable():Boolean</code><br/><code> public function set makeObjectsBindable(value:Boolean):void</code><br/></div><a name="propertyDetail"></a><a name="showBusyCursor"></a><table class="detailHeader" cellpadding="0" cellspacing="0"><tr><td class="detailHeaderName">showBusyCursor</td><td class="detailHeaderType">property</td><td class="detailHeaderRule"> </td></tr></table><div class="detailBody"><code>showBusyCursor:Boolean</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 Version : </b></td><td>Flex 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> |
| If <code>true</code>, a busy cursor is displayed while a service is executing. The default |
| value is <code>false</code>. |
| |
| </p><br/><span class="label"> Implementation </span><br/><code> public function get showBusyCursor():Boolean</code><br/><code> public function set showBusyCursor(value:Boolean):void</code><br/></div><a name="propertyDetail"></a><a name="source"></a><table class="detailHeader" cellpadding="0" cellspacing="0"><tr><td class="detailHeaderName">source</td><td class="detailHeaderType">property</td><td class="detailHeaderRule"> </td></tr></table><div class="detailBody"><code>source: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 Version : </b></td><td>Flex 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> |
| Lets you specify a source value on the client; not supported for destinations that use the JavaAdapter. This allows you to provide more than one source |
| that can be accessed from a single destination on the server. |
| |
| |
| </p><br/><span class="label"> Implementation </span><br/><code> public function get source():String</code><br/><code> public function set source(value:String):void</code><br/></div><a name="constructorDetail"></a><div class="detailSectionHeader">Constructor Detail</div><a name="RemoteObject()"></a><a name="RemoteObject(String)"></a><table class="detailHeader" cellpadding="0" cellspacing="0"><tr><td class="detailHeaderName">RemoteObject</td><td class="detailHeaderParens">()</td><td class="detailHeaderType">Constructor</td></tr></table><div class="detailBody"><code>public function RemoteObject(destination:String = null)</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 Version : </b></td><td>Flex 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> |
| Creates a new RemoteObject. |
| </p><span class="label"> Parameters </span><table cellpadding="0" cellspacing="0" border="0"><tr><td width="20px"></td><td><code><span class="label">destination</span>:String</code> (default = <code>null</code>)<code></code> — [optional] Destination of the RemoteObject; should match a destination name in the services-config.xml file. |
| |
| </td></tr></table></div><a name="methodDetail"></a><div class="detailSectionHeader">Method Detail</div><a name="getOperation()"></a><a name="getOperation(String)"></a><table class="detailHeader" cellpadding="0" cellspacing="0"><tr><td class="detailHeaderName">getOperation</td><td class="detailHeaderParens">()</td><td class="detailHeaderType">method</td></tr></table><div class="detailBody"><code>override public function getOperation(name:String):<a href="../../../mx/rpc/AbstractOperation.html">AbstractOperation</a></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 Version : </b></td><td>Flex 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> |
| Returns an Operation of the given name. If the Operation wasn't |
| created beforehand, a new <code>mx.rpc.remoting.Operation</code> is |
| created during this call. Operations are usually accessible by simply |
| naming them after the service variable |
| (<code>myService.someOperation</code>), but if your Operation name |
| happens to match a defined method on the service |
| (like <code>setCredentials</code>), you can use this method to get the |
| Operation instead. |
| </p><p><span class="label"> Parameters </span><table cellpadding="0" cellspacing="0" border="0"><tr><td width="20px"></td><td><code><span class="label">name</span>:String</code> — Name of the Operation. |
| </td></tr></table></p><p></p><span class="label">Returns</span><table cellpadding="0" cellspacing="0" border="0"><tr><td width="20"></td><td><code><a href="../../../mx/rpc/AbstractOperation.html">AbstractOperation</a></code> — Operation that executes for this name. |
| |
| </td></tr></table></div><a name="setRemoteCredentials()"></a><a name="setRemoteCredentials(String,String,String)"></a><table class="detailHeader" cellpadding="0" cellspacing="0"><tr><td class="detailHeaderName">setRemoteCredentials</td><td class="detailHeaderParens">()</td><td class="detailHeaderType">method</td><td class="detailHeaderRule"> </td></tr></table><div class="detailBody"><code>override public function setRemoteCredentials(remoteUsername:String, remotePassword:String, charset:String = null):void</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 Version : </b></td><td>Flex 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> |
| If a remote object is managed by an external service, such a ColdFusion Component (CFC), |
| a username and password can be set for the authentication mechanism of that remote service. |
| </p><p><span class="label"> Parameters </span><table cellpadding="0" cellspacing="0" border="0"><tr><td width="20px"></td><td><code><span class="label">remoteUsername</span>:String</code> — the username to pass to the remote endpoint |
| </td></tr><tr><td class="paramSpacer"> </td></tr><tr><td width="20px"></td><td><code><span class="label">remotePassword</span>:String</code> — the password to pass to the remote endpoint |
| </td></tr><tr><td class="paramSpacer"> </td></tr><tr><td width="20px"></td><td><code><span class="label">charset</span>:String</code> (default = <code>null</code>)<code></code> — The character set encoding to use while encoding the |
| remote credentials. The default is null, which implies the legacy charset |
| of ISO-Latin-1. The only other supported charset is "UTF-8". |
| |
| </td></tr></table></p></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><td class="detailHeaderRule"> </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 Version : </b></td><td>Flex 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> |
| Represents an instance of RemoteObject as a String, describing |
| important properties such as the destination id and the set of |
| channels assigned. |
| </p><p></p><span class="label">Returns</span><table cellpadding="0" cellspacing="0" border="0"><tr><td width="20"></td><td><code>String</code> — Returns a String representing an instance of a RemoteObject. |
| |
| </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 --> |
