| Package | mx.rpc |
| Class | public class CallResponder |
| Inheritance | CallResponder  EventDispatcher Object |
| Implements | IResponder |
| Language Version: | ActionScript 3.0 |
| Product Version: | Flex 3 |
| Runtime Versions: | Flash Player 9, AIR 1.1 |
You set the token property of this component to the AsyncToken returned by the
service. You can then add event listeners on this component instead of having to
add them to each AsyncToken returned. This component also maintains the
lastResult property which is a copy of the value returned by the last successful
result event dispatched by a token monitored by this service. Though you can
bind to either the callResponder.token.result or
callResponder.lastResult, the latter will be preserved while a second
call to the same service is in progress while the former will be reset as soon
as a new service invocation is started.
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 | |
| lastResult : *
This property stores the result property of the token each time it
delivers a successful result. | CallResponder | ||
| token : mx.rpc:AsyncToken
Each CallResponder dispatches result and fault events received
from a single token. | CallResponder | ||
| Method | Defined By | ||
|---|---|---|---|
| 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 | |
|
Dispatches an event into the event flow. | EventDispatcher | |
This method is called by the AsyncToken when it wants to deliver a
FaultEvent to the CallResponder. | CallResponder | ||
|
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 | |
|
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 | |
This method is called by the AsyncToken when it wants to deliver a
ResultEvent to the CallResponder. | CallResponder | ||
|
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 | |
| Event | Summary | Defined By | ||
|---|---|---|---|---|
| [broadcast event] Dispatched when the Flash Player or AIR application gains operating system focus and becomes active. | EventDispatcher | ||
| [broadcast event] Dispatched when the Flash Player or AIR application operating loses system focus and is becoming inactive. | EventDispatcher | ||
| Dispatched when an Operation call fails. | CallResponder | |||
| Dispatched when an Operation invocation successfully returns. | CallResponder | |||
lastResult | property |
lastResult:*| Language Version: | ActionScript 3.0 |
| Product Version: | Flex 3 |
| Runtime Versions: | Flash Player 9, AIR 1.1 |
This property stores the result property of the token each time it delivers a successful result. You can bind to or access this property instead of the token.result property to keep your code from seeing that value cleared out on the second and subsequent call to a particular service method. Additionally, if a fault occurs this value will still be set to the last successful result returned by a token monitored by this CallResponder.
This property can be used as the source for data binding. When this property is modified, it dispatches the propertyChange event.
Implementation
public function get lastResult():* public function set lastResult(value:any):voidtoken | property |
token:mx.rpc:AsyncToken| Language Version: | ActionScript 3.0 |
| Product Version: | Flex 3 |
| Runtime Versions: | Flash Player 9, AIR 1.1 |
Each CallResponder dispatches result and fault events received from a single token. This property value specifies that token. You typically set this property to the AsyncToken object returned by the service.
This property can be used as the source for data binding. When this property is modified, it dispatches the propertyChange event.
Implementation
public function get token():mx.rpc:AsyncToken public function set token(value:mx.rpc:AsyncToken):voidfault | () | method |
public function fault(data:Object):void| Language Version: | ActionScript 3.0 |
| Product Version: | Flex 3 |
| Runtime Versions: | Flash Player 9, AIR 1.1 |
This method is called by the AsyncToken when it wants to deliver a
FaultEvent to the CallResponder. You do not call
this method directly.
Parameters
data:Object — The FaultEvent delivered by the AsyncToken
|
result | () | method |
public function result(data:Object):void| Language Version: | ActionScript 3.0 |
| Product Version: | Flex 3 |
| Runtime Versions: | Flash Player 9, AIR 1.1 |
This method is called by the AsyncToken when it wants to deliver a
ResultEvent to the CallResponder. You do not call
this method directly.
Parameters
data:Object — The ResultEvent delivered by the AsyncToken
|
fault | Event |
mx.rpc.events.FaultEventproperty FaultEvent.type =
mx.rpc.events.FaultEvent.FAULT| Language Version: | ActionScript 3.0 |
| Product Version: | Flex 3 |
| Runtime Versions: | Flash Player 9, AIR 1.1 |
Dispatched when an Operation call fails.
The FAULT event type.The properties of the event object have the following values:
| Property | Value |
|---|---|
bubbles | false |
cancelable | true, calling preventDefault() from the associated token's responder.fault method will prevent the service or operation from dispatching this event |
currentTarget | The Object that defines the
event listener that handles the event. For example, if you use
myButton.addEventListener() to register an event listener,
myButton is the value of the currentTarget. |
fault | The Fault object that contains the details of what caused this event. |
message | The Message associated with this event. |
target | The Object that dispatched the event;
it is not always the Object listening for the event.
Use the currentTarget property to always access the
Object listening for the event. |
token | The token that represents the call to the method. Used in the asynchronous completion token pattern. |
result | Event |
mx.rpc.events.ResultEventproperty ResultEvent.type =
mx.rpc.events.ResultEvent.RESULT| Language Version: | ActionScript 3.0 |
| Product Version: | Flex 3 |
| Runtime Versions: | Flash Player 9, AIR 1.1 |
Dispatched when an Operation invocation successfully returns.
The RESULT event type.The properties of the event object have the following values:
| Property | Value |
|---|---|
bubbles | false |
cancelable | true, preventDefault() from the associated token's responder.result method will prevent the service or operation from dispatching this event |
currentTarget | The Object that defines the
event listener that handles the event. For example, if you use
myButton.addEventListener() to register an event listener,
myButton is the value of the currentTarget. |
message | The Message associated with this event. |
target | The Object that dispatched the event;
it is not always the Object listening for the event.
Use the currentTarget property to always access the
Object listening for the event. |
result | Result that the RPC call returns. |
token | The token that represents the indiviudal call to the method. Used in the asynchronous completion token pattern. |
Wed Nov 21 2018, 06:34 AM -08:00