GetInfo - Develop Apps | Community Toolbar

This function is used in order to retrieve the current toolbar information.

GetInfo()

None.

An object that contains the following fields:

Field Name	Description	Type
returnValue	Indicates whether the operation was successful. True - The function returns the current toolbar information successfully False - The toolbar information is not retrieved and the function was not completed successfully. 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
name	The toolbar name	string
version	The toolbar version	string
originalCTID	The CTID of the parent toolbar, if such exists	string
CTID	The toolbar CTID	string
isMulticommunity	When true, indicates whether the User Aggregation is enabled for the toolbar. See the Glossary page for a description of User Aggregation	boolean
isGrouping	When true, indicates whether the toolbar has a predefined group of community toolbars. See the Glossary page for a description of Grouping	boolean

*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 retrive information from 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 - GetInfo</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 GetToolbarInfo(){
        var resultDiv = document.getElementById('result');
        resultDiv.innerHTML = "";            
        var oToolbar = new TPI.Toolbar("CT2275160");
        var oReturn = oToolbar.GetInfo();
        if(oReturn.returnValue){
            resultDiv.innerHTML += "<a style=\"text-decoration:underline\"><strong>" + oReturn.name + "</strong> info:</a><br/>" + 
                                   "\tVersion: " + oReturn.version + "<br/>" +
                                   "\tOriginal CTID: " + oReturn.originalCTID + "<br/>" +
                                   "\tCTID: " + oReturn.CTID + "<br/>" +
                                   "\tIs Multi Community: " + oReturn.isMulticommunity + "<br/>" +
                                   "\tIs My Stuff Supported: " + oReturn.isMyStuffSupported + "<br/>" +
                                   "\tIs My Stuff Visible: " + oReturn.isMyStuffVisible + "<br/>" +
                                   "\tIs Grouping: " + oReturn.isGrouping;  
        }   
        else{
            resultDiv.innerHTML += "Failed to retrive information for toolbar id = CT2275160, Error Code: " + oReturn.errorCode + "<br/>";
        }  
    }
</script>  </head> <body>  <div><input type="button" value="Get Toolbar Info" onclick="GetToolbarInfo()" /></div> <br /> <div id="result"></div> </body> </html>

See code usage
See live demo usage
Live example