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

IAsyncToken  - AS3 Asset Composer
Packagecom.adobe.icc.token
Interfacepublic interface IAsyncToken

Language Version: ActionScript 3.0
Product Version: Asset Composer Building Block 9.5
Runtime Versions: AIR (unsupported), Flash Player 9, Flash Player 10

Used to manage asynchronous method calls. Greatly inspired from com.adobe.utility.async.IToken except that the LC Utility SWC where the original IToken is defined cannot be used due to the refactoring effort involved at this time (2010/Apr/14). If IToken is ever incorporated, this interface could be made to extend IToken to as not to require refactoring code already using IAsyncToken.

By using an interface for basic token operations, methods can return different types of tokens without the caller needing to know what kind of token it is.

The caller may expect the token's success or fault handlers to be called depending on the result of the method call. Handlers will be called in the order in which they were added.


Public Properties
 PropertyDefined By
  data : Object
Associates custom data to this token.
IAsyncToken
  operationName : String
[read-only] Returns the operation name associated with this token or null if an operation name was not given.
IAsyncToken
Public Methods
 MethodDefined By
  
addFaultHandler(fault:Function):void
Adds a fault handler to this token.
IAsyncToken
  
addHandlers(success:Function, fault:Function):void
Adds a success and a fault handler to this token.
IAsyncToken
  
addResponder(responder:IResponder):void
Deprecated since 1.0: Please Use addHandlers, or addSuccessHandler/addFaultHandler
Adds a responder to this token.
IAsyncToken
  
addSuccessHandler(success:Function):void
Adds a success handler to this token.
IAsyncToken
Property Detail

data

property
data:Object

Language Version: ActionScript 3.0
Product Version: Asset Composer Building Block 9.5
Runtime Versions: AIR (unsupported), Flash Player 9, Flash Player 10

Associates custom data to this token.



Implementation
    public function get data():Object
    public function set data(value:Object):void

operationName

property 
operationName:String  [read-only]

Language Version: ActionScript 3.0
Product Version: Asset Composer Building Block 9.5
Runtime Versions: AIR (unsupported), Flash Player 9, Flash Player 10

Returns the operation name associated with this token or null if an operation name was not given.



Implementation
    public function get operationName():String
Method Detail

addFaultHandler

()method
public function addFaultHandler(fault:Function):void

Language Version: ActionScript 3.0
Product Version: Asset Composer Building Block 9.5
Runtime Versions: AIR (unsupported), Flash Player 9, Flash Player 10

Adds a fault handler to this token.

Parameters

fault:Function — The function to call on fault. Can be null, but it's not recommended to ignore a possible fault unless you are certain the call will not fail. Expected function signature: function(fault:Object).

addHandlers

()method 
public function addHandlers(success:Function, fault:Function):void

Language Version: ActionScript 3.0
Product Version: Asset Composer Building Block 9.5
Runtime Versions: AIR (unsupported), Flash Player 9, Flash Player 10

Adds a success and a fault handler to this token. This is a convenience over having to explicitly call addSuccessHandler() and addFaultHandler() after receiving an IToken. With this, you can simply do asyncMethod().addHandlers(function(event:ResultEvent){}, function(event:FaultEvent){});

Parameters

success:Function — The function to call on success. Can be null, but it's rare you wouldn't want to know about success. Expected function signature: function(data:Object).
 
fault:Function — The function to call on fault. Can be null, but it's not recommended to ignore a possible fault unless you are certain the call will not fail. Expected function signature: function(fault:Object).

addResponder

()method 
public function addResponder(responder:IResponder):void
Deprecated since 1.0: Please Use addHandlers, or addSuccessHandler/addFaultHandler

Language Version: ActionScript 3.0
Product Version: Asset Composer Building Block 9.5
Runtime Versions: AIR (unsupported), Flash Player 9, Flash Player 10

Adds a responder to this token. Unfortunately, this method is necessary due to the refactoring effort required in cmAdmin in order to call addHandlers (or addSuccessHandler and addFaultHandler) instead.

Parameters

responder:IResponder — The responder to add. This defines a result (success) and a fault handler to call on success or on fault, respectively.

addSuccessHandler

()method 
public function addSuccessHandler(success:Function):void

Language Version: ActionScript 3.0
Product Version: Asset Composer Building Block 9.5
Runtime Versions: AIR (unsupported), Flash Player 9, Flash Player 10

Adds a success handler to this token.

Parameters

success:Function — The function to call on success. Can be null, but it's rare you wouldn't want to know about success. Expected function signature: function(data:Object).



© 2014 Adobe Systems Incorporated. All rights reserved.
Thu Dec 4 2014, 05:50 PM -08:00
 

 

Legal Notices | Online Privacy Policy