CB-9070 Update CameraPopoverHandle docs to reflect README update

This commit is contained in:
Vladimir Kotikov 2016-08-23 16:14:11 +03:00
parent 6e19147b09
commit 7813ad9bef
3 changed files with 13 additions and 22 deletions

View File

@ -93,11 +93,9 @@ Documentation consists of template and API docs produced from the plugin JS code
* [.PictureSourceType](#module_Camera.PictureSourceType) : <code>enum</code>
* [.PopoverArrowDirection](#module_Camera.PopoverArrowDirection) : <code>enum</code>
* [.Direction](#module_Camera.Direction) : <code>enum</code>
* [CameraPopoverOptions](#module_CameraPopoverOptions)
* [CameraPopoverHandle](#module_CameraPopoverHandle)
* [.setPosition(options)](#module_CameraPopoverHandle.setPosition)
* [CameraPopoverOptions](#module_CameraPopoverOptions)
---
@ -305,9 +303,9 @@ change, cropping, etc.) due to implementation specific.
| Name | Type | Default | Description |
| --- | --- | --- | --- |
| PHOTOLIBRARY | <code>number</code> | <code>0</code> | Choose image from the device's photo library (same as SAVEDPHOTOALBUM for Android) |
| PHOTOLIBRARY | <code>number</code> | <code>0</code> | Choose image from picture library (same as SAVEDPHOTOALBUM for Android) |
| CAMERA | <code>number</code> | <code>1</code> | Take picture from camera |
| SAVEDPHOTOALBUM | <code>number</code> | <code>2</code> | Choose image only from the device's Camera Roll album (same as PHOTOLIBRARY for Android) |
| SAVEDPHOTOALBUM | <code>number</code> | <code>2</code> | Choose image from picture library (same as PHOTOLIBRARY for Android) |
<a name="module_Camera.PopoverArrowDirection"></a>
@ -363,17 +361,7 @@ location.
<a name="module_CameraPopoverHandle"></a>
## CameraPopoverHandle
A handle to the image picker popover.
<a name="module_CameraPopoverHandle.setPosition"></a>
### CameraPopoverHandle.setPosition(options)
Can be used to reposition the image selection dialog, for example, when the device orientation changes.
| Param | Type | Description |
| --- | --- | --- |
| options | <code>[CameraPopoverOptions](#module_CameraPopoverOptions)</code> | CameraPopoverOptions |
A handle to an image picker popover.
__Supported Platforms__

View File

@ -89,10 +89,7 @@ for (var key in Camera) {
*
* If `Camera.sourceType` is `Camera.PictureSourceType.PHOTOLIBRARY` or
* `Camera.PictureSourceType.SAVEDPHOTOALBUM`, then a dialog displays
* that allows users to select an existing image. The
* `camera.getPicture` function returns a [`CameraPopoverHandle`]{@link module:CameraPopoverHandle} object,
* which can be used to reposition the image selection dialog, for
* example, when the device orientation changes.
* that allows users to select an existing image.
*
* The return value is sent to the [`cameraSuccess`]{@link module:camera.onSuccess} callback function, in
* one of the following formats, depending on the specified

View File

@ -33,7 +33,7 @@ var exec = require('cordova/exec');
* - iOS
*
* @example
* var cameraPopoverHandle = navigator.camera.getPicture(onSuccess, onFail,
* navigator.camera.getPicture(onSuccess, onFail,
* {
* destinationType: Camera.DestinationType.FILE_URI,
* sourceType: Camera.PictureSourceType.PHOTOLIBRARY,
@ -42,13 +42,19 @@ var exec = require('cordova/exec');
*
* // Reposition the popover if the orientation changes.
* window.onorientationchange = function() {
* var cameraPopoverHandle = new CameraPopoverHandle();
* var cameraPopoverOptions = new CameraPopoverOptions(0, 0, 100, 100, Camera.PopoverArrowDirection.ARROW_ANY);
* cameraPopoverHandle.setPosition(cameraPopoverOptions);
* }
* @module CameraPopoverHandle
*/
var CameraPopoverHandle = function() {
/** Set the position of the popover.
/**
* Can be used to reposition the image selection dialog,
* for example, when the device orientation changes.
* @memberof CameraPopoverHandle
* @instance
* @method setPosition
* @param {module:CameraPopoverOptions} popoverOptions
*/
this.setPosition = function(popoverOptions) {