| Package | com.adobe.livecycle.rca.token |
| Interface | public interface IAsyncToken |
| Implementors | RCAToken |
Deprecated since Review, Commenting, and Approval 10New Review, Commenting, and Approval APIs use mx.rpc.AsyncToken
| Language Version: | ActionScript 3.0 |
| Product Version: | Review, Commenting, and Approval Building Block 9.5 |
| Runtime Versions: | Flash Player 9, Flash Player 10, AIR (unsupported) |
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.
Public Methods
| Method | Defined By | ||
|---|---|---|---|
Adds a fault handler to this token. | IAsyncToken | ||
Adds success and fault handlers to this token. | IAsyncToken | ||
Adds a responder to this token. | IAsyncToken | ||
Adds a success handler to this token. | IAsyncToken | ||
Method Detail
addFaultHandler | () | method |
public function addFaultHandler(fault:Function):void| Language Version: | ActionScript 3.0 |
| Product Version: | Review, Commenting, and Approval Building Block 9.5 |
| Runtime Versions: | Flash Player 9, Flash Player 10, AIR (unsupported) |
Adds a fault handler to this token.
Parameters
fault:Function — The function to call on fault. Can be null, but ignoring a possible fault is not recommended unless
you are certain the call cannot fail. The expected function signature is function(fault:Object).
|
addHandlers | () | method |
public function addHandlers(success:Function, fault:Function):void| Language Version: | ActionScript 3.0 |
| Product Version: | Review, Commenting, and Approval Building Block 9.5 |
| Runtime Versions: | Flash Player 9, Flash Player 10, AIR (unsupported) |
Adds success and fault handlers to this token. Adding handlers is more convenient than explicitly calling addSuccessHandler()
and addFaultHandler() after receiving an IToken. Instead, you can use
asyncMethod().addHandlers(function(event:ResultEvent){}, function(event:FaultEvent){});
Parameters
success:Function — The function to call on success. Can be null, but in most cases, you want to call a function on success.
The expected function signature is function(data:Object).
| |
fault:Function — The function to call on fault. Can be null, but ignoring a fault is not recommended unless
you are certain that the call cannot fail. The expected function signature is function(fault:Object).
|
addResponder | () | method |
public function addResponder(responder:IResponder):void| Language Version: | ActionScript 3.0 |
| Product Version: | Review, Commenting, and Approval Building Block 9.5 |
| Runtime Versions: | Flash Player 9, Flash Player 10, AIR (unsupported) |
Adds a responder to this token.
Parameters
responder:IResponder — The responder to add. This responder defines a result or success handler to call on success, and a fault handler to call on fault.
|
addSuccessHandler | () | method |
public function addSuccessHandler(success:Function):void| Language Version: | ActionScript 3.0 |
| Product Version: | Review, Commenting, and Approval Building Block 9.5 |
| Runtime Versions: | Flash Player 9, Flash Player 10, AIR (unsupported) |
Adds a success handler to this token.
Parameters
success:Function — The function to call on success. Can be null, but in most cases, you want to call a function on success.
The expected function signature is function(data:Object).
|
Thu Dec 6 2018, 01:12 PM -08:00