AddRSS - Develop Apps | Community Toolbar

This function is used to add a Customized Button to the Toolbar. Clicking this button will cause a menu to open, containing the title and links of the RSS feed.

AddRSS(buttonLabel,

buttonIcon,

rssFeedUrl,

buttonNewMessagesIcon,

optionsDisplayText,

optionsDisplayIcon,

refreshIntervalInMinutes,

uniqueComponentID)

Parameter	Description	Range	Type
buttonLabel	The text to display on the button	not null or empty	string
buttonIcon	The URL of the icon which is displayed on the button	not null or empty	string
rssFeedUrl	The URL of the RSS feed	not null or empty	string
buttonNewMessagesIco	This parameter is currently not in use	--	--
optionsDisplayText	Optional. The text to display in the toolbar's options dialog. When the parameter is left empty, the button label text is displayed in the toolbar's options dialog	not null or empty	string
optionsDisplayIcon	Optional. The icon to display in the toolbar's options dialog. When the parameter is left empty, the button icon is displayed in the toolbar's options dialog	not null or empty	string
refreshIntervalInMinutes	Optional. Indicates how often the RSS feed refreshes itself (the default is 120 minutes)	>0	int
uniqueComponentID	The Browser Component's (RSS feed) unique ID, used to prevent duplicates. If the parameter is left empty a unique ID is automatically created	not null or empty	string

An object that contains the following fields:

Field Name	Description	Type
returnValue	Indicates whether the operation was successful. True - The function adds a customized RSS button to the toolbar successfully False - The RSS button is not added to the toolbar. Check the value of the errorCode to determine the specific reason for the function failure	boolean
errorCode	Specific error code. See Error Code Table for additional information.	int

This function must be called with at least one of the following parameters (which contain a value): "ButtonLabel" and/or "ButtonIcon". If both parameters are left empty the button will not appear on the toolbar.
*Notice: API methods must be invoked after the web page has triggered the "onload" event.

This example contains a button that when clicked upon will insert an RSS item to the Conduit demo toolbar.

 
<!DOCTYPE html PUBLIC "-//W3C//DTD XHTML 1.0 Transitional//EN" "http://www.w3.org/TR/xhtml1/DTD/xhtml1-transitional.dtd">
<html xmlns="http://www.w3.org/1999/xhtml">
<head>   
<title>Conduit Toolbar API - AddRSS</title>
<!-- Conduit API script declaration -->
<script language="javascript" type="text/javascript" src="http://api.conduit.com/ToolbarApi.js"></script>
 
<script language="javascript" type="text/javascript">
    function AddRssToToolbar(){
        var resultDiv = document.getElementById('result');
        resultDiv.innerHTML = "";
        var oToolbar = new TPI.Toolbar("CT2275160");           
        var oResult = oToolbar.AddRSS("CNN.com", 
                                      "http://www.conduit.com/Images/rssImages/rrs16Images/rss01x16.gif",
                                      "CNN.com",
                                      "http://rss.cnn.com/rss/cnn_topstories.rss");
        // Check the results
        if(oResult.returnValue){
                resultDiv.innerHTML += "Rss was added to toolbar id: CT2275160<br/>";                                                                            
        }
        else{
            if(oResult.errorCode == 5){
                resultDiv.innerHTML += "Rss already exist on toolbar id: CT2275160<br/>";    
            }
            else{                                                           
                resultDiv.innerHTML += "Failed to add Rss to toolbar id: CT2275160, Error Code: " + oResult.errorCode + "<br/>";    
            }
        }
    }
</script> 
</head>
<body> 
<div><input type="button" value="Add Rss" onclick="AddRssToToolbar()" /></div>
<br />
<div id="result"></div>
</body>
</html>

See code usage
See live demo usage
Live example