5ml User's Guide

CHAPTER 8: Customizing Page Elements
The Behavior tab on the Properties pane lets you associate an element (or page) with an event and an action to perform
when the user taps or clicks the element. An action can execute a Custom Function that calls the 5ml Proxy API. The API
in turn can invoke a remote web service, hosted on another server. Use the Behavior tab's Script Editor to implement the
custom code and 5ml Proxy API. Then associate the custom code with a 5ml widget (for example, a Button widget) by
setting up an Event/Action sequence, using the Custom Function-Action and selecting the custom function from the
Function drop down menu. For more information about setting up Events and Actions, see "Changing Behavior
Properties" on page 223.
5ml Proxy API Reference
fiveml.proxy.sendRequest = function(url, httpMethod /*, data, oncomplete, headers*/);
Parameters
• url (required)—The remote web service URL that you want to invoke.
• httpMethod (required)—The HTTP method to invoke the remote web service (GET or POST).
• data (required for POST requests)—The data parameter can be of any type, depending on the web service you
wish to invoke. If you want to invoke a web service using a GET HTTP request and you want to pass parameters
as a query string, then pass a JavaScript object and the 5ml Proxy API will manage the encoding.
• oncomplete (optional)—A callback function to invoke after the remote service sends the response. It accepts one
parameter, which is the XHR instance.
• headers (required for POST)—A JavaScript object that contains headers that you want to set when invoking the
remote web service. For POST HTTP requests, you should at least set the Content-Type header, as the API uses it
to determine how to encode the POST data.
The headers parameter can take the following three static variables:
fiveml.proxy.TYPE_JSON = 'application/json';
fiveml.proxy.TYPE_XML = 'text/xml';
fiveml.proxy.TYPE_FORM_POST = 'application/x-www-form-urlencoded';
5ml Proxy API Examples
Sending a Simple GET HTTP Request
function simpleGet() {
fiveml.proxy.sendRequest('http://wsf.cdyne.com/WeatherWS/Weather.asmx/
GetCityForecastByZIP','GET', null, function(req){alert(req.responseText);
});
Sending a GET HTTP Request with Query String Parameters
function get() {
- 228 -