Provides access to the ChannelSet used by the service. The ChannelSet can be manually constructed and assigned, or it will be dynamically created to use the configured Channels for the destination for this service.

Value that indicates how to handle multiple calls to the same service. The default value is multiple. The following values are permitted:

• multiple Existing 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.
• single Only a single request at a time is allowed on the operation; multiple requests generate a fault.
• last Making a request cancels any existing request.

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.

An HTTPService destination name in the services-config.xml file. When unspecified, Flex uses the DefaultHTTP destination. If you are using the url property, but want requests to reach the proxy over HTTPS, specify DefaultHTTPS.

Custom HTTP headers to be sent to the third party endpoint. If multiple headers need to be sent with the same name the value should be specified as an Array.

The result of the last invocation.

This property can be used as the source for data binding. When this property is modified, it dispatches the resultForBinding event.

When this value is true, anonymous objects returned are forced to bindable objects.

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.

Object of name-value pairs used as parameters to the URL. If the contentType property is set to application/xml, it should be an XML document.

Provides access to the request timeout in seconds for sent messages. A value less than or equal to zero prevents request timeout.

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:

• object The value returned is XML and is parsed as a tree of ActionScript objects. This is the default.
• array The 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.
• xml The value returned is XML and is returned as literal XML in an ActionScript XMLnode object.
• flashvars The value returned is text containing name=value pairs separated by ampersands, which is parsed into an ActionScript object.
• text The value returned is text, and is left raw.
• e4x The 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.

The URL that the HTTPService object should use when computing relative URLs. This property is only used when going through the proxy. When the useProxy property is set to false, the relative URL is computed automatically based on the location of the SWF running this application. If not set explicitly rootURL is automatically set to the URL of mx.messaging.config.LoaderConfig.url.

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. This can also be set indirectly by setting the resultFormat by registering a SerializationFilter using the static method: SerializationFilter.registerFilterForResultFormat("formatName", filter)

If true, a busy cursor is displayed while a service is executing. The default value is false.

Location of the service. If you specify the url and a non-default destination, your destination in the services-config.xml file must allow the specified URL.

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.

The default value is false.

ActionScript function used to decode a service result from XML. When the resultFormat is an object and the xmlDecode property is set, Flex uses the XML that the HTTPService returns to create an Object. If it is not defined the default XMLDecoder is used to do the work.

The function referenced by the xmlDecode property must take a flash.xml.XMLNode object as a parameter and should return an Object. It can return any type of object, but it must return something. Returning null or undefined causes a fault.

   <mx:HTTPService id="hs" xmlDecode="xmlDecoder" url="myURL" resultFormat="object" contentType="application/xml">
        <mx:request><source/>
            <obj>{RequestObject}</obj>
        </mx:request>
   </mx:HTTPService>

function xmlDecoder (myXML)
{
 // Simplified decoding logic.
 var myObj = {};
 myObj.name = myXML.firstChild.nodeValue;
 myObj.honorific = myXML.firstChild.attributes.honorific;
 return myObj;
}

ActionScript function used to encode a service request as XML. When the contentType of a request is application/xml and the request object passed in is an Object, Flex attempts to use the function specified in the xmlEncode property to turn it into a flash.xml.XMLNode object If the xmlEncode property is not set, Flex uses the default XMLEncoder to turn the object graph into a flash.xml.XMLNode object.

The xmlEncode property takes an Object and should return a flash.xml.XMLNode object. In this case, the XMLNode object can be a flash.xml.XML object, which is a subclass of XMLNode, or the first child of the flash.xml.XML object, which is what you get from an <mx:XML> tag. Returning the wrong type of object causes a fault. The following example shows an <mx:HTTPService> tag that specifies an xmlEncode function:

  <mx:HTTPService id="hs" xmlEncode="xmlEncoder" url="myURL" resultFormat="object" contentType="application/xml">
        <mx:request><source/>
            <obj>{RequestObject}</obj>
        </mx:request>
   </mx:HTTPService>
    

function xmlEncoder (myObj)
{
  return new XML("");
}

Creates a new HTTPService. If you expect the service to send using relative URLs you may wish to specify the rootURL that will be the basis for determining the full URL (one example would be Application.application.url).

Cancels the last service invocation or an invokation with the specified ID. Even though the network operation may still continue, no result or fault event is dispatched.

Parameters

Sets the result property of the invoker to null. This is useful when the result is a large object that is no longer being used.

Parameters

Disconnects the service's network connection. This method does not wait for outstanding network operations to complete.

Logs the user out of the destination. Logging out of a destination applies to everything connected using the same channel as specified in the server configuration. For example, if you're connected over the my-rtmp channel and you log out using one of your RPC components, anything that was connected over my-rtmp is logged out.

Note: Adobe recommends that you use the mx.messaging.ChannelSet.logout() method rather than this method.

See also

Executes an HTTPService request. The parameters are optional, but if specified should be an Object containing name-value pairs or an XML object depending on the contentType.

Parameters

Sets the credentials for the destination accessed by the service. The credentials are applied to all services connected over the same ChannelSet. Note that services that use a proxy to a remote destination will need to call the setRemoteCredentials() method instead.

Parameters

The username and password to authenticate a user when accessing the HTTP URL. These are passed as part of the HTTP Authorization header from the proxy to the endpoint. If the useProxy property is set to is false, this property is ignored.

Parameters

Dispatched when an HTTPService call fails.

The properties of the event object have the following values:

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.

The properties of the event object have the following values:

Dispatched when an HTTPService call returns successfully.

The properties of the event object have the following values:

Indicates that the data being sent by the HTTP service is encoded as application/x-www-form-urlencoded.

Indicates that the data being sent by the HTTP service is encoded as application/xml.

Indicates that the HTTPService object uses the DefaultHTTP destination.

Indicates that the HTTPService object uses the DefaultHTTPS destination.

Indicates that an XML formatted result could not be parsed into an XML instance or decoded into an Object.

Indicates that an input parameter could not be encoded as XML.

Indicates that the useProxy property was set to false but a url was not provided.

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.

The result format "e4x" specifies that the value returned is an XML instance, which can be accessed using ECMAScript for XML (E4X) expressions.

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.

The result format "object" specifies that the value returned is XML but is parsed as a tree of ActionScript objects. This is the default.

The result format "text" specifies that the HTTPService result text should be an unprocessed String.

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.