| Package | mx.rpc.http |
| Class | public class Operation |
| Inheritance | Operation  AbstractOperation AbstractOperation AbstractInvoker EventDispatcher Object |
| Language Version: | ActionScript 3.0 |
| Product Version: | Flex 3 |
| Runtime Versions: | Flash Player 9, AIR 1.1 |
send(param1, param2) method. HTTP services also support a sendBody
method which allows you to directly specify the body of the HTTP response. If you use the
send(param1, param2) method, the body is typically formed by combining the argumentNames
property of the operation with the parameters sent. An Object is created which uses the
argumentNames[i] as the key and the corresponding parameter as the value.
The exact way in which the HTTP operation arguments is put into the HTTP body is determined by the serializationFilter used.
Hide Inherited Public Properties
Show Inherited Public Properties| Property | Defined By | ||
|---|---|---|---|
 | argumentNames : Array
An ordered list of the names of the arguments to pass to a method invocation. | AbstractOperation | |
| arguments : Object
The arguments to pass to the Operation when it is invoked. | AbstractOperation | |
| concurrency : String [override]
Value that indicates how to handle multiple calls to the same service operation. | Operation | ||
| constructor : Object
A reference to the class object or constructor function for a given object instance. | Object | |
| contentType : String [override]
Type of content for service requests. | Operation | ||
| headers : Object
Custom HTTP headers to be sent to the third party endpoint. | AbstractOperation | |
| lastResult : Object [read-only]
The result of the last invocation. | AbstractInvoker | |
| makeObjectsBindable : Boolean [override]
When this value is true, anonymous objects returned are forced to bindable objects. | Operation | ||
| method : String [override]
HTTP method for sending the request. | Operation | ||
| 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 | |
| prototype : Object [static]
A reference to the prototype object of a class or function object. | Object | |
| request : Object
Object of name-value pairs used as parameters to the URL. | AbstractOperation | |
| requestTimeout : int
Provides access to the request timeout in seconds for sent messages. | 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 | |
| resultFormat : String [override]
Value that indicates how you want to deserialize the result
returned by the HTTP call. | Operation | ||
| resultType : Class
Specifies an optional return type for the operation. | AbstractInvoker | |
| rootURL : String [override]
The rootURL is used to compute the URL for an HTTP service operation when the
a relative URL is specified for the operation. | Operation | ||
| serializationFilter : SerializationFilter
A SerializationFilter can control how the arguments are formatted to form the content
of the HTTP request. | AbstractOperation | |
| service : AbstractService [read-only]
Provides convenient access to the service on which the Operation
is being invoked. | AbstractOperation | |
| showBusyCursor : Boolean [override]
If true, a busy cursor is displayed while a service is executing. | Operation | ||
| url : String
Location of the service. | AbstractOperation | |
| useProxy : Boolean [override]
Specifies whether to use the Flex proxy service. | Operation | ||
| xmlDecode : Function
ActionScript function used to decode a service result from XML. | AbstractOperation | |
| xmlEncode : Function
ActionScript function used to encode a service request as XML. | AbstractOperation | |
| Method | Defined By | ||
|---|---|---|---|
Creates a new Operation. | Operation | ||
| 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 | |
[override]
Executes the http operation. | Operation | ||
| 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 | |
concurrency | property |
concurrency:String[override] | 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 operation. The default
value is multiple. The following values are permitted:
multipleExisting 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 value.singleOnly a single request at a time is allowed on the operation; multiple requests generate a fault.lastMaking a request cancels any existing request.
Implementation
override public function get concurrency():String override public function set concurrency(value:String):voidcontentType | property |
contentType:String[override]
Type of content for service requests.
The default is application/x-www-form-urlencoded which sends requests
like a normal HTTP POST with name-value pairs. application/xml send
requests as XML.
Implementation
override public function get contentType():String override public function set contentType(value:String):voidmakeObjectsBindable | property |
makeObjectsBindable:Boolean[override] | 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
override public function get makeObjectsBindable():Boolean override public function set makeObjectsBindable(value:Boolean):voidmethod | property |
method:String[override]
HTTP method for sending the request. Permitted values are GET, POST, HEAD,
OPTIONS, PUT, TRACE and DELETE.
Lowercase letters are converted to uppercase letters. The default value is GET.
Implementation
override public function get method():String override public function set method(value:String):voidresultFormat | property |
resultFormat:String[override] Value that indicates how you want to deserialize the result returned by the HTTP call. The value for this is based on the following:
- Whether you are returning XML or name/value pairs.
- How you want to access the results; you can access results as an object, text, or XML.
The default value is object. The following values are permitted:
objectThe value returned is XML and is parsed as a tree of ActionScript objects. This is the default.arrayThe value returned is XML and is parsed as a tree of ActionScript objects however if the top level object is not an Array, a new Array is created and the result set as the first item. If makeObjectsBindable is true then the Array will be wrapped in an ArrayCollection.xmlThe value returned is XML and is returned as literal XML in an ActionScript XMLnode object.flashvarsThe value returned is text containing name=value pairs separated by ampersands, which is parsed into an ActionScript object.textThe value returned is text, and is left raw.e4xThe value returned is XML and is returned as literal XML in an ActionScript XML object, which can be accessed using ECMAScript for XML (E4X) expressions.
Implementation
override public function get resultFormat():String override public function set resultFormat(value:String):voidrootURL | property |
rootURL:String[override] | Language Version: | ActionScript 3.0 |
| Product Version: | Flex 3 |
| Runtime Versions: | Flash Player 9, AIR 1.1 |
The rootURL is used to compute the URL for an HTTP service operation when the a relative URL is specified for the operation. The directory name of the rootURL is prepended to any relative URLs for the operation. It is typically more convenient to set the baseURL since baseURL specifies the directory name directly whereas rootURL specifies the name of a file whose directory name is prepended. If neither rootURL nor baseURL are set explicitly, the directory name of the .swf file is prepended to relative paths.
Implementation
override public function get rootURL():String override public function set rootURL(value:String):voidshowBusyCursor | property |
useProxy | property |
useProxy:Boolean[override]
Specifies whether to use the Flex proxy service. The default value is false. If you
do not specify true to proxy requests though the Flex server, you must ensure that the player
can reach the target URL. You also cannot use destinations defined in the services-config.xml file if the
useProxy property is set to false.
Implementation
override public function get useProxy():Boolean override public function set useProxy(value:Boolean):voidOperation | () | Constructor |
public function Operation(service:mx.rpc.http:HTTPMultiService = null, name:String = null)| Language Version: | ActionScript 3.0 |
| Product Version: | Flex 3 Creates a new Operation. |
| Runtime Versions: | Flash Player 9, AIR 1.1 |
Creates a new Operation.
Parametersservice:mx.rpc.http:HTTPMultiService (default = null) | |
name:String (default = null) |
send | () | method |
override 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 http operation. Any arguments passed in are passed along as part of the operation call. If there are no arguments passed, the arguments property of class is used as the source of parameters. HTTP operations commonly take named parameters, not positional parameters. To supply the names for these parameters, you can also set the argumentNames property to an array of the property names.
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 Call using the asynchronous completion token pattern.
The same object is available in the result and
fault events from the token property.
|
Mon Nov 28 2011, 06:48 AM -08:00