Packagemx.rpc.remoting.mxml
Classpublic dynamic class RemoteObject
InheritanceRemoteObject Inheritance RemoteObject Inheritance AbstractService Inheritance Proxy Inheritance Object
Implements IMXMLSupport, IMXMLObject

Language Version: ActionScript 3.0
Product Version: Flex 3
Runtime Versions: Flash Player 9, AIR 1.1

Use the <mx:RemoteObject> tag to represent an HTTPService object in an MXML file. This tag gives you access to the methods of Java objects using Action Message Format (AMF) encoding.

MXML SyntaxexpandedHide MXML Syntax

The <mx:RemoteObject> tag accepts the following tag attributes: 

 <mx:RemoteObject
  Properties
  concurrency="multiple|single|last"
  destination="No default."
  id="No default."
  endpoint="No default."
  showBusyCursor="false|true"
  source="No default." (currently, Adobe ColdFusion only)
  makeObjectsBindable="false|true"
  
  Events
  fault="No default."
  result="No default."  
 />

<mx:RemoteObject> can have multiple <mx:method> tags, which have the following tag attributes: 

 <mx:method
  Properties
  concurrency="multiple|single|last"
  name="No default, required."
  makeObjectsBindable="false|true"
         
 Events
  fault="No default."
  result="No default."
 />

It then can have a single <mx:arguments> child tag which is an array of objects that is passed in order.


Public Properties
 PropertyDefined By
 InheritedchannelSet : ChannelSet
Provides access to the ChannelSet used by the service.
AbstractService
 Inheritedconcurrency : String
Value that indicates how to handle multiple calls to the same service.
RemoteObject
 Inheritedconstructor : Object
A reference to the class object or constructor function for a given object instance.
Object
 InheritedconvertParametersHandler : 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
 InheritedconvertResultHandler : 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
 Inheriteddestination : String
The destination of the service.
AbstractService
 Inheritedendpoint : 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
 InheritedmakeObjectsBindable : Boolean
When this value is true, anonymous objects returned are forced to bindable objects.
RemoteObject
 Inheritedmanagers : Array
The managers property stores a list of data managers which modify the behavior of this service.
AbstractService
 Inheritedoperations : Object
The Operations array is usually only set by the MXML compiler if you create a service using an MXML tag.
AbstractService
 Inheritedprototype : Object
[static] A reference to the prototype object of a class or function object.
Object
 InheritedrequestTimeout : int
Provides access to the request timeout in seconds for sent messages.
AbstractService
 InheritedshowBusyCursor : Boolean
If true, a busy cursor is displayed while a service is executing.
RemoteObject
 Inheritedsource : String
Lets you specify a source value on the client; not supported for destinations that use the JavaAdapter.
RemoteObject
Public Methods
 MethodDefined By
  
RemoteObject(destination:String = null)
Create a new RemoteObject.
RemoteObject
 Inherited
disconnect():void
Disconnects the service's network connection and removes any pending request responders.
AbstractService
  
getOperation(name:String):AbstractOperation
[override] Returns an Operation of the given name.
RemoteObject
 Inherited
hasOwnProperty(name:String):Boolean
Indicates whether an object has a specified property defined.
Object
 Inherited
initialize():void
Called to initialize the service.
AbstractService
  
initialized(document:Object, id:String):void
Called automatically by the MXML compiler if the RemoteObject is set up using a tag.
RemoteObject
 Inherited
isPrototypeOf(theClass:Object):Boolean
Indicates whether an instance of the Object class is in the prototype chain of the object specified as the parameter.
Object
 Inherited
logout():void
Logs the user out of the destination.
AbstractService
 Inherited
propertyIsEnumerable(name:String):Boolean
Indicates whether the specified property exists and is enumerable.
Object
 Inherited
setCredentials(username:String, password:String, charset:String = null):void
Sets the credentials for the destination accessed by the service when using Data Services on the server side.
AbstractService
 Inherited
setPropertyIsEnumerable(name:String, isEnum:Boolean = true):void
Sets the availability of a dynamic property for loop operations.
Object
 Inherited
setRemoteCredentials(remoteUsername:String, remotePassword:String, charset:String = null):void
[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
 Inherited
toLocaleString():String
Returns the string representation of this object, formatted according to locale-specific conventions.
Object
 Inherited
toString():String
Represents an instance of RemoteObject as a String, describing important properties such as the destination id and the set of channels assigned.
RemoteObject
 Inherited
valueOf():Object
Returns the primitive value of the specified object.
Object
Events
Click for more information on events
 Event Summary Defined By
 Inherited
fault
The fault event is dispatched when a service call fails and isn't handled by the Operation itself.AbstractService
 Inherited
invoke
The invoke event is dispatched when a service Operation is invoked so long as an Error is not thrown before the Channel attempts to send the message.AbstractService
 Inherited
result
The result event is dispatched when a service call successfully returns and isn't handled by the Operation itself.AbstractService
Constructor Detail
RemoteObject()Constructor
public function RemoteObject(destination:String = null)

Language Version: ActionScript 3.0
Product Version: Flex 3
Runtime Versions: Flash Player 9, AIR 1.1

Create a new RemoteObject.

Parameters
destination:String (default = null) — The destination of the RemoteObject, should match a destination name in the services-config.xml file.
Method Detail
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.mxml.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.

Returns
AbstractOperation — Operation that executes for this name.
initialized()method 
public function initialized(document:Object, id:String):void

Language Version: ActionScript 3.0
Product Version: Flex 3
Runtime Versions: Flash Player 9, AIR 1.1

Called automatically by the MXML compiler if the RemoteObject is set up using a tag. If you create the RemoteObject through ActionScript you may want to call this method yourself as it is useful for validating any arguments.

Parameters

document:Object — the MXML document on which this RemoteObject lives
 
id:String — the id of this RemoteObject within the document




© 2009 Adobe Systems Incorporated. All rights reserved.
Sat Oct 3 2009, 04:15 AM -07:00