Apache Flex 4.16.0 API Reference | All Packages | All Classes | Index | Frames No Frames |
AbstractInvoker

Package | mx.rpc
Class | public class AbstractInvoker
Inheritance | AbstractInvoker flash.events.EventDispatcher
Subclasses | AbstractOperation, HTTPService

Language Version : | ActionScript 3.0

Product Version : | Flex 3

Runtime Versions : | Flash Player 9, AIR 1.1

An invoker is an object that actually executes a remote procedure call (RPC). For example, RemoteObject, HTTPService, and WebService objects are invokers.

Public Properties

| Property | Defined By
--- | --- | ---
|  | keepLastResult : Boolean Flag indicating whether the operation should keep its last call result for later access. | AbstractInvoker
|  | 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
|  | 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
|  | 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

Public Methods

| Method | Defined By
--- | --- | ---
|  | cancel(id:String = null):AsyncToken Cancels the last service invocation or an invokation with the specified ID. | AbstractInvoker
|  | clearResult(fireBindingEvent:Boolean = true):void Sets the result property of the invoker to null. | AbstractInvoker
|  | setResult(result:Object):void This hook is exposed to update the lastResult property. | AbstractInvoker

Property Detail

keepLastResult | property

`keepLastResult:Boolean`

Product Version : | Flex 4.11

Runtime Versions : | Flash Player 10, AIR 3

Flag indicating whether the operation should keep its last call result for later access.

If set to true, the last call result will be accessible through `lastResult` bindable property.

If set to false, the last call result will be cleared after the call, and must be processed in the operation's result handler. This will allow the result object to be garbage collected, which is especially useful if the operation is only called a few times and returns a large result.

If not set, will use the `keepLastResult` value of its owning Service, if any, or the default value.

The default value is `true`.

Implementation
`public function get keepLastResult():Boolean`
`public function set keepLastResult(value:Boolean):void`

See also

lastResult
mx.rpc.AbstractService.keepLastResult

lastResult | property |

`lastResult:Object` [read-only]

Language Version : | ActionScript 3.0

Product Version : | Flex 3

Runtime Versions : | Flash Player 9, AIR 1.1

The result of the last invocation.

This property can be used as the source for data binding.

Implementation
`public function get lastResult():Object`

makeObjectsBindable | property |

`makeObjectsBindable:Boolean`

Language Version : | ActionScript 3.0

Product Version : | Flex 3

Runtime Versions : | Flash Player 9, AIR 1.1

When this value is true, anonymous objects returned are forced to bindable objects.

Implementation
`public function get makeObjectsBindable():Boolean`
`public function set makeObjectsBindable(value:Boolean):void`

operationManager | property |

`public var operationManager:Function`

Language Version : | ActionScript 3.0

Product Version : | Flex 3

Runtime Versions : | Flash Player 9, AIR 1.1

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. This allows you to add a "filter" step on the method call to ensure for example that you do not return duplicate instances for the same id or to insert parameters for performing on-demand paging. When this is set to a non-null value on the send call, the operationManager function is called instead. It returns the token that the caller uses to be notified of the result. Typically the called function will at some point clear this property temporarily, then invoke the operation again actually sending it to the server this time.

resultElementType | property |

`public var resultElementType:Class`

Language Version : | ActionScript 3.0

Product Version : | Flex 3

Runtime Versions : | Flash Player 9, AIR 1.1

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. an Array or ArrayCollection (IList)). This property specifies an ActionScript class for the members of the array or array collection. When you set resultElementType, you do not have to set resultType. In that case, the operation returns an Array if makeObjectsbindable is false and an ArrayCollection otherwise.

resultType | property |

`public var resultType:Class`

Language Version : | ActionScript 3.0

Product Version : | Flex 3

Runtime Versions : | Flash Player 9, AIR 1.1

Specifies an optional return type for the operation. Used in situations where you want to coerce the over-the-wire information into a specific ActionScript class or to provide metadata for other services as to the return type of this operation.

Method Detail

cancel | () | method

`public function cancel(id:String = null):AsyncToken`

Language Version : | ActionScript 3.0

Product Version : | Flex 3

Runtime Versions : | Flash Player 9, AIR 1.1

Cancels the last service invocation or an invokation with the specified ID. Even though the network operation may still continue, no result or fault event is dispatched.

Parameters

| `id:String` (default = `null`)`` — The messageId of the invocation to cancel. Optional. If omitted, the last service invocation is canceled.

Returns

| `AsyncToken` — The AsyncToken associated with the call that is cancelled or null if no call was cancelled.

clearResult | () | method |

`public function clearResult(fireBindingEvent:Boolean = true):void`

Language Version : | ActionScript 3.0

Product Version : | Flex 3

Runtime Versions : | Flash Player 9, AIR 1.1

Sets the `result` property of the invoker to `null`. This is useful when the result is a large object that is no longer being used.

Parameters

| `fireBindingEvent:Boolean` (default = `true`)`` — Set to `true` if you want anything bound to the result to update. Otherwise, set to `false`. The default value is `true`

setResult | () | method |

`public function setResult(result:Object):void`

Language Version : | ActionScript 3.0

Product Version : | Flex 3

Runtime Versions : | Flash Player 9, AIR 1.1

This hook is exposed to update the lastResult property. Since lastResult is ordinarily updated automatically by the service, you do not typically call this. It is used by managed services that want to ensure lastResult always points to "the" managed instance for a given identity even if the the service returns a new copy of the same object.

Parameters

| `result:Object` — The new value for the lastResult property.

Sun Mar 5 2017, 03:42 PM +11:00