Refresh - Develop Apps | Community Toolbar

Conduit API

Case Study

Web Page API -> Refresh

This function is used in order to retrieve the latest settings from the server, and to refresh the toolbar and its components.

- Syntax

Refresh()

- Parameters

None.

- Return Value

An object that contains the following fields:

Field Name	Description	Type
returnValue	Indicates whether the operation was successful. True - The toolbar is refreshed successfully False - The toolbar failed to refresh. 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

- Remarks

*Notice: API methods must be invoked after the web page has triggered the "onload" event.

- Code Example

This example contains a button that when clicked upon will refresh 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 - Refresh</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 RefreshToolbar(){
        var resultDiv = document.getElementById('result');
        resultDiv.innerHTML = "";            
        var oToolbar = new TPI.Toolbar("CT2275160");
        var oReturn = oToolbar.Refresh();
            if(oReturn.returnValue)
                resultDiv.innerHTML += "The Toolbar identified as CT2275160 is refreshed<br/>";
            else
                resultDiv.innerHTML += "Failed to refresh the Toolbar identified as CT2275160, Error Code: " + oReturn.errorCode + "<br/>";               
    }
</script> 
</head>
<body> 
<div><input type="button" value="Refresh" onclick="RefreshToolbar()" /></div>
<br />
<div id="result"></div>
</body>
</html>

- Code Usage

See code usage
See live demo usage
Live example