Application

This function will cause the application to exit.

This function will lock the application's screen to the given orientation.

Minimizes the application window to a thumbnail and sends the user to the application switcher on the home screen. This will trigger the pause event.

This function will remove the indicator on the banner.

This function will move the application to the background.

This function will move the application to the foreground application.

This function will rotate the application even if the application is locked.

This method will set the icon that appears in the Home Screen of the Smartphone.

Returns true if successful, false otherwise. The hover icon can only be set when the application icon has been set first. Changes made using this API are NOT persisted across PlayBook resets.

This method will set the text for the icon that appears in the Home Screen of the Smartphone.

Returns true if successful, false otherwise. Changes made using this API are NOT persisted across resets.

This function will show an icon on the banner. A banner indicator can have an optional numeric value that usually serves as a counter. The value can be negative, 0, or positive. If the indicator is used as a counter then the best practice is to hide it when its value is equal to 0. Some applications may choose to show 0 as a counter value if such information is important to user, for example, the number of financial transactions in the current business day. Due to limited real estate, the indicator value can be truncated if it is very large. In such case the indicator will display '99+' or '999+', which means 'over a hundred' or 'over a thousand'.

Indicators are not guaranteed to be displayed. Different factors play a role in whether the indicator is displayed, such as available indicators space, number of registered indicators, and current application preferences. Application indicators have the lowest drawing priority compared to system indicators such as the unread email counter or missed calls indicator.

This function will unlock the screen rotating if it was previously locked.

This event is fired by the system. If you want to listen to the event you can do so using the blackberry.event.addEventListener function and remove the listener using the blackberry.event.removeEventListener function.
The keyboardClosed event is triggered when the virtual keyboard has finished sliding out of view of the application.

<script type="text/javascript">

function onKeyboardClosed() {
  console.log("Keyboard closed event occured.");
}

blackberry.event.addEventListener("keyboardClosed", onKeyboardClosed);

</script>

This event is fired by the system. If you want to listen to the event you can do so using the blackberry.event.addEventListener function and remove the listener using the blackberry.event.removeEventListener function.
The keyboardClosing event is triggered when the virtual keyboard is toggled to slide out of view of the application.

<script type="text/javascript">

function onKeyboardClosing() {
  console.log("Keyboard closing event occured.");
}

blackberry.event.addEventListener("keyboardClosing", onKeyboardClosing);

</script>

This event is fired by the system. If you want to listen to the event you can do so using the blackberry.event.addEventListener function and remove the listener using the blackberry.event.removeEventListener function.
The keyboardOpened event is triggered when the virtual keyboard has finished sliding into view of the application.

<script type="text/javascript">

function onKeyboardOpened() {
  console.log("Keyboard opened event occured.");
}

blackberry.event.addEventListener("keyboardOpened", onKeyboardOpened);

</script>

This event is fired by the system. If you want to listen to the event you can do so using the blackberry.event.addEventListener function and remove the listener using the blackberry.event.removeEventListener function.
The keyboardOpening event is triggered when the virtual keyboard is toggled to slide into view of the application.

<script type="text/javascript">

function onKeyboardOpening() {
  console.log("Keyboard opened event occured.");
}

blackberry.event.addEventListener("keyboardOpening", onKeyboardOpening);

</script>

This event is fired by the system. If you want to listen to the event you can do so using the blackberry.event.addEventListener function and remove the listener using the blackberry.event.removeEventListener function.
The keyboardPosition event is triggered when the virtual keyboard's position has changed.

<script type="text/javascript">

function onKeyboardPosition() {
  console.log("Keyboard position event occured. Keyboard position is " + yPosition + "px");
}

blackberry.event.addEventListener("keyboardPosition", onKeyboardPosition);

</script>

This event is fired by the system. If you want to listen to the event you can do so using the blackberry.event.addEventListener function and remove the listener using the blackberry.event.removeEventListener function.
The orientationchange event is triggered when the user changes the orientation of the device.

<script type="text/javascript">

function onOrientationChange(orientation) {
  alert("New orientation is: " + orientation);
}

blackberry.event.addEventListener("orientationchange", onOrientationChange);

</script>

This event is fired by the system. If you want to listen to the event you can do so using the blackberry.event.addEventListener function and remove the listener using the blackberry.event.removeEventListener function.
The pause event is triggered whenever the the application is put into the background.

<script type="text/javascript">

function onPause() {
  alert("The app is about to be paused.");
}

blackberry.event.addEventListener("pause", onPause);

</script>

This event is fired by the system. If you want to listen to the event you can do so using the blackberry.event.addEventListener function and remove the listener using the blackberry.event.removeEventListener function.
The resume event is triggered whenever the the application is retrieved from the background.

<script type="text/javascript">

function onResume() {
  alert("The app is resumed.");
}

blackberry.event.addEventListener("resume", onResume);

</script>

This event is fired by the system. If you want to listen to the event you can do so using the blackberry.event.addEventListener function and remove the listener using the blackberry.event.removeEventListener function.
The swipedown event is triggered when the user swipes down from the top of the application.

<script type="text/javascript">

function onSwipedown() {
  alert("Swipe down event occured.");
}

blackberry.event.addEventListener("swipedown", onSwipedown);

</script>

The ID of the author's name that is specified in the config.xml file.

The author's email of the BlackBerry WebWorks application that is specified in the config.xml file.

The author's URL of the BlackBerry WebWorks application that is specified in the config.xml file.

The copyright information of the BlackBerry WebWorks application that is specified in the config.xml file.

The description of the BlackBerry WebWorks application that is specified in the config.xml file.

The ID of the BlackBerry WebWorks Application that is specified in the config.xml file.

A property that will return true if the BlackBerry WebWorks Application is in the foreground.

The license of the BlackBerry WebWorks Application that is specified in the config.xml file.

The license URL of the BlackBerry WebWorks Application that is specified in the config.xml file.

The name of the BlackBerry WebWorks Application that is specified in the config.xml file.

The current orientation of the BlackBerry device.

The version of the BlackBerry WebWorks Application that is specified in the config.xml file.

Returns a JSON object containing all properties of the application.

 {
    "data": {
        "author":"John Doe",
        "name":"My WebWorks Widget",
        "authorEmail":"jdoe@company.com",
        "authorURL":"www.company.com",
        "description":"A sample widget",
        "license":"Legal stuff goes here",
        "id":"888",
        "version":"1.0",
        "copyright":"Company Ltd.",
        "licenseURL":"www.company.com/license"
    }
} 

<html>
<head>
    <script type="text/javascript" src="js/jquery-1.4.2.js" ></script>
    <script type="text/javascript" src="js/jquery.form.js" ></script>
    <script type="text/javascript" src="js/jquery.populate.js" ></script>

    <script type="text/javascript">
	function getAppData(){
		$.ajax({
		    type: "get",
		    url: "http://localhost:8472/blackberry/app/get",
		    success: function(msg){
		      $('#myAppDiv').populate(JSON.parse(msg).data);
		    }
		});
	}
     </script>

</head>
<body>

   <input type="button" onclick="getAppData();" value="Populate - APP"/>
   <div id="myAppDiv">
       Name: <span id="author"></span><br/>
       ID: <span id="id"></span>
   </div>

</body>
</html>