(Preview)
| Package | mx.rpc |
| Class | public class AbstractOperation |
| Inheritance | AbstractOperation  AbstractInvoker EventDispatcher Object |
| Subclasses | AbstractOperation, Operation, Operation |
| Language Version: | ActionScript 3.0 |
| Product Version: | Flex 3 |
| Runtime Versions: | Flash Player 9, AIR 1.1 |
send() method.
Related API Elements
Public Properties
Hide Inherited Public Properties
Show Inherited Public Properties| Property | Defined By | ||
|---|---|---|---|
| arguments : Object
The arguments to pass to the Operation when it is invoked. | AbstractOperation | ||
 | constructor : Object
A reference to the class object or constructor function for a given object instance. | Object | |
| lastResult : Object [read-only]
The result of the last invocation. | AbstractInvoker | |
| makeObjectsBindable : Boolean
When this value is true, anonymous objects returned are forced to bindable objects. | AbstractInvoker | |
| name : String
The name of this Operation. | AbstractOperation | ||
| operationManager : Function
This property is set usually by framework code which wants to modify the
behavior of a service invocation without modifying the way in which the
service is called externally. | AbstractInvoker | |
| properties : Object
This is a hook primarily for framework developers to register additional user
specified properties for your operation. | AbstractOperation | ||
| resultElementType : Class
Like resultType, used to define the ActionScript class used by a given operation though
this property only applies to operations which return a multi-valued result (e.g. | AbstractInvoker | |
| resultType : Class
Specifies an optional return type for the operation. | AbstractInvoker | |
| service : AbstractService [read-only]
Provides convenient access to the service on which the Operation
is being invoked. | AbstractOperation | ||
Public Methods
| Method | Defined By | ||
|---|---|---|---|
Creates a new Operation. | AbstractOperation | ||
| 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 | |
|
Cancels the last service invocation or an invokation with the specified ID. | AbstractInvoker | |
|
Sets the result property of the invoker to null. | AbstractInvoker | |
|
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 | |
|
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 | |
Executes the method. | AbstractOperation | ||
|
Sets the availability of a dynamic property for loop operations. | Object | |
|
This hook is exposed to update the lastResult property. | AbstractInvoker | |
|
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 | |
Events
| 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. | AbstractOperation | |||
| Dispatched when an Operation invocation successfully returns. | AbstractOperation | |||
Property Detail
arguments | property |
public var arguments:Object| Language Version: | ActionScript 3.0 |
| Product Version: | Flex 3 |
| Runtime Versions: | Flash Player 9, AIR 1.1 |
The arguments to pass to the Operation when it is invoked. If you call
the send() method with no parameters, an array based on
this object is sent. If you call the send() method with
parameters (or call the function directly on the service) those
parameters are used instead of whatever is stored in this property.
For RemoteObject Operations the associated argumentNames array determines
the order of the arguments passed.
name | property |
name:String| Language Version: | ActionScript 3.0 |
| Product Version: | Flex 3 |
| Runtime Versions: | Flash Player 9, AIR 1.1 |
The name of this Operation. This is how the Operation is accessed off the service. It can only be set once.
Implementation
public function get name():String public function set name(value:String):voidproperties | property |
public var properties:Object| Language Version: | ActionScript 3.0 |
| Product Version: | Flex 3 |
| Runtime Versions: | Flash Player 9, AIR 1.1 |
This is a hook primarily for framework developers to register additional user specified properties for your operation.
service | property |
service:AbstractService [read-only] | Language Version: | ActionScript 3.0 |
| Product Version: | Flex 3 |
| Runtime Versions: | Flash Player 9, AIR 1.1 |
Provides convenient access to the service on which the Operation is being invoked. Note that the service cannot be changed after the Operation is constructed.
Implementation
public function get service():AbstractServiceConstructor Detail
AbstractOperation | () | Constructor |
public function AbstractOperation(service:AbstractService = null, name:String = null)| Language Version: | ActionScript 3.0 |
| Product Version: | Flex 3 |
| Runtime Versions: | Flash Player 9, AIR 1.1 |
Creates a new Operation. This is usually done directly by the MXML compiler or automatically by the service when an unknown Operation has been accessed. It is not recommended that a developer use this constructor directly.
Parametersservice:AbstractService (default = null) | |
name:String (default = null) |
Method Detail
send | () | method |
public function send(... args):mx.rpc:AsyncToken| Language Version: | ActionScript 3.0 |
| Product Version: | Flex 3 |
| Runtime Versions: | Flash Player 9, AIR 1.1 |
Executes the method. Any arguments passed in are passed along as part of the method call. If there are no arguments passed, the arguments object is used as the source of parameters.
Parameters
... args — Optional arguments passed in as part of the method call. If there
are no arguments passed, the arguments object is used as the source of
parameters.
|
mx.rpc:AsyncToken — AsyncToken object.
The same object is available in the result and
fault events from the token property.
|
Event Detail
fault | Event |
Event Object Type:
property FaultEvent.type =
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 |
Event Object Type:
property ResultEvent.type =
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