You are viewing a plain text version of this content. The canonical link for it is here.
Posted to commits@cordova.apache.org by mw...@apache.org on 2013/08/02 00:17:47 UTC
svn commit: r1509456 [14/21] - in /cordova/site/public/docs: en/1.5.0/
en/1.5.0rc1/ en/1.6.0/ en/1.6.0rc1/ en/1.6.1/ en/1.7.0/ en/1.7.0rc1/
en/1.8.0/ en/1.8.0rc1/ en/1.8.1/ en/1.9.0/ en/1.9.0rc1/ en/2.0.0/
en/2.0.0rc1/ en/2.1.0/ en/2.1.0rc1/ en/2.1.0rc...
Modified: cordova/site/public/docs/en/edge/cordova_globalization_globalization.md.html
URL: http://svn.apache.org/viewvc/cordova/site/public/docs/en/edge/cordova_globalization_globalization.md.html?rev=1509456&r1=1509455&r2=1509456&view=diff
==============================================================================
--- cordova/site/public/docs/en/edge/cordova_globalization_globalization.md.html (original)
+++ cordova/site/public/docs/en/edge/cordova_globalization_globalization.md.html Thu Aug 1 22:17:43 2013
@@ -85,7 +85,7 @@
<option value="Globalization_objects">Â Â Â Â Â Â - Objects</option>
<option value="Globalization_methods">Â Â Â Â Â Â - Methods</option>
<option value="Globalization_variable_scope">Â Â Â Â Â Â - Variable Scope</option>
-<option value="Globalization_permissions">Â Â Â Â Â Â - Permissions</option>
+<option value="Globalization_accessing_the_feature">Â Â Â Â Â Â - Accessing the Feature</option>
<option value="globalization.getPreferredLanguage">globalization.getPreferredLanguage</option>
<option value="globalization.getPreferredLanguage_description">Â Â Â Â Â Â - Description</option>
<option value="globalization.getPreferredLanguage_supported_platforms">Â Â Â Â Â Â - Supported Platforms</option>
@@ -167,7 +167,6 @@
<li><a href="guide_overview_index.md.html#Overview">Overview</a></li>
<li><a href="guide_cli_index.md.html#The%20Command-line%20Interface">The Command-line Interface</a></li>
<li><a href="guide_platforms_index.md.html#Platform%20Guides">Platform Guides</a></li>
-<li><a href="index.md.html#Guides">Guides</a></li>
<li><a href="config_ref_index.md.html#Configuration%20Reference">Configuration Reference</a></li>
<li><a href="guide_hybrid_webviews_index.md.html#Embedding%20WebViews">Embedding WebViews</a></li>
<li><a href="guide_hybrid_plugins_index.md.html#Plugin%20Development%20Guide">Plugin Development Guide</a></li>
@@ -240,15 +239,32 @@ var globalization = navigator.globalizat
</code></pre>
<h2>
-<a name="Globalization_permissions">Permissions</a>
+<a name="Globalization_accessing_the_feature">Accessing the Feature</a>
</h2>
-<h3>Android</h3>
+<p>As of version 3.0, Cordova implements device-level APIs as <em>plugins</em>.
+Use the CLI's <code>plugin</code> command, described in <a href="#The%20Command-line%0AInterface">The Command-line
+Interface</a>, to add or remove this feature for a project:</p>
-<h4>app/res/xml/config.xml</h4>
+<pre class="prettyprint"><code> $ cordova plugin add https://git-wip-us.apache.org/repos/asf/cordova-plugin-globalization.git
+ $ cordova plugin rm org.apache.cordova.core.globalization
+</code></pre>
+
+<p>These commands apply to all targeted platforms, but modify the
+platform-specific configuration settings described below:</p>
+
+<ul>
+<li>
+<p>Android (in <code>app/res/xml/config.xml</code>)</p>
-<pre class="prettyprint"><code><plugin name="<a href="cordova_globalization_globalization.md.html#Globalization">Globalization</a>" value="org.apache.cordova.<a href="cordova_globalization_globalization.md.html#Globalization">Globalization</a>" />
+<pre class="prettyprint"><code><feature name="<a href="cordova_globalization_globalization.md.html#Globalization">Globalization</a>">
+ <param name="android-package" value="org.apache.cordova.<a href="cordova_globalization_globalization.md.html#Globalization">Globalization</a>" />
+</feature>
</code></pre>
+</li>
+</ul>
+<p>Some platforms may support this feature without requiring any special
+configuration. See Platform Support for an overview.</p>
<hr>
<h1><a name="globalization.getPreferredLanguage">globalization.getPreferredLanguage</a></h1>
@@ -301,7 +317,7 @@ popup dialog with the text <code>languag
<html>
<head>
<title>getPreferredLanguage Example</title>
- <script type="text/javascript" charset="utf-8" src="cordova-x.x.x.js"></script>
+ <script type="text/javascript" charset="utf-8" src="cordova.js"></script>
<script type="text/javascript" charset="utf-8">
function checkLanguage() {
@@ -376,7 +392,7 @@ dialog with the text <code>locale: en\_U
<html>
<head>
<title>getLocaleName Example</title>
- <script type="text/javascript" charset="utf-8" src="cordova-x.x.x.js"></script>
+ <script type="text/javascript" charset="utf-8" src="cordova.js"></script>
<script type="text/javascript" charset="utf-8">
function checkLocale() {
@@ -464,7 +480,7 @@ options:</p>
<html>
<head>
<title>dateToString Example</title>
- <script type="text/javascript" charset="utf-8" src="cordova-x.x.x.js"></script>
+ <script type="text/javascript" charset="utf-8" src="cordova.js"></script>
<script type="text/javascript" charset="utf-8">
function checkDateString() {
@@ -508,27 +524,13 @@ returns the corresponding date object.</
a parameter. That object should have the following properties:</p>
<ul>
-<li>
-<strong>year</strong>: The four digit year. <em>(Number)</em>
-</li>
-<li>
-<strong>month</strong>: The month from (0 - 11). <em>(Number)</em>
-</li>
-<li>
-<strong>day</strong>: The day from (1 - 31). <em>(Number)</em>
-</li>
-<li>
-<strong>hour</strong>: The hour from (0 - 23). <em>(Number)</em>
-</li>
-<li>
-<strong>minute</strong>: The minute from (0 - 59). <em>(Number)</em>
-</li>
-<li>
-<strong>second</strong>: The second from (0 - 59). <em>(Number)</em>
-</li>
-<li>
-<strong>millisecond</strong>: The milliseconds (from 0 - 999), not available on all platforms. <em>(Number)</em>
-</li>
+<li><p><strong>year</strong>: The four digit year. <em>(Number)</em></p></li>
+<li><p><strong>month</strong>: The month from (0-11). <em>(Number)</em></p></li>
+<li><p><strong>day</strong>: The day from (1-31). <em>(Number)</em></p></li>
+<li><p><strong>hour</strong>: The hour from (0-23). <em>(Number)</em></p></li>
+<li><p><strong>minute</strong>: The minute from (0-59). <em>(Number)</em></p></li>
+<li><p><strong>second</strong>: The second from (0-59). <em>(Number)</em></p></li>
+<li><p><strong>millisecond</strong>: The milliseconds (from 0-999), not available on all platforms. <em>(Number)</em></p></li>
</ul>
<p>The inbound <code>dateString</code> parameter should be of type <code>String</code>.</p>
@@ -583,7 +585,7 @@ integer represents an array index.</p>
<html>
<head>
<title>stringToDate Example</title>
- <script type="text/javascript" charset="utf-8" src="cordova-x.x.x.js"></script>
+ <script type="text/javascript" charset="utf-8" src="cordova.js"></script>
<script type="text/javascript" charset="utf-8">
function checkStringDate() {
@@ -629,18 +631,10 @@ client's user preferences.</p>
a parameter contains the following properties:</p>
<ul>
-<li>
-<strong>pattern</strong>: The date and time pattern to format and parse dates. The patterns follow Unicode Technical Standard #35. <a class="external" href="http://unicode.org/reports/tr35/tr35-4.html">http://unicode.org/reports/tr35/tr35-4.html</a>. <em>(String)</em>
-</li>
-<li>
-<strong>timezone</strong>: The abbreviated name of the time zone on the client. <em>(String)</em>
-</li>
-<li>
-<strong>utc_offset</strong>: The current difference in seconds between the client's time zone and coordinated universal time. <em>(Number)</em>
-</li>
-<li>
-<strong>dst_offset</strong>: The current daylight saving time offset in seconds between the client's non-daylight saving's time zone and the client's daylight saving's time zone. <em>(Number)</em>
-</li>
+<li><p><strong>pattern</strong>: The date and time pattern to format and parse dates. The patterns follow Unicode Technical Standard #35. <a class="external" href="http://unicode.org/reports/tr35/tr35-4.html">http://unicode.org/reports/tr35/tr35-4.html</a>. <em>(String)</em></p></li>
+<li><p><strong>timezone</strong>: The abbreviated name of the time zone on the client. <em>(String)</em></p></li>
+<li><p><strong>utc_offset</strong>: The current difference in seconds between the client's time zone and coordinated universal time. <em>(Number)</em></p></li>
+<li><p><strong>dst_offset</strong>: The current daylight saving time offset in seconds between the client's non-daylight saving's time zone and the client's daylight saving's time zone. <em>(Number)</em></p></li>
</ul>
<p>If there is an error obtaining the pattern, the <code>errorCallback</code>
executes with a <code><a href="cordova_globalization_globalization.md.html#GlobalizationError">GlobalizationError</a></code> object as a parameter. The
@@ -689,7 +683,7 @@ a popup dialog with text such as <code>p
<html>
<head>
<title>getDatePattern Example</title>
- <script type="text/javascript" charset="utf-8" src="cordova-x.x.x.js"></script>
+ <script type="text/javascript" charset="utf-8" src="cordova.js"></script>
<script type="text/javascript" charset="utf-8">
function checkDatePattern() {
@@ -713,10 +707,10 @@ a popup dialog with text such as <code>p
</h2>
<ul>
-<li>The <code>formatLength</code> supports only <code>short</code> and <code>full</code> values.</li>
-<li>The <code>pattern</code> for <code>date and time</code> pattern returns only full datetime format.</li>
-<li>The <code>timezone</code> returns the full time zone name.</li>
-<li>The <code>dst_offset</code> property is not supported, and always returns zero.</li>
+<li><p>The <code>formatLength</code> supports only <code>short</code> and <code>full</code> values.</p></li>
+<li><p>The <code>pattern</code> for <code>date and time</code> pattern returns only full datetime format.</p></li>
+<li><p>The <code>timezone</code> returns the full time zone name.</p></li>
+<li><p>The <code>dst_offset</code> property is not supported, and always returns zero.</p></li>
</ul>
<hr>
<h1><a name="globalization.getDateNames">globalization.getDateNames</a></h1>
@@ -787,7 +781,7 @@ a series of twelve popup dialogs, one pe
<html>
<head>
<title>getDateNames Example</title>
- <script type="text/javascript" charset="utf-8" src="cordova-x.x.x.js"></script>
+ <script type="text/javascript" charset="utf-8" src="cordova.js"></script>
<script type="text/javascript" charset="utf-8">
function checkDateNames() {
@@ -867,7 +861,7 @@ timezone, this should display a popup di
<html>
<head>
<title>isDayLightSavingsTime Example</title>
- <script type="text/javascript" charset="utf-8" src="cordova-x.x.x.js"></script>
+ <script type="text/javascript" charset="utf-8" src="cordova.js"></script>
<script type="text/javascript" charset="utf-8">
function checkDayLightSavings() {
@@ -939,7 +933,7 @@ popup dialog with text similar to <code>
<html>
<head>
<title>getFirstDayOfWeek Example</title>
- <script type="text/javascript" charset="utf-8" src="cordova-x.x.x.js"></script>
+ <script type="text/javascript" charset="utf-8" src="cordova.js"></script>
<script type="text/javascript" charset="utf-8">
function checkFirstDay() {
@@ -1017,7 +1011,7 @@ dialog with text similar to <code>number
<html>
<head>
<title>numberToString Example</title>
- <script type="text/javascript" charset="utf-8" src="cordova-x.x.x.js"></script>
+ <script type="text/javascript" charset="utf-8" src="cordova.js"></script>
<script type="text/javascript" charset="utf-8">
function checkNumber() {
@@ -1100,7 +1094,7 @@ popup dialog with text similar to <code>
<html>
<head>
<title>stringToNumber Example</title>
- <script type="text/javascript" charset="utf-8" src="cordova-x.x.x.js"></script>
+ <script type="text/javascript" charset="utf-8" src="cordova.js"></script>
<script type="text/javascript" charset="utf-8">
function checkNumber() {
@@ -1136,30 +1130,14 @@ popup dialog with text similar to <code>
as a parameter. That object contains the following properties:</p>
<ul>
-<li>
-<strong>pattern</strong>: The number pattern to format and parse numbers. The patterns follow Unicode Technical Standard #35. <a class="external" href="http://unicode.org/reports/tr35/tr35-4.html">http://unicode.org/reports/tr35/tr35-4.html</a>. <em>(String)</em>
-</li>
-<li>
-<strong>symbol</strong>: The symbol to use when formatting and parsing, such as a percent or currency symbol. <em>(String)</em>
-</li>
-<li>
-<strong>fraction</strong>: The number of fractional digits to use when parsing and formatting numbers. <em>(Number)</em>
-</li>
-<li>
-<strong>rounding</strong>: The rounding increment to use when parsing and formatting. <em>(Number)</em>
-</li>
-<li>
-<strong>positive</strong>: The symbol to use for positive numbers when parsing and formatting. <em>(String)</em>
-</li>
-<li>
-<strong>negative</strong>: The symbol to use for negative numbers when parsing and formatting. <em>(String)</em>
-</li>
-<li>
-<strong>decimal</strong>: The decimal symbol to use for parsing and formatting. <em>(String)</em>
-</li>
-<li>
-<strong>grouping</strong>: The grouping symbol to use for parsing and formatting. <em>(String)</em>
-</li>
+<li><p><strong>pattern</strong>: The number pattern to format and parse numbers. The patterns follow Unicode Technical Standard #35. <a class="external" href="http://unicode.org/reports/tr35/tr35-4.html">http://unicode.org/reports/tr35/tr35-4.html</a>. <em>(String)</em></p></li>
+<li><p><strong>symbol</strong>: The symbol to use when formatting and parsing, such as a percent or currency symbol. <em>(String)</em></p></li>
+<li><p><strong>fraction</strong>: The number of fractional digits to use when parsing and formatting numbers. <em>(Number)</em></p></li>
+<li><p><strong>rounding</strong>: The rounding increment to use when parsing and formatting. <em>(Number)</em></p></li>
+<li><p><strong>positive</strong>: The symbol to use for positive numbers when parsing and formatting. <em>(String)</em></p></li>
+<li><p><strong>negative</strong>: The symbol to use for negative numbers when parsing and formatting. <em>(String)</em></p></li>
+<li><p><strong>decimal</strong>: The decimal symbol to use for parsing and formatting. <em>(String)</em></p></li>
+<li><p><strong>grouping</strong>: The grouping symbol to use for parsing and formatting. <em>(String)</em></p></li>
</ul>
<p>If there is an error obtaining the pattern, then the <code>errorCallback</code>
executes with a <code><a href="cordova_globalization_globalization.md.html#GlobalizationError">GlobalizationError</a></code> object as a parameter. The
@@ -1223,7 +1201,7 @@ grouping: ,
<html>
<head>
<title>getNumberPattern Example</title>
- <script type="text/javascript" charset="utf-8" src="cordova-x.x.x.js"></script>
+ <script type="text/javascript" charset="utf-8" src="cordova.js"></script>
<script type="text/javascript" charset="utf-8">
function checkPattern() {
@@ -1254,8 +1232,8 @@ grouping: ,
</h2>
<ul>
-<li>The <code>pattern</code> property is not supported, and retuens an empty string.</li>
-<li>The <code>fraction</code> property is not supported, and returns zero.</li>
+<li><p>The <code>pattern</code> property is not supported, and retuens an empty string.</p></li>
+<li><p>The <code>fraction</code> property is not supported, and returns zero.</p></li>
</ul>
<hr>
<h1><a name="globalization.getCurrencyPattern">globalization.getCurrencyPattern</a></h1>
@@ -1274,24 +1252,12 @@ to the client's user preferences and ISO
as a parameter. That object should contain the following properties:</p>
<ul>
-<li>
-<strong>pattern</strong>: The currency pattern to format and parse currency values. The patterns follow Unicode Technical Standard #35. <a class="external" href="http://unicode.org/reports/tr35/tr35-4.html">http://unicode.org/reports/tr35/tr35-4.html</a>. <em>(String)</em>
-</li>
-<li>
-<strong>code</strong>: The ISO 4217 currency code for the pattern. <em>(String)</em>
-</li>
-<li>
-<strong>fraction</strong>: The number of fractional digits to use when parsing and formatting currency. <em>(Number)</em>
-</li>
-<li>
-<strong>rounding</strong>: The rounding increment to use when parsing and formatting. <em>(Number)</em>
-</li>
-<li>
-<strong>decimal</strong>: The decimal symbol to use for parsing and formatting. <em>(String)</em>
-</li>
-<li>
-<strong>grouping</strong>: The grouping symbol to use for parsing and formatting. <em>(String)</em>
-</li>
+<li><p><strong>pattern</strong>: The currency pattern to format and parse currency values. The patterns follow Unicode Technical Standard #35. <a class="external" href="http://unicode.org/reports/tr35/tr35-4.html">http://unicode.org/reports/tr35/tr35-4.html</a>. <em>(String)</em></p></li>
+<li><p><strong>code</strong>: The ISO 4217 currency code for the pattern. <em>(String)</em></p></li>
+<li><p><strong>fraction</strong>: The number of fractional digits to use when parsing and formatting currency. <em>(Number)</em></p></li>
+<li><p><strong>rounding</strong>: The rounding increment to use when parsing and formatting. <em>(Number)</em></p></li>
+<li><p><strong>decimal</strong>: The decimal symbol to use for parsing and formatting. <em>(String)</em></p></li>
+<li><p><strong>grouping</strong>: The grouping symbol to use for parsing and formatting. <em>(String)</em></p></li>
</ul>
<p>The inbound <code>currencyCode</code> parameter should be a <code>String</code> of one of
the ISO 4217 currency codes, for example 'USD'.</p>
@@ -1349,7 +1315,7 @@ grouping: ,
<html>
<head>
<title>getCurrencyPattern Example</title>
- <script type="text/javascript" charset="utf-8" src="cordova-x.x.x.js"></script>
+ <script type="text/javascript" charset="utf-8" src="cordova.js"></script>
<script type="text/javascript" charset="utf-8">
function checkPattern() {
@@ -1436,7 +1402,7 @@ popup dialog with the text similar to <c
<html>
<head>
<title><a href="cordova_globalization_globalization.md.html#GlobalizationError">GlobalizationError</a> Example</title>
- <script type="text/javascript" charset="utf-8" src="cordova-x.x.x.js"></script>
+ <script type="text/javascript" charset="utf-8" src="cordova.js"></script>
<script type="text/javascript" charset="utf-8">
function successCallback(date) {
Modified: cordova/site/public/docs/en/edge/cordova_inappbrowser_inappbrowser.md.html
URL: http://svn.apache.org/viewvc/cordova/site/public/docs/en/edge/cordova_inappbrowser_inappbrowser.md.html?rev=1509456&r1=1509455&r2=1509456&view=diff
==============================================================================
--- cordova/site/public/docs/en/edge/cordova_inappbrowser_inappbrowser.md.html (original)
+++ cordova/site/public/docs/en/edge/cordova_inappbrowser_inappbrowser.md.html Thu Aug 1 22:17:43 2013
@@ -84,7 +84,7 @@
<small><select><option value="InAppBrowser">InAppBrowser</option>
<option value="InAppBrowser_description">Â Â Â Â Â Â - Description</option>
<option value="InAppBrowser_methods">Â Â Â Â Â Â - Methods</option>
-<option value="InAppBrowser_permissions">Â Â Â Â Â Â - Permissions</option>
+<option value="InAppBrowser_accessing_the_feature">Â Â Â Â Â Â - Accessing the Feature</option>
<option value="addEventListener">addEventListener</option>
<option value="addEventListener_supported_platforms">Â Â Â Â Â Â - Supported Platforms</option>
<option value="addEventListener_quick_example">Â Â Â Â Â Â - Quick Example</option>
@@ -124,7 +124,6 @@
<li><a href="guide_overview_index.md.html#Overview">Overview</a></li>
<li><a href="guide_cli_index.md.html#The%20Command-line%20Interface">The Command-line Interface</a></li>
<li><a href="guide_platforms_index.md.html#Platform%20Guides">Platform Guides</a></li>
-<li><a href="index.md.html#Guides">Guides</a></li>
<li><a href="config_ref_index.md.html#Configuration%20Reference">Configuration Reference</a></li>
<li><a href="guide_hybrid_webviews_index.md.html#Embedding%20WebViews">Embedding WebViews</a></li>
<li><a href="guide_hybrid_plugins_index.md.html#Plugin%20Development%20Guide">Plugin Development Guide</a></li>
@@ -183,29 +182,46 @@
<li><a href="cordova_inappbrowser_inappbrowser.md.html#insertCSS">insertCSS</a></li>
</ul>
<h2>
-<a name="InAppBrowser_permissions">Permissions</a>
+<a name="InAppBrowser_accessing_the_feature">Accessing the Feature</a>
</h2>
-<h3>Android</h3>
+<p>As of version 3.0, Cordova implements device-level APIs as <em>plugins</em>.
+Use the CLI's <code>plugin</code> command, described in <a href="#The%20Command-line%0AInterface">The Command-line
+Interface</a>, to add or remove this feature for a project:</p>
-<h4>app/res/xml/config.xml</h4>
-
-<pre class="prettyprint"><code><plugin name="<a href="cordova_inappbrowser_inappbrowser.md.html#InAppBrowser">InAppBrowser</a>" value="org.apache.cordova.<a href="cordova_inappbrowser_inappbrowser.md.html#InAppBrowser">InAppBrowser</a>" />
+<pre class="prettyprint"><code> $ cordova plugin add https://git-wip-us.apache.org/repos/asf/cordova-plugin-inappbrowser.git
+ $ cordova plugin rm org.apache.cordova.core.inappbrowser
</code></pre>
-<h3>iOS</h3>
+<p>These commands apply to all targeted platforms, but modify the
+platform-specific configuration settings described below:</p>
-<h4>config.xml</h4>
+<ul>
+<li>
+<p>Android (in <code>app/res/xml/config.xml</code>)</p>
-<pre class="prettyprint"><code><plugin name="<a href="cordova_inappbrowser_inappbrowser.md.html#InAppBrowser">InAppBrowser</a>" value="CDVInAppBrowser" />
+<pre class="prettyprint"><code><feature name="<a href="cordova_inappbrowser_inappbrowser.md.html#InAppBrowser">InAppBrowser</a>">
+ <param name="android-package" value="org.apache.cordova.<a href="cordova_inappbrowser_inappbrowser.md.html#InAppBrowser">InAppBrowser</a>" />
+</feature>
</code></pre>
+</li>
+<li>
+<p>iOS (in <code>config.xml</code>)</p>
-<h3>Windows Phone 7 + 8</h3>
-
-<h4>config.xml</h4>
+<pre class="prettyprint"><code><feature name="<a href="cordova_inappbrowser_inappbrowser.md.html#InAppBrowser">InAppBrowser</a>">
+ <param name="ios-package" value="CDVInAppBrowser" />
+</feature>
+</code></pre>
+</li>
+<li>
+<p>Windows Phone 7 and 8 (in <code>config.xml</code>)</p>
-<pre class="prettyprint"><code><plugin name="<a href="cordova_inappbrowser_inappbrowser.md.html#InAppBrowser">InAppBrowser</a>" />
+<pre class="prettyprint"><code><feature name="<a href="cordova_inappbrowser_inappbrowser.md.html#InAppBrowser">InAppBrowser</a>" />
</code></pre>
+</li>
+</ul>
+<p>Some platforms may support this feature without requiring any special
+configuration. See Platform Support for an overview.</p>
<h1><a name="addEventListener">addEventListener</a></h1>
@@ -217,9 +233,7 @@
</code></pre>
<ul>
-<li>
-<strong>ref</strong>: reference to the <code><a href="cordova_inappbrowser_inappbrowser.md.html#InAppBrowser">InAppBrowser</a></code> window <em>(<a href="cordova_inappbrowser_inappbrowser.md.html#InAppBrowser">InAppBrowser</a>)</em>
-</li>
+<li><p><strong>ref</strong>: reference to the <code><a href="cordova_inappbrowser_inappbrowser.md.html#InAppBrowser">InAppBrowser</a></code> window <em>(<a href="cordova_inappbrowser_inappbrowser.md.html#InAppBrowser">InAppBrowser</a>)</em></p></li>
<li>
<p><strong>eventname</strong>: the event to listen for <em>(String)</em></p>
@@ -242,8 +256,9 @@
<ul>
<li>Android</li>
+<li>BlackBerry</li>
<li>iOS</li>
-<li>Windows Phone 7 + 8</li>
+<li>Windows Phone 7 and 8</li>
</ul>
<h2>
<a name="addEventListener_quick_example">Quick Example</a>
@@ -262,7 +277,7 @@ ref.<a href="cordova_inappbrowser_inappb
<head>
<title><a href="cordova_inappbrowser_inappbrowser.md.html#InAppBrowser">InAppBrowser</a>.<a href="cordova_inappbrowser_inappbrowser.md.html#addEventListener">addEventListener</a> Example</title>
- <script type="text/javascript" charset="utf-8" src="cordova-x.x.x.js"></script>
+ <script type="text/javascript" charset="utf-8" src="cordova.js"></script>
<script type="text/javascript" charset="utf-8">
// Wait for device API libraries to load
@@ -296,9 +311,7 @@ ref.<a href="cordova_inappbrowser_inappb
</code></pre>
<ul>
-<li>
-<strong>ref</strong>: reference to the <code><a href="cordova_inappbrowser_inappbrowser.md.html#InAppBrowser">InAppBrowser</a></code> window. <em>(<a href="cordova_inappbrowser_inappbrowser.md.html#InAppBrowser">InAppBrowser</a>)</em>
-</li>
+<li><p><strong>ref</strong>: reference to the <code><a href="cordova_inappbrowser_inappbrowser.md.html#InAppBrowser">InAppBrowser</a></code> window. <em>(<a href="cordova_inappbrowser_inappbrowser.md.html#InAppBrowser">InAppBrowser</a>)</em></p></li>
<li>
<p><strong>eventname</strong>: the event to stop listening for. <em>(String)</em></p>
@@ -322,8 +335,9 @@ The function is passed an <code><a href=
<ul>
<li>Android</li>
+<li>BlackBerry</li>
<li>iOS</li>
-<li>Windows Phone 7 + 8</li>
+<li>Windows Phone 7 and 8</li>
</ul>
<h2>
<a name="removeEventListener_quick_example">Quick Example</a>
@@ -344,7 +358,7 @@ ref.<a href="cordova_inappbrowser_inappb
<head>
<title><a href="cordova_inappbrowser_inappbrowser.md.html#InAppBrowser">InAppBrowser</a>.<a href="cordova_inappbrowser_inappbrowser.md.html#removeEventListener">removeEventListener</a> Example</title>
- <script type="text/javascript" charset="utf-8" src="cordova-x.x.x.js"></script>
+ <script type="text/javascript" charset="utf-8" src="cordova.js"></script>
<script type="text/javascript" charset="utf-8">
// Wait for device API libraries to load
@@ -411,9 +425,9 @@ ref.<a href="cordova_inappbrowser_inappb
<ul>
<li>Android</li>
+<li>BlackBerry</li>
<li>iOS</li>
-<li>Windows Phone 7 + 8</li>
-<li>BlackBerry 10</li>
+<li>Windows Phone 7 and 8</li>
</ul>
<h2>
<a name="close_quick_example">Quick Example</a>
@@ -432,7 +446,7 @@ ref.<a href="cordova_inappbrowser_inappb
<head>
<title><a href="cordova_inappbrowser_inappbrowser.md.html#InAppBrowser">InAppBrowser</a>.<a href="cordova_inappbrowser_inappbrowser.md.html#close">close</a> Example</title>
- <script type="text/javascript" charset="utf-8" src="cordova-x.x.x.js"></script>
+ <script type="text/javascript" charset="utf-8" src="cordova.js"></script>
<script type="text/javascript" charset="utf-8">
// Wait for device API libraries to load
@@ -475,6 +489,7 @@ ref.<a href="cordova_inappbrowser_inappb
<ul>
<li>Android</li>
+<li>BlackBerry</li>
<li>iOS</li>
</ul>
<h2>
@@ -494,7 +509,7 @@ ref.<a href="cordova_inappbrowser_inappb
<head>
<title><a href="cordova_inappbrowser_inappbrowser.md.html#InAppBrowser">InAppBrowser</a>.<a href="cordova_inappbrowser_inappbrowser.md.html#show">show</a> Example</title>
- <script type="text/javascript" charset="utf-8" src="cordova-x.x.x.js"></script>
+ <script type="text/javascript" charset="utf-8" src="cordova.js"></script>
<script type="text/javascript" charset="utf-8">
// Wait for Cordova to load
@@ -531,11 +546,10 @@ ref.<a href="cordova_inappbrowser_inappb
</code></pre>
<ul>
+<li><p><strong>ref</strong>: reference to the <code><a href="cordova_inappbrowser_inappbrowser.md.html#InAppBrowser">InAppBrowser</a></code> window. <em>(<a href="cordova_inappbrowser_inappbrowser.md.html#InAppBrowser">InAppBrowser</a>)</em></p></li>
<li>
-<strong>ref</strong>: reference to the <code><a href="cordova_inappbrowser_inappbrowser.md.html#InAppBrowser">InAppBrowser</a></code> window. <em>(<a href="cordova_inappbrowser_inappbrowser.md.html#InAppBrowser">InAppBrowser</a>)</em>
-</li>
-<li>
-<strong>injectDetails</strong>: details of the script to run, specifying either a <code>file</code> or <code>code</code> key. <em>(Object)</em>
+<p><strong>injectDetails</strong>: details of the script to run, specifying either a <code>file</code> or <code>code</code> key. <em>(Object)</em></p>
+
<ul>
<li>
<strong>file</strong>: URL of the script to inject.</li>
@@ -544,7 +558,8 @@ ref.<a href="cordova_inappbrowser_inappb
</ul>
</li>
<li>
-<strong>callback</strong>: the function that executes after the JavaScript code is injected.
+<p><strong>callback</strong>: the function that executes after the JavaScript code is injected.</p>
+
<ul>
<li>If the injected script is of type <code>code</code>, the callback executes
with a single parameter, which is the return value of the
@@ -560,6 +575,7 @@ evaluated.</li>
<ul>
<li>Android</li>
+<li>BlackBerry</li>
<li>iOS</li>
</ul>
<h2>
@@ -581,7 +597,7 @@ ref.<a href="cordova_inappbrowser_inappb
<head>
<title><a href="cordova_inappbrowser_inappbrowser.md.html#InAppBrowser">InAppBrowser</a>.<a href="cordova_inappbrowser_inappbrowser.md.html#executeScript">executeScript</a> Example</title>
- <script type="text/javascript" charset="utf-8" src="cordova-x.x.x.js"></script>
+ <script type="text/javascript" charset="utf-8" src="cordova.js"></script>
<script type="text/javascript" charset="utf-8">
// Wait for device API libraries to load
@@ -631,11 +647,10 @@ ref.<a href="cordova_inappbrowser_inappb
</code></pre>
<ul>
+<li><p><strong>ref</strong>: reference to the <code><a href="cordova_inappbrowser_inappbrowser.md.html#InAppBrowser">InAppBrowser</a></code> window <em>(<a href="cordova_inappbrowser_inappbrowser.md.html#InAppBrowser">InAppBrowser</a>)</em></p></li>
<li>
-<strong>ref</strong>: reference to the <code><a href="cordova_inappbrowser_inappbrowser.md.html#InAppBrowser">InAppBrowser</a></code> window <em>(<a href="cordova_inappbrowser_inappbrowser.md.html#InAppBrowser">InAppBrowser</a>)</em>
-</li>
-<li>
-<strong>injectDetails</strong>: details of the script to run, specifying either a <code>file</code> or <code>code</code> key. <em>(Object)</em>
+<p><strong>injectDetails</strong>: details of the script to run, specifying either a <code>file</code> or <code>code</code> key. <em>(Object)</em></p>
+
<ul>
<li>
<strong>file</strong>: URL of the stylesheet to inject.</li>
@@ -643,8 +658,7 @@ ref.<a href="cordova_inappbrowser_inappb
<strong>code</strong>: Text of the stylesheet to inject.</li>
</ul>
</li>
-<li>
-<strong>callback</strong>: the function that executes after the CSS is injected.</li>
+<li><p><strong>callback</strong>: the function that executes after the CSS is injected.</p></li>
</ul>
<h2>
<a name="insertCSS_supported_platforms">Supported Platforms</a>
@@ -652,6 +666,7 @@ ref.<a href="cordova_inappbrowser_inappb
<ul>
<li>Android</li>
+<li>BlackBerry</li>
<li>iOS</li>
</ul>
<h2>
@@ -673,7 +688,7 @@ ref.<a href="cordova_inappbrowser_inappb
<head>
<title><a href="cordova_inappbrowser_inappbrowser.md.html#InAppBrowser">InAppBrowser</a>.<a href="cordova_inappbrowser_inappbrowser.md.html#insertCSS">insertCSS</a> Example</title>
- <script type="text/javascript" charset="utf-8" src="cordova-x.x.x.js"></script>
+ <script type="text/javascript" charset="utf-8" src="cordova.js"></script>
<script type="text/javascript" charset="utf-8">
// Wait for device API libraries to load
@@ -723,18 +738,10 @@ ref.<a href="cordova_inappbrowser_inappb
</h2>
<ul>
-<li>
-<strong>type</strong>: the eventname, either <code>loadstart</code>, <code>loadstop</code>, <code>loaderror</code>, or <code>exit</code>. <em>(String)</em>
-</li>
-<li>
-<strong>url</strong>: the URL that was loaded. <em>(String)</em>
-</li>
-<li>
-<strong>code</strong>: the error code, only in the case of <code>loaderror</code>. <em>(Number)</em>
-</li>
-<li>
-<strong>message</strong>: the error message, only in the case of <code>loaderror</code>. <em>(String)</em>
-</li>
+<li><p><strong>type</strong>: the eventname, either <code>loadstart</code>, <code>loadstop</code>, <code>loaderror</code>, or <code>exit</code>. <em>(String)</em></p></li>
+<li><p><strong>url</strong>: the URL that was loaded. <em>(String)</em></p></li>
+<li><p><strong>code</strong>: the error code, only in the case of <code>loaderror</code>. <em>(Number)</em></p></li>
+<li><p><strong>message</strong>: the error message, only in the case of <code>loaderror</code>. <em>(String)</em></p></li>
</ul>
<hr>
<h1><a name="window.open">window.open</a></h1>
@@ -746,11 +753,8 @@ instance, or the system browser.</p>
</code></pre>
<ul>
-<li>
-<strong>ref</strong>: Reference to the <code><a href="cordova_inappbrowser_inappbrowser.md.html#InAppBrowser">InAppBrowser</a></code> window. <em>(<a href="cordova_inappbrowser_inappbrowser.md.html#InAppBrowser">InAppBrowser</a>)</em>
-</li>
-<li>
-<strong>url</strong>: The URL to load <em>(String)</em>. Call <code>encodeURI()</code> on this if the URL contains Unicode characters.</li>
+<li><p><strong>ref</strong>: Reference to the <code><a href="cordova_inappbrowser_inappbrowser.md.html#InAppBrowser">InAppBrowser</a></code> window. <em>(<a href="cordova_inappbrowser_inappbrowser.md.html#InAppBrowser">InAppBrowser</a>)</em></p></li>
+<li><p><strong>url</strong>: The URL to load <em>(String)</em>. Call <code>encodeURI()</code> on this if the URL contains Unicode characters.</p></li>
<li>
<p><strong>target</strong>: The target in which to load the URL, an optional parameter that defaults to <code>_self</code>. <em>(String)</em></p>
@@ -812,9 +816,9 @@ instance, or the system browser.</p>
<ul>
<li>Android</li>
+<li>BlackBerry</li>
<li>iOS</li>
-<li>BlackBerry 10</li>
-<li>Windows Phone 7 + 8</li>
+<li>Windows Phone 7 and 8</li>
</ul>
<h2>
<a name="window.open_quick_example">Quick Example</a>
@@ -833,7 +837,7 @@ var ref2 = <a href="cordova_inappbrowser
<head>
<title><a href="cordova_inappbrowser_inappbrowser.md.html#window.open">window.open</a> Example</title>
- <script type="text/javascript" charset="utf-8" src="cordova-x.x.x.js"></script>
+ <script type="text/javascript" charset="utf-8" src="cordova.js"></script>
<script type="text/javascript" charset="utf-8">
// Wait for device API libraries to load
Modified: cordova/site/public/docs/en/edge/cordova_media_capture_capture.md.html
URL: http://svn.apache.org/viewvc/cordova/site/public/docs/en/edge/cordova_media_capture_capture.md.html?rev=1509456&r1=1509455&r2=1509456&view=diff
==============================================================================
--- cordova/site/public/docs/en/edge/cordova_media_capture_capture.md.html (original)
+++ cordova/site/public/docs/en/edge/cordova_media_capture_capture.md.html Thu Aug 1 22:17:43 2013
@@ -88,7 +88,7 @@
<option value="Capture_properties">Â Â Â Â Â Â - Properties</option>
<option value="Capture_methods">Â Â Â Â Â Â - Methods</option>
<option value="Capture_supported_platforms">Â Â Â Â Â Â - Supported Platforms</option>
-<option value="Capture_permissions">Â Â Â Â Â Â - Permissions</option>
+<option value="Capture_accessing_the_feature">Â Â Â Â Â Â - Accessing the Feature</option>
<option value="capture.captureAudio">capture.captureAudio</option>
<option value="capture.captureAudio_description">Â Â Â Â Â Â - Description</option>
<option value="capture.captureAudio_supported_platforms">Â Â Â Â Â Â - Supported Platforms</option>
@@ -160,7 +160,6 @@
<li><a href="guide_overview_index.md.html#Overview">Overview</a></li>
<li><a href="guide_cli_index.md.html#The%20Command-line%20Interface">The Command-line Interface</a></li>
<li><a href="guide_platforms_index.md.html#Platform%20Guides">Platform Guides</a></li>
-<li><a href="index.md.html#Guides">Guides</a></li>
<li><a href="config_ref_index.md.html#Configuration%20Reference">Configuration Reference</a></li>
<li><a href="guide_hybrid_webviews_index.md.html#Embedding%20WebViews">Embedding WebViews</a></li>
<li><a href="guide_hybrid_plugins_index.md.html#Plugin%20Development%20Guide">Plugin Development Guide</a></li>
@@ -240,24 +239,18 @@ var capture = navigator.device.capture;
</h2>
<ul>
-<li>
-<strong>supportedAudioModes</strong>: The audio recording formats supported by the device. (<a href="cordova_media_capture_capture.md.html#ConfigurationData">ConfigurationData</a>[])</li>
-<li>
-<strong>supportedImageModes</strong>: The recording image sizes and formats supported by the device. (<a href="cordova_media_capture_capture.md.html#ConfigurationData">ConfigurationData</a>[])</li>
-<li>
-<strong>supportedVideoModes</strong>: The recording video resolutions and formats supported by the device. (<a href="cordova_media_capture_capture.md.html#ConfigurationData">ConfigurationData</a>[])</li>
+<li><p><strong>supportedAudioModes</strong>: The audio recording formats supported by the device. (<a href="cordova_media_capture_capture.md.html#ConfigurationData">ConfigurationData</a>[])</p></li>
+<li><p><strong>supportedImageModes</strong>: The recording image sizes and formats supported by the device. (<a href="cordova_media_capture_capture.md.html#ConfigurationData">ConfigurationData</a>[])</p></li>
+<li><p><strong>supportedVideoModes</strong>: The recording video resolutions and formats supported by the device. (<a href="cordova_media_capture_capture.md.html#ConfigurationData">ConfigurationData</a>[])</p></li>
</ul>
<h2>
<a name="Capture_methods">Methods</a>
</h2>
<ul>
-<li>
-<code><a href="cordova_media_capture_capture.md.html#capture.captureAudio">capture.captureAudio</a></code>: Launch the device's audio recording application to record audio clips.</li>
-<li>
-<code><a href="cordova_media_capture_capture.md.html#capture.captureImage">capture.captureImage</a></code>: Launch the device's camera application to take photos.</li>
-<li>
-<code><a href="cordova_media_capture_capture.md.html#capture.captureVideo">capture.captureVideo</a></code>: Launch the device's video recorder application to record videos.</li>
+<li><p><code><a href="cordova_media_capture_capture.md.html#capture.captureAudio">capture.captureAudio</a></code>: Launch the device's audio recording application to record audio clips.</p></li>
+<li><p><code><a href="cordova_media_capture_capture.md.html#capture.captureImage">capture.captureImage</a></code>: Launch the device's camera application to take photos.</p></li>
+<li><p><code><a href="cordova_media_capture_capture.md.html#capture.captureVideo">capture.captureVideo</a></code>: Launch the device's video recorder application to record videos.</p></li>
</ul>
<h2>
<a name="Capture_supported_platforms">Supported Platforms</a>
@@ -271,45 +264,59 @@ var capture = navigator.device.capture;
<li>Windows 8</li>
</ul>
<h2>
-<a name="Capture_permissions">Permissions</a>
+<a name="Capture_accessing_the_feature">Accessing the Feature</a>
</h2>
-<h3>Android</h3>
+<p>As of version 3.0, Cordova implements device-level APIs as <em>plugins</em>.
+Use the CLI's <code>plugin</code> command, described in <a href="#The%20Command-line%0AInterface">The Command-line
+Interface</a>, to add or remove this feature for a project:</p>
-<h4>app/res/xml/plugins.xml</h4>
-
-<pre class="prettyprint"><code><plugin name="<a href="cordova_media_capture_capture.md.html#Capture">Capture</a>" value="org.apache.cordova.<a href="cordova_media_capture_capture.md.html#Capture">Capture</a>"/>
+<pre class="prettyprint"><code> $ 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
</code></pre>
-<h4>app/AndroidManifest.xml</h4>
+<p>These commands apply to all targeted platforms, but modify the
+platform-specific configuration settings described below:</p>
-<pre class="prettyprint"><code><uses-permission android:name="android.permission.RECORD_AUDIO" />
-<uses-permission android:name="android.permission.WRITE_EXTERNAL_STORAGE" />
-</code></pre>
+<ul>
+<li>
+<p>Android</p>
-<h3>BlackBerry WebWorks</h3>
+<pre class="prettyprint"><code>(in app/res/xml/plugins.xml)
+<feature name="<a href="cordova_media_capture_capture.md.html#Capture">Capture</a>">
+ <param name="android-package" value="org.apache.cordova.<a href="cordova_media_capture_capture.md.html#Capture">Capture</a>" />
+</feature>
-<h4>www/plugins.xml</h4>
-<pre class="prettyprint"><code><plugin name="<a href="cordova_media_capture_capture.md.html#Capture">Capture</a>" value="org.apache.cordova.capture.MediaCapture" />
+(in app/AndroidManifest.xml)
+<uses-permission android:name="android.permission.RECORD_AUDIO" />
+<uses-permission android:name="android.permission.WRITE_EXTERNAL_STORAGE" />
</code></pre>
+</li>
+<li>
+<p>BlackBerry WebWorks</p>
+
+<pre class="prettyprint"><code>(in www/plugins.xml)
+<feature name="<a href="cordova_media_capture_capture.md.html#Capture">Capture</a>">
+ <param name="blackberry-package" value="org.apache.cordova.capture.MediaCapture" />
+</feature>
-<h4>www/config.xml</h4>
-<pre class="prettyprint"><code><feature id="blackberry.system" required="true" version="1.0.0.0" />
+(in 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" />
</code></pre>
+</li>
+<li>
+<p>iOS (in <code>config.xml</code>)</p>
-<h3>iOS</h3>
-
-<h4>config.xml</h4>
-
-<pre class="prettyprint"><code><plugin name="<a href="cordova_media_capture_capture.md.html#Capture">Capture</a>" value="CDVCapture" />
+<pre class="prettyprint"><code><feature name="<a href="cordova_media_capture_capture.md.html#Capture">Capture</a>">
+ <param name="ios-package" value="CDVCapture" />
+</feature>
</code></pre>
-
-<h3>Windows Phone</h3>
-
-<h4>Properties/WPAppManifest.xml</h4>
+</li>
+<li>
+<p>Windows Phone (in <code>Properties/WPAppManifest.xml</code>)</p>
<pre class="prettyprint"><code><Capabilities>
<Capability Name="ID_CAP_MEDIALIB" />
@@ -319,12 +326,16 @@ var capture = navigator.device.capture;
<Capability Name="ID_CAP_CAMERA" />
</Capabilities>
</code></pre>
+</li>
+</ul>
+<p>Some platforms may support this feature without requiring any special
+configuration. See Platform Support for an overview.</p>
<hr>
<h1><a name="capture.captureAudio">capture.captureAudio</a></h1>
<blockquote>
- <p>Start the audio recorder application and return information about the captured audio clip file(s).</p>
+ <p>Start the audio recorder application and return information about captured audio clip files.</p>
</blockquote>
<pre class="prettyprint"><code>navigator.device.<a href="cordova_media_capture_capture.md.html#capture.captureAudio">capture.captureAudio</a>(
@@ -395,7 +406,7 @@ navigator.device.<a href="cordova_media_
<head>
<title><a href="cordova_media_capture_capture.md.html#Capture">Capture</a> Audio</title>
- <script type="text/javascript" charset="utf-8" src="cordova-x.x.x.js"></script>
+ <script type="text/javascript" charset="utf-8" src="cordova.js"></script>
<script type="text/javascript" charset="utf-8" src="json2.js"></script>
<script type="text/javascript" charset="utf-8">
@@ -482,10 +493,8 @@ navigator.device.<a href="cordova_media_
</h2>
<ul>
-<li>
-<strong>limit</strong>: The maximum number of audio clips the device user can record in a single capture operation. The value must be greater than or equal to 1 (defaults to 1).</li>
-<li>
-<strong>duration</strong>: The maximum duration of an audio sound clip, in seconds.</li>
+<li><p><strong>limit</strong>: The maximum number of audio clips the device user can record in a single capture operation. The value must be greater than or equal to 1 (defaults to 1).</p></li>
+<li><p><strong>duration</strong>: The maximum duration of an audio sound clip, in seconds.</p></li>
</ul>
<h2>
<a name="CaptureAudioOptions_quick_example">Quick Example</a>
@@ -522,7 +531,7 @@ navigator.device.<a href="cordova_media_
<h1><a name="capture.captureImage">capture.captureImage</a></h1>
<blockquote>
- <p>Start the camera application and return information about captured image file(s).</p>
+ <p>Start the camera application and return information about captured image files.</p>
</blockquote>
<pre class="prettyprint"><code>navigator.device.<a href="cordova_media_capture_capture.md.html#capture.captureImage">capture.captureImage</a>(
@@ -599,7 +608,7 @@ navigator.device.<a href="cordova_media_
<head>
<title><a href="cordova_media_capture_capture.md.html#Capture">Capture</a> Image</title>
- <script type="text/javascript" charset="utf-8" src="cordova-x.x.x.js"></script>
+ <script type="text/javascript" charset="utf-8" src="cordova.js"></script>
<script type="text/javascript" charset="utf-8" src="json2.js"></script>
<script type="text/javascript" charset="utf-8">
@@ -689,7 +698,7 @@ navigator.device.<a href="cordova_media_
<h1><a name="capture.captureVideo">capture.captureVideo</a></h1>
<blockquote>
- <p>Start the video recorder application and return information about captured video clip file(s).</p>
+ <p>Start the video recorder application and return information about captured video clip files.</p>
</blockquote>
<pre class="prettyprint"><code>navigator.device.<a href="cordova_media_capture_capture.md.html#capture.captureVideo">capture.captureVideo</a>(
@@ -760,7 +769,7 @@ navigator.device.<a href="cordova_media_
<head>
<title><a href="cordova_media_capture_capture.md.html#Capture">Capture</a> Video</title>
- <script type="text/javascript" charset="utf-8" src="cordova-x.x.x.js"></script>
+ <script type="text/javascript" charset="utf-8" src="cordova.js"></script>
<script type="text/javascript" charset="utf-8" src="json2.js"></script>
<script type="text/javascript" charset="utf-8">
@@ -833,10 +842,8 @@ navigator.device.<a href="cordova_media_
</h2>
<ul>
-<li>
-<strong>limit</strong>: The maximum number of video clips the device's user can capture in a single capture operation. The value must be greater than or equal to 1 (defaults to 1).</li>
-<li>
-<strong>duration</strong>: The maximum duration of a video clip, in seconds.</li>
+<li><p><strong>limit</strong>: The maximum number of video clips the device's user can capture in a single capture operation. The value must be greater than or equal to 1 (defaults to 1).</p></li>
+<li><p><strong>duration</strong>: The maximum duration of a video clip, in seconds.</p></li>
</ul>
<h2>
<a name="CaptureVideoOptions_quick_example">Quick Example</a>
@@ -882,16 +889,11 @@ navigator.device.<a href="cordova_media_
</h2>
<ul>
-<li>
-<code><a href="cordova_media_capture_capture.md.html#CaptureError">CaptureError</a>.CAPTURE_INTERNAL_ERR</code>: The camera or microphone failed to capture image or sound.</li>
-<li>
-<code><a href="cordova_media_capture_capture.md.html#CaptureError">CaptureError</a>.CAPTURE_APPLICATION_BUSY</code>: The camera or audio capture application is currently serving another capture request.</li>
-<li>
-<code><a href="cordova_media_capture_capture.md.html#CaptureError">CaptureError</a>.CAPTURE_INVALID_ARGUMENT</code>: Invalid use of the API (e.g. the value of <code>limit</code> is less than one).</li>
-<li>
-<code><a href="cordova_media_capture_capture.md.html#CaptureError">CaptureError</a>.CAPTURE_NO_MEDIA_FILES</code>: The user exits the camera or audio capture application before capturing anything.</li>
-<li>
-<code><a href="cordova_media_capture_capture.md.html#CaptureError">CaptureError</a>.CAPTURE_NOT_SUPPORTED</code>: The requested capture operation is not supported.</li>
+<li><p><code><a href="cordova_media_capture_capture.md.html#CaptureError">CaptureError</a>.CAPTURE_INTERNAL_ERR</code>: The camera or microphone failed to capture image or sound.</p></li>
+<li><p><code><a href="cordova_media_capture_capture.md.html#CaptureError">CaptureError</a>.CAPTURE_APPLICATION_BUSY</code>: The camera or audio capture application is currently serving another capture request.</p></li>
+<li><p><code><a href="cordova_media_capture_capture.md.html#CaptureError">CaptureError</a>.CAPTURE_INVALID_ARGUMENT</code>: Invalid use of the API (e.g. the value of <code>limit</code> is less than one).</p></li>
+<li><p><code><a href="cordova_media_capture_capture.md.html#CaptureError">CaptureError</a>.CAPTURE_NO_MEDIA_FILES</code>: The user exits the camera or audio capture application before capturing anything.</p></li>
+<li><p><code><a href="cordova_media_capture_capture.md.html#CaptureError">CaptureError</a>.CAPTURE_NOT_SUPPORTED</code>: The requested capture operation is not supported.</p></li>
</ul>
<hr>
<h1><a name="CaptureCB">CaptureCB</a></h1>
@@ -989,12 +991,9 @@ video or image capture.</p>
</h2>
<ul>
-<li>
-<strong>type</strong>: The ASCII-encoded lowercase string representing the media type. (DOMString)</li>
-<li>
-<strong>height</strong>: The height of the image or video in pixels. The value is zero for sound clips. (Number)</li>
-<li>
-<strong>width</strong>: The width of the image or video in pixels. The value is zero for sound clips. (Number)</li>
+<li><p><strong>type</strong>: The ASCII-encoded lowercase string representing the media type. (DOMString)</p></li>
+<li><p><strong>height</strong>: The height of the image or video in pixels. The value is zero for sound clips. (Number)</p></li>
+<li><p><strong>width</strong>: The width of the image or video in pixels. The value is zero for sound clips. (Number)</p></li>
</ul>
<h2>
<a name="ConfigurationData_quick_example">Quick Example</a>
@@ -1028,16 +1027,11 @@ for each (var mode in imageModes) {
</h2>
<ul>
-<li>
-<strong>name</strong>: The name of the file, without path information. (DOMString)</li>
-<li>
-<strong>fullPath</strong>: The full path of the file, including the name. (DOMString)</li>
-<li>
-<strong>type</strong>: The file's mime type (DOMString)</li>
-<li>
-<strong>lastModifiedDate</strong>: The date and time when the file was last modified. (Date)</li>
-<li>
-<strong>size</strong>: The size of the file, in bytes. (Number)</li>
+<li><p><strong>name</strong>: The name of the file, without path information. (DOMString)</p></li>
+<li><p><strong>fullPath</strong>: The full path of the file, including the name. (DOMString)</p></li>
+<li><p><strong>type</strong>: The file's mime type (DOMString)</p></li>
+<li><p><strong>lastModifiedDate</strong>: The date and time when the file was last modified. (Date)</p></li>
+<li><p><strong>size</strong>: The size of the file, in bytes. (Number)</p></li>
</ul>
<h2>
<a name="MediaFile_methods">Methods</a>
@@ -1114,16 +1108,11 @@ callback.</p>
</h2>
<ul>
-<li>
-<strong>codecs</strong>: The actual format of the audio and video content. (DOMString)</li>
-<li>
-<strong>bitrate</strong>: The average bitrate of the content. The value is zero for images. (Number)</li>
-<li>
-<strong>height</strong>: The height of the image or video in pixels. The value is zero for audio clips. (Number)</li>
-<li>
-<strong>width</strong>: The width of the image or video in pixels. The value is zero for audio clips. (Number)</li>
-<li>
-<strong>duration</strong>: The length of the video or sound clip in seconds. The value is zero for images. (Number)</li>
+<li><p><strong>codecs</strong>: The actual format of the audio and video content. (DOMString)</p></li>
+<li><p><strong>bitrate</strong>: The average bitrate of the content. The value is zero for images. (Number)</p></li>
+<li><p><strong>height</strong>: The height of the image or video in pixels. The value is zero for audio clips. (Number)</p></li>
+<li><p><strong>width</strong>: The width of the image or video in pixels. The value is zero for audio clips. (Number)</p></li>
+<li><p><strong>duration</strong>: The length of the video or sound clip in seconds. The value is zero for images. (Number)</p></li>
</ul>
<h2>
<a name="MediaFileData_blackberry_webworks_quirks">BlackBerry WebWorks Quirks</a>
@@ -1134,16 +1123,11 @@ callback.</p>
the following default values:</p>
<ul>
-<li>
-<strong>codecs</strong>: Not supported, and returns <code>null</code>.</li>
-<li>
-<strong>bitrate</strong>: Not supported, and returns zero.</li>
-<li>
-<strong>height</strong>: Not supported, and returns zero.</li>
-<li>
-<strong>width</strong>: Not supported, and returns zero.</li>
-<li>
-<strong>duration</strong>: Not supported, and returns zero.</li>
+<li><p><strong>codecs</strong>: Not supported, and returns <code>null</code>.</p></li>
+<li><p><strong>bitrate</strong>: Not supported, and returns zero.</p></li>
+<li><p><strong>height</strong>: Not supported, and returns zero.</p></li>
+<li><p><strong>width</strong>: Not supported, and returns zero.</p></li>
+<li><p><strong>duration</strong>: Not supported, and returns zero.</p></li>
</ul>
<h2>
<a name="MediaFileData_android_quirks">Android Quirks</a>
@@ -1152,16 +1136,11 @@ the following default values:</p>
<p>Supports the following <code><a href="cordova_media_capture_capture.md.html#MediaFileData">MediaFileData</a></code> properties:</p>
<ul>
-<li>
-<strong>codecs</strong>: Not supported, and returns <code>null</code>.</li>
-<li>
-<strong>bitrate</strong>: Not supported, and returns zero.</li>
-<li>
-<strong>height</strong>: Supported: image and video files only.</li>
-<li>
-<strong>width</strong>: Supported: image and video files only.</li>
-<li>
-<strong>duration</strong>: Supported: audio and video files only.</li>
+<li><p><strong>codecs</strong>: Not supported, and returns <code>null</code>.</p></li>
+<li><p><strong>bitrate</strong>: Not supported, and returns zero.</p></li>
+<li><p><strong>height</strong>: Supported: image and video files only.</p></li>
+<li><p><strong>width</strong>: Supported: image and video files only.</p></li>
+<li><p><strong>duration</strong>: Supported: audio and video files only.</p></li>
</ul>
<h2>
<a name="MediaFileData_ios_quirks">iOS Quirks</a>
@@ -1170,16 +1149,11 @@ the following default values:</p>
<p>Supports the following <code><a href="cordova_media_capture_capture.md.html#MediaFileData">MediaFileData</a></code> properties:</p>
<ul>
-<li>
-<strong>codecs</strong>: Not supported, and returns null.</li>
-<li>
-<strong>bitrate</strong>: Supported on iOS4 devices for audio only. Returns zero for images and videos.</li>
-<li>
-<strong>height</strong>: Supported: image and video files only.</li>
-<li>
-<strong>width</strong>: Supported: image and video files only.</li>
-<li>
-<strong>duration</strong>: Supported: audio and video files only.</li>
+<li><p><strong>codecs</strong>: Not supported, and returns null.</p></li>
+<li><p><strong>bitrate</strong>: Supported on iOS4 devices for audio only. Returns zero for images and videos.</p></li>
+<li><p><strong>height</strong>: Supported: image and video files only.</p></li>
+<li><p><strong>width</strong>: Supported: image and video files only.</p></li>
+<li><p><strong>duration</strong>: Supported: audio and video files only.</p></li>
</ul>
</div>
</div>
Modified: cordova/site/public/docs/en/edge/cordova_media_media.md.html
URL: http://svn.apache.org/viewvc/cordova/site/public/docs/en/edge/cordova_media_media.md.html?rev=1509456&r1=1509455&r2=1509456&view=diff
==============================================================================
--- cordova/site/public/docs/en/edge/cordova_media_media.md.html (original)
+++ cordova/site/public/docs/en/edge/cordova_media_media.md.html Thu Aug 1 22:17:43 2013
@@ -87,7 +87,7 @@
<option value="Media_methods">Â Â Â Â Â Â - Methods</option>
<option value="Media_additional_readonly_parameters">Â Â Â Â Â Â - Additional ReadOnly Parameters</option>
<option value="Media_supported_platforms">Â Â Â Â Â Â - Supported Platforms</option>
-<option value="Media_permissions">Â Â Â Â Â Â - Permissions</option>
+<option value="Media_accessing_the_feature">Â Â Â Â Â Â - Accessing the Feature</option>
<option value="media.getCurrentPosition">media.getCurrentPosition</option>
<option value="media.getCurrentPosition_parameters">Â Â Â Â Â Â - Parameters</option>
<option value="media.getCurrentPosition_description">Â Â Â Â Â Â - Description</option>
@@ -164,7 +164,6 @@
<li><a href="guide_overview_index.md.html#Overview">Overview</a></li>
<li><a href="guide_cli_index.md.html#The%20Command-line%20Interface">The Command-line Interface</a></li>
<li><a href="guide_platforms_index.md.html#Platform%20Guides">Platform Guides</a></li>
-<li><a href="index.md.html#Guides">Guides</a></li>
<li><a href="config_ref_index.md.html#Configuration%20Reference">Configuration Reference</a></li>
<li><a href="guide_hybrid_webviews_index.md.html#Embedding%20WebViews">Embedding WebViews</a></li>
<li><a href="guide_hybrid_plugins_index.md.html#Plugin%20Development%20Guide">Plugin Development Guide</a></li>
@@ -214,18 +213,10 @@ and may deprecate the current APIs.</p>
</h2>
<ul>
-<li>
-<strong>src</strong>: A URI containing the audio content. <em>(DOMString)</em>
-</li>
-<li>
-<strong>mediaSuccess</strong>: (Optional) The callback that executes after a <code><a href="cordova_media_media.md.html#Media">Media</a></code> object has completed the current play, record, or stop action. <em>(Function)</em>
-</li>
-<li>
-<strong><a href="cordova_media_media.md.html#mediaError">mediaError</a></strong>: (Optional) The callback that executes if an error occurs. <em>(Function)</em>
-</li>
-<li>
-<strong>mediaStatus</strong>: (Optional) The callback that executes to indicate status changes. <em>(Function)</em>
-</li>
+<li><p><strong>src</strong>: A URI containing the audio content. <em>(DOMString)</em></p></li>
+<li><p><strong>mediaSuccess</strong>: (Optional) The callback that executes after a <code><a href="cordova_media_media.md.html#Media">Media</a></code> object has completed the current play, record, or stop action. <em>(Function)</em></p></li>
+<li><p><strong><a href="cordova_media_media.md.html#mediaError">mediaError</a></strong>: (Optional) The callback that executes if an error occurs. <em>(Function)</em></p></li>
+<li><p><strong>mediaStatus</strong>: (Optional) The callback that executes to indicate status changes. <em>(Function)</em></p></li>
</ul>
<h2>
<a name="Media_constants">Constants</a>
@@ -251,26 +242,16 @@ and may deprecate the current APIs.</p>
</h2>
<ul>
-<li>
-<code><a href="cordova_media_media.md.html#media.getCurrentPosition">media.getCurrentPosition</a></code>: Returns the current position within an audio file.</li>
-<li>
-<code><a href="cordova_media_media.md.html#media.getDuration">media.getDuration</a></code>: Returns the duration of an audio file.</li>
-<li>
-<code><a href="cordova_media_media.md.html#media.play">media.play</a></code>: Start or <a href="cordova_events_events.md.html#resume">resume</a> playing an audio file.</li>
-<li>
-<code><a href="cordova_media_media.md.html#media.pause">media.pause</a></code>: Pause playback of an audio file.</li>
-<li>
-<code><a href="cordova_media_media.md.html#media.release">media.release</a></code>: Releases the underlying operating system's audio resources.</li>
-<li>
-<code><a href="cordova_media_media.md.html#media.seekTo">media.seekTo</a></code>: Moves the position within the audio file.</li>
-<li>
-<code><a href="cordova_media_media.md.html#media.setVolume">media.setVolume</a></code>: Set the volume for audio playback.</li>
-<li>
-<code><a href="cordova_media_media.md.html#media.startRecord">media.startRecord</a></code>: Start recording an audio file.</li>
-<li>
-<code><a href="cordova_media_media.md.html#media.stopRecord">media.stopRecord</a></code>: Stop recording an audio file.</li>
-<li>
-<code><a href="cordova_media_media.md.html#media.stop">media.stop</a></code>: Stop playing an audio file.</li>
+<li><p><code><a href="cordova_media_media.md.html#media.getCurrentPosition">media.getCurrentPosition</a></code>: Returns the current position within an audio file.</p></li>
+<li><p><code><a href="cordova_media_media.md.html#media.getDuration">media.getDuration</a></code>: Returns the duration of an audio file.</p></li>
+<li><p><code><a href="cordova_media_media.md.html#media.play">media.play</a></code>: Start or <a href="cordova_events_events.md.html#resume">resume</a> playing an audio file.</p></li>
+<li><p><code><a href="cordova_media_media.md.html#media.pause">media.pause</a></code>: Pause playback of an audio file.</p></li>
+<li><p><code><a href="cordova_media_media.md.html#media.release">media.release</a></code>: Releases the underlying operating system's audio resources.</p></li>
+<li><p><code><a href="cordova_media_media.md.html#media.seekTo">media.seekTo</a></code>: Moves the position within the audio file.</p></li>
+<li><p><code><a href="cordova_media_media.md.html#media.setVolume">media.setVolume</a></code>: Set the volume for audio playback.</p></li>
+<li><p><code><a href="cordova_media_media.md.html#media.startRecord">media.startRecord</a></code>: Start recording an audio file.</p></li>
+<li><p><code><a href="cordova_media_media.md.html#media.stopRecord">media.stopRecord</a></code>: Stop recording an audio file.</p></li>
+<li><p><code><a href="cordova_media_media.md.html#media.stop">media.stop</a></code>: Stop playing an audio file.</p></li>
</ul>
<h2>
<a name="Media_additional_readonly_parameters">Additional ReadOnly Parameters</a>
@@ -278,13 +259,13 @@ and may deprecate the current APIs.</p>
<ul>
<li>
-<strong>position</strong>: The position within the audio playback, in seconds.
+<p><strong>position</strong>: The position within the audio playback, in seconds.</p>
+
<ul>
<li>Not automatically updated during play; call <code>getCurrentPosition</code> to update.</li>
</ul>
</li>
-<li>
-<strong>duration</strong>: The duration of the media, in seconds.</li>
+<li><p><strong>duration</strong>: The duration of the media, in seconds.</p></li>
</ul>
<h2>
<a name="Media_supported_platforms">Supported Platforms</a>
@@ -299,40 +280,54 @@ and may deprecate the current APIs.</p>
<li>Windows 8</li>
</ul>
<h2>
-<a name="Media_permissions">Permissions</a>
+<a name="Media_accessing_the_feature">Accessing the Feature</a>
</h2>
-<h3>Android</h3>
-
-<h4>app/res/xml/config.xml</h4>
+<p>As of version 3.0, Cordova implements device-level APIs as <em>plugins</em>.
+Use the CLI's <code>plugin</code> command, described in <a href="#The%20Command-line%0AInterface">The Command-line
+Interface</a>, to add or remove this feature for a project:</p>
-<pre class="prettyprint"><code><plugin name="<a href="cordova_media_media.md.html#Media">Media</a>" value="org.apache.cordova.AudioHandler" />
+<pre class="prettyprint"><code> $ cordova plugin add https://git-wip-us.apache.org/repos/asf/cordova-plugin-media.git
</code></pre>
-<h4>app/AndroidManifest.xml</h4>
+<p>These commands apply to all targeted platforms, but modify the
+platform-specific configuration settings described below:</p>
-<pre class="prettyprint"><code><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" />
-</code></pre>
+<ul>
+<li>
+<p>Android</p>
-<h3>BlackBerry WebWorks</h3>
+<pre class="prettyprint"><code>(in app/res/xml/config.xml)
+<feature name="<a href="cordova_media_media.md.html#Media">Media</a>">
+ <param name="android-package" value="org.apache.cordova.AudioHandler" />
+</feature>
-<h4>www/plugins.xml</h4>
-<pre class="prettyprint"><code><plugin name="<a href="cordova_media_capture_capture.md.html#Capture">Capture</a>" value="org.apache.cordova.media.MediaCapture" />
+(in 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" />
</code></pre>
+</li>
+<li>
+<p>BlackBerry WebWorks</p>
-<h3>iOS</h3>
-
-<h4>config.xml</h4>
-
-<pre class="prettyprint"><code><plugin name="<a href="cordova_media_media.md.html#Media">Media</a>" value="CDVSound" />
+<pre class="prettyprint"><code>(in www/plugins.xml)
+<feature name="<a href="cordova_media_capture_capture.md.html#Capture">Capture</a>">
+ <param name="blackberry-package" value="org.apache.cordova.media.MediaCapture" />
+</feature>
</code></pre>
+</li>
+<li>
+<p>iOS (in <code>config.xml</code>)</p>
-<h3>Windows Phone</h3>
-
-<h4>Properties/WPAppManifest.xml</h4>
+<pre class="prettyprint"><code><feature name="<a href="cordova_media_media.md.html#Media">Media</a>">
+ <param name="ios-package" value="CDVSound" />
+</feature>
+</code></pre>
+</li>
+<li>
+<p>Windows Phone (in <code>Properties/WPAppManifest.xml</code>)</p>
<pre class="prettyprint"><code><Capabilities>
<Capability Name="ID_CAP_MEDIALIB" />
@@ -344,17 +339,16 @@ and may deprecate the current APIs.</p>
</code></pre>
<p>Reference: <a class="external" href="http://msdn.microsoft.com/en-us/library/ff769509%28v=vs.92%29.aspx">Application Manifest for Windows Phone</a></p>
-
-<h3>Tizen</h3>
-
-<pre class="prettyprint"><code>No permissions are required.
-</code></pre>
+</li>
+</ul>
+<p>Some platforms may support this feature without requiring any special
+configuration. See Platform Support for an overview.</p>
<h3>Windows Phone Quirks</h3>
<ul>
-<li>Only one media file can be played back at a time.</li>
-<li>There are strict restrictions on how your application interacts with other media. See the <a class="external" href="http://msdn.microsoft.com/en-us/library/windowsphone/develop/hh184838(v=vs.92).aspx">Microsoft documentation for details</a>.</li>
+<li><p>Only one media file can be played back at a time.</p></li>
+<li><p>There are strict restrictions on how your application interacts with other media. See the <a class="external" href="http://msdn.microsoft.com/en-us/library/windowsphone/develop/hh184838(v=vs.92).aspx">Microsoft documentation for details</a>.</p></li>
</ul>
<hr>
<h1><a name="media.getCurrentPosition">media.getCurrentPosition</a></h1>
@@ -369,10 +363,8 @@ and may deprecate the current APIs.</p>
</h2>
<ul>
-<li>
-<strong>mediaSuccess</strong>: The callback that is passed the current position in seconds.</li>
-<li>
-<strong><a href="cordova_media_media.md.html#mediaError">mediaError</a></strong>: (Optional) The callback to execute if an error occurs.</li>
+<li><p><strong>mediaSuccess</strong>: The callback that is passed the current position in seconds.</p></li>
+<li><p><strong><a href="cordova_media_media.md.html#mediaError">mediaError</a></strong>: (Optional) The callback to execute if an error occurs.</p></li>
</ul>
<h2>
<a name="media.getCurrentPosition_description">Description</a>
@@ -387,12 +379,12 @@ object's <code>position</code> parameter
</h2>
<ul>
-<li>Android</li>
-<li>BlackBerry WebWorks (OS 5.0 and higher)</li>
-<li>iOS</li>
-<li>Windows Phone 7 and 8</li>
-<li>Tizen</li>
-<li>Windows 8</li>
+<li><p>Android</p></li>
+<li><p>BlackBerry WebWorks (OS 5.0 and higher)</p></li>
+<li><p>iOS</p></li>
+<li><p>Windows Phone 7 and 8</p></li>
+<li><p>Tizen</p></li>
+<li><p>Windows 8</p></li>
</ul>
<h2>
<a name="media.getCurrentPosition_quick_example">Quick Example</a>
@@ -430,7 +422,7 @@ var mediaTimer = setInterval(function ()
<head>
<title><a href="cordova_media_media.md.html#Media">Media</a> Example</title>
- <script type="text/javascript" charset="utf-8" src="cordova-x.x.x.js"></script>
+ <script type="text/javascript" charset="utf-8" src="cordova.js"></script>
<script type="text/javascript" charset="utf-8">
// Wait for device API libraries to load
@@ -587,7 +579,7 @@ var timerDur = setInterval(function() {
<head>
<title><a href="cordova_media_media.md.html#Media">Media</a> Example</title>
- <script type="text/javascript" charset="utf-8" src="cordova-x.x.x.js"></script>
+ <script type="text/javascript" charset="utf-8" src="cordova.js"></script>
<script type="text/javascript" charset="utf-8">
// Wait for device API libraries to load
@@ -744,7 +736,7 @@ function playAudio(url) {
<head>
<title><a href="cordova_media_media.md.html#Media">Media</a> Example</title>
- <script type="text/javascript" charset="utf-8" src="cordova-x.x.x.js"></script>
+ <script type="text/javascript" charset="utf-8" src="cordova.js"></script>
<script type="text/javascript" charset="utf-8">
// Wait for device API libraries to load
@@ -900,7 +892,7 @@ function playAudio(url) {
<head>
<title><a href="cordova_media_media.md.html#Media">Media</a> Example</title>
- <script type="text/javascript" charset="utf-8" src="cordova-x.x.x.js"></script>
+ <script type="text/javascript" charset="utf-8" src="cordova.js"></script>
<script type="text/javascript" charset="utf-8">
// Wait for device API libraries to load
@@ -1094,7 +1086,7 @@ my_media.release();
<head>
<title><a href="cordova_media_media.md.html#Media">Media</a> Example</title>
- <script type="text/javascript" charset="utf-8" src="cordova-x.x.x.js"></script>
+ <script type="text/javascript" charset="utf-8" src="cordova.js"></script>
<script type="text/javascript" charset="utf-8">
// Wait for device API libraries to load
@@ -1250,7 +1242,7 @@ setTimeout(function() {
<head>
<title><a href="cordova_media_media.md.html#Media">Media</a> Example</title>
- <script type="text/javascript" charset="utf-8" src="cordova-x.x.x.js"></script>
+ <script type="text/javascript" charset="utf-8" src="cordova.js"></script>
<script type="text/javascript" charset="utf-8">
// Wait for device API libraries to load
@@ -1419,7 +1411,7 @@ function playAudio(url) {
<head>
<title><a href="cordova_media_media.md.html#Media">Media</a> Example</title>
- <script type="text/javascript" charset="utf-8" src="cordova-x.x.x.js"></script>
+ <script type="text/javascript" charset="utf-8" src="cordova.js"></script>
<script type="text/javascript" charset="utf-8">
// Wait for Cordova to load
@@ -1575,7 +1567,7 @@ function recordAudio() {
<head>
<title><a href="cordova_device_device.md.html#Device">Device</a> Properties Example</title>
- <script type="text/javascript" charset="utf-8" src="cordova-x.x.x.js"></script>
+ <script type="text/javascript" charset="utf-8" src="cordova.js"></script>
<script type="text/javascript" charset="utf-8">
// Wait for device API libraries to load
@@ -1656,8 +1648,8 @@ function recordAudio() {
</h2>
<ul>
-<li>iOS only records to files of type <em>.wav</em> and returns an error if the file name extension is not correct.</li>
-<li>If a full path is not provided, the recording is placed in the application's <code>documents/tmp</code> directory. This can be accessed via the <code><a href="cordova_file_file.md.html#File">File</a></code> API using <code><a href="cordova_file_file.md.html#LocalFileSystem">LocalFileSystem</a>.TEMPORARY</code>. Any subdirectory specified at record time must already exist.</li>
+<li><p>iOS only records to files of type <em>.wav</em> and returns an error if the file name extension is not correct.</p></li>
+<li><p>If a full path is not provided, the recording is placed in the application's <code>documents/tmp</code> directory. This can be accessed via the <code><a href="cordova_file_file.md.html#File">File</a></code> API using <code><a href="cordova_file_file.md.html#LocalFileSystem">LocalFileSystem</a>.TEMPORARY</code>. Any subdirectory specified at record time must already exist.</p></li>
<li>
<p>Files can be recorded and played back using the documents URI:</p>
@@ -1738,7 +1730,7 @@ function playAudio(url) {
<head>
<title><a href="cordova_media_media.md.html#Media">Media</a> Example</title>
- <script type="text/javascript" charset="utf-8" src="cordova-x.x.x.js"></script>
+ <script type="text/javascript" charset="utf-8" src="cordova.js"></script>
<script type="text/javascript" charset="utf-8">
// Wait for device API libraries to load
@@ -1899,7 +1891,7 @@ function recordAudio() {
<head>
<title><a href="cordova_device_device.md.html#Device">Device</a> Properties Example</title>
- <script type="text/javascript" charset="utf-8" src="cordova-x.x.x.js"></script>
+ <script type="text/javascript" charset="utf-8" src="cordova.js"></script>
<script type="text/javascript" charset="utf-8">
// Wait for device API libraries to load
@@ -1979,10 +1971,8 @@ function when an error occurs.</p>
</h2>
<ul>
-<li>
-<strong>code</strong>: One of the predefined error codes listed below.</li>
-<li>
-<strong>message</strong>: An error message describing the details of the error.</li>
+<li><p><strong>code</strong>: One of the predefined error codes listed below.</p></li>
+<li><p><strong>message</strong>: An error message describing the details of the error.</p></li>
</ul>
<h2>
<a name="MediaError_constants">Constants</a>
Modified: cordova/site/public/docs/en/edge/cordova_notification_notification.md.html
URL: http://svn.apache.org/viewvc/cordova/site/public/docs/en/edge/cordova_notification_notification.md.html?rev=1509456&r1=1509455&r2=1509456&view=diff
==============================================================================
--- cordova/site/public/docs/en/edge/cordova_notification_notification.md.html (original)
+++ cordova/site/public/docs/en/edge/cordova_notification_notification.md.html Thu Aug 1 22:17:43 2013
@@ -83,7 +83,7 @@
<h1>Notification</h1>
<small><select><option value="Notification">Notification</option>
<option value="Notification_methods">Â Â Â Â Â Â - Methods</option>
-<option value="Notification_permissions">Â Â Â Â Â Â - Permissions</option>
+<option value="Notification_accessing_the_feature">Â Â Â Â Â Â - Accessing the Feature</option>
<option value="notification.alert">notification.alert</option>
<option value="notification.alert_description">Â Â Â Â Â Â - Description</option>
<option value="notification.alert_supported_platforms">Â Â Â Â Â Â - Supported Platforms</option>
@@ -125,7 +125,6 @@
<li><a href="guide_overview_index.md.html#Overview">Overview</a></li>
<li><a href="guide_cli_index.md.html#The%20Command-line%20Interface">The Command-line Interface</a></li>
<li><a href="guide_platforms_index.md.html#Platform%20Guides">Platform Guides</a></li>
-<li><a href="index.md.html#Guides">Guides</a></li>
<li><a href="config_ref_index.md.html#Configuration%20Reference">Configuration Reference</a></li>
<li><a href="guide_hybrid_webviews_index.md.html#Embedding%20WebViews">Embedding WebViews</a></li>
<li><a href="guide_hybrid_plugins_index.md.html#Plugin%20Development%20Guide">Plugin Development Guide</a></li>
@@ -174,49 +173,60 @@
<li><code><a href="cordova_notification_notification.md.html#notification.vibrate">notification.vibrate</a></code></li>
</ul>
<h2>
-<a name="Notification_permissions">Permissions</a>
+<a name="Notification_accessing_the_feature">Accessing the Feature</a>
</h2>
-<h3>Android</h3>
+<p>As of version 3.0, Cordova implements device-level APIs as <em>plugins</em>.
+Use the CLI's <code>plugin</code> command, described in <a href="#The%20Command-line%0AInterface">The Command-line
+Interface</a>, to add or remove this feature for a project:</p>
-<h4>app/res/xml/config.xml</h4>
-
-<pre class="prettyprint"><code><plugin name="<a href="cordova_notification_notification.md.html#Notification">Notification</a>" value="org.apache.cordova.<a href="cordova_notification_notification.md.html#Notification">Notification</a>"/>
+<pre class="prettyprint"><code> $ 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
</code></pre>
-<h4>app/AndroidManifest.xml</h4>
-
-<pre class="prettyprint"><code><uses-permission android:name="android.permission.VIBRATE" />
-</code></pre>
+<p>These commands apply to all targeted platforms, but modify the
+platform-specific configuration settings described below:</p>
-<h3>BlackBerry WebWorks</h3>
-
-<h4>www/plugins.xml</h4>
+<ul>
+<li>
+<p>Android</p>
-<pre class="prettyprint"><code><plugin name="<a href="cordova_notification_notification.md.html#Notification">Notification</a>" value="org.apache.cordova.notification.<a href="cordova_notification_notification.md.html#Notification">Notification</a>" />
-</code></pre>
+<pre class="prettyprint"><code>(in app/res/xml/config.xml)
+<feature name="<a href="cordova_notification_notification.md.html#Notification">Notification</a>">
+ <param name="android-package" value="org.apache.cordova.<a href="cordova_notification_notification.md.html#Notification">Notification</a>" />
+</feature>
-<h4>www/config.xml</h4>
-<pre class="prettyprint"><code><feature id="blackberry.ui.dialog" />
+(in app/AndroidManifest.xml)
+<uses-permission android:name="android.permission.VIBRATE" />
</code></pre>
+</li>
+<li>
+<p>BlackBerry WebWorks</p>
-<h3>iOS</h3>
-
-<h4>config.xml</h4>
-
-<pre class="prettyprint"><code><plugin name="<a href="cordova_notification_notification.md.html#Notification">Notification</a>" value="CDVNotification" />
-</code></pre>
+<pre class="prettyprint"><code>(in www/plugins.xml)
+<feature name="<a href="cordova_notification_notification.md.html#Notification">Notification</a>">
+ <param name="blackberry-package" value="org.apache.cordova.notification.<a href="cordova_notification_notification.md.html#Notification">Notification</a>" />
+</feature>
-<h3>Windows Phone</h3>
-<pre class="prettyprint"><code>No permissions are required.
+(in www/config.xml)
+<feature id="blackberry.ui.dialog" />
</code></pre>
+</li>
+<li>
+<p>iOS (in <code>config.xml</code>)</p>
-<h3>Tizen</h3>
-
-<pre class="prettyprint"><code>No permissions are required.
+<pre class="prettyprint"><code><feature name="<a href="cordova_notification_notification.md.html#Notification">Notification</a>">
+ <param name="ios-package" value="CDVNotification" />
+</feature>
</code></pre>
+</li>
+</ul>
+<p>Some platforms may support this feature without requiring any special
+configuration. See Platform Support for an overview.</p>
<hr>
<h1><a name="notification.alert">notification.alert</a></h1>
@@ -227,16 +237,10 @@
</code></pre>
<ul>
-<li>
-<strong>message</strong>: Dialog message. <em>(String)</em>
-</li>
-<li>
-<strong>alertCallback</strong>: Callback to invoke when alert dialog is dismissed. <em>(Function)</em>
-</li>
-<li>
-<strong>title</strong>: Dialog title. <em>(String)</em> (Optional, defaults to <code>Alert</code>)</li>
-<li>
-<strong>buttonName</strong>: Button name. <em>(String)</em> (Optional, defaults to <code>OK</code>)</li>
+<li><p><strong>message</strong>: Dialog message. <em>(String)</em></p></li>
+<li><p><strong>alertCallback</strong>: Callback to invoke when alert dialog is dismissed. <em>(Function)</em></p></li>
+<li><p><strong>title</strong>: Dialog title. <em>(String)</em> (Optional, defaults to <code>Alert</code>)</p></li>
+<li><p><strong>buttonName</strong>: Button name. <em>(String)</em> (Optional, defaults to <code>OK</code>)</p></li>
</ul>
<h2>
<a name="notification.alert_description">Description</a>
@@ -285,7 +289,7 @@ navigator.<a href="cordova_notification_
<head>
<title><a href="cordova_notification_notification.md.html#Notification">Notification</a> Example</title>
- <script type="text/javascript" charset="utf-8" src="cordova-x.x.x.js"></script>
+ <script type="text/javascript" charset="utf-8" src="cordova.js"></script>
<script type="text/javascript" charset="utf-8">
// Wait for device API libraries to load
@@ -344,16 +348,10 @@ navigator.<a href="cordova_notification_
</code></pre>
<ul>
-<li>
-<strong>message</strong>: Dialog message. <em>(String)</em>
-</li>
-<li>
-<strong>confirmCallback</strong>: Callback to invoke with index of button pressed (1, 2, or 3) or when the dialog is dismissed without a button press (0). <em>(Function)</em>
-</li>
-<li>
-<strong>title</strong>: Dialog title. <em>(String)</em> (Optional, defaults to <code>Confirm</code>)</li>
-<li>
-<strong>buttonLabels</strong>: Comma-separated string specifying button labels. <em>(String)</em> (Optional, defaults to <code>OK,Cancel</code>)</li>
+<li><p><strong>message</strong>: Dialog message. <em>(String)</em></p></li>
+<li><p><strong>confirmCallback</strong>: Callback to invoke with index of button pressed (1, 2, or 3) or when the dialog is dismissed without a button press (0). <em>(Function)</em></p></li>
+<li><p><strong>title</strong>: Dialog title. <em>(String)</em> (Optional, defaults to <code>Confirm</code>)</p></li>
+<li><p><strong>buttonLabels</strong>: Comma-separated string specifying button labels. <em>(String)</em> (Optional, defaults to <code>OK,Cancel</code>)</p></li>
</ul>
<h2>
<a name="notification.confirm_description">Description</a>
@@ -415,7 +413,7 @@ function showConfirm() {
<head>
<title><a href="cordova_notification_notification.md.html#Notification">Notification</a> Example</title>
- <script type="text/javascript" charset="utf-8" src="cordova-x.x.x.js"></script>
+ <script type="text/javascript" charset="utf-8" src="cordova.js"></script>
<script type="text/javascript" charset="utf-8">
// Wait for device API libraries to load
@@ -474,18 +472,11 @@ function showConfirm() {
</code></pre>
<ul>
-<li>
-<strong>message</strong>: Dialog message. <em>(String)</em>
-</li>
-<li>
-<strong>promptCallback</strong>: Callback to invoke when a button is pressed. <em>(Function)</em>
-</li>
-<li>
-<strong>title</strong>: Dialog title <em>(String)</em> (Optional, defaults to <code>Prompt</code>)</li>
-<li>
-<strong>buttonLabels</strong>: Array of strings specifying button labels <em>(Array)</em> (Optional, defaults to <code>["OK","Cancel"]</code>)</li>
-<li>
-<strong>defaultText</strong>: Default textbox input value (<code>String</code>) (Optional, Default: "Default text")</li>
+<li><p><strong>message</strong>: Dialog message. <em>(String)</em></p></li>
+<li><p><strong>promptCallback</strong>: Callback to invoke when a button is pressed. <em>(Function)</em></p></li>
+<li><p><strong>title</strong>: Dialog title <em>(String)</em> (Optional, defaults to <code>Prompt</code>)</p></li>
+<li><p><strong>buttonLabels</strong>: Array of strings specifying button labels <em>(Array)</em> (Optional, defaults to <code>["OK","Cancel"]</code>)</p></li>
+<li><p><strong>defaultText</strong>: Default textbox input value (<code>String</code>) (Optional, Default: empty string)</p></li>
</ul>
<h2>
<a name="notification.prompt_description">Description</a>
@@ -503,11 +494,8 @@ in the prompt dialog box. The <code>resu
contains the following properties:</p>
<ul>
-<li>
-<strong>buttonIndex</strong>: The index of the pressed button. <em>(Number)</em> Note that the index uses one-based indexing, so the value is <code>1</code>, <code>2</code>, <code>3</code>, etc.</li>
-<li>
-<strong>input1</strong>: The text entered in the prompt dialog box. <em>(String)</em>
-</li>
+<li><p><strong>buttonIndex</strong>: The index of the pressed button. <em>(Number)</em> Note that the index uses one-based indexing, so the value is <code>1</code>, <code>2</code>, <code>3</code>, etc.</p></li>
+<li><p><strong>input1</strong>: The text entered in the prompt dialog box. <em>(String)</em></p></li>
</ul>
<h2>
<a name="notification.prompt_supported_platforms">Supported Platforms</a>
@@ -548,7 +536,7 @@ function showPrompt() {
<head>
<title><a href="cordova_notification_notification.md.html#Notification">Notification</a> Prompt Dialog Example</title>
- <script type="text/javascript" charset="utf-8" src="cordova-x.x.x.js"></script>
+ <script type="text/javascript" charset="utf-8" src="cordova.js"></script>
<script type="text/javascript" charset="utf-8">
// Wait for device API libraries to load
@@ -591,8 +579,8 @@ function showPrompt() {
</h2>
<ul>
-<li>Android supports a maximum of three buttons, and ignores any more than that.</li>
-<li>On Android 3.0 and later, buttons are displayed in reverse order for devices that use the Holo theme.</li>
+<li><p>Android supports a maximum of three buttons, and ignores any more than that.</p></li>
+<li><p>On Android 3.0 and later, buttons are displayed in reverse order for devices that use the Holo theme.</p></li>
</ul>
<hr>
<h1><a name="notification.beep">notification.beep</a></h1>
@@ -635,7 +623,7 @@ navigator.<a href="cordova_notification_
<head>
<title><a href="cordova_notification_notification.md.html#Notification">Notification</a> Example</title>
- <script type="text/javascript" charset="utf-8" src="cordova-x.x.x.js"></script>
+ <script type="text/javascript" charset="utf-8" src="cordova.js"></script>
<script type="text/javascript" charset="utf-8">
// Wait for device API libraries to load
@@ -699,8 +687,8 @@ navigator.<a href="cordova_notification_
</h2>
<ul>
-<li>Tizen implements beeps by playing an audio file via the media API.</li>
-<li>The beep file must be short, must be located in a <code>sounds</code> sub-directory of the application's root directory, and must be named <code>beep.wav</code>.</li>
+<li><p>Tizen implements beeps by playing an audio file via the media API.</p></li>
+<li><p>The beep file must be short, must be located in a <code>sounds</code> subdirectory of the application's root directory, and must be named <code>beep.wav</code>.</p></li>
</ul>
<hr>
<h1><a name="notification.vibrate">notification.vibrate</a></h1>
@@ -743,7 +731,7 @@ navigator.<a href="cordova_notification_
<head>
<title><a href="cordova_notification_notification.md.html#Notification">Notification</a> Example</title>
- <script type="text/javascript" charset="utf-8" src="cordova-x.x.x.js"></script>
+ <script type="text/javascript" charset="utf-8" src="cordova.js"></script>
<script type="text/javascript" charset="utf-8">
// Wait for device API libraries to load