RSSRenderer Quick Reference
Fetch, parse, and render RSS feeds as HTML content
Key Features
- Fetch and parse RSS feeds
- Convert RSS to HTML
- Cache feed content
- Automatic feed updates
- Customizable rendering templates
- Multiple feed support
- Force update capability
Server-Side Usage:
<![CDATA[
// Get the RSSRenderer API
var RSSRenderer = js.getObject("/OpenForum/AddOn/RSSRenderer","RSSRenderer.sjs");
// Fetch and render RSS feed
RSSRenderer.updateRSS(
"/MyPage", // Page to store RSS
"feed.rss", // RSS file name
"/MyPage", // Target page
"rss.html", // Output HTML file
"https://example.com/rss", // RSS feed URL
false // Force update
);
// Get RSS feed data
var feedData = RSSRenderer.getRSSFeed("/MyPage", "feed.rss");
// Parse RSS to HTML
var html = RSSRenderer.renderRSS(feedData);
]]>
Client-Side Usage:
<![CDATA[
// Update RSS feed via URL
var url = '/OpenForum/AddOn/RSSRenderer'
'?action=updateRSS'
'&pageName=/MyPage'
'&fileName=feed.rss'
'&targetPageName=/MyPage'
'&targetFileName=rss.html'
'&forceUpdate=true';
JSON.get(url)
.onSuccess(function(result) {
console.log('RSS updated');
}).go();
// Fetch and display RSS
JSON.get('/OpenForum/AddOn/RSSRenderer/Fetch', null,
'url=' encodeURIComponent('https://example.com/rss'))
.onSuccess(function(html) {
document.getElementById('rssContent').innerHTML = html;
}).go();
]]>
Parameters
- pageName = Page to store RSS data
- fileName = RSS file name
- targetPageName = Page for rendered HTML
- targetFileName = Output HTML file
- url = RSS feed URL (optional if already stored)
- forceUpdate = Skip cache and fetch fresh (true/false)
Configuration
- Update frequency
- Cache duration
- Rendering template
- Feed item limit