Community Toolbar

Conduit API

Case Study

RegisterForMessaging

This function is used to register an app for events with a unique key.Registering an app can be used for messaging communication between two apps from the same toolbar/engine, or from web page to app.
Notes:

The registered app should remain open in order to receive messages.
This function should be used along with the "SendMessage ()" function.

- Syntax

RegisterForMessaging(key)

- Parameters

Parameter	Description	Range	Type
Key	The key that the sender app will use to communicate with this app	Not Null or empty string	string

- Return Value

Boolean (Success or failure)

- Remarks

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

<!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" src="http://api.conduit.com/browsercompapi.js"></script>	
		<script type="text/javascript">

		    function RegisterThisApp() {
		        var b = RegisterForMessaging("event1");
		        document.getElementById("regResults").innerHTML =
      		     	"<p>" +
                    	"App1 >> registration successfull." +
                		"</p>";
		    }

		    function EBMessageReceived(nickname, strMsg) {
		        document.getElementById("rcvResults").innerHTML =
              		"<p>" +
         	     		"App1 >> Event recieved: \n      Id=" + nickname + " Message=" + strMsg + "." +
              		"</p>";

		    }
		</script>
	<title>App1: register & receive messages</title>
	</head>
	<body>
        		<input type="button" value="Register" onclick="RegisterThisApp();" />
	   	<div id="regResults">
       	 	</div>  
        		<div id="rcvResults">
        		</div>  
	</body>
</html>

- Code Usage