updated ability for PB20 tags and fixed docs to reflect

blackberry-webworks · Nov 24, 2011 · c7d0caa · c7d0caa
1 parent 0796c14
commit c7d0caa
Show file tree

Hide file tree

Showing 32 changed files with 1,378 additions and 894 deletions.
diff --git a/api/blackberry_app.js b/api/blackberry_app.js
@@ -17,8 +17,6 @@
 /**
  * @toc {System} Application
  * @featureID blackberry.app
- * @notice {Warning ( Playbook 1.0 Notice):}
- * For URI based APIs, webworks:// has been deprecated and replaced with http://localhost:8472. This change does not affect the procedural APIs.
  * @namespace The Application object provides functions and properties for the currently running application.
  * @example
  * &lt;script type="text/javascript"&gt;
@@ -51,7 +49,7 @@ blackberry.app ={
 	/**
 	 * @description This function will cause the application to exit.
 	 * @BB50+
-	 * @PB10
+	 * @PB10+
      * @RIPPLE
 	 */
 	exit: function(){},
@@ -110,7 +108,7 @@ A banner indicator can have an optional numeric value that usually serves as a c
 	/**
 	 * @description The ID of the author's name that is specified in the config.xml file. 
 	 * @BB50+
-	 * @PB10
+	 * @PB10+
      * @RIPPLE
 	 * @readonly
 	 * @type String
@@ -120,7 +118,7 @@ A banner indicator can have an optional numeric value that usually serves as a c
 	/**
 	 * @description The author's email of the BlackBerry WebWorks application that is specified in the config.xml file. 
 	 * @BB50+
-	 * @PB10
+	 * @PB10+
      * @RIPPLE
 	 * @readonly
 	 * @type String
@@ -130,7 +128,7 @@ A banner indicator can have an optional numeric value that usually serves as a c
 	/**
 	 * @description The author's URL of the BlackBerry WebWorks application that is specified in the config.xml file.
 	 * @BB50+
-	 * @PB10
+	 * @PB10+
      * @RIPPLE
 	 * @readonly
 	 * @type String
@@ -139,7 +137,7 @@ A banner indicator can have an optional numeric value that usually serves as a c
 	/**
 	 * @description The copyright information of the BlackBerry WebWorks application that is specified in the config.xml file.
 	 * @BB50+
-	 * @PB10
+	 * @PB10+
      * @RIPPLE
 	 * @readonly
 	 * @type String
@@ -149,7 +147,7 @@ A banner indicator can have an optional numeric value that usually serves as a c
 	/**
 	 * @description The description of the BlackBerry WebWorks application that is specified in the config.xml file.
 	 * @BB50+
-	 * @PB10
+	 * @PB10+
      * @RIPPLE
 	 * @readonly
 	 * @type String
@@ -159,7 +157,7 @@ A banner indicator can have an optional numeric value that usually serves as a c
 	/**
 	 * @description The ID of the BlackBerry WebWorks Application that is specified in the config.xml file. 
 	 * @BB50+
-	 * @PB10
+	 * @PB10+
      * @RIPPLE
 	 * @readonly
 	 * @type String
@@ -178,7 +176,7 @@ A banner indicator can have an optional numeric value that usually serves as a c
 	/**
 	 * @description The license of the BlackBerry WebWorks Application that is specified in the config.xml file. 
 	 * @BB50+
-	 * @PB10
+	 * @PB10+
      * @RIPPLE
 	 * @readonly
 	 * @type String
@@ -188,7 +186,7 @@ A banner indicator can have an optional numeric value that usually serves as a c
 	/**
 	 * @description The license URL of the BlackBerry WebWorks Application that is specified in the config.xml file. 
 	 * @BB50+
-	 * @PB10
+	 * @PB10+
      * @RIPPLE
 	 * @readonly
 	 * @type String
@@ -198,7 +196,7 @@ A banner indicator can have an optional numeric value that usually serves as a c
 	/**
 	 * @description The name of the BlackBerry WebWorks Application that is specified in the config.xml file. 
 	 * @BB50+
-	 * @PB10
+	 * @PB10+
      * @RIPPLE
 	 * @readonly
 	 * @type String
@@ -208,7 +206,7 @@ A banner indicator can have an optional numeric value that usually serves as a c
 	/**
 	 * @description The version of the BlackBerry WebWorks Application that is specified in the config.xml file. 
 	 * @BB50+
-	 * @PB10
+	 * @PB10+
      * @RIPPLE
 	 * @readonly
 	 * @type String
@@ -220,7 +218,7 @@ A banner indicator can have an optional numeric value that usually serves as a c
 	/**
      * Returns a JSON object containing all properties of the application.
 	 * @uri 
-	 * @PB10
+	 * @PB10+
 	 * @returns {JSON of all the properties}
 	 * {
 	 * 	"data":{

diff --git a/api/blackberry_app_events.js b/api/blackberry_app_events.js
@@ -44,7 +44,7 @@ blackberry.app.event = {
 	 * This event is dispatched whenever the application goes to the background, but has not ended. Only one function can be assigned to this event. To unregister the callback, call the onBackground method and pass in null for the callback parameter.
 	 * <p/>Note: The BlackBerry PlayBook's "Application Behavior" setting has an impact on when onBackground gets dispatched. When "Application Behavior" is set to "Default", onBackground does not get dispatched until another application goes fullscreen.  When "Application Behavior" is set to "Showcase", onBackground does not get dispatched because all open applications stay active. When "Application Behavior" is set to "Paused", onBackground gets dispatched once the application is sent to the background. 	
 	 * @callback {function} onBackgroundCallback Function to be called when the application goes to the background. Expected signature: function onBackgroundCallback().
-	 * @PB10 
+	 * @PB10+ 
 	 * @BB50+
      * @RIPPLE
 	 * @example
@@ -69,7 +69,7 @@ blackberry.app.event = {
 	 * This event is dispatched whenever the application comes to the foreground, for example, when the user re-opens the application from the application list. Only one function can be assigned to this event. To unregister the callback call the onForeground method and pass in null for the callback parameter.
 	 * <p/>Note: The BlackBerry PlayBook's "Application Behavior" setting has an impact on when onForeground gets dispatched. Refer to {@link blackberry.app.event.onBackground} documentation for details.	
 	 * @callback {function} onForegroundCallback Function to be called when the application goes to the foreground. Expected signature: function onForegroundCallback().
-	 * @PB10
+	 * @PB10+
 	 * @BB50+
      * @RIPPLE
 	 */
