ActionScript® 3.0 Reference for the Adobe® Flash® Platform
Home  |  Show Packages and Classes List |  Packages  |  Classes  |  What's New  |  Index  |  Appendixes
com.adobe.gravity.utility.async 

AggregatingToken  - AS3 ADEP Client Component

Packagecom.adobe.gravity.utility.async
Classpublic class AggregatingToken
InheritanceAggregatingToken Inheritance Object
Implements IToken

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

AggregatingToken objects are returned from functions that initiate multiple asynchronous operations and must accumulate the results. You are guaranteed that either the fault handlers or the success handlers will be invoked, depending on whether the operation succeeded or failed. Return values should always be of type IToken, the caller should not need to be aware that result aggregation occurred.

The parameters passed to the success handler are the combination of all the parameters for the success handlers of the aggregated tokens, in the order in which the tokens were added.



Public Properties
 PropertyDefined By
 Inheritedconstructor : Object
A reference to the class object or constructor function for a given object instance.
Object
Public Methods
 MethodDefined By
  
Constructor.
AggregatingToken
  
addFaultHandler(handler:Function, weakReference:Boolean = false):void
Add a handler to be called if the operation fails.
AggregatingToken
  
addSuccessHandler(handler:Function, weakReference:Boolean = false):void
Add a handler to be called if the operation succeeds.
AggregatingToken
  
Add a token to be aggregated.
AggregatingToken
  
Indicates that all IToken objects to be aggregated have been added.
AggregatingToken
 Inherited
Indicates whether an object has a specified property defined.
Object
 Inherited
Indicates whether an instance of the Object class is in the prototype chain of the object specified as the parameter.
Object
 Inherited
Indicates whether the specified property exists and is enumerable.
Object
  
Remove a fault handler.
AggregatingToken
  
Remove a success handler.
AggregatingToken
 Inherited
Sets the availability of a dynamic property for loop operations.
Object
 Inherited
Returns the string representation of this object, formatted according to locale-specific conventions.
Object
 Inherited
Returns the string representation of the specified object.
Object
 Inherited
Returns the primitive value of the specified object.
Object
Constructor Detail

AggregatingToken

()Constructor
public function AggregatingToken()

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

Constructor.

Method Detail

addFaultHandler

()method
public function addFaultHandler(handler: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

Add a handler to be called if the operation fails.

Parameters

handler:Function — A function to be called if the operation fails.
 
weakReference:Boolean (default = false) — Use a weak reference to hold onto the handler.

addSuccessHandler

()method 
public function addSuccessHandler(handler: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

Add a handler to be called if the operation succeeds.

Parameters

handler:Function — A function to be called if the operation succeeds.
 
weakReference:Boolean (default = false) — Use a weak reference to hold onto the handler.

addToken

()method 
public function addToken(token:com.adobe.gravity.utility.async:IToken):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

Add a token to be aggregated.

NOTE: You must call doneAddingTokens() when you are done adding tokens, otherwise your success or fault handlers will never be called.

Parameters

token:com.adobe.gravity.utility.async:IToken — The token to be aggregated.

doneAddingTokens

()method 
public function doneAddingTokens():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

Indicates that all IToken objects to be aggregated have been added.

Only after doneAddingTokens is called will success or fault handlers be invoked. Note that this is true even if all tokens have already indicated completion before doneAddingTokens is called (in which case the call to doneAddingTokens itself will trigger invocation of the success or fault handlers).

NOTE: doneAddingTokens can only be called once. Additional calls to doneAddingTokens will have no effect.

removeFaultHandler

()method 
public function removeFaultHandler(handler:Function):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

Remove a fault handler.

Parameters

handler:Function — The handler to be removed.

removeSuccessHandler

()method 
public function removeSuccessHandler(handler:Function):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

Remove a success handler.

Parameters

handler:Function — The handler to remove.