HTTPMultiService

(Preview)

Package	mx.rpc.http
Class	public dynamic class HTTPMultiService
Inheritance	HTTPMultiService AbstractService Proxy
Subclasses	HTTPMultiService

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 a collection of http operations. Each one has a URL, method, parameters and return type.

You can set attributes such as the URL and method on the HTTPMultiService tag to act as defaults for values set on each individual operation tag. The URL of the HTTPMultiService serves as the base url (meaning the prefix) for any relative urls set on the http operation tags. Each http operation has a send() method, which makes an HTTP request to the specified URL, and an HTTP response is returned.

You can pass parameters to the specified URL which are used to put data into the HTTP request. The contentType property specifies a mime-type which is used to determine the over-the-wire data format (such as HTTP form encoding or XML).

You can also use a serialization filter to implement a custom resultFormat such as JSON. When you do not go through the server-based proxy service, you can use only HTTP GET or POST methods. However, when you set the useProxy property to true and you use the server-based proxy service, you can also use the HTTP HEAD, OPTIONS, TRACE, and DELETE methods.

Note: Unlike the HTTPService class, the HTTPMultiService class does not define a request property.

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

Default MXML PropertyoperationList

Related API Elements

mx.rpc.http.HTTPService

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
		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

Public Methods

Hide Inherited Public Methods

Show Inherited Public Methods

	Method		Defined By
		HTTPMultiService(baseURL:String = null, destination:String = null) Creates a new HTTPService.	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
		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

Click for more information on events

	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

Property Detail

contentType

property

public var contentType:String = "application/x-www-form-urlencoded"

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.

serializationFilter

property

public var serializationFilter:SerializationFilter

Default serializationFilter used by all operations which do not set one explicitly

Constructor Detail

Event Detail

[an error occurred while processing this directive]

Legal Notices | Online Privacy Policy

Property	Value
`bubbles`	false
`cancelable`	true, calling preventDefault() from the associated token's responder.fault method will prevent the service or operation from dispatching this event
`currentTarget`	The Object that defines the event listener that handles the event. For example, if you use `myButton.addEventListener()` to register an event listener, myButton is the value of the `currentTarget`.
`fault`	The Fault object that contains the details of what caused this event.
`message`	The Message associated with this event.
`target`	The Object that dispatched the event; it is not always the Object listening for the event. Use the `currentTarget` property to always access the Object listening for the event.
`token`	The token that represents the call to the method. Used in the asynchronous completion token pattern.

Property	Value
`bubbles`	false
`token`	The token that represents the indiviudal call to the method. Used in the asynchronous completion token pattern.
`cancelable`	true
`currentTarget`	The Object that defines the event listener that handles the event. For example, if you use `myButton.addEventListener()` to register an event listener, myButton is the value of the `currentTarget`.
`message`	The request Message associated with this event.
`target`	The Object that dispatched the event; it is not always the Object listening for the event. Use the `currentTarget` property to always access the Object listening for the event.

Property	Value
`bubbles`	false
`cancelable`	true, preventDefault() from the associated token's responder.result method will prevent the service or operation from dispatching this event
`currentTarget`	The Object that defines the event listener that handles the event. For example, if you use `myButton.addEventListener()` to register an event listener, myButton is the value of the `currentTarget`.
`message`	The Message associated with this event.
`target`	The Object that dispatched the event; it is not always the Object listening for the event. Use the `currentTarget` property to always access the Object listening for the event.
`result`	Result that the RPC call returns.
`token`	The token that represents the indiviudal call to the method. Used in the asynchronous completion token pattern.

HTTPMultiService - AS3 Flex

Packagesx

Language Elements

Appendixes

Package mx.rpc.http

baseURL

concurrency

contentType

headers

makeObjectsBindable

method

operationList

resultFormat

serializationFilter

showBusyCursor

useProxy

fault

invoke

result

	`baseURL:String` (default = `null`) — The URL the HTTPService should use when computing relative URLS.

	`destination:String` (default = `null`)