(Beta)
| Package | com.adobe.livecycle.rca.token |
| Class | public class RCAToken |
| Inheritance | RCAToken  AsyncToken EventDispatcher Object |
| Implements | IAsyncToken |
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) |
Public Properties
Hide Inherited Public Properties
Show Inherited Public Properties| Property | Defined By | ||
|---|---|---|---|
 | constructor : Object
A reference to the class object or constructor function for a given object instance. | Object | |
| message : IMessage [read-only]
Provides access to the associated message. | AsyncToken | |
| operationName : String [read-only]
Specifies the operation name. | RCAToken | ||
| responders : Array [read-only]
An array of IResponder handlers that will be called when
the asynchronous request completes. | AsyncToken | |
| result : Object [read-only]
The result that was returned by the associated RPC call. | AsyncToken | |
Public Methods
| Method | Defined By | ||
|---|---|---|---|
Constructs a RCAToken. | RCAToken | ||
| addEventListener(type:String, listener:Function, useCapture:Boolean = false, priority:int = 0, useWeakReference:Boolean = false):void
Registers an event listener object with an EventDispatcher object so that the listener
receives notification of an event. | EventDispatcher | |
Adds a fault handler to this token. | RCAToken | ||
Adds success and fault handlers to this token. | RCAToken | ||
[override]
Adds a responder to this token. | RCAToken | ||
Adds a success handler to this token. | RCAToken | ||
Calls all fault handlers that are associated with this token. | RCAToken | ||
Calls all success handlers that are associated with this token. | RCAToken | ||
|
Dispatches an event into the event flow. | EventDispatcher | |
|
Checks whether the EventDispatcher object has any listeners registered for a specific type
of event. | EventDispatcher | |
|
Indicates whether an object has a specified property defined. | Object | |
|
Determines if this token has at least one mx.rpc.IResponder registered. | AsyncToken | |
|
Indicates whether an instance of the Object class is in the prototype chain of the object specified
as the parameter. | Object | |
|
Indicates whether the specified property exists and is enumerable. | Object | |
|
Removes a listener from the EventDispatcher object. | EventDispatcher | |
|
Sets the availability of a dynamic property for loop operations. | Object | |
|
Returns the string representation of this object, formatted according to locale-specific conventions. | Object | |
|
Returns the string representation of the specified object. | Object | |
|
Returns the primitive value of the specified object. | Object | |
|
Checks whether an event listener is registered with this EventDispatcher object or any of
its ancestors for the specified event type. | EventDispatcher | |
Property Detail
operationName | property |
Constructor Detail
RCAToken | () | Constructor |
public function RCAToken(operationName:String = "", message:IMessage = null)| 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) |
Constructs a RCAToken.
operationName:String (default = " | |
message:IMessage (default = null) |
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 |
override 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).
|
callFaultHandlers | () | method |
public function callFaultHandlers(fault:Object):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) |
Calls all fault handlers that are associated with this token.
Parameters
fault:Object — The fault to pass to each fault handler invocation.
|
callSuccessHandlers | () | method |
public function callSuccessHandlers(data:Object):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) |
Calls all success handlers that are associated with this token.
Parameters
data:Object — The data to pass to each success handler invocation.
|
Wed Nov 21 2018, 06:34 AM -08:00