Community Toolbar

Conduit API

Case Study

SendMessage

This function is used to send a message to an app (on the same toolbar/engine) using the key the recipient app was previously registered with.Messages can be sent between HTML apps, or from a web page to app.
Notes:

The registered app should remain open in order to receive messages.
This function should be used along with the "RegisterForMessaging()" function.
In order to send a message from a web page, you must include the web page API code on the page that sends the message

- Syntax

SendMessage(key, data)

- Parameters

Parameter	Description	Range	Type
Key	The key that the recipient app uses for registration	Not null or empty string	string
Data	Text message that will be sent to the recipient app	Not null or empty string	string

- Return Value

Boolean (success or failure)
Recipient’s EBMessageRecieved(nickname, strMsg) event is invoked

- Remarks

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

- Code Example

This example demonstrates message passing between two apps. 
Pressing on the "Register" button registers App1 for messaging with a key "event1". Pressing on the "Send message" button sends message from App2 to App1 using the "event1" key. As a result, the event function EBMessageRecieved(nickname, strMsg) is called with nickname "event1".

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

		    function SendMessageExample() {
		        var msg = "MsgFromApp2"
		        var b = SendMessage("event1", msg);

		        document.getElementById("sndResults").innerHTML =
                		"<p>" +
                    	"App2 >> message sent successfully to registered apps (=App1)." +
                		"</p>";
		    }		    
		</script>
	<title>App2: Sender</title>
	</head>
	<body>

		<input type="button" value="Send Message" onclick="SendMessageExample();" />
		<div id="sndResults">
        		</div>
	</body>
</html>



The following sample send a message from a web page on the mainframe the user is visiting to the app. in order to send the message, you must include the ToolbarAPI.js file at the head of the document that sends the message:

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

		
		<script type="text/javascript">

		    function SendMessageExample() {
		        var msg = "MsgFromApp2";
		        var key = "bbrs1";
		        var oManager = new TPI.Manager();
		        oManager.SendMessage(key, msg);
		    } 
        </script>

		<input type="button" value="Send Message" onclick="SendMessageExample();" />
		<div id="Div1">
        		</div>
	</body>
</html>
 

- Code Usage