| <!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="AbstractService,mx.rpc.AbstractService,_keepLastResult,arguments,channelSet,content,destination,faultCode,faultDetail,faultString,keepLastResult,keepLastResult,lastResult,lastResult,makeObjectsBindable,managers,message,name,operationManager,operations,properties,requestTimeout,responders,result,resultElementType,resultType,rootCause,service,token,addResponder,cancel,clearResult,disconnect,fault,fault,fault,fault,getOperation,hasPendingRequestForMessage,hasResponder,initialize,invoke,logout,result,result,result,result,send,setCredentials,setRemoteCredentials,setResult,toString"><title>mx.rpc.AbstractService</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 = 'AbstractService - 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/AbstractService.html&mx/rpc/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">AbstractService</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("AbstractService"); 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</a></td></tr><tr><td class="classHeaderTableLabel">Class</td><td class="classSignature">public dynamic class AbstractService</td></tr><tr><td class="classHeaderTableLabel">Inheritance</td><td class="inheritanceList">AbstractService <img src="../../images/inherit-arrow.gif" title="Inheritance" alt="Inheritance" class="inheritArrow"> flash.utils.Proxy</td></tr><tr><td class="classHeaderTableLabel">Implements</td><td> flash.events.IEventDispatcher</td></tr><tr><td class="classHeaderTableLabel">Subclasses</td><td> <a href="../../mx/rpc/soap/AbstractWebService.html">AbstractWebService</a>, <a href="../../mx/rpc/http/HTTPMultiService.html">HTTPMultiService</a>, <a href="../../mx/rpc/remoting/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 AbstractService class is the base class for the HTTPMultiService, WebService, |
| and RemoteObject classes. This class does the work of creating Operations |
| which do the actual execution of remote procedure calls. |
| <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="#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">AbstractService</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 destination of the service.</div></td><td class="summaryTableOwnerCol">AbstractService</td></tr><tr class=""><td class="summaryTablePaddingCol"> </td><td class="summaryTableInheritanceCol"> </td><td class="summaryTableSignatureCol"><a href="#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">AbstractService</td></tr><tr class=""><td class="summaryTablePaddingCol"> </td><td class="summaryTableInheritanceCol"> </td><td class="summaryTableSignatureCol"><a href="#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">AbstractService</td></tr><tr class=""><td class="summaryTablePaddingCol"> </td><td class="summaryTableInheritanceCol"> </td><td class="summaryTableSignatureCol"><a href="#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">AbstractService</td></tr><tr class=""><td class="summaryTablePaddingCol"> </td><td class="summaryTableInheritanceCol"> </td><td class="summaryTableSignatureCol"><a href="#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">AbstractService</td></tr></table></div><a name="protectedPropertySummary"></a><div class="summarySection"><div class="summaryTableTitle">Protected Properties</div><table cellspacing="0" cellpadding="3" class="summaryTable " id="summaryTableProtectedProperty"><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="#_keepLastResult" class="signatureLink">_keepLastResult</a> : Boolean = true<div class="summaryTableDescription"></div></td><td class="summaryTableOwnerCol">AbstractService</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="#AbstractService()" class="signatureLink">AbstractService</a>(destination:String = null)</div><div class="summaryTableDescription"> |
| Constructor.</div></td><td class="summaryTableOwnerCol">AbstractService</td></tr><tr class=""><td class="summaryTablePaddingCol"> </td><td class="summaryTableInheritanceCol"> </td><td class="summaryTableSignatureCol"><div class="summarySignature"><a href="#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">AbstractService</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"> |
| Returns an Operation of the given name.</div></td><td class="summaryTableOwnerCol">AbstractService</td></tr><tr class=""><td class="summaryTablePaddingCol"> </td><td class="summaryTableInheritanceCol"> </td><td class="summaryTableSignatureCol"><div class="summarySignature"><a href="#initialize()" class="signatureLink">initialize</a>():void</div><div class="summaryTableDescription"> |
| Called to initialize the service.</div></td><td class="summaryTableOwnerCol">AbstractService</td></tr><tr class=""><td class="summaryTablePaddingCol"> </td><td class="summaryTableInheritanceCol"> </td><td class="summaryTableSignatureCol"><div class="summarySignature"><a href="#logout()" class="signatureLink">logout</a>():void</div><div class="summaryTableDescription"> |
| Logs the user out of the destination.</div></td><td class="summaryTableOwnerCol">AbstractService</td></tr><tr class=""><td class="summaryTablePaddingCol"> </td><td class="summaryTableInheritanceCol"> </td><td class="summaryTableSignatureCol"><div class="summarySignature"><a href="#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">AbstractService</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"> |
| The username and password to be used to authenticate a user when |
| accessing a remote, third-party endpoint such as a web service through a |
| proxy or a remote object through a custom adapter when using Data Services on the server side.</div></td><td class="summaryTableOwnerCol">AbstractService</td></tr></table></div><a name="eventSummary"></a><div class="summarySection"><div class="summaryTableTitle">Events</div><table cellspacing="0" cellpadding="3" class="summaryTable " id="summaryTableEvent"><tr><th> </th><th colspan="2">Event</th><th> Summary </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="#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">AbstractService</td></tr><tr class=""><td class="summaryTablePaddingCol"> </td><td class="summaryTableInheritanceCol"> </td><td class="summaryTableSignatureCol"><div class="summarySignature"><a href="#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">AbstractService</td></tr><tr class=""><td class="summaryTablePaddingCol"> </td><td class="summaryTableInheritanceCol"> </td><td class="summaryTableSignatureCol"><div class="summarySignature"><a href="#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">AbstractService</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="_keepLastResult"></a><table class="detailHeader" cellpadding="0" cellspacing="0"><tr><td class="detailHeaderName">_keepLastResult</td><td class="detailHeaderType">property</td></tr></table><div class="detailBody"><code>protected var _keepLastResult:Boolean = true</code><p></p></div><a name="propertyDetail"></a><a name="channelSet"></a><table class="detailHeader" cellpadding="0" cellspacing="0"><tr><td class="detailHeaderName">channelSet</td><td class="detailHeaderType">property</td><td class="detailHeaderRule"> </td></tr></table><div class="detailBody"><code>channelSet:<a href="../../mx/messaging/ChannelSet.html">ChannelSet</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> |
| Provides access to the ChannelSet used by the service. The |
| ChannelSet can be manually constructed and assigned, or it will be |
| dynamically created to use the configured Channels for the |
| <code>destination</code> for this service. |
| </p><br/><span class="label"> Implementation </span><br/><code> public function get channelSet():<a href="../../mx/messaging/ChannelSet.html">ChannelSet</a></code><br/><code> public function set channelSet(value:<a href="../../mx/messaging/ChannelSet.html">ChannelSet</a>):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 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> |
| The destination of the service. This value should match a destination |
| entry in the services-config.xml file. |
| </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="keepLastResult"></a><table class="detailHeader" cellpadding="0" cellspacing="0"><tr><td class="detailHeaderName">keepLastResult</td><td class="detailHeaderType">property</td><td class="detailHeaderRule"> </td></tr></table><div class="detailBody"><code>keepLastResult:Boolean</code><p></p><table cellpadding="0" cellspacing="0" border="0"><tr><td style="white-space:nowrap" valign="top"><b> Product Version : </b></td><td>Flex 4.11</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 10, AIR 3</td></tr></table><p></p><p></p><p> Flag indicating whether the service's operations should keep their last call result for later access. |
| <p>Setting this flag at the service level will set <code>keepLastResult</code> for each operation, unless explicitly set in the operation.</p> |
| <p> If set to true or not set, each operation's last call result will be accessible through its <code>lastResult</code> bindable property. </p> |
| <p> If set to false, each operation's last call result will be cleared after the call, |
| and must be processed in the operation's result handler. |
| This will allow the result object to be garbage collected, |
| which is especially useful if the operation is only called a few times and returns a large result. </p> |
| </p><p> The default value is <code>true</code>.</p><br/><span class="label"> Implementation </span><br/><code> public function get keepLastResult():Boolean</code><br/><code> public function set keepLastResult(value:Boolean):void</code><br/><p><span class="label">See also</span></p><div class="seeAlso"><a href="AbstractInvoker.html#keepLastResult" target="">mx.rpc.AbstractInvoker.keepLastResult</a></div></div><a name="propertyDetail"></a><a name="managers"></a><table class="detailHeader" cellpadding="0" cellspacing="0"><tr><td class="detailHeaderName">managers</td><td class="detailHeaderType">property</td><td class="detailHeaderRule"> </td></tr></table><div class="detailBody"><code>managers:Array</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> |
| The managers property stores a list of data managers which modify the |
| behavior of this service. You can use this hook to define one or more |
| manager components associated with this service. When this property is set, |
| if the managers have a property called "service" that property is set to |
| the value of this service. When this service is initialized, we also call |
| the initialize method on any manager components. |
| </p><br/><span class="label"> Implementation </span><br/><code> public function get managers():Array</code><br/><code> public function set managers(value:Array):void</code><br/></div><a name="propertyDetail"></a><a name="operations"></a><table class="detailHeader" cellpadding="0" cellspacing="0"><tr><td class="detailHeaderName">operations</td><td class="detailHeaderType">property</td><td class="detailHeaderRule"> </td></tr></table><div class="detailBody"><code>operations: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 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> |
| The Operations array is usually only set by the MXML compiler if you |
| create a service using an MXML tag. |
| </p><br/><span class="label"> Implementation </span><br/><code> public function get operations():Object</code><br/><code> public function set operations(value:Object):void</code><br/></div><a name="propertyDetail"></a><a name="requestTimeout"></a><table class="detailHeader" cellpadding="0" cellspacing="0"><tr><td class="detailHeaderName">requestTimeout</td><td class="detailHeaderType">property</td><td class="detailHeaderRule"> </td></tr></table><div class="detailBody"><code>requestTimeout:int</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> |
| Provides access to the request timeout in seconds for sent messages. |
| A value less than or equal to zero prevents request timeout. |
| </p><br/><span class="label"> Implementation </span><br/><code> public function get requestTimeout():int</code><br/><code> public function set requestTimeout(value:int):void</code><br/></div><a name="constructorDetail"></a><div class="detailSectionHeader">Constructor Detail</div><a name="AbstractService()"></a><a name="AbstractService(String)"></a><table class="detailHeader" cellpadding="0" cellspacing="0"><tr><td class="detailHeaderName">AbstractService</td><td class="detailHeaderParens">()</td><td class="detailHeaderType">Constructor</td></tr></table><div class="detailBody"><code>public function AbstractService(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> |
| Constructor. |
| |
| </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> — The destination of the service. |
| </td></tr></table></div><a name="methodDetail"></a><div class="detailSectionHeader">Method Detail</div><a name="disconnect()"></a><table class="detailHeader" cellpadding="0" cellspacing="0"><tr><td class="detailHeaderName">disconnect</td><td class="detailHeaderParens">()</td><td class="detailHeaderType">method</td></tr></table><div class="detailBody"><code> public function disconnect():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> |
| Disconnects the service's network connection and removes any pending |
| request responders. |
| This method does not wait for outstanding network operations to complete. |
| </p></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><td class="detailHeaderRule"> </td></tr></table><div class="detailBody"><code> 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, subclasses are responsible for creating it 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="initialize()"></a><table class="detailHeader" cellpadding="0" cellspacing="0"><tr><td class="detailHeaderName">initialize</td><td class="detailHeaderParens">()</td><td class="detailHeaderType">method</td><td class="detailHeaderRule"> </td></tr></table><div class="detailBody"><code> public function initialize():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> |
| Called to initialize the service. |
| </p></div><a name="logout()"></a><table class="detailHeader" cellpadding="0" cellspacing="0"><tr><td class="detailHeaderName">logout</td><td class="detailHeaderParens">()</td><td class="detailHeaderType">method</td><td class="detailHeaderRule"> </td></tr></table><div class="detailBody"><code> public function logout():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> |
| Logs the user out of the destination. |
| Logging out of a destination applies to everything connected using the |
| same ChannelSet as specified in the server configuration. For example, |
| if you're connected over the my-rtmp channel and you log out using one |
| of your RPC components, anything that was connected over the same |
| ChannelSet is logged out. |
| <p><b>Note:</b> Adobe recommends that you use the mx.messaging.ChannelSet.logout() method |
| rather than this method. </p> |
| </p><p><span class="label">See also</span></p><div class="seeAlso"><a href="../../mx/messaging/ChannelSet.html#logout()" target="">mx.messaging.ChannelSet.logout()</a></div></div><a name="setCredentials()"></a><a name="setCredentials(String,String,String)"></a><table class="detailHeader" cellpadding="0" cellspacing="0"><tr><td class="detailHeaderName">setCredentials</td><td class="detailHeaderParens">()</td><td class="detailHeaderType">method</td><td class="detailHeaderRule"> </td></tr></table><div class="detailBody"><code> public function setCredentials(username:String, password: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> |
| Sets the credentials for the destination accessed by the service when using Data Services on the server side. |
| The credentials are applied to all services connected over the same |
| ChannelSet. Note that services that use a proxy or a third-party adapter |
| to a remote endpoint will need to setRemoteCredentials 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">username</span>:String</code> — The username for the destination. |
| </td></tr><tr><td class="paramSpacer"> </td></tr><tr><td width="20px"></td><td><code><span class="label">password</span>:String</code> — The password for the destination. |
| </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 |
| 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="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> 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> |
| The username and password to be used to authenticate a user when |
| accessing a remote, third-party endpoint such as a web service through a |
| proxy or a remote object through a custom adapter when using Data Services on the server side. |
| </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><div class="detailSectionHeader"> Event Detail </div><a name="event:fault"></a><table class="detailHeader" cellpadding="0" cellspacing="0"><tr><td class="detailHeaderName">fault</td><td class="detailHeaderType"> Event </td></tr></table><div class="detailBody"><span class="label">Event Object Type: </span><a href="../../mx/rpc/events/FaultEvent.html"><code>mx.rpc.events.FaultEvent</code></a><br/><span class="label">FaultEvent.type property = </span><a href="../../mx/rpc/events/FaultEvent.html#FAULT"><code>mx.rpc.events.FaultEvent.FAULT</code></a><br/><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> |
| The fault event is dispatched when a service call fails and isn't handled by |
| the Operation itself. |
| </p> |
| The FAULT event type. |
| <p>The properties of the event object have the following values:</p> |
| <table class="innertable" ><tr><th>Property</th><th>Value</th></tr><tr><td><code>bubbles</code></td><td>false</td></tr><tr><td><code>cancelable</code></td><td>true, calling preventDefault() |
| from the associated token's responder.fault method will prevent |
| the service or operation from dispatching this event</td></tr><tr><td><code>currentTarget</code></td><td>The Object that defines the |
| event listener that handles the event. For example, if you use |
| <code>myButton.addEventListener()</code> to register an event listener, |
| myButton is the value of the <code>currentTarget</code>. </td></tr><tr><td><code>fault</code></td><td>The Fault object that contains the |
| details of what caused this event.</td></tr><tr><td><code>message</code></td><td>The Message associated with this event.</td></tr><tr><td><code>target</code></td><td>The Object that dispatched the event; |
| it is not always the Object listening for the event. |
| Use the <code>currentTarget</code> property to always access the |
| Object listening for the event.</td></tr><tr><td><code>token</code></td><td>The token that represents the call |
| to the method. Used in the asynchronous completion token pattern.</td></tr></table> |
| </div><a name="event:invoke"></a><table class="detailHeader" cellpadding="0" cellspacing="0"><tr><td class="detailHeaderName">invoke</td><td class="detailHeaderType"> Event </td><td class="detailHeaderRule"> </td></tr></table><div class="detailBody"><span class="label">Event Object Type: </span><a href="../../mx/rpc/events/InvokeEvent.html"><code>mx.rpc.events.InvokeEvent</code></a><br/><span class="label">InvokeEvent.type property = </span><a href="../../mx/rpc/events/InvokeEvent.html#INVOKE"><code>mx.rpc.events.InvokeEvent.INVOKE</code></a><br/><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> |
| 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. |
| </p> |
| The INVOKE event type. |
| |
| <p>The properties of the event object have the following values:</p> |
| <table class="innertable" ><tr><th>Property</th><th>Value</th></tr><tr><td><code>bubbles</code></td><td>false</td></tr><tr><td><code>token</code></td><td> The token that represents the indiviudal call |
| to the method. Used in the asynchronous completion token pattern.</td></tr><tr><td><code>cancelable</code></td><td>true</td></tr><tr><td><code>currentTarget</code></td><td>The Object that defines the |
| event listener that handles the event. For example, if you use |
| <code>myButton.addEventListener()</code> to register an event listener, |
| myButton is the value of the <code>currentTarget</code>. </td></tr><tr><td><code>message</code></td><td> The request Message associated with this event.</td></tr><tr><td><code>target</code></td><td>The Object that dispatched the event; |
| it is not always the Object listening for the event. |
| Use the <code>currentTarget</code> property to always access the |
| Object listening for the event.</td></tr></table> |
| </div><a name="event:result"></a><table class="detailHeader" cellpadding="0" cellspacing="0"><tr><td class="detailHeaderName">result</td><td class="detailHeaderType"> Event </td><td class="detailHeaderRule"> </td></tr></table><div class="detailBody"><span class="label">Event Object Type: </span><a href="../../mx/rpc/events/ResultEvent.html"><code>mx.rpc.events.ResultEvent</code></a><br/><span class="label">ResultEvent.type property = </span><a href="../../mx/rpc/events/ResultEvent.html#RESULT"><code>mx.rpc.events.ResultEvent.RESULT</code></a><br/><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> |
| The result event is dispatched when a service call successfully returns and |
| isn't handled by the Operation itself. |
| </p> |
| The RESULT event type. |
| <p>The properties of the event object have the following values:</p> |
| <table class="innertable" ><tr><th>Property</th><th>Value</th></tr><tr><td><code>bubbles</code></td><td>false</td></tr><tr><td><code>cancelable</code></td><td>true, preventDefault() |
| from the associated token's responder.result method will prevent |
| the service or operation from dispatching this event</td></tr><tr><td><code>currentTarget</code></td><td>The Object that defines the |
| event listener that handles the event. For example, if you use |
| <code>myButton.addEventListener()</code> to register an event listener, |
| myButton is the value of the <code>currentTarget</code>. </td></tr><tr><td><code>message</code></td><td> The Message associated with this event.</td></tr><tr><td><code>target</code></td><td>The Object that dispatched the event; |
| it is not always the Object listening for the event. |
| Use the <code>currentTarget</code> property to always access the |
| Object listening for the event.</td></tr><tr><td><code>result</code></td><td>Result that the RPC call returns.</td></tr><tr><td><code>token</code></td><td>The token that represents the indiviudal call |
| to the method. Used in the asynchronous completion token pattern.</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 --> |
