GetFeed Method

Fetches an RSS feed.

Syntax

rss.getFeed(URL, [callback])

Callback

The 'callback' parameter specifies a function which will be called when the operation completes (or an error is encountered). If the 'callback' parameter is not specified, then the method will block and will not return until the operation completes (or an error is encountered).

The callback for this method is defined as:

function(err){ }

'err' is the error that occurred. If there was no error, then 'err' is 'null'.

'err' has 2 properties which hold detailed information:

err.code
err.message

Remarks

This method fetches documents using the HTTP GET method. The document contents are delivered in the RSSData property, as well as through the Transfer event, and the HTTP response headers through the Header event. If the LocalFile property has been set, the class will write the transferred data there.

The class will then attempt to parse the RSS feed, filling in the Channel and Item properties as it goes. The feed properties can be accessed either directly through the named properties, or through the GetProperty and SetProperty methods.