Package | mx.rpc.http.mxml |
Class | public class HTTPService |
Inheritance | HTTPService HTTPService AbstractInvoker EventDispatcher Object |
Implements | IMXMLSupport, IMXMLObject |
Language Version: | ActionScript 3.0 |
Product Version: | Flex 3 |
Runtime Versions: | Flash Player 9, AIR 1.1 |
<mx:HTTPService>
tag to represent an
HTTPService object in an MXML file. When you call the HTTPService object's
send()
method, it makes an HTTP request to the
specified URL, and an HTTP response is returned. Optionally, you can pass
parameters to the specified URL. 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: Due to a software limitation, HTTPService does not generate user-friendly error messages when using GET.
MXML SyntaxHide MXML SyntaxThe <mx:HTTPService> tag accepts the following tag attributes:
<mx:HTTPService Properties concurrency="multiple|single|last" contentType="application/x-www-form-urlencoded|application/xml" destination="DefaultHTTP" id="No default." method="GET|POST|HEAD|OPTIONS|PUT|TRACE|DELETE" resultFormat="object|array|xml|e4x|flashvars|text" showBusyCursor="false|true" makeObjectsBindable="false|true" url="No default." useProxy="false|true" xmlEncode="No default." xmlDecode="No default." Events fault="No default." result="No default." />The
<mx:HTTPService>
tag can have a single <mx:request> tag under which the parameters can be specified.
Related API Elements
Property | Defined By | ||
---|---|---|---|
channelSet : ChannelSet
Provides access to the ChannelSet used by the service. | HTTPService | ||
concurrency : String
Value that indicates how to handle multiple calls to the same service. | HTTPService | ||
constructor : Object
A reference to the class object or constructor function for a given object instance. | Object | ||
contentType : String
Type of content for service requests. | HTTPService | ||
destination : String
An HTTPService destination name in the services-config.xml file. | HTTPService | ||
headers : Object
Custom HTTP headers to be sent to the third party endpoint. | HTTPService | ||
lastResult : Object [override] [read-only]
The result of the last invocation. | HTTPService | ||
makeObjectsBindable : Boolean [override]
When this value is true, anonymous objects returned are forced to bindable objects. | HTTPService | ||
method : String
HTTP method for sending the request. | HTTPService | ||
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 | ||
request : Object
Object of name-value pairs used as parameters to the URL. | HTTPService | ||
requestTimeout : int
Provides access to the request timeout in seconds for sent messages. | HTTPService | ||
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
Value that indicates how you want to deserialize the result
returned by the HTTP call. | HTTPService | ||
resultType : Class
Specifies an optional return type for the operation. | AbstractInvoker | ||
rootURL : String
The URL that the HTTPService object should use when computing relative URLs. | HTTPService | ||
serializationFilter : SerializationFilter
Provides an adapter which controls the process of converting the HTTP response body into
ActionScript objects and/or turning the parameters or body into the contentType, URL, and
and post body of the HTTP request. | HTTPService | ||
showBusyCursor : Boolean
If true, a busy cursor is displayed while a service is executing. | HTTPService | ||
url : String
Location of the service. | HTTPService | ||
useProxy : Boolean
Specifies whether to use the Flex proxy service. | HTTPService | ||
xmlDecode : Function
ActionScript function used to decode a service result from XML. | HTTPService | ||
xmlEncode : Function
ActionScript function used to encode a service request as XML. | HTTPService |
Method | Defined By | ||
---|---|---|---|
Creates a new HTTPService. | HTTPService | ||
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 | ||
[override]
Cancels the last service invocation or an invokation with the specified ID. | HTTPService | ||
[override]
Sets the result property of the invoker to null. | HTTPService | ||
Disconnects the service's network connection. | HTTPService | ||
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 | ||
Called after the implementing object has been created and all
component properties specified on the MXML tag have been
initialized. | HTTPService | ||
Indicates whether an instance of the Object class is in the prototype chain of the object specified
as the parameter. | Object | ||
Logs the user out of the destination. | HTTPService | ||
Indicates whether the specified property exists and is enumerable. | Object | ||
Removes a listener from the EventDispatcher object. | EventDispatcher | ||
Executes an HTTPService request. | HTTPService | ||
Sets the credentials for the destination accessed by the service. | HTTPService | ||
Sets the availability of a dynamic property for loop operations. | Object | ||
The username and password to authenticate a user when accessing
the HTTP URL. | HTTPService | ||
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 |
Event | Summary | Defined By | ||
---|---|---|---|---|
[broadcast event] Dispatched when the Flash Player or AIR application gains operating system focus and becomes active. | EventDispatcher | |||
[broadcast event] Dispatched when the Flash Player or AIR application operating loses system focus and is becoming inactive. | EventDispatcher | |||
Dispatched when an HTTPService call fails. | HTTPService | |||
The invoke event is fired when an HTTPService call is invoked so long as an Error is not thrown before the Channel attempts to send the message. | HTTPService | |||
Dispatched when an HTTPService call returns successfully. | HTTPService |
Constant | Defined By |
---|
HTTPService | () | Constructor |
public function HTTPService(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 HTTPService. 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.
ParametersrootURL: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.
|
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.
|
<?xml version="1.0" encoding="utf-8"?> <!-- Simple example to demonstrate the HTTPService tag. --> <s:Application xmlns:fx="http://ns.adobe.com/mxml/2009" xmlns:s="library://ns.adobe.com/flex/spark" xmlns:mx="library://ns.adobe.com/flex/mx" creationComplete="feedRequest.send();"> <!-- The url property specifies the location of the requested file, in this case the RSS 2.0 feed of Matt Chotin's blog. As of this writing, the URL was still valid, but you should check to make sure it hasn't changed. You should use the latest RSS 2.0 URL listed on the right side of the blog at http://www.adobe.com/go/mchotinblog. --> <fx:Declarations> <mx:HTTPService id="feedRequest" url="http://weblogs.macromedia.com/mchotin/index.xml" useProxy="false" /> </fx:Declarations> <mx:Panel title="HTTPService Example" height="75%" width="75%" paddingTop="10" paddingBottom="10" paddingLeft="10" paddingRight="10"> <mx:DataGrid id="dgPosts" height="50%" width="75%" dataProvider="{feedRequest.lastResult.rss.channel.item}"> <mx:columns> <mx:DataGridColumn headerText="Posts" dataField="title"/> <mx:DataGridColumn headerText="Date" dataField="pubDate"/> </mx:columns> </mx:DataGrid> <mx:TextArea height="50%" width="75%" htmlText="{dgPosts.selectedItem.description}"/> </mx:Panel> </s:Application>
Thu Dec 4 2014, 05:50 PM -08:00