| Package | mx.rpc.remoting |
| Class | public dynamic class RemoteObject |
| Inheritance | RemoteObject  AbstractService Proxy |
| Subclasses | RemoteObject |
| Language Version: | ActionScript 3.0 |
| Product Version: | Flex 3 |
| Runtime Versions: | Flash Player 9, AIR 1.1 |
Hide Inherited Public Properties
Show Inherited Public Properties| Property | Defined By | ||
|---|---|---|---|
 | channelSet : ChannelSet
Provides access to the ChannelSet used by the service. | AbstractService | |
| concurrency : String
Value that indicates how to handle multiple calls to the same service. | RemoteObject | ||
| convertParametersHandler : Function
An optional function, primarily intended for framework developers who need to install
a function to get called with the parameters passed to each remote object invocation. | RemoteObject | ||
| convertResultHandler : Function
An optional function, primarily intended for framework developers who need to install
a hook to process the results of an operation before notifying the result handlers. | RemoteObject | ||
| destination : String
The destination of the service. | AbstractService | |
| endpoint : String
This property allows the developer to quickly specify an endpoint for a RemoteObject
destination without referring to a services configuration file at compile time or programmatically creating
a ChannelSet. | RemoteObject | ||
| makeObjectsBindable : Boolean
When this value is true, anonymous objects returned are forced to bindable objects. | RemoteObject | ||
| managers : Array
The managers property stores a list of data managers which modify the
behavior of this service. | AbstractService | |
| operations : Object
The Operations array is usually only set by the MXML compiler if you
create a service using an MXML tag. | AbstractService | |
| requestTimeout : int
Provides access to the request timeout in seconds for sent messages. | AbstractService | |
| showBusyCursor : Boolean
If true, a busy cursor is displayed while a service is executing. | RemoteObject | ||
| source : String
Lets you specify a source value on the client; not supported for destinations that use the JavaAdapter. | RemoteObject | ||
| Method | Defined By | ||
|---|---|---|---|
RemoteObject(destination:String = null)
Creates a new RemoteObject. | RemoteObject | ||
|
Disconnects the service's network connection and removes any pending
request responders. | AbstractService | |
[override]
Returns an Operation of the given name. | RemoteObject | ||
|
Called to initialize the service. | AbstractService | |
|
Logs the user out of the destination. | AbstractService | |
|
Sets the credentials for the destination accessed by the service when using Data Services on the server side. | AbstractService | |
[override]
If a remote object is managed by an external service, such a ColdFusion Component (CFC),
a username and password can be set for the authentication mechanism of that remote service. | RemoteObject | ||
Represents an instance of RemoteObject as a String, describing
important properties such as the destination id and the set of
channels assigned. | RemoteObject | ||
concurrency | property |
concurrency:String| Language Version: | ActionScript 3.0 |
| Product Version: | Flex 3 |
| Runtime Versions: | Flash Player 9, AIR 1.1 |
Value that indicates how to handle multiple calls to the same service. The default value is multiple. The following values are permitted:
- multiple - Existing requests are not cancelled, and the developer is responsible for ensuring the consistency of returned data by carefully managing the event stream. This is the default.
- single - Making only one request at a time is allowed on the method; additional requests made while a request is outstanding are immediately faulted on the client and are not sent to the server.
- last - Making a request causes the client to ignore a result or fault for any current outstanding request. Only the result or fault for the most recent request will be dispatched on the client. This may simplify event handling in the client application, but care should be taken to only use this mode when results or faults for requests may be safely ignored.
Implementation
public function get concurrency():String public function set concurrency(value:String):voidconvertParametersHandler | property |
public var convertParametersHandler:Function| Language Version: | ActionScript 3.0 |
| Product Version: | Flex 3 |
| Runtime Versions: | Flash Player 9, AIR 1.1 |
An optional function, primarily intended for framework developers who need to install
a function to get called with the parameters passed to each remote object invocation.
The function takes an array of parameters and returns the potentially altered array.
The function definition should look like:
function myParametersFunction(parameters:Array):Array
convertResultHandler | property |
public var convertResultHandler:Function| Language Version: | ActionScript 3.0 |
| Product Version: | Flex 3 |
| Runtime Versions: | Flash Player 9, AIR 1.1 |
An optional function, primarily intended for framework developers who need to install
a hook to process the results of an operation before notifying the result handlers.
The function definition should look like:
function myConvertResultsFunction(result: operation:AbstractOperation):
It is passed the result just after the makeObjectsBindable conversion has been done
but before the result event is created.
endpoint | property |
endpoint:String| Language Version: | ActionScript 3.0 |
| Product Version: | Flex 3 |
| Runtime Versions: | Flash Player 9, AIR 1.1 |
This property allows the developer to quickly specify an endpoint for a RemoteObject destination without referring to a services configuration file at compile time or programmatically creating a ChannelSet. It also overrides an existing ChannelSet if one has been set for the RemoteObject service.
If the endpoint url starts with "https" a SecureAMFChannel will be used, otherwise an AMFChannel will be used. Two special tokens, {server.name} and {server.port}, can be used in the endpoint url to specify that the channel should use the server name and port that was used to load the SWF.
Note: This property is required when creating AIR applications.
Implementation
public function get endpoint():String public function set endpoint(value:String):voidmakeObjectsBindable | 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):voidshowBusyCursor | property |
showBusyCursor:Boolean| Language Version: | ActionScript 3.0 |
| Product Version: | Flex 3 |
| Runtime Versions: | Flash Player 9, AIR 1.1 |
If true, a busy cursor is displayed while a service is executing. The default
value is false.
Implementation
public function get showBusyCursor():Boolean public function set showBusyCursor(value:Boolean):voidsource | property |
source:String| Language Version: | ActionScript 3.0 |
| Product Version: | Flex 3 |
| Runtime Versions: | Flash Player 9, AIR 1.1 |
Lets you specify a source value on the client; not supported for destinations that use the JavaAdapter. This allows you to provide more than one source that can be accessed from a single destination on the server.
Implementation
public function get source():String public function set source(value:String):voidRemoteObject | () | Constructor |
public function RemoteObject(destination:String = null)| Language Version: | ActionScript 3.0 |
| Product Version: | Flex 3 |
| Runtime Versions: | Flash Player 9, AIR 1.1 |
Creates a new RemoteObject.
Parametersdestination:String (default = null) |
getOperation | () | method |
override public function getOperation(name:String):AbstractOperation| Language Version: | ActionScript 3.0 |
| Product Version: | Flex 3 |
| Runtime Versions: | Flash Player 9, AIR 1.1 |
Returns an Operation of the given name. If the Operation wasn't
created beforehand, a new mx.rpc.remoting.Operation is
created during this call. Operations are usually accessible by simply
naming them after the service variable
(myService.someOperation), but if your Operation name
happens to match a defined method on the service
(like setCredentials), you can use this method to get the
Operation instead.
Parameters
name:String — Name of the Operation.
|
AbstractOperation — Operation that executes for this name.
|
setRemoteCredentials | () | method |
override public function setRemoteCredentials(remoteUsername:String, remotePassword:String, charset:String = null):void| Language Version: | ActionScript 3.0 |
| Product Version: | Flex 3 |
| Runtime Versions: | Flash Player 9, AIR 1.1 |
If a remote object is managed by an external service, such a ColdFusion Component (CFC), a username and password can be set for the authentication mechanism of that remote service.
Parameters
remoteUsername:String — the username to pass to the remote endpoint
| |
remotePassword:String — the password to pass to the remote endpoint
| |
charset:String (default = null) |
toString | () | method |
public function toString():String| Language Version: | ActionScript 3.0 |
| Product Version: | Flex 3 |
| Runtime Versions: | Flash Player 9, AIR 1.1 |
Represents an instance of RemoteObject as a String, describing important properties such as the destination id and the set of channels assigned.
ReturnsString — Returns a String representing an instance of a RemoteObject.
|
Thu Dec 6 2018, 01:12 PM -08:00