@@ -81,7 +81,7 @@ blackberry.app.event = {
 	 * <p/>
 	 * This event is dispatched when a user swipes down from the top bezel of the BlackBerry PlayBook onto the screen. Only one function can be assigned to this event. To unregister the callback call the onSwipeDown method and pass in null for the callback parameter. 	
 	 * @callback {function} onSwipeDownCallback Function to be called when the swipe down action occurs. Expected signature: function onSwipeDownCallback().
-	 * @PB10
+	 * @PB10+
      * @RIPPLE
 	 */
 	onSwipeDown : function(onSwipeDownCallback) {},
@@ -91,7 +91,7 @@ blackberry.app.event = {
 	 * <p/>
 	 * This event is dispatched when the user starts a swipe from the top bezel of the BlackBerry PlayBook. Only one function can be assigned to this event. To unregister the callback call the onSwipeStart method and pass in null for the callback parameter.
 	 * @callback {function} onSwipeStartCallback Function to be called when the user starts a swipe from the top bezel of the PlayBook. Expected signature: function onSwipeStartCallback(). Static="true" returns="void".
-	 * @PB10
+	 * @PB10+
      * @RIPPLE
 	 */
 	onSwipeStart : function(onSwipeStartCallback) {}

diff --git a/api/blackberry_identity.js b/api/blackberry_identity.js
@@ -18,8 +18,6 @@
 * @toc {Identity} Identity 
 * @BB50+
 * @RIPPLE
-* @notice {Warning ( Playbook 1.0 Notice):}
-* For URI based APIs, webworks:// has been deprecated and replaced with http://localhost:8472. This change does not affect the procedural APIs.
 * @namespace The Identity object contains information regarding the user&apos;s identity and accounts on a BlackBerry smartphone.
 * @featureID blackberry.identity
 * @featureID blackberry.identity.phone
@@ -30,7 +28,7 @@ blackberry.identity = {
 /**
  * Returns a JSON object containing the PIN of the device.
  * @uri 
- * @PB10
+ * @PB10+
  * @returns {JSON of all the properties}
  * {
  * 	"data":{
@@ -101,7 +99,7 @@ blackberry.identity.getTransportList = function() { };
 * @readOnly
 * @BB50+
 * @RIPPLE
-* @PB10
+* @PB10+
 */
 blackberry.identity.PIN = { };
 

diff --git a/api/blackberry_invoke.js b/api/blackberry_invoke.js
@@ -44,7 +44,7 @@ blackberry.invoke = {
 		 * @param {Object} [args] An arguments object specifying information for the application being invoked.
 		 * @throws {Exception} If values supplied are not correct. 
 		 * @BB50+
-		 * @PB10
+		 * @PB10+
 		 * @RIPPLE
 		 */
 		invoke : function(appType, args){},
@@ -94,7 +94,7 @@ blackberry.invoke = {
 		 * @type Number
 		 * @constant
 		 * @BB50+
-		 * @PB10
+		 * @PB10+
 		 * @RIPPLE
 		 * @description Camera.
 		 */
@@ -105,7 +105,7 @@ blackberry.invoke = {
 		 * @type Number
 		 * @constant
 		 * @BB50+
-		 * @PB10
+		 * @PB10+
 		 * @RIPPLE
 		 * @description Maps.
 		 */
@@ -164,7 +164,7 @@ blackberry.invoke = {
 		 * @type Number
 		 * @constant
 		 * @BB50+
-		 * @PB10
+		 * @PB10+
 		 * @RIPPLE
 		 * @description Browser.
 		 */
@@ -182,7 +182,7 @@ blackberry.invoke = {
 		 * @default 13
 		 * @type Number
 		 * @constant
-		 * @PB10
+		 * @PB10+
 		 * @RIPPLE
 		 * @description Music Application.
 		 */
@@ -191,7 +191,7 @@ blackberry.invoke = {
 		 * @default 14
 		 * @type Number
 		 * @constant
-		 * @PB10
+		 * @PB10+
 		 * @RIPPLE
 		 * @description Photos Application.
 		 */
@@ -200,7 +200,7 @@ blackberry.invoke = {
 		 * @default 15
 		 * @type Number
 		 * @constant
-		 * @PB10
+		 * @PB10+
 		 * @RIPPLE
 		 * @description Videos Application.
 		 */
@@ -209,7 +209,7 @@ blackberry.invoke = {
 		 * @default 16
 		 * @type Number
 		 * @constant
-		 * @PB10
+		 * @PB10+
 		 * @RIPPLE
 		 * @description App World Application.
 		 */

diff --git a/api/blackberry_invoke_BrowserArguments.js b/api/blackberry_invoke_BrowserArguments.js
@@ -21,7 +21,7 @@
 *     </p></div>
 * @toc {Invoke} BrowserArguments 
 * @BB50+
-* @PB10
+* @PB10+
 * @RIPPLE
 * @class The BrowserArguments object is an instance object, and is used as a parameter to the invoke() method when invoking the BlackBerry Browser application.
 * @featureID blackberry.invoke

diff --git a/api/blackberry_invoke_CameraArguments.js b/api/blackberry_invoke_CameraArguments.js
@@ -20,7 +20,7 @@
 *     </p></div>
 * @toc {Invoke} CameraArguments 
 * @BB50+
-* @PB10
+* @PB10+
 * @RIPPLE
 * @class The CameraArguments object is an instance object, and is used as a parameter to the invoke() method when invoking the Camera application or Recorder application.
 * @featureID blackberry.invoke
@@ -40,7 +40,7 @@ blackberry.invoke.CameraArguments = function() { };
 * Photo Camera 
 * @type Number
 * @constant
-* @PB10
+* @PB10+
 * @BB50+
 * @RIPPLE
 */
@@ -51,7 +51,7 @@ blackberry.invoke.CameraArguments.VIEW_CAMERA = 0;
 * @type Number
 * @constant
 * @BB50+
-* @PB10
+* @PB10+
 * @RIPPLE
 */
 blackberry.invoke.CameraArguments.VIEW_RECORDER = 1;
@@ -60,7 +60,7 @@ blackberry.invoke.CameraArguments.VIEW_RECORDER = 1;
 * Value that specifies what kind of camera application you want to open. 
 * @type Number
 * @BB50+
-* @PB10
+* @PB10+
 * @RIPPLE
 */
 blackberry.invoke.CameraArguments.prototype.view = { };