AddAlert - Develop Apps | Community Toolbar

Conduit API

Case Study

Web Page API -> AddAlert

This function is used in order to subscribe a user to receive alerts from a specific community toolbar.

AddAlert(alertId)

Parameter	Description	Range	Type
alertId	The alert Id to add	>0	int

- Return Value

An object that contains the following fields:

Field Name	Description	Type
returnValue	Indicates whether the operation was successful True - The function succeeded False - Subscription to the alert failed. 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 add an alert for each installed and visible Conduit powered 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 ToolbarManager API - AddAlert</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 AddToolbarsAlert(){
        		var resultDiv = document.getElementById('result');
        		resultDiv.innerHTML = "";
        		// First get the list of all toolbars currently installed and visible.
        		var oManager = new TPI.Manager();
        		var oResult = oManager.AddAlert(123);
        		if(oResult.returnValue){
            		resultDiv.innerHTML = "Alert was added";
        		}
        		else{debugger;
            		resultDiv.innerHTML = "Alert was not added. Error Code: " + oResult.errorCode;
        		}
    		}
		</script>  
	</head> 
	<body>  
		<div>
			<input type="button" value="Add Alert" onclick="AddToolbarsAlert()" />
		</div> 
		<br /> 
		<div id="result"></div> 
	</body> 
</html>                                                  
 

- Code Usage

See code usage
See live demo usage
Live example