Updated Branches: refs/heads/master 357c3a35b -> c9c4c0643
[CB-4379 CB-3818] specify CLI interface to API features Project: http://git-wip-us.apache.org/repos/asf/cordova-docs/repo Commit: http://git-wip-us.apache.org/repos/asf/cordova-docs/commit/857cf3df Tree: http://git-wip-us.apache.org/repos/asf/cordova-docs/tree/857cf3df Diff: http://git-wip-us.apache.org/repos/asf/cordova-docs/diff/857cf3df Branch: refs/heads/master Commit: 857cf3df12f5206464c50253d5419f66f3861986 Parents: 357c3a3 Author: Mike Sierra <[email protected]> Authored: Fri Jul 26 13:39:19 2013 -0400 Committer: Michael Brooks <[email protected]> Committed: Mon Jul 29 11:31:43 2013 -0700 ---------------------------------------------------------------------- .../edge/cordova/accelerometer/accelerometer.md | 38 +++++++++-------- docs/en/edge/cordova/camera/camera.md | 42 ++++++++++--------- docs/en/edge/cordova/compass/compass.md | 34 +++++++++------- docs/en/edge/cordova/connection/connection.md | 39 ++++++++++-------- docs/en/edge/cordova/contacts/contacts.md | 37 +++++++++-------- docs/en/edge/cordova/device/device.md | 41 ++++++++++--------- docs/en/edge/cordova/events/events.md | 33 ++++++--------- docs/en/edge/cordova/file/file.md | 36 ++++++++-------- docs/en/edge/cordova/geolocation/geolocation.md | 41 ++++++++++--------- .../edge/cordova/globalization/globalization.md | 16 ++++++-- .../edge/cordova/inappbrowser/inappbrowser.md | 26 +++++++----- docs/en/edge/cordova/media/capture/capture.md | 37 +++++++++-------- docs/en/edge/cordova/media/media.md | 37 +++++++++-------- .../edge/cordova/notification/notification.md | 43 ++++++++++++-------- .../edge/cordova/splashscreen/splashscreen.md | 21 ++++++---- docs/en/edge/cordova/storage/storage.md | 25 +++++------- 16 files changed, 299 insertions(+), 247 deletions(-) ---------------------------------------------------------------------- http://git-wip-us.apache.org/repos/asf/cordova-docs/blob/857cf3df/docs/en/edge/cordova/accelerometer/accelerometer.md ---------------------------------------------------------------------- diff --git a/docs/en/edge/cordova/accelerometer/accelerometer.md b/docs/en/edge/cordova/accelerometer/accelerometer.md index 31d6012..f23abc2 100644 --- a/docs/en/edge/cordova/accelerometer/accelerometer.md +++ b/docs/en/edge/cordova/accelerometer/accelerometer.md @@ -41,42 +41,46 @@ Objects (Read-Only) - Acceleration -Permissions ------------ +## Accessing the Feature -### Android +As of version 3.0, Cordova implements device-level APIs as _plugins_. +Use the CLI's `plugin` command, described in The Command-line +Interface, to add or remove this feature for a project: -#### app/res/xml/config.xml + $ cordova plugin add https://git-wip-us.apache.org/repos/asf/cordova-plugin-device-motion.git + $ cordova plugin rm org.apache.cordova.core.device-motion - <plugin name="Accelerometer" value="org.apache.cordova.AccelListener" /> +These commands apply to all targeted platforms, but modify the +platform-specific configuration settings described below: -### BlackBerry WebWorks +* Android -#### www/plugins.xml + # app/res/xml/config.xml + <plugin name="Accelerometer" value="org.apache.cordova.AccelListener" /> - <plugin name="Accelerometer" value="org.apache.cordova.accelerometer.Accelerometer" /> +* BlackBerry WebWorks -#### www/config.xml + # www/plugins.xml + <plugin name="Accelerometer" value="org.apache.cordova.accelerometer.Accelerometer" /> + # www/config.xml <feature id="blackberry.system" required="true" version="1.0.0.0" /> <feature id="org.apache.cordova" required="true" version="1.0.0" /> -### iOS - -#### config.xml +* iOS + # config.xml <plugin name="Accelerometer" value="CDVAccelerometer" /> -### Windows Phone - -#### Properties/WPAppManifest.xml +* Windows Phone + # Properties/WPAppManifest.xml <Capabilities> <Capability Name="ID_CAP_SENSORS" /> </Capabilities> Reference: [Application Manifest for Windows Phone](http://msdn.microsoft.com/en-us/library/ff769509%28v=vs.92%29.aspx) -### Tizen +* Tizen - No permissions are required. + No special permissions are required. http://git-wip-us.apache.org/repos/asf/cordova-docs/blob/857cf3df/docs/en/edge/cordova/camera/camera.md ---------------------------------------------------------------------- diff --git a/docs/en/edge/cordova/camera/camera.md b/docs/en/edge/cordova/camera/camera.md index 9b100e4..9eea801 100644 --- a/docs/en/edge/cordova/camera/camera.md +++ b/docs/en/edge/cordova/camera/camera.md @@ -30,43 +30,46 @@ Methods - camera.getPicture - camera.cleanup -Permissions ------------ +## Accessing the Feature -### Android +As of version 3.0, Cordova implements device-level APIs as _plugins_. +Use the CLI's `plugin` command, described in The Command-line +Interface, to add or remove this feature for a project: -#### app/res/xml/config.xml + $ cordova plugin add https://git-wip-us.apache.org/repos/asf/cordova-plugin-camera.git + $ cordova plugin rm org.apache.cordova.core.camera - <plugin name="Camera" value="org.apache.cordova.CameraLauncher" /> +These commands apply to all targeted platforms, but modify the +platform-specific configuration settings described below: -#### app/AndroidManifest +* Android - <uses-permission android:name="android.permission.WRITE_EXTERNAL_STORAGE" /> + # app/res/xml/config.xml + <plugin name="Camera" value="org.apache.cordova.CameraLauncher" /> -### BlackBerry WebWorks + # app/AndroidManifest + <uses-permission android:name="android.permission.WRITE_EXTERNAL_STORAGE" /> -#### www/plugins.xml +* BlackBerry WebWorks + # www/plugins.xml <plugin name="Camera" value="org.apache.cordova.camera.Camera" /> -#### www/config.xml - + # www/config.xml <feature id="blackberry.media.camera" /> <rim:permissions> <rim:permit>use_camera</rim:permit> </rim:permissions> -### iOS - -#### config.xml +* iOS + # config.xml <plugin name="Camera" value="CDVCamera" /> -### Windows Phone - -#### Properties/WPAppManifest.xml +* Windows Phone + # Properties/WPAppManifest.xml <Capabilities> <Capability Name="ID_CAP_ISV_CAMERA" /> <Capability Name="ID_HW_FRONTCAMERA" /> @@ -74,10 +77,9 @@ Permissions Reference: [Application Manifest for Windows Phone](http://msdn.microsoft.com/en-us/library/ff769509%28v=vs.92%29.aspx) -### Tizen - -#### config.xml +* Tizen + # config.xml <feature name="http://tizen.org/api/application"; required="true"/> <feature name="http://tizen.org/api/application.launch"; required="true"/> http://git-wip-us.apache.org/repos/asf/cordova-docs/blob/857cf3df/docs/en/edge/cordova/compass/compass.md ---------------------------------------------------------------------- diff --git a/docs/en/edge/cordova/compass/compass.md b/docs/en/edge/cordova/compass/compass.md index 43ca2bc..31ef597 100755 --- a/docs/en/edge/cordova/compass/compass.md +++ b/docs/en/edge/cordova/compass/compass.md @@ -39,35 +39,41 @@ Arguments - compassOptions - compassHeading -Permissions ------------ +## Accessing the Feature -### Android +As of version 3.0, Cordova implements device-level APIs as _plugins_. +Use the CLI's `plugin` command, described in The Command-line +Interface, to add or remove this feature for a project: -#### app/res/xml/config.xml + $ cordova plugin add https://git-wip-us.apache.org/repos/asf/cordova-plugin-device-orientation.git + $ cordova plugin rm org.apache.cordova.core.device-orientation - <plugin name="Compass" value="org.apache.cordova.CompassListener" /> +These commands apply to all targeted platforms, but modify the +platform-specific configuration settings described below: + +* Android -### BlackBerry WebWorks + # app/res/xml/config.xml + <plugin name="Compass" value="org.apache.cordova.CompassListener" /> - No permissions are required. +* BlackBerry WebWorks -### iOS + No special permissions are required. -#### config.xml +* iOS + # config.xml <plugin name="Compass" value="CDVLocation" /> -### Windows Phone - -#### Properties/WPAppManifest.xml +* Windows Phone + # Properties/WPAppManifest.xml <Capabilities> <Capability Name="ID_CAP_SENSORS" /> </Capabilities> Reference: [Application Manifest for Windows Phone](http://msdn.microsoft.com/en-us/library/ff769509%28v=vs.92%29.aspx) -### Tizen +* Tizen - No permissions are required. + No special permissions are required. http://git-wip-us.apache.org/repos/asf/cordova-docs/blob/857cf3df/docs/en/edge/cordova/connection/connection.md ---------------------------------------------------------------------- diff --git a/docs/en/edge/cordova/connection/connection.md b/docs/en/edge/cordova/connection/connection.md index 8831dcf..0e5ed1d 100644 --- a/docs/en/edge/cordova/connection/connection.md +++ b/docs/en/edge/cordova/connection/connection.md @@ -39,47 +39,50 @@ Constants - Connection.CELL - Connection.NONE -Permissions ------------ +## Accessing the Feature -### Android +As of version 3.0, Cordova implements device-level APIs as _plugins_. +Use the CLI's `plugin` command, described in The Command-line +Interface, to add or remove this feature for a project: -#### app/res/xml/config.xml + $ cordova plugin add https://git-wip-us.apache.org/repos/asf/cordova-plugin-network-information.git + $ cordova plugin rm org.apache.cordova.core.network-information - <plugin name="NetworkStatus" value="org.apache.cordova.NetworkManager" /> +These commands apply to all targeted platforms, but modify the +platform-specific configuration settings described below: + +* Android -#### app/AndroidManifest.xml + # app/res/xml/config.xml + <plugin name="NetworkStatus" value="org.apache.cordova.NetworkManager" /> + # app/AndroidManifest.xml <uses-permission android:name="android.permission.INTERNET" /> <uses-permission android:name="android.permission.ACCESS_NETWORK_STATE" /> <uses-permission android:name="android.permission.READ_PHONE_STATE" /> -### BlackBerry WebWorks - -#### www/plugins.xml +* BlackBerry WebWorks + # www/plugins.xml <plugin name="Network Status" value="org.apache.cordova.network.Network" /> -### iOS - -#### config.xml +* iOS + # config.xml <plugin name="NetworkStatus" value="CDVConnection" /> -### Windows Phone - -#### Properties/WPAppManifest.xml +* Windows Phone + # Properties/WPAppManifest.xml <Capabilities> <Capability Name="ID_CAP_NETWORKING" /> </Capabilities> Reference: [Application Manifest for Windows Phone](http://msdn.microsoft.com/en-us/library/ff769509%28v=vs.92%29.aspx) -### Tizen - -#### config.xml +* Tizen + # config.xml <feature name="http://tizen.org/api/systeminfo"; required="true"/> Reference: [Application Manifest for Tizen Web Application](https://developer.tizen.org/help/topic/org.tizen.help.gs/Creating%20a%20Project.html?path=0_1_1_3#8814682_CreatingaProject-EditingconfigxmlFeatures) http://git-wip-us.apache.org/repos/asf/cordova-docs/blob/857cf3df/docs/en/edge/cordova/contacts/contacts.md ---------------------------------------------------------------------- diff --git a/docs/en/edge/cordova/contacts/contacts.md b/docs/en/edge/cordova/contacts/contacts.md index ec50fd7..ad8c7f8 100644 --- a/docs/en/edge/cordova/contacts/contacts.md +++ b/docs/en/edge/cordova/contacts/contacts.md @@ -49,44 +49,47 @@ Objects - ContactFindOptions - ContactError -Permissions ------------ +## Accessing the Feature -### Android +As of version 3.0, Cordova implements device-level APIs as _plugins_. +Use the CLI's `plugin` command, described in The Command-line +Interface, to add or remove this feature for a project: -#### app/res/xml/config.xml + $ cordova plugin add https://git-wip-us.apache.org/repos/asf/cordova-plugin-contacts.git + $ cordova plugin rm org.apache.cordova.core.contacts - <plugin name="Contacts" value="org.apache.cordova.ContactManager" /> +These commands apply to all targeted platforms, but modify the +platform-specific configuration settings described below: + +* Android -#### app/AndroidManifest.xml + # app/res/xml/config.xml + <plugin name="Contacts" value="org.apache.cordova.ContactManager" /> + # app/AndroidManifest.xml <uses-permission android:name="android.permission.GET_ACCOUNTS" /> <uses-permission android:name="android.permission.READ_CONTACTS" /> <uses-permission android:name="android.permission.WRITE_CONTACTS" /> -### BlackBerry WebWorks - -#### www/plugins.xml +* BlackBerry WebWorks + # www/plugins.xml <plugin name="Contact" value="org.apache.cordova.pim.Contact" /> -#### www/config.xml - + # www/config.xml <feature id="blackberry.find" required="true" version="1.0.0.0" /> <feature id="blackberry.identity" required="true" version="1.0.0.0" /> <feature id="blackberry.pim.Address" required="true" version="1.0.0.0" /> <feature id="blackberry.pim.Contact" required="true" version="1.0.0.0" /> -### iOS - -#### config.xml +* iOS + # config.xml <plugin name="Contacts" value="CDVContacts" /> -### Windows Phone - -#### Properties/WPAppManifest.xml +* Windows Phone + # Properties/WPAppManifest.xml <Capabilities> <Capability Name="ID_CAP_CONTACTS" /> </Capabilities> http://git-wip-us.apache.org/repos/asf/cordova-docs/blob/857cf3df/docs/en/edge/cordova/device/device.md ---------------------------------------------------------------------- diff --git a/docs/en/edge/cordova/device/device.md b/docs/en/edge/cordova/device/device.md index 38abb0c..ffbfaef 100644 --- a/docs/en/edge/cordova/device/device.md +++ b/docs/en/edge/cordova/device/device.md @@ -41,40 +41,44 @@ Since `device` is assigned to the `window` object, it is implicitly in the globa var phoneName = window.device.name; var phoneName = device.name; -Permissions ------------ +## Accessing the Feature -### Android +As of version 3.0, Cordova implements device-level APIs as _plugins_. +Use the CLI's `plugin` command, described in The Command-line +Interface, to add or remove this feature for a project: -#### app/res/xml/config.xml + $ cordova plugin add https://git-wip-us.apache.org/repos/asf/cordova-plugin-device.git + $ cordova plugin rm org.apache.cordova.core.device - <plugin name="Device" value="org.apache.cordova.Device" /> +These commands apply to all targeted platforms, but modify the +platform-specific configuration settings described below: -#### app/AndroidManifest.xml +* Android - <uses-permission android:name="android.permission.READ_PHONE_STATE" /> + # app/res/xml/config.xml + <plugin name="Device" value="org.apache.cordova.Device" /> -### BlackBerry WebWorks + # app/AndroidManifest.xml + <uses-permission android:name="android.permission.READ_PHONE_STATE" /> -#### www/plugins.xml +* BlackBerry WebWorks + # www/plugins.xml <plugin name="Device" value="org.apache.cordova.device.Device" /> -#### www/config.xml - + # www/config.xml <feature id="blackberry.app" required="true" version="1.0.0.0" /> <rim:permissions> <rim:permit>read_device_identifying_information</rim:permit> </rim:permissions> -### iOS - - No permissions are required. +* iOS -### Windows Phone + No special permissions are required. -#### Properties/WPAppManifest.xml +* Windows Phone + # Properties/WPAppManifest.xml <Capabilities> <Capability Name="ID_CAP_WEBBROWSERCOMPONENT" /> <Capability Name="ID_CAP_IDENTITY_DEVICE" /> @@ -83,10 +87,9 @@ Permissions Reference: [Application Manifest for Windows Phone](http://msdn.microsoft.com/en-us/library/ff769509%28v=vs.92%29.aspx) -### Tizen - -#### config.xml +* Tizen + # config.xml <feature name="http://tizen.org/api/systeminfo"; required="true"/> Reference: [Application Manifest for Tizen Web Application](https://developer.tizen.org/help/topic/org.tizen.help.gs/Creating%20a%20Project.html?path=0_1_1_3#8814682_CreatingaProject-EditingconfigxmlFeatures) http://git-wip-us.apache.org/repos/asf/cordova-docs/blob/857cf3df/docs/en/edge/cordova/events/events.md ---------------------------------------------------------------------- diff --git a/docs/en/edge/cordova/events/events.md b/docs/en/edge/cordova/events/events.md index bdecd16..8e471f3 100644 --- a/docs/en/edge/cordova/events/events.md +++ b/docs/en/edge/cordova/events/events.md @@ -41,45 +41,38 @@ Event Types - volumedownbutton - volumeupbutton -Permissions ------------ - -### Android +## Accessing the Feature -#### app/res/xml/config.xml +* Android + # app/res/xml/config.xml <plugin name="Battery" value="org.apache.cordova.BatteryListener" /> -#### app/AndroidManifest.xml - + # app/AndroidManifest.xml <uses-permission android:name="android.permission.BROADCAST_STICKY" /> -### BlackBerry WebWorks - -#### www/plugins.xml +* BlackBerry WebWorks + # www/plugins.xml <plugin name="Battery" value="org.apache.cordova.battery.Battery" /> -#### www/config.xml - + # www/config.xml <feature id="blackberry.app" required="true" version="1.0.0.0" /> <feature id="blackberry.app.event" required="true" version="1.0.0.0" /> <feature id="blackberry.system.event" required="true" version="1.0.0.0" /> -### iOS - -#### config.xml +* iOS + # config.xml <plugin name="Battery" value="CDVBattery" /> -### Windows Phone - - No permissions are required. +* Windows Phone -### Tizen + No special permissions are required. -#### config.xml +* Tizen + # config.xml <feature name="http://tizen.org/api/systeminfo"; required="true"/> Reference: [Application Manifest for Tizen Web Application](https://developer.tizen.org/help/topic/org.tizen.help.gs/Creating%20a%20Project.html?path=0_1_1_3#8814682_CreatingaProject-EditingconfigxmlFeatures) http://git-wip-us.apache.org/repos/asf/cordova-docs/blob/857cf3df/docs/en/edge/cordova/file/file.md ---------------------------------------------------------------------- diff --git a/docs/en/edge/cordova/file/file.md b/docs/en/edge/cordova/file/file.md index 52c24ba..c70c6f9 100644 --- a/docs/en/edge/cordova/file/file.md +++ b/docs/en/edge/cordova/file/file.md @@ -41,29 +41,34 @@ Objects - LocalFileSystem - Metadata -Permissions ------------ +## Accessing the Feature -### Android +As of version 3.0, Cordova implements device-level APIs as _plugins_. +Use the CLI's `plugin` command, described in The Command-line +Interface, to add or remove this feature for a project: -#### app/res/xml/config.xml + $ cordova plugin add https://git-wip-us.apache.org/repos/asf/cordova-plugin-file.git + $ cordova plugin rm org.apache.cordova.core.file +These commands apply to all targeted platforms, but modify the +platform-specific configuration settings described below: + +* Android + + # app/res/xml/config.xml <plugin name="File" value="org.apache.cordova.FileUtils" /> <plugin name="FileTransfer" value="org.apache.cordova.FileTransfer" /> -#### app/AndroidManifest.xml - + # app/AndroidManifest.xml <uses-permission android:name="android.permission.WRITE_EXTERNAL_STORAGE" /> -### BlackBerry WebWorks - -#### www/plugins.xml +* BlackBerry WebWorks + # www/plugins.xml <plugin name="File" value="org.apache.cordova.file.FileManager" /> <plugin name="FileTransfer" value="org.apache.cordova.http.FileTransfer" /> -#### www/config.xml - + # www/config.xml <feature id="blackberry.io.file" required="true" version="1.0.0.0" /> <feature id="blackberry.utils" required="true" version="1.0.0.0" /> <feature id="blackberry.io.dir" required="true" version="1.0.0.0" /> @@ -71,13 +76,12 @@ Permissions <rim:permit>access_shared</rim:permit> </rim:permissions> -### iOS - -#### config.xml +* iOS + # config.xml <plugin name="File" value="CDVFile" /> <plugin name="FileTransfer" value="CDVFileTransfer" /> -### Windows Phone +* Windows Phone - No permissions are required. + No special permissions are required. http://git-wip-us.apache.org/repos/asf/cordova-docs/blob/857cf3df/docs/en/edge/cordova/geolocation/geolocation.md ---------------------------------------------------------------------- diff --git a/docs/en/edge/cordova/geolocation/geolocation.md b/docs/en/edge/cordova/geolocation/geolocation.md index f2444c5..1338479 100644 --- a/docs/en/edge/cordova/geolocation/geolocation.md +++ b/docs/en/edge/cordova/geolocation/geolocation.md @@ -56,49 +56,52 @@ Objects (Read-Only) - PositionError - Coordinates -Permissions ------------ +## Accessing the Feature -### Android +As of version 3.0, Cordova implements device-level APIs as _plugins_. +Use the CLI's `plugin` command, described in The Command-line +Interface, to add or remove this feature for a project: -#### app/res/xml/config.xml + $ cordova plugin add https://git-wip-us.apache.org/repos/asf/cordova-plugin-geolocation.git + $ cordova plugin rm org.apache.cordova.core.geolocation - <plugin name="Geolocation" value="org.apache.cordova.GeoBroker" /> +These commands apply to all targeted platforms, but modify the +platform-specific configuration settings described below: + +* Android -#### app/AndroidManifest.xml + # app/res/xml/config.xml + <plugin name="Geolocation" value="org.apache.cordova.GeoBroker" /> + # app/AndroidManifest.xml <uses-permission android:name="android.permission.ACCESS_COARSE_LOCATION" /> <uses-permission android:name="android.permission.ACCESS_FINE_LOCATION" /> <uses-permission android:name="android.permission.ACCESS_LOCATION_EXTRA_COMMANDS" /> -### BlackBerry WebWorks - -#### www/plugins.xml +* BlackBerry WebWorks + # www/plugins.xml <plugin name="Geolocation" value="org.apache.cordova.geolocation.Geolocation" /> -#### www/config.xml - + # www/config.xml <rim:permissions> <rim:permit>read_geolocation</rim:permit> </rim:permissions> -### iOS - -#### config.xml +* iOS + # config.xml <plugin name="Geolocation" value="CDVLocation" /> -### Windows Phone - -#### Properties/WPAppManifest.xml +* Windows Phone + # Properties/WPAppManifest.xml <Capabilities> <Capability Name="ID_CAP_LOCATION" /> </Capabilities> Reference: [Application Manifest for Windows Phone](http://msdn.microsoft.com/en-us/library/ff769509%28v=vs.92%29.aspx) -### Tizen +* Tizen - No permissions are required. + No special permissions are required. http://git-wip-us.apache.org/repos/asf/cordova-docs/blob/857cf3df/docs/en/edge/cordova/globalization/globalization.md ---------------------------------------------------------------------- diff --git a/docs/en/edge/cordova/globalization/globalization.md b/docs/en/edge/cordova/globalization/globalization.md index b473ec9..813244c 100644 --- a/docs/en/edge/cordova/globalization/globalization.md +++ b/docs/en/edge/cordova/globalization/globalization.md @@ -53,11 +53,19 @@ therefore has global scope. // The global globalization object var globalization = navigator.globalization; -Permissions ------------ +## Accessing the Feature -### Android +As of version 3.0, Cordova implements device-level APIs as _plugins_. +Use the CLI's `plugin` command, described in The Command-line +Interface, to add or remove this feature for a project: -#### app/res/xml/config.xml + $ cordova plugin add https://git-wip-us.apache.org/repos/asf/cordova-plugin-globalization.git + $ cordova plugin rm org.apache.cordova.core.globalization +These commands apply to all targeted platforms, but modify the +platform-specific configuration settings described below: + +* Android + + # app/res/xml/config.xml <plugin name="Globalization" value="org.apache.cordova.Globalization" /> http://git-wip-us.apache.org/repos/asf/cordova-docs/blob/857cf3df/docs/en/edge/cordova/inappbrowser/inappbrowser.md ---------------------------------------------------------------------- diff --git a/docs/en/edge/cordova/inappbrowser/inappbrowser.md b/docs/en/edge/cordova/inappbrowser/inappbrowser.md index 3c6b5f8..f47ac94 100644 --- a/docs/en/edge/cordova/inappbrowser/inappbrowser.md +++ b/docs/en/edge/cordova/inappbrowser/inappbrowser.md @@ -39,25 +39,31 @@ Methods - executeScript - insertCSS -Permissions ------------ +## Accessing the Feature -### Android +As of version 3.0, Cordova implements device-level APIs as _plugins_. +Use the CLI's `plugin` command, described in The Command-line +Interface, to add or remove this feature for a project: -#### app/res/xml/config.xml + $ cordova plugin add https://git-wip-us.apache.org/repos/asf/cordova-plugin-inappbrowser.git + $ cordova plugin rm org.apache.cordova.core.inappbrowser - <plugin name="InAppBrowser" value="org.apache.cordova.InAppBrowser" /> +These commands apply to all targeted platforms, but modify the +platform-specific configuration settings described below: -### iOS +* Android -#### config.xml + # app/res/xml/config.xml + <plugin name="InAppBrowser" value="org.apache.cordova.InAppBrowser" /> - <plugin name="InAppBrowser" value="CDVInAppBrowser" /> +* iOS -### Windows Phone 7 + 8 + # config.xml + <plugin name="InAppBrowser" value="CDVInAppBrowser" /> -#### config.xml +* Windows Phone 7 + 8 + # config.xml <plugin name="InAppBrowser" /> addEventListener http://git-wip-us.apache.org/repos/asf/cordova-docs/blob/857cf3df/docs/en/edge/cordova/media/capture/capture.md ---------------------------------------------------------------------- diff --git a/docs/en/edge/cordova/media/capture/capture.md b/docs/en/edge/cordova/media/capture/capture.md index ca184bb..1637ee3 100644 --- a/docs/en/edge/cordova/media/capture/capture.md +++ b/docs/en/edge/cordova/media/capture/capture.md @@ -77,41 +77,44 @@ Supported Platforms - Windows Phone 7 and 8 - Windows 8 -Permissions ------------ +## Accessing the Feature -### Android +As of version 3.0, Cordova implements device-level APIs as _plugins_. +Use the CLI's `plugin` command, described in The Command-line +Interface, to add or remove this feature for a project: -#### app/res/xml/plugins.xml + $ cordova plugin add https://git-wip-us.apache.org/repos/asf/cordova-plugin-media-capture.git + $ cordova plugin rm org.apache.cordova.core.media-capture - <plugin name="Capture" value="org.apache.cordova.Capture"/> +These commands apply to all targeted platforms, but modify the +platform-specific configuration settings described below: + +* Android -#### app/AndroidManifest.xml + # app/res/xml/plugins.xml + <plugin name="Capture" value="org.apache.cordova.Capture"/> + # app/AndroidManifest.xml <uses-permission android:name="android.permission.RECORD_AUDIO" /> <uses-permission android:name="android.permission.WRITE_EXTERNAL_STORAGE" /> -### BlackBerry WebWorks - -#### www/plugins.xml +* BlackBerry WebWorks + # www/plugins.xml <plugin name="Capture" value="org.apache.cordova.capture.MediaCapture" /> -#### www/config.xml - + # www/config.xml <feature id="blackberry.system" required="true" version="1.0.0.0" /> <feature id="blackberry.io.file" required="true" version="1.0.0.0" /> -### iOS - -#### config.xml +* iOS + # config.xml <plugin name="Capture" value="CDVCapture" /> -### Windows Phone - -#### Properties/WPAppManifest.xml +* Windows Phone + # Properties/WPAppManifest.xml <Capabilities> <Capability Name="ID_CAP_MEDIALIB" /> <Capability Name="ID_CAP_MICROPHONE" /> http://git-wip-us.apache.org/repos/asf/cordova-docs/blob/857cf3df/docs/en/edge/cordova/media/media.md ---------------------------------------------------------------------- diff --git a/docs/en/edge/cordova/media/media.md b/docs/en/edge/cordova/media/media.md index 2f9e49e..ce76c53 100644 --- a/docs/en/edge/cordova/media/media.md +++ b/docs/en/edge/cordova/media/media.md @@ -80,37 +80,40 @@ Supported Platforms - Tizen - Windows 8 -Permissions ------------ +## Accessing the Feature -### Android +As of version 3.0, Cordova implements device-level APIs as _plugins_. +Use the CLI's `plugin` command, described in The Command-line +Interface, to add or remove this feature for a project: -#### app/res/xml/config.xml + $ cordova plugin add https://git-wip-us.apache.org/repos/asf/cordova-plugin-media.git - <plugin name="Media" value="org.apache.cordova.AudioHandler" /> +These commands apply to all targeted platforms, but modify the +platform-specific configuration settings described below: + +* Android -#### app/AndroidManifest.xml + # app/res/xml/config.xml + <plugin name="Media" value="org.apache.cordova.AudioHandler" /> + # app/AndroidManifest.xml <uses-permission android:name="android.permission.RECORD_AUDIO" /> <uses-permission android:name="android.permission.MODIFY_AUDIO_SETTINGS" /> <uses-permission android:name="android.permission.WRITE_EXTERNAL_STORAGE" /> -### BlackBerry WebWorks - -#### www/plugins.xml +* BlackBerry WebWorks + # www/plugins.xml <plugin name="Capture" value="org.apache.cordova.media.MediaCapture" /> -### iOS - -#### config.xml +* iOS + # config.xml <plugin name="Media" value="CDVSound" /> -### Windows Phone - -#### Properties/WPAppManifest.xml +* Windows Phone + # Properties/WPAppManifest.xml <Capabilities> <Capability Name="ID_CAP_MEDIALIB" /> <Capability Name="ID_CAP_MICROPHONE" /> @@ -121,9 +124,9 @@ Permissions Reference: [Application Manifest for Windows Phone](http://msdn.microsoft.com/en-us/library/ff769509%28v=vs.92%29.aspx) -### Tizen +* Tizen - No permissions are required. + No special permissions are required. ### Windows Phone Quirks http://git-wip-us.apache.org/repos/asf/cordova-docs/blob/857cf3df/docs/en/edge/cordova/notification/notification.md ---------------------------------------------------------------------- diff --git a/docs/en/edge/cordova/notification/notification.md b/docs/en/edge/cordova/notification/notification.md index d72d51b..ce0a217 100644 --- a/docs/en/edge/cordova/notification/notification.md +++ b/docs/en/edge/cordova/notification/notification.md @@ -31,39 +31,46 @@ Methods - `notification.beep` - `notification.vibrate` -Permissions ------------ +## Accessing the Feature -### Android +As of version 3.0, Cordova implements device-level APIs as _plugins_. +Use the CLI's `plugin` command, described in The Command-line +Interface, to add or remove this feature for a project: -#### app/res/xml/config.xml + $ cordova plugin add https://git-wip-us.apache.org/repos/asf/cordova-plugin-vibration.git + $ cordova plugin add https://git-wip-us.apache.org/repos/asf/cordova-plugin-dialogs.git + $ cordova plugin rm org.apache.cordova.core.dialogs + $ cordova plugin rm org.apache.cordova.core.vibration - <plugin name="Notification" value="org.apache.cordova.Notification"/> -#### app/AndroidManifest.xml +These commands apply to all targeted platforms, but modify the +platform-specific configuration settings described below: - <uses-permission android:name="android.permission.VIBRATE" /> +* Android -### BlackBerry WebWorks + # app/res/xml/config.xml + <plugin name="Notification" value="org.apache.cordova.Notification"/> -#### www/plugins.xml + # app/AndroidManifest.xml + <uses-permission android:name="android.permission.VIBRATE" /> - <plugin name="Notification" value="org.apache.cordova.notification.Notification" /> +* BlackBerry WebWorks -#### www/config.xml + # www/plugins.xml + <plugin name="Notification" value="org.apache.cordova.notification.Notification" /> + # www/config.xml <feature id="blackberry.ui.dialog" /> -### iOS - -#### config.xml +* iOS + # config.xml <plugin name="Notification" value="CDVNotification" /> -### Windows Phone +* Windows Phone - No permissions are required. + No special permissions are required. -### Tizen +* Tizen - No permissions are required. + No special permissions are required. http://git-wip-us.apache.org/repos/asf/cordova-docs/blob/857cf3df/docs/en/edge/cordova/splashscreen/splashscreen.md ---------------------------------------------------------------------- diff --git a/docs/en/edge/cordova/splashscreen/splashscreen.md b/docs/en/edge/cordova/splashscreen/splashscreen.md index c2cc060..7fe6867 100644 --- a/docs/en/edge/cordova/splashscreen/splashscreen.md +++ b/docs/en/edge/cordova/splashscreen/splashscreen.md @@ -28,19 +28,26 @@ Methods - splashscreen.show - splashscreen.hide -Permissions ------------ +## Accessing the Feature -### Android +As of version 3.0, Cordova implements device-level APIs as _plugins_. +Use the CLI's `plugin` command, described in The Command-line +Interface, to add or remove this feature for a project: -#### app/res/xml/config.xml + $ cordova plugin add https://git-wip-us.apache.org/repos/asf/cordova-plugin-splashscreen.git + $ cordova plugin rm org.apache.cordova.core.splashscreen - <plugin name="SplashScreen" value="org.apache.cordova.SplashScreen"/> +These commands apply to all targeted platforms, but modify the +platform-specific configuration settings described below: -### iOS +* Android + + # app/res/xml/config.xml + <plugin name="SplashScreen" value="org.apache.cordova.SplashScreen"/> -#### config.xml +* iOS + # config.xml <plugin name="SplashScreen" value="CDVSplashScreen" /> Setup http://git-wip-us.apache.org/repos/asf/cordova-docs/blob/857cf3df/docs/en/edge/cordova/storage/storage.md ---------------------------------------------------------------------- diff --git a/docs/en/edge/cordova/storage/storage.md b/docs/en/edge/cordova/storage/storage.md index 1f703fd..0ac6641 100644 --- a/docs/en/edge/cordova/storage/storage.md +++ b/docs/en/edge/cordova/storage/storage.md @@ -52,29 +52,26 @@ Objects - SQLError - localStorage -Permissions ------------ +## Accessing the Feature -### Android - -#### app/res/xml/config.xml +* Android + # app/res/xml/config.xml <plugin name="Storage" value="org.apache.cordova.Storage" /> -### BlackBerry WebWorks - -#### www/config.xml +* BlackBerry WebWorks + # www/config.xml <feature id="blackberry.widgetcache" required="true" version="1.0.0.0" /> -### iOS +* iOS - No permissions are required. + No special permissions are required. -### Windows Phone +* Windows Phone - No permissions are required. + No special permissions are required. -### Tizen +* Tizen - No permissions are required. + No special permissions are required.
