You are viewing a plain text version of this content. The canonical link for it is here.
Posted to commits@cordova.apache.org by ag...@apache.org on 2013/12/18 16:40:09 UTC
svn commit: r1551982 [5/18] - in /cordova/site/public/docs/en: 3.0.0/ 3.3.0/
edge/
Modified: cordova/site/public/docs/en/3.3.0/cordova_globalization_globalization.md.html
URL: http://svn.apache.org/viewvc/cordova/site/public/docs/en/3.3.0/cordova_globalization_globalization.md.html?rev=1551982&r1=1551981&r2=1551982&view=diff
==============================================================================
--- cordova/site/public/docs/en/3.3.0/cordova_globalization_globalization.md.html (original)
+++ cordova/site/public/docs/en/3.3.0/cordova_globalization_globalization.md.html Wed Dec 18 15:40:06 2013
@@ -17,18 +17,16 @@
specific language governing permissions and limitations
under the License.
--><html lang="en">
- <head>
- <meta http-equiv="Content-Type" content="text/html; charset=utf-8">
- <meta name="viewport" content="initial-scale=1.0, maximum-scale=1.0, user-scalable=no, width=device-width">
- <meta name="generator" content="joDoc">
-
- <title>Apache Cordova API Documentation</title>
-
- <link rel="stylesheet" type="text/css" href="index.css">
- <link rel="stylesheet" type="text/css" href="mobile.css" media="only screen and (max-device-width: 1024px)">
- <link rel="stylesheet" type="text/css" href="prettify/prettify.css">
- </head>
- <body>
+<head>
+<meta http-equiv="Content-Type" content="text/html; charset=utf-8">
+<meta name="viewport" content="initial-scale=1.0, maximum-scale=1.0, user-scalable=no, width=device-width">
+<meta name="generator" content="joDoc">
+<title>Apache Cordova API Documentation</title>
+<link rel="stylesheet" type="text/css" href="index.css">
+<link rel="stylesheet" type="text/css" href="mobile.css" media="only screen and (max-device-width: 1024px)">
+<link rel="stylesheet" type="text/css" href="prettify/prettify.css">
+</head>
+<body>
<div id="header">
<h1><a href="index.html">Apache <strong>Cordova</strong> Documentation</a></h1>
<small>
@@ -94,8 +92,7 @@
<optgroup label="Spanish" value="es">
<option value="edge">edge</option>
<option value="3.1.0">3.1.0</option>
-</optgroup></select>
- </small>
+</optgroup></select></small>
</div>
<div id="subheader">
<h1>Globalization</h1>
@@ -223,13 +220,16 @@
<p>Obtains information and performs operations specific to the user's
locale and timezone.</p>
-<h2><a name="Globalization_objects">Objects</a></h2>
+<h2>
+<a name="Globalization_objects">Objects</a>
+</h2>
<ul>
<li><a href="cordova_globalization_globalization.md.html#GlobalizationError">GlobalizationError</a></li>
</ul>
-
-<h2><a name="Globalization_methods">Methods</a></h2>
+<h2>
+<a name="Globalization_methods">Methods</a>
+</h2>
<ul>
<li><a href="cordova_globalization_globalization.md.html#globalization.getPreferredLanguage">globalization.getPreferredLanguage</a></li>
@@ -245,8 +245,9 @@ locale and timezone.</p>
<li><a href="cordova_globalization_globalization.md.html#globalization.getNumberPattern">globalization.getNumberPattern</a></li>
<li><a href="cordova_globalization_globalization.md.html#globalization.getCurrencyPattern">globalization.getCurrencyPattern</a></li>
</ul>
-
-<h2><a name="Globalization_variable_scope">Variable Scope</a></h2>
+<h2>
+<a name="Globalization_variable_scope">Variable Scope</a>
+</h2>
<p>The <code>globalization</code> object is a child of the <code>navigator</code> object, and
therefore has global scope.</p>
@@ -255,7 +256,9 @@ therefore has global scope.</p>
var globalization = navigator.globalization;
</code></pre>
-<h2><a name="Globalization_accessing_the_feature">Accessing the Feature</a></h2>
+<h2>
+<a name="Globalization_accessing_the_feature">Accessing the Feature</a>
+</h2>
<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
@@ -288,12 +291,10 @@ platform-specific configuration settings
</code></pre>
</li>
</ul>
-
<p>Some platforms may support this feature without requiring any special
configuration. See <a href="guide_support_index.md.html#Platform%20Support">Platform Support</a> for an overview.</p>
<hr>
-
<h1><a name="globalization.getPreferredLanguage">globalization.getPreferredLanguage</a></h1>
<p>Get the string identifier for the client's current language.</p>
@@ -301,7 +302,9 @@ configuration. See <a href="guide_suppo
<pre class="prettyprint"><code>navigator.<a href="cordova_globalization_globalization.md.html#globalization.getPreferredLanguage">globalization.getPreferredLanguage</a>(successCallback, errorCallback);
</code></pre>
-<h2><a name="globalization.getPreferredLanguage_description">Description</a></h2>
+<h2>
+<a name="globalization.getPreferredLanguage_description">Description</a>
+</h2>
<p>Returns the language identifier string to the <code>successCallback</code> with a
<code>properties</code> object as a parameter. That object should have a <code>value</code>
@@ -311,7 +314,9 @@ property with a <code>String</code> valu
executes with a <code><a href="cordova_globalization_globalization.md.html#GlobalizationError">GlobalizationError</a></code> object as a parameter. The
error's expected code is <code><a href="cordova_globalization_globalization.md.html#GlobalizationError">GlobalizationError</a>.UNKNOWN\_ERROR</code>.</p>
-<h2><a name="globalization.getPreferredLanguage_supported_platforms">Supported Platforms</a></h2>
+<h2>
+<a name="globalization.getPreferredLanguage_supported_platforms">Supported Platforms</a>
+</h2>
<ul>
<li>Amazon Fire OS</li>
@@ -319,8 +324,9 @@ error's expected code is <code><a href="
<li>iOS</li>
<li>Windows Phone 8</li>
</ul>
-
-<h2><a name="globalization.getPreferredLanguage_quick_example">Quick Example</a></h2>
+<h2>
+<a name="globalization.getPreferredLanguage_quick_example">Quick Example</a>
+</h2>
<p>When the browser is set to the <code>en\_US</code> locale, this should display a
popup dialog with the text <code>language: English</code>:</p>
@@ -331,7 +337,9 @@ popup dialog with the text <code>languag
);
</code></pre>
-<h2><a name="globalization.getPreferredLanguage_full_example">Full Example</a></h2>
+<h2>
+<a name="globalization.getPreferredLanguage_full_example">Full Example</a>
+</h2>
<pre class="prettyprint"><code><!DOCTYPE HTML>
<html>
@@ -354,14 +362,14 @@ popup dialog with the text <code>languag
</html>
</code></pre>
-<h2><a name="globalization.getPreferredLanguage_windows_phone_8_quirks">Windows Phone 8 Quirks</a></h2>
+<h2>
+<a name="globalization.getPreferredLanguage_windows_phone_8_quirks">Windows Phone 8 Quirks</a>
+</h2>
<ul>
<li>Returns the ISO 639-1 two-letter code for the current language.</li>
</ul>
-
<hr>
-
<h1><a name="globalization.getLocaleName">globalization.getLocaleName</a></h1>
<p>Get the string identifier for the client's current locale setting.</p>
@@ -369,7 +377,9 @@ popup dialog with the text <code>languag
<pre class="prettyprint"><code>navigator.<a href="cordova_globalization_globalization.md.html#globalization.getLocaleName">globalization.getLocaleName</a>(successCallback, errorCallback);
</code></pre>
-<h2><a name="globalization.getLocaleName_description">Description</a></h2>
+<h2>
+<a name="globalization.getLocaleName_description">Description</a>
+</h2>
<p>Returns the locale identifier string to the <code>successCallback</code> with a
<code>properties</code> object as a parameter. That object should have a <code>value</code>
@@ -379,7 +389,9 @@ property with a <code>String</code> valu
executes with a <code><a href="cordova_globalization_globalization.md.html#GlobalizationError">GlobalizationError</a></code> object as a parameter. The
error's expected code is <code><a href="cordova_globalization_globalization.md.html#GlobalizationError">GlobalizationError</a>.UNKNOWN\_ERROR</code>.</p>
-<h2><a name="globalization.getLocaleName_supported_platforms">Supported Platforms</a></h2>
+<h2>
+<a name="globalization.getLocaleName_supported_platforms">Supported Platforms</a>
+</h2>
<ul>
<li>Amazon Fire OS</li>
@@ -387,8 +399,9 @@ error's expected code is <code><a href="
<li>iOS</li>
<li>Windows Phone 8</li>
</ul>
-
-<h2><a name="globalization.getLocaleName_quick_example">Quick Example</a></h2>
+<h2>
+<a name="globalization.getLocaleName_quick_example">Quick Example</a>
+</h2>
<p>When the browser is set to the <code>en\_US</code> locale, this displays a popup
dialog with the text <code>locale: en\_US</code>.</p>
@@ -399,7 +412,9 @@ dialog with the text <code>locale: en\_U
);
</code></pre>
-<h2><a name="globalization.getLocaleName_full_example">Full Example</a></h2>
+<h2>
+<a name="globalization.getLocaleName_full_example">Full Example</a>
+</h2>
<pre class="prettyprint"><code><!DOCTYPE HTML>
<html>
@@ -422,14 +437,14 @@ dialog with the text <code>locale: en\_U
</html>
</code></pre>
-<h2><a name="globalization.getLocaleName_windows_phone_8_quirks">Windows Phone 8 Quirks</a></h2>
+<h2>
+<a name="globalization.getLocaleName_windows_phone_8_quirks">Windows Phone 8 Quirks</a>
+</h2>
<ul>
<li>Returns the two-letter code defined in ISO 3166 for the current country/region.</li>
</ul>
-
<hr>
-
<h1><a name="globalization.dateToString">globalization.dateToString</a></h1>
<p>Returns a date formatted as a string according to the client's locale and timezone.</p>
@@ -437,7 +452,9 @@ dialog with the text <code>locale: en\_U
<pre class="prettyprint"><code>navigator.<a href="cordova_globalization_globalization.md.html#globalization.dateToString">globalization.dateToString</a>(date, successCallback, errorCallback, options);
</code></pre>
-<h2><a name="globalization.dateToString_description">Description</a></h2>
+<h2>
+<a name="globalization.dateToString_description">Description</a>
+</h2>
<p>Returns the formatted date <code>String</code> via a <code>value</code> property accessible
from the object passed as a parameter to the <code>successCallback</code>.</p>
@@ -457,7 +474,9 @@ error's expected code is <code><a href="
<p>The <code>options.selector</code> can be <code>date</code>, <code>time</code> or <code>date and time</code>.</p>
-<h2><a name="globalization.dateToString_supported_platforms">Supported Platforms</a></h2>
+<h2>
+<a name="globalization.dateToString_supported_platforms">Supported Platforms</a>
+</h2>
<ul>
<li>Amazon Fire OS</li>
@@ -465,8 +484,9 @@ error's expected code is <code><a href="
<li>iOS</li>
<li>Windows Phone 8</li>
</ul>
-
-<h2><a name="globalization.dateToString_quick_example">Quick Example</a></h2>
+<h2>
+<a name="globalization.dateToString_quick_example">Quick Example</a>
+</h2>
<p>If the browser is set to the <code>en\_US</code> locale, this displays a popup
dialog with text similar to <code>date: 9/25/2012 4:21PM</code> using the default
@@ -480,7 +500,9 @@ options:</p>
);
</code></pre>
-<h2><a name="globalization.dateToString_full_example">Full Example</a></h2>
+<h2>
+<a name="globalization.dateToString_full_example">Full Example</a>
+</h2>
<pre class="prettyprint"><code><!DOCTYPE HTML>
<html>
@@ -505,14 +527,14 @@ options:</p>
</html>
</code></pre>
-<h2><a name="globalization.dateToString_windows_phone_8_quirks">Windows Phone 8 Quirks</a></h2>
+<h2>
+<a name="globalization.dateToString_windows_phone_8_quirks">Windows Phone 8 Quirks</a>
+</h2>
<ul>
<li>The <code>formatLength</code> option supports only <code>short</code> and <code>full</code> values.</li>
</ul>
-
<hr>
-
<h1><a name="globalization.stringToDate">globalization.stringToDate</a></h1>
<p>Parses a date formatted as a string, according to the client's user
@@ -522,7 +544,9 @@ returns the corresponding date object.</
<pre class="prettyprint"><code>navigator.<a href="cordova_globalization_globalization.md.html#globalization.stringToDate">globalization.stringToDate</a>(dateString, successCallback, errorCallback, options);
</code></pre>
-<h2><a name="globalization.stringToDate_description">Description</a></h2>
+<h2>
+<a name="globalization.stringToDate_description">Description</a>
+</h2>
<p>Returns the date to the success callback with a <code>properties</code> object as
a parameter. That object should have the following properties:</p>
@@ -536,7 +560,6 @@ a parameter. That object should have the
<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>
<p>The <code>options</code> parameter is optional, and defaults to the following
@@ -553,7 +576,9 @@ time</code>.</p>
executes with a <code><a href="cordova_globalization_globalization.md.html#GlobalizationError">GlobalizationError</a></code> object as a parameter. The
error's expected code is <code><a href="cordova_globalization_globalization.md.html#GlobalizationError">GlobalizationError</a>.PARSING\_ERROR</code>.</p>
-<h2><a name="globalization.stringToDate_supported_platforms">Supported Platforms</a></h2>
+<h2>
+<a name="globalization.stringToDate_supported_platforms">Supported Platforms</a>
+</h2>
<ul>
<li>Amazon Fire OS</li>
@@ -561,8 +586,9 @@ error's expected code is <code><a href="
<li>iOS</li>
<li>Windows Phone 8</li>
</ul>
-
-<h2><a name="globalization.stringToDate_quick_example">Quick Example</a></h2>
+<h2>
+<a name="globalization.stringToDate_quick_example">Quick Example</a>
+</h2>
<p>When the browser is set to the <code>en\_US</code> locale, this displays a
popup dialog with text similar to <code>month:8 day:25 year:2012</code>. Note
@@ -579,7 +605,9 @@ integer represents an array index.</p>
);
</code></pre>
-<h2><a name="globalization.stringToDate_full_example">Full Example</a></h2>
+<h2>
+<a name="globalization.stringToDate_full_example">Full Example</a>
+</h2>
<pre class="prettyprint"><code><!DOCTYPE HTML>
<html>
@@ -607,14 +635,14 @@ integer represents an array index.</p>
</html>
</code></pre>
-<h2><a name="globalization.stringToDate_windows_phone_8_quirks">Windows Phone 8 Quirks</a></h2>
+<h2>
+<a name="globalization.stringToDate_windows_phone_8_quirks">Windows Phone 8 Quirks</a>
+</h2>
<ul>
<li>The <code>formatLength</code> option supports only <code>short</code> and <code>full</code> values.</li>
</ul>
-
<hr>
-
<h1><a name="globalization.getDatePattern">globalization.getDatePattern</a></h1>
<p>Returns a pattern string to format and parse dates according to the
@@ -623,7 +651,9 @@ client's user preferences.</p>
<pre class="prettyprint"><code>navigator.<a href="cordova_globalization_globalization.md.html#globalization.getDatePattern">globalization.getDatePattern</a>(successCallback, errorCallback, options);
</code></pre>
-<h2><a name="globalization.getDatePattern_description">Description</a></h2>
+<h2>
+<a name="globalization.getDatePattern_description">Description</a>
+</h2>
<p>Returns the pattern to the <code>successCallback</code>. The object passed in as
a parameter contains the following properties:</p>
@@ -634,7 +664,6 @@ a parameter contains the following prope
<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
error's expected code is <code><a href="cordova_globalization_globalization.md.html#GlobalizationError">GlobalizationError</a>.PATTERN\_ERROR</code>.</p>
@@ -648,7 +677,9 @@ error's expected code is <code><a href="
<code>full</code>. The <code>options.selector</code> can be <code>date</code>, <code>time</code> or <code>date and
time</code>.</p>
-<h2><a name="globalization.getDatePattern_supported_platforms">Supported Platforms</a></h2>
+<h2>
+<a name="globalization.getDatePattern_supported_platforms">Supported Platforms</a>
+</h2>
<ul>
<li>Amazon Fire OS</li>
@@ -656,8 +687,9 @@ time</code>.</p>
<li>iOS</li>
<li>Windows Phone 8</li>
</ul>
-
-<h2><a name="globalization.getDatePattern_quick_example">Quick Example</a></h2>
+<h2>
+<a name="globalization.getDatePattern_quick_example">Quick Example</a>
+</h2>
<p>When the browser is set to the <code>en\_US</code> locale, this example displays
a popup dialog with text such as <code>pattern: M/d/yyyy h:mm a</code>:</p>
@@ -671,7 +703,9 @@ a popup dialog with text such as <code>p
}
</code></pre>
-<h2><a name="globalization.getDatePattern_full_example">Full Example</a></h2>
+<h2>
+<a name="globalization.getDatePattern_full_example">Full Example</a>
+</h2>
<pre class="prettyprint"><code><!DOCTYPE HTML>
<html>
@@ -696,7 +730,9 @@ a popup dialog with text such as <code>p
</html>
</code></pre>
-<h2><a name="globalization.getDatePattern_windows_phone_8_quirks">Windows Phone 8 Quirks</a></h2>
+<h2>
+<a name="globalization.getDatePattern_windows_phone_8_quirks">Windows Phone 8 Quirks</a>
+</h2>
<ul>
<li><p>The <code>formatLength</code> supports only <code>short</code> and <code>full</code> values.</p></li>
@@ -704,9 +740,7 @@ a popup dialog with text such as <code>p
<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>
<p>Returns an array of the names of the months or days of the week,
@@ -715,7 +749,9 @@ depending on the client's user preferenc
<pre class="prettyprint"><code>navigator.<a href="cordova_globalization_globalization.md.html#globalization.getDateNames">globalization.getDateNames</a>(successCallback, errorCallback, options);
</code></pre>
-<h2><a name="globalization.getDateNames_description">Description</a></h2>
+<h2>
+<a name="globalization.getDateNames_description">Description</a>
+</h2>
<p>Returns the array of names to the <code>successCallback</code> with a
<code>properties</code> object as a parameter. That object contains a <code>value</code>
@@ -736,7 +772,9 @@ error's expected code is <code><a href="
<p>The value of <code>options.item</code> can be <code>months</code> or <code>days</code>.</p>
-<h2><a name="globalization.getDateNames_supported_platforms">Supported Platforms</a></h2>
+<h2>
+<a name="globalization.getDateNames_supported_platforms">Supported Platforms</a>
+</h2>
<ul>
<li>Amazon Fire OS</li>
@@ -744,8 +782,9 @@ error's expected code is <code><a href="
<li>iOS</li>
<li>Windows Phone 8</li>
</ul>
-
-<h2><a name="globalization.getDateNames_quick_example">Quick Example</a></h2>
+<h2>
+<a name="globalization.getDateNames_quick_example">Quick Example</a>
+</h2>
<p>When the browser is set to the <code>en\_US</code> locale, this example displays
a series of twelve popup dialogs, one per month, with text similar to
@@ -762,7 +801,9 @@ a series of twelve popup dialogs, one pe
);
</code></pre>
-<h2><a name="globalization.getDateNames_full_example">Full Example</a></h2>
+<h2>
+<a name="globalization.getDateNames_full_example">Full Example</a>
+</h2>
<pre class="prettyprint"><code><!DOCTYPE HTML>
<html>
@@ -792,7 +833,6 @@ a series of twelve popup dialogs, one pe
</code></pre>
<hr>
-
<h1><a name="globalization.isDayLightSavingsTime">globalization.isDayLightSavingsTime</a></h1>
<p>Indicates whether daylight savings time is in effect for a given date
@@ -801,7 +841,9 @@ using the client's time zone and calenda
<pre class="prettyprint"><code>navigator.<a href="cordova_globalization_globalization.md.html#globalization.isDayLightSavingsTime">globalization.isDayLightSavingsTime</a>(date, successCallback, errorCallback);
</code></pre>
-<h2><a name="globalization.isDayLightSavingsTime_description">Description</a></h2>
+<h2>
+<a name="globalization.isDayLightSavingsTime_description">Description</a>
+</h2>
<p>Indicates whether or not daylight savings time is in effect to the
<code>successCallback</code> with a <code>properties</code> object as a parameter. That object
@@ -814,7 +856,9 @@ and <code>false</code> indicates that it
<p>If there is an error reading the date, then the <code>errorCallback</code>
executes. The error's expected code is <code><a href="cordova_globalization_globalization.md.html#GlobalizationError">GlobalizationError</a>.UNKNOWN\_ERROR</code>.</p>
-<h2><a name="globalization.isDayLightSavingsTime_supported_platforms">Supported Platforms</a></h2>
+<h2>
+<a name="globalization.isDayLightSavingsTime_supported_platforms">Supported Platforms</a>
+</h2>
<ul>
<li>Amazon Fire OS</li>
@@ -822,8 +866,9 @@ executes. The error's expected code is <
<li>iOS</li>
<li>Windows Phone 8</li>
</ul>
-
-<h2><a name="globalization.isDayLightSavingsTime_quick_example">Quick Example</a></h2>
+<h2>
+<a name="globalization.isDayLightSavingsTime_quick_example">Quick Example</a>
+</h2>
<p>During the summer, and if the browser is set to a DST-enabled
timezone, this should display a popup dialog with text similar to
@@ -836,7 +881,9 @@ timezone, this should display a popup di
);
</code></pre>
-<h2><a name="globalization.isDayLightSavingsTime_full_example">Full Example</a></h2>
+<h2>
+<a name="globalization.isDayLightSavingsTime_full_example">Full Example</a>
+</h2>
<pre class="prettyprint"><code><!DOCTYPE HTML>
<html>
@@ -862,7 +909,6 @@ timezone, this should display a popup di
</code></pre>
<hr>
-
<h1><a name="globalization.getFirstDayOfWeek">globalization.getFirstDayOfWeek</a></h1>
<p>Returns the first day of the week according to the client's user
@@ -871,7 +917,9 @@ preferences and calendar.</p>
<pre class="prettyprint"><code>navigator.<a href="cordova_globalization_globalization.md.html#globalization.getFirstDayOfWeek">globalization.getFirstDayOfWeek</a>(successCallback, errorCallback);
</code></pre>
-<h2><a name="globalization.getFirstDayOfWeek_description">Description</a></h2>
+<h2>
+<a name="globalization.getFirstDayOfWeek_description">Description</a>
+</h2>
<p>The days of the week are numbered starting from 1, where 1 is assumed
to be Sunday. Returns the day to the <code>successCallback</code> with a
@@ -882,7 +930,9 @@ property with a <code>Number</code> valu
executes with a <code><a href="cordova_globalization_globalization.md.html#GlobalizationError">GlobalizationError</a></code> object as a parameter. The
error's expected code is <code><a href="cordova_globalization_globalization.md.html#GlobalizationError">GlobalizationError</a>.UNKNOWN\_ERROR</code>.</p>
-<h2><a name="globalization.getFirstDayOfWeek_supported_platforms">Supported Platforms</a></h2>
+<h2>
+<a name="globalization.getFirstDayOfWeek_supported_platforms">Supported Platforms</a>
+</h2>
<ul>
<li>Amazon Fire OS</li>
@@ -890,8 +940,9 @@ error's expected code is <code><a href="
<li>iOS</li>
<li>Windows Phone 8</li>
</ul>
-
-<h2><a name="globalization.getFirstDayOfWeek_quick_example">Quick Example</a></h2>
+<h2>
+<a name="globalization.getFirstDayOfWeek_quick_example">Quick Example</a>
+</h2>
<p>When the browser is set to the <code>en\_US</code> locale, this displays a
popup dialog with text similar to <code>day: 1</code>.</p>
@@ -902,7 +953,9 @@ popup dialog with text similar to <code>
);
</code></pre>
-<h2><a name="globalization.getFirstDayOfWeek_full_example">Full Example</a></h2>
+<h2>
+<a name="globalization.getFirstDayOfWeek_full_example">Full Example</a>
+</h2>
<pre class="prettyprint"><code><!DOCTYPE HTML>
<html>
@@ -927,7 +980,6 @@ popup dialog with text similar to <code>
</code></pre>
<hr>
-
<h1><a name="globalization.numberToString">globalization.numberToString</a></h1>
<p>Returns a number formatted as a string according to the client's user preferences.</p>
@@ -935,7 +987,9 @@ popup dialog with text similar to <code>
<pre class="prettyprint"><code>navigator.<a href="cordova_globalization_globalization.md.html#globalization.numberToString">globalization.numberToString</a>(number, successCallback, errorCallback, options);
</code></pre>
-<h2><a name="globalization.numberToString_description">Description</a></h2>
+<h2>
+<a name="globalization.numberToString_description">Description</a>
+</h2>
<p>Returns the formatted number string to the <code>successCallback</code> with a
<code>properties</code> object as a parameter. That object should have a <code>value</code>
@@ -952,7 +1006,9 @@ error's expected code is <code><a href="
<p>The <code>options.type</code> can be 'decimal', 'percent', or 'currency'.</p>
-<h2><a name="globalization.numberToString_supported_platforms">Supported Platforms</a></h2>
+<h2>
+<a name="globalization.numberToString_supported_platforms">Supported Platforms</a>
+</h2>
<ul>
<li>Amazon Fire OS</li>
@@ -960,8 +1016,9 @@ error's expected code is <code><a href="
<li>iOS</li>
<li>Windows Phone 8</li>
</ul>
-
-<h2><a name="globalization.numberToString_quick_example">Quick Example</a></h2>
+<h2>
+<a name="globalization.numberToString_quick_example">Quick Example</a>
+</h2>
<p>When the browser is set to the <code>en\_US</code> locale, this displays a popup
dialog with text similar to <code>number: 3.142</code>:</p>
@@ -974,7 +1031,9 @@ dialog with text similar to <code>number
);
</code></pre>
-<h2><a name="globalization.numberToString_full_example">Full Example</a></h2>
+<h2>
+<a name="globalization.numberToString_full_example">Full Example</a>
+</h2>
<pre class="prettyprint"><code><!DOCTYPE HTML>
<html>
@@ -1001,7 +1060,6 @@ dialog with text similar to <code>number
</code></pre>
<hr>
-
<h1><a name="globalization.stringToNumber">globalization.stringToNumber</a></h1>
<p>Parses a number formatted as a string according to the client's user
@@ -1010,7 +1068,9 @@ preferences and returns the correspondin
<pre class="prettyprint"><code>navigator.<a href="cordova_globalization_globalization.md.html#globalization.stringToNumber">globalization.stringToNumber</a>(string, successCallback, errorCallback, options);
</code></pre>
-<h2><a name="globalization.stringToNumber_description">Description</a></h2>
+<h2>
+<a name="globalization.stringToNumber_description">Description</a>
+</h2>
<p>Returns the number to the <code>successCallback</code> with a <code>properties</code> object
as a parameter. That object should have a <code>value</code> property with a
@@ -1029,7 +1089,9 @@ values:</p>
<p>The <code>options.type</code> can be <code>decimal</code>, <code>percent</code>, or <code>currency</code>.</p>
-<h2><a name="globalization.stringToNumber_supported_platforms">Supported Platforms</a></h2>
+<h2>
+<a name="globalization.stringToNumber_supported_platforms">Supported Platforms</a>
+</h2>
<ul>
<li>Amazon Fire OS</li>
@@ -1037,8 +1099,9 @@ values:</p>
<li>iOS</li>
<li>Windows Phone 8</li>
</ul>
-
-<h2><a name="globalization.stringToNumber_quick_example">Quick Example</a></h2>
+<h2>
+<a name="globalization.stringToNumber_quick_example">Quick Example</a>
+</h2>
<p>When the browser is set to the <code>en\_US</code> locale, this should display a
popup dialog with text similar to <code>number: 1234.56</code>:</p>
@@ -1051,7 +1114,9 @@ popup dialog with text similar to <code>
);
</code></pre>
-<h2><a name="globalization.stringToNumber_full_example">Full Example</a></h2>
+<h2>
+<a name="globalization.stringToNumber_full_example">Full Example</a>
+</h2>
<pre class="prettyprint"><code><!DOCTYPE HTML>
<html>
@@ -1078,7 +1143,6 @@ popup dialog with text similar to <code>
</code></pre>
<hr>
-
<h1><a name="globalization.getNumberPattern">globalization.getNumberPattern</a></h1>
<p>Returns a pattern string to format and parse numbers according to the client's user preferences.</p>
@@ -1086,7 +1150,9 @@ popup dialog with text similar to <code>
<pre class="prettyprint"><code>navigator.<a href="cordova_globalization_globalization.md.html#globalization.getNumberPattern">globalization.getNumberPattern</a>(successCallback, errorCallback, options);
</code></pre>
-<h2><a name="globalization.getNumberPattern_description">Description</a></h2>
+<h2>
+<a name="globalization.getNumberPattern_description">Description</a>
+</h2>
<p>Returns the pattern to the <code>successCallback</code> with a <code>properties</code> object
as a parameter. That object contains the following properties:</p>
@@ -1101,7 +1167,6 @@ as a parameter. That object contains the
<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
error's expected code is <code><a href="cordova_globalization_globalization.md.html#GlobalizationError">GlobalizationError</a>.PATTERN\_ERROR</code>.</p>
@@ -1113,7 +1178,9 @@ error's expected code is <code><a href="
<p>The <code>options.type</code> can be <code>decimal</code>, <code>percent</code>, or <code>currency</code>.</p>
-<h2><a name="globalization.getNumberPattern_supported_platforms">Supported Platforms</a></h2>
+<h2>
+<a name="globalization.getNumberPattern_supported_platforms">Supported Platforms</a>
+</h2>
<ul>
<li>Amazon Fire OS</li>
@@ -1121,8 +1188,9 @@ error's expected code is <code><a href="
<li>iOS</li>
<li>Windows Phone 8</li>
</ul>
-
-<h2><a name="globalization.getNumberPattern_quick_example">Quick Example</a></h2>
+<h2>
+<a name="globalization.getNumberPattern_quick_example">Quick Example</a>
+</h2>
<p>When the browser is set to the <code>en\_US</code> locale, this should display a
popup dialog with text similar to the results that follow:</p>
@@ -1153,7 +1221,9 @@ decimal: .
grouping: ,
</code></pre>
-<h2><a name="globalization.getNumberPattern_full_example">Full Example</a></h2>
+<h2>
+<a name="globalization.getNumberPattern_full_example">Full Example</a>
+</h2>
<pre class="prettyprint"><code><!DOCTYPE HTML>
<html>
@@ -1185,15 +1255,15 @@ grouping: ,
</html>
</code></pre>
-<h2><a name="globalization.getNumberPattern_windows_phone_8_quirks">Windows Phone 8 Quirks</a></h2>
+<h2>
+<a name="globalization.getNumberPattern_windows_phone_8_quirks">Windows Phone 8 Quirks</a>
+</h2>
<ul>
<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>
<p>Returns a pattern string to format and parse currency values according
@@ -1202,7 +1272,9 @@ to the client's user preferences and ISO
<pre class="prettyprint"><code> navigator.<a href="cordova_globalization_globalization.md.html#globalization.getCurrencyPattern">globalization.getCurrencyPattern</a>(currencyCode, successCallback, errorCallback);
</code></pre>
-<h2><a name="globalization.getCurrencyPattern_description">Description</a></h2>
+<h2>
+<a name="globalization.getCurrencyPattern_description">Description</a>
+</h2>
<p>Returns the pattern to the <code>successCallback</code> with a <code>properties</code> object
as a parameter. That object should contain the following properties:</p>
@@ -1215,7 +1287,6 @@ as a parameter. That object should conta
<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>
@@ -1223,15 +1294,18 @@ the ISO 4217 currency codes, for example
executes with a <code><a href="cordova_globalization_globalization.md.html#GlobalizationError">GlobalizationError</a></code> object as a parameter. The
error's expected code is <code><a href="cordova_globalization_globalization.md.html#GlobalizationError">GlobalizationError</a>.FORMATTING\_ERROR</code>.</p>
-<h2><a name="globalization.getCurrencyPattern_supported_platforms">Supported Platforms</a></h2>
+<h2>
+<a name="globalization.getCurrencyPattern_supported_platforms">Supported Platforms</a>
+</h2>
<ul>
<li>Amazon Fire OS</li>
<li>Android</li>
<li>iOS</li>
</ul>
-
-<h2><a name="globalization.getCurrencyPattern_quick_example">Quick Example</a></h2>
+<h2>
+<a name="globalization.getCurrencyPattern_quick_example">Quick Example</a>
+</h2>
<p>When the browser is set to the <code>en\_US</code> locale and the selected
currency is United States Dollars, this example displays a popup
@@ -1261,7 +1335,9 @@ decimal: .
grouping: ,
</code></pre>
-<h2><a name="globalization.getCurrencyPattern_full_example">Full Example</a></h2>
+<h2>
+<a name="globalization.getCurrencyPattern_full_example">Full Example</a>
+</h2>
<pre class="prettyprint"><code><!DOCTYPE HTML>
<html>
@@ -1292,12 +1368,13 @@ grouping: ,
</code></pre>
<hr>
-
<h1><a name="GlobalizationError">GlobalizationError</a></h1>
<p>An object representing a error from the <a href="cordova_globalization_globalization.md.html#Globalization">Globalization</a> API.</p>
-<h2><a name="GlobalizationError_properties">Properties</a></h2>
+<h2>
+<a name="GlobalizationError_properties">Properties</a>
+</h2>
<ul>
<li>
@@ -1317,20 +1394,24 @@ grouping: ,
<strong>message</strong>: A text message that includes the error's explanation and/or details <em>(String)</em>
</li>
</ul>
-
-<h2><a name="GlobalizationError_description">Description</a></h2>
+<h2>
+<a name="GlobalizationError_description">Description</a>
+</h2>
<p>This object is created and populated by Cordova, and returned to a callback in the case of an error.</p>
-<h2><a name="GlobalizationError_supported_platforms">Supported Platforms</a></h2>
+<h2>
+<a name="GlobalizationError_supported_platforms">Supported Platforms</a>
+</h2>
<ul>
<li>Amazon Fire OS</li>
<li>Android</li>
<li>iOS</li>
</ul>
-
-<h2><a name="GlobalizationError_quick_example">Quick Example</a></h2>
+<h2>
+<a name="GlobalizationError_quick_example">Quick Example</a>
+</h2>
<p>When the following error callback executes, it displays a
popup dialog with the text similar to <code>code: 3</code> and <code>message:</code></p>
@@ -1341,7 +1422,9 @@ popup dialog with the text similar to <c
};
</code></pre>
-<h2><a name="GlobalizationError_full_example">Full Example</a></h2>
+<h2>
+<a name="GlobalizationError_full_example">Full Example</a>
+</h2>
<pre class="prettyprint"><code><!DOCTYPE HTML>
<html>
@@ -1382,7 +1465,6 @@ popup dialog with the text similar to <c
</div>
<!-- Functionality and Syntax Highlighting -->
- <script type="text/javascript" src="index.js"></script>
- <script type="text/javascript" src="prettify/prettify.js"></script>
- </body>
+ <script type="text/javascript" src="index.js"></script><script type="text/javascript" src="prettify/prettify.js"></script>
+</body>
</html>
Modified: cordova/site/public/docs/en/3.3.0/cordova_inappbrowser_inappbrowser.md.html
URL: http://svn.apache.org/viewvc/cordova/site/public/docs/en/3.3.0/cordova_inappbrowser_inappbrowser.md.html?rev=1551982&r1=1551981&r2=1551982&view=diff
==============================================================================
--- cordova/site/public/docs/en/3.3.0/cordova_inappbrowser_inappbrowser.md.html (original)
+++ cordova/site/public/docs/en/3.3.0/cordova_inappbrowser_inappbrowser.md.html Wed Dec 18 15:40:06 2013
@@ -17,18 +17,16 @@
specific language governing permissions and limitations
under the License.
--><html lang="en">
- <head>
- <meta http-equiv="Content-Type" content="text/html; charset=utf-8">
- <meta name="viewport" content="initial-scale=1.0, maximum-scale=1.0, user-scalable=no, width=device-width">
- <meta name="generator" content="joDoc">
-
- <title>Apache Cordova API Documentation</title>
-
- <link rel="stylesheet" type="text/css" href="index.css">
- <link rel="stylesheet" type="text/css" href="mobile.css" media="only screen and (max-device-width: 1024px)">
- <link rel="stylesheet" type="text/css" href="prettify/prettify.css">
- </head>
- <body>
+<head>
+<meta http-equiv="Content-Type" content="text/html; charset=utf-8">
+<meta name="viewport" content="initial-scale=1.0, maximum-scale=1.0, user-scalable=no, width=device-width">
+<meta name="generator" content="joDoc">
+<title>Apache Cordova API Documentation</title>
+<link rel="stylesheet" type="text/css" href="index.css">
+<link rel="stylesheet" type="text/css" href="mobile.css" media="only screen and (max-device-width: 1024px)">
+<link rel="stylesheet" type="text/css" href="prettify/prettify.css">
+</head>
+<body>
<div id="header">
<h1><a href="index.html">Apache <strong>Cordova</strong> Documentation</a></h1>
<small>
@@ -94,8 +92,7 @@
<optgroup label="Spanish" value="es">
<option value="edge">edge</option>
<option value="3.1.0">3.1.0</option>
-</optgroup></select>
- </small>
+</optgroup></select></small>
</div>
<div id="subheader">
<h1>InAppBrowser</h1>
@@ -187,11 +184,15 @@
<p><strong>NOTE</strong>: The <a href="cordova_inappbrowser_inappbrowser.md.html#InAppBrowser">InAppBrowser</a> window behaves like a standard web browser,
and can't access Cordova APIs.</p>
-<h2><a name="InAppBrowser_description">Description</a></h2>
+<h2>
+<a name="InAppBrowser_description">Description</a>
+</h2>
<p>The object returned from a call to <code><a href="cordova_inappbrowser_inappbrowser.md.html#window.open">window.open</a></code>.</p>
-<h2><a name="InAppBrowser_methods">Methods</a></h2>
+<h2>
+<a name="InAppBrowser_methods">Methods</a>
+</h2>
<ul>
<li><a href="cordova_inappbrowser_inappbrowser.md.html#addEventListener">addEventListener</a></li>
@@ -201,8 +202,9 @@ and can't access Cordova APIs.</p>
<li><a href="cordova_inappbrowser_inappbrowser.md.html#executeScript">executeScript</a></li>
<li><a href="cordova_inappbrowser_inappbrowser.md.html#insertCSS">insertCSS</a></li>
</ul>
-
-<h2><a name="InAppBrowser_accessing_the_feature">Accessing the Feature</a></h2>
+<h2>
+<a name="InAppBrowser_accessing_the_feature">Accessing the Feature</a>
+</h2>
<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
@@ -249,7 +251,6 @@ platform-specific configuration settings
</code></pre>
</li>
</ul>
-
<p>Some platforms may support this feature without requiring any special
configuration. See <a href="guide_support_index.md.html#Platform%20Support">Platform Support</a> for an overview.</p>
@@ -280,8 +281,9 @@ configuration. See <a href="guide_suppo
</li>
<li><p><strong>callback</strong>: the function that executes when the event fires. The function is passed an <code><a href="cordova_inappbrowser_inappbrowser.md.html#InAppBrowserEvent">InAppBrowserEvent</a></code> object as a parameter.</p></li>
</ul>
-
-<h2><a name="addEventListener_supported_platforms">Supported Platforms</a></h2>
+<h2>
+<a name="addEventListener_supported_platforms">Supported Platforms</a>
+</h2>
<ul>
<li>Amazon Fire OS</li>
@@ -290,14 +292,17 @@ configuration. See <a href="guide_suppo
<li>iOS</li>
<li>Windows Phone 7 and 8</li>
</ul>
-
-<h2><a name="addEventListener_quick_example">Quick Example</a></h2>
+<h2>
+<a name="addEventListener_quick_example">Quick Example</a>
+</h2>
<pre class="prettyprint"><code>var ref = <a href="cordova_inappbrowser_inappbrowser.md.html#window.open">window.open</a>('http://apache.org', '_blank', 'location=yes');
ref.<a href="cordova_inappbrowser_inappbrowser.md.html#addEventListener">addEventListener</a>('loadstart', function() { alert(event.url); });
</code></pre>
-<h2><a name="addEventListener_full_example">Full Example</a></h2>
+<h2>
+<a name="addEventListener_full_example">Full Example</a>
+</h2>
<pre class="prettyprint"><code><!DOCTYPE html>
<html>
@@ -356,8 +361,9 @@ ref.<a href="cordova_inappbrowser_inappb
<li><p><strong>callback</strong>: the function to execute when the event fires.
The function is passed an <code><a href="cordova_inappbrowser_inappbrowser.md.html#InAppBrowserEvent">InAppBrowserEvent</a></code> object.</p></li>
</ul>
-
-<h2><a name="removeEventListener_supported_platforms">Supported Platforms</a></h2>
+<h2>
+<a name="removeEventListener_supported_platforms">Supported Platforms</a>
+</h2>
<ul>
<li>Amazon Fire OS</li>
@@ -366,8 +372,9 @@ The function is passed an <code><a href=
<li>iOS</li>
<li>Windows Phone 7 and 8</li>
</ul>
-
-<h2><a name="removeEventListener_quick_example">Quick Example</a></h2>
+<h2>
+<a name="removeEventListener_quick_example">Quick Example</a>
+</h2>
<pre class="prettyprint"><code>var ref = <a href="cordova_inappbrowser_inappbrowser.md.html#window.open">window.open</a>('http://apache.org', '_blank', 'location=yes');
var myCallback = function() { alert(event.url); }
@@ -375,7 +382,9 @@ ref.<a href="cordova_inappbrowser_inappb
ref.<a href="cordova_inappbrowser_inappbrowser.md.html#removeEventListener">removeEventListener</a>('loadstart', myCallback);
</code></pre>
-<h2><a name="removeEventListener_full_example">Full Example</a></h2>
+<h2>
+<a name="removeEventListener_full_example">Full Example</a>
+</h2>
<pre class="prettyprint"><code><!DOCTYPE html>
<html>
@@ -443,8 +452,9 @@ ref.<a href="cordova_inappbrowser_inappb
<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>
</ul>
-
-<h2><a name="close_supported_platforms">Supported Platforms</a></h2>
+<h2>
+<a name="close_supported_platforms">Supported Platforms</a>
+</h2>
<ul>
<li>Amazon Fire OS</li>
@@ -453,14 +463,17 @@ ref.<a href="cordova_inappbrowser_inappb
<li>iOS</li>
<li>Windows Phone 7 and 8</li>
</ul>
-
-<h2><a name="close_quick_example">Quick Example</a></h2>
+<h2>
+<a name="close_quick_example">Quick Example</a>
+</h2>
<pre class="prettyprint"><code>var ref = <a href="cordova_inappbrowser_inappbrowser.md.html#window.open">window.open</a>('http://apache.org', '_blank', 'location=yes');
ref.<a href="cordova_inappbrowser_inappbrowser.md.html#close">close</a>();
</code></pre>
-<h2><a name="close_full_example">Full Example</a></h2>
+<h2>
+<a name="close_full_example">Full Example</a>
+</h2>
<pre class="prettyprint"><code><!DOCTYPE html>
<html>
@@ -504,8 +517,9 @@ ref.<a href="cordova_inappbrowser_inappb
<li>
<strong>ref</strong>: reference to the <a href="cordova_inappbrowser_inappbrowser.md.html#InAppBrowser">InAppBrowser</a> window (<code><a href="cordova_inappbrowser_inappbrowser.md.html#InAppBrowser">InAppBrowser</a></code>)</li>
</ul>
-
-<h2><a name="show_supported_platforms">Supported Platforms</a></h2>
+<h2>
+<a name="show_supported_platforms">Supported Platforms</a>
+</h2>
<ul>
<li>Amazon Fire OS</li>
@@ -513,14 +527,17 @@ ref.<a href="cordova_inappbrowser_inappb
<li>BlackBerry 10</li>
<li>iOS</li>
</ul>
-
-<h2><a name="show_quick_example">Quick Example</a></h2>
+<h2>
+<a name="show_quick_example">Quick Example</a>
+</h2>
<pre class="prettyprint"><code>var ref = <a href="cordova_inappbrowser_inappbrowser.md.html#window.open">window.open</a>('http://apache.org', '_blank', 'hidden=yes');
ref.<a href="cordova_inappbrowser_inappbrowser.md.html#show">show</a>();
</code></pre>
-<h2><a name="show_full_example">Full Example</a></h2>
+<h2>
+<a name="show_full_example">Full Example</a>
+</h2>
<pre class="prettyprint"><code><!DOCTYPE html>
<html>
@@ -587,8 +604,9 @@ evaluated.</li>
</ul>
</li>
</ul>
-
-<h2><a name="executeScript_supported_platforms">Supported Platforms</a></h2>
+<h2>
+<a name="executeScript_supported_platforms">Supported Platforms</a>
+</h2>
<ul>
<li>Amazon Fire OS</li>
@@ -596,8 +614,9 @@ evaluated.</li>
<li>BlackBerry 10</li>
<li>iOS</li>
</ul>
-
-<h2><a name="executeScript_quick_example">Quick Example</a></h2>
+<h2>
+<a name="executeScript_quick_example">Quick Example</a>
+</h2>
<pre class="prettyprint"><code>var ref = <a href="cordova_inappbrowser_inappbrowser.md.html#window.open">window.open</a>('http://apache.org', '_blank', 'location=yes');
ref.<a href="cordova_inappbrowser_inappbrowser.md.html#addEventListener">addEventListener</a>('loadstop', function() {
@@ -605,7 +624,9 @@ ref.<a href="cordova_inappbrowser_inappb
});
</code></pre>
-<h2><a name="executeScript_full_example">Full Example</a></h2>
+<h2>
+<a name="executeScript_full_example">Full Example</a>
+</h2>
<pre class="prettyprint"><code><!DOCTYPE html>
<html>
@@ -675,8 +696,9 @@ ref.<a href="cordova_inappbrowser_inappb
</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></h2>
+<h2>
+<a name="insertCSS_supported_platforms">Supported Platforms</a>
+</h2>
<ul>
<li>Amazon Fire OS</li>
@@ -684,8 +706,9 @@ ref.<a href="cordova_inappbrowser_inappb
<li>BlackBerry 10</li>
<li>iOS</li>
</ul>
-
-<h2><a name="insertCSS_quick_example">Quick Example</a></h2>
+<h2>
+<a name="insertCSS_quick_example">Quick Example</a>
+</h2>
<pre class="prettyprint"><code>var ref = <a href="cordova_inappbrowser_inappbrowser.md.html#window.open">window.open</a>('http://apache.org', '_blank', 'location=yes');
ref.<a href="cordova_inappbrowser_inappbrowser.md.html#addEventListener">addEventListener</a>('loadstop', function() {
@@ -693,7 +716,9 @@ ref.<a href="cordova_inappbrowser_inappb
});
</code></pre>
-<h2><a name="insertCSS_full_example">Full Example</a></h2>
+<h2>
+<a name="insertCSS_full_example">Full Example</a>
+</h2>
<pre class="prettyprint"><code><!DOCTYPE html>
<html>
@@ -745,7 +770,9 @@ ref.<a href="cordova_inappbrowser_inappb
<p>The object that is passed to the callback function from an
<code><a href="cordova_inappbrowser_inappbrowser.md.html#addEventListener">addEventListener</a></code> call on an <code><a href="cordova_inappbrowser_inappbrowser.md.html#InAppBrowser">InAppBrowser</a></code> object.</p>
-<h2><a name="InAppBrowserEvent_properties">Properties</a></h2>
+<h2>
+<a name="InAppBrowserEvent_properties">Properties</a>
+</h2>
<ul>
<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>
@@ -753,9 +780,7 @@ ref.<a href="cordova_inappbrowser_inappb
<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>
<p>Opens a URL in a new <code><a href="cordova_inappbrowser_inappbrowser.md.html#InAppBrowser">InAppBrowser</a></code> instance, the current browser
@@ -788,7 +813,6 @@ instance, or the system browser.</p>
<li>
<strong>location</strong>: Set to <code>yes</code> or <code>no</code> to turn the <code><a href="cordova_inappbrowser_inappbrowser.md.html#InAppBrowser">InAppBrowser</a></code>'s location bar on or off.</li>
</ul>
-
<p>Android only:</p>
<ul>
@@ -801,7 +825,6 @@ instance, or the system browser.</p>
<li>
<strong>clearsessioncache</strong>: set to <code>yes</code> to have the session cookie cache cleared before the new window is opened</li>
</ul>
-
<p>iOS only:</p>
<ul>
@@ -828,8 +851,9 @@ instance, or the system browser.</p>
</ul>
</li>
</ul>
-
-<h2><a name="window.open_supported_platforms">Supported Platforms</a></h2>
+<h2>
+<a name="window.open_supported_platforms">Supported Platforms</a>
+</h2>
<ul>
<li>Amazon Fire OS</li>
@@ -838,14 +862,17 @@ instance, or the system browser.</p>
<li>iOS</li>
<li>Windows Phone 7 and 8</li>
</ul>
-
-<h2><a name="window.open_quick_example">Quick Example</a></h2>
+<h2>
+<a name="window.open_quick_example">Quick Example</a>
+</h2>
<pre class="prettyprint"><code>var ref = <a href="cordova_inappbrowser_inappbrowser.md.html#window.open">window.open</a>('http://apache.org', '_blank', 'location=yes');
var ref2 = <a href="cordova_inappbrowser_inappbrowser.md.html#window.open">window.open</a>(encodeURI('http://ja.m.wikipedia.org/wiki/ãã³ã°ã«'), '_blank', 'location=yes');
</code></pre>
-<h2><a name="window.open_full_example">Full Example</a></h2>
+<h2>
+<a name="window.open_full_example">Full Example</a>
+</h2>
<pre class="prettyprint"><code><!DOCTYPE html>
<html>
@@ -879,7 +906,6 @@ var ref2 = <a href="cordova_inappbrowser
</div>
<!-- Functionality and Syntax Highlighting -->
- <script type="text/javascript" src="index.js"></script>
- <script type="text/javascript" src="prettify/prettify.js"></script>
- </body>
+ <script type="text/javascript" src="index.js"></script><script type="text/javascript" src="prettify/prettify.js"></script>
+</body>
</html>
Modified: cordova/site/public/docs/en/3.3.0/cordova_media_capture_capture.md.html
URL: http://svn.apache.org/viewvc/cordova/site/public/docs/en/3.3.0/cordova_media_capture_capture.md.html?rev=1551982&r1=1551981&r2=1551982&view=diff
==============================================================================
--- cordova/site/public/docs/en/3.3.0/cordova_media_capture_capture.md.html (original)
+++ cordova/site/public/docs/en/3.3.0/cordova_media_capture_capture.md.html Wed Dec 18 15:40:06 2013
@@ -17,18 +17,16 @@
specific language governing permissions and limitations
under the License.
--><html lang="en">
- <head>
- <meta http-equiv="Content-Type" content="text/html; charset=utf-8">
- <meta name="viewport" content="initial-scale=1.0, maximum-scale=1.0, user-scalable=no, width=device-width">
- <meta name="generator" content="joDoc">
-
- <title>Apache Cordova API Documentation</title>
-
- <link rel="stylesheet" type="text/css" href="index.css">
- <link rel="stylesheet" type="text/css" href="mobile.css" media="only screen and (max-device-width: 1024px)">
- <link rel="stylesheet" type="text/css" href="prettify/prettify.css">
- </head>
- <body>
+<head>
+<meta http-equiv="Content-Type" content="text/html; charset=utf-8">
+<meta name="viewport" content="initial-scale=1.0, maximum-scale=1.0, user-scalable=no, width=device-width">
+<meta name="generator" content="joDoc">
+<title>Apache Cordova API Documentation</title>
+<link rel="stylesheet" type="text/css" href="index.css">
+<link rel="stylesheet" type="text/css" href="mobile.css" media="only screen and (max-device-width: 1024px)">
+<link rel="stylesheet" type="text/css" href="prettify/prettify.css">
+</head>
+<body>
<div id="header">
<h1><a href="index.html">Apache <strong>Cordova</strong> Documentation</a></h1>
<small>
@@ -94,8 +92,7 @@
<optgroup label="Spanish" value="es">
<option value="edge">edge</option>
<option value="3.1.0">3.1.0</option>
-</optgroup></select>
- </small>
+</optgroup></select></small>
</div>
<div id="subheader">
<h1>Capture</h1>
@@ -235,7 +232,9 @@ provide just-in-time notice and obtain p
to accessing the camera or microphone. For more information, please
see the <a href="guide_appdev_privacy_index.md.html#Privacy%20Guide">Privacy Guide</a>.</p>
-<h2><a name="Capture_objects">Objects</a></h2>
+<h2>
+<a name="Capture_objects">Objects</a>
+</h2>
<ul>
<li><a href="cordova_media_capture_capture.md.html#Capture">Capture</a></li>
@@ -248,8 +247,9 @@ see the <a href="guide_appdev_privacy_in
<li><a href="cordova_media_capture_capture.md.html#MediaFile">MediaFile</a></li>
<li><a href="cordova_media_capture_capture.md.html#MediaFileData">MediaFileData</a></li>
</ul>
-
-<h2><a name="Capture_methods">Methods</a></h2>
+<h2>
+<a name="Capture_methods">Methods</a>
+</h2>
<ul>
<li><a href="cordova_media_capture_capture.md.html#capture.captureAudio">capture.captureAudio</a></li>
@@ -257,8 +257,9 @@ see the <a href="guide_appdev_privacy_in
<li><a href="cordova_media_capture_capture.md.html#capture.captureVideo">capture.captureVideo</a></li>
<li><a href="cordova_media_capture_capture.md.html#MediaFile.getFormatData">MediaFile.getFormatData</a></li>
</ul>
-
-<h2><a name="Capture_scope">Scope</a></h2>
+<h2>
+<a name="Capture_scope">Scope</a>
+</h2>
<p>The <code>capture</code> object is assigned to the <code>navigator.device</code> object, and
therefore has global scope.</p>
@@ -267,23 +268,27 @@ therefore has global scope.</p>
var capture = navigator.device.capture;
</code></pre>
-<h2><a name="Capture_properties">Properties</a></h2>
+<h2>
+<a name="Capture_properties">Properties</a>
+</h2>
<ul>
<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>
+<h2>
+<a name="Capture_methods">Methods</a>
+</h2>
<ul>
<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></h2>
+<h2>
+<a name="Capture_supported_platforms">Supported Platforms</a>
+</h2>
<ul>
<li>Amazon Fire OS</li>
@@ -293,8 +298,9 @@ var capture = navigator.device.capture;
<li>Windows Phone 7 and 8</li>
<li>Windows 8</li>
</ul>
-
-<h2><a name="Capture_accessing_the_feature">Accessing the Feature</a></h2>
+<h2>
+<a name="Capture_accessing_the_feature">Accessing the Feature</a>
+</h2>
<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
@@ -382,12 +388,10 @@ platform-specific configuration settings
</code></pre>
</li>
</ul>
-
<p>Some platforms may support this feature without requiring any special
configuration. See <a href="guide_support_index.md.html#Platform%20Support">Platform Support</a> for an overview.</p>
<hr>
-
<h1><a name="capture.captureAudio">capture.captureAudio</a></h1>
<blockquote>
@@ -399,7 +403,9 @@ configuration. See <a href="guide_suppo
);
</code></pre>
-<h2><a name="capture.captureAudio_description">Description</a></h2>
+<h2>
+<a name="capture.captureAudio_description">Description</a>
+</h2>
<p>Starts an asynchronous operation to capture audio recordings using the
device's default audio recording application. The operation allows
@@ -418,7 +424,9 @@ is captured, the <code>CaptureErrorCallb
object, featuring the <code><a href="cordova_media_capture_capture.md.html#CaptureError">CaptureError</a>.CAPTURE_NO_MEDIA_FILES</code> error
code.</p>
-<h2><a name="capture.captureAudio_supported_platforms">Supported Platforms</a></h2>
+<h2>
+<a name="capture.captureAudio_supported_platforms">Supported Platforms</a>
+</h2>
<ul>
<li>Amazon Fire OS</li>
@@ -428,8 +436,9 @@ code.</p>
<li>Windows Phone 7 and 8</li>
<li>Windows 8</li>
</ul>
-
-<h2><a name="capture.captureAudio_quick_example">Quick Example</a></h2>
+<h2>
+<a name="capture.captureAudio_quick_example">Quick Example</a>
+</h2>
<pre class="prettyprint"><code>// capture callback
var captureSuccess = function(mediaFiles) {
@@ -449,7 +458,9 @@ var captureError = function(error) {
navigator.device.<a href="cordova_media_capture_capture.md.html#capture.captureAudio">capture.captureAudio</a>(captureSuccess, captureError, {limit:2});
</code></pre>
-<h2><a name="capture.captureAudio_full_example">Full Example</a></h2>
+<h2>
+<a name="capture.captureAudio_full_example">Full Example</a>
+</h2>
<pre class="prettyprint"><code><!DOCTYPE html>
<html>
@@ -510,40 +521,45 @@ navigator.device.<a href="cordova_media_
</html>
</code></pre>
-<h2><a name="capture.captureAudio_blackberry_10_quirks">BlackBerry 10 Quirks</a></h2>
+<h2>
+<a name="capture.captureAudio_blackberry_10_quirks">BlackBerry 10 Quirks</a>
+</h2>
<ul>
<li>Cordova for BlackBerry 10 attempts to launch the <strong>Voice Notes Recorder</strong> application, provided by RIM, to capture audio recordings. The app receives a <code><a href="cordova_media_capture_capture.md.html#CaptureError">CaptureError</a>.CAPTURE_NOT_SUPPORTED</code> error code if the application is not installed on the device.</li>
</ul>
-
-<h2><a name="capture.captureAudio_ios_quirks">iOS Quirks</a></h2>
+<h2>
+<a name="capture.captureAudio_ios_quirks">iOS Quirks</a>
+</h2>
<ul>
<li>iOS does not have a default audio recording application, so a simple user interface is provided.</li>
</ul>
-
-<h2><a name="capture.captureAudio_windows_phone_7_and_8_quirks">Windows Phone 7 and 8 Quirks</a></h2>
+<h2>
+<a name="capture.captureAudio_windows_phone_7_and_8_quirks">Windows Phone 7 and 8 Quirks</a>
+</h2>
<ul>
<li>Windows Phone 7 does not have a default audio recording application, so a simple user interface is provided.</li>
</ul>
-
<hr>
-
<h1><a name="CaptureAudioOptions">CaptureAudioOptions</a></h1>
<blockquote>
<p>Encapsulates audio capture configuration options.</p>
</blockquote>
-<h2><a name="CaptureAudioOptions_properties">Properties</a></h2>
+<h2>
+<a name="CaptureAudioOptions_properties">Properties</a>
+</h2>
<ul>
<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></h2>
+<h2>
+<a name="CaptureAudioOptions_quick_example">Quick Example</a>
+</h2>
<pre class="prettyprint"><code>// limit capture operation to 3 media files, no longer than 10 seconds each
var options = { limit: 3, duration: 10 };
@@ -551,32 +567,35 @@ var options = { limit: 3, duration: 10 }
navigator.device.<a href="cordova_media_capture_capture.md.html#capture.captureAudio">capture.captureAudio</a>(captureSuccess, captureError, options);
</code></pre>
-<h2><a name="CaptureAudioOptions_amazon_fire_os_quirks">Amazon Fire OS Quirks</a></h2>
+<h2>
+<a name="CaptureAudioOptions_amazon_fire_os_quirks">Amazon Fire OS Quirks</a>
+</h2>
<ul>
<li>The <code>duration</code> parameter is not supported. Recording lengths cannot be limited programmatically.</li>
</ul>
-
-<h2><a name="CaptureAudioOptions_android_quirks">Android Quirks</a></h2>
+<h2>
+<a name="CaptureAudioOptions_android_quirks">Android Quirks</a>
+</h2>
<ul>
<li>The <code>duration</code> parameter is not supported. Recording lengths can't be limited programmatically.</li>
</ul>
-
-<h2><a name="CaptureAudioOptions_blackberry_10_quirks">BlackBerry 10 Quirks</a></h2>
+<h2>
+<a name="CaptureAudioOptions_blackberry_10_quirks">BlackBerry 10 Quirks</a>
+</h2>
<ul>
<li>The <code>duration</code> parameter is not supported. Recording lengths can't be limited programmatically.</li>
</ul>
-
-<h2><a name="CaptureAudioOptions_ios_quirks">iOS Quirks</a></h2>
+<h2>
+<a name="CaptureAudioOptions_ios_quirks">iOS Quirks</a>
+</h2>
<ul>
<li>The <code>limit</code> parameter is not supported, so only one recording can be created for each invocation.</li>
</ul>
-
<hr>
-
<h1><a name="capture.captureImage">capture.captureImage</a></h1>
<blockquote>
@@ -588,7 +607,9 @@ navigator.device.<a href="cordova_media_
);
</code></pre>
-<h2><a name="capture.captureImage_description">Description</a></h2>
+<h2>
+<a name="capture.captureImage_description">Description</a>
+</h2>
<p>Starts an asynchronous operation to capture images using the device's
camera application. The operation allows users to capture more than
@@ -606,7 +627,9 @@ image file. If the user terminates the
image, the <code><a href="cordova_media_capture_capture.md.html#CaptureErrorCB">CaptureErrorCB</a></code> callback executes with a <code><a href="cordova_media_capture_capture.md.html#CaptureError">CaptureError</a></code>
object featuring a <code><a href="cordova_media_capture_capture.md.html#CaptureError">CaptureError</a>.CAPTURE_NO_MEDIA_FILES</code> error code.</p>
-<h2><a name="capture.captureImage_supported_platforms">Supported Platforms</a></h2>
+<h2>
+<a name="capture.captureImage_supported_platforms">Supported Platforms</a>
+</h2>
<ul>
<li>Amazon Fire OS</li>
@@ -616,13 +639,16 @@ object featuring a <code><a href="cordov
<li>Windows Phone 7 and 8</li>
<li>Windows 8</li>
</ul>
-
-<h2><a name="capture.captureImage_windows_phone_7_quirks">Windows Phone 7 Quirks</a></h2>
+<h2>
+<a name="capture.captureImage_windows_phone_7_quirks">Windows Phone 7 Quirks</a>
+</h2>
<p>Invoking the native camera application while your device is connected
via Zune does not work, and the error callback executes.</p>
-<h2><a name="capture.captureImage_quick_example">Quick Example</a></h2>
+<h2>
+<a name="capture.captureImage_quick_example">Quick Example</a>
+</h2>
<pre class="prettyprint"><code>// capture callback
var captureSuccess = function(mediaFiles) {
@@ -642,7 +668,9 @@ var captureError = function(error) {
navigator.device.<a href="cordova_media_capture_capture.md.html#capture.captureImage">capture.captureImage</a>(captureSuccess, captureError, {limit:2});
</code></pre>
-<h2><a name="capture.captureImage_full_example">Full Example</a></h2>
+<h2>
+<a name="capture.captureImage_full_example">Full Example</a>
+</h2>
<pre class="prettyprint"><code><!DOCTYPE html>
<html>
@@ -704,21 +732,23 @@ navigator.device.<a href="cordova_media_
</code></pre>
<hr>
-
<h1><a name="CaptureImageOptions">CaptureImageOptions</a></h1>
<blockquote>
<p>Encapsulates image capture configuration options.</p>
</blockquote>
-<h2><a name="CaptureImageOptions_properties">Properties</a></h2>
+<h2>
+<a name="CaptureImageOptions_properties">Properties</a>
+</h2>
<ul>
<li>
<strong>limit</strong>: The maximum number of images the user can capture in a single capture operation. The value must be greater than or equal to 1 (defaults to 1).</li>
</ul>
-
-<h2><a name="CaptureImageOptions_quick_example">Quick Example</a></h2>
+<h2>
+<a name="CaptureImageOptions_quick_example">Quick Example</a>
+</h2>
<pre class="prettyprint"><code>// limit capture operation to 3 images
var options = { limit: 3 };
@@ -726,14 +756,14 @@ var options = { limit: 3 };
navigator.device.<a href="cordova_media_capture_capture.md.html#capture.captureImage">capture.captureImage</a>(captureSuccess, captureError, options);
</code></pre>
-<h2><a name="CaptureImageOptions_ios_quirks">iOS Quirks</a></h2>
+<h2>
+<a name="CaptureImageOptions_ios_quirks">iOS Quirks</a>
+</h2>
<ul>
<li>The <strong>limit</strong> parameter is not supported, and only one image is taken per invocation.</li>
</ul>
-
<hr>
-
<h1><a name="capture.captureVideo">capture.captureVideo</a></h1>
<blockquote>
@@ -745,7 +775,9 @@ navigator.device.<a href="cordova_media_
);
</code></pre>
-<h2><a name="capture.captureVideo_description">Description</a></h2>
+<h2>
+<a name="capture.captureVideo_description">Description</a>
+</h2>
<p>Starts an asynchronous operation to capture video recordings using the
device's video recording application. The operation allows the user
@@ -764,7 +796,9 @@ capturing a video clip, the <code><a hre
<code><a href="cordova_media_capture_capture.md.html#CaptureError">CaptureError</a></code> object featuring a
<code><a href="cordova_media_capture_capture.md.html#CaptureError">CaptureError</a>.CAPTURE_NO_MEDIA_FILES</code> error code.</p>
-<h2><a name="capture.captureVideo_supported_platforms">Supported Platforms</a></h2>
+<h2>
+<a name="capture.captureVideo_supported_platforms">Supported Platforms</a>
+</h2>
<ul>
<li>Amazon Fire OS</li>
@@ -774,8 +808,9 @@ capturing a video clip, the <code><a hre
<li>Windows Phone 7 and 8</li>
<li>Windows 8</li>
</ul>
-
-<h2><a name="capture.captureVideo_quick_example">Quick Example</a></h2>
+<h2>
+<a name="capture.captureVideo_quick_example">Quick Example</a>
+</h2>
<pre class="prettyprint"><code>// capture callback
var captureSuccess = function(mediaFiles) {
@@ -795,7 +830,9 @@ var captureError = function(error) {
navigator.device.<a href="cordova_media_capture_capture.md.html#capture.captureVideo">capture.captureVideo</a>(captureSuccess, captureError, {limit:2});
</code></pre>
-<h2><a name="capture.captureVideo_full_example">Full Example</a></h2>
+<h2>
+<a name="capture.captureVideo_full_example">Full Example</a>
+</h2>
<pre class="prettyprint"><code><!DOCTYPE html>
<html>
@@ -856,28 +893,31 @@ navigator.device.<a href="cordova_media_
</html>
</code></pre>
-<h2><a name="capture.captureVideo_blackberry_10_quirks">BlackBerry 10 Quirks</a></h2>
+<h2>
+<a name="capture.captureVideo_blackberry_10_quirks">BlackBerry 10 Quirks</a>
+</h2>
<ul>
<li>Cordova for BlackBerry 10 attempts to launch the <strong>Video Recorder</strong> application, provided by RIM, to capture video recordings. The app receives a <code><a href="cordova_media_capture_capture.md.html#CaptureError">CaptureError</a>.CAPTURE_NOT_SUPPORTED</code> error code if the application is not installed on the device.</li>
</ul>
-
<hr>
-
<h1><a name="CaptureVideoOptions">CaptureVideoOptions</a></h1>
<blockquote>
<p>Encapsulates video capture configuration options.</p>
</blockquote>
-<h2><a name="CaptureVideoOptions_properties">Properties</a></h2>
+<h2>
+<a name="CaptureVideoOptions_properties">Properties</a>
+</h2>
<ul>
<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></h2>
+<h2>
+<a name="CaptureVideoOptions_quick_example">Quick Example</a>
+</h2>
<pre class="prettyprint"><code>// limit capture operation to 3 video clips
var options = { limit: 3 };
@@ -885,34 +925,38 @@ var options = { limit: 3 };
navigator.device.<a href="cordova_media_capture_capture.md.html#capture.captureVideo">capture.captureVideo</a>(captureSuccess, captureError, options);
</code></pre>
-<h2><a name="CaptureVideoOptions_blackberry_10_quirks">BlackBerry 10 Quirks</a></h2>
+<h2>
+<a name="CaptureVideoOptions_blackberry_10_quirks">BlackBerry 10 Quirks</a>
+</h2>
<ul>
<li>The <strong>duration</strong> parameter is not supported, so the length of recordings can't be limited programmatically.</li>
</ul>
-
-<h2><a name="CaptureVideoOptions_ios_quirks">iOS Quirks</a></h2>
+<h2>
+<a name="CaptureVideoOptions_ios_quirks">iOS Quirks</a>
+</h2>
<ul>
<li>The <strong>limit</strong> parameter is not supported. Only one video is recorded per invocation.</li>
</ul>
-
<hr>
-
<h1><a name="CaptureError">CaptureError</a></h1>
<blockquote>
<p>Encapsulates the error code resulting from a failed media capture operation.</p>
</blockquote>
-<h2><a name="CaptureError_properties">Properties</a></h2>
+<h2>
+<a name="CaptureError_properties">Properties</a>
+</h2>
<ul>
<li>
<strong>code</strong>: One of the pre-defined error codes listed below.</li>
</ul>
-
-<h2><a name="CaptureError_constants">Constants</a></h2>
+<h2>
+<a name="CaptureError_constants">Constants</a>
+</h2>
<ul>
<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>
@@ -921,9 +965,7 @@ navigator.device.<a href="cordova_media_
<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>
<blockquote>
@@ -933,7 +975,9 @@ navigator.device.<a href="cordova_media_
<pre class="prettyprint"><code>function captureSuccess( <a href="cordova_media_capture_capture.md.html#MediaFile">MediaFile</a>[] mediaFiles ) { ... };
</code></pre>
-<h2><a name="CaptureCB_description">Description</a></h2>
+<h2>
+<a name="CaptureCB_description">Description</a>
+</h2>
<p>This function executes after a successful capture operation completes.
At this point a media file has been captured, and either the user has
@@ -942,7 +986,9 @@ reached.</p>
<p>Each <code><a href="cordova_media_capture_capture.md.html#MediaFile">MediaFile</a></code> object describes a captured media file.</p>
-<h2><a name="CaptureCB_quick_example">Quick Example</a></h2>
+<h2>
+<a name="CaptureCB_quick_example">Quick Example</a>
+</h2>
<pre class="prettyprint"><code>// capture callback
function captureSuccess(mediaFiles) {
@@ -955,7 +1001,6 @@ function captureSuccess(mediaFiles) {
</code></pre>
<hr>
-
<h1><a name="CaptureErrorCB">CaptureErrorCB</a></h1>
<blockquote>
@@ -965,7 +1010,9 @@ function captureSuccess(mediaFiles) {
<pre class="prettyprint"><code>function captureError( <a href="cordova_media_capture_capture.md.html#CaptureError">CaptureError</a> error ) { ... };
</code></pre>
-<h2><a name="CaptureErrorCB_description">Description</a></h2>
+<h2>
+<a name="CaptureErrorCB_description">Description</a>
+</h2>
<p>This function executes if an error occurs when trying to launch a
media capture operation. Failure scenarios include when the capture
@@ -975,7 +1022,9 @@ the user cancels the operation before an
<p>This function executes with a <code><a href="cordova_media_capture_capture.md.html#CaptureError">CaptureError</a></code> object containing an
appropriate error <code>code</code>.</p>
-<h2><a name="CaptureErrorCB_quick_example">Quick Example</a></h2>
+<h2>
+<a name="CaptureErrorCB_quick_example">Quick Example</a>
+</h2>
<pre class="prettyprint"><code>// capture error callback
var captureError = function(error) {
@@ -984,14 +1033,15 @@ var captureError = function(error) {
</code></pre>
<hr>
-
<h1><a name="ConfigurationData">ConfigurationData</a></h1>
<blockquote>
<p>Encapsulates a set of media capture parameters that a device supports.</p>
</blockquote>
-<h2><a name="ConfigurationData_description">Description</a></h2>
+<h2>
+<a name="ConfigurationData_description">Description</a>
+</h2>
<p>Describes media capture modes supported by the device. The
configuration data includes the MIME type, and capture dimensions for
@@ -1006,16 +1056,18 @@ video or image capture.</p>
<li><code>audio/amr</code></li>
<li><code>audio/wav</code></li>
</ul>
-
-<h2><a name="ConfigurationData_properties">Properties</a></h2>
+<h2>
+<a name="ConfigurationData_properties">Properties</a>
+</h2>
<ul>
<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></h2>
+<h2>
+<a name="ConfigurationData_quick_example">Quick Example</a>
+</h2>
<pre class="prettyprint"><code>// retrieve supported image modes
var imageModes = navigator.device.capture.supportedImageModes;
@@ -1034,14 +1086,15 @@ for each (var mode in imageModes) {
<p>Not supported by any platform. All configuration data arrays are empty.</p>
<hr>
-
<h1><a name="MediaFile">MediaFile</a></h1>
<blockquote>
<p>Encapsulates properties of a media capture file.</p>
</blockquote>
-<h2><a name="MediaFile_properties">Properties</a></h2>
+<h2>
+<a name="MediaFile_properties">Properties</a>
+</h2>
<ul>
<li><p><strong>name</strong>: The name of the file, without path information. (DOMString)</p></li>
@@ -1050,16 +1103,15 @@ for each (var mode in imageModes) {
<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></h2>
+<h2>
+<a name="MediaFile_methods">Methods</a>
+</h2>
<ul>
<li>
<strong><a href="cordova_media_capture_capture.md.html#MediaFile.getFormatData">MediaFile.getFormatData</a></strong>: Retrieves the format information of the media file.</li>
</ul>
-
<hr>
-
<h1><a name="MediaFile.getFormatData">MediaFile.getFormatData</a></h1>
<blockquote>
@@ -1072,7 +1124,9 @@ for each (var mode in imageModes) {
);
</code></pre>
-<h2><a name="MediaFile.getFormatData_description">Description</a></h2>
+<h2>
+<a name="MediaFile.getFormatData_description">Description</a>
+</h2>
<p>This function asynchronously attempts to retrieve the format
information for the media file. If successful, it invokes the
@@ -1080,7 +1134,9 @@ information for the media file. If succ
the attempt fails, this function invokes the <code>MediaFileDataErrorCB</code>
callback.</p>
-<h2><a name="MediaFile.getFormatData_supported_platforms">Supported Platforms</a></h2>
+<h2>
+<a name="MediaFile.getFormatData_supported_platforms">Supported Platforms</a>
+</h2>
<ul>
<li>Amazon Fire OS</li>
@@ -1090,36 +1146,44 @@ callback.</p>
<li>Windows Phone 7 and 8</li>
<li>Windows 8</li>
</ul>
-
-<h2><a name="MediaFile.getFormatData_amazon_fire_os_quirks">Amazon Fire OS Quirks</a></h2>
+<h2>
+<a name="MediaFile.getFormatData_amazon_fire_os_quirks">Amazon Fire OS Quirks</a>
+</h2>
<p>The API to access media file format information is limited, so not all
<code><a href="cordova_media_capture_capture.md.html#MediaFileData">MediaFileData</a></code> properties are supported.</p>
-<h2><a name="MediaFile.getFormatData_blackberry_10_quirks">BlackBerry 10 Quirks</a></h2>
+<h2>
+<a name="MediaFile.getFormatData_blackberry_10_quirks">BlackBerry 10 Quirks</a>
+</h2>
<p>Does not provide an API for information about media files, so all
<code><a href="cordova_media_capture_capture.md.html#MediaFileData">MediaFileData</a></code> objects return with default values.</p>
-<h2><a name="MediaFile.getFormatData_android_quirks">Android Quirks</a></h2>
+<h2>
+<a name="MediaFile.getFormatData_android_quirks">Android Quirks</a>
+</h2>
<p>The API to access media file format information is limited, so not all
<code><a href="cordova_media_capture_capture.md.html#MediaFileData">MediaFileData</a></code> properties are supported.</p>
-<h2><a name="MediaFile.getFormatData_ios_quirks">iOS Quirks</a></h2>
+<h2>
+<a name="MediaFile.getFormatData_ios_quirks">iOS Quirks</a>
+</h2>
<p>The API to access media file format information is limited, so not all
<code><a href="cordova_media_capture_capture.md.html#MediaFileData">MediaFileData</a></code> properties are supported.</p>
<hr>
-
<h1><a name="MediaFileData">MediaFileData</a></h1>
<blockquote>
<p>Encapsulates format information about a media file.</p>
</blockquote>
-<h2><a name="MediaFileData_properties">Properties</a></h2>
+<h2>
+<a name="MediaFileData_properties">Properties</a>
+</h2>
<ul>
<li><p><strong>codecs</strong>: The actual format of the audio and video content. (DOMString)</p></li>
@@ -1128,8 +1192,9 @@ callback.</p>
<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_10_quirks">BlackBerry 10 Quirks</a></h2>
+<h2>
+<a name="MediaFileData_blackberry_10_quirks">BlackBerry 10 Quirks</a>
+</h2>
<p>No API provides format information for media files, so the
<code><a href="cordova_media_capture_capture.md.html#MediaFileData">MediaFileData</a></code> object returned by <code><a href="cordova_media_capture_capture.md.html#MediaFile.getFormatData">MediaFile.getFormatData</a></code> features
@@ -1142,8 +1207,9 @@ the following default values:</p>
<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_amazon_fire_os_quirks">Amazon Fire OS Quirks</a></h2>
+<h2>
+<a name="MediaFileData_amazon_fire_os_quirks">Amazon Fire OS Quirks</a>
+</h2>
<p>Supports the following <code><a href="cordova_media_capture_capture.md.html#MediaFileData">MediaFileData</a></code> properties:</p>
@@ -1154,8 +1220,9 @@ the following default values:</p>
<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_android_quirks">Android Quirks</a></h2>
+<h2>
+<a name="MediaFileData_android_quirks">Android Quirks</a>
+</h2>
<p>Supports the following <code><a href="cordova_media_capture_capture.md.html#MediaFileData">MediaFileData</a></code> properties:</p>
@@ -1166,8 +1233,9 @@ the following default values:</p>
<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></h2>
+<h2>
+<a name="MediaFileData_ios_quirks">iOS Quirks</a>
+</h2>
<p>Supports the following <code><a href="cordova_media_capture_capture.md.html#MediaFileData">MediaFileData</a></code> properties:</p>
@@ -1178,12 +1246,10 @@ the following default values:</p>
<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>
</div>
<!-- Functionality and Syntax Highlighting -->
- <script type="text/javascript" src="index.js"></script>
- <script type="text/javascript" src="prettify/prettify.js"></script>
- </body>
+ <script type="text/javascript" src="index.js"></script><script type="text/javascript" src="prettify/prettify.js"></script>
+</body>
</html>