Community Toolbar

Conduit API

Case Study

EBKeyChanged

This function is called when a local key is changed via StoreKey function.See also EBGlobalKeyChanged

EBKeyChanged(key, value).

Parameter	Description	Range	Type
key	The name of the key that was changed	Not null	string
value	The value of the key	Not null	string

- Return Value

None.

- Remarks

Local keys are key-value objects stored in the registry in the client’s PC. Toolbars and apps can read or write these key-value objects and use them in their apps. Local keys are accessible only within the local app, so other apps cannot read or write these keys.

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

- Code Example

This example contains one button. Clicking on it will store a local key, and as a result the event EBKeyChanged will be executed, displaying an alert on the screen.

<!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>
        <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://www.conduit.com/Api/BrowserCompApi.aspx"></script>
        <script language="javascript" type="text/javascript">
            function Store() {
                StoreKey("Key01", "1234");
            }

            //this will be called right after Store() will be invoked.
            function EBKeyChanged (key, value) {
                alert('Event: local key '  + key + ' was changed to value: ' + value);
            }
        </script>
        <title>Change Local Key</title>
    </head>
    <body>
        <button onclick="Store();">Change local key "Key01" to value "1234"</button>	    
    </body>
</html>

- Code Usage