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

Package | mx.rpc.http.mxml
Class | public dynamic class HTTPMultiService
Inheritance | HTTPMultiService HTTPMultiService AbstractService flash.utils.Proxy
Implements | IMXMLSupport, IMXMLObject

Language Version : | ActionScript 3.0

Product Version : | Flex 3

Runtime Versions : | Flash Player 9, AIR 1.1

You use the `<mx:HTTPMultiService>` tag to represent an HTTPMultiService object in an MXML file. The HTTPMultiService is like the HTTPService but supports more than one operation for each individual tag.

Note: Due to a software limitation, HTTPService does not generate user-friendly error messages when using GET.

Default MXML Property `operationList`

See also

mx.rpc.http.HTTPMultiService

Public Properties
Hide Inherited Public Properties
Show Inherited Public Properties

| Property | Defined By
--- | --- | ---
|  | baseURL : String The URL that the HTTPService object should use when computing relative URLs. | HTTPMultiService
|  | 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 operation within the service. | HTTPMultiService
|  | contentType : String = application/x-www-form-urlencoded Type of content for service requests. | HTTPMultiService
|  | destination : String The destination of the service. | AbstractService
|  | headers : Object Custom HTTP headers to be sent to the third party endpoint. | HTTPMultiService
|  | keepLastResult : Boolean Flag indicating whether the service's operations should keep their last call result for later access. | AbstractService
|  | makeObjectsBindable : Boolean = true When true, the objects returned support data binding to UI controls. | HTTPMultiService
|  | managers : Array The managers property stores a list of data managers which modify the behavior of this service. | AbstractService
|  | method : String = GET HTTP method for sending the request if a method is not set explicit on the operation. | HTTPMultiService
|  | operationList : Array This serves as the default property for this instance so that we can define a set of operations as direct children of the HTTPMultiService tag in MXML. | HTTPMultiService
|  | 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
|  | resultFormat : String Value that indicates how you want to deserialize the result returned by the HTTP call. | HTTPMultiService
|  | serializationFilter : SerializationFilter Default serializationFilter used by all operations which do not set one explicitly | HTTPMultiService
|  | showBusyCursor : Boolean If true, a busy cursor is displayed while a service is executing. | HTTPMultiService
|  | useProxy : Boolean Specifies whether to use the Flex proxy service. | HTTPMultiService

Protected Properties
Hide Inherited Protected Properties
Show Inherited Protected Properties

| Property | Defined By
--- | --- | ---
|  | _keepLastResult : Boolean = true | AbstractService

Public Methods
Hide Inherited Public Methods
Show Inherited Public Methods

| Method | Defined By
--- | --- | ---
|  | HTTPMultiService(rootURL:String = null, destination:String = null) Creates a new HTTPMultiService. | HTTPMultiService
|  | disconnect():void Disconnects the service's network connection and removes any pending request responders. | AbstractService
|  | getOperation(name:String):AbstractOperation Returns an Operation of the given name. | AbstractService
|  | initialize():void Called to initialize the service. | AbstractService
|  | initialized(document:Object, id:String):void Called after the implementing object has been created and all component properties specified on the MXML tag have been initialized. | HTTPMultiService
|  | logout():void Logs the user out of the destination. | AbstractService
|  | 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
|  | setRemoteCredentials(remoteUsername:String, remotePassword:String, charset:String = null):void The username and password to be used to authenticate a user when accessing a remote, third-party endpoint such as a web service through a proxy or a remote object through a custom adapter when using Data Services on the server side. | AbstractService

Events
Hide Inherited Events
Show Inherited Events

| Event | Summary | Defined By
--- | --- | --- | ---
|  | fault | Dispatched when an HTTPMultiService call fails. | HTTPMultiService
|  | invoke | The invoke event is fired when an HTTPMultiService call is invoked so long as an Error is not thrown before the Channel attempts to send the message. | HTTPMultiService
|  | result | Dispatched when an HTTPMultiService call returns successfully. | HTTPMultiService

Constructor Detail

HTTPMultiService | () | Constructor

`public function HTTPMultiService(rootURL:String = null, destination:String = null)`

Language Version : | ActionScript 3.0

Product Version : | Flex 3

Runtime Versions : | Flash Player 9, AIR 1.1

Creates a new HTTPMultiService. This constructor is usually called by the generated code of an MXML document. You usually use the mx.rpc.http.HTTPService class to create an HTTPService in ActionScript.

Parameters

| `rootURL:String` (default = `null`)`` — The URL the HTTPService should use when computing relative URLS.
| `destination:String` (default = `null`)`` — An HTTPService destination name in the service-config.xml file.

Method Detail

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 after the implementing object has been created and all component properties specified on the MXML tag have been initialized. If you create this class in ActionScript and want it to function with validation, you must call this method and pass in the MXML document and the HTTPService's `id`.

Parameters

| `document:Object` — The MXML document that created this object.
| `id:String` — The identifier used by `document` to refer to this object. If the object is a deep property on document, `id` is null.

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