Skip to content
Browse files

Documentations changes and merge from source

  • Loading branch information...
2 parents aa60eaa + 8beb384 commit 5bd727b64c2f4d0a6bcab77499da428c0645653f Mike Waugh committed
View
26 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
* <script type="text/javascript">
@@ -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":{
View
8 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) {}
View
6 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 = { };
View
16 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.
*/
View
2 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
View
8 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 = { };
View
46 api/blackberry_io_dir.js
@@ -1,4 +1,4 @@
-/*
+/*
* Copyright 2010-2011 Research In Motion Limited.
*
* Licensed under the Apache License, Version 2.0 (the "License");
@@ -16,8 +16,6 @@
/**
* @toc {IO} Directory
-* @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 Directory object provides functions for interacting with directories on the file system.<br><br>
* See also {@link blackberry.io.file}
* @featureID blackberry.io.dir
@@ -33,7 +31,8 @@ blackberry.io.dir = {
*
* @type Object
* @readOnly
- * @PB10
+ * @RIPPLE
+ * @PB10+
* @example
* &lt;script type=&quot;text&sol;javascript&quot;&gt;
* var dirs = blackberry.io.dir.appDirs;
@@ -101,7 +100,7 @@ blackberry.io.dir = {
* }
* }
* }
- * @PB10
+ * @PB10+
* @uri
* @function
*/
@@ -112,7 +111,8 @@ blackberry.io.dir = {
* @param {String} path Path location of the directory.
* @returns {String[]}
* @BB50+
- * @PB10
+ * @RIPPLE
+ * @PB10+
*/
listFiles : function(path) { },
@@ -121,7 +121,8 @@ blackberry.io.dir = {
* @param {String} path path location of the directory.
* @returns {String[]}
* @BB50+
- * @PB10
+ * @RIPPLE
+ * @PB10+
*/
listDirectories : function(path) { },
@@ -133,7 +134,8 @@ blackberry.io.dir = {
* @param {String} path path location of the directory.
* @returns {Boolean}
* @BB50+
- * @PB10
+ * @RIPPLE
+ * @PB10+
*/
/**
* @name blackberry.io.dir.exists
@@ -146,7 +148,7 @@ blackberry.io.dir = {
* "exists" : true if the path exists and points to a directory, false otherwise
* }
* }
- * @PB10
+ * @PB10+
* @uri
* @function
*/
@@ -160,7 +162,8 @@ blackberry.io.dir = {
* @param {String} newDirectoryName the new name for the directory.
* @returns {void}
* @BB50+
- * @PB10
+ * @RIPPLE
+ * @PB10+
*/
/**
* @name blackberry.io.dir.rename
@@ -174,7 +177,7 @@ blackberry.io.dir = {
* "newDirectoryName" : "&lt;newDirectoryName that was passed&gt;"
* }
* }
- * @PB10
+ * @PB10+
* @uri
* @function
*/
@@ -186,7 +189,8 @@ blackberry.io.dir = {
* @param {Boolean} [recursive] flag to decide if all contents should be deleted
* @returns {void}
* @BB50+
- * @PB10
+ * @RIPPLE
+ * @PB10+
*/
deleteDirectory : function(path, recursive) { },
@@ -195,7 +199,8 @@ blackberry.io.dir = {
* @param {String} path Path of the directory or file.
* @returns {String}
* @BB50+
- * @PB10
+ * @RIPPLE
+ * @PB10+
*/
getParentDirectory : function(path) { },
@@ -204,7 +209,8 @@ blackberry.io.dir = {
* @param {String} path path location of the new directory. The name of the new directory should be included as parts of the path.
* @returns {void}
* @BB50+
- * @PB10
+ * @RIPPLE
+ * @PB10+
*/
createNewDir : function(path) { },
@@ -212,6 +218,7 @@ blackberry.io.dir = {
* Get a list of root directories.
* @returns {String[]}
* @BB50+
+ * @RIPPLE
* @example
* &lt;script type=&quot;text&sol;javascript&quot;&gt;
* var i;
@@ -234,6 +241,7 @@ blackberry.io.dir = {
* @param {String} rootPath Root path location to determine free space for.
* @returns {Number} The amound of free space availalble in the specified root.
* @BB50+
+ * @RIPPLE
*/
getFreeSpaceForRoot : function(rootPath) { },
@@ -246,7 +254,7 @@ blackberry.io.dir = {
* "path": "&lt;path that was passed&gt;"
* }
* }
- * @PB10
+ * @PB10+
* @uri
*/
create : function(path) {},
@@ -263,7 +271,7 @@ blackberry.io.dir = {
* "recursive" : the boolean that was passed (false if "recursive" was not specified)
* }
* }
- * @PB10
+ * @PB10+
* @uri
* @function
*/
@@ -281,7 +289,7 @@ blackberry.io.dir = {
* "isEmpty": true (if directory does not contain files or sub-directories) or false (if directory contains files or sub-directories), // only defined if "code" is 0
* }
* }
- * @PB10
+ * @PB10+
* @uri
*/
get : function(path) {},
@@ -296,7 +304,7 @@ blackberry.io.dir = {
* "directory" : "&lt;parent directory&gt;" // only defined if "code" is 0
* }
* }
- * @PB10
+ * @PB10+
* @uri
*/
parent : function(path) {},
@@ -343,7 +351,7 @@ blackberry.io.dir = {
* }
* });
* &lt;&sol;script&gt;
- * @PB10
+ * @PB10+
* @uri
*/
list : function(path) {}
View
40 api/blackberry_io_file.js
@@ -1,4 +1,4 @@
-/*
+/*
* Copyright 2010-2011 Research In Motion Limited.
*
* Licensed under the Apache License, Version 2.0 (the "License");
@@ -16,8 +16,6 @@
/**
* @toc {IO} File
-* @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 File object provides functions for interacting with the file system.<br><br>
* See also {@link blackberry.io.dir}
* @featureID blackberry.io.file
@@ -29,7 +27,8 @@ blackberry.io.file = {
* @param {String} path local storage file path to the file
* @returns {blackberry.io.file.FileProperties}
* @BB50+
- * @PB10
+ * @RIPPLE
+ * @PB10+
*/
getFileProperties : function(path) { },
@@ -40,7 +39,8 @@ blackberry.io.file = {
* @param {String} path local storage file path to the file
* @returns {Boolean}
* @BB50+
- * @PB10
+ * @RIPPLE
+ * @PB10+
*/
/**
* @name blackberry.io.file.exists
@@ -53,7 +53,7 @@ blackberry.io.file = {
* "exists" : true if the path exists and points to a file, false otherwise
* }
* }
- * @PB10
+ * @PB10+
* @uri
* @function
*/
@@ -66,7 +66,8 @@ blackberry.io.file = {
* @param {String} path file path to the file to be opened.
* @returns {Boolean}
* @BB50+
- * @PB10
+ * @RIPPLE
+ * @PB10+
*/
/**
* @name blackberry.io.file.open
@@ -79,7 +80,7 @@ blackberry.io.file = {
* }
* }
* @type {Boolean}
- * @PB10
+ * @PB10+
* @uri
* @function
*/
@@ -93,7 +94,8 @@ blackberry.io.file = {
* @param {String} newFileName the new file name.
* @returns {void}
* @BB50+
- * @PB10
+ * @RIPPLE
+ * @PB10+
*/
/**
* @name blackberry.io.file.rename
@@ -107,7 +109,7 @@ blackberry.io.file = {
* "newFileName" : "&lt;newFileName that was passed&gt;"
* }
* }
- * @PB10
+ * @PB10+
* @uri
* @function
*/
@@ -121,7 +123,8 @@ blackberry.io.file = {
* @param {String} targetPath local storage file path to the new copied file. The name of the copied file should be specified at the end of the targetPath.
* @returns {void}
* @BB50+
- * @PB10
+ * @RIPPLE
+ * @PB10+
*/
/**
* @name blackberry.io.file.copy
@@ -135,7 +138,7 @@ blackberry.io.file = {
* "targetPath" : "&lt;targetPath that was passed&gt;"
* }
* }
- * @PB10
+ * @PB10+
* @uri
* @function
*/
@@ -146,7 +149,8 @@ blackberry.io.file = {
* @param {String} path local storage file path to the file to be deleted
* @returns {void}
* @BB50+
- * @PB10
+ * @PB10+
+ * @RIPPLE
*/
deleteFile : function(path) { },
@@ -158,7 +162,8 @@ blackberry.io.file = {
* @param {Blob} data The Blob to be saved.
* @returns {void}
* @BB50+
- * @PB10
+ * @RIPPLE
+ * @PB10+
* @example
* &lt;script type=&quot;text&sol;javascript&quot;&gt;
* var xmlString = &quot;&lt;test&gt;IO functions&lt;&sol;test&gt;&quot;;
@@ -190,7 +195,8 @@ blackberry.io.file = {
* @param {Boolean} [async] a flag specifying if the call to read should be asynchronous or synchronous. If this parameter is not supplied the default of true will be used.
* @returns {void}
* @BB50+
- * @PB10
+ * @RIPPLE
+ * @PB10+
*/
readFile : function(path,onFileOpened,async) { },
@@ -204,7 +210,7 @@ blackberry.io.file = {
* "path" : "&lt;path that was passed&gt;"
* }
* }
- * @PB10
+ * @PB10+
* @uri
* @function
*/
@@ -225,7 +231,7 @@ blackberry.io.file = {
* "size" : &lt;file size in bytes&gt; // only defined if "code" is 0
* }
* }
- * @PB10
+ * @PB10+
* @uri
* @example
* &lt;script type="text/javascript" src="js/jquery-1.4.2.js"&gt;&lt;/script&gt;
View
22 api/blackberry_io_file_FileProperties.js
@@ -1,4 +1,4 @@
-/*
+/*
* Copyright 2010-2011 Research In Motion Limited.
*
* Licensed under the Apache License, Version 2.0 (the "License");
@@ -38,6 +38,7 @@ blackberry.io.file.FileProperties = { };
* @type Boolean
* @readOnly
* @BB50+
+* @RIPPLE
*/
blackberry.io.file.FileProperties.prototype.isReadonly = { };
@@ -46,7 +47,8 @@ blackberry.io.file.FileProperties.prototype.isReadonly = { };
* @type Boolean
* @readOnly
* @BB50+
-* @PB10
+* @RIPPLE
+* @PB10+
*/
blackberry.io.file.FileProperties.prototype.isHidden = { };
@@ -55,7 +57,8 @@ blackberry.io.file.FileProperties.prototype.isHidden = { };
* @type Number
* @readOnly
* @BB50+
-* @PB10
+* @RIPPLE
+* @PB10+
*/
blackberry.io.file.FileProperties.prototype.size = { };
@@ -63,7 +66,8 @@ blackberry.io.file.FileProperties.prototype.size = { };
* File creation date
* @type Date
* @readOnly
-* @PB10
+* @RIPPLE
+* @PB10+
*/
blackberry.io.file.FileProperties.prototype.dateCreated = { };
@@ -72,7 +76,8 @@ blackberry.io.file.FileProperties.prototype.dateCreated = { };
* @type Date
* @readOnly
* @BB50+
-* @PB10
+* @RIPPLE
+* @PB10+
*/
blackberry.io.file.FileProperties.prototype.dateModified = { };
@@ -81,7 +86,8 @@ blackberry.io.file.FileProperties.prototype.dateModified = { };
* @type String
* @readOnly
* @BB50+
-* @PB10
+* @RIPPLE
+* @PB10+
*/
blackberry.io.file.FileProperties.prototype.fileExtension = { };
@@ -90,7 +96,8 @@ blackberry.io.file.FileProperties.prototype.fileExtension = { };
* @type String
* @readOnly
* @BB50+
-* @PB10
+* @RIPPLE
+* @PB10+
*/
blackberry.io.file.FileProperties.prototype.directory = { };
@@ -99,6 +106,7 @@ blackberry.io.file.FileProperties.prototype.directory = { };
* @type String
* @readOnly
* @BB50+
+* @RIPPLE
*/
blackberry.io.file.FileProperties.prototype.mimeType = { };
View
4 api/blackberry_media_camera.js
@@ -54,7 +54,7 @@ blackberry.media.camera = {
* @callback {function} [onError] Method will be invoked when an error occurs. <br/>Expected signature: <code>function onError(e)</code>
* @callback {String} [onError.e] Error message
* @BB50+
- * @PB10
+ * @PB10+
*/
takePicture: function(onCaptured, onCameraClosed, onError) {
},
@@ -67,7 +67,7 @@ blackberry.media.camera = {
* @callback {function} [onError] Method will be invoked when an error occurs. <br/>Expected signature: <code>function onError(e)</code>
* @callback {String} [onError.e] Error message
* @BB50+
- * @PB10
+ * @PB10+
* @example
* function takeVideo() {
* try {
View
6 api/blackberry_media_microphone.js
@@ -151,7 +151,7 @@ blackberry.media.microphone = {
* @callback {Number} onError.errorCode The error code for the error.
* @callback {String} onError.errorMsg The error message for the error.
* @returns {void}
- * @PB10
+ * @PB10+
* @BB50+
*/
record : function(filePath, onCaptured, onError) {},
@@ -160,7 +160,7 @@ blackberry.media.microphone = {
* Pauses/resumes recording.<br><br>If the microphone is in recording mode, calling pause() would cause recording to
* pause. If the microphone is paused, calling pause() would cause recording to resume.<br><br>
* @returns {void}
- * @PB10
+ * @PB10+
* @BB50+
*/
pause : function() {},
@@ -169,7 +169,7 @@ blackberry.media.microphone = {
* Stops recording, this causes the recorded audio data to be saved to the file. The onCaptured callback function passed in record will be
* invoked when the audio file has been saved to disk.
* @returns {void}
- * @PB10
+ * @PB10+
* @BB50+
*/
stop : function() {}
View
41 api/blackberry_payment.js
@@ -62,9 +62,9 @@ blackberry.payment = {
* <li> Digital Good not Found = 4</li>
* <li> Illegal Application Error = 5 [BlackBerry OS 5.0+ only]</li>
* </ul>
- * <b>Note:</b> The actual values may be different when {@link blackberry.payment.developmentMode} equals true.
- * @since Version 1.0
- * @PB10
+ * <b>Note:</b> The actual values may be different when {@link blackberry.payment.developmentMode} equals true.
+ * @since Version 1.0
+ * @PB10+
* @BB50+
*/
getExistingPurchases : function (refresh, callbackOnSuccess, callbackOnFailure) {
@@ -90,9 +90,9 @@ blackberry.payment = {
* <li> General Payment System Error = 3</li>
* <li> Digital Good not Found = 4</li>
* <li> Illegal Application Error = 5 [BlackBerry OS 5.0+ only]</li>
- * </ul>
- * @since Version 1.0
- * @PB10
+ * </ul>
+ * @since Version 1.0
+ * @PB10+
* @BB50+
* @example
* &lt;script type="text/javascript"&gt;
@@ -125,7 +125,7 @@ blackberry.payment = {
* &lt;/script&gt;
*/
purchase : function (args, callbackOnSuccess, callbackOnFailure) {
- },
+ },
/**
* @function
* @description Initiates a request for the price of a digital good. The request can be initiated by using either the digital good ID or the digital good SKU to be purchased, but it is not necessary to provide both.
@@ -155,6 +155,7 @@ blackberry.payment = {
* <li> Illegal Application Error = 5 [BlackBerry OS 5.0+ only]</li>
* </ul>
* @since Version 1.5.0
+ * @PB10+
@tohman
tohman added a note

I don't think the method getPrice was ever implemented for playbook if so remove playbook support tag.

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
* @BB50+
* @example
* &lt;script type="text/javascript"&gt;
@@ -190,7 +191,7 @@ blackberry.payment = {
},
/**
* @function
- * @description Returns a {@link Purchase} object if the logged in BBID user has rights for this digital good SKU at the time of calling this method. The result will be based on the default business rules defined by the PS Server / AppWorld. For example: In the case of a subscription a "Canceled" subscription will return true till the next renewal date. All "Refunded" SKUs will return false immediately. This call is used to get the transactionID for use with the {@link cancel} method to cancel a subscription.
+ * @description Returns a {@link Purchase} object if the user who is logged in with a BlackBerry ID has rights for this digital good SKU at the time of calling this method. The result is based on the default business rules defined by the Payment Service server or BlackBerry App World. For example, in the case of a subscription, a "Canceled" subscription will return true until the next renewal date. All "Refunded" SKUs will return false immediately.
* @param {String} sku of the digital good to query.
* @callback {function} callbackOnSuccess Function to be called when the price set is retrieved.
* @callback {String} callbackOnSuccess.data A string representing a digital good object literal is passed as a parameter in the form below:
@@ -336,7 +337,7 @@ blackberry.payment = {
},
/**
* @function
- * @description Retrieve the user's purchase history for the calling application as well as any digital goods associated to the application.
+ * @description Retrieve the user's purchase history for the calling application as well as any digital goods associated with the application.
* @callback {function} callbackOnSuccess Function to be invoked on successful call.
* @callback {String} callbackOnSuccess.data A string representing a literal array of {@link Purchase} items is passed as a parameter in the form below:
* <pre>[{
@@ -372,7 +373,7 @@ blackberry.payment = {
},
/**
* @function
- * @description Invokes callbackOnSuccess if the logged in BBID user has rights for this digital good SKU at the time of calling this method.
+ * @description Invokes callbackOnSuccess if the user who is logged in with a BlackBerry ID has rights for this digital good SKU at the time of calling this method.
* @param {String} sku the SKU of the digital goods requested
* @callback {function} callbackOnSuccess Function to be invoked on successful call.
* @callback {function} [callbackOnFailure] Function to be invoked when an error occurs.
@@ -392,7 +393,7 @@ blackberry.payment = {
},
/**
* @function
- * @description Starts the process of upgrading App World to the current version by opening the browser on the device to the AppWorld upgrade page.
+ * @description Starts the process of upgrading BlackBerry App World to the current version by opening the browser on the device to the BlackBerry App World upgrade page.
* @callback {function} callbackOnSuccess Function to be invoked on successful call.
* @callback {function} [callbackOnFailure] Function to be invoked when an error occurs.
* @callback {String} callbackOnFailure.errorText Retrieves the message set for an error. In addition to descriptive text, error code may appear at the end of the message.
@@ -411,7 +412,7 @@ blackberry.payment = {
},
/**
* @function
- * @description Invokes the callbackOnSuccess if the App World client is installed and at the correct verison.
+ * @description Invokes the callbackOnSuccess if the BlackBerry App World client is installed and at the correct verison.
* @callback {function} callbackOnSuccess Function to be invoked on successful call.
* @callback {function} [callbackOnFailure] Function to be invoked when an error occurs.
* @callback {String} callbackOnFailure.errorText Retrieves the message set for an error. In addition to descriptive text, error code may appear at the end of the message.
@@ -436,7 +437,7 @@ blackberry.payment = {
},
/**
* @function
- * @description Sets the debug flag to flase to hide debug information from being shown.
+ * @description Sets the debug flag to false to hide debug information from being shown.
*/
setDebugFalse : function() {
},
@@ -454,7 +455,7 @@ Purchase = { };
/**
* @type String
* @description The transaction ID for this purchase.
- * @PB10
+ * @PB10+
* @BB50+
*/
Purchase.prototype.transactionID = null;
@@ -462,7 +463,7 @@ Purchase.prototype.transactionID = null;
/**
* @type String
* @description The ID of the purchased digital good.
- * @PB10
+ * @PB10+
* @BB50+
*/
Purchase.prototype.digitalGoodID = null;
@@ -470,7 +471,7 @@ Purchase.prototype.digitalGoodID = null;
/**
* @type String
* @description The SKU of the purchased digital good.
- * @PB10
+ * @PB10+
* @BB50+
*/
Purchase.prototype.digitalGoodSKU = null;
@@ -478,7 +479,7 @@ Purchase.prototype.digitalGoodSKU = null;
/**
* @type String
* @description The metadata for this purchase, or null if no metadata was included with the purchase.
- * @PB10
+ * @PB10+
* @BB50+
*/
Purchase.prototype.metaData = null;
@@ -486,7 +487,7 @@ Purchase.prototype.metaData = null;
/**
* @type String
* @description The Epoch time represention of the date this purchase was made.
- * @PB10
+ * @PB10+
* @BB50+
*/
Purchase.prototype.date = null;
@@ -494,7 +495,7 @@ Purchase.prototype.date = null;
/**
* @type String
* @description Represents the license key for this purchase, or null if the purchased digital good does not have a license key.
- * @PB10
+ * @PB10+
* @BB50+
*/
Purchase.prototype.licenseKey = null;
@@ -576,4 +577,4 @@ DigitalGood.prototype.subscriptionPeriod = null;
* @description The intial subscription period for the digital good, or null if this digital good is not a subscription item.
* @BB50+
*/
-DigitalGood.prototype.subscriptionInitialPeriod = null;
+DigitalGood.prototype.subscriptionInitialPeriod = null;
View
22 api/blackberry_system.js
@@ -17,8 +17,6 @@
/**
* @toc {System} System
* @featureID blackberry.system
- * @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 System object allows you to get access to system level functions and attributes of the BlackBerry PlayBook.<br>
* <br> The System object is static; all of its functions and properties are used directly from the object.
* @example
@@ -56,7 +54,7 @@ blackberry.system ={
* <br>and network.iden.
* @returns {Boolean} Returns true if the device is capable of the given service.
* @BB50+
- * @PB10
+ * @PB10+
* @RIPPLE
*/
hasCapability : function(capability){},
@@ -66,7 +64,7 @@ blackberry.system ={
* @description Returns true if the device is in coverage, otherwise returns false. This can be used in conjunction with the blackberry.network property to find out what kind of coverage it is in.
* @returns {Boolean} Returns true if the BlackBerry PlayBook or the BlackBerry Smartphone device has any network interface active.
* @BB50+
- * @PB10
+ * @PB10+
* @RIPPLE
*/
hasDataCoverage : function(){},
@@ -85,7 +83,7 @@ blackberry.system ={
* @description Determines the level of access to the requested module.
* @returns {Number} The possible return values: 0 - ALLOW 1 - DENY
* @BB50+
- * @PB10
+ * @PB10+
* @RIPPLE
*/
hasPermission : function(module){},
@@ -94,7 +92,7 @@ blackberry.system ={
* @description Returns whether USB MassStorage mode is active.
* @returns {Boolean} Always returns false on the BlackBerry PlayBook since Mass Storage Mode is not supported. All memory is presented as a network share when connected by USB and is not blocked.
* @BB50+
- * @PB10
+ * @PB10+
* @RIPPLE
*/
isMassStorageActive : function(){},
@@ -102,7 +100,7 @@ blackberry.system ={
/**
* @uri
* @BB50+
- * @PB10
+ * @PB10+
* @description The objects in hasPermission will always be ALLOW (0). They will correspond to all the entries in the whitelist. If they are not whitelisted, they are omitted from the list. Similarly, all of the objects in hasCapability will be true, otherwise they will be omitted.
* @returns {JSON of all the properties}
* {
@@ -169,7 +167,7 @@ blackberry.system ={
* @description Returns the model number of the BlackBerry PlayBook or the BlackBerry Smartphone device.
* @readOnly
* @BB50+
- * @PB10
+ * @PB10+
* @RIPPLE
*/
model: null,
@@ -179,7 +177,7 @@ blackberry.system ={
* @description Returns the current version of the WebWorks library being used.
* @readOnly
* @BB50+
- * @PB10
+ * @PB10+
* @RIPPLE
*/
scriptApiVersion:null,
@@ -189,7 +187,7 @@ blackberry.system ={
* @description Returns the current version of the operating system, for example, 1.0.0.0.
* @readOnly
* @BB50+
- * @PB10
+ * @PB10+
* @RIPPLE
*/
softwareVersion:null,
@@ -200,7 +198,7 @@ blackberry.system ={
* @description Returned by hasPermission() indicating that the module requested is accessible.
* @default 0
* @BB50+
- * @PB10
+ * @PB10+
* @RIPPLE
*/
ALLOW : 0,
@@ -210,7 +208,7 @@ blackberry.system ={
* @description Returned by hasPermission() indicating that the module is not accessible.
* @default 1
* @BB50+
- * @PB10
+ * @PB10+
* @RIPPLE
*/
DENY:1
View
4 api/blackberry_system_event.js
@@ -136,7 +136,7 @@ blackberry.system.event.onCoverageChange = function(onSystemEvent) { };
* Battery level is a percentage value.
* @callback {function} onBatteryLevelChange Function to be called when the battery level changes. The level is passed as its only argument.
* @callback {Number} onBatteryLevelChange.level battery level of the device ranging from 0 to 100
- * @PB10
+ * @PB10+
* @RIPPLE
* @example
* &lt;script type="text/javascript"&gt;
@@ -164,7 +164,7 @@ blackberry.system.event.deviceBatteryLevelChange = function(onBatteryLevelChang
* <br>UNPLUGGED = 3;
* @callback {function} onBatteryStateChange Function to be called when the battery charge state changes. The new state is passed as its only argument.
* @callback {Number} onBatteryStateChange.state battery state of the device
- * @PB10
+ * @PB10+
* @RIPPLE
*/
blackberry.system.event.deviceBatteryStateChange = function(onBatteryStateChange){};
View
30 api/blackberry_ui_dialog.js
@@ -58,7 +58,7 @@ blackberry.ui.dialog ={
* @param {String} [settings.title] Desired title of the dialog.
* @param {String[]} [settings.size] Desired size of the dialog.
* @param {String[]} [settings.position] Desired position of the dialog.
- * @PB10
+ * @PB10+
* @RIPPLE
* @example
* &lt;script type="text/javascript"&gt;
@@ -118,7 +118,7 @@ blackberry.ui.dialog ={
* @param {String} [settings.title] Desired title of the dialog.
* @param {String[]} [settings.size] Desired size of the dialog.
* @param {String[]} [settings.position] Desired position of the dialog.
- * @PB10
+ * @PB10+
* @RIPPLE
* @example
* &lt;script type="text/javascript"&gt;
@@ -145,7 +145,7 @@ blackberry.ui.dialog ={
* @description Standard OK dialog
* @default 0
* @BB50+
- * @PB10
+ * @PB10+
* @RIPPLE
*/
D_OK : 0,
@@ -155,7 +155,7 @@ blackberry.ui.dialog ={
* @description Standard Save dialog
* @default 1
* @BB50+
- * @PB10
+ * @PB10+
* @RIPPLE
*/
D_SAVE:1,
@@ -165,7 +165,7 @@ blackberry.ui.dialog ={
* @description Standard Delete confirmation dialog
* @default 2
* @BB50+
- * @PB10
+ * @PB10+
* @RIPPLE
*/
D_DELETE:2,
@@ -175,7 +175,7 @@ blackberry.ui.dialog ={
* @description Standard Yes/No dialog
* @default 3
* @BB50+
- * @PB10
+ * @PB10+
* @RIPPLE
*/
D_YES_NO:3,
@@ -185,7 +185,7 @@ blackberry.ui.dialog ={
* @description Standard OK/Cancel dialog
* @default 4
* @BB50+
- * @PB10
+ * @PB10+
* @RIPPLE
*/
D_OK_CANCEL:4,
@@ -258,7 +258,7 @@ blackberry.ui.dialog ={
* @type String
* @description Bottom located dialog
* @default "bottomCenter"
- * @PB10
+ * @PB10+
* @RIPPLE
*/
BOTTOM : "bottomCenter",
@@ -267,7 +267,7 @@ blackberry.ui.dialog ={
* @type String
* @description Center located dialog
* @default "middleCenter"
- * @PB10
+ * @PB10+
* @RIPPLE
*/
CENTER : "middleCenter",
@@ -276,7 +276,7 @@ blackberry.ui.dialog ={
* @type String
* @description Top located dialog
* @default "topCenter"
- * @PB10
+ * @PB10+
* @RIPPLE
*/
TOP : "topCenter",
@@ -285,7 +285,7 @@ blackberry.ui.dialog ={
* @type String
* @description Full size dialog
* @default "full"
- * @PB10
+ * @PB10+
* @RIPPLE
*/
SIZE_FULL : null,
@@ -294,7 +294,7 @@ blackberry.ui.dialog ={
* @type String
* @description Large size dialog
* @default "large"
- * @PB10
+ * @PB10+
* @RIPPLE
*/
SIZE_LARGE : null,
@@ -303,7 +303,7 @@ blackberry.ui.dialog ={
* @type String
* @description Medium size dialog
* @default "medium"
- * @PB10
+ * @PB10+
* @RIPPLE
*/
SIZE_MEDIUM : null,
@@ -312,7 +312,7 @@ blackberry.ui.dialog ={
* @type String
* @description Small size dialog
* @default "small"
- * @PB10
+ * @PB10+
* @RIPPLE
*/
SIZE_SMALL : null,
@@ -321,7 +321,7 @@ blackberry.ui.dialog ={
* @type String
* @description Tall size dialog
* @default "tall"
- * @PB10
+ * @PB10+
* @RIPPLE
*/
SIZE_TALL : null
View
16 api/blackberry_utils.js
@@ -33,7 +33,7 @@ blackberry.utils = {
* @param {String} [encoding = ISO-8859-1] The name of a supported character encoding.BlackBerry supports the following character encodings: ISO-8859-1, UTF-8, UTF-16BE, US-ASCII. Besides these encodings, Web API also supports BASE64 encoding. Support of other encodings depends on the configuration of the BlackBerry Smartphone.
* @returns {String} The String result from converting the Blob
* @BB50+
- * @PB10
+ * @PB10+
* @RIPPLE
*/
blobToString : function(blob,encoding){},
@@ -60,7 +60,7 @@ blackberry.utils = {
* @param {String} [encoding = ISO-8859-1] The name of a supported character encoding.BlackBerry supports the following character encodings: ISO-8859-1, UTF-8, UTF-16BE, US-ASCII. Besides these encodings, Web API also supports BASE64 encoding. Support of other encodings depends on the configuration of the BlackBerry Smartphone.
* @returns {Blob} The Blob result from converting the String
* @BB50+
- * @PB10
+ * @PB10+
* @RIPPLE
*/
stringToBlob : function(str,encoding){},
@@ -70,7 +70,7 @@ blackberry.utils = {
* @description This method will generate a unique number.
* @returns {Number} A unique number from JavaScript's Math.random() function.
* @BB50+
- * @PB10
+ * @PB10+
* @RIPPLE
*/
generateUniqueId: function(){},
@@ -80,7 +80,7 @@ blackberry.utils = {
* @param {String} url The URL string to be parsed.
* @returns {blackberry.utils.URL} A {@link blackberry.utils.URL} object is returned if the parsing is successful.
* @BB50+
- * @PB10
+ * @PB10+
* @RIPPLE
*/
parseURL: function(url){},
@@ -99,7 +99,7 @@ blackberry.utils = {
* @param {String} key The key of the parameter to be retrieved.
* @returns {String} An undefined object is returned if the key does not exist in the URL query.
* @BB50+
- * @PB10
+ * @PB10+
* @RIPPLE
*/
getURLParameter:function(key){},
@@ -109,7 +109,7 @@ blackberry.utils = {
* @param {Number} index The index of the parameter to be retrieved.
* @returns {String} An undefined object is returned if the index is invalid.
* @BB50+
- * @PB10
+ * @PB10+
* @RIPPLE
*/
getURLParameterByIndex:function(index){},
@@ -118,7 +118,7 @@ blackberry.utils = {
* @readOnly
* @type String
* @BB50+
- * @PB10
+ * @PB10+
* @RIPPLE
* @description Host address in the URL string.
*/
@@ -127,7 +127,7 @@ blackberry.utils = {
* @readOnly
* @type Number
* @BB50+
- * @PB10
+ * @PB10+
* @RIPPLE
* @description Port number in the URL string.
*/
View
38 api/html5_app_cache.js
@@ -32,7 +32,7 @@ ApplicationCache ={
* var appCache = window.applicationCache;
* &lt;/script&gt;
* @BB60+
- * @PB10
+ * @PB10+
* @RIPPLE
*/
windowConstructor : undefined,
@@ -50,7 +50,7 @@ ApplicationCache ={
*
* var appCache = self.applicationCache()
* @BB60+
- * @PB10
+ * @PB10+
* @RIPPLE
*/
workerConstructor : undefined,
@@ -61,7 +61,7 @@ ApplicationCache ={
* @description The ApplicationCache object's cache host is not associated with an application cache at this time.
* @type Number
* @BB60+
- * @PB10
+ * @PB10+
* @RIPPLE
*/
UNCACHED: 0,
@@ -75,7 +75,7 @@ ApplicationCache ={
* and the application cache group is not marked as obsolete.
* @type Number
* @BB60+
- * @PB10
+ * @PB10+
* @RIPPLE
*/
IDLE: 1,
@@ -87,7 +87,7 @@ ApplicationCache ={
* whose application cache group's update status is checking.
* @type Number
* @BB60+
- * @PB10
+ * @PB10+
* @RIPPLE
*/
CHECKING: 2,
@@ -99,7 +99,7 @@ ApplicationCache ={
* whose application cache group's update status is downloading.
* @type Number
* @BB60+
- * @PB10
+ * @PB10+
* @RIPPLE
*/
DOWNLOADING: 3,
@@ -112,7 +112,7 @@ ApplicationCache ={
* is not marked as obsolete, but that application cache is not the newest cache in its group.
* @type Number
* @BB60+
- * @PB10
+ * @PB10+
* @RIPPLE
*/
UPDATEREADY: 4,
@@ -124,7 +124,7 @@ ApplicationCache ={
* whose application cache group is marked as obsolete.
* @type Number
* @BB60+
- * @PB10
+ * @PB10+
* @RIPPLE
*/
OBSOLETE: 5
@@ -143,7 +143,7 @@ ApplicationCache ={
* @readonly
* @type Number
* @BB60+
- * @PB10
+ * @PB10+
* @RIPPLE
* @example
* var appCache = window.applicationCache;
@@ -178,7 +178,7 @@ ApplicationCache.prototype.status = undefined;
* @description Invokes the application cache download process.
* <br>Throws an INVALID_STATE_ERR exception if there is no application cache to update.<br>
* @BB60+
- * @PB10
+ * @PB10+
* @RIPPLE
* @example
* var appCache = window.applicationCache;
@@ -198,7 +198,7 @@ ApplicationCache.prototype.update = undefined;
* The only change is that subsequent requests for cached resources will obtain the newer copies.<br>
* @throws {INVALID_STATE_ERR} If the current app cache is the most recent
* @BB60+
- * @PB10
+ * @PB10+
* @RIPPLE
* @example
* var appCache = window.applicationCache;
@@ -213,7 +213,7 @@ ApplicationCache.prototype.swapCache = undefined;
/**@event
* @description Sent when the cache update process begins.<br>
* @BB60+
- * @PB10
+ * @PB10+
* @RIPPLE
* @example
* function handleCacheEvent(e) {
@@ -228,7 +228,7 @@ ApplicationCache.prototype.checking = undefined;
* @event
* @description Sent when an error occurs.<br>
* @BB60+
- * @PB10
+ * @PB10+
* @RIPPLE
* @example
* function handleCacheErro(e) {
@@ -244,7 +244,7 @@ ApplicationCache.prototype.error = undefined;
* @event
* @description Sent when the update process finishes but the manifest file does not change.<br>
* @BB60+
- * @PB10
+ * @PB10+
* @RIPPLE
* @example
* function handleCacheEvent(e) {
@@ -259,7 +259,7 @@ ApplicationCache.prototype.noupdate = undefined;
* @event
* @description Sent when the update process begins downloading resources in the manifest file.<br>
* @BB60+
- * @PB10
+ * @PB10+
* @RIPPLE
* @example
* function handleCacheEvent(e) {
@@ -274,7 +274,7 @@ ApplicationCache.prototype.downloading = undefined;
* @event
* @description Sent when each resource in the manifest file begins to download.<br>
* @BB60+
- * @PB10
+ * @PB10+
* @RIPPLE
* @example
* function handleCacheEvent(e) {
@@ -290,7 +290,7 @@ ApplicationCache.prototype.progress = undefined;
* @description Sent when there is an existing application cache, the update process finishes,
* and there is a new application cache ready for use.<br>
* @BB60+
- * @PB10
+ * @PB10+
* @RIPPLE
* @example
* function handleCacheEvent(e) {
@@ -306,7 +306,7 @@ ApplicationCache.prototype.updateready = undefined;
* @description Sent when the resources listed in the manifest have been downloaded,
* and the application is now cached.<br>
* @BB60+
- * @PB10
+ * @PB10+
* @RIPPLE
* @example
* function handleCacheEvent(e) {
@@ -322,7 +322,7 @@ ApplicationCache.prototype.cached = undefined;
* @description Sent when the manifest was found to have become a 404 or 410 page,
* so the application cache is being deleted.<br>
* @BB60+
- * @PB10
+ * @PB10+
* @RIPPLE
* @example
* function handleCacheEvent(e) {
View
14 api/html5_canvas.js
@@ -22,7 +22,7 @@
* The canvas element has several methods for drawing paths, boxes, circles, characters, and adding images.
* Any text inside the between <strong>&#60canvas&#62</strong> tags will be displayed in browsers that do not support the canvas element.
* @BB60+
- * @PB10
+ * @PB10+
*/
canvas ={
@@ -38,7 +38,7 @@
* &#60canvas height="value"&#62
* @type pixels
* @BB60+
- * @PB10
+ * @PB10+
* @RIPPLE
* @example
* &#60canvas id="myCanvas" width="200" height="100"&#62&#60/canvas&#62
@@ -56,7 +56,7 @@
* &#60canvas width="value"&#62
* @type pixels
* @BB60+
- * @PB10
+ * @PB10+
* @RIPPLE
*/
width :,
@@ -64,12 +64,12 @@
/**
* @description Returns an object that exposes an API for drawing on the canvas.
* @param {String} contextId Specifies the desired API.<br>
- * List of defined contexts: 2d, webgl.
+ * List of defined contexts: 2d, experimental-webgl.
* @returns {Object} Returns an object for contextId.
* Returns null if the given context ID is not supported or if the canvas has already been initialised with some other (incompatible)
- * context type (e.g. trying to get a "2d" context after getting a "webgl" context).
+ * context type (e.g. trying to get a "2d" context after getting a "experimental-webgl" context).
* @BB60+
- * @PB10
+ * @PB10+
* @RIPPLE
* @example
* &#60script type="text/javascript"&#62
@@ -91,7 +91,7 @@
* given by type. The possible values are MIME types with no parameters, for example image/png, image/jpeg,
* or even maybe image/svg+xml if the implementation actually keeps enough information to reliably render an SVG image from the canvas.
* @BB60+
- * @PB10
+ * @PB10+
* @RIPPLE
* @example
* &#60script&#62
View
136 api/html5_canvas_context2d.js
@@ -26,7 +26,7 @@
* increasing when going down.
* @toc {User Interface} HTML5 2D Canvas Context
* @BB60+
-* @PB10
+* @PB10+
* @RIPPLE
*/
CanvasRenderingContext2D = { };
@@ -64,7 +64,7 @@ CanvasRenderingContext2D = { };
* &lt;canvas id=&quot;myCanvas&quot; width=&quot;300&quot; height=&quot;300&quot;&gt;&lt;/canvas&gt;
* &lt;/body&gt;
* &lt;/html&gt;
-* @PB10
+* @PB10+
* @BB60+
* @RIPPLE
*/
@@ -76,7 +76,7 @@ CanvasRenderingContext2D.documentConstructor = undefined;
* @type canvas
* @readOnly
* @BB60+
-* @PB10
+* @PB10+
* @RIPPLE
*/
CanvasRenderingContext2D.prototype.canvas = { };
@@ -84,7 +84,7 @@ CanvasRenderingContext2D.prototype.canvas = { };
/**
* Push a copy of the current drawing state onto the drawing state stack.
* @BB60+
-* @PB10
+* @PB10+
* @RIPPLE
*/
CanvasRenderingContext2D.prototype.save = function() { };
@@ -93,7 +93,7 @@ CanvasRenderingContext2D.prototype.save = function() { };
* Pop the top entry in the drawing state stack, and reset the drawing
* state it describes.
* @BB60+
-* @PB10
+* @PB10+
* @RIPPLE
*/
CanvasRenderingContext2D.prototype.restore = function() { };
@@ -106,7 +106,7 @@ CanvasRenderingContext2D.prototype.restore = function() { };
* @param {Number} x the amount to scale horizontally
* @param {Number} y the amount to scale vertically
* @BB60+
-* @PB10
+* @PB10+
* @RIPPLE
*/
CanvasRenderingContext2D.prototype.scale = function(x, y) { };
@@ -118,7 +118,7 @@ CanvasRenderingContext2D.prototype.scale = function(x, y) { };
* rotation angle expressed in radians.
* @param {Number} angle clockwise rotation angle expressed in radians
* @BB60+
-* @PB10
+* @PB10+
* @RIPPLE
*/
CanvasRenderingContext2D.prototype.rotate = function(angle) { };
@@ -132,7 +132,7 @@ CanvasRenderingContext2D.prototype.rotate = function(angle) { };
* @param {Number} x x-coord of the translation
* @param {Number} y y-coord of the translation
* @BB60+
-* @PB10
+* @PB10+
* @RIPPLE
*/
CanvasRenderingContext2D.prototype.translate = function(x, y) { };
@@ -153,7 +153,7 @@ CanvasRenderingContext2D.prototype.translate = function(x, y) { };
* @param {Number} dx Is the x-scalar of the transformation matrix
* @param {Number} dy Is the y-scalar of the transformation matrix
* @BB60+
-* @PB10
+* @PB10+
* @RIPPLE
*/
CanvasRenderingContext2D.prototype.transform = function(m11, m12, m21, m22, dx, dy) { };
@@ -169,7 +169,7 @@ CanvasRenderingContext2D.prototype.transform = function(m11, m12, m21, m22, dx,
* @param {Number} dx Is the x-scalar of the transformation matrix
* @param {Number} dy Is the y-scalar of the transformation matrix
* @BB60+
-* @PB10
+* @PB10+
* @RIPPLE
*/
CanvasRenderingContext2D.prototype.setTransform = function(m11, m12, m21, m22, dx, dy) { };
@@ -180,7 +180,7 @@ CanvasRenderingContext2D.prototype.setTransform = function(m11, m12, m21, m22, d
* from 0.0 to 1.0 are ignored.
* @type Number
* @BB60+
-* @PB10
+* @PB10+
* @RIPPLE
*/
CanvasRenderingContext2D.prototype.globalAlpha = 1.0;
@@ -247,7 +247,7 @@ CanvasRenderingContext2D.prototype.globalAlpha = 1.0;
* the value of globalCompositeOperation unaffected.
* @type String
* @BB60+
-* @PB10
+* @PB10+
* @RIPPLE
*/
CanvasRenderingContext2D.prototype.globalCompositeOperation = "source-over";
@@ -259,7 +259,7 @@ CanvasRenderingContext2D.prototype.globalCompositeOperation = "source-over";
* {@link CanvasGradient} or {@link CanvasPattern} object.
* @type Object
* @BB60+
-* @PB10
+* @PB10+
* @RIPPLE
*/
CanvasRenderingContext2D.prototype.strokeStyle = "black";
@@ -272,7 +272,7 @@ CanvasRenderingContext2D.prototype.strokeStyle = "black";
* Invalid values are ignored.
* @type Object
* @BB60+
-* @PB10
+* @PB10+
* @RIPPLE
*/
CanvasRenderingContext2D.prototype.fillStyle = "black"
@@ -291,7 +291,7 @@ CanvasRenderingContext2D.prototype.fillStyle = "black"
* @return {CanvasGradient} The created {@link CanvasGradient}
* @throws {NOT_SUPPORTED_ERR} If any of the arguments are not finite numbers.
* @BB60+
-* @PB10
+* @PB10+
* @RIPPLE
*/
CanvasRenderingContext2D.prototype.createLinearGradient = function(x0, y0, x1, y1) { };
@@ -310,7 +310,7 @@ CanvasRenderingContext2D.prototype.createLinearGradient = function(x0, y0, x1, y
* @throws {NOT_SUPPORTED_ERR} If any of the arguments are not finite numbers.
* @throws {INDEX_SIZE_ERR} If either of the radii are negative.
* @BB60+
-* @PB10
+* @PB10+
* @RIPPLE
*/
CanvasRenderingContext2D.prototype.createRadialGradient = function (x0, y0, r0, x1, y1, r1) { };
@@ -341,7 +341,7 @@ CanvasRenderingContext2D.prototype.createRadialGradient = function (x0, y0, r0,
* @throws {INVALID_STATE_ERR} If the image has no image data.
* @throws {SYNTAX_ERR} If the second argument isn't one of the allowed values.
* @BB60+
-* @PB10
+* @PB10+
* @RIPPLE
*/
CanvasRenderingContext2D.prototype.createPattern = function(image, repetition) { };
@@ -352,7 +352,7 @@ CanvasRenderingContext2D.prototype.createPattern = function(image, repetition) {
* Values that are not finite values greater than zero are ignored.
* @type Number
* @BB60+
-* @PB10
+* @PB10+
* @RIPPLE
*/
CanvasRenderingContext2D.prototype.lineWidth = 1; // (default 1)
@@ -365,7 +365,7 @@ CanvasRenderingContext2D.prototype.lineWidth = 1; // (default 1)
* Other values are ignored.<br/>
* @type String
* @BB60+
-* @PB10
+* @PB10+
* @RIPPLE
*/
CanvasRenderingContext2D.prototype.lineCap = "butt"; // "butt", "round", "square" (default "butt")
@@ -377,7 +377,7 @@ CanvasRenderingContext2D.prototype.lineCap = "butt"; // "butt", "round", "square
* Other values are ignored.
* @type String
* @BB60+
-* @PB10
+* @PB10+
* @RIPPLE
*/
CanvasRenderingContext2D.prototype.lineJoin = "miter"; // "miter", "round", "bevel" (default "miter")
@@ -388,7 +388,7 @@ CanvasRenderingContext2D.prototype.lineJoin = "miter"; // "miter", "round", "bev
* Values that are not finite values greater than zero are ignored.
* @type Number
* @BB60+
-* @PB10
+* @PB10+
* @RIPPLE
*/
CanvasRenderingContext2D.prototype.miterLimit = 10; // (default 10)
@@ -399,7 +399,7 @@ CanvasRenderingContext2D.prototype.miterLimit = 10; // (default 10)
* finite numbers are ignored.
* @type Number
* @BB60+
-* @PB10
+* @PB10+
* @RIPPLE
*/
CanvasRenderingContext2D.prototype.shadowOffsetX = 0; // (default 0)
@@ -410,7 +410,7 @@ CanvasRenderingContext2D.prototype.shadowOffsetX = 0; // (default 0)
* finite numbers are ignored.
* @type Number
* @BB60+
-* @PB10
+* @PB10+
* @RIPPLE
*/
CanvasRenderingContext2D.prototype.shadowOffsetY = 0; // (default 0)
@@ -423,7 +423,7 @@ CanvasRenderingContext2D.prototype.shadowOffsetY = 0; // (default 0)
* not affected by the current transformation matrix.
* @type Number
* @BB60+
-* @PB10
+* @PB10+
* @RIPPLE
*/
CanvasRenderingContext2D.prototype.shadowBlur = 0; // (default 0)
@@ -434,7 +434,7 @@ CanvasRenderingContext2D.prototype.shadowBlur = 0; // (default 0)
* parsed as CSS colors are ignored.
* @type String
* @BB60+
-* @PB10
+* @PB10+
* @RIPPLE
*/
CanvasRenderingContext2D.prototype.shadowColor = "transparent black"; // (default transparent black)
@@ -447,7 +447,7 @@ CanvasRenderingContext2D.prototype.shadowColor = "transparent black"; // (defaul
* @param {Number} w width of the rectangle
* @param {Number} h height of the rectangle
* @BB60+
-* @PB10
+* @PB10+
* @RIPPLE
*/
CanvasRenderingContext2D.prototype.clearRect = function(x, y, w, h) { };
@@ -460,7 +460,7 @@ CanvasRenderingContext2D.prototype.clearRect = function(x, y, w, h) { };
* @param {Number} w width of the rectangle
* @param {Number} h height of the rectangle
* @BB60+
-* @PB10
+* @PB10+
* @RIPPLE
*/
CanvasRenderingContext2D.prototype.fillRect = function(x, y, w, h) { };
@@ -473,7 +473,7 @@ CanvasRenderingContext2D.prototype.fillRect = function(x, y, w, h) { };
* @param {Number} w width of the rectangle
* @param {Number} h height of the rectangle
* @BB60+
-* @PB10
+* @PB10+
* @RIPPLE
*/
CanvasRenderingContext2D.prototype.strokeRect = function(x, y, w, h) { };
@@ -482,7 +482,7 @@ CanvasRenderingContext2D.prototype.strokeRect = function(x, y, w, h) { };
/**
* Resets the current path.
* @BB60+
-* @PB10
+* @PB10+
* @RIPPLE
*/
CanvasRenderingContext2D.prototype.beginPath = function() { };
@@ -491,7 +491,7 @@ CanvasRenderingContext2D.prototype.beginPath = function() { };
* Marks the current subpath as closed, and starts a new subpath with
* a point the same as the start and end of the newly closed subpath.
* @BB60+
-* @PB10
+* @PB10+
* @RIPPLE
*/
CanvasRenderingContext2D.prototype.closePath = function() { };
@@ -502,7 +502,7 @@ CanvasRenderingContext2D.prototype.closePath = function() { };
* @param {Number} x x-coord of the point to move to
* @param {Number} y y-coord of the point to move to
* @BB60+
-* @PB10
+* @PB10+
* @RIPPLE
*/
CanvasRenderingContext2D.prototype.moveTo = function(x, y) { };
@@ -513,7 +513,7 @@ CanvasRenderingContext2D.prototype.moveTo = function(x, y) { };
* @param {Number} x x-coord of the end point to draw a line to
* @param {Number} y y-coord of the end point to draw a line to
* @BB60+
-* @PB10
+* @PB10+
* @RIPPLE
*/
CanvasRenderingContext2D.prototype.lineTo = function(x, y) { };