Skip to content

Commit f11392f

Browse files
committed
Updating the blackberry.app docs for orientation fixes.
1 parent 0f7e8a2 commit f11392f

File tree

1 file changed

+5
-6
lines changed

1 file changed

+5
-6
lines changed

api/blackberry_app.js

Lines changed: 5 additions & 6 deletions
Original file line numberDiff line numberDiff line change
@@ -57,12 +57,11 @@ blackberry.app ={
5757

5858
/**
5959
* @description This function will lock the application's screen to the given orientation.
60-
* @param {String} orientation The orientation to lock the device to. If the device is currently not in this orientation, the application will rotate then lock.
61-
* @param {Boolean} [receiveRotateEvents] Optional parameter to allow rotation events to still occur while the screen is locked.
60+
* @param {String} orientation The orientation to lock the device to. If the device is currently not in this orientation, the application will rotate then lock.Orientation can be landscape-primary, landscape-secondary, portrait-primary, portrait-secondary.
6261
* @BB10X
6362
* @RIPPLE
6463
*/
65-
lockOrientation: function(orientation, receiveRotateEvents){},
64+
lockOrientation: function(orientation){},
6665

6766
/**
6867
* @description This function will unlock the screen rotating if it was previously locked.
@@ -72,8 +71,8 @@ blackberry.app ={
7271
unlockOrientation: function(){},
7372

7473
/**
75-
* @description This function will rotate the application.
76-
* @param {String} orientation The orientation to rotate the device to.
74+
* @description This function will rotate the application even if the application is locked.
75+
* @param {String} orientation The orientation to rotate the device to. Orientation can be landscape-primary, landscape-secondary, portrait-primary, portrait-secondary.
7776
* @BB10X
7877
* @RIPPLE
7978
*/
@@ -450,7 +449,7 @@ A banner indicator can have an optional numeric value that usually serves as a c
450449

451450
/**
452451
* @description The <b>orientationchange</b> event is triggered when the user changes the orientation of the device.
453-
* @callback {function} yourCallbackFunction The callback function that will be invoked on the orientationchange event
452+
* @callback {function} yourCallbackFunction The callback function that will be invoked on the orientationchange event. Orientation can be landscape-primary, landscape-secondary, portrait-primary, portrait-secondary.
454453
* @example
455454
* &lt;script type="text/javascript"&gt;
456455
*

0 commit comments

Comments
 (0)