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.

feed.copyright – Get the feed copyright information. Returns NULL in Multifeeds mode.
feed.description – Get the feed description. Returns NULL in Multifeeds mode.
feed.encoding – Get the character set for the returned values. Returns NULL in Multifeeds mode.
feed.favicon – Get the URL for the favicon of the feed's website. Returns NULL in Multifeeds mode.
feed.imageHeight – Get the logo/image height. Returns NULL in Multifeeds mode.
feed.imageLink – Get the logo/image linkback URL. Returns NULL in Multifeeds mode.
feed.imageTitle – Get the logo/image title. Returns NULL in Multifeeds mode.
feed.imageUrl – Get the logo/image URL. Returns NULL in Multifeeds mode.
feed.imageWidth – Get the logo/image width. Returns NULL in Multifeeds mode.
feed.itemQuantity – Get the number of items in the feed. Returns NULL in Multifeeds mode.
feed.language – Get the feed language. Returns NULL in Multifeeds mode.
feed.latitude – Get the feed latitude. Returns NULL in Multifeeds mode.
feed.links – Get all the links of a specific relation. Returns NULL in Multifeeds mode.
feed.longitude – Get all the links of a specific relation. Returns NULL in Multifeeds mode.
feed.permalink – Get the first feed link (i.e. the permalink). Returns NULL in Multifeeds mode.
feed.subscribeURL – The actual feed URL. Returns NULL in Multifeeds mode.
feed.title – Get the feed title. Returns NULL in Multifeeds mode.
feed.type – Get the type of feed. Returns NULL in Multifeeds mode.
feed.items – Returns a collection of items.
- feed.items.content – Get the content of the post (prefers full-content).
- feed.items.date – Get the date for the post.
- feed.items.description – Get the content of the post (prefers summaries).
- feed.items.id – Get the identifier for the post.
- feed.items.latitude – Get the post latitude.
- feed.items.links – Get all links for the post of a specific relation.
- feed.items.longitude – Get the post longitude.
- feed.items.permalink – Get the first link for the post (i.e. the permalink).
- feed.items.title – Get the title for the post.
- feed.items.uuid – Get a unique SHA-1 hash identifier for the post.
- feed.items.feed – Get access to information about the parent feed object. Returns NULL if only parsing one feed. Populated when in Multifeeds mode.
  - feed.items.feed.copyright – Get the feed copyright information. Only available in Multifeeds mode.
  - feed.items.feed.description – Get the feed description. Only available in Multifeeds mode.
  - feed.items.feed.encoding – Get the character set for the returned values. Only available in Multifeeds mode.
  - feed.items.feed.favicon – Get the URL for the favicon of the feed's website. Only available in Multifeeds mode.
  - feed.items.feed.imageHeight – Get the logo/image height. Only available in Multifeeds mode.
  - feed.items.feed.imageLink – Get the logo/image linkback URL. Only available in Multifeeds mode.
  - feed.items.feed.imageTitle – Get the logo/image title. Only available in Multifeeds mode.
  - feed.items.feed.imageUrl – Get the logo/image URL. Only available in Multifeeds mode.
  - feed.items.feed.imageWidth – Get the logo/image width. Only available in Multifeeds mode.
  - feed.items.feed.itemQuantity – Get the number of items in the feed. Only available in Multifeeds mode.
  - feed.items.feed.language – Get the feed language. Only available in Multifeeds mode.
  - feed.items.feed.latitude – Get the feed latitude. Only available in Multifeeds mode.
  - feed.items.feed.links – Get all the links of a specific relation. Only available in Multifeeds mode.
  - feed.items.feed.longitude – Get all the links of a specific relation. Only available in Multifeeds mode.
  - feed.items.feed.permalink – Get the first feed link (i.e. the permalink). Only available in Multifeeds mode.
  - feed.items.feed.subscribeURL – The actual feed URL. Only available in Multifeeds mode.
  - feed.items.feed.title – Get the feed title. Only available in Multifeeds mode.
  - feed.items.feed.type – Get the type of feed. Only available in Multifeeds mode.
