Package	net.guttershark.support.servicemanager.http
Class	public final class Service
Inheritance	Service flash.utils.Proxy

When you make a service call from the service manager, and pass it an object of properties, you are passing it a "callProps" object.

Supported properties on the callProps object:

• data (Object) - Data to submit to the service (post or get).
• routes (Array) - An array of "route" paths that get concatenated together.
• method (String) - post or get.
• file (FileReference) - Upload a file. Attempts and timeouts do not apply when uploading a file. See below for more file upload information.
• responseFormat (String) - The response format to expect so casting and parsing can occur - see net.guttershark.support.servicemanager.http.ResponseFormat.
• onCreate (Function) - A function to call, as soon as a http call instance was created (the request hasn't gone out yet though.).
• onResult (Function) - A function to call, and pass a CallResult object to.
• onFault (Function) - A function to call, and pass a CallFault object to.
• onRetry (Function) - A function to call for every retry of a service.
• onTimeout (Function) - A function to call after every retry has been attempted, and no result or fault occured.
• attempts (int) - The number of retry attempts allowed.
• timeout (int - milliseconds) - The amount of time allowed for each call before another attempt is made.

Extended file upload info. If you're upload service returns some data, that data will be passed to your onResult in a CallResult instance. If no data is returned from the server, a call result object will not be passed to your onResult, or onFault callbacks.

File upload responses.

HTTP Service calls support a couple extra features, and, if you follow the rules with the responses from the server, you can trigger the onFault callback. This is useful for situations where the server may have returned a 200 OK, but you need to indicate to the client that it was a faulty operation.

For "xml" responses

A successful xml response can be any well formed xml, which will trigger the onResult callback.

To indicate a fault, and call the onFault callback, send an XML structure like this as the response:

 
  <root>
      <fault>my message</fault>
  </root>
  

Note: the root node name doesn't matter in this case, it's the fault node that matters

For "variable" responses

The response should be a url encoded string like so: (name=asdfasd&email=asdfasd&test=sdfsdf)

To indicate a fault through variables define it like so: (fault=my%20fault%20message).

For text or binary response formats, no translation of the response occurs, it's handed back to you as raw data in either the call result, or call fault.

 
  import net.guttershark.managers.ServiceManager;
  import net.guttershark.support.serviceamanager.shared.CallResult;
  import net.guttershark.support.serviceamanager.shared.CallFault;
  var sm:ServiceManager = ServiceManager.gi();
  sm.createHTTPService("sendEmail","http://localhost/sendEmail.php",3,5000,false);
  sm.sendEmail({method:"post",responseFormat:"variables",data:{toEmail:"test@example.com",subject:"Example",message:"Hello World"},onResult:onr,onFault:onf});
  function onr(cr:CallResult):void{}
  function onf(cf:CallFault):void{}
  

 
  import net.guttershark.managers.ServiceManager;
  var sm:ServiceManager = ServiceManager.gi();
  sm.createHTTPService("uploadFile","http://localhost/uploadFile.php");
  sm.uploadFile({file:myFileReference,onResult:onr,onFault:onf});
  function onr():void{} //no parameter here, as no result data is received.
  function onf():void{} //no parameter here, as no result data is received.
  

 
  import net.guttershark.managers.ServiceManager;
  import net.guttershark.support.serviceamanager.shared.CallResult;
  import net.guttershark.support.serviceamanager.shared.CallFault;
  var sm:ServiceManager = ServiceManager.gi();
  sm.createHTTPService("uploadFile","http://localhost/uploadFile.php");
  sm.uploadFile({file:myFileReference,onResult:onr,onFault:onf});
  function onr(cr:CallResult):void{} //no parameter here, as no result data is received.
  function onf(cf:CallFault):void{} //no parameter here, as no result data is received.