Object
   |
   +--Klip
         |
         +--Engines
               |
               +--Engines.HTTP

The Engines.HTTP object creates an Engines.HTTP.HTTPRequest object interact with any data source accessible via the HTTP and SSL protocols.

The steps in making a HTTP request are as follows:

1. Create an HTTP request.
2. Make the request.
3. Check if data was returned.
4. Process the data.

Here's how the Engines.HTTP.HTTPRequest works with other objects in the Klipfolio Dashboard API:

1. Create a Engines.HTTP.HTTPRequest object using newRequest().
2. Call Engines.HTTP.HTTPRequest.send() on the Engines.HTTP.HTTPRequest object.
3. Check Engines.HTTP.HTTPResponse.length to see if data was returned.
4. Process the data using Engines.Data.process().

---

Nested Object Summary
<static class>	Engines.HTTP.HTTPRequest
<static class>	Engines.HTTP.HTTPResponse

   

Function Summary
function	clear304cache()            Clears the session history of last-modified HTTP response headers.
Engines.HTTP.HTTPRequest	newRequest( <String> url )            Creates a Engines.HTTP.HTTPRequest object for making a HTTP or SSL request to a remote server.

Function Detail

clear304cache

function clear304cache()

Clears the session history of last-modified HTTP response headers.

If you have a user-configurable Klip that, based on user input, may revisit a previous URL, calling clear304cache before loading the data will ensure that the users see all data viewed the previous access.

---

newRequest

Engines.HTTP.HTTPRequest newRequest( <String> url )

Creates a Engines.HTTP.HTTPRequest object for making a HTTP or SSL request to a remote server.

To make an SSL connection, specify a URL of the form "https://www.yoursite.com/path_to_data".

Parameters:
url - URL of site to access. [optional]

Returns:
a new Engines.HTTP.HTTPRequest object configured to use the specified URL.

---

Overview   Object  Tree  Index  Help			Klipfolio Dashboard 5 API
PREV OBJECT  NEXT OBJECT	FRAMES    NO FRAMES
SUMMARY: PROPERTY | FUNCTION	DETAIL: PROPERTY | FUNCTION

---

© 2009 Klipfolio Inc. All Rights Reserved.