ActionScript® 3.0 Reference for the Adobe® Flash® Platform
Home  |  Show Packages and Classes List |  Packages  |  Classes  |  What's New  |  Index  |  Appendixes
 

Package com.adobe.gravity.utility.async 


Public Methods
 FunctionDefined By
  
addHandlers(token:com.adobe.gravity.utility.async:IToken, successHandler:Function, faultHandler:Function, weakReference:Boolean = false):void
A convenience function for adding a success and fault handler without declaring a local variable.
com.adobe.gravity.utility.async
  
Create an adapter function that calls the provided function with the provided parameters, appending any parameters passed in when it is invoked.
com.adobe.gravity.utility.async
  
Create an adapter function that calls the provided function with the provided parameters, ignoring any parameters passed in when it is invoked.
com.adobe.gravity.utility.async
  
injector(target:Object, propertyName:String):Function
A convenience method for a success handler.
com.adobe.gravity.utility.async
Function detail

addHandlers

()function
public function addHandlers(token:com.adobe.gravity.utility.async:IToken, successHandler:Function, faultHandler:Function, weakReference:Boolean = false):void

Language Version: ActionScript 3.0
Product Version: Adobe Digital Enterprise Platform Experience Services - Client Component Framework 10
Runtime Versions: AIR 1.1, Flash Player 9

A convenience function for adding a success and fault handler without declaring a local variable. Instead of

     var token:IToken = context.getService(reference);
     token.addSuccessHandler(successHandler);
     token.addFailureHandler(faultHandler);
     
this convenience function allows for
     addHandlers(context.getService(reference), successHandler, faultHandler);
     
Note that in many cases, code similar to the first example will be easier to read. However, elimination of the local variable can reduce potential confusion between multiple local IToken variables.

Parameters

token:com.adobe.gravity.utility.async:IToken — The token on which to add the success and fault handler.
 
successHandler:Function — The success handler.
 
faultHandler:Function — The fault handler.
 
weakReference:Boolean (default = false) — Whether to use a weak reference.

Related API Elements

addParams

()function 
public function addParams(func:Function, ... params):Function

Language Version: ActionScript 3.0
Product Version: Adobe Digital Enterprise Platform Experience Services - Client Component Framework 10
Runtime Versions: AIR 1.1, Flash Player 9

Create an adapter function that calls the provided function with the provided parameters, appending any parameters passed in when it is invoked. The returned adapter function will accept any number of parameters to be appended.

Parameters

func:Function — The function to adapt.
 
... params — An arbitrary number of additional parameters to be passed to the provided function when the returned adapter function is called.

Returns
Function — A Function object that when invoked will call the provided function with any parameters passed into it appended to the list of parameters passed into the call to addParams.

fixParams

()function 
public function fixParams(func:Function, ... params):Function

Language Version: ActionScript 3.0
Product Version: Adobe Digital Enterprise Platform Experience Services - Client Component Framework 10
Runtime Versions: AIR 1.1, Flash Player 9

Create an adapter function that calls the provided function with the provided parameters, ignoring any parameters passed in when it is invoked. The returned adapter function will accept (and ignore) any number of parameters.

Parameters

func:Function — The function to adapt.
 
... params — An arbitrary number of additional parameters to be passed to the provided function when the returned adapter function is called.

Returns
Function — A Function object that when invoked will call the provided function with the list of parameters passed into the call to fixParams; any parameters passed to the return function will be ignored.

injector

()function 
public function injector(target:Object, propertyName:String):Function

Language Version: ActionScript 3.0
Product Version: Adobe Digital Enterprise Platform Experience Services - Client Component Framework 10
Runtime Versions: AIR 1.1, Flash Player 9

A convenience method for a success handler. Typical usage: commandSenderToken.addSuccessHandler( injector( this, "commandSender" ) );

Parameters

target:Object — The object on which to set the property.
 
propertyName:String — The name of the property to set.

Returns
Function — A function that takes a single object as a parameter and sets that object into the specified property of the target.