github/cordova-plugin-camera
github/cordova-plugin-camera
3
0
Fork 0
mirror of https://github.com/apache/cordova-plugin-camera.git synced 2025-01-19 03:42:52 +08:00
Code Issues Packages Projects Releases Wiki Activity

fixed some bad formatting that hid HTML tags and added link to sample

Browse Source 
This closes #207
This commit is contained in:
Mikejo5001 2016-04-26 13:30:38 -07:00 committed by Raghav Katyal
parent 3586ea58a2
commit a831e15a91
2 changed files with 4 additions and 19 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

19
README.md
View File

@ -73,7 +73,7 @@ Documentation consists of template and API docs produced from the plugin JS code
--- ---
# API Reference # API Reference <a name="reference"></a>
* [camera](#module_camera) * [camera](#module_camera)
@ -98,10 +98,8 @@ Documentation consists of template and API docs produced from the plugin JS code
--- ---
<a name="module_camera"></a> <a name="module_camera"></a>
## camera ## camera
<a name="module_camera.getPicture"></a> <a name="module_camera.getPicture"></a>
### camera.getPicture(successCallback, errorCallback, options) ### camera.getPicture(successCallback, errorCallback, options)
Takes a photo using the camera, or retrieves a photo from the device's Takes a photo using the camera, or retrieves a photo from the device's
image gallery. The image is passed to the success callback as a image gallery. The image is passed to the success callback as a
@ -169,7 +167,6 @@ More examples [here](#camera-getPicture-examples). Quirks [here](#camera-getPict
navigator.camera.getPicture(cameraSuccess, cameraError, cameraOptions); navigator.camera.getPicture(cameraSuccess, cameraError, cameraOptions);
``` ```
<a name="module_camera.cleanup"></a> <a name="module_camera.cleanup"></a>
### camera.cleanup() ### camera.cleanup()
Removes intermediate image files that are kept in temporary storage Removes intermediate image files that are kept in temporary storage
after calling [`camera.getPicture`](#module_camera.getPicture). Applies only when the value of after calling [`camera.getPicture`](#module_camera.getPicture). Applies only when the value of
@ -194,7 +191,6 @@ function onFail(message) {
} }
``` ```
<a name="module_camera.onError"></a> <a name="module_camera.onError"></a>
### camera.onError : <code>function</code> ### camera.onError : <code>function</code>
Callback function that provides an error message. Callback function that provides an error message.
@ -205,7 +201,6 @@ Callback function that provides an error message.
| message | <code>string</code> | The message is provided by the device's native code. | | message | <code>string</code> | The message is provided by the device's native code. |
<a name="module_camera.onSuccess"></a> <a name="module_camera.onSuccess"></a>
### camera.onSuccess : <code>function</code> ### camera.onSuccess : <code>function</code>
Callback function that provides the image data. Callback function that provides the image data.
@ -225,7 +220,6 @@ function cameraCallback(imageData) {
} }
``` ```
<a name="module_camera.CameraOptions"></a> <a name="module_camera.CameraOptions"></a>
### camera.CameraOptions : <code>Object</code> ### camera.CameraOptions : <code>Object</code>
Optional parameters to customize the camera settings. Optional parameters to customize the camera settings.
* [Quirks](#CameraOptions-quirks) * [Quirks](#CameraOptions-quirks)
@ -251,10 +245,8 @@ Optional parameters to customize the camera settings.
--- ---
<a name="module_Camera"></a> <a name="module_Camera"></a>
## Camera ## Camera
<a name="module_Camera.DestinationType"></a> <a name="module_Camera.DestinationType"></a>
### Camera.DestinationType : <code>enum</code> ### Camera.DestinationType : <code>enum</code>
**Kind**: static enum property of <code>[Camera](#module_Camera)</code> **Kind**: static enum property of <code>[Camera](#module_Camera)</code>
**Properties** **Properties**
@ -266,7 +258,6 @@ Optional parameters to customize the camera settings.
| NATIVE_URI | <code>number</code> | <code>2</code> | Return native uri (eg. asset-library://... for iOS) | | NATIVE_URI | <code>number</code> | <code>2</code> | Return native uri (eg. asset-library://... for iOS) |
<a name="module_Camera.EncodingType"></a> <a name="module_Camera.EncodingType"></a>
### Camera.EncodingType : <code>enum</code> ### Camera.EncodingType : <code>enum</code>
**Kind**: static enum property of <code>[Camera](#module_Camera)</code> **Kind**: static enum property of <code>[Camera](#module_Camera)</code>
**Properties** **Properties**
@ -277,7 +268,6 @@ Optional parameters to customize the camera settings.
| PNG | <code>number</code> | <code>1</code> | Return PNG encoded image | | PNG | <code>number</code> | <code>1</code> | Return PNG encoded image |
<a name="module_Camera.MediaType"></a> <a name="module_Camera.MediaType"></a>
### Camera.MediaType : <code>enum</code> ### Camera.MediaType : <code>enum</code>
**Kind**: static enum property of <code>[Camera](#module_Camera)</code> **Kind**: static enum property of <code>[Camera](#module_Camera)</code>
**Properties** **Properties**
@ -289,7 +279,6 @@ Optional parameters to customize the camera settings.
| ALLMEDIA | <code>number</code> | <code>2</code> | Allow selection from all media types | | ALLMEDIA | <code>number</code> | <code>2</code> | Allow selection from all media types |
<a name="module_Camera.PictureSourceType"></a> <a name="module_Camera.PictureSourceType"></a>
### Camera.PictureSourceType : <code>enum</code> ### Camera.PictureSourceType : <code>enum</code>
**Kind**: static enum property of <code>[Camera](#module_Camera)</code> **Kind**: static enum property of <code>[Camera](#module_Camera)</code>
**Properties** **Properties**
@ -301,7 +290,6 @@ Optional parameters to customize the camera settings.
| SAVEDPHOTOALBUM | <code>number</code> | <code>2</code> | Choose image from picture library (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> <a name="module_Camera.PopoverArrowDirection"></a>
### Camera.PopoverArrowDirection : <code>enum</code> ### Camera.PopoverArrowDirection : <code>enum</code>
Matches iOS UIPopoverArrowDirection constants to specify arrow location on popover. Matches iOS UIPopoverArrowDirection constants to specify arrow location on popover.
@ -317,7 +305,6 @@ Matches iOS UIPopoverArrowDirection constants to specify arrow location on popov
| ARROW_ANY | <code>number</code> | <code>15</code> | | ARROW_ANY | <code>number</code> | <code>15</code> |
<a name="module_Camera.Direction"></a> <a name="module_Camera.Direction"></a>
### Camera.Direction : <code>enum</code> ### Camera.Direction : <code>enum</code>
**Kind**: static enum property of <code>[Camera](#module_Camera)</code> **Kind**: static enum property of <code>[Camera](#module_Camera)</code>
**Properties** **Properties**
@ -330,7 +317,6 @@ Matches iOS UIPopoverArrowDirection constants to specify arrow location on popov
--- ---
<a name="module_CameraPopoverOptions"></a> <a name="module_CameraPopoverOptions"></a>
## CameraPopoverOptions ## CameraPopoverOptions
iOS-only parameters that specify the anchor element location and arrow iOS-only parameters that specify the anchor element location and arrow
direction of the popover when selecting images from an iPad's library direction of the popover when selecting images from an iPad's library
@ -352,7 +338,6 @@ location.
--- ---
<a name="module_CameraPopoverHandle"></a> <a name="module_CameraPopoverHandle"></a>
## CameraPopoverHandle ## CameraPopoverHandle
A handle to an image picker popover. A handle to an image picker popover.
@ -618,7 +603,7 @@ function displayImage(imgUri) {
} }
``` ```
To display the image on some platforms, you might need to include the main part of the URI in the Content-Security-Policy <meta> element in index.html. For example, on Windows 10, you can include `ms-appdata:` in your <meta> element. Here is an example. To display the image on some platforms, you might need to include the main part of the URI in the Content-Security-Policy `<meta>` element in index.html. For example, on Windows 10, you can include `ms-appdata:` in your `<meta>` element. Here is an example.
```html ```html
<meta http-equiv="Content-Security-Policy" content="default-src 'self' data: gap: ms-appdata: https://ssl.gstatic.com 'unsafe-eval'; style-src 'self' 'unsafe-inline'; media-src *"> <meta http-equiv="Content-Security-Policy" content="default-src 'self' data: gap: ms-appdata: https://ssl.gstatic.com 'unsafe-eval'; style-src 'self' 'unsafe-inline'; media-src *">

4
jsdoc2md/TEMPLATE.md
View File

@ -15,7 +15,7 @@ the system's image library.
--- ---
# API Reference # API Reference <a name="reference"></a>
{{#orphans~}} {{#orphans~}}
{{>member-index}} {{>member-index}}
@ -274,7 +274,7 @@ function displayImage(imgUri) {
} }
``` ```
To display the image on some platforms, you might need to include the main part of the URI in the Content-Security-Policy <meta> element in index.html. For example, on Windows 10, you can include `ms-appdata:` in your <meta> element. Here is an example. To display the image on some platforms, you might need to include the main part of the URI in the Content-Security-Policy `<meta>` element in index.html. For example, on Windows 10, you can include `ms-appdata:` in your `<meta>` element. Here is an example.
```html ```html
<meta http-equiv="Content-Security-Policy" content="default-src 'self' data: gap: ms-appdata: https://ssl.gstatic.com 'unsafe-eval'; style-src 'self' 'unsafe-inline'; media-src *"> <meta http-equiv="Content-Security-Policy" content="default-src 'self' data: gap: ms-appdata: https://ssl.gstatic.com 'unsafe-eval'; style-src 'self' 'unsafe-inline'; media-src *">