- feed.items.authors – Returns a collection of authors.
  - feed.items.authors.email – Get the author's email address.
  - feed.items.authors.link – Get the author's link.
  - feed.items.authors.name – Get the author's name.
- feed.items.categories – Returns a collection of categories.
  - feed.items.categories.term – Get the category's identifier.
  - feed.items.categories.scheme – Get the category's categorization scheme identifier.
  - feed.items.categories.label – Get the category's human-readable label.
- feed.items.enclosures – Returns a collection of enclosures.
  - feed.items.enclosures.bitrate – Get the bitrate of the enclosure.
  - feed.items.enclosures.channels – Get the number of audio channels for the enclosure.
  - feed.items.enclosures.description – Get the description of the enclosure.
  - feed.items.enclosures.duration – Get the duration (in seconds) of the enclosure.
  - feed.items.enclosures.expression – Get the expression of the enclosure.
  - feed.items.enclosures.extension – Get the file extension of the enclosure.
  - feed.items.enclosures.framerate – Get the framerate of the enclosure.
  - feed.items.enclosures.handler – Get the preferred plugin handler for this content.
  - feed.items.enclosures.hashes – Get all hashes for the enclosure.
  - feed.items.enclosures.height – Get the height of the enclosure.
  - feed.items.enclosures.keywords – Get all keywords for the enclosure.
  - feed.items.enclosures.language – Get the language of the enclosure.
  - feed.items.enclosures.length – Get the file size (in bytes) of the enclosure.
  - feed.items.enclosures.link – Get the URL of the enclosure.
  - feed.items.enclosures.medium – Get the medium of the enclosure.
  - feed.items.enclosures.player – Get the player page for the enclosure.
  - feed.items.enclosures.realType – Get the mime type that the enclosure likely is (despite the feed.items.enclosures.type setting)
  - feed.items.enclosures.samplingRate – Get the sampling rate of the enclosure.
  - feed.items.enclosures.size – Get the file size (in Mebibytes) of the enclosure.
  - feed.items.enclosures.thumbnails – Get all thumbnails for the enclosure.
  - feed.items.enclosures.title – Get the title of the enclosure.
  - feed.items.enclosures.type – Get the mime type of the enclosure.
  - feed.items.enclosures.width – Get the width of the enclosure.
  - feed.items.enclosures.captions – Returns a collection of enclosure caption objects.
    - feed.items.enclosures.captions.endTime – Get the time that a caption should end.
    - feed.items.enclosures.captions.language – Get the language of the caption.
    - feed.items.enclosures.captions.startTime – Get the time that a caption should start.
    - feed.items.enclosures.captions.text – Get the text to display.
    - feed.items.enclosures.captions.type – Get the type of the caption (text or html).
  - feed.items.enclosures.categories – Returns a collection of enclosure category objects.
    - feed.items.enclosures.categories.term – Get the category's identifier.
    - feed.items.enclosures.categories.scheme – Get the category's categorization scheme identifier.
    - feed.items.enclosures.categories.label – Get the category's human-readable label.
  - feed.items.enclosures.copyright – Returns a single (i.e. the only) enclosure copyright object.
    - feed.items.enclosures.copyright.attribution – Get the copyright attribution.
    - feed.items.enclosures.copyright.url – Get the URL containing more information.
  - feed.items.enclosures.credits – Returns a collection of enclosure credits objects.
    - feed.items.enclosures.credits.name – Get the credited person/entity's name.
    - feed.items.enclosures.credits.role – Get the credited role.
    - feed.items.enclosures.credits.scheme – Get the organizational scheme for the credit.
  - feed.items.enclosures.ratings – Returns a collection of enclosure rating objects.
    - feed.items.enclosures.ratings.value – Get the rating itself.
    - feed.items.enclosures.ratings.scheme – Get the organizational scheme for the rating.
  - feed.items.enclosures.restrictions – Returns a collection of enclosure restriction objects.
    - feed.items.enclosures.restrictions.relationship – Get whether it's allow or deny.
    - feed.items.enclosures.restrictions.value – Get the list of things that are restricted.
    - feed.items.enclosures.restrictions.type – Get the type of restriction.

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