RefreshComponentById - Develop Apps

Conduit API

Case Study

HTML Apps -> RefreshComponentById

Instantly refreshes a specific toolbar component by componentId.

RefreshComponentById(componentId)

Parameter	Description	Range	Type
componentId	The unique component id that is meant to be refreshed.	not null or empty string	String

- Return Value

Description	Type
True – in case the component was found, otherwise false	Boolean

- Remarks

This function can be used both with the HTML component and with the gadget window.
*Notice: API methods must be invoked after the web page has triggered the "onload" event.

- Code Example

<html>
<head>
<style type= "text/css">
BODY
{
margin-left:0;
margin-right:0;
margin-top:0;
margin-bottom:0;
width:100%;
height:100%;
overflow:hidden;
background-color:threedface;
}
<style></style>
<!-- Conduit API script declaration -->
<script type="text/javascript" language="javascript" src="http://api.conduit.com/BrowserCompApi.js"></script>
</head>
<body>
<img alt="Refresh" style="vertical-align:bottom" src="http://www.conduit.com/developers/api/Images/Toolbars/HTML/RefreshToolbar.gif" onclick="RefreshComponentById('129135117836875403')" />
</body>
</html>

- Isolating the unique component id

To use this function, you’ll first need to isolate the componentId of the component you wish to refresh. To isolate the componentId:

Go to https://accounts.conduit.com/login/.
Login to your toolbar, and click the "My Toolbar" tab.
Move your mouse over the desired component, and from the drop down menu, click "Edit".
Copy the value of the ”compid” parameter from the resulting URL that appears in the address bar.
For example , in the following URL:

http://accounts.conduit.com/Components/LinkButton/?compid=128987022666281850

The compid is 128987022666281850.

Important note: Do not call this function from the component you wish to refresh.

- Code Usage

See code usage for HTML component
See code usage for gadget