blob: 1809acce9eab2ce81a8d7635806fd2a5b996f21e [file] [log] [blame]
<!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="Operation,mx.rpc.remoting.mxml.Operation"><title>mx.rpc.remoting.mxml.Operation</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 = 'Operation - 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>&nbsp;|&nbsp;<a href="../../../../class-summary.html" onclick="loadClassListFrame('../../../../all-classes.html')">All Classes</a>&nbsp;|&nbsp;<a href="../../../../all-index-A.html" onclick="loadClassListFrame('../../../../index-list.html')">Index</a>&nbsp;|&nbsp;<a id="framesLink1" href="../../../../index.html?mx/rpc/remoting/mxml/Operation.html&amp;mx/rpc/remoting/mxml/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">Operation</td><td class="titleTableSubNav" id="subNav" align="right"><a href="#propertySummary">Properties</a>&nbsp;| <a href="#methodSummary">Methods</a>&nbsp;| <a href="#eventSummary">Events</a></td></tr><tr class="titleTableRow3"><td colspan="3">&nbsp;</td></tr></table><script language="javascript" type="text/javascript" xml:space="preserve">
<!--
if (!isEclipse() || window.name != ECLIPSE_FRAME_NAME) {titleBar_setSubTitle("Operation"); 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.mxml</a></td></tr><tr><td class="classHeaderTableLabel">Class</td><td class="classSignature">public class Operation</td></tr><tr><td class="classHeaderTableLabel">Inheritance</td><td class="inheritanceList">Operation <img src="../../../../images/inherit-arrow.gif" title="Inheritance" alt="Inheritance" class="inheritArrow"> <a href="../../../../mx/rpc/remoting/Operation.html">Operation</a> <img src="../../../../images/inherit-arrow.gif" title="Inheritance" alt="Inheritance" class="inheritArrow"> <a href="../../../../mx/rpc/AbstractOperation.html">AbstractOperation</a> <img src="../../../../images/inherit-arrow.gif" title="Inheritance" alt="Inheritance" class="inheritArrow"> <a href="../../../../mx/rpc/AbstractInvoker.html">AbstractInvoker</a> <img src="../../../../images/inherit-arrow.gif" title="Inheritance" alt="Inheritance" class="inheritArrow"> flash.events.EventDispatcher</td></tr><tr><td class="classHeaderTableLabel">Implements</td><td> <a href="../../../../mx/rpc/mxml/IMXMLSupport.html">IMXMLSupport</a></td></tr></table><p></p><table cellpadding="0" cellspacing="0" border="0"><tr><td style="white-space:nowrap" valign="top"><b> Language Version :&nbsp;</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 :&nbsp;</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 :&nbsp;</b></td><td>Flash Player 9, AIR 1.1</td></tr></table><p></p><p></p><p></p><p></p>
The Operation used for RemoteObject when created in an MXML document.
<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 hideInheritedProperty" id="summaryTableProperty"><tr><th>&nbsp;</th><th colspan="2">Property</th><th class="summaryTableOwnerCol">Defined By</th></tr><tr class="hideInheritedProperty"><td class="summaryTablePaddingCol">&nbsp;</td><td class="summaryTableInheritanceCol"><img src="../../../../images/inheritedSummary.gif" alt="Inherited" title="Inherited" class="inheritedSummaryImage"></td><td class="summaryTableSignatureCol"><a href="../../../../mx/rpc/remoting/Operation.html#argumentNames" class="signatureLink">argumentNames</a> : Array<div class="summaryTableDescription">
An ordered list of the names of the arguments to pass to a method invocation.</div></td><td class="summaryTableOwnerCol"><a href="../../../../mx/rpc/remoting/Operation.html">Operation</a></td></tr><tr class="hideInheritedProperty"><td class="summaryTablePaddingCol">&nbsp;</td><td class="summaryTableInheritanceCol"><img src="../../../../images/inheritedSummary.gif" alt="Inherited" title="Inherited" class="inheritedSummaryImage"></td><td class="summaryTableSignatureCol"><a href="../../../../mx/rpc/AbstractOperation.html#arguments" class="signatureLink">arguments</a> : Object<div class="summaryTableDescription">
The arguments to pass to the Operation when it is invoked.</div></td><td class="summaryTableOwnerCol"><a href="../../../../mx/rpc/AbstractOperation.html">AbstractOperation</a></td></tr><tr class="hideInheritedProperty"><td class="summaryTablePaddingCol">&nbsp;</td><td class="summaryTableInheritanceCol"><img src="../../../../images/inheritedSummary.gif" alt="Inherited" title="Inherited" class="inheritedSummaryImage"></td><td class="summaryTableSignatureCol"><a href="../../../../mx/rpc/remoting/Operation.html#concurrency" class="signatureLink">concurrency</a> : String<div class="summaryTableDescription">
The concurrency for this Operation.</div></td><td class="summaryTableOwnerCol"><a href="../../../../mx/rpc/remoting/Operation.html">Operation</a></td></tr><tr class="hideInheritedProperty"><td class="summaryTablePaddingCol">&nbsp;</td><td class="summaryTableInheritanceCol"><img src="../../../../images/inheritedSummary.gif" alt="Inherited" title="Inherited" class="inheritedSummaryImage"></td><td class="summaryTableSignatureCol"><a href="../../../../mx/rpc/AbstractInvoker.html#keepLastResult" class="signatureLink">keepLastResult</a> : Boolean<div class="summaryTableDescription"> Flag indicating whether the operation should keep its last call result for later access.</div></td><td class="summaryTableOwnerCol"><a href="../../../../mx/rpc/AbstractInvoker.html">AbstractInvoker</a></td></tr><tr class="hideInheritedProperty"><td class="summaryTablePaddingCol">&nbsp;</td><td class="summaryTableInheritanceCol"><img src="../../../../images/inheritedSummary.gif" alt="Inherited" title="Inherited" class="inheritedSummaryImage"></td><td class="summaryTableSignatureCol"><a href="../../../../mx/rpc/AbstractInvoker.html#lastResult" class="signatureLink">lastResult</a> : Object<div class="summaryTableDescription">[read-only]
The result of the last invocation.</div></td><td class="summaryTableOwnerCol"><a href="../../../../mx/rpc/AbstractInvoker.html">AbstractInvoker</a></td></tr><tr class="hideInheritedProperty"><td class="summaryTablePaddingCol">&nbsp;</td><td class="summaryTableInheritanceCol"><img src="../../../../images/inheritedSummary.gif" alt="Inherited" title="Inherited" class="inheritedSummaryImage"></td><td class="summaryTableSignatureCol"><a href="../../../../mx/rpc/remoting/Operation.html#makeObjectsBindable" class="signatureLink">makeObjectsBindable</a> : Boolean<div class="summaryTableDescription">[override]
When this value is true, anonymous objects returned are forced to bindable objects.</div></td><td class="summaryTableOwnerCol"><a href="../../../../mx/rpc/remoting/Operation.html">Operation</a></td></tr><tr class="hideInheritedProperty"><td class="summaryTablePaddingCol">&nbsp;</td><td class="summaryTableInheritanceCol"><img src="../../../../images/inheritedSummary.gif" alt="Inherited" title="Inherited" class="inheritedSummaryImage"></td><td class="summaryTableSignatureCol"><a href="../../../../mx/rpc/AbstractOperation.html#name" class="signatureLink">name</a> : String<div class="summaryTableDescription">
The name of this Operation.</div></td><td class="summaryTableOwnerCol"><a href="../../../../mx/rpc/AbstractOperation.html">AbstractOperation</a></td></tr><tr class="hideInheritedProperty"><td class="summaryTablePaddingCol">&nbsp;</td><td class="summaryTableInheritanceCol"><img src="../../../../images/inheritedSummary.gif" alt="Inherited" title="Inherited" class="inheritedSummaryImage"></td><td class="summaryTableSignatureCol"><a href="../../../../mx/rpc/AbstractInvoker.html#operationManager" class="signatureLink">operationManager</a> : Function<div class="summaryTableDescription">
This property is set usually by framework code which wants to modify the
behavior of a service invocation without modifying the way in which the
service is called externally.</div></td><td class="summaryTableOwnerCol"><a href="../../../../mx/rpc/AbstractInvoker.html">AbstractInvoker</a></td></tr><tr class="hideInheritedProperty"><td class="summaryTablePaddingCol">&nbsp;</td><td class="summaryTableInheritanceCol"><img src="../../../../images/inheritedSummary.gif" alt="Inherited" title="Inherited" class="inheritedSummaryImage"></td><td class="summaryTableSignatureCol"><a href="../../../../mx/rpc/AbstractOperation.html#properties" class="signatureLink">properties</a> : Object<div class="summaryTableDescription">
This is a hook primarily for framework developers to register additional user
specified properties for your operation.</div></td><td class="summaryTableOwnerCol"><a href="../../../../mx/rpc/AbstractOperation.html">AbstractOperation</a></td></tr><tr class="hideInheritedProperty"><td class="summaryTablePaddingCol">&nbsp;</td><td class="summaryTableInheritanceCol"><img src="../../../../images/inheritedSummary.gif" alt="Inherited" title="Inherited" class="inheritedSummaryImage"></td><td class="summaryTableSignatureCol"><a href="../../../../mx/rpc/AbstractInvoker.html#resultElementType" class="signatureLink">resultElementType</a> : Class<div class="summaryTableDescription">
Like resultType, used to define the ActionScript class used by a given operation though
this property only applies to operations which return a multi-valued result (e.g.</div></td><td class="summaryTableOwnerCol"><a href="../../../../mx/rpc/AbstractInvoker.html">AbstractInvoker</a></td></tr><tr class="hideInheritedProperty"><td class="summaryTablePaddingCol">&nbsp;</td><td class="summaryTableInheritanceCol"><img src="../../../../images/inheritedSummary.gif" alt="Inherited" title="Inherited" class="inheritedSummaryImage"></td><td class="summaryTableSignatureCol"><a href="../../../../mx/rpc/AbstractInvoker.html#resultType" class="signatureLink">resultType</a> : Class<div class="summaryTableDescription">
Specifies an optional return type for the operation.</div></td><td class="summaryTableOwnerCol"><a href="../../../../mx/rpc/AbstractInvoker.html">AbstractInvoker</a></td></tr><tr class="hideInheritedProperty"><td class="summaryTablePaddingCol">&nbsp;</td><td class="summaryTableInheritanceCol"><img src="../../../../images/inheritedSummary.gif" alt="Inherited" title="Inherited" class="inheritedSummaryImage"></td><td class="summaryTableSignatureCol"><a href="../../../../mx/rpc/AbstractOperation.html#service" class="signatureLink">service</a> : <a href="../../../../mx/rpc/AbstractService.html">AbstractService</a><div class="summaryTableDescription">[read-only]
Provides convenient access to the service on which the Operation
is being invoked.</div></td><td class="summaryTableOwnerCol"><a href="../../../../mx/rpc/AbstractOperation.html">AbstractOperation</a></td></tr><tr class="hideInheritedProperty"><td class="summaryTablePaddingCol">&nbsp;</td><td class="summaryTableInheritanceCol"><img src="../../../../images/inheritedSummary.gif" alt="Inherited" title="Inherited" class="inheritedSummaryImage"></td><td class="summaryTableSignatureCol"><a href="../../../../mx/rpc/remoting/Operation.html#showBusyCursor" class="signatureLink">showBusyCursor</a> : Boolean<div class="summaryTableDescription">
Whether this operation should show the busy cursor while it is executing.</div></td><td class="summaryTableOwnerCol"><a href="../../../../mx/rpc/remoting/Operation.html">Operation</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 hideInheritedMethod" id="summaryTableMethod"><tr><th>&nbsp;</th><th colspan="2">Method</th><th class="summaryTableOwnerCol">Defined By</th></tr><tr class="hideInheritedMethod"><td class="summaryTablePaddingCol">&nbsp;</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/remoting/Operation.html#cancel()" class="signatureLink">cancel</a>(id:String = null):<a href="../../../../mx/rpc/AsyncToken.html">AsyncToken</a></div><div class="summaryTableDescription">[override]
Cancels the last service invocation or an invokation with the specified ID.</div></td><td class="summaryTableOwnerCol"><a href="../../../../mx/rpc/remoting/Operation.html">Operation</a></td></tr><tr class="hideInheritedMethod"><td class="summaryTablePaddingCol">&nbsp;</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/AbstractInvoker.html#clearResult()" class="signatureLink">clearResult</a>(fireBindingEvent:Boolean = true):void</div><div class="summaryTableDescription">
Sets the result property of the invoker to null.</div></td><td class="summaryTableOwnerCol"><a href="../../../../mx/rpc/AbstractInvoker.html">AbstractInvoker</a></td></tr><tr class="hideInheritedMethod"><td class="summaryTablePaddingCol">&nbsp;</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/remoting/Operation.html#send()" class="signatureLink">send</a>(... args):<a href="../../../../mx/rpc/AsyncToken.html">AsyncToken</a></div><div class="summaryTableDescription">[override]
Executes the method.</div></td><td class="summaryTableOwnerCol"><a href="../../../../mx/rpc/remoting/Operation.html">Operation</a></td></tr><tr class="hideInheritedMethod"><td class="summaryTablePaddingCol">&nbsp;</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/AbstractInvoker.html#setResult()" class="signatureLink">setResult</a>(result:Object):void</div><div class="summaryTableDescription">
This hook is exposed to update the lastResult property.</div></td><td class="summaryTableOwnerCol"><a href="../../../../mx/rpc/AbstractInvoker.html">AbstractInvoker</a></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>&nbsp;</th><th colspan="2">Event</th><th> Summary </th><th class="summaryTableOwnerCol">Defined By</th></tr><tr class="hideInheritedEvent"><td class="summaryTablePaddingCol">&nbsp;</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/AbstractOperation.html#event:fault" class="signatureLink">fault</a></div></td><td class="summaryTableDescription summaryTableCol">Dispatched when an Operation call fails.</td><td class="summaryTableOwnerCol"><a href="../../../../mx/rpc/AbstractOperation.html">AbstractOperation</a></td></tr><tr class="hideInheritedEvent"><td class="summaryTablePaddingCol">&nbsp;</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/AbstractOperation.html#event:result" class="signatureLink">result</a></div></td><td class="summaryTableDescription summaryTableCol">Dispatched when an Operation invocation successfully returns.</td><td class="summaryTableOwnerCol"><a href="../../../../mx/rpc/AbstractOperation.html">AbstractOperation</a></td></tr></table></div><script language="javascript" type="text/javascript"><!--
showHideInherited();
--></script><div class="MainContent"><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 -->