SimplePie 1.3.1 is now available. Upgrade now!

SimplePie Documentation.  Learn how to use this thing.  It's way better than going to school.

You are here: Documentation » SimplePie Live! » API Reference

API Reference

These are all of the properties available for SimplePie Live! This discusses the JSON object that is returned with an api response, not a json response. If you are an existing SimplePie user, and simply want to understand the syntax differences between SimplePie and SimplePie Live, check out the Syntax Notes.

:!: Although this listing is complete, the documentation isn't. We're working on adding docs as fast as we can type. Until then, simply remember that these properties map directly to methods in SimplePie, so if you're halfway intelligent you can likely figure out which property does what.

Documentation

Constructor

  • SimplePie – Construct a new SimplePie object.

Configuration Options

These are passed in as part of the jsonOptions parameter as discussed in the Getting Started documentation.

  • enableOrderByDate – Toggle the reordering of items into reverse chronological order.
  • response – Determines which type of data response is sent back from the server. Defaults to api (which is what is being documented on this page).
  • setInputEncoding – Override the character set within the feed.
  • setOutputEncoding – Set the output character set.
  • setTimeout – Timeout for fetching remote files.
  • simpleResponse – Toggle whether the response contains a complete response or a simple response.

Callback Functions

These are passed in as part of the jsonOptions parameter as discussed in the Getting Started documentation.

  • onFailure – The callback function that handles a failed request.
  • onSuccess – The callback function that handles a successful request.

Methods

  • cleanup – This method will cleanup after the script runs, and remove the no-longer-needed <script> tag from the <head> section of the page.

Response Properties

The top-most feed object may actually be named something else, and will equate to the name of the parameter you choose when setting up your callback functions.


live/reference/start.txt · Last modified: 2011/03/05 19:56 (external edit)