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

Package | mx.rpc.http.mxml
Class | public class HTTPService
Inheritance | HTTPService HTTPService AbstractInvoker flash.events.EventDispatcher
Implements | IMXMLSupport, IMXMLObject

Language Version : | ActionScript 3.0

Product Version : | Flex 3

Runtime Versions : | Flash Player 9, AIR 1.1

You use the `<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 Syntax Show MXML Syntax
Hide MXML Syntax

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

View the examples

See also

mx.rpc.http.HTTPService
mx.validators.Validator
mx.managers.CursorManager

Public Properties
Hide Inherited Public Properties
Show Inherited Public Properties

| 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
|  | 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
|  | keepLastResult : Boolean Flag indicating whether the operation should keep its last call result for later access. | AbstractInvoker
|  | 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

Public Methods
Hide Inherited Public Methods
Show Inherited Public Methods

| Method | Defined By
--- | --- | ---
|  | HTTPService(rootURL:String = null, destination:String = null) Creates a new HTTPService. | HTTPService
|  | cancel(id:String = null):AsyncToken [override] Cancels the last service invocation or an invokation with the specified ID. | HTTPService
|  | clearResult(fireBindingEvent:Boolean = true):void [override] Sets the result property of the invoker to null. | HTTPService
|  | disconnect():void Disconnects the service's network connection. | HTTPService
|  | 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. | HTTPService
|  | logout():void Logs the user out of the destination. | HTTPService
|  | send(parameters:Object = null):AsyncToken Executes an HTTPService request. | HTTPService
|  | setCredentials(username:String, password:String, charset:String = null):void Sets the credentials for the destination accessed by the service. | HTTPService
|  | setRemoteCredentials(remoteUsername:String, remotePassword:String, charset:String = null):void The username and password to authenticate a user when accessing the HTTP URL. | HTTPService
|  | setResult(result:Object):void This hook is exposed to update the lastResult property. | AbstractInvoker

Events
Hide Inherited Events
Show Inherited Events

| Event | Summary | Defined By
--- | --- | --- | ---
|  | fault | Dispatched when an HTTPService call fails. | HTTPService
|  | invoke | 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
|  | result | Dispatched when an HTTPService call returns successfully. | HTTPService

Public Constants
Hide Inherited Public Constants
Show Inherited Public Constants

| Constant | Defined By
--- | --- | ---
|  | CONTENT_TYPE_FORM : String = application/x-www-form-urlencoded [static] Indicates that the data being sent by the HTTP service is encoded as application/x-www-form-urlencoded. | HTTPService
|  | CONTENT_TYPE_XML : String = application/xml [static] Indicates that the data being sent by the HTTP service is encoded as application/xml. | HTTPService
|  | DEFAULT_DESTINATION_HTTP : String = DefaultHTTP [static] Indicates that the HTTPService object uses the DefaultHTTP destination. | HTTPService
|  | DEFAULT_DESTINATION_HTTPS : String = DefaultHTTPS [static] Indicates that the HTTPService object uses the DefaultHTTPS destination. | HTTPService
|  | ERROR_DECODING : String = Client.CouldNotDecode [static] Indicates that an XML formatted result could not be parsed into an XML instance or decoded into an Object. | HTTPService
|  | ERROR_ENCODING : String = Client.CouldNotEncode [static] Indicates that an input parameter could not be encoded as XML. | HTTPService
|  | ERROR_URL_REQUIRED : String = Client.URLRequired [static] Indicates that the useProxy property was set to false but a url was not provided. | HTTPService
|  | RESULT_FORMAT_ARRAY : String = array [static] The result format "array" is similar to "object" however the value returned is always an Array such that if the result returned from result format "object" is not an Array already the item will be added as the first item to a new Array. | HTTPService
|  | RESULT_FORMAT_E4X : String = e4x [static] The result format "e4x" specifies that the value returned is an XML instance, which can be accessed using ECMAScript for XML (E4X) expressions. | HTTPService
|  | RESULT_FORMAT_FLASHVARS : String = flashvars [static] The result format "flashvars" specifies that the value returned is text containing name=value pairs separated by ampersands, which is parsed into an ActionScript object. | HTTPService
|  | RESULT_FORMAT_OBJECT : String = object [static] The result format "object" specifies that the value returned is XML but is parsed as a tree of ActionScript objects. | HTTPService
|  | RESULT_FORMAT_TEXT : String = text [static] The result format "text" specifies that the HTTPService result text should be an unprocessed String. | HTTPService
|  | RESULT_FORMAT_XML : String = xml [static] The result format "xml" specifies that results should be returned as an flash.xml.XMLNode instance pointing to the first child of the parent flash.xml.XMLDocument. | HTTPService

Constructor Detail

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.

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.

Examples
HTTPServiceExample.mxml

    <?xml version="1.0" encoding="utf-8"?>
    <!--

      Licensed to the Apache Software Foundation (ASF) under one or more
      contributor license agreements.  See the NOTICE file distributed with
      this work for additional information regarding copyright ownership.
      The ASF licenses this file to You under the Apache License, Version 2.0
      (the "License"); you may not use this file except in compliance with
      the License.  You may obtain a copy of the License at

          http://www.apache.org/licenses/LICENSE-2.0

      Unless required by applicable law or agreed to in writing, software
      distributed under the License is distributed on an "AS IS" BASIS,
      WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
      See the License for the specific language governing permissions and
      limitations under the License.

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

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