Documentation for mobile, TV, and wearable.
Copied from repo: doc/web-device-api branch: tizen_cordova
Added to index.htm and index.xml
Change-Id: I49f1945a15c85d46bed93f3c65eeade1080f4e97
Signed-off-by: Jakub Skowron <j.skowron@samsung.com>
<td>Mandatory</td>
<td>Yes</td>
+ </tr></tbody></table><h4 id="Cordova">Cordova</h4>
+ <table class="api-list"><thead><tr><th>API</th><th>Description</th><th>Version (Since)</th><th>Mobile</th><th>Supported on<br>Mobile Emulator</th></tr>
+ </thead><tbody><tr><td><a href="tizen/cordova/console.html">
+ Console</a></td>
+ <td>The Console module provides function to access the console.</td>
+ <td>3.0</td>
+ <td>Mandatory</td>
+ <td>Yes</td>
+
+ </tr><tr><td><a href="tizen/cordova/cordova.html">
+ Cordova</a></td>
+ <td>This API provides common Cordova functionality.</td>
+ <td>3.0</td>
+ <td>Mandatory</td>
+ <td>Yes</td>
+
+ </tr><tr><td><a href="tizen/cordova/device.html">
+ Device</a></td>
+ <td>This plugin defines a global device object, which describes the device's hardware and software.</td>
+ <td>3.0</td>
+ <td>Mandatory</td>
+ <td>Yes</td>
+
+ </tr><tr><td><a href="tizen/cordova/device-motion.html">
+ Device Motion</a></td>
+ <td>This plugin provides access to the device's accelerometer.</td>
+ <td>3.0</td>
+ <td>Mandatory</td>
+ <td>Yes</td>
+
+ </tr><tr><td><a href="tizen/cordova/dialogs.html">
+ Dialogs</a></td>
+ <td>This plugin provides the ability to make different types of notifications to the user.</td>
+ <td>3.0</td>
+ <td>Mandatory</td>
+ <td>Yes</td>
+
+ </tr><tr><td><a href="tizen/cordova/events.html">
+ Events</a></td>
+ <td>This plugin provides information about events defined in cordova.</td>
+ <td>3.0</td>
+ <td>Mandatory</td>
+ <td>Yes</td>
+
+ </tr><tr><td><a href="tizen/cordova/file.html">
+ File</a></td>
+ <td>This plugin implements a File API allowing read/write access to files residing on the device.</td>
+ <td>3.0</td>
+ <td>Mandatory</td>
+ <td>Yes</td>
+
+ </tr><tr><td><a href="tizen/cordova/filetransfer.html">
+ File Transfer</a></td>
+ <td>This module allows you to upload and download files.</td>
+ <td>3.0</td>
+ <td>Mandatory</td>
+ <td>Yes</td>
+
+ </tr><tr><td><a href="tizen/cordova/globalization.html">
+ Globalization</a></td>
+ <td>This plugin obtains information and performs operations specific to the user's locale, language, and timezone.</td>
+ <td>3.0</td>
+ <td>Mandatory</td>
+ <td>Yes</td>
+
+ </tr><tr><td><a href="tizen/cordova/media.html">
+ Media</a></td>
+ <td>This plugin provides the ability to record and play back audio files on a device.</td>
+ <td>3.0</td>
+ <td>Mandatory</td>
+ <td>Yes</td>
+
+ </tr><tr><td><a href="tizen/cordova/networkInformation.html">
+ Network Information</a></td>
+ <td>This plugin provides information about the device's cellular and wifi connection, and whether the device has an internet connection. </td>
+ <td>3.0</td>
+ <td>Mandatory</td>
+ <td>Yes</td>
+
</tr></tbody></table><div id="footer">
<div class="copyright" align="center">
Except as noted, this content - excluding the Code Examples - is licensed under <a href="http://creativecommons.org/licenses/by/3.0/legalcode" target="_blank">Creative Commons Attribution 3.0</a> and all of the Code Examples contained herein are licensed under <a href="https://www.tizen.org/bsd-3-clause-license" target="_blank">BSD-3-Clause</a>. <br>For details, see the <a href="https://www.tizen.org/content-license" target="_blank">Content License</a>.
--- /dev/null
+<!DOCTYPE html PUBLIC "html">
+<html>
+<head>
+<meta http-equiv="Content-Type" content="text/html; charset=utf-8">
+<link rel="stylesheet" type="text/css" href="../tizen.css" media="screen">
+<script type="text/javascript" src="snippet.js"></script><title>Console API</title>
+</head>
+<body id="page-content" onload="prettyPrint()">
+<div class="api" id="::Console">
+<div class="supported-platforms"><img class="mobile-mandatory emulator" title="Mandatory, Supported by Tizen Mobile emulator" src="../mobile_s_w.png"></div>
+<div class="title"><h1>Console API</h1></div>
+<div class="brief">
+ the Console module provides function to access the console.
+Original documentation: <a href="https://www.npmjs.com/package/cordova-plugin-console">Cordova Console</a>.
+ </div>
+<h2>Table of Contents</h2>
+<ul class="toc">
+<li>1. <a href="#interfaces-section">Interfaces</a><ul class="toc">
+<li>1.1. <a href="#ConsoleManagerObject">ConsoleManagerObject</a>
+</li>
+<li>1.2. <a href="#ConsoleManager">ConsoleManager</a>
+</li>
+</ul>
+</li>
+<li>2. <a href="#full-webidl">Full WebIDL</a>
+</li>
+</ul>
+<hr>
+<h2 id="method-summary">Summary of Interfaces and Methods</h2>
+<table class="informaltable">
+<thead><tr>
+<th>Interface</th>
+<th>Method</th>
+</tr></thead>
+<tbody>
+<tr>
+<td><a href="#ConsoleManagerObject">ConsoleManagerObject</a></td>
+<td></td>
+</tr>
+<tr>
+<td><a href="#ConsoleManager">ConsoleManager</a></td>
+<td>
+<div>void <a href="#ConsoleManager::log">log</a> (DOMString text)</div>
+<div>void <a href="#ConsoleManager::error">error</a> (DOMString text)</div>
+<div>void <a href="#ConsoleManager::warn">warn</a> (DOMString text)</div>
+<div>void <a href="#ConsoleManager::info">info</a> (DOMString text)</div>
+<div>void <a href="#ConsoleManager::debug">debug</a> (DOMString text)</div>
+<div>void <a href="#ConsoleManager::assert">assert</a> (boolean expression, DOMString message)</div>
+<div>void <a href="#ConsoleManager::dir">dir</a> (Object obj)</div>
+<div>void <a href="#ConsoleManager::dirxml">dirxml</a> (Object obj)</div>
+<div>void <a href="#ConsoleManager::time">time</a> (DOMString label)</div>
+<div>void <a href="#ConsoleManager::timeEnd">timeEnd</a> (DOMString label)</div>
+</td>
+</tr>
+</tbody>
+</table>
+<div class="interfaces" id="interfaces-section">
+<h2>1. Interfaces</h2>
+<div class="interface" id="ConsoleManagerObject">
+<a class="backward-compatibility-anchor" name="::Console::ConsoleManagerObject"></a><h3>1.1. ConsoleManagerObject</h3>
+<pre class="webidl prettyprint"> [NoInterfaceObject] interface ConsoleManagerObject {
+ readonly attribute <a href="#ConsoleManager">ConsoleManager</a> console;
+ };</pre>
+<pre class="webidl prettyprint"> Window implements <a href="#ConsoleManagerObject">ConsoleManagerObject</a>;</pre>
+<div class="description">
+ <p>
+The ConsoleManagerObject interface.
+ </p>
+ </div>
+</div>
+<div class="interface" id="ConsoleManager">
+<a class="backward-compatibility-anchor" name="::Console::ConsoleManager"></a><h3>1.2. ConsoleManager</h3>
+<div class="brief">
+ the ConsoleManager interface embodies Console module methods.
+ </div>
+<pre class="webidl prettyprint"> [NoInterfaceObject] interface ConsoleManager {
+ void log(DOMString text);
+
+ void error(DOMString text);
+
+ void warn(DOMString text);
+
+ void info(DOMString text);
+
+ void debug(DOMString text);
+
+ void assert(boolean expression, DOMString message);
+
+ void dir(Object obj);
+
+ void dirxml(Object obj);
+
+ void time(DOMString label);
+
+ void timeEnd(DOMString label);
+ };</pre>
+<div class="methods">
+<h4>Methods</h4>
+<dl>
+<dt class="method" id="ConsoleManager::log">
+<a class="backward-compatibility-anchor" name="::Console::ConsoleManager::log"></a><code><b><span class="methodName">log</span></b></code>
+</dt>
+<dd>
+<div class="brief">
+ Prints a line of text to a standard output.
+The text will be logged as a standard message.
+ </div>
+<div class="synopsis"><pre class="signature prettyprint">void log(DOMString text);
+ </pre></div>
+<p><span class="version">
+ Since: </span>
+ 3.0
+ </p>
+<div class="parameters">
+<p><span class="param">Parameters:</span></p>
+<ul>
+ <li class="param">
+<span class="name">text</span>:
+ The text to be printed.
+ </li>
+ </ul>
+</div>
+<div class="example">
+<span class="example"><p>Code example:</p></span><pre name="code" class="examplecode prettyprint"> console.log('A is for Alice.');
+ </pre>
+</div>
+<div class="output">
+<span class="title"><p>Output example:</p></span><pre>A is for Alice.
+</pre>
+</div>
+</dd>
+<dt class="method" id="ConsoleManager::error">
+<a class="backward-compatibility-anchor" name="::Console::ConsoleManager::error"></a><code><b><span class="methodName">error</span></b></code>
+</dt>
+<dd>
+<div class="brief">
+ Prints a line of text to a standard output.
+The text will be logged as an error message.
+ </div>
+<div class="synopsis"><pre class="signature prettyprint">void error(DOMString text);
+ </pre></div>
+<p><span class="version">
+ Since: </span>
+ 3.0
+ </p>
+<div class="parameters">
+<p><span class="param">Parameters:</span></p>
+<ul>
+ <li class="param">
+<span class="name">text</span>:
+ The text to be printed.
+ </li>
+ </ul>
+</div>
+<div class="example">
+<span class="example"><p>Code example:</p></span><pre name="code" class="examplecode prettyprint"> console.error('B is for Bob.');
+ </pre>
+</div>
+<div class="output">
+<span class="title"><p>Output example:</p></span><pre>B is for Bob.
+</pre>
+</div>
+</dd>
+<dt class="method" id="ConsoleManager::warn">
+<a class="backward-compatibility-anchor" name="::Console::ConsoleManager::warn"></a><code><b><span class="methodName">warn</span></b></code>
+</dt>
+<dd>
+<div class="brief">
+ Prints a line of text to a standard output.
+The text will be logged as a warning message.
+ </div>
+<div class="synopsis"><pre class="signature prettyprint">void warn(DOMString text);
+ </pre></div>
+<p><span class="version">
+ Since: </span>
+ 3.0
+ </p>
+<div class="parameters">
+<p><span class="param">Parameters:</span></p>
+<ul>
+ <li class="param">
+<span class="name">text</span>:
+ The text to be printed.
+ </li>
+ </ul>
+</div>
+<div class="example">
+<span class="example"><p>Code example:</p></span><pre name="code" class="examplecode prettyprint"> console.warn('C is for Christopher.');
+ </pre>
+</div>
+<div class="output">
+<span class="title"><p>Output example:</p></span><pre>C is for Christopher.
+</pre>
+</div>
+</dd>
+<dt class="method" id="ConsoleManager::info">
+<a class="backward-compatibility-anchor" name="::Console::ConsoleManager::info"></a><code><b><span class="methodName">info</span></b></code>
+</dt>
+<dd>
+<div class="brief">
+ Prints a line of text to a standard output.
+The text will be logged as an info message.
+ </div>
+<div class="synopsis"><pre class="signature prettyprint">void info(DOMString text);
+ </pre></div>
+<p><span class="version">
+ Since: </span>
+ 3.0
+ </p>
+<div class="parameters">
+<p><span class="param">Parameters:</span></p>
+<ul>
+ <li class="param">
+<span class="name">text</span>:
+ The text to be printed.
+ </li>
+ </ul>
+</div>
+<div class="example">
+<span class="example"><p>Code example:</p></span><pre name="code" class="examplecode prettyprint"> console.info('D is for Dorothy.');
+ </pre>
+</div>
+<div class="output">
+<span class="title"><p>Output example:</p></span><pre>D is for Dorothy.
+</pre>
+</div>
+</dd>
+<dt class="method" id="ConsoleManager::debug">
+<a class="backward-compatibility-anchor" name="::Console::ConsoleManager::debug"></a><code><b><span class="methodName">debug</span></b></code>
+</dt>
+<dd>
+<div class="brief">
+ Prints a line of text to a standard output.
+The text will be logged as a debug message.
+ </div>
+<div class="synopsis"><pre class="signature prettyprint">void debug(DOMString text);
+ </pre></div>
+<p><span class="version">
+ Since: </span>
+ 3.0
+ </p>
+<div class="parameters">
+<p><span class="param">Parameters:</span></p>
+<ul>
+ <li class="param">
+<span class="name">text</span>:
+ The text to be printed.
+ </li>
+ </ul>
+</div>
+<div class="example">
+<span class="example"><p>Code example:</p></span><pre name="code" class="examplecode prettyprint"> console.debug('E is for Eve.');
+ </pre>
+</div>
+<div class="output">
+<span class="title"><p>Output example:</p></span><pre>E is for Eve.
+</pre>
+</div>
+</dd>
+<dt class="method" id="ConsoleManager::assert">
+<a class="backward-compatibility-anchor" name="::Console::ConsoleManager::assert"></a><code><b><span class="methodName">assert</span></b></code>
+</dt>
+<dd>
+<div class="brief">
+ If the specified expression is false,
+the message is written to the console.
+ </div>
+<div class="synopsis"><pre class="signature prettyprint">void assert(boolean expression, DOMString message);
+ </pre></div>
+<p><span class="version">
+ Since: </span>
+ 3.0
+ </p>
+<div class="parameters">
+<p><span class="param">Parameters:</span></p>
+<ul>
+ <li class="param">
+<span class="name">expression</span>:
+ The expression to be evaluated.
+ </li>
+ <li class="param">
+<span class="name">message</span>:
+ The message to be displayed if an expression is false.
+ </li>
+ </ul>
+</div>
+<div class="example">
+<span class="example"><p>Code example:</p></span><pre name="code" class="examplecode prettyprint"> var felix = 'Felix';
+
+ // This assertion checks whether the first letter in name 'Felix' is 'A':
+ console.assert(felix.charAt(0) === 'A', felix + ' does not start with A.');
+ </pre>
+</div>
+<div class="output">
+<span class="title"><p>Output example:</p></span><pre>Felix does not start with A.
+</pre>
+</div>
+</dd>
+<dt class="method" id="ConsoleManager::dir">
+<a class="backward-compatibility-anchor" name="::Console::ConsoleManager::dir"></a><code><b><span class="methodName">dir</span></b></code>
+</dt>
+<dd>
+<div class="brief">
+ Prints a JavaScript representation of the specified object.
+If the object being logged is an HTML element, the JavaScript
+Object view is forced.
+ </div>
+<div class="synopsis"><pre class="signature prettyprint">void dir(Object obj);
+ </pre></div>
+<p><span class="version">
+ Since: </span>
+ 3.0
+ </p>
+<div class="parameters">
+<p><span class="param">Parameters:</span></p>
+<ul>
+ <li class="param">
+<span class="name">obj</span>:
+ An object whose JavaScript representation will be printed.
+ </li>
+ </ul>
+</div>
+<div class="example">
+<span class="example"><p>Code example:</p></span><pre name="code" class="examplecode prettyprint"> var john = {name: "John", surname: "Doe"};
+ console.dir(john.name);
+ </pre>
+</div>
+<div class="output">
+<span class="title"><p>Output example:</p></span><pre>John
+</pre>
+</div>
+</dd>
+<dt class="method" id="ConsoleManager::dirxml">
+<a class="backward-compatibility-anchor" name="::Console::ConsoleManager::dirxml"></a><code><b><span class="methodName">dirxml</span></b></code>
+</dt>
+<dd>
+<div class="brief">
+ Prints an XML/HTML Element representation of the specified object
+if possible or the JavaScript Object if it is not.
+ </div>
+<div class="synopsis"><pre class="signature prettyprint">void dirxml(Object obj);
+ </pre></div>
+<p><span class="version">
+ Since: </span>
+ 3.0
+ </p>
+<div class="parameters">
+<p><span class="param">Parameters:</span></p>
+<ul>
+ <li class="param">
+<span class="name">obj</span>:
+ An object whose XML/HTML Element representation will be printed.
+ </li>
+ </ul>
+</div>
+<div class="example">
+<span class="example"><p>Code example:</p></span><pre name="code" class="examplecode prettyprint"> var john = {name: "John", surname: "Doe"};
+ console.dirxml(john.surname);
+ </pre>
+</div>
+<div class="output">
+<span class="title"><p>Output example:</p></span><pre>Doe
+</pre>
+</div>
+</dd>
+<dt class="method" id="ConsoleManager::time">
+<a class="backward-compatibility-anchor" name="::Console::ConsoleManager::time"></a><code><b><span class="methodName">time</span></b></code>
+</dt>
+<dd>
+<div class="brief">
+ Starts a new timer with an associated label. When <var>console.timeEnd()
+</var> is called with the same label, the timer is stopped and the elapsed time
+is displayed in the console. Timer values are accurate to the sub-millisecond.
+ </div>
+<div class="synopsis"><pre class="signature prettyprint">void time(DOMString label);
+ </pre></div>
+<p><span class="version">
+ Since: </span>
+ 3.0
+ </p>
+<div class="parameters">
+<p><span class="param">Parameters:</span></p>
+<ul>
+ <li class="param">
+<span class="name">label</span>:
+ The label to start timing with.
+ </li>
+ </ul>
+</div>
+<div class="example">
+<span class="example"><p>Code example:</p></span><pre name="code" class="examplecode prettyprint"> console.time("Big array initialization");
+ var array = new Array(1000000);
+ for (var i = array.length - 1; i >= 0; i -= 1) {
+ array[i] = new Object();
+ };
+ console.timeEnd("Big array initialization");
+ </pre>
+</div>
+<div class="output">
+<span class="title"><p>Output example:</p></span><pre>Big array initialization: 461.989ms
+</pre>
+</div>
+</dd>
+<dt class="method" id="ConsoleManager::timeEnd">
+<a class="backward-compatibility-anchor" name="::Console::ConsoleManager::timeEnd"></a><code><b><span class="methodName">timeEnd</span></b></code>
+</dt>
+<dd>
+<div class="brief">
+ Stops the timer with the specified label and prints the elapsed time.
+ </div>
+<div class="synopsis"><pre class="signature prettyprint">void timeEnd(DOMString label);
+ </pre></div>
+<p><span class="version">
+ Since: </span>
+ 3.0
+ </p>
+<div class="parameters">
+<p><span class="param">Parameters:</span></p>
+<ul>
+ <li class="param">
+<span class="name">label</span>:
+ The label associated to the timing (with the use of <var>console.time()</var>method).
+ </li>
+ </ul>
+</div>
+<div class="example">
+<span class="example"><p>Code example:</p></span><pre name="code" class="examplecode prettyprint"> console.time("Big array initialization");
+ var array = new Array(1000000);
+ for (var i = array.length - 1; i >= 0; i -= 1) {
+ array[i] = new Object();
+ };
+ console.timeEnd("Big array initialization");
+ </pre>
+</div>
+<div class="output">
+<span class="title"><p>Output example:</p></span><pre>Big array initialization: 461.989ms
+</pre>
+</div>
+</dd>
+</dl>
+</div>
+</div>
+</div>
+<h2 id="full-webidl">2. Full WebIDL</h2>
+<pre class="webidl prettyprint">module Console {
+ [NoInterfaceObject] interface ConsoleManagerObject {
+ readonly attribute <a href="#ConsoleManager">ConsoleManager</a> console;
+ };
+
+ Window implements <a href="#ConsoleManagerObject">ConsoleManagerObject</a>;
+
+ [NoInterfaceObject] interface ConsoleManager {
+ void log(DOMString text);
+
+ void error(DOMString text);
+
+ void warn(DOMString text);
+
+ void info(DOMString text);
+
+ void debug(DOMString text);
+
+ void assert(boolean expression, DOMString message);
+
+ void dir(Object obj);
+
+ void dirxml(Object obj);
+
+ void time(DOMString label);
+
+ void timeEnd(DOMString label);
+ };
+};</pre>
+</div>
+<div id="page-footer">
+<div class="copyright" align="center">
+ Except as noted, this content - excluding the Code Examples - is licensed under <a href="http://creativecommons.org/licenses/by/3.0/legalcode" target="_blank">Creative Commons Attribution 3.0</a> and all of the Code Examples contained herein are licensed under <a href="https://www.tizen.org/bsd-3-clause-license" target="_blank">BSD-3-Clause</a>. <br>For details, see the <a href="https://www.tizen.org/content-license" target="_blank">Content License</a>.
+ </div>
+<script type="text/javascript">
+
+ var _gaq = _gaq || [];
+ _gaq.push(['_setAccount', 'UA-25976949-1']);
+ _gaq.push(['_setDomainName', 'tizen.org']);
+ _gaq.push(['_trackPageview']);
+
+ (function() {
+ var ga = document.createElement('script'); ga.type = 'text/javascript'; ga.async = true;
+ var s = document.getElementsByTagName('script')[0]; s.parentNode.insertBefore(ga, s);
+ })();
+
+ </script>
+</div>
+</body>
+</html>
--- /dev/null
+<!DOCTYPE html PUBLIC "html">
+<html>
+<head>
+<meta http-equiv="Content-Type" content="text/html; charset=utf-8">
+<link rel="stylesheet" type="text/css" href="../tizen.css" media="screen">
+<script type="text/javascript" src="snippet.js"></script><title>Cordova API</title>
+</head>
+<body id="page-content" onload="prettyPrint()">
+<div class="api" id="::Cordova">
+<div class="supported-platforms"><img class="mobile-mandatory emulator" title="Mandatory, Supported by Tizen Mobile emulator" src="../mobile_s_w.png"></div>
+<div class="title"><h1>Cordova API</h1></div>
+<div class="brief">
+ This API provides common Cordova functionality.
+ </div>
+<h2>Table of Contents</h2>
+<ul class="toc">
+<li>1. <a href="#interfaces-section">Interfaces</a><ul class="toc">
+<li>1.1. <a href="#CordovaManagerObject">CordovaManagerObject</a>
+</li>
+<li>1.2. <a href="#Cordova">Cordova</a>
+</li>
+<li>1.3. <a href="#SuccessCallback">SuccessCallback</a>
+</li>
+<li>1.4. <a href="#ErrorCallback">ErrorCallback</a>
+</li>
+<li>1.5. <a href="#DOMException">DOMException</a>
+</li>
+</ul>
+</li>
+<li>2. <a href="#full-webidl">Full WebIDL</a>
+</li>
+</ul>
+<hr>
+<h2 id="method-summary">Summary of Interfaces and Methods</h2>
+<table class="informaltable">
+<thead><tr>
+<th>Interface</th>
+<th>Method</th>
+</tr></thead>
+<tbody>
+<tr>
+<td><a href="#CordovaManagerObject">CordovaManagerObject</a></td>
+<td></td>
+</tr>
+<tr>
+<td><a href="#Cordova">Cordova</a></td>
+<td></td>
+</tr>
+<tr>
+<td><a href="#SuccessCallback">SuccessCallback</a></td>
+<td><div>void <a href="#SuccessCallback::onsuccess">onsuccess</a> ()</div></td>
+</tr>
+<tr>
+<td><a href="#ErrorCallback">ErrorCallback</a></td>
+<td><div>void <a href="#ErrorCallback::onerror">onerror</a> (<a href="#DOMException">DOMException</a> error)</div></td>
+</tr>
+<tr>
+<td><a href="#DOMException">DOMException</a></td>
+<td></td>
+</tr>
+</tbody>
+</table>
+<div class="interfaces" id="interfaces-section">
+<h2>1. Interfaces</h2>
+<div class="interface" id="CordovaManagerObject">
+<a class="backward-compatibility-anchor" name="::Cordova::CordovaManagerObject"></a><h3>1.1. CordovaManagerObject</h3>
+<div class="brief">
+ CordovaManagerObject implemented in Window
+ </div>
+<pre class="webidl prettyprint"> [NoInterfaceObject] interface CordovaManagerObject {
+ readonly attribute <a href="#Cordova">Cordova</a> cordova;
+ };</pre>
+<pre class="webidl prettyprint"> Window implements <a href="#CordovaManagerObject">CordovaManagerObject</a>;</pre>
+</div>
+<div class="interface" id="Cordova">
+<a class="backward-compatibility-anchor" name="::Cordova::Cordova"></a><h3>1.2. Cordova</h3>
+<div class="brief">
+ The Cordova interface defines what is instantiated by the cordova object
+ </div>
+<pre class="webidl prettyprint"> [NoInterfaceObject] interface Cordova {
+ };</pre>
+</div>
+<div class="interface" id="SuccessCallback">
+<a class="backward-compatibility-anchor" name="::Cordova::SuccessCallback"></a><h3>1.3. SuccessCallback</h3>
+<div class="brief">
+ Basic success callback, no parameters.
+ </div>
+<pre class="webidl prettyprint">[Callback=FunctionOnly,NoInterfaceObject]
+interface SuccessCallback {
+ void onsuccess();
+};</pre>
+<div class="methods">
+<h4>Methods</h4>
+<dl>
+<dt class="method" id="SuccessCallback::onsuccess">
+<a class="backward-compatibility-anchor" name="::Cordova::SuccessCallback::onsuccess"></a><code><b><span class="methodName">onsuccess</span></b></code>
+</dt>
+<dd>
+<div class="brief">
+ Success
+ </div>
+<div class="synopsis"><pre class="signature prettyprint">void onsuccess();
+ </pre></div>
+<p><span class="version">
+ Since: </span>
+ 3.0
+ </p>
+</dd>
+</dl>
+</div>
+</div>
+<div class="interface" id="ErrorCallback">
+<a class="backward-compatibility-anchor" name="::Cordova::ErrorCallback"></a><h3>1.4. ErrorCallback</h3>
+<div class="brief">
+ Basic error callback.
+ </div>
+<pre class="webidl prettyprint">[Callback=FunctionOnly,NoInterfaceObject]
+interface ErrorCallback {
+ void onerror(<a href="#DOMException">DOMException</a> error);
+};</pre>
+<div class="methods">
+<h4>Methods</h4>
+<dl>
+<dt class="method" id="ErrorCallback::onerror">
+<a class="backward-compatibility-anchor" name="::Cordova::ErrorCallback::onerror"></a><code><b><span class="methodName">onerror</span></b></code>
+</dt>
+<dd>
+<div class="brief">
+ Success
+ </div>
+<div class="synopsis"><pre class="signature prettyprint">void onerror(<a href="#DOMException">DOMException</a> error);
+ </pre></div>
+<p><span class="version">
+ Since: </span>
+ 3.0
+ </p>
+<div class="parameters">
+<p><span class="param">Parameters:</span></p>
+<ul>
+ <li class="param">
+<span class="name">error</span>:
+ Error object containing some information about the error.
+ </li>
+ </ul>
+</div>
+</dd>
+</dl>
+</div>
+</div>
+<div class="interface" id="DOMException">
+<a class="backward-compatibility-anchor" name="::Cordova::DOMException"></a><h3>1.5. DOMException</h3>
+<div class="brief">
+ See <a href="https://developer.mozilla.org/en/docs/Web/API/DOMException">DOMException</a>.
+ </div>
+<pre class="webidl prettyprint">interface DOMException {
+ readonly attribute short code;
+
+ readonly attribute DOMString name;
+
+ readonly attribute DOMString message;
+};</pre>
+<div class="attributes">
+<h4>Attributes</h4>
+<ul>
+<li class="attribute" id="DOMException::code">
+<span class="attrName"><span class="readonly"> readonly
+</span><span class="type">short </span><span class="name">code</span></span><div class="brief">
+ The number representing the type of the error.
+ </div>
+<p><span class="version">
+ Since: </span>
+ 3.0
+ </p>
+</li>
+<li class="attribute" id="DOMException::name">
+<span class="attrName"><span class="readonly"> readonly
+</span><span class="type">DOMString </span><span class="name">name</span></span><div class="brief">
+ The short text representing the type of the error.
+ </div>
+<p><span class="version">
+ Since: </span>
+ 3.0
+ </p>
+</li>
+<li class="attribute" id="DOMException::message">
+<span class="attrName"><span class="readonly"> readonly
+</span><span class="type">DOMString </span><span class="name">message</span></span><div class="brief">
+ A text containing information about the error.
+ </div>
+<p><span class="version">
+ Since: </span>
+ 3.0
+ </p>
+</li>
+</ul>
+</div>
+</div>
+</div>
+<h2 id="full-webidl">2. Full WebIDL</h2>
+<pre class="webidl prettyprint">module Cordova {
+
+ [NoInterfaceObject] interface CordovaManagerObject {
+ readonly attribute <a href="#Cordova">Cordova</a> cordova;
+ };
+ Window implements <a href="#CordovaManagerObject">CordovaManagerObject</a>;
+
+ [NoInterfaceObject] interface Cordova {
+ };
+
+
+
+[Callback=FunctionOnly,NoInterfaceObject]
+interface SuccessCallback {
+ void onsuccess();
+};
+
+[Callback=FunctionOnly,NoInterfaceObject]
+interface ErrorCallback {
+ void onerror(<a href="#DOMException">DOMException</a> error);
+};
+
+interface DOMException {
+ readonly attribute short code;
+
+ readonly attribute DOMString name;
+
+ readonly attribute DOMString message;
+};
+
+};</pre>
+</div>
+<div id="page-footer">
+<div class="copyright" align="center">
+ Except as noted, this content - excluding the Code Examples - is licensed under <a href="http://creativecommons.org/licenses/by/3.0/legalcode" target="_blank">Creative Commons Attribution 3.0</a> and all of the Code Examples contained herein are licensed under <a href="https://www.tizen.org/bsd-3-clause-license" target="_blank">BSD-3-Clause</a>. <br>For details, see the <a href="https://www.tizen.org/content-license" target="_blank">Content License</a>.
+ </div>
+<script type="text/javascript">
+
+ var _gaq = _gaq || [];
+ _gaq.push(['_setAccount', 'UA-25976949-1']);
+ _gaq.push(['_setDomainName', 'tizen.org']);
+ _gaq.push(['_trackPageview']);
+
+ (function() {
+ var ga = document.createElement('script'); ga.type = 'text/javascript'; ga.async = true;
+ var s = document.getElementsByTagName('script')[0]; s.parentNode.insertBefore(ga, s);
+ })();
+
+ </script>
+</div>
+</body>
+</html>
--- /dev/null
+<!DOCTYPE html PUBLIC "html">
+<html>
+<head>
+<meta http-equiv="Content-Type" content="text/html; charset=utf-8">
+<link rel="stylesheet" type="text/css" href="../tizen.css" media="screen">
+<script type="text/javascript" src="snippet.js"></script><title>DeviceMotion API</title>
+</head>
+<body id="page-content" onload="prettyPrint()">
+<div class="api" id="::DeviceMotion">
+<div class="supported-platforms"><img class="mobile-mandatory emulator" title="Mandatory, Supported by Tizen Mobile emulator" src="../mobile_s_w.png"></div>
+<div class="title"><h1>DeviceMotion API</h1></div>
+<div class="brief">
+ This plugin provides access to the device's accelerometer. The accelerometer is a motion sensor that detects the change (delta) in movement relative to the current device orientation, in three dimensions along the x, y, and z axis.
+ </div>
+<div class="description">
+ <p>
+Original documentation: <a href="https://cordova.apache.org/docs/en/3.0.0/cordova/accelerometer/accelerometer.html">Cordova Accelerometer</a>.
+ </p>
+ </div>
+<h2>Table of Contents</h2>
+<ul class="toc">
+<li>1. <a href="#interfaces-section">Interfaces</a><ul class="toc">
+<li>1.1. <a href="#AccelerometerManagerObject">AccelerometerManagerObject</a>
+</li>
+<li>1.2. <a href="#Accelerometer">Accelerometer</a>
+</li>
+<li>1.3. <a href="#Acceleration">Acceleration</a>
+</li>
+<li>1.4. <a href="#AccelerationOptions">AccelerationOptions</a>
+</li>
+<li>1.5. <a href="#AccelerometerSuccessCallback">AccelerometerSuccessCallback</a>
+</li>
+</ul>
+</li>
+<li>2. <a href="#api-features">Related Feature</a>
+</li>
+<li>3. <a href="#full-webidl">Full WebIDL</a>
+</li>
+</ul>
+<hr>
+<h2 id="method-summary">Summary of Interfaces and Methods</h2>
+<table class="informaltable">
+<thead><tr>
+<th>Interface</th>
+<th>Method</th>
+</tr></thead>
+<tbody>
+<tr>
+<td><a href="#AccelerometerManagerObject">AccelerometerManagerObject</a></td>
+<td></td>
+</tr>
+<tr>
+<td><a href="#Accelerometer">Accelerometer</a></td>
+<td>
+<div>void <a href="#Accelerometer::getCurrentAcceleration">getCurrentAcceleration</a> (<a href="#AccelerometerSuccessCallback">AccelerometerSuccessCallback</a> onsuccess, <a href="cordova.html#ErrorCallback">ErrorCallback</a><a href="file.html#ErrorCallback">ErrorCallback</a> onerror)</div>
+<div>DOMString <a href="#Accelerometer::watchAcceleration">watchAcceleration</a> (<a href="#AccelerometerSuccessCallback">AccelerometerSuccessCallback</a> onsuccess, <a href="cordova.html#ErrorCallback">ErrorCallback</a><a href="file.html#ErrorCallback">ErrorCallback</a> onerror, optional <a href="#AccelerationOptions">AccelerationOptions</a>? options)</div>
+<div>void <a href="#Accelerometer::clearWatch">clearWatch</a> (DOMString watchID)</div>
+</td>
+</tr>
+<tr>
+<td><a href="#Acceleration">Acceleration</a></td>
+<td></td>
+</tr>
+<tr>
+<td><a href="#AccelerationOptions">AccelerationOptions</a></td>
+<td></td>
+</tr>
+<tr>
+<td><a href="#AccelerometerSuccessCallback">AccelerometerSuccessCallback</a></td>
+<td><div>void <a href="#AccelerometerSuccessCallback::onsuccess">onsuccess</a> (<a href="#Acceleration">Acceleration</a> acceleration)</div></td>
+</tr>
+</tbody>
+</table>
+<div class="interfaces" id="interfaces-section">
+<h2>1. Interfaces</h2>
+<div class="interface" id="AccelerometerManagerObject">
+<a class="backward-compatibility-anchor" name="::DeviceMotion::AccelerometerManagerObject"></a><h3>1.1. AccelerometerManagerObject</h3>
+<div class="brief">
+ The <em>navigator.accelerometer </em>object allows access to the functionality of the DeviceMotion API.
+ </div>
+<pre class="webidl prettyprint"> [NoInterfaceObject] interface AccelerometerManagerObject {
+ readonly attribute <a href="#Accelerometer">Accelerometer</a> accelerometer;
+ };</pre>
+<pre class="webidl prettyprint"> implements <a href="#AccelerometerManagerObject">AccelerometerManagerObject</a>;</pre>
+</div>
+<div class="interface" id="Accelerometer">
+<a class="backward-compatibility-anchor" name="::DeviceMotion::Accelerometer"></a><h3>1.2. Accelerometer</h3>
+<div class="brief">
+ The Accelerometer object captures device motion in the x, y, and z direction.
+ </div>
+<pre class="webidl prettyprint"> [NoInterfaceObject] interface Accelerometer {
+ void getCurrentAcceleration(<a href="#AccelerometerSuccessCallback">AccelerometerSuccessCallback</a> onsuccess, <a href="cordova.html#ErrorCallback">ErrorCallback</a><a href="file.html#ErrorCallback">ErrorCallback</a> onerror);
+
+ DOMString watchAcceleration(<a href="#AccelerometerSuccessCallback">AccelerometerSuccessCallback</a> onsuccess, <a href="cordova.html#ErrorCallback">ErrorCallback</a><a href="file.html#ErrorCallback">ErrorCallback</a> onerror, optional <a href="#AccelerationOptions">AccelerationOptions</a>? options);
+
+ void clearWatch(DOMString watchID);
+
+ };</pre>
+<div class="methods">
+<h4>Methods</h4>
+<dl>
+<dt class="method" id="Accelerometer::getCurrentAcceleration">
+<a class="backward-compatibility-anchor" name="::DeviceMotion::Accelerometer::getCurrentAcceleration"></a><code><b><span class="methodName">getCurrentAcceleration</span></b></code>
+</dt>
+<dd>
+<div class="brief">
+ Gets the current acceleration along the x, y, and z axes.
+ </div>
+<div class="synopsis"><pre class="signature prettyprint">void getCurrentAcceleration(<a href="#AccelerometerSuccessCallback">AccelerometerSuccessCallback</a> onsuccess, <a href="cordova.html#ErrorCallback">ErrorCallback</a><a href="file.html#ErrorCallback">ErrorCallback</a> onerror);
+ </pre></div>
+<p><span class="version">
+ Since: </span>
+ 3.0
+ </p>
+<div class="parameters">
+<p><span class="param">Parameters:</span></p>
+<ul>
+ <li class="param">
+<span class="name">onsuccess</span>:
+ The callback method to be invoked with current acceleration values.
+ </li>
+ <li class="param">
+<span class="name">onerror</span>:
+ The callback method called when errors occur
+ </li>
+ </ul>
+</div>
+<div class="exceptionlist">
+<p><span class="except">Exceptions:</span></p>
+ <ul class="exception"><li>TypeError<ul><li class="list"><p>
+ if any of the input parameters contains an invalid value.
+ </p></li></ul>
+</li></ul>
+ </div>
+<div class="example">
+<span class="example"><p>Code example:</p></span><pre name="code" class="examplecode prettyprint"> function onSuccess(acceleration) {
+ console.log('Acceleration X: ' + acceleration.x + '\n' +
+ 'Acceleration Y: ' + acceleration.y + '\n' +
+ 'Acceleration Z: ' + acceleration.z + '\n' +
+ 'Timestamp: ' + acceleration.timestamp);
+ };
+
+ function onError() {
+ console.log('onError!');
+ };
+
+ navigator.accelerometer.getCurrentAcceleration(onSuccess, onError);
+ </pre>
+</div>
+<div class="output">
+<span class="title"><p>Output example:</p></span><pre>Acceleration X: 0.00
+Acceleration Y: 0.00
+Acceleration Z: 9.82
+Timestamp: 1456480118000
+</pre>
+</div>
+</dd>
+<dt class="method" id="Accelerometer::watchAcceleration">
+<a class="backward-compatibility-anchor" name="::DeviceMotion::Accelerometer::watchAcceleration"></a><code><b><span class="methodName">watchAcceleration</span></b></code>
+</dt>
+<dd>
+<div class="brief">
+ Gets the acceleration along the x, y, and z axes at a regular interval.
+ </div>
+<div class="synopsis"><pre class="signature prettyprint">DOMString watchAcceleration(<a href="#AccelerometerSuccessCallback">AccelerometerSuccessCallback</a> onsuccess, <a href="cordova.html#ErrorCallback">ErrorCallback</a><a href="file.html#ErrorCallback">ErrorCallback</a> onerror, optional <a href="#AccelerationOptions">AccelerationOptions</a>? options);
+ </pre></div>
+<p><span class="version">
+ Since: </span>
+ 3.0
+ </p>
+<div class="parameters">
+<p><span class="param">Parameters:</span></p>
+<ul>
+ <li class="param">
+<span class="name">onsuccess</span>:
+ The callback method to be invoked with current acceleration values.
+ </li>
+ <li class="param">
+<span class="name">onerror</span>:
+ The callback method called when errors occur
+ </li>
+ <li class="param">
+<span class="name">options</span><span class="optional"> [optional]</span><span class="optional"> [nullable]</span>:
+ Specifies the interval of calling successcallback in miliseconds. If not provided, default value for frequency is 10000 (10 seconds).
+ </li>
+ </ul>
+</div>
+<div class="returntype">
+<p><span class="return">Return value:</span></p>
+ DOMString The watch id that must be passed to <a href="device-motion.html#Accelerometer::clearWatch">clearWatch</a> to stop watching.
+ </div>
+<div class="exceptionlist">
+<p><span class="except">Exceptions:</span></p>
+ <ul class="exception"><li>TypeError<ul><li class="list"><p>
+ if any of the input parameters contains an invalid value.
+ </p></li></ul>
+</li></ul>
+ </div>
+<div class="example">
+<span class="example"><p>Code example:</p></span><pre name="code" class="examplecode prettyprint"> function onSuccess(acceleration) {
+ console.log('Acceleration X: ' + acceleration.x + '\n' +
+ 'Acceleration Y: ' + acceleration.y + '\n' +
+ 'Acceleration Z: ' + acceleration.z + '\n' +
+ 'Timestamp: ' + acceleration.timestamp);
+ console.log('Please wait 3 seconds for the next measurement...');
+ };
+
+ function onError() {
+ console.log('onError!');
+ };
+
+ var options = { frequency: 3000 }; // Update every 3 seconds
+
+ var watchID = navigator.accelerometer.watchAcceleration(onSuccess, onError, options);
+ </pre>
+</div>
+<div class="output">
+<span class="title"><p>Output example:</p></span><pre>Acceleration X: 0.00
+Acceleration Y: 0.00
+Acceleration Z: 9.82
+Timestamp: 1456480118000
+Please wait 3 seconds for the next measurement...
+Acceleration X: 0.00
+Acceleration Y: 0.00
+Acceleration Z: 9.82
+Timestamp: 1456480121000
+Please wait 3 seconds for the next measurement...
+(...)
+</pre>
+</div>
+</dd>
+<dt class="method" id="Accelerometer::clearWatch">
+<a class="backward-compatibility-anchor" name="::DeviceMotion::Accelerometer::clearWatch"></a><code><b><span class="methodName">clearWatch</span></b></code>
+</dt>
+<dd>
+<div class="brief">
+ Stop watching the Acceleration referenced by the watchID parameter.
+ </div>
+<div class="synopsis"><pre class="signature prettyprint">void clearWatch(DOMString watchID);
+ </pre></div>
+<p><span class="version">
+ Since: </span>
+ 3.0
+ </p>
+<div class="parameters">
+<p><span class="param">Parameters:</span></p>
+<ul>
+ <li class="param">
+<span class="name">watchID</span>:
+ The id of the watch returned from <a href="device-motion.html#Accelerometer::watchAcceleration">watchAcceleration</a>.
+ </li>
+ </ul>
+</div>
+<div class="exceptionlist">
+<p><span class="except">Exceptions:</span></p>
+ <ul class="exception"><li>TypeError<ul><li class="list"><p>
+ if any of the input parameters contains an invalid value.
+ </p></li></ul>
+</li></ul>
+ </div>
+<div class="example">
+<span class="example"><p>Code example:</p></span><pre name="code" class="examplecode prettyprint"> var counter = 0, watchID;
+
+ function onSuccess(acceleration) {
+ console.log('Acceleration X: ' + acceleration.x + '\n' +
+ 'Acceleration Y: ' + acceleration.y + '\n' +
+ 'Acceleration Z: ' + acceleration.z + '\n' +
+ 'Timestamp: ' + acceleration.timestamp);
+ if(3 == ++counter) {
+ navigator.accelerometer.clearWatch(watchID);
+ }
+ };
+
+ function onError() {
+ console.log('onError!');
+ };
+
+ var options = { frequency: 30 }; // Update every 0.03 seconds
+
+ watchID = navigator.accelerometer.watchAcceleration(onSuccess, onError, options);
+ </pre>
+</div>
+<div class="output">
+<span class="title"><p>Output example:</p></span><pre>Acceleration X: 0.00
+Acceleration Y: 0.00
+Acceleration Z: 9.82
+Timestamp: 1456483774000
+Acceleration X: 0.00
+Acceleration Y: 0.00
+Acceleration Z: 9.82
+Timestamp: 1456483774030
+Acceleration X: 0.00
+Acceleration Y: 0.00
+Acceleration Z: 9.82
+Timestamp: 1456483774060
+</pre>
+</div>
+</dd>
+</dl>
+</div>
+</div>
+<div class="interface" id="Acceleration">
+<a class="backward-compatibility-anchor" name="::DeviceMotion::Acceleration"></a><h3>1.3. Acceleration</h3>
+<div class="brief">
+ Contains Accelerometer data captured at a specific point in time.
+Acceleration values include the effect of gravity (9.81 m/s^2), so that when a device lies flat and facing up, x, y, and z values returned should be 0, 0, and 9.81.
+ </div>
+<pre class="webidl prettyprint"> [NoInterfaceObject] interface Acceleration {
+ readonly attribute double x;
+
+ readonly attribute double y;
+
+ readonly attribute double z;
+
+ readonly attribute long timestamp;
+
+ };</pre>
+<div class="attributes">
+<h4>Attributes</h4>
+<ul>
+<li class="attribute" id="Acceleration::x">
+<span class="attrName"><span class="readonly"> readonly
+</span><span class="type">double </span><span class="name">x</span></span><div class="brief">
+ Amount of acceleration on the x-axis. (in m/s^2)
+ </div>
+<p><span class="version">
+ Since: </span>
+ 3.0
+ </p>
+</li>
+<li class="attribute" id="Acceleration::y">
+<span class="attrName"><span class="readonly"> readonly
+</span><span class="type">double </span><span class="name">y</span></span><div class="brief">
+ Amount of acceleration on the y-axis. (in m/s^2)
+ </div>
+<p><span class="version">
+ Since: </span>
+ 3.0
+ </p>
+</li>
+<li class="attribute" id="Acceleration::z">
+<span class="attrName"><span class="readonly"> readonly
+</span><span class="type">double </span><span class="name">z</span></span><div class="brief">
+ Amount of acceleration on the z-axis. (in m/s^2)
+ </div>
+<p><span class="version">
+ Since: </span>
+ 3.0
+ </p>
+</li>
+<li class="attribute" id="Acceleration::timestamp">
+<span class="attrName"><span class="readonly"> readonly
+</span><span class="type">long </span><span class="name">timestamp</span></span><div class="brief">
+ Creation timestamp in milliseconds.
+ </div>
+<p><span class="version">
+ Since: </span>
+ 3.0
+ </p>
+</li>
+</ul>
+</div>
+</div>
+<div class="dictionary" id="AccelerationOptions">
+<a class="backward-compatibility-anchor" name="::DeviceMotion::AccelerationOptions"></a><h3>1.4. AccelerationOptions</h3>
+<div class="brief">
+ An optional parameter to customize the retrieval of accelerometer values.
+ </div>
+<pre class="webidl prettyprint"> dictionary AccelerationOptions {
+ long frequency;
+ };</pre>
+<div class="attributes">
+<h4>Dictionary members</h4>
+<dl>
+<dt class="member" id="AccelerationOptions::frequency"><span class="attrName">long frequency</span></dt>
+<dd>
+<div class="brief">
+ Interval defining how often to retrieve Acceleration in milliseconds.
+ </div>
+<p><span class="version">
+ Since: </span>
+ 3.0
+ </p>
+</dd>
+</dl>
+</div>
+</div>
+<div class="interface" id="AccelerometerSuccessCallback">
+<a class="backward-compatibility-anchor" name="::DeviceMotion::AccelerometerSuccessCallback"></a><h3>1.5. AccelerometerSuccessCallback</h3>
+<div class="brief">
+ The AccelerometerSuccessCallback interface provides a SuccessCallback for the getCurrentAcceleration and watchAcceleration methods.
+ </div>
+<pre class="webidl prettyprint"> [Callback=FunctionOnly, NoInterfaceObject] interface AccelerometerSuccessCallback {
+ void onsuccess(<a href="#Acceleration">Acceleration</a> acceleration);
+ };</pre>
+<div class="methods">
+<h4>Methods</h4>
+<dl>
+<dt class="method" id="AccelerometerSuccessCallback::onsuccess">
+<a class="backward-compatibility-anchor" name="::DeviceMotion::AccelerometerSuccessCallback::onsuccess"></a><code><b><span class="methodName">onsuccess</span></b></code>
+</dt>
+<dd>
+<div class="synopsis"><pre class="signature prettyprint">void onsuccess(<a href="#Acceleration">Acceleration</a> acceleration);
+ </pre></div>
+<p><span class="version">
+ Since: </span>
+ 3.0
+ </p>
+<div class="parameters">
+<p><span class="param">Parameters:</span></p>
+<ul>
+ <li class="param">
+<span class="name">acceleration</span>:
+ The acceleration at a single moment in time.
+ </li>
+ </ul>
+</div>
+</dd>
+</dl>
+</div>
+</div>
+</div>
+<h2 id="api-features">2. Related Feature</h2>
+<div id="def-api-features" class="def-api-features">
+ You can check if this API is supported with <em>tizen.systeminfo.getCapability()</em> and decide enable/disable codes that need this API.
+ <div class="def-api-feature">
+<p><div class="description">
+ <p>
+To guarantee that the DeviceMotion application runs on a device with the DeviceMotion feature declare the following feature requirements in the config file:
+ </p>
+ </div></p>
+<li class="feature">http://tizen.org/feature/sensor.accelerometer</li>
+</div>
+<p></p>
+ For more information, see <a href="../../org.tizen.gettingstarted/html/tizen_overview/application_filtering.htm">Application Filtering.</a>
+</div>
+<h2 id="full-webidl">3. Full WebIDL</h2>
+<pre class="webidl prettyprint">module DeviceMotion {
+ [NoInterfaceObject] interface AccelerometerManagerObject {
+ readonly attribute <a href="#Accelerometer">Accelerometer</a> accelerometer;
+ };
+ implements <a href="#AccelerometerManagerObject">AccelerometerManagerObject</a>;
+ [NoInterfaceObject] interface Accelerometer {
+ void getCurrentAcceleration(<a href="#AccelerometerSuccessCallback">AccelerometerSuccessCallback</a> onsuccess, <a href="cordova.html#ErrorCallback">ErrorCallback</a><a href="file.html#ErrorCallback">ErrorCallback</a> onerror);
+
+ DOMString watchAcceleration(<a href="#AccelerometerSuccessCallback">AccelerometerSuccessCallback</a> onsuccess, <a href="cordova.html#ErrorCallback">ErrorCallback</a><a href="file.html#ErrorCallback">ErrorCallback</a> onerror, optional <a href="#AccelerationOptions">AccelerationOptions</a>? options);
+
+ void clearWatch(DOMString watchID);
+
+ };
+
+ [NoInterfaceObject] interface Acceleration {
+ readonly attribute double x;
+
+ readonly attribute double y;
+
+ readonly attribute double z;
+
+ readonly attribute long timestamp;
+
+ };
+
+ dictionary AccelerationOptions {
+ long frequency;
+ };
+
+ [Callback=FunctionOnly, NoInterfaceObject] interface AccelerometerSuccessCallback {
+ void onsuccess(<a href="#Acceleration">Acceleration</a> acceleration);
+ };
+
+};</pre>
+</div>
+<div id="page-footer">
+<div class="copyright" align="center">
+ Except as noted, this content - excluding the Code Examples - is licensed under <a href="http://creativecommons.org/licenses/by/3.0/legalcode" target="_blank">Creative Commons Attribution 3.0</a> and all of the Code Examples contained herein are licensed under <a href="https://www.tizen.org/bsd-3-clause-license" target="_blank">BSD-3-Clause</a>. <br>For details, see the <a href="https://www.tizen.org/content-license" target="_blank">Content License</a>.
+ </div>
+<script type="text/javascript">
+
+ var _gaq = _gaq || [];
+ _gaq.push(['_setAccount', 'UA-25976949-1']);
+ _gaq.push(['_setDomainName', 'tizen.org']);
+ _gaq.push(['_trackPageview']);
+
+ (function() {
+ var ga = document.createElement('script'); ga.type = 'text/javascript'; ga.async = true;
+ var s = document.getElementsByTagName('script')[0]; s.parentNode.insertBefore(ga, s);
+ })();
+
+ </script>
+</div>
+</body>
+</html>
--- /dev/null
+<!DOCTYPE html PUBLIC "html">
+<html>
+<head>
+<meta http-equiv="Content-Type" content="text/html; charset=utf-8">
+<link rel="stylesheet" type="text/css" href="../tizen.css" media="screen">
+<script type="text/javascript" src="snippet.js"></script><title>Device API</title>
+</head>
+<body id="page-content" onload="prettyPrint()">
+<div class="api" id="::Device">
+<div class="supported-platforms"><img class="mobile-mandatory emulator" title="Mandatory, Supported by Tizen Mobile emulator" src="../mobile_s_w.png"></div>
+<div class="title"><h1>Device API</h1></div>
+<div class="brief">
+ This plugin defines a global device object, which describes the device's hardware and software.
+Although the object is in the global scope, it is not available until the deviceready event.
+ </div>
+<div class="description">
+ <p>
+Original documentation: <a href="https://cordova.apache.org/docs/en/3.0.0/cordova/device/device.html">Cordova Device</a>.
+ </p>
+ </div>
+<p><span class="version">
+ Since: </span>
+ 3.0
+ </p>
+<h2>Table of Contents</h2>
+<ul class="toc">
+<li>1. <a href="#interfaces-section">Interfaces</a><ul class="toc">
+<li>1.1. <a href="#DeviceManagerObject">DeviceManagerObject</a>
+</li>
+<li>1.2. <a href="#Device">Device</a>
+</li>
+</ul>
+</li>
+<li>2. <a href="#full-webidl">Full WebIDL</a>
+</li>
+</ul>
+<hr>
+<h2 id="method-summary">Summary of Interfaces and Methods</h2>
+<table class="informaltable">
+<thead><tr>
+<th>Interface</th>
+<th>Method</th>
+</tr></thead>
+<tbody>
+<tr>
+<td><a href="#DeviceManagerObject">DeviceManagerObject</a></td>
+<td></td>
+</tr>
+<tr>
+<td><a href="#Device">Device</a></td>
+<td></td>
+</tr>
+</tbody>
+</table>
+<div class="interfaces" id="interfaces-section">
+<h2>1. Interfaces</h2>
+<div class="interface" id="DeviceManagerObject">
+<a class="backward-compatibility-anchor" name="::Device::DeviceManagerObject"></a><h3>1.1. DeviceManagerObject</h3>
+<div class="brief">
+ The <em>window.device </em>object allows access to the functionality of the Device API.
+ </div>
+<pre class="webidl prettyprint"> [NoInterfaceObject] interface DeviceManagerObject {
+ readonly attribute <a href="#Device">Device</a> device;
+ };</pre>
+<pre class="webidl prettyprint"> Window implements <a href="#DeviceManagerObject">DeviceManagerObject</a>;</pre>
+<p><span class="version">
+ Since: </span>
+ 3.0
+ </p>
+</div>
+<div class="interface" id="Device">
+<a class="backward-compatibility-anchor" name="::Device::Device"></a><h3>1.2. Device</h3>
+<div class="brief">
+ The device object describes the device's hardware and software.
+ </div>
+<pre class="webidl prettyprint"> [NoInterfaceObject] interface Device {
+ readonly attribute DOMString cordova;
+
+ readonly attribute DOMString model;
+
+ readonly attribute DOMString platform;
+
+ readonly attribute DOMString uuid;
+
+ readonly attribute DOMString version;
+
+ };</pre>
+<div class="attributes">
+<h4>Attributes</h4>
+<ul>
+<li class="attribute" id="Device::cordova">
+<span class="attrName"><span class="readonly"> readonly
+</span><span class="type">DOMString </span><span class="name">cordova</span></span><div class="brief">
+ Returns the version of Cordova running on the device.
+ </div>
+<div class="example">
+<span class="example"><p>Code example:</p></span><pre name="code" class="examplecode prettyprint"> document.addEventListener('deviceready', onDeviceReady, false);
+
+ function onDeviceReady() {
+ console.log('Device Cordova: ' + device.cordova);
+ }
+ </pre>
+</div>
+<div class="output">
+<span class="title"><p>Output example:</p></span><pre>Device Cordova: 5.1.1
+</pre>
+</div>
+</li>
+<li class="attribute" id="Device::model">
+<span class="attrName"><span class="readonly"> readonly
+</span><span class="type">DOMString </span><span class="name">model</span></span><div class="brief">
+ Get the the name of the device's model or product. The value is set by the device manufacturer and may be different across versions of the same product.
+ </div>
+<div class="example">
+<span class="example"><p>Code example:</p></span><pre name="code" class="examplecode prettyprint"> document.addEventListener('deviceready', onDeviceReady, false);
+
+ function onDeviceReady() {
+ console.log('Device Model: ' + device.model);
+ }
+ </pre>
+</div>
+<div class="output">
+<span class="title"><p>Output example:</p></span><pre>Device Model: tm1
+</pre>
+</div>
+</li>
+<li class="attribute" id="Device::platform">
+<span class="attrName"><span class="readonly"> readonly
+</span><span class="type">DOMString </span><span class="name">platform</span></span><div class="brief">
+ Get the device's operating system name.
+ </div>
+<div class="example">
+<span class="example"><p>Code example:</p></span><pre name="code" class="examplecode prettyprint"> document.addEventListener('deviceready', onDeviceReady, false);
+
+ function onDeviceReady() {
+ console.log('Device Platform: ' + device.platform);
+ }
+ </pre>
+</div>
+<div class="output">
+<span class="title"><p>Output example:</p></span><pre>Device Platform: Tizen
+</pre>
+</div>
+</li>
+<li class="attribute" id="Device::uuid">
+<span class="attrName"><span class="readonly"> readonly
+</span><span class="type">DOMString </span><span class="name">uuid</span></span><div class="brief">
+ Get the device's Universally Unique Identifier (UUID). The details of how a UUID is generated are determined by the device manufacturer and are specific to the device's platform or model.
+ </div>
+<div class="example">
+<span class="example"><p>Code example:</p></span><pre name="code" class="examplecode prettyprint"> document.addEventListener('deviceready', onDeviceReady, false);
+
+ function onDeviceReady() {
+ console.log('Device UUID: ' + device.uuid);
+ }
+ </pre>
+</div>
+<div class="output">
+<span class="title"><p>Output example:</p></span><pre>Device UUID: 2LR1b3MXfEUSFvH04m4e1EXYvQA=
+</pre>
+</div>
+</li>
+<li class="attribute" id="Device::version">
+<span class="attrName"><span class="readonly"> readonly
+</span><span class="type">DOMString </span><span class="name">version</span></span><div class="brief">
+ Get the operating system version.
+ </div>
+<div class="example">
+<span class="example"><p>Code example:</p></span><pre name="code" class="examplecode prettyprint"> document.addEventListener('deviceready', onDeviceReady, false);
+
+ function onDeviceReady() {
+ console.log('Device Version: ' + device.version);
+ }
+ </pre>
+</div>
+<div class="output">
+<span class="title"><p>Output example:</p></span><pre>Device Version: 3.0
+</pre>
+</div>
+</li>
+</ul>
+</div>
+</div>
+</div>
+<h2 id="full-webidl">2. Full WebIDL</h2>
+<pre class="webidl prettyprint">module Device {
+ [NoInterfaceObject] interface DeviceManagerObject {
+ readonly attribute <a href="#Device">Device</a> device;
+ };
+ Window implements <a href="#DeviceManagerObject">DeviceManagerObject</a>;
+ [NoInterfaceObject] interface Device {
+ readonly attribute DOMString cordova;
+
+ readonly attribute DOMString model;
+
+ readonly attribute DOMString platform;
+
+ readonly attribute DOMString uuid;
+
+ readonly attribute DOMString version;
+
+ };
+};</pre>
+</div>
+<div id="page-footer">
+<div class="copyright" align="center">
+ Except as noted, this content - excluding the Code Examples - is licensed under <a href="http://creativecommons.org/licenses/by/3.0/legalcode" target="_blank">Creative Commons Attribution 3.0</a> and all of the Code Examples contained herein are licensed under <a href="https://www.tizen.org/bsd-3-clause-license" target="_blank">BSD-3-Clause</a>. <br>For details, see the <a href="https://www.tizen.org/content-license" target="_blank">Content License</a>.
+ </div>
+<script type="text/javascript">
+
+ var _gaq = _gaq || [];
+ _gaq.push(['_setAccount', 'UA-25976949-1']);
+ _gaq.push(['_setDomainName', 'tizen.org']);
+ _gaq.push(['_trackPageview']);
+
+ (function() {
+ var ga = document.createElement('script'); ga.type = 'text/javascript'; ga.async = true;
+ var s = document.getElementsByTagName('script')[0]; s.parentNode.insertBefore(ga, s);
+ })();
+
+ </script>
+</div>
+</body>
+</html>
--- /dev/null
+<!DOCTYPE html PUBLIC "html">
+<html>
+<head>
+<meta http-equiv="Content-Type" content="text/html; charset=utf-8">
+<link rel="stylesheet" type="text/css" href="../tizen.css" media="screen">
+<script type="text/javascript" src="snippet.js"></script><title>Dialogs API</title>
+</head>
+<body id="page-content" onload="prettyPrint()">
+<div class="api" id="::Dialogs">
+<div class="supported-platforms"><img class="mobile-mandatory emulator" title="Mandatory, Supported by Tizen Mobile emulator" src="../mobile_s_w.png"></div>
+<div class="title"><h1>Dialogs API</h1></div>
+<div class="brief">
+ This plugin provides the ability to make different types of notifications to the user.
+ </div>
+<div class="description">
+ <p>
+Original documentation: <a href="https://www.npmjs.com/package/cordova-plugin-dialogs">Cordova Dialogs</a>.
+ </p>
+ </div>
+<h2>Table of Contents</h2>
+<ul class="toc">
+<li>1. <a href="#interfaces-section">Interfaces</a><ul class="toc">
+<li>1.1. <a href="#DialogsManagerObject">DialogsManagerObject</a>
+</li>
+<li>1.2. <a href="#DialogsManager">DialogsManager</a>
+</li>
+<li>1.3. <a href="#PromptData">PromptData</a>
+</li>
+<li>1.4. <a href="#ConfirmCallback">ConfirmCallback</a>
+</li>
+<li>1.5. <a href="#PromptCallback">PromptCallback</a>
+</li>
+</ul>
+</li>
+<li>2. <a href="#full-webidl">Full WebIDL</a>
+</li>
+</ul>
+<hr>
+<h2 id="method-summary">Summary of Interfaces and Methods</h2>
+<table class="informaltable">
+<thead><tr>
+<th>Interface</th>
+<th>Method</th>
+</tr></thead>
+<tbody>
+<tr>
+<td><a href="#DialogsManagerObject">DialogsManagerObject</a></td>
+<td></td>
+</tr>
+<tr>
+<td><a href="#DialogsManager">DialogsManager</a></td>
+<td>
+<div>void <a href="#DialogsManager::alert">alert</a> (DOMString message, <a href="cordova.html#SuccessCallback">SuccessCallback</a> alertCallback, optional DOMString? title, optional DOMString? buttonName)</div>
+<div>void <a href="#DialogsManager::confirm">confirm</a> (DOMString message, <a href="#ConfirmCallback">ConfirmCallback</a> confirmCallback, optional DOMString? title, optional DOMString[]? buttonNames)</div>
+<div>void <a href="#DialogsManager::prompt">prompt</a> (DOMString message, <a href="#PromptCallback">PromptCallback</a> promptCallback, optional DOMString? title, optional DOMString[]? buttonNames, optional DOMString? defaultText)</div>
+<div>void <a href="#DialogsManager::beep">beep</a> (long times)</div>
+</td>
+</tr>
+<tr>
+<td><a href="#PromptData">PromptData</a></td>
+<td></td>
+</tr>
+<tr>
+<td><a href="#ConfirmCallback">ConfirmCallback</a></td>
+<td><div>void <a href="#ConfirmCallback::onsuccess">onsuccess</a> (long buttonIndex)</div></td>
+</tr>
+<tr>
+<td><a href="#PromptCallback">PromptCallback</a></td>
+<td><div>void <a href="#PromptCallback::onsuccess">onsuccess</a> (<a href="#PromptData">PromptData</a> data)</div></td>
+</tr>
+</tbody>
+</table>
+<div class="interfaces" id="interfaces-section">
+<h2>1. Interfaces</h2>
+<div class="interface" id="DialogsManagerObject">
+<a class="backward-compatibility-anchor" name="::Dialogs::DialogsManagerObject"></a><h3>1.1. DialogsManagerObject</h3>
+<div class="brief">
+ The <em>DialogsManagerObject</em> interface defines what is instantiated in the <em>Navigator</em> object.
+ </div>
+<pre class="webidl prettyprint"> [NoInterfaceObject] interface DialogsManagerObject {
+ readonly attribute <a href="#DialogsManager">DialogsManager</a> notification;
+ };</pre>
+<pre class="webidl prettyprint"> implements <a href="#DialogsManagerObject">DialogsManagerObject</a>;</pre>
+<div class="description">
+ <p>
+The <em>navigator.notification</em> object allows access to the Dialogs API.
+ </p>
+ </div>
+</div>
+<div class="interface" id="DialogsManager">
+<a class="backward-compatibility-anchor" name="::Dialogs::DialogsManager"></a><h3>1.2. DialogsManager</h3>
+<div class="brief">
+ The <em>DialogsManager</em> interface provides methods for global operations related to notifications to the user.
+ </div>
+<pre class="webidl prettyprint"> [NoInterfaceObject] interface DialogsManager {
+ void alert(DOMString message, <a href="cordova.html#SuccessCallback">SuccessCallback</a> alertCallback, optional DOMString? title, optional DOMString? buttonName);
+
+ void confirm(DOMString message, <a href="#ConfirmCallback">ConfirmCallback</a> confirmCallback, optional DOMString? title, optional DOMString[]? buttonNames);
+
+ void prompt(DOMString message, <a href="#PromptCallback">PromptCallback</a> promptCallback,
+ optional DOMString? title, optional DOMString[]? buttonNames, optional DOMString? defaultText);
+
+ void beep(long times);
+ };</pre>
+<div class="methods">
+<h4>Methods</h4>
+<dl>
+<dt class="method" id="DialogsManager::alert">
+<a class="backward-compatibility-anchor" name="::Dialogs::DialogsManager::alert"></a><code><b><span class="methodName">alert</span></b></code>
+</dt>
+<dd>
+<div class="brief">
+ Shows a custom alert with one button.
+ </div>
+<div class="synopsis"><pre class="signature prettyprint">void alert(DOMString message, <a href="cordova.html#SuccessCallback">SuccessCallback</a> alertCallback, optional DOMString? title, optional DOMString? buttonName);
+ </pre></div>
+<p><span class="version">
+ Since: </span>
+ 3.0
+ </p>
+<div class="parameters">
+<p><span class="param">Parameters:</span></p>
+<ul>
+ <li class="param">
+<span class="name">message</span>:
+ The message to be shown to the user by dialog dialog.
+ </li>
+ <li class="param">
+<span class="name">alertCallback</span>:
+ The callback to be invoked when alert dialog would be dismissed.
+ </li>
+ <li class="param">
+<span class="name">title</span><span class="optional"> [optional]</span><span class="optional"> [nullable]</span>:
+ The title of dialog box. Default value is 'Dialog'.
+ </li>
+ <li class="param">
+<span class="name">buttonName</span><span class="optional"> [optional]</span><span class="optional"> [nullable]</span>:
+ Button name to be shown on dialog box. Default value is 'OK'.
+ </li>
+ </ul>
+</div>
+<div class="example">
+<span class="example"><p>Code example:</p></span><pre name="code" class="examplecode prettyprint"> var alertDismissed = function() {
+ console.log('Alert was dismissed');
+ }
+
+ navigator.notification.alert('Please click OK button', alertDismissed,
+ 'OK click alert', 'OK');
+ </pre>
+</div>
+<div class="output">
+<span class="title"><p>Output example:</p></span><pre>Alert was dismissed
+</pre>
+</div>
+</dd>
+<dt class="method" id="DialogsManager::confirm">
+<a class="backward-compatibility-anchor" name="::Dialogs::DialogsManager::confirm"></a><code><b><span class="methodName">confirm</span></b></code>
+</dt>
+<dd>
+<div class="brief">
+ Shows a custom confirm box with set of buttons.
+ </div>
+<div class="synopsis"><pre class="signature prettyprint">void confirm(DOMString message, <a href="#ConfirmCallback">ConfirmCallback</a> confirmCallback, optional DOMString? title, optional DOMString[]? buttonNames);
+ </pre></div>
+<p><span class="version">
+ Since: </span>
+ 3.0
+ </p>
+<div class="parameters">
+<p><span class="param">Parameters:</span></p>
+<ul>
+ <li class="param">
+<span class="name">message</span>:
+ The message to be shown to the user by dialog box.
+ </li>
+ <li class="param">
+<span class="name">confirmCallback</span>:
+ The callback to be invoked when user perform an action on dialog box.
+Callback provides index of button pressed (1,2,3 etc.) or 0, if dialog was dismissed without button press.
+ </li>
+ <li class="param">
+<span class="name">title</span><span class="optional"> [optional]</span><span class="optional"> [nullable]</span>:
+ The title of dialog box. Default value is 'Confirm'.
+ </li>
+ <li class="param">
+<span class="name">buttonNames</span><span class="optional"> [optional]</span><span class="optional"> [nullable]</span>:
+ Button names to be shown on dialog box. Default values are ['OK', 'Cancel'].
+ </li>
+ </ul>
+</div>
+<div class="example">
+<span class="example"><p>Code example:</p></span><pre name="code" class="examplecode prettyprint"> var confirmCallback = function(buttonIndex) {
+ console.log('Selected option was ' + buttonIndex);
+ }
+
+ navigator.notification.confirm('Choose one option', confirmCallback,
+ 'Options', ['Option1', 'Option2']);
+ </pre>
+</div>
+<div class="output">
+<span class="title"><p>Output example:</p></span><pre>Selected option was 1
+</pre>
+</div>
+</dd>
+<dt class="method" id="DialogsManager::prompt">
+<a class="backward-compatibility-anchor" name="::Dialogs::DialogsManager::prompt"></a><code><b><span class="methodName">prompt</span></b></code>
+</dt>
+<dd>
+<div class="brief">
+ Shows a custom confirm box with set of buttons.
+ </div>
+<div class="synopsis"><pre class="signature prettyprint">void prompt(DOMString message, <a href="#PromptCallback">PromptCallback</a> promptCallback, optional DOMString? title, optional DOMString[]? buttonNames, optional DOMString? defaultText);
+ </pre></div>
+<p><span class="version">
+ Since: </span>
+ 3.0
+ </p>
+<div class="parameters">
+<p><span class="param">Parameters:</span></p>
+<ul>
+ <li class="param">
+<span class="name">message</span>:
+ The message to be shown to the user by dialog box.
+ </li>
+ <li class="param">
+<span class="name">promptCallback</span>:
+ The callback to be invoked when user perform an action on dialog box.
+Callback provides <em>PromptData</em> object, which holds all data provided by user.
+ </li>
+ <li class="param">
+<span class="name">title</span><span class="optional"> [optional]</span><span class="optional"> [nullable]</span>:
+ The title of dialog box. Default value is 'Prompt'.
+ </li>
+ <li class="param">
+<span class="name">buttonNames</span><span class="optional"> [optional]</span><span class="optional"> [nullable]</span>:
+ Button names to be shown on dialog box. Default values are ['OK', 'Cancel'].
+ </li>
+ <li class="param">
+<span class="name">defaultText</span><span class="optional"> [optional]</span><span class="optional"> [nullable]</span>:
+ Default text to be shown in textbox of dialog box. Default value is an empty string ('').
+ </li>
+ </ul>
+</div>
+<div class="example">
+<span class="example"><p>Code example:</p></span><pre name="code" class="examplecode prettyprint"> var promptCallback = function(results) {
+ console.log('Hello ' + results.input1 + ', you selected option ' + results.buttonIndex);
+ }
+
+ navigator.notification.prompt('Please enter your name',
+ promptCallback,
+ 'Registration Box',
+ ['Ok', 'Exit'],
+ 'e.g. Jane Doe');
+ </pre>
+</div>
+<div class="output">
+<span class="title"><p>Output example:</p></span><pre>Hello Jane Doe, you selected option 1
+</pre>
+</div>
+</dd>
+<dt class="method" id="DialogsManager::beep">
+<a class="backward-compatibility-anchor" name="::Dialogs::DialogsManager::beep"></a><code><b><span class="methodName">beep</span></b></code>
+</dt>
+<dd>
+<div class="brief">
+ Method allows to make custom number of beeps by device.
+ </div>
+<div class="synopsis"><pre class="signature prettyprint">void beep(long times);
+ </pre></div>
+<p><span class="version">
+ Since: </span>
+ 3.0
+ </p>
+<div class="parameters">
+<p><span class="param">Parameters:</span></p>
+<ul>
+ <li class="param">
+<span class="name">times</span>:
+ The number of times to repeat the beep.
+ </li>
+ </ul>
+</div>
+<div class="example">
+<span class="example"><p>Code example:</p></span><pre name="code" class="examplecode prettyprint"> var times = 2;
+ console.log('Device would beep ' + times + ' times');
+ navigator.notification.beep(times);
+ </pre>
+</div>
+<div class="output">
+<span class="title"><p>Output example:</p></span><pre>Device would beep 2 times
+</pre>
+</div>
+</dd>
+</dl>
+</div>
+</div>
+<div class="interface" id="PromptData">
+<a class="backward-compatibility-anchor" name="::Dialogs::PromptData"></a><h3>1.3. PromptData</h3>
+<div class="brief">
+ The object returned from prompt dialog.
+ </div>
+<pre class="webidl prettyprint"> [NoInterfaceObject] interface PromptData {
+ readonly attribute long buttonIndex;
+
+ readonly attribute DOMString input1;
+ };</pre>
+<p><span class="remark"> Remark : </span>
+ Example usage is described on method <a href="#DialogsManager::prompt">prompt</a>.
+ </p>
+<div class="attributes">
+<h4>Attributes</h4>
+<ul>
+<li class="attribute" id="PromptData::buttonIndex">
+<span class="attrName"><span class="readonly"> readonly
+</span><span class="type">long </span><span class="name">buttonIndex</span></span><div class="brief">
+ The index of button, which was pressed by user.
+the index uses one-based indexing, so the values could be 1, 2, 3, etc.
+ </div>
+<p><span class="version">
+ Since: </span>
+ 3.0
+ </p>
+</li>
+<li class="attribute" id="PromptData::input1">
+<span class="attrName"><span class="readonly"> readonly
+</span><span class="type">DOMString </span><span class="name">input1</span></span><div class="brief">
+ The text entered by user in the prompt of dialog box.
+ </div>
+<p><span class="version">
+ Since: </span>
+ 3.0
+ </p>
+</li>
+</ul>
+</div>
+</div>
+<div class="interface" id="ConfirmCallback">
+<a class="backward-compatibility-anchor" name="::Dialogs::ConfirmCallback"></a><h3>1.4. ConfirmCallback</h3>
+<div class="brief">
+ The callback function used to return index of pressed button of confirm dialog.
+ </div>
+<pre class="webidl prettyprint"> [Callback=FunctionOnly, NoInterfaceObject] interface ConfirmCallback {
+ void onsuccess(long buttonIndex);
+ };</pre>
+<p><span class="remark"> Remark : </span>
+ Example usage is described on method <a href="#DialogsManager::confirm">confirm</a>.
+ </p>
+<div class="methods">
+<h4>Methods</h4>
+<dl>
+<dt class="method" id="ConfirmCallback::onsuccess">
+<a class="backward-compatibility-anchor" name="::Dialogs::ConfirmCallback::onsuccess"></a><code><b><span class="methodName">onsuccess</span></b></code>
+</dt>
+<dd>
+<div class="brief">
+ Called when the user perform action on confirm dialog.
+ </div>
+<div class="synopsis"><pre class="signature prettyprint">void onsuccess(long buttonIndex);
+ </pre></div>
+<p><span class="version">
+ Since: </span>
+ 3.0
+ </p>
+<div class="parameters">
+<p><span class="param">Parameters:</span></p>
+<ul>
+ <li class="param">
+<span class="name">buttonIndex</span>:
+ The index of button, which was pressed by user.
+the index uses one-based indexing, so the values could be 1, 2, 3, etc.
+ </li>
+ </ul>
+</div>
+</dd>
+</dl>
+</div>
+</div>
+<div class="interface" id="PromptCallback">
+<a class="backward-compatibility-anchor" name="::Dialogs::PromptCallback"></a><h3>1.5. PromptCallback</h3>
+<div class="brief">
+ The callback function used to return data from prompt dialog.
+ </div>
+<pre class="webidl prettyprint"> [Callback=FunctionOnly, NoInterfaceObject] interface PromptCallback {
+ void onsuccess(<a href="#PromptData">PromptData</a> data);
+ };</pre>
+<p><span class="remark"> Remark : </span>
+ Example usage is described on method <a href="#DialogsManager::prompt">prompt</a>.
+ </p>
+<div class="methods">
+<h4>Methods</h4>
+<dl>
+<dt class="method" id="PromptCallback::onsuccess">
+<a class="backward-compatibility-anchor" name="::Dialogs::PromptCallback::onsuccess"></a><code><b><span class="methodName">onsuccess</span></b></code>
+</dt>
+<dd>
+<div class="brief">
+ Called when the user perform action on prompt dialog.
+ </div>
+<div class="synopsis"><pre class="signature prettyprint">void onsuccess(<a href="#PromptData">PromptData</a> data);
+ </pre></div>
+<p><span class="version">
+ Since: </span>
+ 3.0
+ </p>
+<div class="parameters">
+<p><span class="param">Parameters:</span></p>
+<ul>
+ <li class="param">
+<span class="name">data</span>:
+ The data input into dialog box.
+ </li>
+ </ul>
+</div>
+</dd>
+</dl>
+</div>
+</div>
+</div>
+<h2 id="full-webidl">2. Full WebIDL</h2>
+<pre class="webidl prettyprint">module Dialogs {
+ [NoInterfaceObject] interface DialogsManagerObject {
+ readonly attribute <a href="#DialogsManager">DialogsManager</a> notification;
+ };
+
+ implements <a href="#DialogsManagerObject">DialogsManagerObject</a>;
+
+ [NoInterfaceObject] interface DialogsManager {
+ void alert(DOMString message, <a href="cordova.html#SuccessCallback">SuccessCallback</a> alertCallback, optional DOMString? title, optional DOMString? buttonName);
+
+ void confirm(DOMString message, <a href="#ConfirmCallback">ConfirmCallback</a> confirmCallback, optional DOMString? title, optional DOMString[]? buttonNames);
+
+ void prompt(DOMString message, <a href="#PromptCallback">PromptCallback</a> promptCallback,
+ optional DOMString? title, optional DOMString[]? buttonNames, optional DOMString? defaultText);
+
+ void beep(long times);
+ };
+
+ [NoInterfaceObject] interface PromptData {
+ readonly attribute long buttonIndex;
+
+ readonly attribute DOMString input1;
+ };
+
+ [Callback=FunctionOnly, NoInterfaceObject] interface ConfirmCallback {
+ void onsuccess(long buttonIndex);
+ };
+
+ [Callback=FunctionOnly, NoInterfaceObject] interface PromptCallback {
+ void onsuccess(<a href="#PromptData">PromptData</a> data);
+ };
+
+};</pre>
+</div>
+<div id="page-footer">
+<div class="copyright" align="center">
+ Except as noted, this content - excluding the Code Examples - is licensed under <a href="http://creativecommons.org/licenses/by/3.0/legalcode" target="_blank">Creative Commons Attribution 3.0</a> and all of the Code Examples contained herein are licensed under <a href="https://www.tizen.org/bsd-3-clause-license" target="_blank">BSD-3-Clause</a>. <br>For details, see the <a href="https://www.tizen.org/content-license" target="_blank">Content License</a>.
+ </div>
+<script type="text/javascript">
+
+ var _gaq = _gaq || [];
+ _gaq.push(['_setAccount', 'UA-25976949-1']);
+ _gaq.push(['_setDomainName', 'tizen.org']);
+ _gaq.push(['_trackPageview']);
+
+ (function() {
+ var ga = document.createElement('script'); ga.type = 'text/javascript'; ga.async = true;
+ var s = document.getElementsByTagName('script')[0]; s.parentNode.insertBefore(ga, s);
+ })();
+
+ </script>
+</div>
+</body>
+</html>
--- /dev/null
+<!DOCTYPE html PUBLIC "html">
+<html>
+<head>
+<meta http-equiv="Content-Type" content="text/html; charset=utf-8">
+<link rel="stylesheet" type="text/css" href="../tizen.css" media="screen">
+<script type="text/javascript" src="snippet.js"></script><title>Events API</title>
+</head>
+<body id="page-content" onload="prettyPrint()">
+<div class="api" id="::Events">
+<div class="supported-platforms"><img class="mobile-mandatory emulator" title="Mandatory, Supported by Tizen Mobile emulator" src="../mobile_s_w.png"></div>
+<div class="title"><h1>Events API</h1></div>
+<div class="brief">
+ This plugin provides information about events defined in cordova.
+ </div>
+<div class="description">
+ <p>
+Original documentation: <a href="https://cordova.apache.org/docs/en/latest/cordova/events/events.html">Cordova Events</a>.
+ </p>
+ <table>
+ <tr>
+ <th>
+Event name </th>
+ <th>
+Event handler callback </th>
+ </tr>
+ <tr>
+ <td>
+deviceready </td>
+ <td>
+<a href="#DeviceReadyEventCallback">DeviceReadyEventCallback</a> </td>
+ </tr>
+ <tr>
+ <td>
+pause </td>
+ <td>
+<a href="#PauseEventCallback">PauseEventCallback</a> </td>
+ </tr>
+ <tr>
+ <td>
+resume </td>
+ <td>
+<a href="#ResumeEventCallback">ResumeEventCallback</a> </td>
+ </tr>
+ <tr>
+ <td>
+backbutton </td>
+ <td>
+<a href="#BackButtonEventCallback">BackButtonEventCallback</a> </td>
+ </tr>
+ <tr>
+ <td>
+menubutton </td>
+ <td>
+<a href="#MenuButtonEventCallback">MenuButtonEventCallback</a> </td>
+ </tr>
+ <tr>
+ <td>
+searchbutton </td>
+ <td>
+<a href="#SearchButtonEventCallback">SearchButtonEventCallback</a> </td>
+ </tr>
+ <tr>
+ <td>
+startcallbutton </td>
+ <td>
+<a href="#StartCallEventCallback">StartCallEventCallback</a> </td>
+ </tr>
+ <tr>
+ <td>
+endcallbutton </td>
+ <td>
+<a href="#EndCallButtonEventCallback">EndCallButtonEventCallback</a> </td>
+ </tr>
+ <tr>
+ <td>
+volumedownbutton </td>
+ <td>
+<a href="#VolumeDownButtonEventCallback">VolumeDownButtonEventCallback</a> </td>
+ </tr>
+ <tr>
+ <td>
+volumeupbutton </td>
+ <td>
+<a href="#VolumeUpButtonEventCallback">VolumeUpButtonEventCallback</a> </td>
+ </tr>
+ <tr>
+ <th colspan="2">
+Network Information events </th>
+ </tr>
+ <tr>
+ <td>
+online </td>
+ <td>
+<a href="networkInformation.html#OnlineEventCallback">OnlineEventCallback</a> </td>
+ </tr>
+ <tr>
+ <td>
+offline </td>
+ <td>
+<a href="networkInformation.html#OfflineEventCallback">OfflineEventCallback</a> </td>
+ </tr>
+ </table>
+ </div>
+<h2>Table of Contents</h2>
+<ul class="toc">
+<li>1. <a href="#interfaces-section">Interfaces</a><ul class="toc">
+<li>1.1. <a href="#DeviceReadyEventCallback">DeviceReadyEventCallback</a>
+</li>
+<li>1.2. <a href="#PauseEventCallback">PauseEventCallback</a>
+</li>
+<li>1.3. <a href="#ResumeEventCallback">ResumeEventCallback</a>
+</li>
+<li>1.4. <a href="#BackButtonEventCallback">BackButtonEventCallback</a>
+</li>
+<li>1.5. <a href="#MenuButtonEventCallback">MenuButtonEventCallback</a>
+</li>
+<li>1.6. <a href="#SearchButtonEventCallback">SearchButtonEventCallback</a>
+</li>
+<li>1.7. <a href="#StartCallEventCallback">StartCallEventCallback</a>
+</li>
+<li>1.8. <a href="#EndCallButtonEventCallback">EndCallButtonEventCallback</a>
+</li>
+<li>1.9. <a href="#VolumeDownButtonEventCallback">VolumeDownButtonEventCallback</a>
+</li>
+<li>1.10. <a href="#VolumeUpButtonEventCallback">VolumeUpButtonEventCallback</a>
+</li>
+</ul>
+</li>
+<li>2. <a href="#full-webidl">Full WebIDL</a>
+</li>
+</ul>
+<hr>
+<h2 id="method-summary">Summary of Interfaces and Methods</h2>
+<table class="informaltable">
+<thead><tr>
+<th>Interface</th>
+<th>Method</th>
+</tr></thead>
+<tbody>
+<tr>
+<td><a href="#DeviceReadyEventCallback">DeviceReadyEventCallback</a></td>
+<td><div>void <a href="#DeviceReadyEventCallback::ondeviceready">ondeviceready</a> ()</div></td>
+</tr>
+<tr>
+<td><a href="#PauseEventCallback">PauseEventCallback</a></td>
+<td><div>void <a href="#PauseEventCallback::onpause">onpause</a> ()</div></td>
+</tr>
+<tr>
+<td><a href="#ResumeEventCallback">ResumeEventCallback</a></td>
+<td><div>void <a href="#ResumeEventCallback::onresume">onresume</a> ()</div></td>
+</tr>
+<tr>
+<td><a href="#BackButtonEventCallback">BackButtonEventCallback</a></td>
+<td><div>void <a href="#BackButtonEventCallback::onbackbutton">onbackbutton</a> ()</div></td>
+</tr>
+<tr>
+<td><a href="#MenuButtonEventCallback">MenuButtonEventCallback</a></td>
+<td><div>void <a href="#MenuButtonEventCallback::onmenubutton">onmenubutton</a> ()</div></td>
+</tr>
+<tr>
+<td><a href="#SearchButtonEventCallback">SearchButtonEventCallback</a></td>
+<td><div>void <a href="#SearchButtonEventCallback::onsearchbutton">onsearchbutton</a> ()</div></td>
+</tr>
+<tr>
+<td><a href="#StartCallEventCallback">StartCallEventCallback</a></td>
+<td><div>void <a href="#StartCallEventCallback::onstartcallbutton">onstartcallbutton</a> ()</div></td>
+</tr>
+<tr>
+<td><a href="#EndCallButtonEventCallback">EndCallButtonEventCallback</a></td>
+<td><div>void <a href="#EndCallButtonEventCallback::onendcallbutton">onendcallbutton</a> ()</div></td>
+</tr>
+<tr>
+<td><a href="#VolumeDownButtonEventCallback">VolumeDownButtonEventCallback</a></td>
+<td><div>void <a href="#VolumeDownButtonEventCallback::onvolumedownbutton">onvolumedownbutton</a> ()</div></td>
+</tr>
+<tr>
+<td><a href="#VolumeUpButtonEventCallback">VolumeUpButtonEventCallback</a></td>
+<td><div>void <a href="#VolumeUpButtonEventCallback::onvolumeupbutton">onvolumeupbutton</a> ()</div></td>
+</tr>
+</tbody>
+</table>
+<div class="interfaces" id="interfaces-section">
+<h2>1. Interfaces</h2>
+<div class="interface" id="DeviceReadyEventCallback">
+<a class="backward-compatibility-anchor" name="::Events::DeviceReadyEventCallback"></a><h3>1.1. DeviceReadyEventCallback</h3>
+<div class="brief">
+ Callback for the event which fires when Cordova is fully loaded
+ </div>
+<pre class="webidl prettyprint">[NoInterfaceObject, Callback=FunctionOnly]
+interface DeviceReadyEventCallback {
+ void ondeviceready();
+};</pre>
+<p><span class="version">
+ Since: </span>
+ 3.0
+ </p>
+<div class="description">
+ <p>
+The <var>domready</var> event is essential to any application. It signals that Cordova's device APIs have loaded and are ready to access.
+ </p>
+ <p>
+Cordova consists of two code bases: native and JavaScript. While the native code loads, a custom loading image displays. However, JavaScript only loads once the DOM loads. This means the web app may potentially call a Cordova JavaScript function before the corresponding native code becomes available.
+ </p>
+ <p>
+The deviceready event fires once Cordova has fully loaded. Once the event fires, you can safely make calls to Cordova APIs. Applications typically attach an event listener with document.addEventListener once the HTML document's DOM has loaded.
+ </p>
+ <p>
+The deviceready event behaves somewhat differently from others. Any event handler registered after the deviceready event fires has its callback function called immediately.
+ </p>
+ <p>
+Original documentation: <a href="https://cordova.apache.org/docs/en/latest/cordova/events/events.deviceready.html">Cordova deviceredy event</a> </p>
+ </div>
+<div class="example">
+<span class="example"><p>Code example:</p></span><pre name="code" class="examplecode prettyprint"> document.addEventListener('deviceready', onDeviceReady, false);
+
+ function onDeviceReady() {
+ // Now safe to use device APIs
+ }
+ </pre>
+</div>
+</div>
+<div class="interface" id="PauseEventCallback">
+<a class="backward-compatibility-anchor" name="::Events::PauseEventCallback"></a><h3>1.2. PauseEventCallback</h3>
+<div class="brief">
+ Callback for the event which fires when an application is put into the background
+ </div>
+<pre class="webidl prettyprint">[NoInterfaceObject, Callback=FunctionOnly]
+interface PauseEventCallback {
+ void onpause();
+};</pre>
+<p><span class="version">
+ Since: </span>
+ 3.0
+ </p>
+<div class="description">
+ <p>
+The <var>pause</var> event fires when the native platform puts the application into the background, typically when the user switches to a different application.
+ </p>
+ <p>
+Applications typically should use document.addEventListener() to attach an event listener once the <a href="#DeviceReadyEventCallback">deviceready</a> event fires.
+ </p>
+ <p>
+Original documentation: <a href="https://cordova.apache.org/docs/en/latest/cordova/events/events.pause.html">Cordova pause event</a> </p>
+ </div>
+<div class="example">
+<span class="example"><p>Code example:</p></span><pre name="code" class="examplecode prettyprint"> document.addEventListener('deviceready', onDeviceReady, false);
+
+ function onDeviceReady() {
+ document.addEventListener('pause', onPause, false);
+ }
+
+ function onPause() {
+ // Handle the pause event
+ }
+ </pre>
+</div>
+</div>
+<div class="interface" id="ResumeEventCallback">
+<a class="backward-compatibility-anchor" name="::Events::ResumeEventCallback"></a><h3>1.3. ResumeEventCallback</h3>
+<div class="brief">
+ Callback for the event which fires when an application is retrieved from the background
+ </div>
+<pre class="webidl prettyprint">[NoInterfaceObject, Callback=FunctionOnly]
+interface ResumeEventCallback {
+ void onresume();
+};</pre>
+<p><span class="version">
+ Since: </span>
+ 3.0
+ </p>
+<div class="description">
+ <p>
+The <var>resume</var> event fires when the native platform pulls the application out from the background.
+ </p>
+ <p>
+Applications typically should use document.addEventListener() to attach an event listener once the <a href="#DeviceReadyEventCallback">deviceready</a> event fires.
+ </p>
+ <p>
+Original documentation: <a href="https://cordova.apache.org/docs/en/latest/cordova/events/events.resume.html">Cordova resume event</a> </p>
+ </div>
+<div class="example">
+<span class="example"><p>Code example:</p></span><pre name="code" class="examplecode prettyprint"> document.addEventListener('deviceready', onDeviceReady, false);
+
+ function onDeviceReady() {
+ document.addEventListener('resume', onResume, false);
+ }
+
+ function onResume() {
+ // Handle the resume event
+ }
+ </pre>
+</div>
+</div>
+<div class="interface" id="BackButtonEventCallback">
+<a class="backward-compatibility-anchor" name="::Events::BackButtonEventCallback"></a><h3>1.4. BackButtonEventCallback</h3>
+<div class="brief">
+ Callback for the event which fires when the user presses the back button
+ </div>
+<pre class="webidl prettyprint">[NoInterfaceObject, Callback=FunctionOnly]
+interface BackButtonEventCallback {
+ void onbackbutton();
+};</pre>
+<p><span class="version">
+ Since: </span>
+ 3.0
+ </p>
+<div class="description">
+ <p>
+To override the default back-button behavior, register an event listener for the backbutton event, typically by calling document.addEventListener() once you receive the <a href="#DeviceReadyEventCallback">deviceready</a> event.
+It is no longer necessary to call any other method to override the back-button behavior.
+ </p>
+ <p>
+Original documentation: <a href="https://cordova.apache.org/docs/en/latest/cordova/events/events.backbutton.html">Cordova backbutton event</a> </p>
+ </div>
+<div class="example">
+<span class="example"><p>Code example:</p></span><pre name="code" class="examplecode prettyprint"> document.addEventListener('deviceready', onDeviceReady, false);
+
+ function onDeviceReady() {
+ document.addEventListener('backbutton', onBackKeyDown, false);
+ }
+
+ function onBackKeyDown() {
+ // Handle the back button
+ }
+ </pre>
+</div>
+</div>
+<div class="interface" id="MenuButtonEventCallback">
+<a class="backward-compatibility-anchor" name="::Events::MenuButtonEventCallback"></a><h3>1.5. MenuButtonEventCallback</h3>
+<div class="brief">
+ Callback for the event which fires when the user presses the menu button
+ </div>
+<pre class="webidl prettyprint">[NoInterfaceObject, Callback=FunctionOnly]
+interface MenuButtonEventCallback {
+ void onmenubutton();
+};</pre>
+<p><span class="version">
+ Since: </span>
+ 3.0
+ </p>
+<div class="description">
+ <p>
+Applying an event handler for the <var>menubutton</var> event overrides the default menu button behavior.
+ </p>
+ <p>
+Applications typically should use document.addEventListener() to attach an event listener once the <a href="#DeviceReadyEventCallback">deviceready</a> event fires.
+ </p>
+ <p>
+Original documentation: <a href="https://cordova.apache.org/docs/en/latest/cordova/events/events.menubutton.html">Cordova menubutton event</a> </p>
+ </div>
+<div class="example">
+<span class="example"><p>Code example:</p></span><pre name="code" class="examplecode prettyprint"> document.addEventListener('deviceready', onDeviceReady, false);
+
+ function onDeviceReady() {
+ document.addEventListener('menubutton', onMenuKeyDown, false);
+ }
+
+ function onMenuKeyDown() {
+ // Handle the back button
+ }
+ </pre>
+</div>
+</div>
+<div class="interface" id="SearchButtonEventCallback">
+<a class="backward-compatibility-anchor" name="::Events::SearchButtonEventCallback"></a><h3>1.6. SearchButtonEventCallback</h3>
+<div class="brief">
+ Callback for the event which fires when the user presses the search button
+ </div>
+<pre class="webidl prettyprint">[NoInterfaceObject, Callback=FunctionOnly]
+interface SearchButtonEventCallback {
+ void onsearchbutton();
+};</pre>
+<p><span class="version">
+ Since: </span>
+ 3.0
+ </p>
+<div class="description">
+ <p>
+If you need to override the default search button behavior on Android you can register an event listener for the <var>searchbutton</var> event.
+ </p>
+ <p>
+Applications typically should use document.addEventListener() to attach an event listener once the <a href="#DeviceReadyEventCallback">deviceready</a> event fires.
+ </p>
+ <p>
+Original documentation: <a href="https://cordova.apache.org/docs/en/latest/cordova/events/events.searchbutton.html">Cordova searchbutton event</a> </p>
+ </div>
+<div class="example">
+<span class="example"><p>Code example:</p></span><pre name="code" class="examplecode prettyprint"> document.addEventListener('deviceready', onDeviceReady, false);
+
+ function onDeviceReady() {
+ document.addEventListener('searchbutton', onSearchKeyDown, false);
+ }
+
+ function onSearchKeyDown() {
+ // Handle the search button
+ }
+ </pre>
+</div>
+</div>
+<div class="interface" id="StartCallEventCallback">
+<a class="backward-compatibility-anchor" name="::Events::StartCallEventCallback"></a><h3>1.7. StartCallEventCallback</h3>
+<div class="brief">
+ Callback for the event which fires when the user presses the start call button
+ </div>
+<pre class="webidl prettyprint">[NoInterfaceObject, Callback=FunctionOnly]
+interface StartCallEventCallback {
+ void onstartcallbutton();
+};</pre>
+<p><span class="version">
+ Since: </span>
+ 3.0
+ </p>
+<div class="description">
+ <p>
+If you need to override the default start call behavior you can register an event listener for the <var>startcallbutton</var> event.
+ </p>
+ <p>
+Applications typically should use document.addEventListener() to attach an event listener once the <a href="#DeviceReadyEventCallback">deviceready</a> event fires.
+ </p>
+ <p>
+Original documentation: <a href="https://cordova.apache.org/docs/en/latest/cordova/events/events.startcallbutton.html">Cordova startcallbutton event</a> </p>
+ </div>
+<div class="example">
+<span class="example"><p>Code example:</p></span><pre name="code" class="examplecode prettyprint"> document.addEventListener('deviceready', onDeviceReady, false);
+
+ function onDeviceReady() {
+ document.addEventListener('startcallbutton', onStartCallKeyDown, false);
+ }
+
+ function onStartCallKeyDown() {
+ // Handle the start call button
+ }
+ </pre>
+</div>
+</div>
+<div class="interface" id="EndCallButtonEventCallback">
+<a class="backward-compatibility-anchor" name="::Events::EndCallButtonEventCallback"></a><h3>1.8. EndCallButtonEventCallback</h3>
+<div class="brief">
+ Callback for the event which fires when the user presses the end call button
+ </div>
+<pre class="webidl prettyprint">[NoInterfaceObject, Callback=FunctionOnly]
+interface EndCallButtonEventCallback {
+ void onendcallbutton();
+};</pre>
+<p><span class="version">
+ Since: </span>
+ 3.0
+ </p>
+<div class="description">
+ <p>
+The <var>endcallbutton</var> event overrides the default end call behavior.
+ </p>
+ <p>
+Applications typically should use document.addEventListener() to attach an event listener once the <a href="#DeviceReadyEventCallback">deviceready</a> event fires.
+ </p>
+ <p>
+Original documentation: <a href="https://cordova.apache.org/docs/en/latest/cordova/events/events.endcallbutton.html">Cordova endcallbutton event</a> </p>
+ </div>
+<div class="example">
+<span class="example"><p>Code example:</p></span><pre name="code" class="examplecode prettyprint"> document.addEventListener('deviceready', onDeviceReady, false);
+
+ function onDeviceReady() {
+ document.addEventListener('endcallbutton', onEndCallKeyDown, false);
+ }
+
+ function onEndCallKeyDown() {
+ // Handle the end call button
+ }
+ </pre>
+</div>
+</div>
+<div class="interface" id="VolumeDownButtonEventCallback">
+<a class="backward-compatibility-anchor" name="::Events::VolumeDownButtonEventCallback"></a><h3>1.9. VolumeDownButtonEventCallback</h3>
+<div class="brief">
+ Callback for the event which fires when the user presses the volume down button
+ </div>
+<pre class="webidl prettyprint">[NoInterfaceObject, Callback=FunctionOnly]
+interface VolumeDownButtonEventCallback {
+ void onvolumedownbutton();
+};</pre>
+<p><span class="version">
+ Since: </span>
+ 3.0
+ </p>
+<div class="description">
+ <p>
+If you need to override the default volume down behavior you can register an event listener for the <var>volumedownbutton</var> event.
+ </p>
+ <p>
+Applications typically should use document.addEventListener() to attach an event listener once the <a href="#DeviceReadyEventCallback">deviceready</a> event fires.
+ </p>
+ <p>
+Original documentation: <a href="https://cordova.apache.org/docs/en/latest/cordova/events/events.volumedownbutton.html">Cordova volumedownbutton event</a> </p>
+ </div>
+<div class="example">
+<span class="example"><p>Code example:</p></span><pre name="code" class="examplecode prettyprint"> document.addEventListener('deviceready', onDeviceReady, false);
+
+ function onDeviceReady() {
+ document.addEventListener('volumedownbutton', onVolumeDownKeyDown, false);
+ }
+
+ function onVolumeDownKeyDown() {
+ // Handle the volume down button
+ }
+ </pre>
+</div>
+</div>
+<div class="interface" id="VolumeUpButtonEventCallback">
+<a class="backward-compatibility-anchor" name="::Events::VolumeUpButtonEventCallback"></a><h3>1.10. VolumeUpButtonEventCallback</h3>
+<div class="brief">
+ Callback for the event which fires when the user presses the volume up button
+ </div>
+<pre class="webidl prettyprint">[NoInterfaceObject, Callback=FunctionOnly]
+interface VolumeUpButtonEventCallback {
+ void onvolumeupbutton();
+};</pre>
+<p><span class="version">
+ Since: </span>
+ 3.0
+ </p>
+<div class="description">
+ <p>
+If you need to override the default volume up behavior you can register an event listener for the <var>volumeupbutton</var> event.
+ </p>
+ <p>
+Applications typically should use document.addEventListener() to attach an event listener once the <a href="#DeviceReadyEventCallback">deviceready</a> event fires.
+ </p>
+ <p>
+Original documentation: <a href="https://cordova.apache.org/docs/en/latest/cordova/events/events.volumeupbutton.html">Cordova volumeupbutton event</a> </p>
+ </div>
+<div class="example">
+<span class="example"><p>Code example:</p></span><pre name="code" class="examplecode prettyprint"> document.addEventListener('deviceready', onDeviceReady, false);
+
+ function onDeviceReady() {
+ document.addEventListener('volumeupbutton', onVolumeUpKeyDown, false);
+ }
+
+ function onVolumeUpKeyDown() {
+ // Handle the volume up button
+ }
+ </pre>
+</div>
+</div>
+</div>
+<h2 id="full-webidl">2. Full WebIDL</h2>
+<pre class="webidl prettyprint">module Events {
+
+[NoInterfaceObject, Callback=FunctionOnly]
+interface DeviceReadyEventCallback {
+ void ondeviceready();
+};
+
+[NoInterfaceObject, Callback=FunctionOnly]
+interface PauseEventCallback {
+ void onpause();
+};
+
+[NoInterfaceObject, Callback=FunctionOnly]
+interface ResumeEventCallback {
+ void onresume();
+};
+
+[NoInterfaceObject, Callback=FunctionOnly]
+interface BackButtonEventCallback {
+ void onbackbutton();
+};
+
+[NoInterfaceObject, Callback=FunctionOnly]
+interface MenuButtonEventCallback {
+ void onmenubutton();
+};
+
+[NoInterfaceObject, Callback=FunctionOnly]
+interface SearchButtonEventCallback {
+ void onsearchbutton();
+};
+
+[NoInterfaceObject, Callback=FunctionOnly]
+interface StartCallEventCallback {
+ void onstartcallbutton();
+};
+
+[NoInterfaceObject, Callback=FunctionOnly]
+interface EndCallButtonEventCallback {
+ void onendcallbutton();
+};
+
+[NoInterfaceObject, Callback=FunctionOnly]
+interface VolumeDownButtonEventCallback {
+ void onvolumedownbutton();
+};
+
+[NoInterfaceObject, Callback=FunctionOnly]
+interface VolumeUpButtonEventCallback {
+ void onvolumeupbutton();
+};
+};</pre>
+</div>
+<div id="page-footer">
+<div class="copyright" align="center">
+ Except as noted, this content - excluding the Code Examples - is licensed under <a href="http://creativecommons.org/licenses/by/3.0/legalcode" target="_blank">Creative Commons Attribution 3.0</a> and all of the Code Examples contained herein are licensed under <a href="https://www.tizen.org/bsd-3-clause-license" target="_blank">BSD-3-Clause</a>. <br>For details, see the <a href="https://www.tizen.org/content-license" target="_blank">Content License</a>.
+ </div>
+<script type="text/javascript">
+
+ var _gaq = _gaq || [];
+ _gaq.push(['_setAccount', 'UA-25976949-1']);
+ _gaq.push(['_setDomainName', 'tizen.org']);
+ _gaq.push(['_trackPageview']);
+
+ (function() {
+ var ga = document.createElement('script'); ga.type = 'text/javascript'; ga.async = true;
+ var s = document.getElementsByTagName('script')[0]; s.parentNode.insertBefore(ga, s);
+ })();
+
+ </script>
+</div>
+</body>
+</html>
--- /dev/null
+<!DOCTYPE html PUBLIC "html">
+<html>
+<head>
+<meta http-equiv="Content-Type" content="text/html; charset=utf-8">
+<link rel="stylesheet" type="text/css" href="../tizen.css" media="screen">
+<script type="text/javascript" src="snippet.js"></script><title>File API</title>
+</head>
+<body id="page-content" onload="prettyPrint()">
+<div class="api" id="::File">
+<div class="supported-platforms"><img class="mobile-mandatory emulator" title="Mandatory, Supported by Tizen Mobile emulator" src="../mobile_s_w.png"></div>
+<div class="title"><h1>File API</h1></div>
+<div class="brief">
+ This plugin implements a File API allowing read/write access to files residing on the device.
+ </div>
+<div class="description">
+ <p>
+Original documentation: <a href="https://www.npmjs.com/package/cordova-plugin-file">Cordova File</a>.
+ </p>
+ </div>
+<p><span class="version">
+ Since: </span>
+ 3.0
+ </p>
+<h2>Table of Contents</h2>
+<ul class="toc">
+<li>1. <a href="#typedefs-section">Type Definitions</a><ul class="toc">
+<li>
+ 1.1. <a href="#WriteData">WriteData</a>
+</li>
+<li>
+ 1.2. <a href="#ReadResultData">ReadResultData</a>
+</li>
+</ul>
+</li>
+<li>2. <a href="#interfaces-section">Interfaces</a><ul class="toc">
+<li>2.1. <a href="#FilePropertyBag">FilePropertyBag</a>
+</li>
+<li>2.2. <a href="#ProgressEventInit">ProgressEventInit</a>
+</li>
+<li>2.3. <a href="#ProgressEvent">ProgressEvent</a>
+</li>
+<li>2.4. <a href="#FileSystemManagerObject">FileSystemManagerObject</a>
+</li>
+<li>2.5. <a href="#FileSystemManager">FileSystemManager</a>
+</li>
+<li>2.6. <a href="#FileSystem">FileSystem</a>
+</li>
+<li>2.7. <a href="#Metadata">Metadata</a>
+</li>
+<li>2.8. <a href="#FileError">FileError</a>
+</li>
+<li>2.9. <a href="#File">File</a>
+</li>
+<li>2.10. <a href="#LocalFileSystem">LocalFileSystem</a>
+</li>
+<li>2.11. <a href="#Entry">Entry</a>
+</li>
+<li>2.12. <a href="#DirectoryEntry">DirectoryEntry</a>
+</li>
+<li>2.13. <a href="#DirectoryReader">DirectoryReader</a>
+</li>
+<li>2.14. <a href="#FileEntry">FileEntry</a>
+</li>
+<li>2.15. <a href="#FileReader">FileReader</a>
+</li>
+<li>2.16. <a href="#FileWriter">FileWriter</a>
+</li>
+<li>2.17. <a href="#ProgressCallback">ProgressCallback</a>
+</li>
+<li>2.18. <a href="#FileSystemCallback">FileSystemCallback</a>
+</li>
+<li>2.19. <a href="#EntryCallback">EntryCallback</a>
+</li>
+<li>2.20. <a href="#EntriesCallback">EntriesCallback</a>
+</li>
+<li>2.21. <a href="#MetadataCallback">MetadataCallback</a>
+</li>
+<li>2.22. <a href="#FileWriterCallback">FileWriterCallback</a>
+</li>
+<li>2.23. <a href="#FileCallback">FileCallback</a>
+</li>
+<li>2.24. <a href="#VoidCallback">VoidCallback</a>
+</li>
+<li>2.25. <a href="#ErrorCallback">ErrorCallback</a>
+</li>
+</ul>
+</li>
+<li>3. <a href="#full-webidl">Full WebIDL</a>
+</li>
+</ul>
+<hr>
+<h2 id="method-summary">Summary of Interfaces and Methods</h2>
+<table class="informaltable">
+<thead><tr>
+<th>Interface</th>
+<th>Method</th>
+</tr></thead>
+<tbody>
+<tr>
+<td><a href="#FilePropertyBag">FilePropertyBag</a></td>
+<td></td>
+</tr>
+<tr>
+<td><a href="#ProgressEventInit">ProgressEventInit</a></td>
+<td></td>
+</tr>
+<tr>
+<td><a href="#ProgressEvent">ProgressEvent</a></td>
+<td></td>
+</tr>
+<tr>
+<td><a href="#FileSystemManagerObject">FileSystemManagerObject</a></td>
+<td></td>
+</tr>
+<tr>
+<td><a href="#FileSystemManager">FileSystemManager</a></td>
+<td></td>
+</tr>
+<tr>
+<td><a href="#FileSystem">FileSystem</a></td>
+<td></td>
+</tr>
+<tr>
+<td><a href="#Metadata">Metadata</a></td>
+<td></td>
+</tr>
+<tr>
+<td><a href="#FileError">FileError</a></td>
+<td></td>
+</tr>
+<tr>
+<td><a href="#File">File</a></td>
+<td></td>
+</tr>
+<tr>
+<td><a href="#LocalFileSystem">LocalFileSystem</a></td>
+<td>
+<div>void <a href="#LocalFileSystem::requestFileSystem">requestFileSystem</a> (short type, long long size, optional <a href="#FileSystemCallback">FileSystemCallback</a>? successCallback, optional <a href="#ErrorCallback">ErrorCallback</a>? errorCallback)</div>
+<div>void <a href="#LocalFileSystem::resolveLocalFileSystemURL">resolveLocalFileSystemURL</a> (DOMString uri, optional <a href="#EntryCallback">EntryCallback</a>? successCallback, optional <a href="#ErrorCallback">ErrorCallback</a>? errorCallback)</div>
+</td>
+</tr>
+<tr>
+<td><a href="#Entry">Entry</a></td>
+<td>
+<div>void <a href="#Entry::getMetadata">getMetadata</a> (<a href="#MetadataCallback">MetadataCallback</a> onsuccess, optional <a href="#ErrorCallback">ErrorCallback</a>? onerror)</div>
+<div>void <a href="#Entry::moveTo">moveTo</a> (<a href="#DirectoryEntry">DirectoryEntry</a> parent, optional DOMString? newName, optional <a href="#EntryCallback">EntryCallback</a>? onsuccess, optional <a href="#ErrorCallback">ErrorCallback</a>? onerror)</div>
+<div>void <a href="#Entry::copyTo">copyTo</a> (<a href="#DirectoryEntry">DirectoryEntry</a> parent, optional DOMString? newName, optional <a href="#EntryCallback">EntryCallback</a>? onsuccess, optional <a href="#ErrorCallback">ErrorCallback</a>? onerror)</div>
+<div>void <a href="#Entry::getParent">getParent</a> (<a href="#EntryCallback">EntryCallback</a> onsuccess, optional <a href="#ErrorCallback">ErrorCallback</a>? onerror)</div>
+<div>void <a href="#Entry::remove">remove</a> (<a href="#VoidCallback">VoidCallback</a> onsuccess, optional <a href="#ErrorCallback">ErrorCallback</a>? onerror)</div>
+<div>DOMString <a href="#Entry::toURL">toURL</a> ()</div>
+</td>
+</tr>
+<tr>
+<td><a href="#DirectoryEntry">DirectoryEntry</a></td>
+<td>
+<div>
+<a href="#DirectoryReader">DirectoryReader</a> <a href="#DirectoryEntry::createReader">createReader</a> ()</div>
+<div>void <a href="#DirectoryEntry::getDirectory">getDirectory</a> (DOMString path, optional ? options, optional <a href="#EntryCallback">EntryCallback</a>? onsuccess, optional <a href="#ErrorCallback">ErrorCallback</a>? onerror)</div>
+<div>void <a href="#DirectoryEntry::getFile">getFile</a> (DOMString path, optional ? options, optional <a href="#EntryCallback">EntryCallback</a>? onsuccess, optional <a href="#ErrorCallback">ErrorCallback</a>? onerror)</div>
+<div>void <a href="#DirectoryEntry::removeRecursively">removeRecursively</a> (<a href="#VoidCallback">VoidCallback</a> onsuccess, optional <a href="#ErrorCallback">ErrorCallback</a>? onerror)</div>
+</td>
+</tr>
+<tr>
+<td><a href="#DirectoryReader">DirectoryReader</a></td>
+<td><div>void <a href="#DirectoryReader::readEntries">readEntries</a> (<a href="#EntriesCallback">EntriesCallback</a> onsuccess, optional <a href="#ErrorCallback">ErrorCallback</a>? onerror)</div></td>
+</tr>
+<tr>
+<td><a href="#FileEntry">FileEntry</a></td>
+<td>
+<div>void <a href="#FileEntry::createWriter">createWriter</a> (<a href="#FileWriterCallback">FileWriterCallback</a> onsuccess, optional <a href="#ErrorCallback">ErrorCallback</a>? onerror)</div>
+<div>void <a href="#FileEntry::file">file</a> (<a href="#FileCallback">FileCallback</a> onsuccess, optional <a href="#ErrorCallback">ErrorCallback</a> onerror)</div>
+</td>
+</tr>
+<tr>
+<td><a href="#FileReader">FileReader</a></td>
+<td>
+<div>void <a href="#FileReader::abort">abort</a> ()</div>
+<div>void <a href="#FileReader::readAsDataURL">readAsDataURL</a> ( blob)</div>
+<div>void <a href="#FileReader::readAsText">readAsText</a> ( blob, optional DOMString? label)</div>
+<div>void <a href="#FileReader::readAsBinaryString">readAsBinaryString</a> ( blob)</div>
+<div>void <a href="#FileReader::readAsArrayBuffer">readAsArrayBuffer</a> ( blob)</div>
+</td>
+</tr>
+<tr>
+<td><a href="#FileWriter">FileWriter</a></td>
+<td>
+<div>void <a href="#FileWriter::abort">abort</a> ()</div>
+<div>void <a href="#FileWriter::seek">seek</a> (long offset)</div>
+<div>void <a href="#FileWriter::truncate">truncate</a> (long size)</div>
+<div>void <a href="#FileWriter::write">write</a> (<a href="#WriteData">WriteData</a> data)</div>
+</td>
+</tr>
+<tr>
+<td><a href="#ProgressCallback">ProgressCallback</a></td>
+<td><div>void <a href="#ProgressCallback::onsuccess">onsuccess</a> (<a href="#ProgressEvent">ProgressEvent</a> event)</div></td>
+</tr>
+<tr>
+<td><a href="#FileSystemCallback">FileSystemCallback</a></td>
+<td><div>void <a href="#FileSystemCallback::handleEvent">handleEvent</a> (<a href="#FileSystem">FileSystem</a> filesystem)</div></td>
+</tr>
+<tr>
+<td><a href="#EntryCallback">EntryCallback</a></td>
+<td><div>void <a href="#EntryCallback::handleEvent">handleEvent</a> (<a href="#Entry">Entry</a> entry)</div></td>
+</tr>
+<tr>
+<td><a href="#EntriesCallback">EntriesCallback</a></td>
+<td><div>void <a href="#EntriesCallback::handleEvent">handleEvent</a> (<a href="#Entry">Entry</a>[] entries)</div></td>
+</tr>
+<tr>
+<td><a href="#MetadataCallback">MetadataCallback</a></td>
+<td><div>void <a href="#MetadataCallback::handleEvent">handleEvent</a> (<a href="#Metadata">Metadata</a> metadata)</div></td>
+</tr>
+<tr>
+<td><a href="#FileWriterCallback">FileWriterCallback</a></td>
+<td><div>void <a href="#FileWriterCallback::handleEvent">handleEvent</a> (<a href="#FileWriter">FileWriter</a> fileWriter)</div></td>
+</tr>
+<tr>
+<td><a href="#FileCallback">FileCallback</a></td>
+<td><div>void <a href="#FileCallback::handleEvent">handleEvent</a> (<a href="#File">File</a> file)</div></td>
+</tr>
+<tr>
+<td><a href="#VoidCallback">VoidCallback</a></td>
+<td><div>void <a href="#VoidCallback::handleEvent">handleEvent</a> ()</div></td>
+</tr>
+<tr>
+<td><a href="#ErrorCallback">ErrorCallback</a></td>
+<td><div>void <a href="#ErrorCallback::handleEvent">handleEvent</a> (<a href="#FileError">FileError</a> err)</div></td>
+</tr>
+</tbody>
+</table>
+<div class="typedefs" id="typedefs-section">
+<h2>1. Type Definitions</h2>
+<div class="typedef" id="WriteData">
+<a class="backward-compatibility-anchor" name="::File::WriteData"></a><h3>1.1. WriteData</h3>
+<div class="brief">
+ Specifies the user or system defined event data.
+ </div>
+<pre class="webidl prettyprint"> typedef ( or DOMString) WriteData;</pre>
+<p><span class="version">
+ Since: </span>
+ 3.0
+ </p>
+</div>
+<div class="typedef" id="ReadResultData">
+<a class="backward-compatibility-anchor" name="::File::ReadResultData"></a><h3>1.2. ReadResultData</h3>
+<div class="brief">
+ Specifies the result data of <em>FileReader</em> object.
+ </div>
+<pre class="webidl prettyprint"> typedef (DOMString or byte[]) ReadResultData;</pre>
+<p><span class="version">
+ Since: </span>
+ 3.0
+ </p>
+</div>
+</div>
+<div class="interfaces" id="interfaces-section">
+<h2>2. Interfaces</h2>
+<div class="dictionary" id="FilePropertyBag">
+<a class="backward-compatibility-anchor" name="::File::FilePropertyBag"></a><h3>2.1. FilePropertyBag</h3>
+<div class="brief">
+ FilePropertyBag.
+ </div>
+<pre class="webidl prettyprint"> dictionary FilePropertyBag {
+
+ DOMString type;
+
+ long long lastModified;
+ };</pre>
+<p><span class="version">
+ Since: </span>
+ 3.0
+ </p>
+<div class="attributes">
+<h4>Dictionary members</h4>
+<dl>
+<dt class="member" id="FilePropertyBag::type"><span class="attrName">DOMString type</span></dt>
+<dd>
+<div class="brief">
+ The ASCII-encoded string in lower case representing the media type of the File. Normative conditions for this member are provided in the File constructor steps.
+ </div>
+<p><span class="version">
+ Since: </span>
+ 3.0
+ </p>
+</dd>
+<dt class="member" id="FilePropertyBag::lastModified"><span class="attrName">long long lastModified</span></dt>
+<dd>
+<div class="brief">
+ conditions for this member are provided in the File constructor steps.
+ </div>
+<p><span class="version">
+ Since: </span>
+ 3.0
+ </p>
+</dd>
+</dl>
+</div>
+</div>
+<div class="dictionary" id="ProgressEventInit">
+<a class="backward-compatibility-anchor" name="::File::ProgressEventInit"></a><h3>2.2. ProgressEventInit</h3>
+<div class="brief">
+ A dictionary used to initialize ProgressEvent object.
+ </div>
+<pre class="webidl prettyprint"> dictionary ProgressEventInit {
+ unsigned long long loaded = false;
+ unsigned long long total = false;
+ target = null;
+ };</pre>
+<p><span class="version">
+ Since: </span>
+ 3.0
+ </p>
+</div>
+<div class="interface" id="ProgressEvent">
+<a class="backward-compatibility-anchor" name="::File::ProgressEvent"></a><h3>2.3. ProgressEvent</h3>
+<div class="brief">
+ The interface that indicates progression event.
+ </div>
+<pre class="webidl prettyprint"> [Constructor(DOMString type, optional <a href="#ProgressEventInit">ProgressEventInit</a> eventInitDict)]
+ interface ProgressEvent {
+ readonly attribute DOMString type;
+ readonly attribute boolean bubbles;
+ readonly attribute boolean cancelBubble;
+ readonly attribute boolean cancelable;
+ readonly attribute boolean lengthComputable;
+ readonly attribute unsigned long long loaded;
+ readonly attribute unsigned long long total;
+ readonly attribute target;
+ };</pre>
+<p><span class="version">
+ Since: </span>
+ 3.0
+ </p>
+<div class="example">
+<span class="example"><p>Code example:</p></span><pre name="code" class="examplecode prettyprint"> var eventInit = {
+ loaded: 128,
+ total: 1024
+ };
+ var event = new ProgressEvent('submit', eventInit);
+ </pre>
+</div>
+<div class="constructors">
+<h4 id="ProgressEvent::constructor">Constructors</h4>
+<dl><pre class="webidl prettyprint">ProgressEvent(DOMString type, optional <a href="#ProgressEventInit">ProgressEventInit</a> eventInitDict);</pre></dl>
+</div>
+<div class="attributes">
+<h4>Attributes</h4>
+<ul>
+<li class="attribute" id="ProgressEvent::type">
+<span class="attrName"><span class="readonly"> readonly
+</span><span class="type">DOMString </span><span class="name">type</span></span><div class="brief">
+ The type of event, e.g. 'click', 'hashchange', or 'submit'.
+ </div>
+<p><span class="version">
+ Since: </span>
+ 3.0
+ </p>
+</li>
+<li class="attribute" id="ProgressEvent::bubbles">
+<span class="attrName"><span class="readonly"> readonly
+</span><span class="type">boolean </span><span class="name">bubbles</span></span><div class="brief">
+ True if event's goes through its target attribute value's ancestors in reverse tree order, and false otherwise.
+ </div>
+<p><span class="version">
+ Since: </span>
+ 3.0
+ </p>
+</li>
+<li class="attribute" id="ProgressEvent::cancelBubble">
+<span class="attrName"><span class="readonly"> readonly
+</span><span class="type">boolean </span><span class="name">cancelBubble</span></span><div class="brief">
+ Cancel bubble
+ </div>
+<p><span class="version">
+ Since: </span>
+ 3.0
+ </p>
+</li>
+<li class="attribute" id="ProgressEvent::cancelable">
+<span class="attrName"><span class="readonly"> readonly
+</span><span class="type">boolean </span><span class="name">cancelable</span></span><div class="brief">
+ Its return value does not always carry meaning, but true can indicate that part of the operation during which event was dispatched, can be canceled.
+ </div>
+<p><span class="version">
+ Since: </span>
+ 3.0
+ </p>
+</li>
+<li class="attribute" id="ProgressEvent::lengthComputable">
+<span class="attrName"><span class="readonly"> readonly
+</span><span class="type">boolean </span><span class="name">lengthComputable</span></span><div class="brief">
+ True when the length of the transferred content is known.
+ </div>
+<p><span class="version">
+ Since: </span>
+ 3.0
+ </p>
+</li>
+<li class="attribute" id="ProgressEvent::loaded">
+<span class="attrName"><span class="readonly"> readonly
+</span><span class="type">unsigned long long </span><span class="name">loaded</span></span><div class="brief">
+ Number of bytes transferred.
+ </div>
+<p><span class="version">
+ Since: </span>
+ 3.0
+ </p>
+</li>
+<li class="attribute" id="ProgressEvent::total">
+<span class="attrName"><span class="readonly"> readonly
+</span><span class="type">unsigned long long </span><span class="name">total</span></span><div class="brief">
+ The total length of the content. This attribute is set when lengthComputable is true.
+ </div>
+<p><span class="version">
+ Since: </span>
+ 3.0
+ </p>
+</li>
+<li class="attribute" id="ProgressEvent::target">
+<span class="attrName"><span class="readonly"> readonly
+</span><span class="type">EventTarget </span><span class="name">target</span></span><div class="brief">
+ The object to which event is dispatched.
+ </div>
+<p><span class="version">
+ Since: </span>
+ 3.0
+ </p>
+</li>
+</ul>
+</div>
+</div>
+<div class="interface" id="FileSystemManagerObject">
+<a class="backward-compatibility-anchor" name="::File::FileSystemManagerObject"></a><h3>2.4. FileSystemManagerObject</h3>
+<div class="brief">
+ The FileSystemManagerObject interface defines what is instantiated by the Cordova object.
+ </div>
+<pre class="webidl prettyprint"> [NoInterfaceObject] interface FileSystemManagerObject {
+ readonly attribute <a href="#FileSystemManager">FileSystemManager</a> file;
+ };</pre>
+<pre class="webidl prettyprint"> <a href="cordova.html#Cordova">Cordova</a> implements <a href="#FileSystemManagerObject">FileSystemManagerObject</a>;</pre>
+<p><span class="version">
+ Since: </span>
+ 3.0
+ </p>
+<div class="description">
+ <p>
+There is a <em>cordova.file </em>object that allows accessing the functionality of the Filesystem API.
+ </p>
+ </div>
+</div>
+<div class="interface" id="FileSystemManager">
+<a class="backward-compatibility-anchor" name="::File::FileSystemManager"></a><h3>2.5. FileSystemManager</h3>
+<div class="brief">
+ The FileSystemManager interface provides access to the Filesystem API.
+ </div>
+<pre class="webidl prettyprint"> [NoInterfaceObject] interface FileSystemManager {
+ readonly attribute DOMString applicationDirectory;
+
+ readonly attribute DOMString applicationStorageDirectory;
+
+ readonly attribute DOMString dataDirectory;
+
+ readonly attribute DOMString cacheDirectory;
+
+ readonly attribute DOMString externalApplicationStorageDirectory;
+
+ readonly attribute DOMString externalDataDirectory;
+
+ readonly attribute DOMString externalCacheDirectory;
+
+ readonly attribute DOMString externalRootDirectory;
+
+ readonly attribute DOMString tempDirectory;
+
+ readonly attribute DOMString syncedDataDirectory;
+
+ readonly attribute DOMString documentsDirectory;
+
+ readonly attribute DOMString sharedDirectory;
+
+ };</pre>
+<p><span class="version">
+ Since: </span>
+ 3.0
+ </p>
+<div class="description">
+ <p>
+This manager interface exposes the Filesystem base API constants.
+ </p>
+ </div>
+<div class="attributes">
+<h4>Attributes</h4>
+<ul>
+<li class="attribute" id="FileSystemManager::applicationDirectory">
+<span class="attrName"><span class="readonly"> readonly
+</span><span class="type">DOMString </span><span class="name">applicationDirectory</span></span><div class="brief">
+ Read-only directory where the application is installed.
+ </div>
+<p><span class="version">
+ Since: </span>
+ 3.0
+ </p>
+<div class="example">
+<span class="example"><p>Code example:</p></span><pre name="code" class="examplecode prettyprint"> console.log("The directory where the application is installed " + cordova.file.applicationDirectory);
+ </pre>
+</div>
+<div class="output">
+<span class="title"><p>Output example:</p></span><pre>The directory where the application is installed file:///opt/usr/apps/WfigBlWDyf/res/wgt/
+</pre>
+</div>
+</li>
+<li class="attribute" id="FileSystemManager::applicationStorageDirectory">
+<span class="attrName"><span class="readonly"> readonly
+</span><span class="type">DOMString </span><span class="name">applicationStorageDirectory</span></span><div class="brief">
+ Root directory of the application's sandbox.
+ </div>
+<p><span class="version">
+ Since: </span>
+ 3.0
+ </p>
+<div class="example">
+<span class="example"><p>Code example:</p></span><pre name="code" class="examplecode prettyprint"> console.log("Root directory of the application's sandbox " + cordova.file.applicationStorageDirectory);
+ </pre>
+</div>
+<div class="output">
+<span class="title"><p>Output example:</p></span><pre>Root directory of the application's sandbox file:///opt/usr/apps/WfigBlWDyf/
+</pre>
+</div>
+</li>
+<li class="attribute" id="FileSystemManager::dataDirectory">
+<span class="attrName"><span class="readonly"> readonly
+</span><span class="type">DOMString </span><span class="name">dataDirectory</span></span><div class="brief">
+ Persistent and private data storage within the application's sandbox using internal memory
+ </div>
+<p><span class="version">
+ Since: </span>
+ 3.0
+ </p>
+<div class="example">
+<span class="example"><p>Code example:</p></span><pre name="code" class="examplecode prettyprint"> console.log("Data directory " + cordova.file.dataDirectory);
+ </pre>
+</div>
+<div class="output">
+<span class="title"><p>Output example:</p></span><pre>Data directory file:///opt/usr/apps/WfigBlWDyf/data/
+</pre>
+</div>
+</li>
+<li class="attribute" id="FileSystemManager::cacheDirectory">
+<span class="attrName"><span class="readonly"> readonly
+</span><span class="type">DOMString </span><span class="name">cacheDirectory</span></span><div class="brief">
+ Directory for cached data files or any files that your app can re-create easily. The OS may delete these files when the device runs low on storage, nevertheless, apps should not rely on the OS to delete files in here.
+ </div>
+<p><span class="version">
+ Since: </span>
+ 3.0
+ </p>
+<div class="example">
+<span class="example"><p>Code example:</p></span><pre name="code" class="examplecode prettyprint"> console.log("Cache directory " + cordova.file.cacheDirectory);
+ </pre>
+</div>
+<div class="output">
+<span class="title"><p>Output example:</p></span><pre>Cache directory file:///opt/usr/apps/WfigBlWDyf/tmp/
+</pre>
+</div>
+</li>
+<li class="attribute" id="FileSystemManager::externalApplicationStorageDirectory">
+<span class="attrName"><span class="readonly"> readonly
+</span><span class="type">DOMString </span><span class="name">externalApplicationStorageDirectory</span></span><div class="brief">
+ Application space on external storage.
+ </div>
+<p><span class="version">
+ Since: </span>
+ 3.0
+ </p>
+<div class="example">
+<span class="example"><p>Code example:</p></span><pre name="code" class="examplecode prettyprint"> console.log("Space on external storage " + cordova.file.externalApplicationStorageDirectory);
+ </pre>
+</div>
+<div class="output">
+<span class="title"><p>Output example:</p></span><pre>Space on external storage null
+</pre>
+</div>
+</li>
+<li class="attribute" id="FileSystemManager::externalDataDirectory">
+<span class="attrName"><span class="readonly"> readonly
+</span><span class="type">DOMString </span><span class="name">externalDataDirectory</span></span><div class="brief">
+ Where to put app-specific data files on external storage.
+ </div>
+<p><span class="version">
+ Since: </span>
+ 3.0
+ </p>
+<div class="example">
+<span class="example"><p>Code example:</p></span><pre name="code" class="examplecode prettyprint"> console.log("Data files on external storage " + cordova.file.externalDataDirectory);
+ </pre>
+</div>
+<div class="output">
+<span class="title"><p>Output example:</p></span><pre>Data files on external storage null
+</pre>
+</div>
+</li>
+<li class="attribute" id="FileSystemManager::externalCacheDirectory">
+<span class="attrName"><span class="readonly"> readonly
+</span><span class="type">DOMString </span><span class="name">externalCacheDirectory</span></span><div class="brief">
+ Application cache on external storage.
+ </div>
+<p><span class="version">
+ Since: </span>
+ 3.0
+ </p>
+<div class="example">
+<span class="example"><p>Code example:</p></span><pre name="code" class="examplecode prettyprint"> console.log("Cache on external storage " + cordova.file.externalCacheDirectory);
+ </pre>
+</div>
+<div class="output">
+<span class="title"><p>Output example:</p></span><pre>Cache on external storage null
+</pre>
+</div>
+</li>
+<li class="attribute" id="FileSystemManager::externalRootDirectory">
+<span class="attrName"><span class="readonly"> readonly
+</span><span class="type">DOMString </span><span class="name">externalRootDirectory</span></span><div class="brief">
+ External storage root.
+ </div>
+<p><span class="version">
+ Since: </span>
+ 3.0
+ </p>
+<div class="example">
+<span class="example"><p>Code example:</p></span><pre name="code" class="examplecode prettyprint"> console.log("Root on external storage " + cordova.file.externalRootDirectory);
+ </pre>
+</div>
+<div class="output">
+<span class="title"><p>Output example:</p></span><pre>Root on external storage file:///usr/storage/sdcard/
+</pre>
+</div>
+</li>
+<li class="attribute" id="FileSystemManager::tempDirectory">
+<span class="attrName"><span class="readonly"> readonly
+</span><span class="type">DOMString </span><span class="name">tempDirectory</span></span><div class="brief">
+ Temp directory that the OS can clear at will. Do not rely on the OS to clear this directory; your app should always remove files as applicable.
+ </div>
+<p><span class="version">
+ Since: </span>
+ 3.0
+ </p>
+<div class="example">
+<span class="example"><p>Code example:</p></span><pre name="code" class="examplecode prettyprint"> console.log("Temp directory " + cordova.file.tempDirectory);
+ </pre>
+</div>
+<div class="output">
+<span class="title"><p>Output example:</p></span><pre>Temp directory null
+</pre>
+</div>
+</li>
+<li class="attribute" id="FileSystemManager::syncedDataDirectory">
+<span class="attrName"><span class="readonly"> readonly
+</span><span class="type">DOMString </span><span class="name">syncedDataDirectory</span></span><div class="brief">
+ Holds app-specific files that should be synced.
+ </div>
+<p><span class="version">
+ Since: </span>
+ 3.0
+ </p>
+<div class="example">
+<span class="example"><p>Code example:</p></span><pre name="code" class="examplecode prettyprint"> console.log("Synced data directory " + cordova.file.syncedDataDirectory);
+ </pre>
+</div>
+<div class="output">
+<span class="title"><p>Output example:</p></span><pre>Synced data directory null
+</pre>
+</div>
+</li>
+<li class="attribute" id="FileSystemManager::documentsDirectory">
+<span class="attrName"><span class="readonly"> readonly
+</span><span class="type">DOMString </span><span class="name">documentsDirectory</span></span><div class="brief">
+ Files private to the app, but that are meaningful to other application (e.g. Office files).
+ </div>
+<p><span class="version">
+ Since: </span>
+ 3.0
+ </p>
+<div class="example">
+<span class="example"><p>Code example:</p></span><pre name="code" class="examplecode prettyprint"> console.log("Documents directory " + cordova.file.documentsDirectory);
+ </pre>
+</div>
+<div class="output">
+<span class="title"><p>Output example:</p></span><pre>Documents directory null
+</pre>
+</div>
+</li>
+<li class="attribute" id="FileSystemManager::sharedDirectory">
+<span class="attrName"><span class="readonly"> readonly
+</span><span class="type">DOMString </span><span class="name">sharedDirectory</span></span><div class="brief">
+ Files globally available to all applications.
+ </div>
+<p><span class="version">
+ Since: </span>
+ 3.0
+ </p>
+<div class="example">
+<span class="example"><p>Code example:</p></span><pre name="code" class="examplecode prettyprint"> console.log("Files globally available to all applications " + cordova.file.sharedDirectory);
+ </pre>
+</div>
+<div class="output">
+<span class="title"><p>Output example:</p></span><pre>Files globally available to all applications file:///opt/usr/media/
+</pre>
+</div>
+</li>
+</ul>
+</div>
+</div>
+<div class="interface" id="FileSystem">
+<a class="backward-compatibility-anchor" name="::File::FileSystem"></a><h3>2.6. FileSystem</h3>
+<div class="brief">
+ This interface provides object that represents a file system.
+ </div>
+<pre class="webidl prettyprint"> [NoInterfaceObject] interface FileSystem {
+
+ readonly attribute DOMString name;
+
+ readonly attribute <a href="#DirectoryEntry">DirectoryEntry</a> root;
+ };</pre>
+<p><span class="version">
+ Since: </span>
+ 3.0
+ </p>
+<div class="attributes">
+<h4>Attributes</h4>
+<ul>
+<li class="attribute" id="FileSystem::name">
+<span class="attrName"><span class="readonly"> readonly
+</span><span class="type">DOMString </span><span class="name">name</span></span><div class="brief">
+ This is the name of the file system.
+ </div>
+<div class="description">
+ <p>
+The specifics of naming filesystems is unspecified, but a name must be unique across the list of exposed file systems.
+ </p>
+ </div>
+<p><span class="version">
+ Since: </span>
+ 3.0
+ </p>
+<div class="example">
+<span class="example"><p>Code example:</p></span><pre name="code" class="examplecode prettyprint"> requestFileSystem(TEMPORARY, 100, function (fileSystem) {
+ console.log('Name of the filesystem: '+fileSystem.name);
+ });
+ </pre>
+</div>
+<div class="output">
+<span class="title"><p>Output example:</p></span><pre>Name of the filesystem: temporary
+</pre>
+</div>
+</li>
+<li class="attribute" id="FileSystem::root">
+<span class="attrName"><span class="readonly"> readonly
+</span><span class="type">DirectoryEntry </span><span class="name">root</span></span><div class="brief">
+ The root directory of the file system.
+ </div>
+<p><span class="version">
+ Since: </span>
+ 3.0
+ </p>
+</li>
+</ul>
+</div>
+</div>
+<div class="interface" id="Metadata">
+<a class="backward-compatibility-anchor" name="::File::Metadata"></a><h3>2.7. Metadata</h3>
+<div class="brief">
+ This interface supplies information about the state of a file or directory.
+ </div>
+<pre class="webidl prettyprint"> interface Metadata {
+ readonly attribute Date modificationTime;
+
+ readonly attribute unsigned long long size;
+ };</pre>
+<p><span class="version">
+ Since: </span>
+ 3.0
+ </p>
+<div class="attributes">
+<h4>Attributes</h4>
+<ul>
+<li class="attribute" id="Metadata::modificationTime">
+<span class="attrName"><span class="readonly"> readonly
+</span><span class="type">Date </span><span class="name">modificationTime</span></span><div class="brief">
+ This is the time at which the file or directory was last modified.
+ </div>
+<p><span class="version">
+ Since: </span>
+ 3.0
+ </p>
+</li>
+<li class="attribute" id="Metadata::size">
+<span class="attrName"><span class="readonly"> readonly
+</span><span class="type">unsigned long long </span><span class="name">size</span></span><div class="brief">
+ The size of the file, in bytes. This must return 0 for directories.
+ </div>
+<p><span class="version">
+ Since: </span>
+ 3.0
+ </p>
+</li>
+</ul>
+</div>
+</div>
+<div class="interface" id="FileError">
+<a class="backward-compatibility-anchor" name="::File::FileError"></a><h3>2.8. FileError</h3>
+<div class="brief">
+ File Error
+ </div>
+<pre class="webidl prettyprint"> [NoInterfaceObject] interface FileError {
+ const unsigned short NOT_FOUND_ERR = 1;
+ const unsigned short SECURITY_ERR = 2;
+ const unsigned short ABORT_ERR = 3;
+ const unsigned short NOT_READABLE_ERR = 4;
+ const unsigned short ENCODING_ERR = 5;
+ const unsigned short NO_MODIFICATION_ALLOWED_ERR = 6;
+ const unsigned short INVALID_STATE_ERR = 7;
+ const unsigned short SYNTAX_ERR = 8;
+ const unsigned short INVALID_MODIFICATION_ERR = 9;
+ const unsigned short QUOTA_EXCEEDED_ERR = 10;
+ const unsigned short TYPE_MISMATCH_ERR = 11;
+ const unsigned short PATH_EXISTS_ERR = 12;
+ attribute unsigned short code;
+ };</pre>
+<p><span class="version">
+ Since: </span>
+ 3.0
+ </p>
+</div>
+<div class="interface" id="File">
+<a class="backward-compatibility-anchor" name="::File::File"></a><h3>2.9. File</h3>
+<div class="brief">
+ The File interface provides access to file's properties. File object could be created with using of <em>FileEntry.file()</em> method.
+ </div>
+<pre class="webidl prettyprint"> [NoInterfaceObject] interface File {
+
+ readonly attribute DOMString name;
+
+ readonly attribute DOMString localURL;
+
+ readonly attribute DOMString type;
+
+ readonly attribute Date lastModified;
+
+ readonly attribute long long size;
+ };</pre>
+<p><span class="version">
+ Since: </span>
+ 3.0
+ </p>
+<div class="attributes">
+<h4>Attributes</h4>
+<ul>
+<li class="attribute" id="File::name">
+<span class="attrName"><span class="readonly"> readonly
+</span><span class="type">DOMString </span><span class="name">name</span></span><div class="brief">
+ The name of the file.
+ </div>
+<p><span class="version">
+ Since: </span>
+ 3.0
+ </p>
+</li>
+<li class="attribute" id="File::localURL">
+<span class="attrName"><span class="readonly"> readonly
+</span><span class="type">DOMString </span><span class="name">localURL</span></span><div class="brief">
+ The full path of the file, including the name.
+ </div>
+<p><span class="version">
+ Since: </span>
+ 3.0
+ </p>
+</li>
+<li class="attribute" id="File::type">
+<span class="attrName"><span class="readonly"> readonly
+</span><span class="type">DOMString </span><span class="name">type</span></span><div class="brief">
+ The mime type of the file.
+ </div>
+<p><span class="version">
+ Since: </span>
+ 3.0
+ </p>
+</li>
+<li class="attribute" id="File::lastModified">
+<span class="attrName"><span class="readonly"> readonly
+</span><span class="type">Date </span><span class="name">lastModified</span></span><div class="brief">
+ The last modified date of the file.
+ </div>
+<p><span class="version">
+ Since: </span>
+ 3.0
+ </p>
+</li>
+<li class="attribute" id="File::size">
+<span class="attrName"><span class="readonly"> readonly
+</span><span class="type">long long </span><span class="name">size</span></span><div class="brief">
+ The size of the file in bytes.
+ </div>
+<p><span class="version">
+ Since: </span>
+ 3.0
+ </p>
+</li>
+</ul>
+</div>
+</div>
+<div class="interface" id="LocalFileSystem">
+<a class="backward-compatibility-anchor" name="::File::LocalFileSystem"></a><h3>2.10. LocalFileSystem</h3>
+<div class="brief">
+ This interface provides a way to obtain <em>Entry</em> and <em>FileSystem</em> objects.
+ </div>
+<pre class="webidl prettyprint"> [NoInterfaceObject] interface LocalFileSystem {
+
+ const short TEMPORARY = 0;
+
+ const short PERSISTENT = 1;
+
+ void requestFileSystem(short type, long long size, optional <a href="#FileSystemCallback">FileSystemCallback</a>? successCallback, optional <a href="#ErrorCallback">ErrorCallback</a>? errorCallback);
+
+ void resolveLocalFileSystemURL(DOMString uri, optional <a href="#EntryCallback">EntryCallback</a>? successCallback, optional <a href="#ErrorCallback">ErrorCallback</a>? errorCallback);
+
+ };</pre>
+<pre class="webidl prettyprint"> Window implements <a href="#LocalFileSystem">LocalFileSystem</a>;</pre>
+<p><span class="version">
+ Since: </span>
+ 3.0
+ </p>
+<div class="consts">
+<h4>Constants</h4>
+<dl>
+<li class="const" id="LocalFileSystem::TEMPORARY">
+<a class="backward-compatibility-anchor" name="::File::LocalFileSystem::TEMPORARY"></a><span class="name">TEMPORARY</span><div class="brief">
+ Used for storage with no guarantee of persistence.
+ </div>
+<p><span class="version">
+ Since: </span>
+ 3.0
+ </p>
+<br><br>
+</li>
+<li class="const" id="LocalFileSystem::PERSISTENT">
+<a class="backward-compatibility-anchor" name="::File::LocalFileSystem::PERSISTENT"></a><span class="name">PERSISTENT</span><div class="brief">
+ Used for storage that should not be removed by the user agent without application or user permission.
+ </div>
+<p><span class="version">
+ Since: </span>
+ 3.0
+ </p>
+<br><br>
+</li>
+</dl>
+</div>
+<div class="methods">
+<h4>Methods</h4>
+<dl>
+<dt class="method" id="LocalFileSystem::requestFileSystem">
+<a class="backward-compatibility-anchor" name="::File::LocalFileSystem::requestFileSystem"></a><code><b><span class="methodName">requestFileSystem</span></b></code>
+</dt>
+<dd>
+<div class="brief">
+ Request a file system in which to store application data.
+ </div>
+<div class="synopsis"><pre class="signature prettyprint">void requestFileSystem(short type, long long size, optional <a href="#FileSystemCallback">FileSystemCallback</a>? successCallback, optional <a href="#ErrorCallback">ErrorCallback</a>? errorCallback);
+ </pre></div>
+<p><span class="version">
+ Since: </span>
+ 3.0
+ </p>
+<p><span class="privilegelevel">
+ Privilege level: </span>
+ public
+ </p>
+<p><span class="privilege">
+ Privilege: </span>
+ http://tizen.org/privilege/filesystem.read
+ </p>
+<div class="parameters">
+<p><span class="param">Parameters:</span></p>
+<ul>
+ <li class="param">
+<span class="name">type</span>:
+ Local file system type, either TEMPORARY or PERSISTENT.
+ </li>
+ <li class="param">
+<span class="name">size</span>:
+ Indicates how much storage space, in bytes, the application expects to need.
+ </li>
+ <li class="param">
+<span class="name">successCallback</span><span class="optional"> [optional]</span><span class="optional"> [nullable]</span>:
+ Invoked with a <em>FileSystem</em> object.
+ </li>
+ <li class="param">
+<span class="name">errorCallback</span><span class="optional"> [optional]</span><span class="optional"> [nullable]</span>:
+ Invoked if error occurs retrieving file system.
+ </li>
+ </ul>
+</div>
+<div class="exceptionlist">
+<p><span class="except">Exceptions:</span></p>
+ <ul class="exception"><li>TypeError<ul><li class="list"><p>
+ if any of the input parameters has incorrect type.
+ </p></li></ul>
+</li></ul>
+ </div>
+<div class="example">
+<span class="example"><p>Code example:</p></span><pre name="code" class="examplecode prettyprint"> successCallback = function(fs) {
+ console.log('File system name ' + fs.name);
+ };
+
+ errorCallback = function(err) {
+ console.log(err.code);
+ };
+
+ requestFileSystem(TEMPORARY, 1024*1024, successCallback, errorCallback);
+
+ </pre>
+</div>
+<div class="output">
+<span class="title"><p>Output example:</p></span><pre>File system name temporary
+</pre>
+</div>
+</dd>
+<dt class="method" id="LocalFileSystem::resolveLocalFileSystemURL">
+<a class="backward-compatibility-anchor" name="::File::LocalFileSystem::resolveLocalFileSystemURL"></a><code><b><span class="methodName">resolveLocalFileSystemURL</span></b></code>
+</dt>
+<dd>
+<div class="brief">
+ Retrieves a <em>DirectoryEntry</em> or <em>FileEntry</em> using local URI.
+ </div>
+<div class="synopsis"><pre class="signature prettyprint">void resolveLocalFileSystemURL(DOMString uri, optional <a href="#EntryCallback">EntryCallback</a>? successCallback, optional <a href="#ErrorCallback">ErrorCallback</a>? errorCallback);
+ </pre></div>
+<p><span class="version">
+ Since: </span>
+ 3.0
+ </p>
+<p><span class="privilegelevel">
+ Privilege level: </span>
+ public
+ </p>
+<p><span class="privilege">
+ Privilege: </span>
+ http://tizen.org/privilege/filesystem.read
+ </p>
+<div class="parameters">
+<p><span class="param">Parameters:</span></p>
+<ul>
+ <li class="param">
+<span class="name">uri</span>:
+ URI referring to a local file or directory.
+ </li>
+ <li class="param">
+<span class="name">successCallback</span><span class="optional"> [optional]</span><span class="optional"> [nullable]</span>:
+ Invoked with <em>Entry</em> object corresponding to URI.
+ </li>
+ <li class="param">
+<span class="name">errorCallback</span><span class="optional"> [optional]</span><span class="optional"> [nullable]</span>:
+ Invoked if error occurs retrieving file system entry.
+ </li>
+ </ul>
+</div>
+<div class="exceptionlist">
+<p><span class="except">Exceptions:</span></p>
+ <ul class="exception"><li>TypeError<ul><li class="list"><p>
+ if any of the input parameters has incorrect type.
+ </p></li></ul>
+</li></ul>
+ </div>
+<div class="example">
+<span class="example"><p>Code example:</p></span><pre name="code" class="examplecode prettyprint"> successCallback = function(entry) {
+ console.log('Entry name ' + entry.name);
+ };
+
+ errorCallback = function(err) {
+ console.log(err.code);
+ };
+
+ var uri = 'file:///home/owner/content/Documents/example.txt';
+ resolveLocalFileSystemURL(uri, successCallback, errorCallback);
+
+ </pre>
+</div>
+<div class="output">
+<span class="title"><p>Output example:</p></span><pre>Entry name example.txt
+</pre>
+</div>
+</dd>
+</dl>
+</div>
+</div>
+<div class="interface" id="Entry">
+<a class="backward-compatibility-anchor" name="::File::Entry"></a><h3>2.11. Entry</h3>
+<div class="brief">
+ The Entry interface.
+ </div>
+<pre class="webidl prettyprint"> [NoInterfaceObject] interface Entry {
+
+ readonly attribute boolean isFile;
+
+ readonly attribute boolean isDirectory;
+
+ readonly attribute DOMString fullPath;
+
+ readonly attribute DOMString name;
+
+ readonly attribute <a href="#FileSystem">FileSystem</a> filesystem;
+
+ void getMetadata(<a href="#MetadataCallback">MetadataCallback</a> onsuccess, optional <a href="#ErrorCallback">ErrorCallback</a>? onerror);
+
+ void moveTo(<a href="#DirectoryEntry">DirectoryEntry</a> parent, optional DOMString? newName, optional <a href="#EntryCallback">EntryCallback</a>? onsuccess, optional <a href="#ErrorCallback">ErrorCallback</a>? onerror);
+
+ void copyTo(<a href="#DirectoryEntry">DirectoryEntry</a> parent, optional DOMString? newName, optional <a href="#EntryCallback">EntryCallback</a>? onsuccess, optional <a href="#ErrorCallback">ErrorCallback</a>? onerror);
+
+ void getParent(<a href="#EntryCallback">EntryCallback</a> onsuccess, optional <a href="#ErrorCallback">ErrorCallback</a>? onerror);
+
+ void remove(<a href="#VoidCallback">VoidCallback</a> onsuccess, optional <a href="#ErrorCallback">ErrorCallback</a>? onerror);
+
+ DOMString toURL();
+ };</pre>
+<p><span class="version">
+ Since: </span>
+ 3.0
+ </p>
+<div class="attributes">
+<h4>Attributes</h4>
+<ul>
+<li class="attribute" id="Entry::isFile">
+<span class="attrName"><span class="readonly"> readonly
+</span><span class="type">boolean </span><span class="name">isFile</span></span><div class="brief">
+ True if the entry is a file.
+ </div>
+<p><span class="version">
+ Since: </span>
+ 3.0
+ </p>
+</li>
+<li class="attribute" id="Entry::isDirectory">
+<span class="attrName"><span class="readonly"> readonly
+</span><span class="type">boolean </span><span class="name">isDirectory</span></span><div class="brief">
+ True if the entry is a directory.
+ </div>
+<p><span class="version">
+ Since: </span>
+ 3.0
+ </p>
+</li>
+<li class="attribute" id="Entry::fullPath">
+<span class="attrName"><span class="readonly"> readonly
+</span><span class="type">DOMString </span><span class="name">fullPath</span></span><div class="brief">
+ The full absolute path from the root to the entry. An absolute path is a relative path from the root directory, prepended with a '/'.
+ </div>
+<p><span class="version">
+ Since: </span>
+ 3.0
+ </p>
+</li>
+<li class="attribute" id="Entry::name">
+<span class="attrName"><span class="readonly"> readonly
+</span><span class="type">DOMString </span><span class="name">name</span></span><div class="brief">
+ The name of the entry, excluding the path leading to it.
+ </div>
+<p><span class="version">
+ Since: </span>
+ 3.0
+ </p>
+</li>
+<li class="attribute" id="Entry::filesystem">
+<span class="attrName"><span class="readonly"> readonly
+</span><span class="type">FileSystem </span><span class="name">filesystem</span></span><div class="brief">
+ The file system where the entry resides.
+ </div>
+<p><span class="version">
+ Since: </span>
+ 3.0
+ </p>
+</li>
+</ul>
+</div>
+<div class="methods">
+<h4>Methods</h4>
+<dl>
+<dt class="method" id="Entry::getMetadata">
+<a class="backward-compatibility-anchor" name="::File::Entry::getMetadata"></a><code><b><span class="methodName">getMetadata</span></b></code>
+</dt>
+<dd>
+<div class="brief">
+ Look up metadata about this entry.
+ </div>
+<div class="synopsis"><pre class="signature prettyprint">void getMetadata(<a href="#MetadataCallback">MetadataCallback</a> onsuccess, optional <a href="#ErrorCallback">ErrorCallback</a>? onerror);
+ </pre></div>
+<p><span class="version">
+ Since: </span>
+ 3.0
+ </p>
+<p><span class="privilegelevel">
+ Privilege level: </span>
+ public
+ </p>
+<p><span class="privilege">
+ Privilege: </span>
+ http://tizen.org/privilege/filesystem.read
+ </p>
+<div class="parameters">
+<p><span class="param">Parameters:</span></p>
+<ul>
+ <li class="param">
+<span class="name">onsuccess</span>:
+ A callback that is called with the time of the last modification.
+ </li>
+ <li class="param">
+<span class="name">onerror</span><span class="optional"> [optional]</span><span class="optional"> [nullable]</span>:
+ A callback that is called when errors happen.
+ </li>
+ </ul>
+</div>
+<div class="exceptionlist">
+<p><span class="except">Exceptions:</span></p>
+ <ul class="exception"><li>FileException<ul><li class="list"><p>
+ with error type TYPE_MISMATCH_ERR, if any of the input parameter is not compatible with the expected type for that parameter.
+ </p></li></ul>
+</li></ul>
+ </div>
+<div class="example">
+<span class="example"><p>Code example:</p></span><pre name="code" class="examplecode prettyprint"> requestFileSystem(TEMPORARY, 100, function(fs) {
+ fs.root.getMetadata(function (metadata) {
+ console.log("Last modification time: " + metadata.modificationTime);// get metadata successfully
+ });
+ });
+ </pre>
+</div>
+<div class="output">
+<span class="title"><p>Output example:</p></span><pre>Last modification time: Fri Jan 02 2015 03:58:08 GMT+0900 (KST)
+</pre>
+</div>
+</dd>
+<dt class="method" id="Entry::moveTo">
+<a class="backward-compatibility-anchor" name="::File::Entry::moveTo"></a><code><b><span class="methodName">moveTo</span></b></code>
+</dt>
+<dd>
+<div class="brief">
+ Move an entry to a different location on the file system.
+ </div>
+<div class="synopsis"><pre class="signature prettyprint">void moveTo(<a href="#DirectoryEntry">DirectoryEntry</a> parent, optional DOMString? newName, optional <a href="#EntryCallback">EntryCallback</a>? onsuccess, optional <a href="#ErrorCallback">ErrorCallback</a>? onerror);
+ </pre></div>
+<p><span class="version">
+ Since: </span>
+ 3.0
+ </p>
+<div class="description">
+ <p>
+It is an error to try to:
+ </p>
+ <ul>
+ <li>
+move a directory inside itself or to any child at any depth </li>
+ <li>
+move an entry into its parent if a name different from its current one isn't provided </li>
+ <li>
+move a file to a path occupied by a directory </li>
+ <li>
+move a directory to a path occupied by a file </li>
+ <li>
+move any element to a path occupied by a directory which is not empty </li>
+ </ul>
+ <p>
+A move of a file on top of an existing file must attempt to delete and replace that file.
+A move of a directory on top of an existing empty directory must attempt to delete and replace that directory.
+ </p>
+ </div>
+<p><span class="privilegelevel">
+ Privilege level: </span>
+ public
+ </p>
+<p><span class="privilege">
+ Privilege: </span>
+ http://tizen.org/privilege/filesystem.read
+ </p>
+<p><span class="privilege">
+ Privilege: </span>
+ http://tizen.org/privilege/filesystem.write
+ </p>
+<div class="parameters">
+<p><span class="param">Parameters:</span></p>
+<ul>
+ <li class="param">
+<span class="name">parent</span>:
+ The directory to which to move the entry.
+ </li>
+ <li class="param">
+<span class="name">newName</span><span class="optional"> [optional]</span><span class="optional"> [nullable]</span>:
+ The new name of the entry. Defaults to the Entry's current name if unspecified.
+ </li>
+ <li class="param">
+<span class="name">onsuccess</span><span class="optional"> [optional]</span><span class="optional"> [nullable]</span>:
+ A callback that is called with the Entry for the new location.
+ </li>
+ <li class="param">
+<span class="name">onerror</span><span class="optional"> [optional]</span><span class="optional"> [nullable]</span>:
+ Callback method to be invoked when an error has occurred
+ </li>
+ </ul>
+</div>
+<div class="exceptionlist">
+<p><span class="except">Exceptions:</span></p>
+ <ul class="exception"><li>FileException<ul><li class="list"><p>
+ with error type TYPE_MISMATCH_ERR, if any of the input parameter is not compatible with the expected type for that parameter.
+ </p></li></ul>
+</li></ul>
+ </div>
+<div class="example">
+<span class="example"><p>Code example:</p></span><pre name="code" class="examplecode prettyprint"> successCallback = function(entry){console.log('Full path to the moved file: '+entry.fullPath)};
+ requestFileSystem(TEMPORARY, 100, function(fs) {
+ fs.root.getDirectory('testDirectory', {create:true}, function(direntry) {
+ fs.root.getFile("aa.txt", {create:true}, function(fileentry) {
+ console.log('Full path before move: '+fileentry.fullPath);
+ fileentry.moveTo(direntry,'newname.txt',successCallback);
+ });
+ });
+ });
+ </pre>
+</div>
+<div class="output">
+<span class="title"><p>Output example:</p></span><pre>Full path before move: /aa.txt
+Full path to the moved file: /testDirectory/newname.txt
+</pre>
+</div>
+</dd>
+<dt class="method" id="Entry::copyTo">
+<a class="backward-compatibility-anchor" name="::File::Entry::copyTo"></a><code><b><span class="methodName">copyTo</span></b></code>
+</dt>
+<dd>
+<div class="brief">
+ Copy an entry to a different location on the file system.
+ </div>
+<div class="synopsis"><pre class="signature prettyprint">void copyTo(<a href="#DirectoryEntry">DirectoryEntry</a> parent, optional DOMString? newName, optional <a href="#EntryCallback">EntryCallback</a>? onsuccess, optional <a href="#ErrorCallback">ErrorCallback</a>? onerror);
+ </pre></div>
+<p><span class="version">
+ Since: </span>
+ 3.0
+ </p>
+<div class="description">
+ <p>
+It is an error to try to:
+ </p>
+ <ul>
+ <li>
+copy a directory inside itself or to any child at any depth </li>
+ <li>
+copy an entry into its parent if a name different from its current one isn't provided </li>
+ <li>
+copy a file to a path occupied by a directory </li>
+ <li>
+copy a directory to a path occupied by a file </li>
+ <li>
+copy any element to a path occupied by a directory which is not empty </li>
+ </ul>
+ <p>
+A copy of a file on top of an existing file must attempt to delete and replace that file.
+A copy of a directory on top of an existing empty directory must attempt to delete and replace that directory.
+Directory copies are always recursive--that is, they copy all contents of the directory.
+ </p>
+ </div>
+<p><span class="privilegelevel">
+ Privilege level: </span>
+ public
+ </p>
+<p><span class="privilege">
+ Privilege: </span>
+ http://tizen.org/privilege/filesystem.read
+ </p>
+<p><span class="privilege">
+ Privilege: </span>
+ http://tizen.org/privilege/filesystem.write
+ </p>
+<div class="parameters">
+<p><span class="param">Parameters:</span></p>
+<ul>
+ <li class="param">
+<span class="name">parent</span>:
+ The directory to which to copy the entry.
+ </li>
+ <li class="param">
+<span class="name">newName</span><span class="optional"> [optional]</span><span class="optional"> [nullable]</span>:
+ The new name of the entry. Defaults to the Entry's current name if unspecified.
+ </li>
+ <li class="param">
+<span class="name">onsuccess</span><span class="optional"> [optional]</span><span class="optional"> [nullable]</span>:
+ A callback that is called with the Entry for the new location.
+ </li>
+ <li class="param">
+<span class="name">onerror</span><span class="optional"> [optional]</span><span class="optional"> [nullable]</span>:
+ Callback method to be invoked when an error has occurred.
+ </li>
+ </ul>
+</div>
+<div class="exceptionlist">
+<p><span class="except">Exceptions:</span></p>
+ <ul class="exception"><li>FileException<ul><li class="list"><p>
+ with error type TYPE_MISMATCH_ERR, if any of the input parameter is not compatible with the expected type for that parameter.
+ </p></li></ul>
+</li></ul>
+ </div>
+<div class="example">
+<span class="example"><p>Code example:</p></span><pre name="code" class="examplecode prettyprint"> successCallback = function(entry){console.log('Full path to the copied file: '+entry.fullPath);};
+ requestFileSystem(TEMPORARY, 100, function(fs) {
+ fs.root.getDirectory('testDirectory', {create:true},
+ function(direntry) {
+ fs.root.getFile("test.txt", {create:true},
+ function(fileentry) {
+ fileentry.copyTo(direntry,'newname.txt',successCallback);
+ }
+ );
+ });
+ });
+ </pre>
+</div>
+<div class="output">
+<span class="title"><p>Output example:</p></span><pre>Full path to the copied file: /testDirectory/newname.txt
+</pre>
+</div>
+</dd>
+<dt class="method" id="Entry::getParent">
+<a class="backward-compatibility-anchor" name="::File::Entry::getParent"></a><code><b><span class="methodName">getParent</span></b></code>
+</dt>
+<dd>
+<div class="brief">
+ Look up the parent DirectoryEntry containing this Entry. If this Entry is the root of its filesystem, its parent is itself.
+ </div>
+<div class="synopsis"><pre class="signature prettyprint">void getParent(<a href="#EntryCallback">EntryCallback</a> onsuccess, optional <a href="#ErrorCallback">ErrorCallback</a>? onerror);
+ </pre></div>
+<p><span class="version">
+ Since: </span>
+ 3.0
+ </p>
+<p><span class="privilegelevel">
+ Privilege level: </span>
+ public
+ </p>
+<p><span class="privilege">
+ Privilege: </span>
+ http://tizen.org/privilege/filesystem.read
+ </p>
+<div class="parameters">
+<p><span class="param">Parameters:</span></p>
+<ul>
+ <li class="param">
+<span class="name">onsuccess</span>:
+ A callback that is called to return the parent Entry.
+ </li>
+ <li class="param">
+<span class="name">onerror</span><span class="optional"> [optional]</span><span class="optional"> [nullable]</span>:
+ Callback method to be invoked when an error has occurred.
+ </li>
+ </ul>
+</div>
+<div class="exceptionlist">
+<p><span class="except">Exceptions:</span></p>
+ <ul class="exception"><li>FileException<ul><li class="list"><p>
+ with error type TYPE_MISMATCH_ERR, if any of the input parameter is not compatible with the expected type for that parameter.
+ </p></li></ul>
+</li></ul>
+ </div>
+<div class="example">
+<span class="example"><p>Code example:</p></span><pre name="code" class="examplecode prettyprint"> requestFileSystem(TEMPORARY, 100, function(fs) {
+ fs.root.getParent(function (entry) {
+ console.log("success");
+ });
+ });
+ </pre>
+</div>
+<div class="output">
+<span class="title"><p>Output example:</p></span><pre>success
+</pre>
+</div>
+</dd>
+<dt class="method" id="Entry::remove">
+<a class="backward-compatibility-anchor" name="::File::Entry::remove"></a><code><b><span class="methodName">remove</span></b></code>
+</dt>
+<dd>
+<div class="brief">
+ Deletes a file or directory. It is an error to attempt to delete a directory that is not empty. It is an error to attempt to delete the root directory of a filesystem.
+ </div>
+<div class="synopsis"><pre class="signature prettyprint">void remove(<a href="#VoidCallback">VoidCallback</a> onsuccess, optional <a href="#ErrorCallback">ErrorCallback</a>? onerror);
+ </pre></div>
+<p><span class="version">
+ Since: </span>
+ 3.0
+ </p>
+<p><span class="privilegelevel">
+ Privilege level: </span>
+ public
+ </p>
+<p><span class="privilege">
+ Privilege: </span>
+ http://tizen.org/privilege/filesystem.read
+ </p>
+<p><span class="privilege">
+ Privilege: </span>
+ http://tizen.org/privilege/filesystem.write
+ </p>
+<div class="parameters">
+<p><span class="param">Parameters:</span></p>
+<ul>
+ <li class="param">
+<span class="name">onsuccess</span>:
+ A callback that is called on success.
+ </li>
+ <li class="param">
+<span class="name">onerror</span><span class="optional"> [optional]</span><span class="optional"> [nullable]</span>:
+ Callback method to be invoked when an error has occurred.
+ </li>
+ </ul>
+</div>
+<div class="exceptionlist">
+<p><span class="except">Exceptions:</span></p>
+ <ul class="exception"><li>FileException<ul><li class="list"><p>
+ with error type TYPE_MISMATCH_ERR, if any of the input parameter is not compatible with the expected type for that parameter.
+ </p></li></ul>
+</li></ul>
+ </div>
+<div class="example">
+<span class="example"><p>Code example:</p></span><pre name="code" class="examplecode prettyprint"> requestFileSystem(TEMPORARY, 100, function(fs) {
+ fs.root.getFile('test.txt', {create: true}, function(fileEntry) {
+ fileEntry.remove(function () {
+ console.log("success");
+ });
+ });
+ });
+ </pre>
+</div>
+<div class="output">
+<span class="title"><p>Output example:</p></span><pre>success
+</pre>
+</div>
+</dd>
+<dt class="method" id="Entry::toURL">
+<a class="backward-compatibility-anchor" name="::File::Entry::toURL"></a><code><b><span class="methodName">toURL</span></b></code>
+</dt>
+<dd>
+<div class="brief">
+ Returns a URL that can be used to identify this entry. Unlike the URN defined in [FILE-API-ED], it has no specific expiration; as it describes a location on disk, it should be valid at least as long as that location exists.
+ </div>
+<div class="synopsis"><pre class="signature prettyprint">DOMString toURL();
+ </pre></div>
+<p><span class="version">
+ Since: </span>
+ 3.0
+ </p>
+<div class="returntype">
+<p><span class="return">Return value:</span></p>
+ URL that can be used to identify this entry.
+ </div>
+<div class="example">
+<span class="example"><p>Code example:</p></span><pre name="code" class="examplecode prettyprint"> requestFileSystem(TEMPORARY, 100, function(fs) {
+ fs.root.getDirectory('testDirectory', {create:true},
+ function(entry) {
+ var url = entry.toURL();
+ console.log('URL: '+url);
+ });
+ });
+ </pre>
+</div>
+<div class="output">
+<span class="title"><p>Output example:</p></span><pre>URL: file:///home/owner/apps_rw/WfigBlWDyf/tmp/testDirectory/
+</pre>
+</div>
+</dd>
+</dl>
+</div>
+</div>
+<div class="interface" id="DirectoryEntry">
+<a class="backward-compatibility-anchor" name="::File::DirectoryEntry"></a><h3>2.12. DirectoryEntry</h3>
+<div class="brief">
+ The DirectoryEntry interface provides access to the Filesystem API.
+ </div>
+<pre class="webidl prettyprint"> interface DirectoryEntry : <a href="#Entry">Entry</a> {
+
+ <a href="#DirectoryReader">DirectoryReader</a> createReader();
+
+ void getDirectory(DOMString path, optional ? options, optional <a href="#EntryCallback">EntryCallback</a>? onsuccess, optional <a href="#ErrorCallback">ErrorCallback</a>? onerror);
+
+ void getFile(DOMString path, optional ? options, optional <a href="#EntryCallback">EntryCallback</a>? onsuccess, optional <a href="#ErrorCallback">ErrorCallback</a>? onerror);
+
+ void removeRecursively(<a href="#VoidCallback">VoidCallback</a> onsuccess, optional <a href="#ErrorCallback">ErrorCallback</a>? onerror);
+ };</pre>
+<p><span class="version">
+ Since: </span>
+ 3.0
+ </p>
+
+ <div class="methods">
+<h4>Methods</h4>
+<dl>
+<dt class="method" id="DirectoryEntry::createReader">
+<a class="backward-compatibility-anchor" name="::File::DirectoryEntry::createReader"></a><code><b><span class="methodName">createReader</span></b></code>
+</dt>
+<dd>
+<div class="brief">
+ Creates a new DirectoryReader to read Entries from this Directory.
+ </div>
+<div class="synopsis"><pre class="signature prettyprint"><a href="#DirectoryReader">DirectoryReader</a> createReader();
+ </pre></div>
+<p><span class="version">
+ Since: </span>
+ 3.0
+ </p>
+<p><span class="privilegelevel">
+ Privilege level: </span>
+ public
+ </p>
+<p><span class="privilege">
+ Privilege: </span>
+ http://tizen.org/privilege/filesystem.read
+ </p>
+<div class="returntype">
+<p><span class="return">Return value:</span></p>
+ DirectoryReader
+ </div>
+<div class="example">
+<span class="example"><p>Code example:</p></span><pre name="code" class="examplecode prettyprint"> requestFileSystem(TEMPORARY, 100, function (entry) {
+ entry.root.getDirectory("MyDocument", {create:true}, function(dirEntry) {
+ var directoryReader = dirEntry.createReader();
+ });
+ });
+ </pre>
+</div>
+</dd>
+<dt class="method" id="DirectoryEntry::getDirectory">
+<a class="backward-compatibility-anchor" name="::File::DirectoryEntry::getDirectory"></a><code><b><span class="methodName">getDirectory</span></b></code>
+</dt>
+<dd>
+<div class="brief">
+ Creates or looks up a directory.
+ </div>
+<div class="synopsis"><pre class="signature prettyprint">void getDirectory(DOMString path, optional ? options, optional <a href="#EntryCallback">EntryCallback</a>? onsuccess, optional <a href="#ErrorCallback">ErrorCallback</a>? onerror);
+ </pre></div>
+<p><span class="version">
+ Since: </span>
+ 3.0
+ </p>
+<div class="description">
+ <ul>
+ <li>
+If create and exclusive are both true and the path already exists, getDirectory must fail. </li>
+ <li>
+If create is true, the path doesn't exist, and no other error occurs, getDirectory must create and return a corresponding DirectoryEntry. </li>
+ <li>
+If create is not true and the path doesn't exist, getDirectory must fail. </li>
+ <li>
+If create is not true and the path exists, but is a file, getDirectory must fail. </li>
+ <li>
+Otherwise, if no other error occurs, getDirectory must return a DirectoryEntry corresponding to path. </li>
+ </ul>
+ </div>
+<p><span class="privilegelevel">
+ Privilege level: </span>
+ public
+ </p>
+<p><span class="privilege">
+ Privilege: </span>
+ http://tizen.org/privilege/filesystem.read
+ </p>
+<p><span class="privilege">
+ Privilege: </span>
+ http://tizen.org/privilege/filesystem.write
+ </p>
+<div class="parameters">
+<p><span class="param">Parameters:</span></p>
+<ul>
+ <li class="param">
+<span class="name">path</span>:
+ Either an absolute path or a relative path from this DirectoryEntry to the directory to be looked up or created. It is an error to attempt to create a directory whose immediate parent does not yet exist.
+ </li>
+ <li class="param">
+<span class="name">options</span><span class="optional"> [optional]</span><span class="optional"> [nullable]</span>:
+ Flags
+ </li>
+ <li class="param">
+<span class="name">onsuccess</span><span class="optional"> [optional]</span><span class="optional"> [nullable]</span>:
+ A callback that is called to return the DirectoryEntry selected or created.
+ </li>
+ <li class="param">
+<span class="name">onerror</span><span class="optional"> [optional]</span><span class="optional"> [nullable]</span>:
+ Callback method to be invoked when an error has occurred.
+ </li>
+ </ul>
+</div>
+<div class="exceptionlist">
+<p><span class="except">Exceptions:</span></p>
+ <ul class="exception"><li>FileException<ul><li class="list"><p>
+ with error type TYPE_MISMATCH_ERR, if any of the input parameter is not compatible with the expected type for that parameter.
+ </p></li></ul>
+</li></ul>
+ </div>
+<div class="example">
+<span class="example"><p>Code example:</p></span><pre name="code" class="examplecode prettyprint"> requestFileSystem(TEMPORARY, 100, function(fs) {
+ fs.root.getDirectory("ert",{create:true},function(dir){
+ console.log('Created dir: '+dir.name);
+ })
+ });
+ </pre>
+</div>
+<div class="output">
+<span class="title"><p>Output example:</p></span><pre>Created dir: ert
+</pre>
+</div>
+</dd>
+<dt class="method" id="DirectoryEntry::getFile">
+<a class="backward-compatibility-anchor" name="::File::DirectoryEntry::getFile"></a><code><b><span class="methodName">getFile</span></b></code>
+</dt>
+<dd>
+<div class="brief">
+ Creates or looks up a file.
+ </div>
+<div class="synopsis"><pre class="signature prettyprint">void getFile(DOMString path, optional ? options, optional <a href="#EntryCallback">EntryCallback</a>? onsuccess, optional <a href="#ErrorCallback">ErrorCallback</a>? onerror);
+ </pre></div>
+<p><span class="version">
+ Since: </span>
+ 3.0
+ </p>
+<div class="description">
+ <ul>
+ <li>
+If create and exclusive are both true, and the path already exists, getFile must fail. </li>
+ <li>
+If create is true, the path doesn't exist, and no other error occurs, getFile must create it as a zero-length file and return a corresponding FileEntry. </li>
+ <li>
+If create is not true and the path doesn't exist, getFile must fail. </li>
+ <li>
+If create is not true and the path exists, but is a directory, getFile must fail. </li>
+ <li>
+Otherwise, if no other error occurs, getFile must return a FileEntry corresponding to path. </li>
+ </ul>
+ </div>
+<p><span class="privilegelevel">
+ Privilege level: </span>
+ public
+ </p>
+<p><span class="privilege">
+ Privilege: </span>
+ http://tizen.org/privilege/filesystem.read
+ </p>
+<p><span class="privilege">
+ Privilege: </span>
+ http://tizen.org/privilege/filesystem.write
+ </p>
+<div class="parameters">
+<p><span class="param">Parameters:</span></p>
+<ul>
+ <li class="param">
+<span class="name">path</span>:
+ Either an absolute path or a relative path from this DirectoryEntry to the file to be looked up or created. It is an error to attempt to create a file whose immediate parent does not yet exist.
+ </li>
+ <li class="param">
+<span class="name">options</span><span class="optional"> [optional]</span><span class="optional"> [nullable]</span>:
+ Flags
+ </li>
+ <li class="param">
+<span class="name">onsuccess</span><span class="optional"> [optional]</span><span class="optional"> [nullable]</span>:
+ A callback that is called to return the File selected or created.
+ </li>
+ <li class="param">
+<span class="name">onerror</span><span class="optional"> [optional]</span><span class="optional"> [nullable]</span>:
+ Callback method to be invoked when an error has occurred.
+ </li>
+ </ul>
+</div>
+<div class="exceptionlist">
+<p><span class="except">Exceptions:</span></p>
+ <ul class="exception"><li>FileException<ul><li class="list"><p>
+ with error type TYPE_MISMATCH_ERR, if any of the input parameter is not compatible with the expected type for that parameter.
+ </p></li></ul>
+</li></ul>
+ </div>
+<div class="example">
+<span class="example"><p>Code example:</p></span><pre name="code" class="examplecode prettyprint"> requestFileSystem(TEMPORARY, 100, function(fs) {
+ fs.root.getFile("qa.txt",{create:true},function(file){
+ console.log('Created file: '+file.name);
+ });
+ });
+ </pre>
+</div>
+<div class="output">
+<span class="title"><p>Output example:</p></span><pre>Created file: qa.txt
+</pre>
+</div>
+</dd>
+<dt class="method" id="DirectoryEntry::removeRecursively">
+<a class="backward-compatibility-anchor" name="::File::DirectoryEntry::removeRecursively"></a><code><b><span class="methodName">removeRecursively</span></b></code>
+</dt>
+<dd>
+<div class="brief">
+ Deletes a directory and all of its contents, if any. In the event of an error [e.g. trying to delete a directory that contains a file that cannot be removed], some of the contents of the directory may be deleted. It is an error to attempt to delete the root directory of a filesystem.
+ </div>
+<div class="synopsis"><pre class="signature prettyprint">void removeRecursively(<a href="#VoidCallback">VoidCallback</a> onsuccess, optional <a href="#ErrorCallback">ErrorCallback</a>? onerror);
+ </pre></div>
+<p><span class="version">
+ Since: </span>
+ 3.0
+ </p>
+<p><span class="privilegelevel">
+ Privilege level: </span>
+ public
+ </p>
+<p><span class="privilege">
+ Privilege: </span>
+ http://tizen.org/privilege/filesystem.read
+ </p>
+<p><span class="privilege">
+ Privilege: </span>
+ http://tizen.org/privilege/filesystem.write
+ </p>
+<div class="parameters">
+<p><span class="param">Parameters:</span></p>
+<ul>
+ <li class="param">
+<span class="name">onsuccess</span>:
+ A callback that is called on success.
+ </li>
+ <li class="param">
+<span class="name">onerror</span><span class="optional"> [optional]</span><span class="optional"> [nullable]</span>:
+ Callback method to be invoked when an error has occurred.
+ </li>
+ </ul>
+</div>
+<div class="exceptionlist">
+<p><span class="except">Exceptions:</span></p>
+ <ul class="exception"><li>FileException<ul><li class="list"><p>
+ with error type TYPE_MISMATCH_ERR, if any of the input parameter is not compatible with the expected type for that parameter.
+ </p></li></ul>
+</li></ul>
+ </div>
+<div class="example">
+<span class="example"><p>Code example:</p></span><pre name="code" class="examplecode prettyprint"> requestFileSystem(TEMPORARY, 100, function(fs) {
+ fs.root.getDirectory("testDirectory", {create:true},
+ function(directoryEntry) {
+ directoryEntry.removeRecursively(function() {
+ console.log("success");
+ });
+ });
+ });
+ </pre>
+</div>
+<div class="output">
+<span class="title"><p>Output example:</p></span><pre>success
+</pre>
+</div>
+</dd>
+</dl>
+</div>
+</div>
+<div class="interface" id="DirectoryReader">
+<a class="backward-compatibility-anchor" name="::File::DirectoryReader"></a><h3>2.13. DirectoryReader</h3>
+<div class="brief">
+ The DirectoryReader interface provides access to the Filesystem API.
+ </div>
+<pre class="webidl prettyprint"> [NoInterfaceObject] interface DirectoryReader {
+
+ void readEntries(<a href="#EntriesCallback">EntriesCallback</a> onsuccess, optional <a href="#ErrorCallback">ErrorCallback</a>? onerror);
+ };</pre>
+<div class="methods">
+<h4>Methods</h4>
+<dl>
+<dt class="method" id="DirectoryReader::readEntries">
+<a class="backward-compatibility-anchor" name="::File::DirectoryReader::readEntries"></a><code><b><span class="methodName">readEntries</span></b></code>
+</dt>
+<dd>
+<div class="brief">
+ Read the next block of entries from this directory.
+ </div>
+<div class="synopsis"><pre class="signature prettyprint">void readEntries(<a href="#EntriesCallback">EntriesCallback</a> onsuccess, optional <a href="#ErrorCallback">ErrorCallback</a>? onerror);
+ </pre></div>
+<p><span class="version">
+ Since: </span>
+ 3.0
+ </p>
+<p><span class="privilegelevel">
+ Privilege level: </span>
+ public
+ </p>
+<p><span class="privilege">
+ Privilege: </span>
+ http://tizen.org/privilege/filesystem.read
+ </p>
+<div class="parameters">
+<p><span class="param">Parameters:</span></p>
+<ul>
+ <li class="param">
+<span class="name">onsuccess</span>:
+ Called once per successful call to readEntries to deliver the next previously-unreported set of Entries in the associated Directory. If all Entries have already been returned from previous invocations of readEntries, successCallback must be called with a zero-length array as an argument.
+ </li>
+ <li class="param">
+<span class="name">onerror</span><span class="optional"> [optional]</span><span class="optional"> [nullable]</span>:
+ A callback indicating that there was an error reading from the Directory.
+ </li>
+ </ul>
+</div>
+<div class="exceptionlist">
+<p><span class="except">Exceptions:</span></p>
+ <ul class="exception"><li>FileException<ul><li class="list"><p>
+ with error type TYPE_MISMATCH_ERR, if any of the input parameter is not compatible with the expected type for that parameter.
+ </p></li></ul>
+</li></ul>
+ </div>
+<div class="example">
+<span class="example"><p>Code example:</p></span><pre name="code" class="examplecode prettyprint"> requestFileSystem(TEMPORARY, 100, function(fs) {
+ var a = fs.root.createReader();
+ a.readEntries(function successCallback(entries) {
+ console.log("success");
+ });
+ });
+ </pre>
+</div>
+<div class="output">
+<span class="title"><p>Output example:</p></span><pre>success
+</pre>
+</div>
+</dd>
+</dl>
+</div>
+</div>
+<div class="interface" id="FileEntry">
+<a class="backward-compatibility-anchor" name="::File::FileEntry"></a><h3>2.14. FileEntry</h3>
+<div class="brief">
+ The FileEntry interface provides access to the Filesystem API.
+ </div>
+<pre class="webidl prettyprint"> [NoInterfaceObject] interface FileEntry : <a href="#Entry">Entry</a> {
+
+ void createWriter(<a href="#FileWriterCallback">FileWriterCallback</a> onsuccess, optional <a href="#ErrorCallback">ErrorCallback</a>? onerror);
+
+ void file (<a href="#FileCallback">FileCallback</a> onsuccess, optional <a href="#ErrorCallback">ErrorCallback</a> onerror);
+ };</pre>
+
+ <div class="methods">
+<h4>Methods</h4>
+<dl>
+<dt class="method" id="FileEntry::createWriter">
+<a class="backward-compatibility-anchor" name="::File::FileEntry::createWriter"></a><code><b><span class="methodName">createWriter</span></b></code>
+</dt>
+<dd>
+<div class="brief">
+ Creates a new FileWriter associated with the file that this FileEntry represents.
+ </div>
+<div class="synopsis"><pre class="signature prettyprint">void createWriter(<a href="#FileWriterCallback">FileWriterCallback</a> onsuccess, optional <a href="#ErrorCallback">ErrorCallback</a>? onerror);
+ </pre></div>
+<p><span class="version">
+ Since: </span>
+ 3.0
+ </p>
+<p><span class="privilegelevel">
+ Privilege level: </span>
+ public
+ </p>
+<p><span class="privilege">
+ Privilege: </span>
+ http://tizen.org/privilege/filesystem.read
+ </p>
+<p><span class="privilege">
+ Privilege: </span>
+ http://tizen.org/privilege/filesystem.write
+ </p>
+<div class="parameters">
+<p><span class="param">Parameters:</span></p>
+<ul>
+ <li class="param">
+<span class="name">onsuccess</span>:
+ A callback that is called with the new FileWriter.
+ </li>
+ <li class="param">
+<span class="name">onerror</span><span class="optional"> [optional]</span><span class="optional"> [nullable]</span>:
+ Callback method to be invoked when an error has occurred.
+ </li>
+ </ul>
+</div>
+<div class="example">
+<span class="example"><p>Code example:</p></span><pre name="code" class="examplecode prettyprint"> requestFileSystem(TEMPORARY, 100, function(fs) {
+ fs.root.getFile("logFile.txt", {create: true}, function (f) {
+ f.createWriter(function(fileWriter) {
+ fileWriter.write(new Blob(['hello']));
+ fileWriter.onerror = function(e) {
+ console.log('Write file failed:' + e);
+ };
+ fileWriter.onwriteend = function () {
+ console.log("success");
+ };
+ });
+ });
+ });
+ </pre>
+</div>
+<div class="output">
+<span class="title"><p>Output example:</p></span><pre>success
+</pre>
+</div>
+</dd>
+<dt class="method" id="FileEntry::file">
+<a class="backward-compatibility-anchor" name="::File::FileEntry::file"></a><code><b><span class="methodName">file</span></b></code>
+</dt>
+<dd>
+<div class="brief">
+ Returns a File that represents the current state of the file that this FileEntry represents.
+ </div>
+<div class="synopsis"><pre class="signature prettyprint">void file(<a href="#FileCallback">FileCallback</a> onsuccess, optional <a href="#ErrorCallback">ErrorCallback</a> onerror);
+ </pre></div>
+<p><span class="version">
+ Since: </span>
+ 3.0
+ </p>
+<p><span class="privilegelevel">
+ Privilege level: </span>
+ public
+ </p>
+<p><span class="privilege">
+ Privilege: </span>
+ http://tizen.org/privilege/filesystem.read
+ </p>
+<div class="parameters">
+<p><span class="param">Parameters:</span></p>
+<ul>
+ <li class="param">
+<span class="name">onsuccess</span>:
+ A callback that is called with the File.
+ </li>
+ <li class="param">
+<span class="name">onerror</span><span class="optional"> [optional]</span>:
+ Callback method to be invoked when an error has occurred.
+ </li>
+ </ul>
+</div>
+<div class="example">
+<span class="example"><p>Code example:</p></span><pre name="code" class="examplecode prettyprint"> requestFileSystem(TEMPORARY, 100, function(fs) {
+ fs.root.getFile("abcdz.txt", {create: true}, function (f) {
+ f.file(function (file) {
+ console.log("success");
+ });
+ });
+ });
+ </pre>
+</div>
+<div class="output">
+<span class="title"><p>Output example:</p></span><pre>success
+</pre>
+</div>
+</dd>
+</dl>
+</div>
+</div>
+<div class="interface" id="FileReader">
+<a class="backward-compatibility-anchor" name="::File::FileReader"></a><h3>2.15. FileReader</h3>
+<div class="brief">
+ The FileReader interface provides access to capabilities of reading <em>Blob</em> objects.
+ </div>
+<pre class="webidl prettyprint"> [Constructor()]
+ interface FileReader {
+ const short EMPTY = 0;
+ const short LOADING = 1;
+ const short DONE = 2;
+
+ readonly attribute short readyState;
+
+ readonly attribute <a href="#ReadResultData">ReadResultData</a>? result;
+
+ readonly attribute <a href="#FileError">FileError</a>? error;
+
+ attribute <a href="#ProgressCallback">ProgressCallback</a>? onloadstart;
+
+ attribute <a href="#ProgressCallback">ProgressCallback</a>? onload;
+
+ attribute <a href="#ProgressCallback">ProgressCallback</a>? onabort;
+
+ attribute <a href="#ProgressCallback">ProgressCallback</a>? onerror;
+
+ attribute <a href="#ProgressCallback">ProgressCallback</a>? onloadend;
+
+ void abort();
+
+ void readAsDataURL( blob);
+
+ void readAsText( blob, optional DOMString? label);
+
+ void readAsBinaryString( blob);
+
+ void readAsArrayBuffer( blob);
+ };</pre>
+<p><span class="version">
+ Since: </span>
+ 3.0
+ </p>
+<div class="example">
+<span class="example"><p>Code example:</p></span><pre name="code" class="examplecode prettyprint"> var deviceReady, fileReader;
+ deviceReady = function() {
+ fileReader = new FileReader();
+ };
+ document.addEventListener('deviceready', deviceReady, true);
+ </pre>
+</div>
+<div class="constructors">
+<h4 id="FileReader::constructor">Constructors</h4>
+<dl><pre class="webidl prettyprint">FileReader();</pre></dl>
+</div>
+<div class="consts">
+<h4>Constants</h4>
+<dl>
+<li class="const" id="FileReader::EMPTY">
+<a class="backward-compatibility-anchor" name="::File::FileReader::EMPTY"></a><span class="name">EMPTY</span><div class="brief">
+ The FileReader object has been constructed, and there are no pending reads. None of the read methods have been called.
+This is the default state of a newly minted FileReader object, until one of the read methods have been called on it.
+ </div>
+<p><span class="version">
+ Since: </span>
+ 3.0
+ </p>
+<br><br>
+</li>
+<li class="const" id="FileReader::LOADING">
+<a class="backward-compatibility-anchor" name="::File::FileReader::LOADING"></a><span class="name">LOADING</span><div class="brief">
+ A File or Blob is being read. One of the read methods is being processed, and no error has occurred during the read.
+ </div>
+<p><span class="version">
+ Since: </span>
+ 3.0
+ </p>
+<br><br>
+</li>
+<li class="const" id="FileReader::DONE">
+<a class="backward-compatibility-anchor" name="::File::FileReader::DONE"></a><span class="name">DONE</span><div class="brief">
+ The entire File or Blob has been read into memory, OR a file error occurred during read, OR the read was aborted using abort().
+The FileReader is no longer reading a File or Blob. If readyState is set to DONE it means at least one of the read methods have been called on this FileReader.
+ </div>
+<p><span class="version">
+ Since: </span>
+ 3.0
+ </p>
+<br><br>
+</li>
+</dl>
+</div>
+<div class="attributes">
+<h4>Attributes</h4>
+<ul>
+<li class="attribute" id="FileReader::readyState">
+<span class="attrName"><span class="readonly"> readonly
+</span><span class="type">short </span><span class="name">readyState</span></span><div class="brief">
+ The state of FileReader. Possible values are <em>FileReader.EMPTY</em>, <em>FileReader.LOADING</em> or <em>FileReader.DONE</em>.
+ </div>
+<p><span class="version">
+ Since: </span>
+ 3.0
+ </p>
+</li>
+<li class="attribute" id="FileReader::result">
+<span class="attrName"><span class="readonly"> readonly
+</span><span class="type">ReadResultData </span><span class="name">result</span><span class="optional"> [nullable]</span></span><div class="brief">
+ The contents of the file, that have been read.
+Returns a Blob's data as a DOMString, or byte[], or null, depending on the read method that has been called on the FileReader. It is <em>null</em> if any errors occurred.
+ </div>
+<p><span class="version">
+ Since: </span>
+ 3.0
+ </p>
+</li>
+<li class="attribute" id="FileReader::error">
+<span class="attrName"><span class="readonly"> readonly
+</span><span class="type">FileError </span><span class="name">error</span><span class="optional"> [nullable]</span></span><div class="brief">
+ An object describing error, if any occured.
+ </div>
+<p><span class="version">
+ Since: </span>
+ 3.0
+ </p>
+</li>
+<li class="attribute" id="FileReader::onloadstart">
+<span class="attrName"><span class="type">ProgressCallback </span><span class="name">onloadstart</span><span class="optional"> [nullable]</span></span><div class="brief">
+ Callback, which is triggered, when the read starts.
+ </div>
+<p><span class="version">
+ Since: </span>
+ 3.0
+ </p>
+</li>
+<li class="attribute" id="FileReader::onload">
+<span class="attrName"><span class="type">ProgressCallback </span><span class="name">onload</span><span class="optional"> [nullable]</span></span><div class="brief">
+ Callback, which is triggered, when the read has successfully completed.
+ </div>
+<p><span class="version">
+ Since: </span>
+ 3.0
+ </p>
+</li>
+<li class="attribute" id="FileReader::onabort">
+<span class="attrName"><span class="type">ProgressCallback </span><span class="name">onabort</span><span class="optional"> [nullable]</span></span><div class="brief">
+ Callback, which is triggered, when the read has been aborted. For instance, by invoking the abort() method.
+ </div>
+<p><span class="version">
+ Since: </span>
+ 3.0
+ </p>
+</li>
+<li class="attribute" id="FileReader::onerror">
+<span class="attrName"><span class="type">ProgressCallback </span><span class="name">onerror</span><span class="optional"> [nullable]</span></span><div class="brief">
+ Callback, which is triggered, when the read has failed.
+ </div>
+<p><span class="version">
+ Since: </span>
+ 3.0
+ </p>
+</li>
+<li class="attribute" id="FileReader::onloadend">
+<span class="attrName"><span class="type">ProgressCallback </span><span class="name">onloadend</span><span class="optional"> [nullable]</span></span><div class="brief">
+ Callback, which is triggered, when the request has completed (either in success or failure).
+ </div>
+<p><span class="version">
+ Since: </span>
+ 3.0
+ </p>
+</li>
+</ul>
+</div>
+<div class="methods">
+<h4>Methods</h4>
+<dl>
+<dt class="method" id="FileReader::abort">
+<a class="backward-compatibility-anchor" name="::File::FileReader::abort"></a><code><b><span class="methodName">abort</span></b></code>
+</dt>
+<dd>
+<div class="brief">
+ Aborts current operation of reading file.
+ </div>
+<div class="synopsis"><pre class="signature prettyprint">void abort();
+ </pre></div>
+<p><span class="version">
+ Since: </span>
+ 3.0
+ </p>
+<div class="example">
+<span class="example"><p>Code example:</p></span><pre name="code" class="examplecode prettyprint"> var blob = new Blob(['abc']);
+ var fileReader = new FileReader();
+ fileReader.onload = function(){
+ console.log('Loaded');
+ };
+ fileReader.onabort = function(){
+ console.log('aborted');
+ };
+ fileReader.readAsDataURL(blob);
+ fileReader.abort();
+ </pre>
+</div>
+<div class="output">
+<span class="title"><p>Output example:</p></span><pre>aborted
+</pre>
+</div>
+</dd>
+<dt class="method" id="FileReader::readAsDataURL">
+<a class="backward-compatibility-anchor" name="::File::FileReader::readAsDataURL"></a><code><b><span class="methodName">readAsDataURL</span></b></code>
+</dt>
+<dd>
+<div class="brief">
+ Reads file and return data as a base64-encoded data URL.
+ </div>
+<div class="synopsis"><pre class="signature prettyprint">void readAsDataURL( blob);
+ </pre></div>
+<p><span class="version">
+ Since: </span>
+ 3.0
+ </p>
+<p><span class="privilegelevel">
+ Privilege level: </span>
+ public
+ </p>
+<p><span class="privilege">
+ Privilege: </span>
+ http://tizen.org/privilege/filesystem.read
+ </p>
+<div class="parameters">
+<p><span class="param">Parameters:</span></p>
+<ul>
+ <li class="param">
+<span class="name">blob</span>:
+ The <em>Blob</em> object to be read as data URL.
+ </li>
+ </ul>
+</div>
+<div class="exceptionlist">
+<p><span class="except">Exceptions:</span></p>
+ <ul class="exception"><li>TypeError<ul><li class="list"><p>
+ if input parameter is missing.
+ </p></li></ul>
+</li></ul>
+ <ul class="exception"><li>FileError<ul><li class="list"><p>
+ with error type INVALID_STATE_ERR, if it is already reading a file.
+ </p></li></ul>
+</li></ul>
+ </div>
+<div class="example">
+<span class="example"><p>Code example:</p></span><pre name="code" class="examplecode prettyprint"> var blob = new Blob(['abc']);
+ var fileReader = new FileReader();
+ fileReader.onload = function(){
+ console.log('Loaded, result = '+fileReader.result);
+ };
+ fileReader.readAsDataURL(blob);
+ </pre>
+</div>
+<div class="output">
+<span class="title"><p>Output example:</p></span><pre>Loaded, result = data:;base64,YWJj
+</pre>
+</div>
+</dd>
+<dt class="method" id="FileReader::readAsText">
+<a class="backward-compatibility-anchor" name="::File::FileReader::readAsText"></a><code><b><span class="methodName">readAsText</span></b></code>
+</dt>
+<dd>
+<div class="brief">
+ Reads text file.
+ </div>
+<div class="synopsis"><pre class="signature prettyprint">void readAsText( blob, optional DOMString? label);
+ </pre></div>
+<p><span class="version">
+ Since: </span>
+ 3.0
+ </p>
+<p><span class="privilegelevel">
+ Privilege level: </span>
+ public
+ </p>
+<p><span class="privilege">
+ Privilege: </span>
+ http://tizen.org/privilege/filesystem.read
+ </p>
+<div class="parameters">
+<p><span class="param">Parameters:</span></p>
+<ul>
+ <li class="param">
+<span class="name">blob</span>:
+ The <em>Blob</em> object to be read as text.
+ </li>
+ <li class="param">
+<span class="name">label</span><span class="optional"> [optional]</span><span class="optional"> [nullable]</span>:
+ An optional argument, that represents the label of an encoding
+ </li>
+ </ul>
+</div>
+<div class="exceptionlist">
+<p><span class="except">Exceptions:</span></p>
+ <ul class="exception"><li>TypeError<ul><li class="list"><p>
+ if input parameter is missing.
+ </p></li></ul>
+</li></ul>
+ <ul class="exception"><li>FileError<ul><li class="list"><p>
+ with error type INVALID_STATE_ERR, if it is already reading a file.
+ </p></li></ul>
+</li></ul>
+ </div>
+<div class="example">
+<span class="example"><p>Code example:</p></span><pre name="code" class="examplecode prettyprint"> var blob = new Blob(['abc']);
+ var fileReader = new FileReader();
+ fileReader.onload = function(){
+ console.log('Loaded, result = '+fileReader.result);
+ };
+ fileReader.readAsText(blob);
+ </pre>
+</div>
+<div class="output">
+<span class="title"><p>Output example:</p></span><pre>Loaded, result = abc
+</pre>
+</div>
+</dd>
+<dt class="method" id="FileReader::readAsBinaryString">
+<a class="backward-compatibility-anchor" name="::File::FileReader::readAsBinaryString"></a><code><b><span class="methodName">readAsBinaryString</span></b></code>
+</dt>
+<dd>
+<div class="brief">
+ Reads file as binary and returns a binary string.
+ </div>
+<div class="synopsis"><pre class="signature prettyprint">void readAsBinaryString( blob);
+ </pre></div>
+<p><span class="version">
+ Since: </span>
+ 3.0
+ </p>
+<p><span class="privilegelevel">
+ Privilege level: </span>
+ public
+ </p>
+<p><span class="privilege">
+ Privilege: </span>
+ http://tizen.org/privilege/filesystem.read
+ </p>
+<div class="parameters">
+<p><span class="param">Parameters:</span></p>
+<ul>
+ <li class="param">
+<span class="name">blob</span>:
+ The <em>Blob</em> object to be read as binary.
+ </li>
+ </ul>
+</div>
+<div class="exceptionlist">
+<p><span class="except">Exceptions:</span></p>
+ <ul class="exception"><li>TypeError<ul><li class="list"><p>
+ if input parameter is missing.
+ </p></li></ul>
+</li></ul>
+ <ul class="exception"><li>FileError<ul><li class="list"><p>
+ with error type INVALID_STATE_ERR, if it is already reading a file.
+ </p></li></ul>
+</li></ul>
+ </div>
+<div class="example">
+<span class="example"><p>Code example:</p></span><pre name="code" class="examplecode prettyprint"> var blob = new Blob(['abc']);
+ var fileReader = new FileReader();
+ fileReader.onload = function(){
+ console.log('Loaded, result = '+fileReader.result);
+ };
+ fileReader.readAsBinaryString(blob);
+ </pre>
+</div>
+<div class="output">
+<span class="title"><p>Output example:</p></span><pre>Loaded, result = abc
+</pre>
+</div>
+</dd>
+<dt class="method" id="FileReader::readAsArrayBuffer">
+<a class="backward-compatibility-anchor" name="::File::FileReader::readAsArrayBuffer"></a><code><b><span class="methodName">readAsArrayBuffer</span></b></code>
+</dt>
+<dd>
+<div class="brief">
+ Reads file as an array buffer and result would be <em>byte[]</em>.
+ </div>
+<div class="synopsis"><pre class="signature prettyprint">void readAsArrayBuffer( blob);
+ </pre></div>
+<p><span class="version">
+ Since: </span>
+ 3.0
+ </p>
+<p><span class="privilegelevel">
+ Privilege level: </span>
+ public
+ </p>
+<p><span class="privilege">
+ Privilege: </span>
+ http://tizen.org/privilege/filesystem.read
+ </p>
+<div class="parameters">
+<p><span class="param">Parameters:</span></p>
+<ul>
+ <li class="param">
+<span class="name">blob</span>:
+ The <em>Blob</em> object to be read as array buffer.
+ </li>
+ </ul>
+</div>
+<div class="exceptionlist">
+<p><span class="except">Exceptions:</span></p>
+ <ul class="exception"><li>TypeError<ul><li class="list"><p>
+ if input parameter is missing.
+ </p></li></ul>
+</li></ul>
+ <ul class="exception"><li>FileError<ul><li class="list"><p>
+ with error type INVALID_STATE_ERR, if it is already reading a file.
+ </p></li></ul>
+</li></ul>
+ </div>
+<div class="example">
+<span class="example"><p>Code example:</p></span><pre name="code" class="examplecode prettyprint"> var blob = new Blob(['abc']);
+ var fileReader = new FileReader();
+ fileReader.onload = function(){
+ resultValue = fileReader.result;
+ console.log("Result: "+resultValue.toString()+'<br>'+'ByteLength: '+resultValue.byteLength);
+ };
+ fileReader.readAsArrayBuffer(blob);
+ </pre>
+</div>
+<div class="output">
+<span class="title"><p>Output example:</p></span><pre>Result: [object ArrayBuffer]
+ByteLength: 3
+</pre>
+</div>
+</dd>
+</dl>
+</div>
+</div>
+<div class="interface" id="FileWriter">
+<a class="backward-compatibility-anchor" name="::File::FileWriter"></a><h3>2.16. FileWriter</h3>
+<div class="brief">
+ FileWriter interface allows to create and write data to file.
+ </div>
+<pre class="webidl prettyprint"> [NoInterfaceObject] interface FileWriter {
+ const short INIT = 0;
+ const short WRITING = 1;
+ const short DONE = 2;
+
+ attribute short readyState;
+
+ attribute DOMString fileName;
+
+ attribute long length;
+
+ attribute long position;
+
+ attribute <a href="#FileError">FileError</a>? error;
+
+ attribute <a href="#ProgressCallback">ProgressCallback</a>? onwritestart;
+
+ attribute <a href="#ProgressCallback">ProgressCallback</a>? onwrite;
+
+ attribute <a href="#ProgressCallback">ProgressCallback</a>? onabort;
+
+ attribute <a href="#ProgressCallback">ProgressCallback</a>? onerror;
+
+ attribute <a href="#ProgressCallback">ProgressCallback</a>? onwriteend;
+
+ void abort ();
+
+ void seek (long offset);
+
+ void truncate (long size);
+
+ void write (<a href="#WriteData">WriteData</a> data);
+ };</pre>
+<p><span class="version">
+ Since: </span>
+ 3.0
+ </p>
+<div class="consts">
+<h4>Constants</h4>
+<dl>
+<li class="const" id="FileWriter::INIT">
+<a class="backward-compatibility-anchor" name="::File::FileWriter::INIT"></a><span class="name">INIT</span><br><br>
+</li>
+<li class="const" id="FileWriter::WRITING">
+<a class="backward-compatibility-anchor" name="::File::FileWriter::WRITING"></a><span class="name">WRITING</span><br><br>
+</li>
+<li class="const" id="FileWriter::DONE">
+<a class="backward-compatibility-anchor" name="::File::FileWriter::DONE"></a><span class="name">DONE</span><div class="brief">
+ Above constants describe current state of FileWriter object.
+ </div>
+<br><br>
+</li>
+</dl>
+</div>
+<div class="attributes">
+<h4>Attributes</h4>
+<ul>
+<li class="attribute" id="FileWriter::readyState">
+<span class="attrName"><span class="type">short </span><span class="name">readyState</span></span><div class="brief">
+ One of the three possible states, either INIT, WRITING, or DONE.
+ </div>
+<p><span class="version">
+ Since: </span>
+ 3.0
+ </p>
+</li>
+<li class="attribute" id="FileWriter::fileName">
+<span class="attrName"><span class="type">DOMString </span><span class="name">fileName</span></span><div class="brief">
+ The name of the file to be written.
+ </div>
+<p><span class="version">
+ Since: </span>
+ 3.0
+ </p>
+</li>
+<li class="attribute" id="FileWriter::length">
+<span class="attrName"><span class="type">long </span><span class="name">length</span></span><div class="brief">
+ The length of the file to be written.
+ </div>
+<p><span class="version">
+ Since: </span>
+ 3.0
+ </p>
+</li>
+<li class="attribute" id="FileWriter::position">
+<span class="attrName"><span class="type">long </span><span class="name">position</span></span><div class="brief">
+ The current position of the file pointer.
+ </div>
+<p><span class="version">
+ Since: </span>
+ 3.0
+ </p>
+</li>
+<li class="attribute" id="FileWriter::error">
+<span class="attrName"><span class="type">FileError </span><span class="name">error</span><span class="optional"> [nullable]</span></span><div class="brief">
+ An object containing errors.
+ </div>
+<p><span class="version">
+ Since: </span>
+ 3.0
+ </p>
+</li>
+<li class="attribute" id="FileWriter::onwritestart">
+<span class="attrName"><span class="type">ProgressCallback </span><span class="name">onwritestart</span><span class="optional"> [nullable]</span></span><div class="brief">
+ Called when the write starts.
+ </div>
+<p><span class="version">
+ Since: </span>
+ 3.0
+ </p>
+</li>
+<li class="attribute" id="FileWriter::onwrite">
+<span class="attrName"><span class="type">ProgressCallback </span><span class="name">onwrite</span><span class="optional"> [nullable]</span></span><div class="brief">
+ Called when the request has completed successfully.
+ </div>
+<p><span class="version">
+ Since: </span>
+ 3.0
+ </p>
+</li>
+<li class="attribute" id="FileWriter::onabort">
+<span class="attrName"><span class="type">ProgressCallback </span><span class="name">onabort</span><span class="optional"> [nullable]</span></span><div class="brief">
+ Called when the write has been aborted. For instance, by invoking the abort() method.
+ </div>
+<p><span class="version">
+ Since: </span>
+ 3.0
+ </p>
+</li>
+<li class="attribute" id="FileWriter::onerror">
+<span class="attrName"><span class="type">ProgressCallback </span><span class="name">onerror</span><span class="optional"> [nullable]</span></span><div class="brief">
+ Called when the write has failed.
+ </div>
+<p><span class="version">
+ Since: </span>
+ 3.0
+ </p>
+</li>
+<li class="attribute" id="FileWriter::onwriteend">
+<span class="attrName"><span class="type">ProgressCallback </span><span class="name">onwriteend</span><span class="optional"> [nullable]</span></span><div class="brief">
+ Called when the request has completed (either in success or failure).
+ </div>
+<p><span class="version">
+ Since: </span>
+ 3.0
+ </p>
+</li>
+</ul>
+</div>
+<div class="methods">
+<h4>Methods</h4>
+<dl>
+<dt class="method" id="FileWriter::abort">
+<a class="backward-compatibility-anchor" name="::File::FileWriter::abort"></a><code><b><span class="methodName">abort</span></b></code>
+</dt>
+<dd>
+<div class="brief">
+ Aborts writing the file.
+ </div>
+<div class="synopsis"><pre class="signature prettyprint">void abort();
+ </pre></div>
+<p><span class="version">
+ Since: </span>
+ 3.0
+ </p>
+<div class="exceptionlist">
+<p><span class="except">Exceptions:</span></p>
+ <ul class="exception"><li>FileException<ul><li class="list"><p>
+ with error type TYPE_MISMATCH_ERR, if any of the input parameter is not compatible with the expected type for that parameter.
+ </p></li></ul>
+</li></ul>
+ </div>
+<div class="example">
+<span class="example"><p>Code example:</p></span><pre name="code" class="examplecode prettyprint"> successCallback = function(writer) {
+ writer.onwrite = function(evt) {
+ console.log('write success');
+ };
+ writer.onabort = function(e){
+ console.log('abort');
+ };
+ writer.write('some sample text');
+ writer.abort();
+ };
+
+ errorCallback = function(err) {
+ console.log(err.code);
+ };
+
+ // entry is FileEntry object retrieved by getFile() function of DirectoryEntry interface.
+ entry.createWriter(successCallback, errorCallback);
+ </pre>
+</div>
+<div class="output">
+<span class="title"><p>Output example:</p></span><pre>abort
+</pre>
+</div>
+</dd>
+<dt class="method" id="FileWriter::seek">
+<a class="backward-compatibility-anchor" name="::File::FileWriter::seek"></a><code><b><span class="methodName">seek</span></b></code>
+</dt>
+<dd>
+<div class="brief">
+ Moves the file pointer to the specified byte.
+ </div>
+<div class="synopsis"><pre class="signature prettyprint">void seek(long offset);
+ </pre></div>
+<p><span class="version">
+ Since: </span>
+ 3.0
+ </p>
+<div class="description">
+ <p>
+If the offset is a negative number the position of the file pointer is rewound. If the offset is greater than the file size the position is set to the end of the file.
+ </p>
+ </div>
+<div class="parameters">
+<p><span class="param">Parameters:</span></p>
+<ul>
+ <li class="param">
+<span class="name">offset</span>:
+ Location to move the file pointer to.
+ </li>
+ </ul>
+</div>
+<div class="exceptionlist">
+<p><span class="except">Exceptions:</span></p>
+ <ul class="exception"><li>FileException<ul><li class="list"><p>
+ with error type INVALID_STATE_ERR, if it is already writing a file.
+ </p></li></ul>
+</li></ul>
+ </div>
+<div class="example">
+<span class="example"><p>Code example:</p></span><pre name="code" class="examplecode prettyprint"> successCallback = function(writer) {
+ // fast forwards file pointer to the end of file.
+ writer.seek(writer.length);
+ };
+
+ errorCallback = function(err) {
+ console.log(err.code);
+ };
+
+ // entry is FileEntry object retrieved by getFile() function of DirectoryEntry interface.
+ entry.createWriter(successCallback, errorCallback);
+ </pre>
+</div>
+</dd>
+<dt class="method" id="FileWriter::truncate">
+<a class="backward-compatibility-anchor" name="::File::FileWriter::truncate"></a><code><b><span class="methodName">truncate</span></b></code>
+</dt>
+<dd>
+<div class="brief">
+ Shortens the file to the specified length.
+ </div>
+<div class="synopsis"><pre class="signature prettyprint">void truncate(long size);
+ </pre></div>
+<p><span class="version">
+ Since: </span>
+ 3.0
+ </p>
+<p><span class="privilegelevel">
+ Privilege level: </span>
+ public
+ </p>
+<p><span class="privilege">
+ Privilege: </span>
+ http://tizen.org/privilege/filesystem.write
+ </p>
+<div class="parameters">
+<p><span class="param">Parameters:</span></p>
+<ul>
+ <li class="param">
+<span class="name">size</span>:
+ Size to chop the file at.
+ </li>
+ </ul>
+</div>
+<div class="exceptionlist">
+<p><span class="except">Exceptions:</span></p>
+ <ul class="exception"><li>FileException<ul><li class="list"><p>
+ with error type INVALID_STATE_ERR, if it is already writing a file.
+ </p></li></ul>
+</li></ul>
+ </div>
+<div class="example">
+<span class="example"><p>Code example:</p></span><pre name="code" class="examplecode prettyprint"> successCallback = function(writer) {
+ writer.onwrite = function(evt) {
+ console.log('truncate success');
+ };
+
+ writer.truncate(10);
+ };
+
+ errorCallback = function(err) {
+ console.log(err.code);
+ };
+
+ // entry is FileEntry object retrieved by getFile() function of DirectoryEntry interface.
+ entry.createWriter(successCallback, errorCallback);
+ </pre>
+</div>
+<div class="output">
+<span class="title"><p>Output example:</p></span><pre>truncate success
+</pre>
+</div>
+</dd>
+<dt class="method" id="FileWriter::write">
+<a class="backward-compatibility-anchor" name="::File::FileWriter::write"></a><code><b><span class="methodName">write</span></b></code>
+</dt>
+<dd>
+<div class="brief">
+ Writes data to the file.
+ </div>
+<div class="synopsis"><pre class="signature prettyprint">void write(<a href="#WriteData">WriteData</a> data);
+ </pre></div>
+<p><span class="version">
+ Since: </span>
+ 3.0
+ </p>
+<p><span class="privilegelevel">
+ Privilege level: </span>
+ public
+ </p>
+<p><span class="privilege">
+ Privilege: </span>
+ http://tizen.org/privilege/filesystem.read
+ </p>
+<p><span class="privilege">
+ Privilege: </span>
+ http://tizen.org/privilege/filesystem.write
+ </p>
+<div class="parameters">
+<p><span class="param">Parameters:</span></p>
+<ul>
+ <li class="param">
+<span class="name">data</span>:
+ Text or Blob to be written.
+ </li>
+ </ul>
+</div>
+<div class="exceptionlist">
+<p><span class="except">Exceptions:</span></p>
+ <ul class="exception"><li>FileException<ul><li class="list"><p>
+ with error type INVALID_STATE_ERR, if it is already writing a file.
+ </p></li></ul>
+</li></ul>
+ </div>
+<div class="example">
+<span class="example"><p>Code example:</p></span><pre name="code" class="examplecode prettyprint"> successCallback = function(writer) {
+ writer.onwrite = function(evt) {
+ console.log('write success');
+ };
+
+ writer.write('some sample text');
+ };
+
+ errorCallback = function(err) {
+ console.log(err.code);
+ };
+
+ // entry is FileEntry object retrieved by getFile() function of DirectoryEntry interface.
+ entry.createWriter(successCallback, errorCallback);
+ </pre>
+</div>
+<div class="output">
+<span class="title"><p>Output example:</p></span><pre>write success
+</pre>
+</div>
+</dd>
+</dl>
+</div>
+</div>
+<div class="interface" id="ProgressCallback">
+<a class="backward-compatibility-anchor" name="::File::ProgressCallback"></a><h3>2.17. ProgressCallback</h3>
+<div class="brief">
+ The interface that defines a callback function which is called with the ProgressEvent object.
+ </div>
+<pre class="webidl prettyprint"> [Callback=FunctionOnly, NoInterfaceObject] interface ProgressCallback {
+ void onsuccess(<a href="#ProgressEvent">ProgressEvent</a> event);
+ };</pre>
+<div class="methods">
+<h4>Methods</h4>
+<dl>
+<dt class="method" id="ProgressCallback::onsuccess">
+<a class="backward-compatibility-anchor" name="::File::ProgressCallback::onsuccess"></a><code><b><span class="methodName">onsuccess</span></b></code>
+</dt>
+<dd>
+<div class="brief">
+ Called with a ProgressEvent object.
+ </div>
+<div class="synopsis"><pre class="signature prettyprint">void onsuccess(<a href="#ProgressEvent">ProgressEvent</a> event);
+ </pre></div>
+<p><span class="version">
+ Since: </span>
+ 3.0
+ </p>
+<div class="parameters">
+<p><span class="param">Parameters:</span></p>
+<ul>
+ <li class="param">
+<span class="name">event</span>:
+ A progress event.
+ </li>
+ </ul>
+</div>
+</dd>
+</dl>
+</div>
+</div>
+<div class="interface" id="FileSystemCallback">
+<a class="backward-compatibility-anchor" name="::File::FileSystemCallback"></a><h3>2.18. FileSystemCallback</h3>
+<div class="brief">
+ The FileSystemCallback interface.
+ </div>
+<pre class="webidl prettyprint"> [Callback=FunctionOnly, NoInterfaceObject] interface FileSystemCallback {
+ void handleEvent(<a href="#FileSystem">FileSystem</a> filesystem);
+ };</pre>
+<p><span class="version">
+ Since: </span>
+ 3.0
+ </p>
+<p><span class="remark"> Remark : </span>
+ Example of using can be find at <a href="file.html#FileSystem">FileSystem</a> code example.
+ </p>
+<div class="methods">
+<h4>Methods</h4>
+<dl>
+<dt class="method" id="FileSystemCallback::handleEvent">
+<a class="backward-compatibility-anchor" name="::File::FileSystemCallback::handleEvent"></a><code><b><span class="methodName">handleEvent</span></b></code>
+</dt>
+<dd>
+<div class="brief">
+ Called when the file system was successfully obtained.
+ </div>
+<div class="synopsis"><pre class="signature prettyprint">void handleEvent(<a href="#FileSystem">FileSystem</a> filesystem);
+ </pre></div>
+<p><span class="version">
+ Since: </span>
+ 3.0
+ </p>
+<div class="parameters">
+<p><span class="param">Parameters:</span></p>
+<ul>
+ <li class="param">
+<span class="name">filesystem</span>:
+ FileSystem The file systems to which the app is granted access.
+ </li>
+ </ul>
+</div>
+</dd>
+</dl>
+</div>
+</div>
+<div class="interface" id="EntryCallback">
+<a class="backward-compatibility-anchor" name="::File::EntryCallback"></a><h3>2.19. EntryCallback</h3>
+<div class="brief">
+ The EntryCallback interface.
+ </div>
+<pre class="webidl prettyprint"> [Callback=FunctionOnly, NoInterfaceObject] interface EntryCallback {
+ void handleEvent(<a href="#Entry">Entry</a> entry);
+ };</pre>
+<p><span class="version">
+ Since: </span>
+ 3.0
+ </p>
+<p><span class="remark"> Remark : </span>
+ Example of using can be find at <a href="file.html#DirectoryEntry::getDirectory">DirectoryEntry::getDirectory</a> code example.
+ </p>
+<div class="methods">
+<h4>Methods</h4>
+<dl>
+<dt class="method" id="EntryCallback::handleEvent">
+<a class="backward-compatibility-anchor" name="::File::EntryCallback::handleEvent"></a><code><b><span class="methodName">handleEvent</span></b></code>
+</dt>
+<dd>
+<div class="brief">
+ Used to supply an Entry as a response to a user query.
+ </div>
+<div class="synopsis"><pre class="signature prettyprint">void handleEvent(<a href="#Entry">Entry</a> entry);
+ </pre></div>
+<p><span class="version">
+ Since: </span>
+ 3.0
+ </p>
+<div class="parameters">
+<p><span class="param">Parameters:</span></p>
+<ul>
+ <li class="param">
+<span class="name">entry</span>:
+ Entry
+ </li>
+ </ul>
+</div>
+</dd>
+</dl>
+</div>
+</div>
+<div class="interface" id="EntriesCallback">
+<a class="backward-compatibility-anchor" name="::File::EntriesCallback"></a><h3>2.20. EntriesCallback</h3>
+<div class="brief">
+ The EntriesCallback interface.
+ </div>
+<pre class="webidl prettyprint"> [Callback=FunctionOnly, NoInterfaceObject] interface EntriesCallback {
+ void handleEvent(<a href="#Entry">Entry</a>[] entries);
+ };</pre>
+<p><span class="version">
+ Since: </span>
+ 3.0
+ </p>
+<p><span class="remark"> Remark : </span>
+ Example of using can be find at <a href="file.html#DirectoryReader::readEntries">DirectoryReader::readEntries</a> code example.
+ </p>
+<div class="methods">
+<h4>Methods</h4>
+<dl>
+<dt class="method" id="EntriesCallback::handleEvent">
+<a class="backward-compatibility-anchor" name="::File::EntriesCallback::handleEvent"></a><code><b><span class="methodName">handleEvent</span></b></code>
+</dt>
+<dd>
+<div class="brief">
+ Used to supply an array of Entries as a response to a user query.
+ </div>
+<div class="synopsis"><pre class="signature prettyprint">void handleEvent(<a href="#Entry">Entry</a>[] entries);
+ </pre></div>
+<p><span class="version">
+ Since: </span>
+ 3.0
+ </p>
+<div class="parameters">
+<p><span class="param">Parameters:</span></p>
+<ul>
+ <li class="param">
+<span class="name">entries</span>:
+ Entry[]
+ </li>
+ </ul>
+</div>
+</dd>
+</dl>
+</div>
+</div>
+<div class="interface" id="MetadataCallback">
+<a class="backward-compatibility-anchor" name="::File::MetadataCallback"></a><h3>2.21. MetadataCallback</h3>
+<div class="brief">
+ The MetadataCallback interface.
+ </div>
+<pre class="webidl prettyprint"> [Callback=FunctionOnly, NoInterfaceObject] interface MetadataCallback {
+ void handleEvent(<a href="#Metadata">Metadata</a> metadata);
+ };</pre>
+<p><span class="version">
+ Since: </span>
+ 3.0
+ </p>
+<p><span class="remark"> Remark : </span>
+ Example of using can be find at <a href="file.html#Entry::getMetadata">Entry::getMetadata</a> code example.
+ </p>
+<div class="methods">
+<h4>Methods</h4>
+<dl>
+<dt class="method" id="MetadataCallback::handleEvent">
+<a class="backward-compatibility-anchor" name="::File::MetadataCallback::handleEvent"></a><code><b><span class="methodName">handleEvent</span></b></code>
+</dt>
+<dd>
+<div class="brief">
+ Used to supply file or directory metadata as a response to a user query.
+ </div>
+<div class="synopsis"><pre class="signature prettyprint">void handleEvent(<a href="#Metadata">Metadata</a> metadata);
+ </pre></div>
+<p><span class="version">
+ Since: </span>
+ 3.0
+ </p>
+<div class="parameters">
+<p><span class="param">Parameters:</span></p>
+<ul>
+ <li class="param">
+<span class="name">metadata</span>:
+ Metadata
+ </li>
+ </ul>
+</div>
+</dd>
+</dl>
+</div>
+</div>
+<div class="interface" id="FileWriterCallback">
+<a class="backward-compatibility-anchor" name="::File::FileWriterCallback"></a><h3>2.22. FileWriterCallback</h3>
+<div class="brief">
+ The FileWriterCallback interface.
+ </div>
+<pre class="webidl prettyprint"> [Callback=FunctionOnly, NoInterfaceObject] interface FileWriterCallback {
+ void handleEvent(<a href="#FileWriter">FileWriter</a> fileWriter);
+ };</pre>
+<p><span class="version">
+ Since: </span>
+ 3.0
+ </p>
+<p><span class="remark"> Remark : </span>
+ Example of using can be find at <a href="file.html#FileEntry::createWriter">FileEntry::createWriter</a> code example.
+ </p>
+<div class="methods">
+<h4>Methods</h4>
+<dl>
+<dt class="method" id="FileWriterCallback::handleEvent">
+<a class="backward-compatibility-anchor" name="::File::FileWriterCallback::handleEvent"></a><code><b><span class="methodName">handleEvent</span></b></code>
+</dt>
+<dd>
+<div class="brief">
+ Used to supply a FileWriter as a response to a user query.
+ </div>
+<div class="synopsis"><pre class="signature prettyprint">void handleEvent(<a href="#FileWriter">FileWriter</a> fileWriter);
+ </pre></div>
+<p><span class="version">
+ Since: </span>
+ 3.0
+ </p>
+<div class="parameters">
+<p><span class="param">Parameters:</span></p>
+<ul>
+ <li class="param">
+<span class="name">fileWriter</span>:
+ FileWriter
+ </li>
+ </ul>
+</div>
+</dd>
+</dl>
+</div>
+</div>
+<div class="interface" id="FileCallback">
+<a class="backward-compatibility-anchor" name="::File::FileCallback"></a><h3>2.23. FileCallback</h3>
+<div class="brief">
+ The FileCallback interface.
+ </div>
+<pre class="webidl prettyprint"> [Callback=FunctionOnly, NoInterfaceObject] interface FileCallback {
+ void handleEvent(<a href="#File">File</a> file);
+ };</pre>
+<p><span class="version">
+ Since: </span>
+ 3.0
+ </p>
+<p><span class="remark"> Remark : </span>
+ Example of using can be find at <a href="file.html#FileEntry::file">FileEntry::file</a> code example.
+ </p>
+<div class="methods">
+<h4>Methods</h4>
+<dl>
+<dt class="method" id="FileCallback::handleEvent">
+<a class="backward-compatibility-anchor" name="::File::FileCallback::handleEvent"></a><code><b><span class="methodName">handleEvent</span></b></code>
+</dt>
+<dd>
+<div class="brief">
+ Used to supply a File as a response to a user query.
+ </div>
+<div class="synopsis"><pre class="signature prettyprint">void handleEvent(<a href="#File">File</a> file);
+ </pre></div>
+<div class="parameters">
+<p><span class="param">Parameters:</span></p>
+<ul>
+ <li class="param">
+<span class="name">file</span>:
+ File
+ </li>
+ </ul>
+</div>
+</dd>
+</dl>
+</div>
+</div>
+<div class="interface" id="VoidCallback">
+<a class="backward-compatibility-anchor" name="::File::VoidCallback"></a><h3>2.24. VoidCallback</h3>
+<div class="brief">
+ The VoidCallback interface.
+ </div>
+<pre class="webidl prettyprint"> [Callback=FunctionOnly, NoInterfaceObject] interface VoidCallback {
+ void handleEvent();
+ };</pre>
+<p><span class="version">
+ Since: </span>
+ 3.0
+ </p>
+<p><span class="remark"> Remark : </span>
+ Example of using can be find at <a href="file.html#Entry::remove">Entry::remove</a> code example.
+ </p>
+<div class="methods">
+<h4>Methods</h4>
+<dl>
+<dt class="method" id="VoidCallback::handleEvent">
+<a class="backward-compatibility-anchor" name="::File::VoidCallback::handleEvent"></a><code><b><span class="methodName">handleEvent</span></b></code>
+</dt>
+<dd>
+<div class="brief">
+ .
+ </div>
+<div class="synopsis"><pre class="signature prettyprint">void handleEvent();
+ </pre></div>
+<p><span class="version">
+ Since: </span>
+ 3.0
+ </p>
+</dd>
+</dl>
+</div>
+</div>
+<div class="interface" id="ErrorCallback">
+<a class="backward-compatibility-anchor" name="::File::ErrorCallback"></a><h3>2.25. ErrorCallback</h3>
+<div class="brief">
+ The ErrorCallback interface.
+ </div>
+<pre class="webidl prettyprint"> [Callback=FunctionOnly, NoInterfaceObject] interface ErrorCallback {
+ void handleEvent(<a href="#FileError">FileError</a> err);
+ };</pre>
+<p><span class="version">
+ Since: </span>
+ 3.0
+ </p>
+<p><span class="remark"> Remark : </span>
+ Example of using can be find at <a href="file.html#Entry::getMetadata">Entry::getMetadata</a> code example.
+ </p>
+<div class="methods">
+<h4>Methods</h4>
+<dl>
+<dt class="method" id="ErrorCallback::handleEvent">
+<a class="backward-compatibility-anchor" name="::File::ErrorCallback::handleEvent"></a><code><b><span class="methodName">handleEvent</span></b></code>
+</dt>
+<dd>
+<div class="brief">
+ There was an error with the request. Details are provided by the FileError parameter.
+ </div>
+<div class="synopsis"><pre class="signature prettyprint">void handleEvent(<a href="#FileError">FileError</a> err);
+ </pre></div>
+<p><span class="version">
+ Since: </span>
+ 3.0
+ </p>
+<div class="parameters">
+<p><span class="param">Parameters:</span></p>
+<ul>
+ <li class="param">
+<span class="name">err</span>:
+ FileError
+ </li>
+ </ul>
+</div>
+</dd>
+</dl>
+</div>
+</div>
+</div>
+<h2 id="full-webidl">3. Full WebIDL</h2>
+<pre class="webidl prettyprint">module File {
+
+ typedef ( or DOMString) WriteData;
+
+ typedef (DOMString or byte[]) ReadResultData;
+
+ dictionary FilePropertyBag {
+
+ DOMString type;
+
+ long long lastModified;
+ };
+
+ dictionary ProgressEventInit {
+ unsigned long long loaded = false;
+ unsigned long long total = false;
+ target = null;
+ };
+
+ [Constructor(DOMString type, optional <a href="#ProgressEventInit">ProgressEventInit</a> eventInitDict)]
+ interface ProgressEvent {
+ readonly attribute DOMString type;
+ readonly attribute boolean bubbles;
+ readonly attribute boolean cancelBubble;
+ readonly attribute boolean cancelable;
+ readonly attribute boolean lengthComputable;
+ readonly attribute unsigned long long loaded;
+ readonly attribute unsigned long long total;
+ readonly attribute target;
+ };
+
+ [NoInterfaceObject] interface FileSystemManagerObject {
+ readonly attribute <a href="#FileSystemManager">FileSystemManager</a> file;
+ };
+ <a href="cordova.html#Cordova">Cordova</a> implements <a href="#FileSystemManagerObject">FileSystemManagerObject</a>;
+
+
+ [NoInterfaceObject] interface FileSystemManager {
+ readonly attribute DOMString applicationDirectory;
+
+ readonly attribute DOMString applicationStorageDirectory;
+
+ readonly attribute DOMString dataDirectory;
+
+ readonly attribute DOMString cacheDirectory;
+
+ readonly attribute DOMString externalApplicationStorageDirectory;
+
+ readonly attribute DOMString externalDataDirectory;
+
+ readonly attribute DOMString externalCacheDirectory;
+
+ readonly attribute DOMString externalRootDirectory;
+
+ readonly attribute DOMString tempDirectory;
+
+ readonly attribute DOMString syncedDataDirectory;
+
+ readonly attribute DOMString documentsDirectory;
+
+ readonly attribute DOMString sharedDirectory;
+
+ };
+
+ [NoInterfaceObject] interface FileSystem {
+
+ readonly attribute DOMString name;
+
+ readonly attribute <a href="#DirectoryEntry">DirectoryEntry</a> root;
+ };
+
+ interface Metadata {
+ readonly attribute Date modificationTime;
+
+ readonly attribute unsigned long long size;
+ };
+
+ [NoInterfaceObject] interface FileError {
+ const unsigned short NOT_FOUND_ERR = 1;
+ const unsigned short SECURITY_ERR = 2;
+ const unsigned short ABORT_ERR = 3;
+ const unsigned short NOT_READABLE_ERR = 4;
+ const unsigned short ENCODING_ERR = 5;
+ const unsigned short NO_MODIFICATION_ALLOWED_ERR = 6;
+ const unsigned short INVALID_STATE_ERR = 7;
+ const unsigned short SYNTAX_ERR = 8;
+ const unsigned short INVALID_MODIFICATION_ERR = 9;
+ const unsigned short QUOTA_EXCEEDED_ERR = 10;
+ const unsigned short TYPE_MISMATCH_ERR = 11;
+ const unsigned short PATH_EXISTS_ERR = 12;
+ attribute unsigned short code;
+ };
+
+ [NoInterfaceObject] interface File {
+
+ readonly attribute DOMString name;
+
+ readonly attribute DOMString localURL;
+
+ readonly attribute DOMString type;
+
+ readonly attribute Date lastModified;
+
+ readonly attribute long long size;
+ };
+
+ [NoInterfaceObject] interface LocalFileSystem {
+
+ const short TEMPORARY = 0;
+
+ const short PERSISTENT = 1;
+
+ void requestFileSystem(short type, long long size, optional <a href="#FileSystemCallback">FileSystemCallback</a>? successCallback, optional <a href="#ErrorCallback">ErrorCallback</a>? errorCallback);
+
+ void resolveLocalFileSystemURL(DOMString uri, optional <a href="#EntryCallback">EntryCallback</a>? successCallback, optional <a href="#ErrorCallback">ErrorCallback</a>? errorCallback);
+
+ };
+
+ Window implements <a href="#LocalFileSystem">LocalFileSystem</a>;
+
+ [NoInterfaceObject] interface Entry {
+
+ readonly attribute boolean isFile;
+
+ readonly attribute boolean isDirectory;
+
+ readonly attribute DOMString fullPath;
+
+ readonly attribute DOMString name;
+
+ readonly attribute <a href="#FileSystem">FileSystem</a> filesystem;
+
+ void getMetadata(<a href="#MetadataCallback">MetadataCallback</a> onsuccess, optional <a href="#ErrorCallback">ErrorCallback</a>? onerror);
+
+ void moveTo(<a href="#DirectoryEntry">DirectoryEntry</a> parent, optional DOMString? newName, optional <a href="#EntryCallback">EntryCallback</a>? onsuccess, optional <a href="#ErrorCallback">ErrorCallback</a>? onerror);
+
+ void copyTo(<a href="#DirectoryEntry">DirectoryEntry</a> parent, optional DOMString? newName, optional <a href="#EntryCallback">EntryCallback</a>? onsuccess, optional <a href="#ErrorCallback">ErrorCallback</a>? onerror);
+
+ void getParent(<a href="#EntryCallback">EntryCallback</a> onsuccess, optional <a href="#ErrorCallback">ErrorCallback</a>? onerror);
+
+ void remove(<a href="#VoidCallback">VoidCallback</a> onsuccess, optional <a href="#ErrorCallback">ErrorCallback</a>? onerror);
+
+ DOMString toURL();
+ };
+
+ interface DirectoryEntry : <a href="#Entry">Entry</a> {
+
+ <a href="#DirectoryReader">DirectoryReader</a> createReader();
+
+ void getDirectory(DOMString path, optional ? options, optional <a href="#EntryCallback">EntryCallback</a>? onsuccess, optional <a href="#ErrorCallback">ErrorCallback</a>? onerror);
+
+ void getFile(DOMString path, optional ? options, optional <a href="#EntryCallback">EntryCallback</a>? onsuccess, optional <a href="#ErrorCallback">ErrorCallback</a>? onerror);
+
+ void removeRecursively(<a href="#VoidCallback">VoidCallback</a> onsuccess, optional <a href="#ErrorCallback">ErrorCallback</a>? onerror);
+ };
+
+ [NoInterfaceObject] interface DirectoryReader {
+
+ void readEntries(<a href="#EntriesCallback">EntriesCallback</a> onsuccess, optional <a href="#ErrorCallback">ErrorCallback</a>? onerror);
+ };
+
+ [NoInterfaceObject] interface FileEntry : <a href="#Entry">Entry</a> {
+
+ void createWriter(<a href="#FileWriterCallback">FileWriterCallback</a> onsuccess, optional <a href="#ErrorCallback">ErrorCallback</a>? onerror);
+
+ void file (<a href="#FileCallback">FileCallback</a> onsuccess, optional <a href="#ErrorCallback">ErrorCallback</a> onerror);
+ };
+
+ [Constructor()]
+ interface FileReader {
+ const short EMPTY = 0;
+ const short LOADING = 1;
+ const short DONE = 2;
+
+ readonly attribute short readyState;
+
+ readonly attribute <a href="#ReadResultData">ReadResultData</a>? result;
+
+ readonly attribute <a href="#FileError">FileError</a>? error;
+
+ attribute <a href="#ProgressCallback">ProgressCallback</a>? onloadstart;
+
+ attribute <a href="#ProgressCallback">ProgressCallback</a>? onload;
+
+ attribute <a href="#ProgressCallback">ProgressCallback</a>? onabort;
+
+ attribute <a href="#ProgressCallback">ProgressCallback</a>? onerror;
+
+ attribute <a href="#ProgressCallback">ProgressCallback</a>? onloadend;
+
+ void abort();
+
+ void readAsDataURL( blob);
+
+ void readAsText( blob, optional DOMString? label);
+
+ void readAsBinaryString( blob);
+
+ void readAsArrayBuffer( blob);
+ };
+
+ [NoInterfaceObject] interface FileWriter {
+ const short INIT = 0;
+ const short WRITING = 1;
+ const short DONE = 2;
+
+ attribute short readyState;
+
+ attribute DOMString fileName;
+
+ attribute long length;
+
+ attribute long position;
+
+ attribute <a href="#FileError">FileError</a>? error;
+
+ attribute <a href="#ProgressCallback">ProgressCallback</a>? onwritestart;
+
+ attribute <a href="#ProgressCallback">ProgressCallback</a>? onwrite;
+
+ attribute <a href="#ProgressCallback">ProgressCallback</a>? onabort;
+
+ attribute <a href="#ProgressCallback">ProgressCallback</a>? onerror;
+
+ attribute <a href="#ProgressCallback">ProgressCallback</a>? onwriteend;
+
+ void abort ();
+
+ void seek (long offset);
+
+ void truncate (long size);
+
+ void write (<a href="#WriteData">WriteData</a> data);
+ };
+
+ [Callback=FunctionOnly, NoInterfaceObject] interface ProgressCallback {
+ void onsuccess(<a href="#ProgressEvent">ProgressEvent</a> event);
+ };
+
+ [Callback=FunctionOnly, NoInterfaceObject] interface FileSystemCallback {
+ void handleEvent(<a href="#FileSystem">FileSystem</a> filesystem);
+ };
+
+ [Callback=FunctionOnly, NoInterfaceObject] interface EntryCallback {
+ void handleEvent(<a href="#Entry">Entry</a> entry);
+ };
+
+ [Callback=FunctionOnly, NoInterfaceObject] interface EntriesCallback {
+ void handleEvent(<a href="#Entry">Entry</a>[] entries);
+ };
+
+ [Callback=FunctionOnly, NoInterfaceObject] interface MetadataCallback {
+ void handleEvent(<a href="#Metadata">Metadata</a> metadata);
+ };
+
+ [Callback=FunctionOnly, NoInterfaceObject] interface FileWriterCallback {
+ void handleEvent(<a href="#FileWriter">FileWriter</a> fileWriter);
+ };
+
+ [Callback=FunctionOnly, NoInterfaceObject] interface FileCallback {
+ void handleEvent(<a href="#File">File</a> file);
+ };
+
+ [Callback=FunctionOnly, NoInterfaceObject] interface VoidCallback {
+ void handleEvent();
+ };
+
+ [Callback=FunctionOnly, NoInterfaceObject] interface ErrorCallback {
+ void handleEvent(<a href="#FileError">FileError</a> err);
+ };
+
+};</pre>
+</div>
+<div id="page-footer">
+<div class="copyright" align="center">
+ Except as noted, this content - excluding the Code Examples - is licensed under <a href="http://creativecommons.org/licenses/by/3.0/legalcode" target="_blank">Creative Commons Attribution 3.0</a> and all of the Code Examples contained herein are licensed under <a href="https://www.tizen.org/bsd-3-clause-license" target="_blank">BSD-3-Clause</a>. <br>For details, see the <a href="https://www.tizen.org/content-license" target="_blank">Content License</a>.
+ </div>
+<script type="text/javascript">
+
+ var _gaq = _gaq || [];
+ _gaq.push(['_setAccount', 'UA-25976949-1']);
+ _gaq.push(['_setDomainName', 'tizen.org']);
+ _gaq.push(['_trackPageview']);
+
+ (function() {
+ var ga = document.createElement('script'); ga.type = 'text/javascript'; ga.async = true;
+ var s = document.getElementsByTagName('script')[0]; s.parentNode.insertBefore(ga, s);
+ })();
+
+ </script>
+</div>
+</body>
+</html>
--- /dev/null
+<!DOCTYPE html PUBLIC "html">
+<html>
+<head>
+<meta http-equiv="Content-Type" content="text/html; charset=utf-8">
+<link rel="stylesheet" type="text/css" href="../tizen.css" media="screen">
+<script type="text/javascript" src="snippet.js"></script><title>FileTransfer API</title>
+</head>
+<body id="page-content" onload="prettyPrint()">
+<div class="api" id="::FileTransfer">
+<div class="supported-platforms"><img class="mobile-mandatory emulator" title="Mandatory, Supported by Tizen Mobile emulator" src="../mobile_s_w.png"></div>
+<div class="title"><h1>FileTransfer API</h1></div>
+<div class="brief">
+ This module allows you to upload and download files.
+ </div>
+<div class="description">
+ <p>
+Original documetation: <a href="https://www.npmjs.com/package/cordova-plugin-file-transfer">Cordova FileTransfer</a> </p>
+ </div>
+<p><span class="version">
+ Since: </span>
+ 3.0
+ </p>
+<h2>Table of Contents</h2>
+<ul class="toc">
+<li>1. <a href="#typedefs-section">Type Definitions</a><ul class="toc">
+<li>
+ 1.1. <a href="#FileUploadParams">FileUploadParams</a>
+</li>
+<li>
+ 1.2. <a href="#HeaderFields">HeaderFields</a>
+</li>
+<li>
+ 1.3. <a href="#FileDownloadOptions">FileDownloadOptions</a>
+</li>
+</ul>
+</li>
+<li>2. <a href="#interfaces-section">Interfaces</a><ul class="toc">
+<li>2.1. <a href="#FileUploadOptions">FileUploadOptions</a>
+</li>
+<li>2.2. <a href="#FileUploadResult">FileUploadResult</a>
+</li>
+<li>2.3. <a href="#FileTransferError">FileTransferError</a>
+</li>
+<li>2.4. <a href="#FileTransfer">FileTransfer</a>
+</li>
+<li>2.5. <a href="#FileUploadSuccessCallback">FileUploadSuccessCallback</a>
+</li>
+<li>2.6. <a href="#FileDownloadSuccessCallback">FileDownloadSuccessCallback</a>
+</li>
+<li>2.7. <a href="#FileTransferErrorCallback">FileTransferErrorCallback</a>
+</li>
+</ul>
+</li>
+<li>3. <a href="#full-webidl">Full WebIDL</a>
+</li>
+</ul>
+<hr>
+<h2 id="method-summary">Summary of Interfaces and Methods</h2>
+<table class="informaltable">
+<thead><tr>
+<th>Interface</th>
+<th>Method</th>
+</tr></thead>
+<tbody>
+<tr>
+<td><a href="#FileUploadOptions">FileUploadOptions</a></td>
+<td></td>
+</tr>
+<tr>
+<td><a href="#FileUploadResult">FileUploadResult</a></td>
+<td></td>
+</tr>
+<tr>
+<td><a href="#FileTransferError">FileTransferError</a></td>
+<td></td>
+</tr>
+<tr>
+<td><a href="#FileTransfer">FileTransfer</a></td>
+<td>
+<div>void <a href="#FileTransfer::upload">upload</a> (DOMString fileURL, DOMString server, optional <a href="#FileUploadSuccessCallback">FileUploadSuccessCallback</a>? successCallback, optional <a href="#FileTransferErrorCallback">FileTransferErrorCallback</a>? errorCallback, optional <a href="#FileUploadOptions">FileUploadOptions</a>? options, optional boolean? trustAllHosts)</div>
+<div>void <a href="#FileTransfer::download">download</a> (DOMString source, DOMString target, optional <a href="#FileDownloadSuccessCallback">FileDownloadSuccessCallback</a>? successCallback, optional <a href="#FileTransferErrorCallback">FileTransferErrorCallback</a>? errorCallback, optional boolean? trustAllHosts, optional <a href="#FileDownloadOptions">FileDownloadOptions</a>? options)</div>
+<div>void <a href="#FileTransfer::abort">abort</a> ()</div>
+</td>
+</tr>
+<tr>
+<td><a href="#FileUploadSuccessCallback">FileUploadSuccessCallback</a></td>
+<td><div>void <a href="#FileUploadSuccessCallback::onsuccess">onsuccess</a> (<a href="#FileUploadResult">FileUploadResult</a> result)</div></td>
+</tr>
+<tr>
+<td><a href="#FileDownloadSuccessCallback">FileDownloadSuccessCallback</a></td>
+<td><div>void <a href="#FileDownloadSuccessCallback::onsuccess">onsuccess</a> (<a href="file.html#FileEntry">FileEntry</a> file)</div></td>
+</tr>
+<tr>
+<td><a href="#FileTransferErrorCallback">FileTransferErrorCallback</a></td>
+<td><div>void <a href="#FileTransferErrorCallback::onerror">onerror</a> (<a href="#FileTransferError">FileTransferError</a> error)</div></td>
+</tr>
+</tbody>
+</table>
+<div class="typedefs" id="typedefs-section">
+<h2>1. Type Definitions</h2>
+<div class="typedef" id="FileUploadParams">
+<a class="backward-compatibility-anchor" name="::FileTransfer::FileUploadParams"></a><h3>1.1. FileUploadParams</h3>
+<div class="brief">
+ A set of additional upload HTTP request parameters.
+ </div>
+<pre class="webidl prettyprint"> typedef object FileUploadParams;</pre>
+<p><span class="version">
+ Since: </span>
+ 3.0
+ </p>
+<div class="description">
+ <p>
+The key / value type to pass in the HTTP request.
+ </p>
+ </div>
+</div>
+<div class="typedef" id="HeaderFields">
+<a class="backward-compatibility-anchor" name="::FileTransfer::HeaderFields"></a><h3>1.2. HeaderFields</h3>
+<div class="brief">
+ A set of HTTP header fields.
+ </div>
+<pre class="webidl prettyprint"> typedef object HeaderFields;</pre>
+<p><span class="version">
+ Since: </span>
+ 3.0
+ </p>
+<div class="description">
+ <p>
+The key / value type of each HTTP header field should be DOMString.
+ </p>
+ </div>
+</div>
+<div class="typedef" id="FileDownloadOptions">
+<a class="backward-compatibility-anchor" name="::FileTransfer::FileDownloadOptions"></a><h3>1.3. FileDownloadOptions</h3>
+<div class="brief">
+ A set of download options.
+ </div>
+<pre class="webidl prettyprint"> typedef object FileDownloadOptions;</pre>
+<p><span class="version">
+ Since: </span>
+ 3.0
+ </p>
+<div class="description">
+ <p>
+The key / value type of download options values. Currently only supports headers (such as Authorization (Basic Authentication), etc).
+ </p>
+ </div>
+</div>
+</div>
+<div class="interfaces" id="interfaces-section">
+<h2>2. Interfaces</h2>
+<div class="interface" id="FileUploadOptions">
+<a class="backward-compatibility-anchor" name="::FileTransfer::FileUploadOptions"></a><h3>2.1. FileUploadOptions</h3>
+<div class="brief">
+ A FileUploadOptions object can be passed to the FileTransfer objects upload method in order to specify additional parameters to the upload script
+ </div>
+<pre class="webidl prettyprint"> [Constructor(DOMString fileKey, DOMString fileName, DOMString mimeType, <a href="#FileUploadParams">FileUploadParams</a> params, <a href="#HeaderFields">HeaderFields</a> headers, DOMString httpMethod)]
+ interface FileUploadOptions {
+ attribute DOMString fileKey;
+ attribute DOMString fileName;
+ attribute DOMString httpMethod;
+ attribute DOMString mimeType;
+ attribute <a href="#FileUploadParams">FileUploadParams</a> params;
+ attribute boolean chunkedMode;
+ attribute <a href="#HeaderFields">HeaderFields</a> headers;
+ };</pre>
+<p><span class="version">
+ Since: </span>
+ 3.0
+ </p>
+<div class="example">
+<span class="example"><p>Code example:</p></span><pre name="code" class="examplecode prettyprint"> var fileURL; // We assume the variable fileURL contains a valid URL to a text file on the device.
+
+ var win = function (r) {
+ console.log('Code = ' + r.responseCode);
+ console.log('Response = ' + r.response);
+ console.log('Sent = ' + r.bytesSent);
+ }
+
+ var fail = function (error) {
+ alert('An error has occurred: Code = ' + error.code);
+ console.log('upload error source ' + error.source);
+ console.log('upload error target ' + error.target);
+ }
+
+ var options = new FileUploadOptions();
+ options.fileKey = 'file';
+ options.fileName = fileURL.substr(fileURL.lastIndexOf('/') + 1);
+ options.mimeType = 'text/plain';
+
+ var params = {};
+ params.value1 = 'test';
+ params.value2 = 'param';
+
+ options.params = params;
+
+ var ft = new FileTransfer();
+ ft.upload(fileURL, encodeURI('http://some.server.com/upload.php'), win, fail, options);
+ </pre>
+</div>
+<div class="output">
+<span class="title"><p>Output example:</p></span><pre>Code = 200
+Response = OK
+Sent = 1024
+</pre>
+</div>
+<div class="constructors">
+<h4 id="FileUploadOptions::constructor">Constructors</h4>
+<dl>
+<pre class="webidl prettyprint">FileUploadOptions(DOMString fileKey, DOMString fileName, DOMString mimeType, <a href="#FileUploadParams">FileUploadParams</a> params, <a href="#HeaderFields">HeaderFields</a> headers, DOMString httpMethod);</pre>
+<div class="example">
+<span class="example"><p>Code example:</p></span><pre name="code" class="examplecode prettyprint"> // Creates a FileUploadOptions object.
+ var options = new FileUploadOptions('file', 'doc.txt', 'text/plain', null, null, 'POST');
+ </pre>
+</div>
+</dl>
+</div>
+<div class="attributes">
+<h4>Attributes</h4>
+<ul>
+<li class="attribute" id="FileUploadOptions::fileKey">
+<span class="attrName"><span class="type">DOMString </span><span class="name">fileKey</span></span><div class="brief">
+ The name of the form element. Defaults to file
+ </div>
+<p><span class="version">
+ Since: </span>
+ 3.0
+ </p>
+</li>
+<li class="attribute" id="FileUploadOptions::fileName">
+<span class="attrName"><span class="type">DOMString </span><span class="name">fileName</span></span><div class="brief">
+ The file name to use when saving the file on the server. Defaults to image.jpg.
+ </div>
+<p><span class="version">
+ Since: </span>
+ 3.0
+ </p>
+</li>
+<li class="attribute" id="FileUploadOptions::httpMethod">
+<span class="attrName"><span class="type">DOMString </span><span class="name">httpMethod</span></span><div class="brief">
+ The HTTP method to use - either PUT or POST. Defaults to POST.
+ </div>
+<p><span class="version">
+ Since: </span>
+ 3.0
+ </p>
+</li>
+<li class="attribute" id="FileUploadOptions::mimeType">
+<span class="attrName"><span class="type">DOMString </span><span class="name">mimeType</span></span><div class="brief">
+ The mime type of the data to upload. Defaults to image/jpeg.
+ </div>
+<p><span class="version">
+ Since: </span>
+ 3.0
+ </p>
+</li>
+<li class="attribute" id="FileUploadOptions::params">
+<span class="attrName"><span class="type">FileUploadParams </span><span class="name">params</span></span><div class="brief">
+ A set of optional key/value pairs to pass in the HTTP request.
+ </div>
+<p><span class="version">
+ Since: </span>
+ 3.0
+ </p>
+</li>
+<li class="attribute" id="FileUploadOptions::chunkedMode">
+<span class="attrName"><span class="type">boolean </span><span class="name">chunkedMode</span></span><div class="brief">
+ Whether to upload the data in chunked streaming mode. Defaults to true.
+ </div>
+<p><span class="version">
+ Since: </span>
+ 3.0
+ </p>
+</li>
+<li class="attribute" id="FileUploadOptions::headers">
+<span class="attrName"><span class="type">HeaderFields </span><span class="name">headers</span></span><div class="brief">
+ A map of header name/header values. Use an array to specify more than one value.
+ </div>
+<p><span class="version">
+ Since: </span>
+ 3.0
+ </p>
+</li>
+</ul>
+</div>
+</div>
+<div class="interface" id="FileUploadResult">
+<a class="backward-compatibility-anchor" name="::FileTransfer::FileUploadResult"></a><h3>2.2. FileUploadResult</h3>
+<div class="brief">
+ A FileUploadResult object is passed to the success callback of the FileTransfer object's upload() method.
+ </div>
+<pre class="webidl prettyprint"> [NoInterfaceObject] interface FileUploadResult {
+ attribute long bytesSent;
+ attribute long responseCode;
+ attribute DOMString response;
+ attribute <a href="#HeaderFields">HeaderFields</a> headers;
+ };</pre>
+<p><span class="version">
+ Since: </span>
+ 3.0
+ </p>
+<div class="attributes">
+<h4>Attributes</h4>
+<ul>
+<li class="attribute" id="FileUploadResult::bytesSent">
+<span class="attrName"><span class="type">long </span><span class="name">bytesSent</span></span><div class="brief">
+ The number of bytes sent to the server as part of the upload.
+ </div>
+<p><span class="version">
+ Since: </span>
+ 3.0
+ </p>
+</li>
+<li class="attribute" id="FileUploadResult::responseCode">
+<span class="attrName"><span class="type">long </span><span class="name">responseCode</span></span><div class="brief">
+ The HTTP response code returned by the server.
+ </div>
+<p><span class="version">
+ Since: </span>
+ 3.0
+ </p>
+</li>
+<li class="attribute" id="FileUploadResult::response">
+<span class="attrName"><span class="type">DOMString </span><span class="name">response</span></span><div class="brief">
+ The HTTP response returned by the server.
+ </div>
+<p><span class="version">
+ Since: </span>
+ 3.0
+ </p>
+</li>
+<li class="attribute" id="FileUploadResult::headers">
+<span class="attrName"><span class="type">HeaderFields </span><span class="name">headers</span></span><div class="brief">
+ The HTTP response headers by the server.
+ </div>
+<p><span class="version">
+ Since: </span>
+ 3.0
+ </p>
+</li>
+</ul>
+</div>
+</div>
+<div class="interface" id="FileTransferError">
+<a class="backward-compatibility-anchor" name="::FileTransfer::FileTransferError"></a><h3>2.3. FileTransferError</h3>
+<div class="brief">
+ A FileTransferError object is passed to an error callback when an error occurs.
+ </div>
+<pre class="webidl prettyprint"> interface FileTransferError {
+ attribute short code;
+ attribute DOMString source;
+ attribute DOMString target;
+ attribute long http_status;
+ attribute DOMString body;
+ attribute DOMString exception;
+ const short FILE_NOT_FOUND_ERR = 1;
+ const short INVALID_URL_ERR = 2;
+ const short CONNECTION_ERR = 3;
+ const short ABORT_ERR = 4;
+ const short NOT_MODIFIED_ERR = 5;
+ };</pre>
+<p><span class="version">
+ Since: </span>
+ 3.0
+ </p>
+<div class="consts">
+<h4>Constants</h4>
+<dl>
+<li class="const" id="FileTransferError::FILE_NOT_FOUND_ERR">
+<a class="backward-compatibility-anchor" name="::FileTransfer::FileTransferError::FILE_NOT_FOUND_ERR"></a><span class="name">FILE_NOT_FOUND_ERR</span><div class="brief">
+ File Not Found error.
+ </div>
+<p><span class="version">
+ Since: </span>
+ 3.0
+ </p>
+<br><br>
+</li>
+<li class="const" id="FileTransferError::INVALID_URL_ERR">
+<a class="backward-compatibility-anchor" name="::FileTransfer::FileTransferError::INVALID_URL_ERR"></a><span class="name">INVALID_URL_ERR</span><div class="brief">
+ Invalid URL error.
+ </div>
+<p><span class="version">
+ Since: </span>
+ 3.0
+ </p>
+<br><br>
+</li>
+<li class="const" id="FileTransferError::CONNECTION_ERR">
+<a class="backward-compatibility-anchor" name="::FileTransfer::FileTransferError::CONNECTION_ERR"></a><span class="name">CONNECTION_ERR</span><div class="brief">
+ Connection error.
+ </div>
+<p><span class="version">
+ Since: </span>
+ 3.0
+ </p>
+<br><br>
+</li>
+<li class="const" id="FileTransferError::ABORT_ERR">
+<a class="backward-compatibility-anchor" name="::FileTransfer::FileTransferError::ABORT_ERR"></a><span class="name">ABORT_ERR</span><div class="brief">
+ Abort error.
+ </div>
+<p><span class="version">
+ Since: </span>
+ 3.0
+ </p>
+<br><br>
+</li>
+<li class="const" id="FileTransferError::NOT_MODIFIED_ERR">
+<a class="backward-compatibility-anchor" name="::FileTransfer::FileTransferError::NOT_MODIFIED_ERR"></a><span class="name">NOT_MODIFIED_ERR</span><div class="brief">
+ Not Modified error.
+ </div>
+<p><span class="version">
+ Since: </span>
+ 3.0
+ </p>
+<br><br>
+</li>
+</dl>
+</div>
+<div class="attributes">
+<h4>Attributes</h4>
+<ul>
+<li class="attribute" id="FileTransferError::code">
+<span class="attrName"><span class="type">short </span><span class="name">code</span></span><div class="brief">
+ One of the predefined error codes listed above.
+ </div>
+<p><span class="version">
+ Since: </span>
+ 3.0
+ </p>
+</li>
+<li class="attribute" id="FileTransferError::source">
+<span class="attrName"><span class="type">DOMString </span><span class="name">source</span></span><div class="brief">
+ URL to the source.
+ </div>
+<p><span class="version">
+ Since: </span>
+ 3.0
+ </p>
+</li>
+<li class="attribute" id="FileTransferError::target">
+<span class="attrName"><span class="type">DOMString </span><span class="name">target</span></span><div class="brief">
+ URL to the target.
+ </div>
+<p><span class="version">
+ Since: </span>
+ 3.0
+ </p>
+</li>
+<li class="attribute" id="FileTransferError::http_status">
+<span class="attrName"><span class="type">long </span><span class="name">http_status</span></span><div class="brief">
+ HTTP status code. This attribute is only available when a response code is received from the HTTP connection.
+ </div>
+<p><span class="version">
+ Since: </span>
+ 3.0
+ </p>
+</li>
+<li class="attribute" id="FileTransferError::body">
+<span class="attrName"><span class="type">DOMString </span><span class="name">body</span></span><div class="brief">
+ Response body. This attribute is only available when a response is received from the HTTP connection.
+ </div>
+<p><span class="version">
+ Since: </span>
+ 3.0
+ </p>
+</li>
+<li class="attribute" id="FileTransferError::exception">
+<span class="attrName"><span class="type">DOMString </span><span class="name">exception</span></span><div class="brief">
+ Either e.getMessage or e.toString
+ </div>
+<p><span class="version">
+ Since: </span>
+ 3.0
+ </p>
+</li>
+</ul>
+</div>
+</div>
+<div class="interface" id="FileTransfer">
+<a class="backward-compatibility-anchor" name="::FileTransfer::FileTransfer"></a><h3>2.4. FileTransfer</h3>
+<div class="brief">
+ The FileTransfer object provides a way to upload files using an HTTP multi-part POST or PUT request, and to download files as well.
+ </div>
+<pre class="webidl prettyprint"> [Constructor()]
+ interface FileTransfer {
+ [TreatNonCallableAsNull] attribute <a href="file.html#ProgressCallback">ProgressCallback</a>? onprogress;
+
+ void upload(DOMString fileURL, DOMString server, optional <a href="#FileUploadSuccessCallback">FileUploadSuccessCallback</a>? successCallback, optional <a href="#FileTransferErrorCallback">FileTransferErrorCallback</a>? errorCallback, optional <a href="#FileUploadOptions">FileUploadOptions</a>? options, optional boolean? trustAllHosts);
+
+ void download(DOMString source, DOMString target, optional <a href="#FileDownloadSuccessCallback">FileDownloadSuccessCallback</a>? successCallback, optional <a href="#FileTransferErrorCallback">FileTransferErrorCallback</a>? errorCallback, optional boolean? trustAllHosts, optional <a href="#FileDownloadOptions">FileDownloadOptions</a>? options);
+
+ void abort();
+ };</pre>
+<p><span class="version">
+ Since: </span>
+ 3.0
+ </p>
+<div class="constructors">
+<h4 id="FileTransfer::constructor">Constructors</h4>
+<dl>
+<pre class="webidl prettyprint">FileTransfer();</pre>
+<div class="example">
+<span class="example"><p>Code example:</p></span><pre name="code" class="examplecode prettyprint"> // Creates a FileTransfer object.
+ var file_transfer = new FileTransfer();
+ </pre>
+</div>
+</dl>
+</div>
+<div class="attributes">
+<h4>Attributes</h4>
+<ul><li class="attribute" id="FileTransfer::onprogress">
+<span class="attrName"><span class="type">ProgressCallback </span><span class="name">onprogress</span><span class="optional"> [nullable]</span></span><div class="brief">
+ Called with a ProgressEvent whenever a new chunk of data is transferred.
+ </div>
+<p><span class="version">
+ Since: </span>
+ 3.0
+ </p>
+<div class="example">
+<span class="example"><p>Code example:</p></span><pre name="code" class="examplecode prettyprint"> var fileURL; // should be a valid url eg. cdvfile://localhost/persistent/path/to/file.txt
+
+ var win = function(r) {
+ console.log('Success. File uploaded.');
+ }
+
+ var fail = function(error) {
+ // error.code == FileTransferError.ABORT_ERR
+ alert('An error has occurred: Code = ' + error.code);
+ console.log('upload error source ' + error.source);
+ console.log('upload error target ' + error.target);
+ };
+
+ var ft = new FileTransfer();
+
+ ft.onprogress = function(event) {
+ console.log('uploaded: ' + event.loaded);
+ };
+
+ ft.upload(fileURL, encodeURI('http://some.server.com/upload.php'), win, fail);
+ </pre>
+</div>
+<div class="output">
+<span class="title"><p>Output example:</p></span><pre>uploaded: 512
+uploaded: 1024
+Success. File uploaded.
+</pre>
+</div>
+</li></ul>
+</div>
+<div class="methods">
+<h4>Methods</h4>
+<dl>
+<dt class="method" id="FileTransfer::upload">
+<a class="backward-compatibility-anchor" name="::FileTransfer::FileTransfer::upload"></a><code><b><span class="methodName">upload</span></b></code>
+</dt>
+<dd>
+<div class="brief">
+ Sends a file to a server.
+ </div>
+<div class="synopsis"><pre class="signature prettyprint">void upload(DOMString fileURL, DOMString server, optional <a href="#FileUploadSuccessCallback">FileUploadSuccessCallback</a>? successCallback, optional <a href="#FileTransferErrorCallback">FileTransferErrorCallback</a>? errorCallback, optional <a href="#FileUploadOptions">FileUploadOptions</a>? options, optional boolean? trustAllHosts);
+ </pre></div>
+<p><span class="version">
+ Since: </span>
+ 3.0
+ </p>
+<p><span class="privilegelevel">
+ Privilege level: </span>
+ public
+ </p>
+<p><span class="privilege">
+ Privilege: </span>
+ http://tizen.org/privilege/filesystem.read
+ </p>
+<p><span class="privilege">
+ Privilege: </span>
+ http://tizen.org/privilege/internet
+ </p>
+<div class="parameters">
+<p><span class="param">Parameters:</span></p>
+<ul>
+ <li class="param">
+<span class="name">fileURL</span>:
+ Filesystem URL representing the file on the device. For backwards compatibility, this can also be the full path of the file on the device.
+ </li>
+ <li class="param">
+<span class="name">server</span>:
+ URL of the server to receive the file, as encoded by encodeURI().
+ </li>
+ <li class="param">
+<span class="name">successCallback</span><span class="optional"> [optional]</span><span class="optional"> [nullable]</span>:
+ A callback that is passed a FileUploadResult object.
+ </li>
+ <li class="param">
+<span class="name">errorCallback</span><span class="optional"> [optional]</span><span class="optional"> [nullable]</span>:
+ : A callback that executes if an error occurs retrieving the FileUploadResult. Invoked with a FileTransferError object.
+ </li>
+ <li class="param">
+<span class="name">options</span><span class="optional"> [optional]</span><span class="optional"> [nullable]</span>:
+ Optional parameters
+ </li>
+ <li class="param">
+<span class="name">trustAllHosts</span><span class="optional"> [optional]</span><span class="optional"> [nullable]</span>:
+ Optional parameter, defaults to false. If set to true, it accepts all security certificates.
+ </li>
+ </ul>
+</div>
+<div class="example">
+<span class="example"><p>Code example:</p></span><pre name="code" class="examplecode prettyprint"> var fileURL; // should be a valid url eg. cdvfile://localhost/persistent/path/to/file.txt
+
+ var win = function (r) {
+ console.log('Code = ' + r.responseCode);
+ console.log('Response = ' + r.response);
+ console.log('Sent = ' + r.bytesSent);
+ }
+
+ var fail = function (error) {
+ alert('An error has occurred: Code = ' + error.code);
+ console.log('upload error source ' + error.source);
+ console.log('upload error target ' + error.target);
+ }
+
+ var ft = new FileTransfer();
+ ft.upload(fileURL, encodeURI('http://some.server.com/upload.php'), win, fail);
+ </pre>
+</div>
+<div class="output">
+<span class="title"><p>Output example:</p></span><pre>Code = 200
+Response = OK
+Sent = 1024
+</pre>
+</div>
+</dd>
+<dt class="method" id="FileTransfer::download">
+<a class="backward-compatibility-anchor" name="::FileTransfer::FileTransfer::download"></a><code><b><span class="methodName">download</span></b></code>
+</dt>
+<dd>
+<div class="brief">
+ Downloads a file from a server.
+ </div>
+<div class="synopsis"><pre class="signature prettyprint">void download(DOMString source, DOMString target, optional <a href="#FileDownloadSuccessCallback">FileDownloadSuccessCallback</a>? successCallback, optional <a href="#FileTransferErrorCallback">FileTransferErrorCallback</a>? errorCallback, optional boolean? trustAllHosts, optional <a href="#FileDownloadOptions">FileDownloadOptions</a>? options);
+ </pre></div>
+<p><span class="version">
+ Since: </span>
+ 3.0
+ </p>
+<p><span class="privilegelevel">
+ Privilege level: </span>
+ public
+ </p>
+<p><span class="privilege">
+ Privilege: </span>
+ http://tizen.org/privilege/filesystem.read
+ </p>
+<p><span class="privilege">
+ Privilege: </span>
+ http://tizen.org/privilege/filesystem.write
+ </p>
+<div class="parameters">
+<p><span class="param">Parameters:</span></p>
+<ul>
+ <li class="param">
+<span class="name">source</span>:
+ URL of the server to download the file, as encoded by encodeURI().
+ </li>
+ <li class="param">
+<span class="name">target</span>:
+ Filesystem url representing the file on the device. For backwards compatibility, this can also be the full path of the file on the device.
+ </li>
+ <li class="param">
+<span class="name">successCallback</span><span class="optional"> [optional]</span><span class="optional"> [nullable]</span>:
+ A callback that is passed a FileEntry object.
+ </li>
+ <li class="param">
+<span class="name">errorCallback</span><span class="optional"> [optional]</span><span class="optional"> [nullable]</span>:
+ A callback that executes if an error occurs when retrieving the FileEntry. Invoked with a FileTransferError object.
+ </li>
+ <li class="param">
+<span class="name">trustAllHosts</span><span class="optional"> [optional]</span><span class="optional"> [nullable]</span>:
+ Optional parameter, defaults to false. If set to true, it accepts all security certificates.
+ </li>
+ <li class="param">
+<span class="name">options</span><span class="optional"> [optional]</span><span class="optional"> [nullable]</span>:
+ Optional parameters, currently only supports headers (such as Authorization (Basic Authentication), etc).
+ </li>
+ </ul>
+</div>
+<div class="example">
+<span class="example"><p>Code example:</p></span><pre name="code" class="examplecode prettyprint"> var fileURL; // should be a valid url eg. cdvfile://localhost/persistent/path/to/file.txt
+
+ var fileTransfer = new FileTransfer();
+ var uri = encodeURI('http://some.server.com/download.php');
+
+ fileTransfer.download(
+ uri,
+ fileURL,
+ function(entry) {
+ console.log('download complete: ' + entry.toURL());
+ },
+ function(error) {
+ console.log('download error source ' + error.source);
+ console.log('download error target ' + error.target);
+ console.log('upload error code' + error.code);
+ },
+ false,
+ {
+ headers: {
+ 'Authorization': 'Basic dGVzdHVzZXJuYW1lOnRlc3RwYXNzd29yZA=='
+ }
+ }
+ );
+ </pre>
+</div>
+<div class="output">
+<span class="title"><p>Output example:</p></span><pre>download complete: file:///home/owner/apps_rw/Gk6hf8hjk/tmp/file.txt
+</pre>
+</div>
+</dd>
+<dt class="method" id="FileTransfer::abort">
+<a class="backward-compatibility-anchor" name="::FileTransfer::FileTransfer::abort"></a><code><b><span class="methodName">abort</span></b></code>
+</dt>
+<dd>
+<div class="brief">
+ Aborts an in-progress transfer. The onerror callback is passed a FileTransferError object which has an error code of FileTransferError.ABORT_ERR.
+ </div>
+<div class="synopsis"><pre class="signature prettyprint">void abort();
+ </pre></div>
+<p><span class="version">
+ Since: </span>
+ 3.0
+ </p>
+<p><span class="privilegelevel">
+ Privilege level: </span>
+ public
+ </p>
+<p><span class="privilege">
+ Privilege: </span>
+ http://tizen.org/privilege/internet
+ </p>
+<div class="example">
+<span class="example"><p>Code example:</p></span><pre name="code" class="examplecode prettyprint"> var fileURL; // should be a valid url eg. cdvfile://localhost/persistent/path/to/file.txt
+
+ var win = function(r) {
+ console.log('Should not be called.');
+ }
+
+ var fail = function(error) {
+ // error.code == FileTransferError.ABORT_ERR
+ alert('An error has occurred: Code = ' + error.code);
+ console.log('upload error source ' + error.source);
+ console.log('upload error target ' + error.target);
+ };
+
+ var ft = new FileTransfer();
+ ft.upload(fileURL, encodeURI('http://some.server.com/upload.php'), win, fail);
+ ft.abort();
+ </pre>
+</div>
+<div class="output">
+<span class="title"><p>Output example:</p></span><pre>An error has occured: Code = 4
+upload error source file:///home/owner/apps_rw/Gk6hf8hjk/tmp/file.txt
+upload error target http://some.server.com/file.txt
+</pre>
+</div>
+</dd>
+</dl>
+</div>
+</div>
+<div class="interface" id="FileUploadSuccessCallback">
+<a class="backward-compatibility-anchor" name="::FileTransfer::FileUploadSuccessCallback"></a><h3>2.5. FileUploadSuccessCallback</h3>
+<div class="brief">
+ The interface that defines a callback function which is called when an upload is successfully finished.
+ </div>
+<pre class="webidl prettyprint"> [Callback=FunctionOnly, NoInterfaceObject] interface FileUploadSuccessCallback {
+ void onsuccess(<a href="#FileUploadResult">FileUploadResult</a> result);
+ };</pre>
+<p><span class="version">
+ Since: </span>
+ 3.0
+ </p>
+<div class="methods">
+<h4>Methods</h4>
+<dl>
+<dt class="method" id="FileUploadSuccessCallback::onsuccess">
+<a class="backward-compatibility-anchor" name="::FileTransfer::FileUploadSuccessCallback::onsuccess"></a><code><b><span class="methodName">onsuccess</span></b></code>
+</dt>
+<dd>
+<div class="brief">
+ Called when upload is successfully finished.
+ </div>
+<div class="synopsis"><pre class="signature prettyprint">void onsuccess(<a href="#FileUploadResult">FileUploadResult</a> result);
+ </pre></div>
+<p><span class="version">
+ Since: </span>
+ 3.0
+ </p>
+<p><span class="remark"> Remark : </span>
+ See the <a href="#FileTransfer::upload">example</a> </p>
+<div class="parameters">
+<p><span class="param">Parameters:</span></p>
+<ul>
+ <li class="param">
+<span class="name">result</span>:
+ A result object that defines an upload result.
+ </li>
+ </ul>
+</div>
+</dd>
+</dl>
+</div>
+</div>
+<div class="interface" id="FileDownloadSuccessCallback">
+<a class="backward-compatibility-anchor" name="::FileTransfer::FileDownloadSuccessCallback"></a><h3>2.6. FileDownloadSuccessCallback</h3>
+<div class="brief">
+ The interface that defines a callback function which is called when download is successfully finished.
+ </div>
+<pre class="webidl prettyprint"> [Callback=FunctionOnly, NoInterfaceObject] interface FileDownloadSuccessCallback {
+ void onsuccess(<a href="file.html#FileEntry">FileEntry</a> file);
+ };</pre>
+<div class="methods">
+<h4>Methods</h4>
+<dl>
+<dt class="method" id="FileDownloadSuccessCallback::onsuccess">
+<a class="backward-compatibility-anchor" name="::FileTransfer::FileDownloadSuccessCallback::onsuccess"></a><code><b><span class="methodName">onsuccess</span></b></code>
+</dt>
+<dd>
+<div class="brief">
+ Called when download is successfully finished.
+ </div>
+<div class="synopsis"><pre class="signature prettyprint">void onsuccess(<a href="file.html#FileEntry">FileEntry</a> file);
+ </pre></div>
+<p><span class="version">
+ Since: </span>
+ 3.0
+ </p>
+<p><span class="remark"> Remark : </span>
+ See the <a href="#FileTransfer::download">example</a> </p>
+<div class="parameters">
+<p><span class="param">Parameters:</span></p>
+<ul>
+ <li class="param">
+<span class="name">file</span>:
+ An object that defines a downloaded file.
+ </li>
+ </ul>
+</div>
+</dd>
+</dl>
+</div>
+</div>
+<div class="interface" id="FileTransferErrorCallback">
+<a class="backward-compatibility-anchor" name="::FileTransfer::FileTransferErrorCallback"></a><h3>2.7. FileTransferErrorCallback</h3>
+<div class="brief">
+ The interface that defines an error callback function which is called when an error occur.
+ </div>
+<pre class="webidl prettyprint"> [Callback=FunctionOnly, NoInterfaceObject] interface FileTransferErrorCallback {
+ void onerror(<a href="#FileTransferError">FileTransferError</a> error);
+ };</pre>
+<div class="methods">
+<h4>Methods</h4>
+<dl>
+<dt class="method" id="FileTransferErrorCallback::onerror">
+<a class="backward-compatibility-anchor" name="::FileTransfer::FileTransferErrorCallback::onerror"></a><code><b><span class="methodName">onerror</span></b></code>
+</dt>
+<dd>
+<div class="brief">
+ Called when file transfer is finished with an error
+ </div>
+<div class="synopsis"><pre class="signature prettyprint">void onerror(<a href="#FileTransferError">FileTransferError</a> error);
+ </pre></div>
+<p><span class="version">
+ Since: </span>
+ 3.0
+ </p>
+<p><span class="remark"> Remark : </span>
+ See the <a href="#FileTransfer::download">example</a> </p>
+<div class="parameters">
+<p><span class="param">Parameters:</span></p>
+<ul>
+ <li class="param">
+<span class="name">error</span>:
+ An object that defines details of the error
+ </li>
+ </ul>
+</div>
+</dd>
+</dl>
+</div>
+</div>
+</div>
+<h2 id="full-webidl">3. Full WebIDL</h2>
+<pre class="webidl prettyprint">module FileTransfer {
+ typedef object FileUploadParams;
+
+ typedef object HeaderFields;
+
+ typedef object FileDownloadOptions;
+
+ [Constructor(DOMString fileKey, DOMString fileName, DOMString mimeType, <a href="#FileUploadParams">FileUploadParams</a> params, <a href="#HeaderFields">HeaderFields</a> headers, DOMString httpMethod)]
+ interface FileUploadOptions {
+ attribute DOMString fileKey;
+ attribute DOMString fileName;
+ attribute DOMString httpMethod;
+ attribute DOMString mimeType;
+ attribute <a href="#FileUploadParams">FileUploadParams</a> params;
+ attribute boolean chunkedMode;
+ attribute <a href="#HeaderFields">HeaderFields</a> headers;
+ };
+
+ [NoInterfaceObject] interface FileUploadResult {
+ attribute long bytesSent;
+ attribute long responseCode;
+ attribute DOMString response;
+ attribute <a href="#HeaderFields">HeaderFields</a> headers;
+ };
+
+ interface FileTransferError {
+ attribute short code;
+ attribute DOMString source;
+ attribute DOMString target;
+ attribute long http_status;
+ attribute DOMString body;
+ attribute DOMString exception;
+ const short FILE_NOT_FOUND_ERR = 1;
+ const short INVALID_URL_ERR = 2;
+ const short CONNECTION_ERR = 3;
+ const short ABORT_ERR = 4;
+ const short NOT_MODIFIED_ERR = 5;
+ };
+
+ [Constructor()]
+ interface FileTransfer {
+ [TreatNonCallableAsNull] attribute <a href="file.html#ProgressCallback">ProgressCallback</a>? onprogress;
+
+ void upload(DOMString fileURL, DOMString server, optional <a href="#FileUploadSuccessCallback">FileUploadSuccessCallback</a>? successCallback, optional <a href="#FileTransferErrorCallback">FileTransferErrorCallback</a>? errorCallback, optional <a href="#FileUploadOptions">FileUploadOptions</a>? options, optional boolean? trustAllHosts);
+
+ void download(DOMString source, DOMString target, optional <a href="#FileDownloadSuccessCallback">FileDownloadSuccessCallback</a>? successCallback, optional <a href="#FileTransferErrorCallback">FileTransferErrorCallback</a>? errorCallback, optional boolean? trustAllHosts, optional <a href="#FileDownloadOptions">FileDownloadOptions</a>? options);
+
+ void abort();
+ };
+
+ [Callback=FunctionOnly, NoInterfaceObject] interface FileUploadSuccessCallback {
+ void onsuccess(<a href="#FileUploadResult">FileUploadResult</a> result);
+ };
+
+ [Callback=FunctionOnly, NoInterfaceObject] interface FileDownloadSuccessCallback {
+ void onsuccess(<a href="file.html#FileEntry">FileEntry</a> file);
+ };
+
+ [Callback=FunctionOnly, NoInterfaceObject] interface FileTransferErrorCallback {
+ void onerror(<a href="#FileTransferError">FileTransferError</a> error);
+ };
+};</pre>
+</div>
+<div id="page-footer">
+<div class="copyright" align="center">
+ Except as noted, this content - excluding the Code Examples - is licensed under <a href="http://creativecommons.org/licenses/by/3.0/legalcode" target="_blank">Creative Commons Attribution 3.0</a> and all of the Code Examples contained herein are licensed under <a href="https://www.tizen.org/bsd-3-clause-license" target="_blank">BSD-3-Clause</a>. <br>For details, see the <a href="https://www.tizen.org/content-license" target="_blank">Content License</a>.
+ </div>
+<script type="text/javascript">
+
+ var _gaq = _gaq || [];
+ _gaq.push(['_setAccount', 'UA-25976949-1']);
+ _gaq.push(['_setDomainName', 'tizen.org']);
+ _gaq.push(['_trackPageview']);
+
+ (function() {
+ var ga = document.createElement('script'); ga.type = 'text/javascript'; ga.async = true;
+ var s = document.getElementsByTagName('script')[0]; s.parentNode.insertBefore(ga, s);
+ })();
+
+ </script>
+</div>
+</body>
+</html>
--- /dev/null
+<!DOCTYPE html PUBLIC "html">
+<html>
+<head>
+<meta http-equiv="Content-Type" content="text/html; charset=utf-8">
+<link rel="stylesheet" type="text/css" href="../tizen.css" media="screen">
+<script type="text/javascript" src="snippet.js"></script><title>Globalization API</title>
+</head>
+<body id="page-content" onload="prettyPrint()">
+<div class="api" id="::Globalization">
+<div class="supported-platforms"><img class="mobile-mandatory emulator" title="Mandatory, Supported by Tizen Mobile emulator" src="../mobile_s_w.png"></div>
+<div class="title"><h1>Globalization API</h1></div>
+<div class="brief">
+ This plugin obtains information and performs operations specific to the user's locale,
+language, and timezone. Note the difference between locale and language: locale controls how numbers,
+dates, and times are displayed for a region, while language determines what language text appears as,
+independently of locale settings. Often developers use locale to set both settings, but there is no reason
+a user couldn't set her language to "English" but locale to "French", so that text is displayed in English
+but dates, times, etc., are displayed as they are in France. Unfortunately, most mobile platforms
+currently do not make a distinction between these settings.
+ </div>
+<div class="description">
+ <p>
+Original documentation: <a href="https://www.npmjs.com/package/cordova-plugin-globalization">Cordova Globalization</a> </p>
+ </div>
+<p><span class="version">
+ Since: </span>
+ 3.0
+ </p>
+<h2>Table of Contents</h2>
+<ul class="toc">
+<li>1. <a href="#interfaces-section">Interfaces</a><ul class="toc">
+<li>1.1. <a href="#GlobalizationManager">GlobalizationManager</a>
+</li>
+<li>1.2. <a href="#DateOptions">DateOptions</a>
+</li>
+<li>1.3. <a href="#CurrencyPattern">CurrencyPattern</a>
+</li>
+<li>1.4. <a href="#GetDateNamesOptions">GetDateNamesOptions</a>
+</li>
+<li>1.5. <a href="#NumberPatternOptions">NumberPatternOptions</a>
+</li>
+<li>1.6. <a href="#DatePattern">DatePattern</a>
+</li>
+<li>1.7. <a href="#NumberPattern">NumberPattern</a>
+</li>
+<li>1.8. <a href="#GlobalizationDate">GlobalizationDate</a>
+</li>
+<li>1.9. <a href="#DSTSuccessCallback">DSTSuccessCallback</a>
+</li>
+<li>1.10. <a href="#StringSuccessCallback">StringSuccessCallback</a>
+</li>
+<li>1.11. <a href="#ArrayStringSuccessCallback">ArrayStringSuccessCallback</a>
+</li>
+<li>1.12. <a href="#LongSuccessCallback">LongSuccessCallback</a>
+</li>
+<li>1.13. <a href="#DoubleSuccessCallback">DoubleSuccessCallback</a>
+</li>
+<li>1.14. <a href="#GlobalizationDateSuccessCallback">GlobalizationDateSuccessCallback</a>
+</li>
+<li>1.15. <a href="#PatternSuccessCallback">PatternSuccessCallback</a>
+</li>
+<li>1.16. <a href="#GetDatePatternSuccessCallback">GetDatePatternSuccessCallback</a>
+</li>
+<li>1.17. <a href="#GetNumberPatternSuccessCallback">GetNumberPatternSuccessCallback</a>
+</li>
+<li>1.18. <a href="#GlobalizationError">GlobalizationError</a>
+</li>
+</ul>
+</li>
+<li>2. <a href="#full-webidl">Full WebIDL</a>
+</li>
+</ul>
+<hr>
+<h2 id="method-summary">Summary of Interfaces and Methods</h2>
+<table class="informaltable">
+<thead><tr>
+<th>Interface</th>
+<th>Method</th>
+</tr></thead>
+<tbody>
+<tr>
+<td><a href="#GlobalizationManager">GlobalizationManager</a></td>
+<td>
+<div>void <a href="#GlobalizationManager::getPreferredLanguage">getPreferredLanguage</a> (<a href="#StringSuccessCallback">StringSuccessCallback</a> onsuccess, <a href="cordova.html#ErrorCallback">ErrorCallback</a><a href="file.html#ErrorCallback">ErrorCallback</a> onerror)</div>
+<div>void <a href="#GlobalizationManager::getLocaleName">getLocaleName</a> (<a href="#StringSuccessCallback">StringSuccessCallback</a> onsuccess, <a href="cordova.html#ErrorCallback">ErrorCallback</a><a href="file.html#ErrorCallback">ErrorCallback</a> onerror)</div>
+<div>void <a href="#GlobalizationManager::dateToString">dateToString</a> (Date date, <a href="#StringSuccessCallback">StringSuccessCallback</a> onsuccess, <a href="cordova.html#ErrorCallback">ErrorCallback</a><a href="file.html#ErrorCallback">ErrorCallback</a> onerror, optional <a href="#DateOptions">DateOptions</a> options)</div>
+<div>void <a href="#GlobalizationManager::getCurrencyPattern">getCurrencyPattern</a> (DOMString currencyCode, <a href="#PatternSuccessCallback">PatternSuccessCallback</a> onsuccess, <a href="cordova.html#ErrorCallback">ErrorCallback</a><a href="file.html#ErrorCallback">ErrorCallback</a> onerror)</div>
+<div>void <a href="#GlobalizationManager::getDateNames">getDateNames</a> (<a href="#ArrayStringSuccessCallback">ArrayStringSuccessCallback</a> onsuccess, <a href="cordova.html#ErrorCallback">ErrorCallback</a><a href="file.html#ErrorCallback">ErrorCallback</a> onerror, optional <a href="#GetDateNamesOptions">GetDateNamesOptions</a> options)</div>
+<div>void <a href="#GlobalizationManager::getDatePattern">getDatePattern</a> (<a href="#GetDatePatternSuccessCallback">GetDatePatternSuccessCallback</a> onsuccess, <a href="cordova.html#ErrorCallback">ErrorCallback</a><a href="file.html#ErrorCallback">ErrorCallback</a> onerror, optional <a href="#DateOptions">DateOptions</a> options)</div>
+<div>void <a href="#GlobalizationManager::getFirstDayOfWeek">getFirstDayOfWeek</a> (<a href="#LongSuccessCallback">LongSuccessCallback</a> onsuccess, <a href="cordova.html#ErrorCallback">ErrorCallback</a><a href="file.html#ErrorCallback">ErrorCallback</a> onerror)</div>
+<div>void <a href="#GlobalizationManager::getNumberPattern">getNumberPattern</a> (<a href="#GetNumberPatternSuccessCallback">GetNumberPatternSuccessCallback</a> onsuccess, <a href="cordova.html#ErrorCallback">ErrorCallback</a><a href="file.html#ErrorCallback">ErrorCallback</a> onerror, optional <a href="#NumberPatternOptions">NumberPatternOptions</a> options)</div>
+<div>void <a href="#GlobalizationManager::isDayLightSavingsTime">isDayLightSavingsTime</a> (Date date, <a href="#DSTSuccessCallback">DSTSuccessCallback</a> onsuccess, <a href="cordova.html#ErrorCallback">ErrorCallback</a><a href="file.html#ErrorCallback">ErrorCallback</a> onerror)</div>
+<div>void <a href="#GlobalizationManager::numberToString">numberToString</a> (double number, <a href="#StringSuccessCallback">StringSuccessCallback</a> onsuccess, <a href="cordova.html#ErrorCallback">ErrorCallback</a><a href="file.html#ErrorCallback">ErrorCallback</a> onerror, optional <a href="#NumberPatternOptions">NumberPatternOptions</a> options)</div>
+<div>void <a href="#GlobalizationManager::stringToDate">stringToDate</a> (DOMString dateString, <a href="#GlobalizationDateSuccessCallback">GlobalizationDateSuccessCallback</a> onsuccess, <a href="cordova.html#ErrorCallback">ErrorCallback</a><a href="file.html#ErrorCallback">ErrorCallback</a> onerror, optional <a href="#DateOptions">DateOptions</a> options)</div>
+<div>void <a href="#GlobalizationManager::stringToNumber">stringToNumber</a> (DOMString numberString, <a href="#DoubleSuccessCallback">DoubleSuccessCallback</a> onsuccess, <a href="cordova.html#ErrorCallback">ErrorCallback</a><a href="file.html#ErrorCallback">ErrorCallback</a> onerror, optional <a href="#NumberPatternOptions">NumberPatternOptions</a> options)</div>
+</td>
+</tr>
+<tr>
+<td><a href="#DateOptions">DateOptions</a></td>
+<td></td>
+</tr>
+<tr>
+<td><a href="#CurrencyPattern">CurrencyPattern</a></td>
+<td></td>
+</tr>
+<tr>
+<td><a href="#GetDateNamesOptions">GetDateNamesOptions</a></td>
+<td></td>
+</tr>
+<tr>
+<td><a href="#NumberPatternOptions">NumberPatternOptions</a></td>
+<td></td>
+</tr>
+<tr>
+<td><a href="#DatePattern">DatePattern</a></td>
+<td></td>
+</tr>
+<tr>
+<td><a href="#NumberPattern">NumberPattern</a></td>
+<td></td>
+</tr>
+<tr>
+<td><a href="#GlobalizationDate">GlobalizationDate</a></td>
+<td></td>
+</tr>
+<tr>
+<td><a href="#DSTSuccessCallback">DSTSuccessCallback</a></td>
+<td><div>void <a href="#DSTSuccessCallback::onsuccess">onsuccess</a> (object properties)</div></td>
+</tr>
+<tr>
+<td><a href="#StringSuccessCallback">StringSuccessCallback</a></td>
+<td><div>void <a href="#StringSuccessCallback::onsuccess">onsuccess</a> (object properties)</div></td>
+</tr>
+<tr>
+<td><a href="#ArrayStringSuccessCallback">ArrayStringSuccessCallback</a></td>
+<td><div>void <a href="#ArrayStringSuccessCallback::onsuccess">onsuccess</a> (object properties)</div></td>
+</tr>
+<tr>
+<td><a href="#LongSuccessCallback">LongSuccessCallback</a></td>
+<td><div>void <a href="#LongSuccessCallback::onsuccess">onsuccess</a> (object properties)</div></td>
+</tr>
+<tr>
+<td><a href="#DoubleSuccessCallback">DoubleSuccessCallback</a></td>
+<td><div>void <a href="#DoubleSuccessCallback::onsuccess">onsuccess</a> (object properties)</div></td>
+</tr>
+<tr>
+<td><a href="#GlobalizationDateSuccessCallback">GlobalizationDateSuccessCallback</a></td>
+<td><div>void <a href="#GlobalizationDateSuccessCallback::onsuccess">onsuccess</a> (Date date)</div></td>
+</tr>
+<tr>
+<td><a href="#PatternSuccessCallback">PatternSuccessCallback</a></td>
+<td><div>void <a href="#PatternSuccessCallback::onsuccess">onsuccess</a> (<a href="#CurrencyPattern">CurrencyPattern</a> pattern)</div></td>
+</tr>
+<tr>
+<td><a href="#GetDatePatternSuccessCallback">GetDatePatternSuccessCallback</a></td>
+<td><div>void <a href="#GetDatePatternSuccessCallback::onsuccess">onsuccess</a> (<a href="#DatePattern">DatePattern</a> pattern)</div></td>
+</tr>
+<tr>
+<td><a href="#GetNumberPatternSuccessCallback">GetNumberPatternSuccessCallback</a></td>
+<td><div>void <a href="#GetNumberPatternSuccessCallback::onsuccess">onsuccess</a> (<a href="#NumberPattern">NumberPattern</a> pattern)</div></td>
+</tr>
+<tr>
+<td><a href="#GlobalizationError">GlobalizationError</a></td>
+<td></td>
+</tr>
+</tbody>
+</table>
+<div class="interfaces" id="interfaces-section">
+<h2>1. Interfaces</h2>
+<div class="interface" id="GlobalizationManager">
+<a class="backward-compatibility-anchor" name="::Globalization::GlobalizationManager"></a><h3>1.2. GlobalizationManager</h3>
+<div class="brief">
+ the GlobalizationManager interface embodies Globalization module methods.
+ </div>
+<pre class="webidl prettyprint"> [NoInterfaceObject] interface GlobalizationManager {
+
+ void getPreferredLanguage(<a href="#StringSuccessCallback">StringSuccessCallback</a> onsuccess,
+ <a href="cordova.html#ErrorCallback">ErrorCallback</a><a href="file.html#ErrorCallback">ErrorCallback</a> onerror);
+
+ void getLocaleName(<a href="#StringSuccessCallback">StringSuccessCallback</a> onsuccess,
+ <a href="cordova.html#ErrorCallback">ErrorCallback</a><a href="file.html#ErrorCallback">ErrorCallback</a> onerror);
+
+ void dateToString(Date date, <a href="#StringSuccessCallback">StringSuccessCallback</a> onsuccess, <a href="cordova.html#ErrorCallback">ErrorCallback</a><a href="file.html#ErrorCallback">ErrorCallback</a> onerror,
+ optional <a href="#DateOptions">DateOptions</a> options);
+
+ void getCurrencyPattern(DOMString currencyCode,
+ <a href="#PatternSuccessCallback">PatternSuccessCallback</a> onsuccess,
+ <a href="cordova.html#ErrorCallback">ErrorCallback</a><a href="file.html#ErrorCallback">ErrorCallback</a> onerror);
+
+ void getDateNames(<a href="#ArrayStringSuccessCallback">ArrayStringSuccessCallback</a> onsuccess, <a href="cordova.html#ErrorCallback">ErrorCallback</a><a href="file.html#ErrorCallback">ErrorCallback</a> onerror,
+ optional <a href="#GetDateNamesOptions">GetDateNamesOptions</a> options);
+
+ void getDatePattern(<a href="#GetDatePatternSuccessCallback">GetDatePatternSuccessCallback</a> onsuccess, <a href="cordova.html#ErrorCallback">ErrorCallback</a><a href="file.html#ErrorCallback">ErrorCallback</a> onerror,
+ optional <a href="#DateOptions">DateOptions</a> options);
+
+ void getFirstDayOfWeek(<a href="#LongSuccessCallback">LongSuccessCallback</a> onsuccess,
+ <a href="cordova.html#ErrorCallback">ErrorCallback</a><a href="file.html#ErrorCallback">ErrorCallback</a> onerror);
+
+ void getNumberPattern(<a href="#GetNumberPatternSuccessCallback">GetNumberPatternSuccessCallback</a> onsuccess,
+ <a href="cordova.html#ErrorCallback">ErrorCallback</a><a href="file.html#ErrorCallback">ErrorCallback</a> onerror,
+ optional <a href="#NumberPatternOptions">NumberPatternOptions</a> options);
+
+ void isDayLightSavingsTime(Date date, <a href="#DSTSuccessCallback">DSTSuccessCallback</a> onsuccess,
+ <a href="cordova.html#ErrorCallback">ErrorCallback</a><a href="file.html#ErrorCallback">ErrorCallback</a> onerror);
+
+ void numberToString(double number, <a href="#StringSuccessCallback">StringSuccessCallback</a> onsuccess, <a href="cordova.html#ErrorCallback">ErrorCallback</a><a href="file.html#ErrorCallback">ErrorCallback</a> onerror,
+ optional <a href="#NumberPatternOptions">NumberPatternOptions</a> options);
+
+ void stringToDate(DOMString dateString, <a href="#GlobalizationDateSuccessCallback">GlobalizationDateSuccessCallback</a> onsuccess,
+ <a href="cordova.html#ErrorCallback">ErrorCallback</a><a href="file.html#ErrorCallback">ErrorCallback</a> onerror,
+ optional <a href="#DateOptions">DateOptions</a> options);
+ void stringToNumber(DOMString numberString, <a href="#DoubleSuccessCallback">DoubleSuccessCallback</a> onsuccess,
+ <a href="cordova.html#ErrorCallback">ErrorCallback</a><a href="file.html#ErrorCallback">ErrorCallback</a> onerror,
+ optional <a href="#NumberPatternOptions">NumberPatternOptions</a> options);
+ };</pre>
+<p><span class="version">
+ Since: </span>
+ 3.0
+ </p>
+<div class="methods">
+<h4>Methods</h4>
+<dl>
+<dt class="method" id="GlobalizationManager::getPreferredLanguage">
+<a class="backward-compatibility-anchor" name="::Globalization::GlobalizationManager::getPreferredLanguage"></a><code><b><span class="methodName">getPreferredLanguage</span></b></code>
+</dt>
+<dd>
+<div class="brief">
+ Gets the BCP 47 language tag for the client's current language.
+ </div>
+<div class="synopsis"><pre class="signature prettyprint">void getPreferredLanguage(<a href="#StringSuccessCallback">StringSuccessCallback</a> onsuccess, <a href="cordova.html#ErrorCallback">ErrorCallback</a><a href="file.html#ErrorCallback">ErrorCallback</a> onerror);
+ </pre></div>
+<p><span class="version">
+ Since: </span>
+ 3.0
+ </p>
+<div class="description">
+ <p>
+Returns the BCP-47 compliant language identifier tag to the successCallback
+with a properties object as a parameter. That object should have a value property
+with a String value.
+ </p>
+ </div>
+<div class="parameters">
+<p><span class="param">Parameters:</span></p>
+<ul>
+ <li class="param">
+<span class="name">onsuccess</span>:
+ The callback method to be invoked if the preferred language
+is obtained successfully.
+ </li>
+ <li class="param">
+<span class="name">onerror</span>:
+ The callback method called when errors occur
+during this method's execution.
+ </li>
+ </ul>
+</div>
+<div class="exceptionlist">
+<p><span class="except">Exceptions:</span></p>
+ <ul class="exception"><li>TypeError<ul><li class="list"><p>
+ if any of the input parameters contains an invalid value.
+ </p></li></ul>
+</li></ul>
+ </div>
+<div class="example">
+<span class="example"><p>Code example:</p></span><pre name="code" class="examplecode prettyprint"> // When the browser is set to the en-US language,
+ // this should output the text
+ // similar to the results that follow.
+
+ navigator.globalization.getPreferredLanguage(
+ function (language) { console.log('Language: ' + language.value); },
+ function () { console.log('Error getting language.'); }
+ );
+ </pre>
+</div>
+<div class="output">
+<span class="title"><p>Output example:</p></span><pre>Language: en-US
+</pre>
+</div>
+</dd>
+<dt class="method" id="GlobalizationManager::getLocaleName">
+<a class="backward-compatibility-anchor" name="::Globalization::GlobalizationManager::getLocaleName"></a><code><b><span class="methodName">getLocaleName</span></b></code>
+</dt>
+<dd>
+<div class="brief">
+ Returns the BCP 47 compliant tag for the client's current locale settings.
+ </div>
+<div class="synopsis"><pre class="signature prettyprint">void getLocaleName(<a href="#StringSuccessCallback">StringSuccessCallback</a> onsuccess, <a href="cordova.html#ErrorCallback">ErrorCallback</a><a href="file.html#ErrorCallback">ErrorCallback</a> onerror);
+ </pre></div>
+<p><span class="version">
+ Since: </span>
+ 3.0
+ </p>
+<div class="description">
+ <p>
+Returns the BCP 47 compliant locale identifier string to the successCallback
+with a properties object as a parameter. That object should have a value
+property with a String value. The locale tag will consist of a two-letter
+lower case language code, two-letter upper case country code, and (unspecified)
+variant code, separated by a hyphen.
+ </p>
+ </div>
+<div class="parameters">
+<p><span class="param">Parameters:</span></p>
+<ul>
+ <li class="param">
+<span class="name">onsuccess</span>:
+ The callback function called when the locale name
+has been obtained successfully.
+ </li>
+ <li class="param">
+<span class="name">onerror</span>:
+ The callback method invoked in case of errors
+occuring while getting a locale name.
+ </li>
+ </ul>
+</div>
+<div class="exceptionlist">
+<p><span class="except">Exceptions:</span></p>
+ <ul class="exception"><li>TypeError<ul><li class="list"><p>
+ if any of the input parameters contains an invalid value.
+ </p></li></ul>
+</li></ul>
+ </div>
+<div class="example">
+<span class="example"><p>Code example:</p></span><pre name="code" class="examplecode prettyprint"> // When the browser is set to the en-US language,
+ // this should output the text
+ // similar to the results that follow.
+
+ navigator.globalization.getLocaleName(
+ function (locale) { console.log('Locale: ' + locale.value); },
+ function () { console.log('Error getting locale.'); }
+ );
+ </pre>
+</div>
+<div class="output">
+<span class="title"><p>Output example:</p></span><pre>Locale: en-US
+</pre>
+</div>
+</dd>
+<dt class="method" id="GlobalizationManager::dateToString">
+<a class="backward-compatibility-anchor" name="::Globalization::GlobalizationManager::dateToString"></a><code><b><span class="methodName">dateToString</span></b></code>
+</dt>
+<dd>
+<div class="brief">
+ Returns a date formatted as a string according to the client's locale and timezone.
+ </div>
+<div class="synopsis"><pre class="signature prettyprint">void dateToString(Date date, <a href="#StringSuccessCallback">StringSuccessCallback</a> onsuccess, <a href="cordova.html#ErrorCallback">ErrorCallback</a><a href="file.html#ErrorCallback">ErrorCallback</a> onerror, optional <a href="#DateOptions">DateOptions</a> options);
+ </pre></div>
+<p><span class="version">
+ Since: </span>
+ 3.0
+ </p>
+<div class="description">
+ <p>
+Returns the date formatted as a String via a value property accessible from the object
+passed as a parameter to the successCallback.
+ </p>
+ </div>
+<div class="parameters">
+<p><span class="param">Parameters:</span></p>
+<ul>
+ <li class="param">
+<span class="name">date</span>:
+ The date to be converted to a DOMString. It should be of type Date.
+ </li>
+ <li class="param">
+<span class="name">onsuccess</span>:
+ The callback method called after a successful conversion.
+ </li>
+ <li class="param">
+<span class="name">onerror</span>:
+ The callback method called if errors occur during conversion.
+ </li>
+ <li class="param">
+<span class="name">options</span><span class="optional"> [optional]</span>:
+ Optional parameter defining conversion options. The default values are:
+<var>{formatLength : 'short', selector : 'date and time'}</var>.
+ </li>
+ </ul>
+</div>
+<div class="exceptionlist">
+<p><span class="except">Exceptions:</span></p>
+ <ul class="exception"><li>TypeError<ul><li class="list"><p>
+ if any of the input parameters contains an invalid value.
+ </p></li></ul>
+</li></ul>
+ </div>
+<div class="example">
+<span class="example"><p>Code example:</p></span><pre name="code" class="examplecode prettyprint"> // When the browser is set to the en-US language,
+ // this should output text similar to the results that follow.
+ // This example uses the default conversion options.
+
+ navigator.globalization.dateToString(
+ new Date(),
+ function (date) { console.log('Date: ' + date.value); },
+ function () { console.log('Error getting dateString.'); },
+ { formatLength: 'short', selector: 'date and time' }
+ );
+ </pre>
+</div>
+<div class="output">
+<span class="title"><p>Output example:</p></span><pre>Date: 9/25/2012 4:21PM
+</pre>
+</div>
+</dd>
+<dt class="method" id="GlobalizationManager::getCurrencyPattern">
+<a class="backward-compatibility-anchor" name="::Globalization::GlobalizationManager::getCurrencyPattern"></a><code><b><span class="methodName">getCurrencyPattern</span></b></code>
+</dt>
+<dd>
+<div class="brief">
+ Returns a pattern string to format and parse currency values according to
+the client's user preferences and ISO 4217 currency code.
+ </div>
+<div class="synopsis"><pre class="signature prettyprint">void getCurrencyPattern(DOMString currencyCode, <a href="#PatternSuccessCallback">PatternSuccessCallback</a> onsuccess, <a href="cordova.html#ErrorCallback">ErrorCallback</a><a href="file.html#ErrorCallback">ErrorCallback</a> onerror);
+ </pre></div>
+<p><span class="version">
+ Since: </span>
+ 3.0
+ </p>
+<div class="description">
+ <p>
+The pattern information is returned in the onsuccess callback with pattern object
+as a parameter.
+ </p>
+ </div>
+<div class="parameters">
+<p><span class="param">Parameters:</span></p>
+<ul>
+ <li class="param">
+<span class="name">currencyCode</span>:
+ ISO 4217 compliant currency code provided as a DOMString,
+for example 'USD'.
+ </li>
+ <li class="param">
+<span class="name">onsuccess</span>:
+ The callback method invoked after a successful conversion.
+ </li>
+ <li class="param">
+<span class="name">onerror</span>:
+ The callback method called if errors occur during the conversion.
+ </li>
+ </ul>
+</div>
+<div class="exceptionlist">
+<p><span class="except">Exceptions:</span></p>
+ <ul class="exception"><li>TypeError<ul><li class="list"><p>
+ if any of the input parameters contains an invalid value.
+ </p></li></ul>
+</li></ul>
+ </div>
+<div class="example">
+<span class="example"><p>Code example:</p></span><pre name="code" class="examplecode prettyprint"> // When the browser is set to the en-US locale and the selected
+ // currency is United States Dollars, this example outputs
+ // text similar to the results that follow.
+
+ navigator.globalization.getCurrencyPattern(
+ 'USD',
+ function (pattern) {
+ console.log('pattern: ' + pattern.pattern);
+ console.log('code: ' + pattern.code);
+ console.log('fraction: ' + pattern.fraction);
+ console.log('rounding: ' + pattern.rounding);
+ console.log('decimal: ' + pattern.decimal);
+ console.log('grouping: ' + pattern.grouping);
+ },
+ function () { console.log('Error getting pattern.'); }
+ );
+
+ </pre>
+</div>
+<div class="output">
+<span class="title"><p>Output example:</p></span><pre>pattern: $#,##0.##;($#,##0.##)
+code: USD
+fraction: 2
+rounding: 0
+decimal: .
+grouping: ,
+</pre>
+</div>
+</dd>
+<dt class="method" id="GlobalizationManager::getDateNames">
+<a class="backward-compatibility-anchor" name="::Globalization::GlobalizationManager::getDateNames"></a><code><b><span class="methodName">getDateNames</span></b></code>
+</dt>
+<dd>
+<div class="brief">
+ Returns an array of the names of the months or the days of the week,
+depending on the client's user preferences and calendar.
+ </div>
+<div class="synopsis"><pre class="signature prettyprint">void getDateNames(<a href="#ArrayStringSuccessCallback">ArrayStringSuccessCallback</a> onsuccess, <a href="cordova.html#ErrorCallback">ErrorCallback</a><a href="file.html#ErrorCallback">ErrorCallback</a> onerror, optional <a href="#GetDateNamesOptions">GetDateNamesOptions</a> options);
+ </pre></div>
+<p><span class="version">
+ Since: </span>
+ 3.0
+ </p>
+<div class="description">
+ <p>
+If this method executes successfully, it invokes the onsuccess callback
+with months' or days' names passed as an Array of DOMString values
+in a parameter. This array features names starting from either
+the first month in the year or the first day of the week
+depending on the option selected.
+ </p>
+ </div>
+<div class="parameters">
+<p><span class="param">Parameters:</span></p>
+<ul>
+ <li class="param">
+<span class="name">onsuccess</span>:
+ The function to be called if this method returns the names correctly.
+ </li>
+ <li class="param">
+<span class="name">onerror</span>:
+ The function to be called in case of error occuring.
+ </li>
+ <li class="param">
+<span class="name">options</span><span class="optional"> [optional]</span>:
+ An optional parameter specifying additional options.
+The default value is <var>{type: 'wide', item: 'months'}</var> </li>
+ </ul>
+</div>
+<div class="exceptionlist">
+<p><span class="except">Exceptions:</span></p>
+ <ul class="exception"><li>TypeError<ul><li class="list"><p>
+ if any of the input parameters contains an invalid value.
+ </p></li></ul>
+</li></ul>
+ </div>
+<div class="example">
+<span class="example"><p>Code example:</p></span><pre name="code" class="examplecode prettyprint"> // When the browser is set to the en_US locale,
+ // this example logs the names of months, as per locale settings,
+ // with text similar to the results that follow.
+
+ navigator.globalization.getDateNames(
+ function (names) {
+ for (var i = 0; i < names.value.length; i++) {
+ console.log('month: ' + names.value[i]);
+ }
+ },
+ function () { console.log('Error getting names.'); },
+ { type: 'wide', item: 'months' }
+ );
+ </pre>
+</div>
+<div class="output">
+<span class="title"><p>Output example:</p></span><pre>month: January
+month: February
+month: March
+month: April
+month: May
+month: June
+month: July
+month: August
+month: September
+month: October
+month: November
+month: December
+</pre>
+</div>
+</dd>
+<dt class="method" id="GlobalizationManager::getDatePattern">
+<a class="backward-compatibility-anchor" name="::Globalization::GlobalizationManager::getDatePattern"></a><code><b><span class="methodName">getDatePattern</span></b></code>
+</dt>
+<dd>
+<div class="brief">
+ Gets a pattern string to format and parse dates according to the client's
+user preferences.
+ </div>
+<div class="synopsis"><pre class="signature prettyprint">void getDatePattern(<a href="#GetDatePatternSuccessCallback">GetDatePatternSuccessCallback</a> onsuccess, <a href="cordova.html#ErrorCallback">ErrorCallback</a><a href="file.html#ErrorCallback">ErrorCallback</a> onerror, optional <a href="#DateOptions">DateOptions</a> options);
+ </pre></div>
+<p><span class="version">
+ Since: </span>
+ 3.0
+ </p>
+<div class="description">
+ <p>
+If this method executes successfully, the onsuccess callback is invoked
+with a DatePattern object passed as a parameter.
+ </p>
+ </div>
+<div class="parameters">
+<p><span class="param">Parameters:</span></p>
+<ul>
+ <li class="param">
+<span class="name">onsuccess</span>:
+ The method to be invoked when this function executes successfully.
+ </li>
+ <li class="param">
+<span class="name">onerror</span>:
+ The function to be invoked in case of errors occuring.
+ </li>
+ <li class="param">
+<span class="name">options</span><span class="optional"> [optional]</span>:
+ The DateOptions object containing additional options.
+The default value is <var>{formatLength: 'short', selector: 'date and time'}</var>.
+ </li>
+ </ul>
+</div>
+<div class="exceptionlist">
+<p><span class="except">Exceptions:</span></p>
+ <ul class="exception"><li>TypeError<ul><li class="list"><p>
+ if any of the input parameters contains an invalid value.
+ </p></li></ul>
+</li></ul>
+ </div>
+<div class="example">
+<span class="example"><p>Code example:</p></span><pre name="code" class="examplecode prettyprint"> // This example displays the locale date pattern.
+ // When the browser is set to the en_US locale,
+ // the text displayed is similar to the results that follow.
+
+ function checkDatePattern () {
+ navigator.globalization.getDatePattern(
+ function (date) { console.log('Date pattern: ' + date.pattern); },
+ function () { console.log('Error getting pattern'); },
+ { formatLength: 'short', selector: 'date and time' }
+ );
+ }
+
+ checkDatePattern();
+ </pre>
+</div>
+<div class="output">
+<span class="title"><p>Output example:</p></span><pre>Date pattern: M/d/yyyy h:mm a
+</pre>
+</div>
+</dd>
+<dt class="method" id="GlobalizationManager::getFirstDayOfWeek">
+<a class="backward-compatibility-anchor" name="::Globalization::GlobalizationManager::getFirstDayOfWeek"></a><code><b><span class="methodName">getFirstDayOfWeek</span></b></code>
+</dt>
+<dd>
+<div class="brief">
+ Gets the first day of the week according to the client's
+user preferences and calendar.
+ </div>
+<div class="synopsis"><pre class="signature prettyprint">void getFirstDayOfWeek(<a href="#LongSuccessCallback">LongSuccessCallback</a> onsuccess, <a href="cordova.html#ErrorCallback">ErrorCallback</a><a href="file.html#ErrorCallback">ErrorCallback</a> onerror);
+ </pre></div>
+<p><span class="version">
+ Since: </span>
+ 3.0
+ </p>
+<div class="description">
+ <p>
+The days of the week are numbered starting from 1, where 1 is assumed to be Sunday.
+If successful, it invokes onsuccess callback with a LongSuccessCallback object
+as a parameter. That object has a value property representing the number of
+the first day of a week.
+ </p>
+ </div>
+<div class="parameters">
+<p><span class="param">Parameters:</span></p>
+<ul>
+ <li class="param">
+<span class="name">onsuccess</span>:
+ The method to be called when this function executes successfully.
+ </li>
+ <li class="param">
+<span class="name">onerror</span>:
+ The method to be invoked in case of errors occuring.
+ </li>
+ </ul>
+</div>
+<div class="exceptionlist">
+<p><span class="except">Exceptions:</span></p>
+ <ul class="exception"><li>TypeError<ul><li class="list"><p>
+ if any of the input parameters contains an invalid value.
+ </p></li></ul>
+</li></ul>
+ </div>
+<div class="example">
+<span class="example"><p>Code example:</p></span><pre name="code" class="examplecode prettyprint"> // When the browser is set to the en_US locale,
+ // this outputs the text similar to "day: 1".
+
+ navigator.globalization.getFirstDayOfWeek(
+ function (day) { console.log('day: ' + day.value); },
+ function () { console.log('Error getting first day of week.'); }
+ );
+ </pre>
+</div>
+<div class="output">
+<span class="title"><p>Output example:</p></span><pre>day: 1
+</pre>
+</div>
+</dd>
+<dt class="method" id="GlobalizationManager::getNumberPattern">
+<a class="backward-compatibility-anchor" name="::Globalization::GlobalizationManager::getNumberPattern"></a><code><b><span class="methodName">getNumberPattern</span></b></code>
+</dt>
+<dd>
+<div class="brief">
+ Gets a pattern string to format and parse numbers
+according to the client's user preferences.
+ </div>
+<div class="synopsis"><pre class="signature prettyprint">void getNumberPattern(<a href="#GetNumberPatternSuccessCallback">GetNumberPatternSuccessCallback</a> onsuccess, <a href="cordova.html#ErrorCallback">ErrorCallback</a><a href="file.html#ErrorCallback">ErrorCallback</a> onerror, optional <a href="#NumberPatternOptions">NumberPatternOptions</a> options);
+ </pre></div>
+<p><span class="version">
+ Since: </span>
+ 3.0
+ </p>
+<div class="description">
+ <p>
+The obtained pattern is then passed to the onsuccess callback
+as a parameter.
+ </p>
+ </div>
+<div class="parameters">
+<p><span class="param">Parameters:</span></p>
+<ul>
+ <li class="param">
+<span class="name">onsuccess</span>:
+ The callback method to be invoked
+when this function executes successfully.
+ </li>
+ <li class="param">
+<span class="name">onerror</span>:
+ The callback method to be invoked
+in case of errors occuring during this method's execution.
+ </li>
+ <li class="param">
+<span class="name">options</span><span class="optional"> [optional]</span>:
+ Defines the type of numeric value for which
+the pattern will be returned.
+ </li>
+ </ul>
+</div>
+<div class="exceptionlist">
+<p><span class="except">Exceptions:</span></p>
+ <ul class="exception"><li>TypeError<ul><li class="list"><p>
+ if any of the input parameters contains an invalid value.
+ </p></li></ul>
+</li></ul>
+ </div>
+<div class="example">
+<span class="example"><p>Code example:</p></span><pre name="code" class="examplecode prettyprint"> // When the browser is set to the en_US locale,
+ // this example outputs the text
+ // similar to the results that follow.
+
+ navigator.globalization.getNumberPattern(
+ function (pattern) {
+ console.log('pattern: ' + pattern.pattern);
+ console.log('symbol: ' + pattern.symbol);
+ console.log('fraction: ' + pattern.fraction);
+ console.log('rounding: ' + pattern.rounding);
+ console.log('positive: ' + pattern.positive);
+ console.log('negative: ' + pattern.negative);
+ console.log('decimal: ' + pattern.decimal);
+ console.log('grouping: ' + pattern.grouping);
+ },
+ function() { console.log('An error occurred.'); },
+ { type: 'decimal' }
+ );
+
+ </pre>
+</div>
+<div class="output">
+<span class="title"><p>Output example:</p></span><pre>pattern: #,##0.###
+symbol: .
+fraction: 0
+rounding: 0
+positive:
+negative: -
+decimal: .
+grouping: ,
+</pre>
+</div>
+</dd>
+<dt class="method" id="GlobalizationManager::isDayLightSavingsTime">
+<a class="backward-compatibility-anchor" name="::Globalization::GlobalizationManager::isDayLightSavingsTime"></a><code><b><span class="methodName">isDayLightSavingsTime</span></b></code>
+</dt>
+<dd>
+<div class="brief">
+ Indicates whether or not daylight savings time is in effect
+for a given date using the client's time zone and calendar.
+ </div>
+<div class="synopsis"><pre class="signature prettyprint">void isDayLightSavingsTime(Date date, <a href="#DSTSuccessCallback">DSTSuccessCallback</a> onsuccess, <a href="cordova.html#ErrorCallback">ErrorCallback</a><a href="file.html#ErrorCallback">ErrorCallback</a> onerror);
+ </pre></div>
+<p><span class="version">
+ Since: </span>
+ 3.0
+ </p>
+<div class="description">
+ <p>
+If this function executes successfully, the onsuccess callback
+will be invoked with a dstStatus object as a parameter. That object
+would contain a dst property with a Boolean value. The true value
+indicates that the DST is in effect for the given date.
+ </p>
+ </div>
+<div class="parameters">
+<p><span class="param">Parameters:</span></p>
+<ul>
+ <li class="param">
+<span class="name">date</span>:
+ The Date object for which the daylight savings time status will be checked.
+ </li>
+ <li class="param">
+<span class="name">onsuccess</span>:
+ The callback method to be called when this function
+successfully completes its execution.
+ </li>
+ <li class="param">
+<span class="name">onerror</span>:
+ The callback method to be called in case of
+errors occuring during this method's execution.
+ </li>
+ </ul>
+</div>
+<div class="exceptionlist">
+<p><span class="except">Exceptions:</span></p>
+ <ul class="exception"><li>TypeError<ul><li class="list"><p>
+ if any of the input parameters contains an invalid value.
+ </p></li></ul>
+</li></ul>
+ </div>
+<div class="example">
+<span class="example"><p>Code example:</p></span><pre name="code" class="examplecode prettyprint"> // During the summer, and if the browser
+ // is set to a DST-enabled timezone,
+ // this should log text similar to "dst: true":
+
+ navigator.globalization.isDayLightSavingsTime(
+ new Date(),
+ function (date) { console.log('dst: ' + date.dst); },
+ function () { console.log('Error getting the DST state.'); }
+ );
+ </pre>
+</div>
+<div class="output">
+<span class="title"><p>Output example:</p></span><pre>dst: true
+</pre>
+</div>
+</dd>
+<dt class="method" id="GlobalizationManager::numberToString">
+<a class="backward-compatibility-anchor" name="::Globalization::GlobalizationManager::numberToString"></a><code><b><span class="methodName">numberToString</span></b></code>
+</dt>
+<dd>
+<div class="brief">
+ Returns a number formatted as a string
+according to the client's user preferences.
+ </div>
+<div class="synopsis"><pre class="signature prettyprint">void numberToString(double number, <a href="#StringSuccessCallback">StringSuccessCallback</a> onsuccess, <a href="cordova.html#ErrorCallback">ErrorCallback</a><a href="file.html#ErrorCallback">ErrorCallback</a> onerror, optional <a href="#NumberPatternOptions">NumberPatternOptions</a> options);
+ </pre></div>
+<p><span class="version">
+ Since: </span>
+ 3.0
+ </p>
+<div class="description">
+ <p>
+The formatted number string is returned by onsuccess callback with
+a properties object as a parameter. That object contains a property value
+of DOMString type containing the result of the conversion.
+ </p>
+ </div>
+<div class="parameters">
+<p><span class="param">Parameters:</span></p>
+<ul>
+ <li class="param">
+<span class="name">number</span>:
+ The number that will be converted to a DOMString
+in accordance with the client's user preferences.
+ </li>
+ <li class="param">
+<span class="name">onsuccess</span>:
+ The callback function executed when the conversion
+is done successfully. The results of the conversion are passed
+as a parameter to this callback function.
+ </li>
+ <li class="param">
+<span class="name">onerror</span>:
+ The callback function executed in case of errors
+occuring during the conversion. The GlobalizationError object with
+the details is passed as a parameter to this callback function.
+ </li>
+ <li class="param">
+<span class="name">options</span><span class="optional"> [optional]</span>:
+ Additional options specifying the details of conversion.
+It is a dictionary with a single property <var>type</var>.
+The default value of this parameter is <var>{type: 'decimal'}</var>.
+ </li>
+ </ul>
+</div>
+<div class="exceptionlist">
+<p><span class="except">Exceptions:</span></p>
+ <ul class="exception"><li>TypeError<ul><li class="list"><p>
+ if any of the input parameters contains an invalid value.
+ </p></li></ul>
+</li></ul>
+ </div>
+<div class="example">
+<span class="example"><p>Code example:</p></span><pre name="code" class="examplecode prettyprint"> // When the browser is set to the en_US locale,
+ // this code displays the results that follow.
+
+ navigator.globalization.numberToString(
+ 3.1415926,
+ function (number) { console.log('decimal number: ' + number.value); },
+ function () { console.log('Error getting number.'); },
+ { type: 'decimal' }
+ );
+
+ navigator.globalization.numberToString(
+ 1000003,
+ function (number) { console.log('big decimal number: ' + number.value); },
+ function () { console.log('Error getting number.'); },
+ { type: 'decimal' }
+ );
+
+ navigator.globalization.numberToString(
+ 0.3183099,
+ function (number) { console.log('percentile: ' + number.value); },
+ function () { console.log('Error getting number.'); },
+ { type: 'percent' }
+ );
+
+ navigator.globalization.numberToString(
+ 1099.95,
+ function (number) { console.log('currency: ' + number.value); },
+ function () { console.log('Error getting number'); },
+ { type: 'currency' }
+ );
+ </pre>
+</div>
+<div class="output">
+<span class="title"><p>Output example:</p></span><pre>decimal number: 3.142
+big decimal number: 1,000,003
+percentile: 32%
+currency: $1,099.95
+</pre>
+</div>
+</dd>
+<dt class="method" id="GlobalizationManager::stringToDate">
+<a class="backward-compatibility-anchor" name="::Globalization::GlobalizationManager::stringToDate"></a><code><b><span class="methodName">stringToDate</span></b></code>
+</dt>
+<dd>
+<div class="brief">
+ Parses a date formatted as a DOMString according to the client's
+user preferences and calendar using the time zone of the client.
+Returns the corresponding date object.
+ </div>
+<div class="synopsis"><pre class="signature prettyprint">void stringToDate(DOMString dateString, <a href="#GlobalizationDateSuccessCallback">GlobalizationDateSuccessCallback</a> onsuccess, <a href="cordova.html#ErrorCallback">ErrorCallback</a><a href="file.html#ErrorCallback">ErrorCallback</a> onerror, optional <a href="#DateOptions">DateOptions</a> options);
+ </pre></div>
+<p><span class="version">
+ Since: </span>
+ 3.0
+ </p>
+<div class="parameters">
+<p><span class="param">Parameters:</span></p>
+<ul>
+ <li class="param">
+<span class="name">dateString</span>:
+ a string containing the representation of a date to be converted
+to a Date object.
+ </li>
+ <li class="param">
+<span class="name">onsuccess</span>:
+ The callback method invoked when the conversion completes successfully.
+The result of conversion is passed as a parameter to this callback.
+ </li>
+ <li class="param">
+<span class="name">onerror</span>:
+ The callback method invoked in case of errors occuring during
+the conversion. A GlobalizationError object is passed as a parameter
+to this callback.
+ </li>
+ <li class="param">
+<span class="name">options</span><span class="optional"> [optional]</span>:
+ Additional options specifying the details of the conversion.
+The default value is <var>{formatLength: 'short', selector: 'date and time'}</var>.
+ </li>
+ </ul>
+</div>
+<div class="exceptionlist">
+<p><span class="except">Exceptions:</span></p>
+ <ul class="exception"><li>TypeError<ul><li class="list"><p>
+ if any of the input parameters contains an invalid value.
+ </p></li></ul>
+</li></ul>
+ </div>
+<div class="example">
+<span class="example"><p>Code example:</p></span><pre name="code" class="examplecode prettyprint"> // when the browser is set to the en_US locale,
+ // this example outputs text similar to the results that follow.
+ // Note that the month integer is one less than the string,
+ // as the month integer represents an array index.
+
+ navigator.globalization.stringToDate(
+ '9/25/2012',
+ function (date) {
+ console.log('month: ' + date.month +
+ ', day: ' + date.day +
+ ', year: ' + date.year)
+ },
+ function () { console.log('Error getting date.'); },
+ { selector: 'date' }
+ );
+ </pre>
+</div>
+<div class="output">
+<span class="title"><p>Output example:</p></span><pre>month: 8, day: 25, year: 2012
+</pre>
+</div>
+</dd>
+<dt class="method" id="GlobalizationManager::stringToNumber">
+<a class="backward-compatibility-anchor" name="::Globalization::GlobalizationManager::stringToNumber"></a><code><b><span class="methodName">stringToNumber</span></b></code>
+</dt>
+<dd>
+<div class="brief">
+ Parses a number formatted as a string according to the client's
+user preferences and returns the corresponding number.
+ </div>
+<div class="synopsis"><pre class="signature prettyprint">void stringToNumber(DOMString numberString, <a href="#DoubleSuccessCallback">DoubleSuccessCallback</a> onsuccess, <a href="cordova.html#ErrorCallback">ErrorCallback</a><a href="file.html#ErrorCallback">ErrorCallback</a> onerror, optional <a href="#NumberPatternOptions">NumberPatternOptions</a> options);
+ </pre></div>
+<p><span class="version">
+ Since: </span>
+ 3.0
+ </p>
+<div class="description">
+ <p>
+If successful, the result of the conversion is passed as a parameter to the onsuccess
+callback method.
+ </p>
+ </div>
+<div class="parameters">
+<p><span class="param">Parameters:</span></p>
+<ul>
+ <li class="param">
+<span class="name">numberString</span>:
+ The DOMString containing a text representation of a number
+to be converted to a double data type.
+ </li>
+ <li class="param">
+<span class="name">onsuccess</span>:
+ The callback method called after a successful conversion.
+The result of a conversion is passed as a parameter of this callback method.
+ </li>
+ <li class="param">
+<span class="name">onerror</span>:
+ The callback method invoked in case of errors occuring during
+the conversion. The error is passed as a parameter of this callback method.
+ </li>
+ <li class="param">
+<span class="name">options</span><span class="optional"> [optional]</span>:
+ Additional options specifying the details of the conversion.
+The default value is <var>{type: 'decimal'}</var> </li>
+ </ul>
+</div>
+<div class="exceptionlist">
+<p><span class="except">Exceptions:</span></p>
+ <ul class="exception"><li>TypeError<ul><li class="list"><p>
+ if any of the input parameters contains an invalid value.
+ </p></li></ul>
+</li></ul>
+ </div>
+<div class="example">
+<span class="example"><p>Code example:</p></span><pre name="code" class="examplecode prettyprint"> // When the browser is set to the en_US locale,
+ // this should display the text similar to the results that follow.
+
+ navigator.globalization.stringToNumber(
+ '1234.56',
+ function (number) { console.log('number: ' + number.value); },
+ function () { console.log('Error getting number.'); },
+ { type: 'decimal' }
+ );
+ </pre>
+</div>
+<div class="output">
+<span class="title"><p>Output example:</p></span><pre>number: 1234.56
+</pre>
+</div>
+</dd>
+</dl>
+</div>
+</div>
+<div class="dictionary" id="DateOptions">
+<a class="backward-compatibility-anchor" name="::Globalization::DateOptions"></a><h3>1.3. DateOptions</h3>
+<div class="brief">
+ DateOptions is a dictionary containing options for date conversions.
+ </div>
+<pre class="webidl prettyprint"> dictionary DateOptions {
+ DOMString formatLength;
+ DOMString selector;
+ };</pre>
+<p><span class="version">
+ Since: </span>
+ 3.0
+ </p>
+<div class="attributes">
+<h4>Dictionary members</h4>
+<dl>
+<dt class="member" id="DateOptions::formatLength"><span class="attrName">DOMString formatLength</span></dt>
+<dd>
+<div class="brief">
+ Indicates the length of DOMString representation of the date.
+ </div>
+<div class="description">
+ <p>
+Valid values are:
+ </p>
+ <ul>
+ <li>
+'short' </li>
+ <li>
+'medium' </li>
+ <li>
+'long' </li>
+ <li>
+'full' </li>
+ </ul>
+ </div>
+</dd>
+<dt class="member" id="DateOptions::selector"><span class="attrName">DOMString selector</span></dt>
+<dd>
+<div class="brief">
+ Indicates the selector for DOMString representation of the date.
+ </div>
+<div class="description">
+ <p>
+Valid values are:
+ </p>
+ <ul>
+ <li>
+'date' </li>
+ <li>
+'time' </li>
+ <li>
+'date and time' </li>
+ </ul>
+ </div>
+</dd>
+</dl>
+</div>
+</div>
+<div class="dictionary" id="CurrencyPattern">
+<a class="backward-compatibility-anchor" name="::Globalization::CurrencyPattern"></a><h3>1.4. CurrencyPattern</h3>
+<div class="brief">
+ CurrencyPattern is a dictionary containing currency formatting properties.
+ </div>
+<pre class="webidl prettyprint"> dictionary CurrencyPattern {
+ DOMString pattern;
+ DOMString code;
+ long fraction;
+ double rounding;
+ DOMString decimal;
+ DOMString grouping;
+ };</pre>
+<div class="attributes">
+<h4>Dictionary members</h4>
+<dl>
+<dt class="member" id="CurrencyPattern::pattern"><span class="attrName">DOMString pattern</span></dt>
+<dd>
+<div class="brief">
+ The currency pattern to format and parse the currency values.
+The patterns follow Unicode Technical Standard #35.
+ </div>
+<p><span class="version">
+ Since: </span>
+ 3.0
+ </p>
+</dd>
+<dt class="member" id="CurrencyPattern::code"><span class="attrName">DOMString code</span></dt>
+<dd>
+<div class="brief">
+ The ISO 4217 currency code for the pattern.
+ </div>
+<p><span class="version">
+ Since: </span>
+ 3.0
+ </p>
+</dd>
+<dt class="member" id="CurrencyPattern::fraction"><span class="attrName">long fraction</span></dt>
+<dd>
+<div class="brief">
+ The number of fractional digits to use when parsing and formatting currency.
+ </div>
+<p><span class="version">
+ Since: </span>
+ 3.0
+ </p>
+</dd>
+<dt class="member" id="CurrencyPattern::rounding"><span class="attrName">double rounding</span></dt>
+<dd>
+<div class="brief">
+ The rounding increment to use when parsing and formatting.
+ </div>
+<p><span class="version">
+ Since: </span>
+ 3.0
+ </p>
+</dd>
+<dt class="member" id="CurrencyPattern::decimal"><span class="attrName">DOMString decimal</span></dt>
+<dd>
+<div class="brief">
+ The decimal symbol to use for parsing and formatting.
+ </div>
+<p><span class="version">
+ Since: </span>
+ 3.0
+ </p>
+</dd>
+<dt class="member" id="CurrencyPattern::grouping"><span class="attrName">DOMString grouping</span></dt>
+<dd>
+<div class="brief">
+ The grouping symbol to use for parsing and formatting.
+ </div>
+<p><span class="version">
+ Since: </span>
+ 3.0
+ </p>
+</dd>
+</dl>
+</div>
+</div>
+<div class="dictionary" id="GetDateNamesOptions">
+<a class="backward-compatibility-anchor" name="::Globalization::GetDateNamesOptions"></a><h3>1.5. GetDateNamesOptions</h3>
+<div class="brief">
+ The GetDateNamesOptions dictionary contains options used in getDateNames method.
+ </div>
+<pre class="webidl prettyprint"> dictionary GetDateNamesOptions {
+ DOMString type;
+ DOMString item;
+ };</pre>
+<p><span class="version">
+ Since: </span>
+ 3.0
+ </p>
+<div class="attributes">
+<h4>Dictionary members</h4>
+<dl>
+<dt class="member" id="GetDateNamesOptions::type"><span class="attrName">DOMString type</span></dt>
+<dd>
+<div class="brief">
+ Determines whether to use abbreviated (narrow) or full-length (wide) names.
+ </div>
+<div class="description">
+ <p>
+The following values are valid:
+ </p>
+ <ul>
+ <li>
+'narrow' - Abbreviated names will be returned. </li>
+ <li>
+'wide' - Full names will be returned. </li>
+ </ul>
+ </div>
+<p><span class="version">
+ Since: </span>
+ 3.0
+ </p>
+</dd>
+<dt class="member" id="GetDateNamesOptions::item"><span class="attrName">DOMString item</span></dt>
+<dd>
+<div class="brief">
+ Determines whether to return the names of months or the names of days.
+ </div>
+<div class="description">
+ <p>
+The following values are valid:
+ </p>
+ <ul>
+ <li>
+'months' - The names of months will be returned. </li>
+ <li>
+'days' - The names of days of the week will be returned. </li>
+ </ul>
+ </div>
+<p><span class="version">
+ Since: </span>
+ 3.0
+ </p>
+</dd>
+</dl>
+</div>
+</div>
+<div class="dictionary" id="NumberPatternOptions">
+<a class="backward-compatibility-anchor" name="::Globalization::NumberPatternOptions"></a><h3>1.6. NumberPatternOptions</h3>
+<div class="brief">
+ The NumberPatternOptions dictionary contains options
+used in handling numerical locale settings.
+ </div>
+<pre class="webidl prettyprint"> dictionary NumberPatternOptions {
+ DOMString type;
+ };</pre>
+<p><span class="version">
+ Since: </span>
+ 3.0
+ </p>
+<div class="attributes">
+<h4>Dictionary members</h4>
+<dl>
+<dt class="member" id="NumberPatternOptions::type"><span class="attrName">DOMString type</span></dt>
+<dd>
+<div class="brief">
+ The type determines the genus of numeric value,
+for which the pattern will be extracted.
+ </div>
+<div class="description">
+ <p>
+The following values are valid:
+ </p>
+ <ul>
+ <li>
+'decimal' - Indicates that the pattern for the
+decimal numbers should be extracted. </li>
+ <li>
+'percent' - Indicates that the pattern for the
+percents should be extracted. </li>
+ <li>
+'currency' - Indicates that the pattern for the
+currency values should be extracted. </li>
+ </ul>
+ </div>
+<p><span class="version">
+ Since: </span>
+ 3.0
+ </p>
+</dd>
+</dl>
+</div>
+</div>
+<div class="dictionary" id="DatePattern">
+<a class="backward-compatibility-anchor" name="::Globalization::DatePattern"></a><h3>1.7. DatePattern</h3>
+<div class="brief">
+ The DatePattern dictionary contains the information obtained in getDatePattern method.
+ </div>
+<pre class="webidl prettyprint"> dictionary DatePattern {
+ DOMString pattern;
+ DOMString timezone;
+ long utc_offset;
+ long dst_offset;
+ };</pre>
+<p><span class="version">
+ Since: </span>
+ 3.0
+ </p>
+<div class="attributes">
+<h4>Dictionary members</h4>
+<dl>
+<dt class="member" id="DatePattern::pattern"><span class="attrName">DOMString pattern</span></dt>
+<dd>
+<div class="brief">
+ The date and time pattern to format and parse dates.
+The patterns follow Unicode Technical Standard #35.
+ </div>
+<p><span class="version">
+ Since: </span>
+ 3.0
+ </p>
+</dd>
+<dt class="member" id="DatePattern::timezone"><span class="attrName">DOMString timezone</span></dt>
+<dd>
+<div class="brief">
+ The abbreviated name of the time zone on client's device.
+ </div>
+<p><span class="version">
+ Since: </span>
+ 3.0
+ </p>
+</dd>
+<dt class="member" id="DatePattern::utc_offset"><span class="attrName">long utc_offset</span></dt>
+<dd>
+<div class="brief">
+ The current difference in seconds between the client's time zone
+and coordinated universal time.
+ </div>
+<p><span class="version">
+ Since: </span>
+ 3.0
+ </p>
+</dd>
+<dt class="member" id="DatePattern::dst_offset"><span class="attrName">long dst_offset</span></dt>
+<dd>
+<div class="brief">
+ The current daylight saving time offset in seconds between the client's
+non-daylight saving time zone and the client's daylight saving time zone.
+ </div>
+<p><span class="version">
+ Since: </span>
+ 3.0
+ </p>
+</dd>
+</dl>
+</div>
+</div>
+<div class="dictionary" id="NumberPattern">
+<a class="backward-compatibility-anchor" name="::Globalization::NumberPattern"></a><h3>1.8. NumberPattern</h3>
+<div class="brief">
+ The NumberPattern dictionary contains the information obtained
+by calling the getNumberPattern method.
+ </div>
+<pre class="webidl prettyprint"> dictionary NumberPattern {
+ DOMString pattern;
+ DOMString symbol;
+ long fraction;
+ double rounding;
+ DOMString positive;
+ DOMString negative;
+ DOMString decimal;
+ DOMString grouping;
+ };</pre>
+<p><span class="version">
+ Since: </span>
+ 3.0
+ </p>
+<div class="attributes">
+<h4>Dictionary members</h4>
+<dl>
+<dt class="member" id="NumberPattern::pattern"><span class="attrName">DOMString pattern</span></dt>
+<dd>
+<div class="brief">
+ The number pattern to format and parse numbers.
+The patterns follow Unicode Technical Standard #35.
+ </div>
+<p><span class="version">
+ Since: </span>
+ 3.0
+ </p>
+</dd>
+<dt class="member" id="NumberPattern::symbol"><span class="attrName">DOMString symbol</span></dt>
+<dd>
+<div class="brief">
+ The symbol to use when formatting and parsing,
+such as percent or currency symbol.
+ </div>
+<p><span class="version">
+ Since: </span>
+ 3.0
+ </p>
+</dd>
+<dt class="member" id="NumberPattern::fraction"><span class="attrName">long fraction</span></dt>
+<dd>
+<div class="brief">
+ The number of fractional digits to use
+when parsing and formatting.
+ </div>
+<p><span class="version">
+ Since: </span>
+ 3.0
+ </p>
+</dd>
+<dt class="member" id="NumberPattern::rounding"><span class="attrName">double rounding</span></dt>
+<dd>
+<div class="brief">
+ The rounding increment to use when parsing and formatting.
+ </div>
+<p><span class="version">
+ Since: </span>
+ 3.0
+ </p>
+</dd>
+<dt class="member" id="NumberPattern::positive"><span class="attrName">DOMString positive</span></dt>
+<dd>
+<div class="brief">
+ The symbol to use for positive numbers
+when parsing and formatting.
+ </div>
+<p><span class="version">
+ Since: </span>
+ 3.0
+ </p>
+</dd>
+<dt class="member" id="NumberPattern::negative"><span class="attrName">DOMString negative</span></dt>
+<dd>
+<div class="brief">
+ The symbol to use for negative numbers
+when parsing and formatting.
+ </div>
+<p><span class="version">
+ Since: </span>
+ 3.0
+ </p>
+</dd>
+<dt class="member" id="NumberPattern::decimal"><span class="attrName">DOMString decimal</span></dt>
+<dd>
+<div class="brief">
+ The decimal symbol to use for parsing and formatting.
+ </div>
+<p><span class="version">
+ Since: </span>
+ 3.0
+ </p>
+</dd>
+<dt class="member" id="NumberPattern::grouping"><span class="attrName">DOMString grouping</span></dt>
+<dd>
+<div class="brief">
+ The grouping symbol to use for parsing and formatting.
+ </div>
+<p><span class="version">
+ Since: </span>
+ 3.0
+ </p>
+</dd>
+</dl>
+</div>
+</div>
+<div class="dictionary" id="GlobalizationDate">
+<a class="backward-compatibility-anchor" name="::Globalization::GlobalizationDate"></a><h3>1.9. GlobalizationDate</h3>
+<div class="brief">
+ the GlobalizationDate dictionary represents a point in time,
+similar to a Date object in javascript.
+ </div>
+<pre class="webidl prettyprint"> dictionary GlobalizationDate {
+ long year;
+ long month;
+ long day;
+ long hour;
+ long minute;
+ long second;
+ long millisecond;
+ };</pre>
+<p><span class="version">
+ Since: </span>
+ 3.0
+ </p>
+<div class="attributes">
+<h4>Dictionary members</h4>
+<dl>
+<dt class="member" id="GlobalizationDate::year"><span class="attrName">long year</span></dt>
+<dd>
+<div class="brief">
+ The four digit year.
+ </div>
+<p><span class="version">
+ Since: </span>
+ 3.0
+ </p>
+</dd>
+<dt class="member" id="GlobalizationDate::month"><span class="attrName">long month</span></dt>
+<dd>
+<div class="brief">
+ The month index in range (0, 11) inclusively.
+ </div>
+<p><span class="version">
+ Since: </span>
+ 3.0
+ </p>
+</dd>
+<dt class="member" id="GlobalizationDate::day"><span class="attrName">long day</span></dt>
+<dd>
+<div class="brief">
+ The day of month in range (1, 31) inclusively.
+ </div>
+<p><span class="version">
+ Since: </span>
+ 3.0
+ </p>
+</dd>
+<dt class="member" id="GlobalizationDate::hour"><span class="attrName">long hour</span></dt>
+<dd>
+<div class="brief">
+ The hour in range (0, 23) inclusively.
+ </div>
+<p><span class="version">
+ Since: </span>
+ 3.0
+ </p>
+</dd>
+<dt class="member" id="GlobalizationDate::minute"><span class="attrName">long minute</span></dt>
+<dd>
+<div class="brief">
+ The minute in range (0, 59) inclusively.
+ </div>
+<p><span class="version">
+ Since: </span>
+ 3.0
+ </p>
+</dd>
+<dt class="member" id="GlobalizationDate::second"><span class="attrName">long second</span></dt>
+<dd>
+<div class="brief">
+ The second in range (0, 59) inclusively.
+ </div>
+<p><span class="version">
+ Since: </span>
+ 3.0
+ </p>
+</dd>
+<dt class="member" id="GlobalizationDate::millisecond"><span class="attrName">long millisecond</span></dt>
+<dd>
+<div class="brief">
+ The milliseconds in range (0, 999) inclusively.
+ </div>
+<p><span class="version">
+ Since: </span>
+ 3.0
+ </p>
+</dd>
+</dl>
+</div>
+</div>
+<div class="interface" id="DSTSuccessCallback">
+<a class="backward-compatibility-anchor" name="::Globalization::DSTSuccessCallback"></a><h3>1.10. DSTSuccessCallback</h3>
+<div class="brief">
+ A callback method invoked on successful extraction
+of Daylight Saving Time data.
+ </div>
+<pre class="webidl prettyprint"> [Callback=FunctionOnly, NoInterfaceObject] interface DSTSuccessCallback {
+ void onsuccess(object properties);
+ };</pre>
+<p><span class="version">
+ Since: </span>
+ 3.0
+ </p>
+<div class="methods">
+<h4>Methods</h4>
+<dl>
+<dt class="method" id="DSTSuccessCallback::onsuccess">
+<a class="backward-compatibility-anchor" name="::Globalization::DSTSuccessCallback::onsuccess"></a><code><b><span class="methodName">onsuccess</span></b></code>
+</dt>
+<dd>
+<div class="brief">
+ Called when a function returns the DST data successfully.
+ </div>
+<div class="synopsis"><pre class="signature prettyprint">void onsuccess(object properties);
+ </pre></div>
+<p><span class="version">
+ Since: </span>
+ 3.0
+ </p>
+<div class="parameters">
+<p><span class="param">Parameters:</span></p>
+<ul>
+ <li class="param">
+<span class="name">properties</span>:
+ An object containing the field "dst" of boolean type.
+ </li>
+ </ul>
+</div>
+</dd>
+</dl>
+</div>
+</div>
+<div class="interface" id="StringSuccessCallback">
+<a class="backward-compatibility-anchor" name="::Globalization::StringSuccessCallback"></a><h3>1.11. StringSuccessCallback</h3>
+<div class="brief">
+ A callback method invoked on successful extraction of
+a data encoded as a DOMString.
+ </div>
+<pre class="webidl prettyprint"> [Callback=FunctionOnly, NoInterfaceObject] interface StringSuccessCallback {
+ void onsuccess(object properties);
+ };</pre>
+<p><span class="version">
+ Since: </span>
+ 3.0
+ </p>
+<div class="methods">
+<h4>Methods</h4>
+<dl>
+<dt class="method" id="StringSuccessCallback::onsuccess">
+<a class="backward-compatibility-anchor" name="::Globalization::StringSuccessCallback::onsuccess"></a><code><b><span class="methodName">onsuccess</span></b></code>
+</dt>
+<dd>
+<div class="brief">
+ Called when a function returns the properties object with data successfully.
+ </div>
+<div class="synopsis"><pre class="signature prettyprint">void onsuccess(object properties);
+ </pre></div>
+<p><span class="version">
+ Since: </span>
+ 3.0
+ </p>
+<div class="parameters">
+<p><span class="param">Parameters:</span></p>
+<ul>
+ <li class="param">
+<span class="name">properties</span>:
+ An object containing the field "value" of a DOMString type.
+ </li>
+ </ul>
+</div>
+</dd>
+</dl>
+</div>
+</div>
+<div class="interface" id="ArrayStringSuccessCallback">
+<a class="backward-compatibility-anchor" name="::Globalization::ArrayStringSuccessCallback"></a><h3>1.12. ArrayStringSuccessCallback</h3>
+<div class="brief">
+ The callback method invoked on successful extraction of
+the data represented as an array of DOMString values.
+ </div>
+<pre class="webidl prettyprint"> [Callback=FunctionOnly, NoInterfaceObject] interface ArrayStringSuccessCallback {
+ void onsuccess(object properties);
+ };</pre>
+<p><span class="version">
+ Since: </span>
+ 3.0
+ </p>
+<div class="methods">
+<h4>Methods</h4>
+<dl>
+<dt class="method" id="ArrayStringSuccessCallback::onsuccess">
+<a class="backward-compatibility-anchor" name="::Globalization::ArrayStringSuccessCallback::onsuccess"></a><code><b><span class="methodName">onsuccess</span></b></code>
+</dt>
+<dd>
+<div class="brief">
+ Called when a function returns the array of DOMString values succesfully.
+ </div>
+<div class="synopsis"><pre class="signature prettyprint">void onsuccess(object properties);
+ </pre></div>
+<p><span class="version">
+ Since: </span>
+ 3.0
+ </p>
+<div class="parameters">
+<p><span class="param">Parameters:</span></p>
+<ul>
+ <li class="param">
+<span class="name">properties</span>:
+ an object with the field "value"
+containing an Array of DOMString values.
+ </li>
+ </ul>
+</div>
+</dd>
+</dl>
+</div>
+</div>
+<div class="interface" id="LongSuccessCallback">
+<a class="backward-compatibility-anchor" name="::Globalization::LongSuccessCallback"></a><h3>1.13. LongSuccessCallback</h3>
+<div class="brief">
+ The callback method invoked on successful extraction
+of the data represented as a long integer value.
+ </div>
+<pre class="webidl prettyprint"> [Callback=FunctionOnly, NoInterfaceObject] interface LongSuccessCallback {
+ void onsuccess(object properties);
+ };</pre>
+<p><span class="version">
+ Since: </span>
+ 3.0
+ </p>
+<div class="methods">
+<h4>Methods</h4>
+<dl>
+<dt class="method" id="LongSuccessCallback::onsuccess">
+<a class="backward-compatibility-anchor" name="::Globalization::LongSuccessCallback::onsuccess"></a><code><b><span class="methodName">onsuccess</span></b></code>
+</dt>
+<dd>
+<div class="brief">
+ Called when a function returns a numeric (long) data successfully.
+ </div>
+<div class="synopsis"><pre class="signature prettyprint">void onsuccess(object properties);
+ </pre></div>
+<p><span class="version">
+ Since: </span>
+ 3.0
+ </p>
+<div class="parameters">
+<p><span class="param">Parameters:</span></p>
+<ul>
+ <li class="param">
+<span class="name">properties</span>:
+ An object containing the field "value" of a long type.
+ </li>
+ </ul>
+</div>
+</dd>
+</dl>
+</div>
+</div>
+<div class="interface" id="DoubleSuccessCallback">
+<a class="backward-compatibility-anchor" name="::Globalization::DoubleSuccessCallback"></a><h3>1.14. DoubleSuccessCallback</h3>
+<div class="brief">
+ The callback method invoked on successful extraction
+of the data represented as a double precision numeric value.
+ </div>
+<pre class="webidl prettyprint"> [Callback=FunctionOnly, NoInterfaceObject] interface DoubleSuccessCallback {
+ void onsuccess(object properties);
+ };</pre>
+<p><span class="version">
+ Since: </span>
+ 3.0
+ </p>
+<div class="methods">
+<h4>Methods</h4>
+<dl>
+<dt class="method" id="DoubleSuccessCallback::onsuccess">
+<a class="backward-compatibility-anchor" name="::Globalization::DoubleSuccessCallback::onsuccess"></a><code><b><span class="methodName">onsuccess</span></b></code>
+</dt>
+<dd>
+<div class="brief">
+ Called when a function returns a numeric (double) data successfully.
+ </div>
+<div class="synopsis"><pre class="signature prettyprint">void onsuccess(object properties);
+ </pre></div>
+<p><span class="version">
+ Since: </span>
+ 3.0
+ </p>
+<div class="parameters">
+<p><span class="param">Parameters:</span></p>
+<ul>
+ <li class="param">
+<span class="name">properties</span>:
+ An object containing the field "value" of a double type.
+ </li>
+ </ul>
+</div>
+</dd>
+</dl>
+</div>
+</div>
+<div class="interface" id="GlobalizationDateSuccessCallback">
+<a class="backward-compatibility-anchor" name="::Globalization::GlobalizationDateSuccessCallback"></a><h3>1.15. GlobalizationDateSuccessCallback</h3>
+<div class="brief">
+ The callback method invoked on successful extraction
+of the GlobalizationDate object.
+ </div>
+<pre class="webidl prettyprint"> [Callback=FunctionOnly, NoInterfaceObject] interface GlobalizationDateSuccessCallback {
+ void onsuccess(Date date);
+ };</pre>
+<p><span class="version">
+ Since: </span>
+ 3.0
+ </p>
+<div class="methods">
+<h4>Methods</h4>
+<dl>
+<dt class="method" id="GlobalizationDateSuccessCallback::onsuccess">
+<a class="backward-compatibility-anchor" name="::Globalization::GlobalizationDateSuccessCallback::onsuccess"></a><code><b><span class="methodName">onsuccess</span></b></code>
+</dt>
+<dd>
+<div class="brief">
+ Called when a function returns a GlobalizationDate object successfully.
+ </div>
+<div class="synopsis"><pre class="signature prettyprint">void onsuccess(Date date);
+ </pre></div>
+<p><span class="version">
+ Since: </span>
+ 3.0
+ </p>
+<div class="parameters">
+<p><span class="param">Parameters:</span></p>
+<ul>
+ <li class="param">
+<span class="name">date</span>:
+ a GlobalizationDate object containing the date information.
+ </li>
+ </ul>
+</div>
+</dd>
+</dl>
+</div>
+</div>
+<div class="interface" id="PatternSuccessCallback">
+<a class="backward-compatibility-anchor" name="::Globalization::PatternSuccessCallback"></a><h3>1.16. PatternSuccessCallback</h3>
+<div class="brief">
+ The callback method invoked on successful extraction
+of a CurrencyPattern object.
+ </div>
+<pre class="webidl prettyprint"> [Callback=FunctionOnly, NoInterfaceObject] interface PatternSuccessCallback {
+ void onsuccess(<a href="#CurrencyPattern">CurrencyPattern</a> pattern);
+ };</pre>
+<p><span class="version">
+ Since: </span>
+ 3.0
+ </p>
+<div class="methods">
+<h4>Methods</h4>
+<dl>
+<dt class="method" id="PatternSuccessCallback::onsuccess">
+<a class="backward-compatibility-anchor" name="::Globalization::PatternSuccessCallback::onsuccess"></a><code><b><span class="methodName">onsuccess</span></b></code>
+</dt>
+<dd>
+<div class="brief">
+ Called when a function returns the currency pattern information succesfully.
+ </div>
+<div class="synopsis"><pre class="signature prettyprint">void onsuccess(<a href="#CurrencyPattern">CurrencyPattern</a> pattern);
+ </pre></div>
+<p><span class="version">
+ Since: </span>
+ 3.0
+ </p>
+<div class="parameters">
+<p><span class="param">Parameters:</span></p>
+<ul>
+ <li class="param">
+<span class="name">pattern</span>:
+ a CurrencyPattern object containing retrieved information.
+ </li>
+ </ul>
+</div>
+</dd>
+</dl>
+</div>
+</div>
+<div class="interface" id="GetDatePatternSuccessCallback">
+<a class="backward-compatibility-anchor" name="::Globalization::GetDatePatternSuccessCallback"></a><h3>1.17. GetDatePatternSuccessCallback</h3>
+<div class="brief">
+ The callback method invoked on succesful extraction
+of a DatePattern object.
+ </div>
+<pre class="webidl prettyprint"> [Callback=FunctionOnly, NoInterfaceObject] interface GetDatePatternSuccessCallback {
+ void onsuccess(<a href="#DatePattern">DatePattern</a> pattern);
+ };</pre>
+<p><span class="version">
+ Since: </span>
+ 3.0
+ </p>
+<div class="methods">
+<h4>Methods</h4>
+<dl>
+<dt class="method" id="GetDatePatternSuccessCallback::onsuccess">
+<a class="backward-compatibility-anchor" name="::Globalization::GetDatePatternSuccessCallback::onsuccess"></a><code><b><span class="methodName">onsuccess</span></b></code>
+</dt>
+<dd>
+<div class="brief">
+ Called when a function returns the date pattern information successfully.
+ </div>
+<div class="synopsis"><pre class="signature prettyprint">void onsuccess(<a href="#DatePattern">DatePattern</a> pattern);
+ </pre></div>
+<p><span class="version">
+ Since: </span>
+ 3.0
+ </p>
+<div class="parameters">
+<p><span class="param">Parameters:</span></p>
+<ul>
+ <li class="param">
+<span class="name">pattern</span>:
+ a DatePattern object containing retrieved information.
+ </li>
+ </ul>
+</div>
+</dd>
+</dl>
+</div>
+</div>
+<div class="interface" id="GetNumberPatternSuccessCallback">
+<a class="backward-compatibility-anchor" name="::Globalization::GetNumberPatternSuccessCallback"></a><h3>1.18. GetNumberPatternSuccessCallback</h3>
+<div class="brief">
+ The callback method invoked on successful extraction
+of a NumberPattern object.
+ </div>
+<pre class="webidl prettyprint"> [Callback=FunctionOnly, NoInterfaceObject] interface GetNumberPatternSuccessCallback {
+ void onsuccess(<a href="#NumberPattern">NumberPattern</a> pattern);
+ };</pre>
+<p><span class="version">
+ Since: </span>
+ 3.0
+ </p>
+<div class="methods">
+<h4>Methods</h4>
+<dl>
+<dt class="method" id="GetNumberPatternSuccessCallback::onsuccess">
+<a class="backward-compatibility-anchor" name="::Globalization::GetNumberPatternSuccessCallback::onsuccess"></a><code><b><span class="methodName">onsuccess</span></b></code>
+</dt>
+<dd>
+<div class="brief">
+ Called when a function returns the number pattern information successfully.
+ </div>
+<div class="synopsis"><pre class="signature prettyprint">void onsuccess(<a href="#NumberPattern">NumberPattern</a> pattern);
+ </pre></div>
+<p><span class="version">
+ Since: </span>
+ 3.0
+ </p>
+<div class="parameters">
+<p><span class="param">Parameters:</span></p>
+<ul>
+ <li class="param">
+<span class="name">pattern</span>:
+ a NumberPattern object containing retrieved information.
+ </li>
+ </ul>
+</div>
+</dd>
+</dl>
+</div>
+</div>
+<div class="interface" id="GlobalizationError">
+<a class="backward-compatibility-anchor" name="::Globalization::GlobalizationError"></a><h3>1.19. GlobalizationError</h3>
+<pre class="webidl prettyprint"> interface GlobalizationError {
+ attribute long code;
+ attribute DOMString message;
+ const short UNKNOWN_ERROR = 0;
+ const short FORMATTING_ERROR = 1;
+ const short PARSING_ERROR = 2;
+ const short PATTERN_ERROR = 3;
+ };</pre>
+<p><span class="version">
+ Since: </span>
+ 3.0
+ </p>
+<div class="description">
+ <p>
+The GlobalizationError interface
+ </p>
+ </div>
+<div class="consts">
+<h4>Constants</h4>
+<dl>
+<li class="const" id="GlobalizationError::UNKNOWN_ERROR">
+<a class="backward-compatibility-anchor" name="::Globalization::GlobalizationError::UNKNOWN_ERROR"></a><span class="name">UNKNOWN_ERROR</span><div class="brief">
+ Unknown error
+ </div>
+<p><span class="version">
+ Since: </span>
+ 3.0
+ </p>
+<br><br>
+</li>
+<li class="const" id="GlobalizationError::FORMATTING_ERROR">
+<a class="backward-compatibility-anchor" name="::Globalization::GlobalizationError::FORMATTING_ERROR"></a><span class="name">FORMATTING_ERROR</span><div class="brief">
+ Formatting error
+ </div>
+<p><span class="version">
+ Since: </span>
+ 3.0
+ </p>
+<br><br>
+</li>
+<li class="const" id="GlobalizationError::PARSING_ERROR">
+<a class="backward-compatibility-anchor" name="::Globalization::GlobalizationError::PARSING_ERROR"></a><span class="name">PARSING_ERROR</span><div class="brief">
+ Parsing error
+ </div>
+<p><span class="version">
+ Since: </span>
+ 3.0
+ </p>
+<br><br>
+</li>
+<li class="const" id="GlobalizationError::PATTERN_ERROR">
+<a class="backward-compatibility-anchor" name="::Globalization::GlobalizationError::PATTERN_ERROR"></a><span class="name">PATTERN_ERROR</span><div class="brief">
+ Pattern error
+ </div>
+<p><span class="version">
+ Since: </span>
+ 3.0
+ </p>
+<br><br>
+</li>
+</dl>
+</div>
+<div class="attributes">
+<h4>Attributes</h4>
+<ul>
+<li class="attribute" id="GlobalizationError::code">
+<span class="attrName"><span class="type">long </span><span class="name">code</span></span><div class="brief">
+ One of the following codes representing the error type.
+ </div>
+<div class="description">
+ <ul>
+ <li>
+0: GlobalizationError.UNKNOWN_ERROR </li>
+ <li>
+1: GlobalizationError.FORMATTING_ERROR </li>
+ <li>
+2: GlobalizationError.PARSING_ERROR </li>
+ <li>
+3: GlobalizationError.PATTERN_ERROR </li>
+ </ul>
+ </div>
+<p><span class="version">
+ Since: </span>
+ 3.0
+ </p>
+</li>
+<li class="attribute" id="GlobalizationError::message">
+<span class="attrName"><span class="type">DOMString </span><span class="name">message</span></span><div class="brief">
+ A text message that includes the error's explaination and/or details.
+ </div>
+<p><span class="version">
+ Since: </span>
+ 3.0
+ </p>
+</li>
+</ul>
+</div>
+</div>
+</div>
+<h2 id="full-webidl">2. Full WebIDL</h2>
+<pre class="webidl prettyprint"> module Globalization {
+
+ [NoInterfaceObject] interface GlobalizationManagerObject {
+ readonly attribute <a href="#GlobalizationManager">GlobalizationManager</a> globalization;
+ };
+
+ implements <a href="#GlobalizationManagerObject">GlobalizationManagerObject</a>;
+
+ [NoInterfaceObject] interface GlobalizationManager {
+
+ void getPreferredLanguage(<a href="#StringSuccessCallback">StringSuccessCallback</a> onsuccess,
+ <a href="cordova.html#ErrorCallback">ErrorCallback</a><a href="file.html#ErrorCallback">ErrorCallback</a> onerror);
+
+ void getLocaleName(<a href="#StringSuccessCallback">StringSuccessCallback</a> onsuccess,
+ <a href="cordova.html#ErrorCallback">ErrorCallback</a><a href="file.html#ErrorCallback">ErrorCallback</a> onerror);
+
+ void dateToString(Date date, <a href="#StringSuccessCallback">StringSuccessCallback</a> onsuccess, <a href="cordova.html#ErrorCallback">ErrorCallback</a><a href="file.html#ErrorCallback">ErrorCallback</a> onerror,
+ optional <a href="#DateOptions">DateOptions</a> options);
+
+ void getCurrencyPattern(DOMString currencyCode,
+ <a href="#PatternSuccessCallback">PatternSuccessCallback</a> onsuccess,
+ <a href="cordova.html#ErrorCallback">ErrorCallback</a><a href="file.html#ErrorCallback">ErrorCallback</a> onerror);
+
+ void getDateNames(<a href="#ArrayStringSuccessCallback">ArrayStringSuccessCallback</a> onsuccess, <a href="cordova.html#ErrorCallback">ErrorCallback</a><a href="file.html#ErrorCallback">ErrorCallback</a> onerror,
+ optional <a href="#GetDateNamesOptions">GetDateNamesOptions</a> options);
+
+ void getDatePattern(<a href="#GetDatePatternSuccessCallback">GetDatePatternSuccessCallback</a> onsuccess, <a href="cordova.html#ErrorCallback">ErrorCallback</a><a href="file.html#ErrorCallback">ErrorCallback</a> onerror,
+ optional <a href="#DateOptions">DateOptions</a> options);
+
+ void getFirstDayOfWeek(<a href="#LongSuccessCallback">LongSuccessCallback</a> onsuccess,
+ <a href="cordova.html#ErrorCallback">ErrorCallback</a><a href="file.html#ErrorCallback">ErrorCallback</a> onerror);
+
+ void getNumberPattern(<a href="#GetNumberPatternSuccessCallback">GetNumberPatternSuccessCallback</a> onsuccess,
+ <a href="cordova.html#ErrorCallback">ErrorCallback</a><a href="file.html#ErrorCallback">ErrorCallback</a> onerror,
+ optional <a href="#NumberPatternOptions">NumberPatternOptions</a> options);
+
+ void isDayLightSavingsTime(Date date, <a href="#DSTSuccessCallback">DSTSuccessCallback</a> onsuccess,
+ <a href="cordova.html#ErrorCallback">ErrorCallback</a><a href="file.html#ErrorCallback">ErrorCallback</a> onerror);
+
+ void numberToString(double number, <a href="#StringSuccessCallback">StringSuccessCallback</a> onsuccess, <a href="cordova.html#ErrorCallback">ErrorCallback</a><a href="file.html#ErrorCallback">ErrorCallback</a> onerror,
+ optional <a href="#NumberPatternOptions">NumberPatternOptions</a> options);
+
+ void stringToDate(DOMString dateString, <a href="#GlobalizationDateSuccessCallback">GlobalizationDateSuccessCallback</a> onsuccess,
+ <a href="cordova.html#ErrorCallback">ErrorCallback</a><a href="file.html#ErrorCallback">ErrorCallback</a> onerror,
+ optional <a href="#DateOptions">DateOptions</a> options);
+ void stringToNumber(DOMString numberString, <a href="#DoubleSuccessCallback">DoubleSuccessCallback</a> onsuccess,
+ <a href="cordova.html#ErrorCallback">ErrorCallback</a><a href="file.html#ErrorCallback">ErrorCallback</a> onerror,
+ optional <a href="#NumberPatternOptions">NumberPatternOptions</a> options);
+ };
+
+ dictionary DateOptions {
+ DOMString formatLength;
+ DOMString selector;
+ };
+
+ dictionary CurrencyPattern {
+ DOMString pattern;
+ DOMString code;
+ long fraction;
+ double rounding;
+ DOMString decimal;
+ DOMString grouping;
+ };
+
+ dictionary GetDateNamesOptions {
+ DOMString type;
+ DOMString item;
+ };
+
+ dictionary NumberPatternOptions {
+ DOMString type;
+ };
+
+ dictionary DatePattern {
+ DOMString pattern;
+ DOMString timezone;
+ long utc_offset;
+ long dst_offset;
+ };
+
+ dictionary NumberPattern {
+ DOMString pattern;
+ DOMString symbol;
+ long fraction;
+ double rounding;
+ DOMString positive;
+ DOMString negative;
+ DOMString decimal;
+ DOMString grouping;
+ };
+
+ dictionary GlobalizationDate {
+ long year;
+ long month;
+ long day;
+ long hour;
+ long minute;
+ long second;
+ long millisecond;
+ };
+
+
+ [Callback=FunctionOnly, NoInterfaceObject] interface DSTSuccessCallback {
+ void onsuccess(object properties);
+ };
+
+ [Callback=FunctionOnly, NoInterfaceObject] interface StringSuccessCallback {
+ void onsuccess(object properties);
+ };
+
+ [Callback=FunctionOnly, NoInterfaceObject] interface ArrayStringSuccessCallback {
+ void onsuccess(object properties);
+ };
+
+ [Callback=FunctionOnly, NoInterfaceObject] interface LongSuccessCallback {
+ void onsuccess(object properties);
+ };
+
+ [Callback=FunctionOnly, NoInterfaceObject] interface DoubleSuccessCallback {
+ void onsuccess(object properties);
+ };
+
+ [Callback=FunctionOnly, NoInterfaceObject] interface GlobalizationDateSuccessCallback {
+ void onsuccess(Date date);
+ };
+
+ [Callback=FunctionOnly, NoInterfaceObject] interface PatternSuccessCallback {
+ void onsuccess(<a href="#CurrencyPattern">CurrencyPattern</a> pattern);
+ };
+
+ [Callback=FunctionOnly, NoInterfaceObject] interface GetDatePatternSuccessCallback {
+ void onsuccess(<a href="#DatePattern">DatePattern</a> pattern);
+ };
+
+ [Callback=FunctionOnly, NoInterfaceObject] interface GetNumberPatternSuccessCallback {
+ void onsuccess(<a href="#NumberPattern">NumberPattern</a> pattern);
+ };
+
+ interface GlobalizationError {
+ attribute long code;
+ attribute DOMString message;
+ const short UNKNOWN_ERROR = 0;
+ const short FORMATTING_ERROR = 1;
+ const short PARSING_ERROR = 2;
+ const short PATTERN_ERROR = 3;
+ };
+};</pre>
+</div>
+<div id="page-footer">
+<div class="copyright" align="center">
+ Except as noted, this content - excluding the Code Examples - is licensed under <a href="http://creativecommons.org/licenses/by/3.0/legalcode" target="_blank">Creative Commons Attribution 3.0</a> and all of the Code Examples contained herein are licensed under <a href="https://www.tizen.org/bsd-3-clause-license" target="_blank">BSD-3-Clause</a>. <br>For details, see the <a href="https://www.tizen.org/content-license" target="_blank">Content License</a>.
+ </div>
+<script type="text/javascript">
+
+ var _gaq = _gaq || [];
+ _gaq.push(['_setAccount', 'UA-25976949-1']);
+ _gaq.push(['_setDomainName', 'tizen.org']);
+ _gaq.push(['_trackPageview']);
+
+ (function() {
+ var ga = document.createElement('script'); ga.type = 'text/javascript'; ga.async = true;
+ var s = document.getElementsByTagName('script')[0]; s.parentNode.insertBefore(ga, s);
+ })();
+
+ </script>
+</div>
+</body>
+</html>
--- /dev/null
+<!DOCTYPE html PUBLIC "html">
+<html>
+<head>
+<meta http-equiv="Content-Type" content="text/html; charset=utf-8">
+<link rel="stylesheet" type="text/css" href="../tizen.css" media="screen">
+<script type="text/javascript" src="snippet.js"></script><title>Media API</title>
+</head>
+<body id="page-content" onload="prettyPrint()">
+<div class="api" id="::Media">
+<div class="supported-platforms"><img class="mobile-mandatory emulator" title="Mandatory, Supported by Tizen Mobile emulator" src="../mobile_s_w.png"></div>
+<div class="title"><h1>Media API</h1></div>
+<div class="brief">
+ This plugin provides the ability to record and play back audio files on a device.
+ </div>
+<div class="description">
+ <p>
+This plugin defines a global Media Constructor.
+ </p>
+ <p>
+Original documentation: <a href="https://www.npmjs.com/package/cordova-plugin-media">Cordova Media</a>.
+ </p>
+ </div>
+<h2>Table of Contents</h2>
+<ul class="toc">
+<li>1. <a href="#interfaces-section">Interfaces</a><ul class="toc">
+<li>1.1. <a href="#Media">Media</a>
+</li>
+<li>1.2. <a href="#MediaError">MediaError</a>
+</li>
+<li>1.3. <a href="#MediaErrorCallback">MediaErrorCallback</a>
+</li>
+<li>1.4. <a href="#StatusChangeCallback">StatusChangeCallback</a>
+</li>
+<li>1.5. <a href="#PositionSuccessCallback">PositionSuccessCallback</a>
+</li>
+</ul>
+</li>
+<li>2. <a href="#api-features">Related Feature</a>
+</li>
+<li>3. <a href="#full-webidl">Full WebIDL</a>
+</li>
+</ul>
+<hr>
+<h2 id="method-summary">Summary of Interfaces and Methods</h2>
+<table class="informaltable">
+<thead><tr>
+<th>Interface</th>
+<th>Method</th>
+</tr></thead>
+<tbody>
+<tr>
+<td><a href="#Media">Media</a></td>
+<td>
+<div>void <a href="#Media::getCurrentPosition">getCurrentPosition</a> (<a href="#PositionSuccessCallback">PositionSuccessCallback</a> positionSuccessCallback, optional <a href="#MediaErrorCallback">MediaErrorCallback</a> errorCallback)</div>
+<div>double <a href="#Media::getDuration">getDuration</a> ()</div>
+<div>void <a href="#Media::pause">pause</a> ()</div>
+<div>void <a href="#Media::play">play</a> ()</div>
+<div>void <a href="#Media::release">release</a> ()</div>
+<div>void <a href="#Media::seekTo">seekTo</a> (double position)</div>
+<div>void <a href="#Media::setVolume">setVolume</a> (double volume)</div>
+<div>void <a href="#Media::startRecord">startRecord</a> ()</div>
+<div>void <a href="#Media::stopRecord">stopRecord</a> ()</div>
+<div>void <a href="#Media::stop">stop</a> ()</div>
+</td>
+</tr>
+<tr>
+<td><a href="#MediaError">MediaError</a></td>
+<td></td>
+</tr>
+<tr>
+<td><a href="#MediaErrorCallback">MediaErrorCallback</a></td>
+<td><div>void <a href="#MediaErrorCallback::onerror">onerror</a> (<a href="#MediaError">MediaError</a> error)</div></td>
+</tr>
+<tr>
+<td><a href="#StatusChangeCallback">StatusChangeCallback</a></td>
+<td><div>void <a href="#StatusChangeCallback::onchanged">onchanged</a> (short status)</div></td>
+</tr>
+<tr>
+<td><a href="#PositionSuccessCallback">PositionSuccessCallback</a></td>
+<td><div>void <a href="#PositionSuccessCallback::onsuccess">onsuccess</a> (double position)</div></td>
+</tr>
+</tbody>
+</table>
+<div class="interfaces" id="interfaces-section">
+<h2>1. Interfaces</h2>
+<div class="interface" id="Media">
+<a class="backward-compatibility-anchor" name="::Media::Media"></a><h3>1.1. Media</h3>
+<div class="brief">
+ The Media interface provides the audio object.
+ </div>
+<pre class="webidl prettyprint"> [Constructor(DOMString src, optional <a href="cordova.html#SuccessCallback">SuccessCallback</a>? successCallback, optional <a href="#MediaErrorCallback">MediaErrorCallback</a>? errorCallback, optional <a href="#StatusChangeCallback">StatusChangeCallback</a>? mediaStatus)]
+ interface Media {
+ const short MEDIA_NONE = 0;
+ const short MEDIA_STARTING = 1;
+ const short MEDIA_RUNNING = 2;
+ const short MEDIA_PAUSED = 3;
+ const short MEDIA_STOPPED = 4;
+
+ attribute DOMString src;
+
+ attribute <a href="cordova.html#SuccessCallback">SuccessCallback</a>? successCallback;
+
+ attribute <a href="#MediaErrorCallback">MediaErrorCallback</a>? errorCallback;
+
+ attribute <a href="#StatusChangeCallback">StatusChangeCallback</a>? statusCallback;
+
+ void getCurrentPosition(<a href="#PositionSuccessCallback">PositionSuccessCallback</a> positionSuccessCallback, optional <a href="#MediaErrorCallback">MediaErrorCallback</a> errorCallback);
+
+ double getDuration();
+
+ void pause();
+
+ void play();
+
+ void release();
+
+ void seekTo(double position);
+
+ void setVolume(double volume);
+
+ void startRecord();
+
+ void stopRecord();
+
+ void stop();
+ };</pre>
+<div class="example">
+<span class="example"><p>Code example:</p></span><pre name="code" class="examplecode prettyprint"> var myMedia = new Media(src, successCallback, errorCallback, statusCallback);
+ </pre>
+</div>
+<div class="constructors">
+<h4 id="Media::constructor">Constructors</h4>
+<dl>
+<div class="brief">
+ The Media interface provides interface and functions to manage audio objects.
+ </div>
+<pre class="webidl prettyprint">Media(DOMString src, optional <a href="cordova.html#SuccessCallback">SuccessCallback</a>? successCallback, optional <a href="#MediaErrorCallback">MediaErrorCallback</a>? errorCallback, optional <a href="#StatusChangeCallback">StatusChangeCallback</a>? mediaStatus);</pre>
+<div class="description">
+ <ul>
+ <li>
+<b>TypeError</b> <ul>
+ <li>
+ <p>
+ Is thrown if any of the input parameters has incorrect type. </p>
+ </li>
+ </ul>
+ </li>
+ </ul>
+ </div>
+</dl>
+</div>
+<div class="consts">
+<h4>Constants</h4>
+<dl>
+<li class="const" id="Media::MEDIA_NONE">
+<a class="backward-compatibility-anchor" name="::Media::Media::MEDIA_NONE"></a><span class="name">MEDIA_NONE</span><br><br>
+</li>
+<li class="const" id="Media::MEDIA_STARTING">
+<a class="backward-compatibility-anchor" name="::Media::Media::MEDIA_STARTING"></a><span class="name">MEDIA_STARTING</span><br><br>
+</li>
+<li class="const" id="Media::MEDIA_RUNNING">
+<a class="backward-compatibility-anchor" name="::Media::Media::MEDIA_RUNNING"></a><span class="name">MEDIA_RUNNING</span><br><br>
+</li>
+<li class="const" id="Media::MEDIA_PAUSED">
+<a class="backward-compatibility-anchor" name="::Media::Media::MEDIA_PAUSED"></a><span class="name">MEDIA_PAUSED</span><br><br>
+</li>
+<li class="const" id="Media::MEDIA_STOPPED">
+<a class="backward-compatibility-anchor" name="::Media::Media::MEDIA_STOPPED"></a><span class="name">MEDIA_STOPPED</span><div class="brief">
+ Above constants are reported as the only parameter to the mediaStatus callback.
+ </div>
+<p><span class="version">
+ Since: </span>
+ 3.0
+ </p>
+<br><br>
+</li>
+</dl>
+</div>
+<div class="attributes">
+<h4>Attributes</h4>
+<ul>
+<li class="attribute" id="Media::src">
+<span class="attrName"><span class="type">DOMString </span><span class="name">src</span></span><div class="brief">
+ A URI containing the audio content.
+ </div>
+<p><span class="version">
+ Since: </span>
+ 3.0
+ </p>
+</li>
+<li class="attribute" id="Media::successCallback">
+<span class="attrName"><span class="type">SuccessCallback </span><span class="name">successCallback</span><span class="optional"> [nullable]</span></span><div class="brief">
+ The callback that executes after a Media object has completed the current play, record, or stop action.
+ </div>
+<p><span class="version">
+ Since: </span>
+ 3.0
+ </p>
+</li>
+<li class="attribute" id="Media::errorCallback">
+<span class="attrName"><span class="type">MediaErrorCallback </span><span class="name">errorCallback</span><span class="optional"> [nullable]</span></span><div class="brief">
+ The callback that executes if an error occurs.
+ </div>
+<p><span class="version">
+ Since: </span>
+ 3.0
+ </p>
+</li>
+<li class="attribute" id="Media::statusCallback">
+<span class="attrName"><span class="type">StatusChangeCallback </span><span class="name">statusCallback</span><span class="optional"> [nullable]</span></span><div class="brief">
+ The callback that executes to indicate status changes.
+ </div>
+<p><span class="version">
+ Since: </span>
+ 3.0
+ </p>
+</li>
+</ul>
+</div>
+<div class="methods">
+<h4>Methods</h4>
+<dl>
+<dt class="method" id="Media::getCurrentPosition">
+<a class="backward-compatibility-anchor" name="::Media::Media::getCurrentPosition"></a><code><b><span class="methodName">getCurrentPosition</span></b></code>
+</dt>
+<dd>
+<div class="brief">
+ Returns the current position within an audio file in seconds.
+ </div>
+<div class="synopsis"><pre class="signature prettyprint">void getCurrentPosition(<a href="#PositionSuccessCallback">PositionSuccessCallback</a> positionSuccessCallback, optional <a href="#MediaErrorCallback">MediaErrorCallback</a> errorCallback);
+ </pre></div>
+<p><span class="version">
+ Since: </span>
+ 3.0
+ </p>
+<div class="parameters">
+<p><span class="param">Parameters:</span></p>
+<ul>
+ <li class="param">
+<span class="name">positionSuccessCallback</span>:
+ The callback that is passed the current position in seconds.
+ </li>
+ <li class="param">
+<span class="name">errorCallback</span><span class="optional"> [optional]</span>:
+ The callback to execute if an error occurs.
+ </li>
+ </ul>
+</div>
+<div class="example">
+<span class="example"><p>Code example:</p></span><pre name="code" class="examplecode prettyprint"> successCallback = function() {
+ console.log('Audio file has been played back.');
+ }
+
+ errorCallback = function(err) {
+ console.log('Error occurred ' + err.message);
+ }
+
+ positionSuccessCallback = function(position) {
+ console.log('Current position is ' + position);
+ }
+
+ var src = 'file:///home/app/content/Documents/play.mp3';
+ var myMedia = new Media(src, successCallback, errorCallback);
+
+ myMedia.play();
+
+ setTimeout(function() {
+ myMedia.getCurrentPosition(positionSuccessCallback);
+ }, 2000);
+
+ </pre>
+</div>
+<div class="output">
+<span class="title"><p>Output example:</p></span><pre>Audio file has been played back.
+Current position is 2.000
+</pre>
+</div>
+</dd>
+<dt class="method" id="Media::getDuration">
+<a class="backward-compatibility-anchor" name="::Media::Media::getDuration"></a><code><b><span class="methodName">getDuration</span></b></code>
+</dt>
+<dd>
+<div class="brief">
+ Returns the duration of an audio file in seconds. If the duration is unknown, it returns a value of -1.
+ </div>
+<div class="synopsis"><pre class="signature prettyprint">double getDuration();
+ </pre></div>
+<p><span class="version">
+ Since: </span>
+ 3.0
+ </p>
+<div class="example">
+<span class="example"><p>Code example:</p></span><pre name="code" class="examplecode prettyprint"> successCallback = function() {
+ console.log('Audio file has been played back.);
+ }
+
+ errorCallback = function(err) {
+ console.log('Error occurred ' + err.message);
+ }
+
+ var src = 'file:///home/app/content/Documents/play.mp3';
+ var myMedia = new Media(src, successCallback, errorCallback);
+
+ var duration = myMedia.getDuration();
+ console.log('Audio duration is ' + duration);
+ </pre>
+</div>
+<div class="output">
+<span class="title"><p>Output example:</p></span><pre>Audio duration is 281.035
+</pre>
+</div>
+</dd>
+<dt class="method" id="Media::pause">
+<a class="backward-compatibility-anchor" name="::Media::Media::pause"></a><code><b><span class="methodName">pause</span></b></code>
+</dt>
+<dd>
+<div class="brief">
+ Pauses playing an audio file.
+ </div>
+<div class="synopsis"><pre class="signature prettyprint">void pause();
+ </pre></div>
+<p><span class="version">
+ Since: </span>
+ 3.0
+ </p>
+<div class="example">
+<span class="example"><p>Code example:</p></span><pre name="code" class="examplecode prettyprint"> successCallback = function() {
+ console.log('Audio file has been played back.');
+ }
+
+ errorCallback = function(err) {
+ console.log('Error occurred ' + err.message);
+ }
+
+ statusCallback = function(status) {
+ if (status == Media.MEDIA_PAUSED) {
+ console.log('Audio file has been paused');
+ }
+ }
+
+ var src = 'file:///home/app/content/Documents/play.mp3';
+ var myMedia = new Media(src, successCallback, errorCallback, statusCallback);
+
+ myMedia.play();
+
+ //Pause after 2 seconds
+ setTimeout(function() {
+ myMedia.pause();
+ }, 2000);
+
+ </pre>
+</div>
+<div class="output">
+<span class="title"><p>Output example:</p></span><pre>Audio file has been paused.
+</pre>
+</div>
+</dd>
+<dt class="method" id="Media::play">
+<a class="backward-compatibility-anchor" name="::Media::Media::play"></a><code><b><span class="methodName">play</span></b></code>
+</dt>
+<dd>
+<div class="brief">
+ Starts or resumes playing an audio file.
+ </div>
+<div class="synopsis"><pre class="signature prettyprint">void play();
+ </pre></div>
+<p><span class="version">
+ Since: </span>
+ 3.0
+ </p>
+<div class="example">
+<span class="example"><p>Code example:</p></span><pre name="code" class="examplecode prettyprint"> successCallback = function() {
+ console.log('Audio file has been played back.');
+ }
+
+ errorCallback = function(err) {
+ console.log('Error occurred ' + err.message);
+ }
+
+ var src = 'file:///home/app/content/Documents/play.mp3';
+ var myMedia = new Media(src, successCallback, errorCallback);
+
+ myMedia.play();
+ </pre>
+</div>
+<div class="output">
+<span class="title"><p>Output example:</p></span><pre>Audio file has been played back.
+</pre>
+</div>
+</dd>
+<dt class="method" id="Media::release">
+<a class="backward-compatibility-anchor" name="::Media::Media::release"></a><code><b><span class="methodName">release</span></b></code>
+</dt>
+<dd>
+<div class="brief">
+ Releases the underlying operating system's audio resources.
+Applications should call the release function for any Media resource that is no longer needed.
+ </div>
+<div class="synopsis"><pre class="signature prettyprint">void release();
+ </pre></div>
+<p><span class="version">
+ Since: </span>
+ 3.0
+ </p>
+<div class="example">
+<span class="example"><p>Code example:</p></span><pre name="code" class="examplecode prettyprint"> successCallback = function() {
+ console.log('Audio file has been stopped or released.');
+ }
+
+ errorCallback = function(err) {
+ console.log('An error occurred: ' + err.message);
+ }
+
+ var src = 'file://home/app/content/Documents/play.mp3';
+ var myMedia = new Media(src, successCallback, errorCallback);
+
+ myMedia.play();
+ myMedia.stop();
+ myMedia.release();
+ </pre>
+</div>
+<div class="output">
+<span class="title"><p>Output example:</p></span><pre>Audio file has been stopped or released.
+Audio file has been stopped or released.
+</pre>
+</div>
+</dd>
+<dt class="method" id="Media::seekTo">
+<a class="backward-compatibility-anchor" name="::Media::Media::seekTo"></a><code><b><span class="methodName">seekTo</span></b></code>
+</dt>
+<dd>
+<div class="brief">
+ Sets the current position within an audio file.
+ </div>
+<div class="synopsis"><pre class="signature prettyprint">void seekTo(double position);
+ </pre></div>
+<p><span class="version">
+ Since: </span>
+ 3.0
+ </p>
+<div class="parameters">
+<p><span class="param">Parameters:</span></p>
+<ul>
+ <li class="param">
+<span class="name">position</span>:
+ The position to set the playback position within the audio, in milliseconds.
+ </li>
+ </ul>
+</div>
+<div class="example">
+<span class="example"><p>Code example:</p></span><pre name="code" class="examplecode prettyprint"> successCallback = function() {
+ console.log('Audio file has been played back.');
+ }
+
+ errorCallback = function(err) {
+ console.log('An error occurred: ' + err.message);
+ }
+
+ var src = 'file://home/app/content/Documents/play.mp3';
+ var myMedia = new Media(src, successCallback, errorCallback);
+
+ myMedia.play();
+
+ //SeekTo to 10 seconds after 5 seconds
+ setTimeout(function() {
+ myMedia.seekTo(10000);
+ console.log('Playback position has been set to 10 seconds.');
+ }, 5000);
+ </pre>
+</div>
+<div class="output">
+<span class="title"><p>Output example:</p></span><pre>Playback position has been set to 10 seconds.
+Audio file has been played back.
+</pre>
+</div>
+</dd>
+<dt class="method" id="Media::setVolume">
+<a class="backward-compatibility-anchor" name="::Media::Media::setVolume"></a><code><b><span class="methodName">setVolume</span></b></code>
+</dt>
+<dd>
+<div class="brief">
+ Set the volume for an audio file.
+ </div>
+<div class="synopsis"><pre class="signature prettyprint">void setVolume(double volume);
+ </pre></div>
+<p><span class="version">
+ Since: </span>
+ 3.0
+ </p>
+<p><span class="privilegelevel">
+ Privilege level: </span>
+ public
+ </p>
+<p><span class="privilege">
+ Privilege: </span>
+ http://tizen.org/privilege/volume.set
+ </p>
+<div class="parameters">
+<p><span class="param">Parameters:</span></p>
+<ul>
+ <li class="param">
+<span class="name">volume</span>:
+ The volume to set for playback. The value must be within the range of 0.0 to 1.0.
+ </li>
+ </ul>
+</div>
+<div class="example">
+<span class="example"><p>Code example:</p></span><pre name="code" class="examplecode prettyprint"> successCallback = function() {
+ console.log('Audio file has been played back.');
+ }
+
+ errorCallback = function(err) {
+ console.log('Error occurred ' + err.message);
+ }
+
+ var src = 'file://home/app/content/Documents/play.mp3';
+ var myMedia = new Media(src, successCallback, errorCallback);
+
+ myMedia.play();
+
+ // Mute volume after 2 seconds
+ setTimeout(function() {
+ myMedia.setVolume(0.0);
+ console.log('Playback volume has been muted.');
+ }, 2000);
+
+ // Set volume to 1.0 after 5 seconds
+ setTimeout(function() {
+ myMedia.setVolume(1.0);
+ console.log('Playback volume has been set to 1.0.');
+ }, 5000);
+ </pre>
+</div>
+<div class="output">
+<span class="title"><p>Output example:</p></span><pre>Playback volume has been muted.
+Playback volume has been set to 1.0.
+Audio file has been played back.
+</pre>
+</div>
+</dd>
+<dt class="method" id="Media::startRecord">
+<a class="backward-compatibility-anchor" name="::Media::Media::startRecord"></a><code><b><span class="methodName">startRecord</span></b></code>
+</dt>
+<dd>
+<div class="brief">
+ Starts recording an audio file.
+ </div>
+<div class="synopsis"><pre class="signature prettyprint">void startRecord();
+ </pre></div>
+<p><span class="version">
+ Since: </span>
+ 3.0
+ </p>
+<p><span class="privilegelevel">
+ Privilege level: </span>
+ public
+ </p>
+<p><span class="privilege">
+ Privilege: </span>
+ http://tizen.org/privilege/mediacapture
+ </p>
+<div class="example">
+<span class="example"><p>Code example:</p></span><pre name="code" class="examplecode prettyprint"> successCallback = function() {
+ console.log('Started recording an audio file.');
+ }
+
+ errorCallback = function(err) {
+ console.log('Error occurred ' + err.message);
+ }
+
+ var src = 'recordAudio.mp3';
+ var myRecMedia = new Media(src, successCallback, errorCallback);
+
+ myRecMedia.startRecord();
+ </pre>
+</div>
+<div class="output">
+<span class="title"><p>Output example:</p></span><pre>Started recording an audio file.
+</pre>
+</div>
+</dd>
+<dt class="method" id="Media::stopRecord">
+<a class="backward-compatibility-anchor" name="::Media::Media::stopRecord"></a><code><b><span class="methodName">stopRecord</span></b></code>
+</dt>
+<dd>
+<div class="brief">
+ Stops recording an audio file.
+ </div>
+<div class="synopsis"><pre class="signature prettyprint">void stopRecord();
+ </pre></div>
+<p><span class="version">
+ Since: </span>
+ 3.0
+ </p>
+<p><span class="privilegelevel">
+ Privilege level: </span>
+ public
+ </p>
+<p><span class="privilege">
+ Privilege: </span>
+ http://tizen.org/privilege/mediacapture
+ </p>
+<div class="example">
+<span class="example"><p>Code example:</p></span><pre name="code" class="examplecode prettyprint"> successCallback = function() {
+ console.log('Started recording an audio file.');
+ }
+
+ errorCallback = function(err) {
+ console.log('Error occurred ' + err.message);
+ }
+
+ var src = 'recordAudio.mp3';
+ var myRecMedia = new Media(src, successCallback, errorCallback);
+
+ myRecMedia.startRecord();
+
+ // Stop recording after 10 seconds
+ setTimeout(function() {
+ myRecMedia.stopRecord();
+ console.log('Stopped recording an audio file.');
+ }, 10000);
+ </pre>
+</div>
+<div class="output">
+<span class="title"><p>Output example:</p></span><pre>Started recording an audio file.
+Stopped recording an audio file.
+</pre>
+</div>
+</dd>
+<dt class="method" id="Media::stop">
+<a class="backward-compatibility-anchor" name="::Media::Media::stop"></a><code><b><span class="methodName">stop</span></b></code>
+</dt>
+<dd>
+<div class="brief">
+ Stops playing an audio file.
+ </div>
+<div class="synopsis"><pre class="signature prettyprint">void stop();
+ </pre></div>
+<p><span class="version">
+ Since: </span>
+ 3.0
+ </p>
+<div class="example">
+<span class="example"><p>Code example:</p></span><pre name="code" class="examplecode prettyprint"> successCallback = function() {
+ console.log('Audio file has been stopped.');
+ }
+
+ errorCallback = function(err) {
+ console.log('Error occurred ' + err.message);
+ }
+
+ var src = 'file://home/app/content/Documents/play.mp3';
+ var myMedia = new Media(src, successCallback, errorCallback);
+
+ myMedia.play();
+
+ // Stop after 10 seconds
+ setTimeout(function() {
+ myMedia.stop();
+ }, 10000);
+ </pre>
+</div>
+<div class="output">
+<span class="title"><p>Output example:</p></span><pre>Audio playback has been stopped.
+</pre>
+</div>
+</dd>
+</dl>
+</div>
+</div>
+<div class="interface" id="MediaError">
+<a class="backward-compatibility-anchor" name="::Media::MediaError"></a><h3>1.2. MediaError</h3>
+<div class="brief">
+ A <em>MediaError</em> object is returned to the <a href="media.html#MediaErrorCallback">MediaErrorCallback</a> function when an error occurs.
+ </div>
+<pre class="webidl prettyprint"> interface MediaError {
+ const short MEDIA_ERR_ABORTED = 1;
+ const short MEDIA_ERR_NETWORK = 2;
+ const short MEDIA_ERR_DECODE = 3;
+ const short MEDIA_ERR_NONE_SUPPORTED = 4;
+
+ readonly attribute short code;
+ };</pre>
+<div class="attributes">
+<h4>Attributes</h4>
+<ul><li class="attribute" id="MediaError::code">
+<span class="attrName"><span class="readonly"> readonly
+</span><span class="type">short </span><span class="name">code</span></span><div class="brief">
+ One of the predefined error codes listed above.
+ </div>
+<p><span class="version">
+ Since: </span>
+ 3.0
+ </p>
+</li></ul>
+</div>
+</div>
+<div class="interface" id="MediaErrorCallback">
+<a class="backward-compatibility-anchor" name="::Media::MediaErrorCallback"></a><h3>1.3. MediaErrorCallback</h3>
+<div class="brief">
+ Basic error callback.
+ </div>
+<pre class="webidl prettyprint"> [Callback=FunctionOnly,NoInterfaceObject] interface MediaErrorCallback {
+ void onerror(<a href="#MediaError">MediaError</a> error);
+ };</pre>
+<div class="methods">
+<h4>Methods</h4>
+<dl>
+<dt class="method" id="MediaErrorCallback::onerror">
+<a class="backward-compatibility-anchor" name="::Media::MediaErrorCallback::onerror"></a><code><b><span class="methodName">onerror</span></b></code>
+</dt>
+<dd>
+<div class="brief">
+ Success
+ </div>
+<div class="synopsis"><pre class="signature prettyprint">void onerror(<a href="#MediaError">MediaError</a> error);
+ </pre></div>
+<p><span class="version">
+ Since: </span>
+ 3.0
+ </p>
+<div class="parameters">
+<p><span class="param">Parameters:</span></p>
+<ul>
+ <li class="param">
+<span class="name">error</span>:
+ Error object containing some information about the error.
+ </li>
+ </ul>
+</div>
+</dd>
+</dl>
+</div>
+</div>
+<div class="interface" id="StatusChangeCallback">
+<a class="backward-compatibility-anchor" name="::Media::StatusChangeCallback"></a><h3>1.4. StatusChangeCallback</h3>
+<div class="brief">
+ The callback function used to return status of the Media object.
+ </div>
+<pre class="webidl prettyprint"> [Callback=FunctionOnly, NoInterfaceObject] interface StatusChangeCallback {
+ void onchanged(short status);
+ };</pre>
+<div class="methods">
+<h4>Methods</h4>
+<dl>
+<dt class="method" id="StatusChangeCallback::onchanged">
+<a class="backward-compatibility-anchor" name="::Media::StatusChangeCallback::onchanged"></a><code><b><span class="methodName">onchanged</span></b></code>
+</dt>
+<dd>
+<div class="brief">
+ Called when the status of the <em>Media</em> object has been changed.
+ </div>
+<div class="synopsis"><pre class="signature prettyprint">void onchanged(short status);
+ </pre></div>
+<p><span class="version">
+ Since: </span>
+ 3.0
+ </p>
+<div class="parameters">
+<p><span class="param">Parameters:</span></p>
+<ul>
+ <li class="param">
+<span class="name">status</span>:
+ The status of the <a href="media.html#Media">Media</a> object. It is equal to one of the Media interface constant: MEDIA_NONE, MEDIA_STARTING, MEDIA_RUNNING, MEDIA_PAUSED or MEDIA_STOPPED.
+ </li>
+ </ul>
+</div>
+</dd>
+</dl>
+</div>
+</div>
+<div class="interface" id="PositionSuccessCallback">
+<a class="backward-compatibility-anchor" name="::Media::PositionSuccessCallback"></a><h3>1.5. PositionSuccessCallback</h3>
+<div class="brief">
+ The callback function used to return current position of the Media object.
+ </div>
+<pre class="webidl prettyprint"> [Callback=FunctionOnly, NoInterfaceObject] interface PositionSuccessCallback {
+ void onsuccess(double position);
+ };</pre>
+<div class="methods">
+<h4>Methods</h4>
+<dl>
+<dt class="method" id="PositionSuccessCallback::onsuccess">
+<a class="backward-compatibility-anchor" name="::Media::PositionSuccessCallback::onsuccess"></a><code><b><span class="methodName">onsuccess</span></b></code>
+</dt>
+<dd>
+<div class="brief">
+ Called when getting current position of the media file is retrieved successfully.
+ </div>
+<div class="synopsis"><pre class="signature prettyprint">void onsuccess(double position);
+ </pre></div>
+<p><span class="version">
+ Since: </span>
+ 3.0
+ </p>
+<div class="parameters">
+<p><span class="param">Parameters:</span></p>
+<ul>
+ <li class="param">
+<span class="name">position</span>:
+ The current position of the media file.
+ </li>
+ </ul>
+</div>
+</dd>
+</dl>
+</div>
+</div>
+</div>
+<h2 id="api-features">2. Related Feature</h2>
+<div id="def-api-features" class="def-api-features">
+ You can check if this API is supported with <em>tizen.systeminfo.getCapability()</em> and decide enable/disable codes that need this API.
+ <div class="def-api-feature">
+<p><div class="description">
+ <p>
+If an application uses startRecord() or stopRecord(), declare the following feature requirements in the config file:
+ </p>
+ </div></p>
+<li class="feature">http://tizen.org/feature/microphone</li>
+</div>
+<div class="def-api-feature">
+<p></p>
+<li class="feature">http://tizen.org/feature/camera</li>
+</div>
+<div class="def-api-feature">
+<p></p>
+<li class="feature">http://tizen.org/feature/media.audio_recording</li>
+</div>
+<p></p>
+ For more information, see <a href="../../org.tizen.gettingstarted/html/tizen_overview/application_filtering.htm">Application Filtering.</a>
+</div>
+<h2 id="full-webidl">3. Full WebIDL</h2>
+<pre class="webidl prettyprint">module Media {
+ [Constructor(DOMString src, optional <a href="cordova.html#SuccessCallback">SuccessCallback</a>? successCallback, optional <a href="#MediaErrorCallback">MediaErrorCallback</a>? errorCallback, optional <a href="#StatusChangeCallback">StatusChangeCallback</a>? mediaStatus)]
+ interface Media {
+ const short MEDIA_NONE = 0;
+ const short MEDIA_STARTING = 1;
+ const short MEDIA_RUNNING = 2;
+ const short MEDIA_PAUSED = 3;
+ const short MEDIA_STOPPED = 4;
+
+ attribute DOMString src;
+
+ attribute <a href="cordova.html#SuccessCallback">SuccessCallback</a>? successCallback;
+
+ attribute <a href="#MediaErrorCallback">MediaErrorCallback</a>? errorCallback;
+
+ attribute <a href="#StatusChangeCallback">StatusChangeCallback</a>? statusCallback;
+
+ void getCurrentPosition(<a href="#PositionSuccessCallback">PositionSuccessCallback</a> positionSuccessCallback, optional <a href="#MediaErrorCallback">MediaErrorCallback</a> errorCallback);
+
+ double getDuration();
+
+ void pause();
+
+ void play();
+
+ void release();
+
+ void seekTo(double position);
+
+ void setVolume(double volume);
+
+ void startRecord();
+
+ void stopRecord();
+
+ void stop();
+ };
+
+ interface MediaError {
+ const short MEDIA_ERR_ABORTED = 1;
+ const short MEDIA_ERR_NETWORK = 2;
+ const short MEDIA_ERR_DECODE = 3;
+ const short MEDIA_ERR_NONE_SUPPORTED = 4;
+
+ readonly attribute short code;
+ };
+
+ [Callback=FunctionOnly,NoInterfaceObject] interface MediaErrorCallback {
+ void onerror(<a href="#MediaError">MediaError</a> error);
+ };
+
+ [Callback=FunctionOnly, NoInterfaceObject] interface StatusChangeCallback {
+ void onchanged(short status);
+ };
+
+ [Callback=FunctionOnly, NoInterfaceObject] interface PositionSuccessCallback {
+ void onsuccess(double position);
+ };
+};</pre>
+</div>
+<div id="page-footer">
+<div class="copyright" align="center">
+ Except as noted, this content - excluding the Code Examples - is licensed under <a href="http://creativecommons.org/licenses/by/3.0/legalcode" target="_blank">Creative Commons Attribution 3.0</a> and all of the Code Examples contained herein are licensed under <a href="https://www.tizen.org/bsd-3-clause-license" target="_blank">BSD-3-Clause</a>. <br>For details, see the <a href="https://www.tizen.org/content-license" target="_blank">Content License</a>.
+ </div>
+<script type="text/javascript">
+
+ var _gaq = _gaq || [];
+ _gaq.push(['_setAccount', 'UA-25976949-1']);
+ _gaq.push(['_setDomainName', 'tizen.org']);
+ _gaq.push(['_trackPageview']);
+
+ (function() {
+ var ga = document.createElement('script'); ga.type = 'text/javascript'; ga.async = true;
+ var s = document.getElementsByTagName('script')[0]; s.parentNode.insertBefore(ga, s);
+ })();
+
+ </script>
+</div>
+</body>
+</html>
--- /dev/null
+<!DOCTYPE html PUBLIC "html">
+<html>
+<head>
+<meta http-equiv="Content-Type" content="text/html; charset=utf-8">
+<link rel="stylesheet" type="text/css" href="../tizen.css" media="screen">
+<script type="text/javascript" src="snippet.js"></script><title>NetworkInformation API</title>
+</head>
+<body id="page-content" onload="prettyPrint()">
+<div class="api" id="::NetworkInformation">
+<div class="supported-platforms"><img class="mobile-mandatory emulator" title="Mandatory, Supported by Tizen Mobile emulator" src="../mobile_s_w.png"></div>
+<div class="title"><h1>NetworkInformation API</h1></div>
+<div class="brief">
+ This plugin provides information about the device's cellular and wifi connection, and whether the device has an internet connection.
+ </div>
+<div class="description">
+ <p>
+Original documentation: <a href="https://www.npmjs.com/package/cordova-plugin-network-information">Cordova Network Information</a>.
+ </p>
+ </div>
+<h2>Table of Contents</h2>
+<ul class="toc">
+<li>1. <a href="#interfaces-section">Interfaces</a><ul class="toc">
+<li>1.1. <a href="#NetworkInformationManagerObject">NetworkInformationManagerObject</a>
+</li>
+<li>1.2. <a href="#NetworkInformationManager">NetworkInformationManager</a>
+</li>
+<li>1.3. <a href="#Connection">Connection</a>
+</li>
+<li>1.4. <a href="#OnlineEventCallback">OnlineEventCallback</a>
+</li>
+<li>1.5. <a href="#OfflineEventCallback">OfflineEventCallback</a>
+</li>
+</ul>
+</li>
+<li>2. <a href="#api-features">Related Feature</a>
+</li>
+<li>3. <a href="#full-webidl">Full WebIDL</a>
+</li>
+</ul>
+<hr>
+<h2 id="method-summary">Summary of Interfaces and Methods</h2>
+<table class="informaltable">
+<thead><tr>
+<th>Interface</th>
+<th>Method</th>
+</tr></thead>
+<tbody>
+<tr>
+<td><a href="#NetworkInformationManagerObject">NetworkInformationManagerObject</a></td>
+<td></td>
+</tr>
+<tr>
+<td><a href="#NetworkInformationManager">NetworkInformationManager</a></td>
+<td></td>
+</tr>
+<tr>
+<td><a href="#Connection">Connection</a></td>
+<td></td>
+</tr>
+<tr>
+<td><a href="#OnlineEventCallback">OnlineEventCallback</a></td>
+<td><div>void <a href="#OnlineEventCallback::online">online</a> ()</div></td>
+</tr>
+<tr>
+<td><a href="#OfflineEventCallback">OfflineEventCallback</a></td>
+<td><div>void <a href="#OfflineEventCallback::offline">offline</a> ()</div></td>
+</tr>
+</tbody>
+</table>
+<div class="interfaces" id="interfaces-section">
+<h2>1. Interfaces</h2>
+<div class="interface" id="NetworkInformationManagerObject">
+<a class="backward-compatibility-anchor" name="::NetworkInformation::NetworkInformationManagerObject"></a><h3>1.1. NetworkInformationManagerObject</h3>
+<div class="brief">
+ The <em>NetworkInformationManagerObject</em> interface defines what is instantiated in the <em>Navigator</em> object.
+ </div>
+<pre class="webidl prettyprint"> [NoInterfaceObject] interface NetworkInformationManagerObject {
+ readonly attribute <a href="#NetworkInformationManager">NetworkInformationManager</a> connection;
+ };</pre>
+<pre class="webidl prettyprint"> implements <a href="#NetworkInformationManagerObject">NetworkInformationManagerObject</a>;</pre>
+<div class="description">
+ <p>
+The <em>navigator.connection</em> object allows access to the NetworkInformation API.
+ </p>
+ </div>
+</div>
+<div class="interface" id="NetworkInformationManager">
+<a class="backward-compatibility-anchor" name="::NetworkInformation::NetworkInformationManager"></a><h3>1.2. NetworkInformationManager</h3>
+<div class="brief">
+ The <em>NetworkInformationManager</em> interface provides methods for global operations related to notifications to the user.
+ </div>
+<pre class="webidl prettyprint"> [NoInterfaceObject] interface NetworkInformationManager {
+ readonly attribute DOMString type;
+ };</pre>
+<div class="attributes">
+<h4>Attributes</h4>
+<ul><li class="attribute" id="NetworkInformationManager::type">
+<span class="attrName"><span class="readonly"> readonly
+</span><span class="type">DOMString </span><span class="name">type</span></span><div class="brief">
+ Returns the current connection type. The value returned is one of the following strings, case-sensitively: unknown, ethernet, wifi, 2g, 3g, 4g, none.
+ </div>
+<p><span class="version">
+ Since: </span>
+ 3.0
+ </p>
+<p><span class="privilegelevel">
+ Privilege level: </span>
+ public
+ </p>
+<p><span class="privilege">
+ Privilege: </span>
+ http://tizen.org/privilege/telephony
+ </p>
+<div class="example">
+<span class="example"><p>Code example:</p></span><pre name="code" class="examplecode prettyprint"> function checkConnection() {
+ var networkState = navigator.connection.type;
+
+ var states = {};
+ states[Connection.UNKNOWN] = 'Unknown connection';
+ states[Connection.ETHERNET] = 'Ethernet connection';
+ states[Connection.WIFI] = 'WiFi connection';
+ states[Connection.CELL_2G] = 'Cell 2G connection';
+ states[Connection.CELL_3G] = 'Cell 3G connection';
+ states[Connection.CELL_4G] = 'Cell 4G connection';
+ states[Connection.CELL] = 'Cell generic connection';
+ states[Connection.NONE] = 'No network connection';
+ alert('Connection type: ' + states[networkState]);
+ }
+
+ checkConnection();
+ </pre>
+</div>
+<div class="output">
+<span class="title"><p>Output example:</p></span><pre>Connection type: Cell 3G connection
+</pre>
+</div>
+</li></ul>
+</div>
+</div>
+<div class="interface" id="Connection">
+<a class="backward-compatibility-anchor" name="::NetworkInformation::Connection"></a><h3>1.3. Connection</h3>
+<div class="brief">
+ The <em>Connection</em> is available as window attribute.
+ </div>
+<pre class="webidl prettyprint"> interface Connection {
+ readonly attribute DOMString UNKNOWN;
+ readonly attribute DOMString ETHERNET;
+ readonly attribute DOMString WIFI;
+ readonly attribute DOMString CELL_2G;
+ readonly attribute DOMString CELL_3G;
+ readonly attribute DOMString CELL_4G;
+ readonly attribute DOMString CELL;
+ readonly attribute DOMString NONE;
+ };</pre>
+<div class="attributes">
+<h4>Attributes</h4>
+<ul>
+<li class="attribute" id="Connection::UNKNOWN">
+<span class="attrName"><span class="readonly"> readonly
+</span><span class="type">DOMString </span><span class="name">UNKNOWN</span></span><div class="brief">
+ The value returned is 'unknown'.
+ </div>
+<p><span class="version">
+ Since: </span>
+ 3.0
+ </p>
+<div class="example">
+<span class="example"><p>Code example:</p></span><pre name="code" class="examplecode prettyprint"> console.log(Connection.UNKNOWN);
+ </pre>
+</div>
+<div class="output">
+<span class="title"><p>Output example:</p></span><pre>unknown
+</pre>
+</div>
+</li>
+<li class="attribute" id="Connection::ETHERNET">
+<span class="attrName"><span class="readonly"> readonly
+</span><span class="type">DOMString </span><span class="name">ETHERNET</span></span><div class="brief">
+ The value returned is 'ethernet'.
+ </div>
+<p><span class="version">
+ Since: </span>
+ 3.0
+ </p>
+<div class="example">
+<span class="example"><p>Code example:</p></span><pre name="code" class="examplecode prettyprint"> console.log(Connection.ETHERNET);
+ </pre>
+</div>
+<div class="output">
+<span class="title"><p>Output example:</p></span><pre>ethernet
+</pre>
+</div>
+</li>
+<li class="attribute" id="Connection::WIFI">
+<span class="attrName"><span class="readonly"> readonly
+</span><span class="type">DOMString </span><span class="name">WIFI</span></span><div class="brief">
+ The value returned is 'wifi'.
+ </div>
+<p><span class="version">
+ Since: </span>
+ 3.0
+ </p>
+<div class="example">
+<span class="example"><p>Code example:</p></span><pre name="code" class="examplecode prettyprint"> console.log(Connection.WIFI);
+ </pre>
+</div>
+<div class="output">
+<span class="title"><p>Output example:</p></span><pre>wifi
+</pre>
+</div>
+</li>
+<li class="attribute" id="Connection::CELL_2G">
+<span class="attrName"><span class="readonly"> readonly
+</span><span class="type">DOMString </span><span class="name">CELL_2G</span></span><div class="brief">
+ The value returned is '2g'.
+ </div>
+<p><span class="version">
+ Since: </span>
+ 3.0
+ </p>
+<div class="example">
+<span class="example"><p>Code example:</p></span><pre name="code" class="examplecode prettyprint"> console.log(Connection.CELL_2G);
+ </pre>
+</div>
+<div class="output">
+<span class="title"><p>Output example:</p></span><pre>2g
+</pre>
+</div>
+</li>
+<li class="attribute" id="Connection::CELL_3G">
+<span class="attrName"><span class="readonly"> readonly
+</span><span class="type">DOMString </span><span class="name">CELL_3G</span></span><div class="brief">
+ The value returned is '3g'.
+ </div>
+<p><span class="version">
+ Since: </span>
+ 3.0
+ </p>
+<div class="example">
+<span class="example"><p>Code example:</p></span><pre name="code" class="examplecode prettyprint"> console.log(Connection.CELL_3G);
+ </pre>
+</div>
+<div class="output">
+<span class="title"><p>Output example:</p></span><pre>3g
+</pre>
+</div>
+</li>
+<li class="attribute" id="Connection::CELL_4G">
+<span class="attrName"><span class="readonly"> readonly
+</span><span class="type">DOMString </span><span class="name">CELL_4G</span></span><div class="brief">
+ The value returned is '4g'.
+ </div>
+<p><span class="version">
+ Since: </span>
+ 3.0
+ </p>
+<div class="example">
+<span class="example"><p>Code example:</p></span><pre name="code" class="examplecode prettyprint"> console.log(Connection.CELL_4G);
+ </pre>
+</div>
+<div class="output">
+<span class="title"><p>Output example:</p></span><pre>4g
+</pre>
+</div>
+</li>
+<li class="attribute" id="Connection::CELL">
+<span class="attrName"><span class="readonly"> readonly
+</span><span class="type">DOMString </span><span class="name">CELL</span></span><div class="brief">
+ The value returned is 'cellular'.
+ </div>
+<p><span class="version">
+ Since: </span>
+ 3.0
+ </p>
+<div class="example">
+<span class="example"><p>Code example:</p></span><pre name="code" class="examplecode prettyprint"> console.log(Connection.CELL);
+ </pre>
+</div>
+<div class="output">
+<span class="title"><p>Output example:</p></span><pre>cellular
+</pre>
+</div>
+</li>
+<li class="attribute" id="Connection::NONE">
+<span class="attrName"><span class="readonly"> readonly
+</span><span class="type">DOMString </span><span class="name">NONE</span></span><div class="brief">
+ The value returned is 'none'.
+ </div>
+<p><span class="version">
+ Since: </span>
+ 3.0
+ </p>
+<div class="example">
+<span class="example"><p>Code example:</p></span><pre name="code" class="examplecode prettyprint"> console.log(Connection.NONE);
+ </pre>
+</div>
+<div class="output">
+<span class="title"><p>Output example:</p></span><pre>none
+</pre>
+</div>
+</li>
+</ul>
+</div>
+</div>
+<div class="interface" id="OnlineEventCallback">
+<a class="backward-compatibility-anchor" name="::NetworkInformation::OnlineEventCallback"></a><h3>1.4. OnlineEventCallback</h3>
+<div class="brief">
+ Callback for the event when an application goes online, and the device becomes connected to the Internet.
+ </div>
+<pre class="webidl prettyprint"> [NoInterfaceObject, Callback=FunctionOnly]
+ interface OnlineEventCallback {
+ void online();
+ };</pre>
+<p><span class="version">
+ Since: </span>
+ 3.0
+ </p>
+<div class="description">
+ <p>
+The <var>online</var> event fires when an application goes online, and the device becomes connected to the Internet.
+ </p>
+ <p>
+Applications typically should use document.addEventListener() to attach an event listener once the <a href="events.html#DeviceReadyEventCallback">deviceready</a> event fires.
+ </p>
+ <p>
+Original documentation: <a href="https://www.npmjs.com/package/cordova-plugin-network-information#online">Cordova online event</a> </p>
+ </div>
+<div class="example">
+<span class="example"><p>Code example:</p></span><pre name="code" class="examplecode prettyprint"> document.addEventListener('deviceready', onDeviceReady, false);
+
+ function onDeviceReady() {
+ document.addEventListener('online', onOnline, false);
+ }
+
+ function onOnline() {
+ // Handle the online event
+ }
+ </pre>
+</div>
+</div>
+<div class="interface" id="OfflineEventCallback">
+<a class="backward-compatibility-anchor" name="::NetworkInformation::OfflineEventCallback"></a><h3>1.5. OfflineEventCallback</h3>
+<div class="brief">
+ Callback for the event when an application goes offline, and the device is not connected to the Internet.
+ </div>
+<pre class="webidl prettyprint"> [NoInterfaceObject, Callback=FunctionOnly]
+ interface OfflineEventCallback {
+ void offline();
+ };</pre>
+<p><span class="version">
+ Since: </span>
+ 3.0
+ </p>
+<div class="description">
+ <p>
+The <var>online</var> event fires when an application goes online, and the device becomes connected to the Internet.
+ </p>
+ <p>
+Applications typically should use document.addEventListener() to attach an event listener once the <a href="events.html#DeviceReadyEventCallback">deviceready</a> event fires.
+ </p>
+ <p>
+Original documentation: <a href="https://www.npmjs.com/package/cordova-plugin-network-information#offline">Cordova offline event</a> </p>
+ </div>
+<div class="example">
+<span class="example"><p>Code example:</p></span><pre name="code" class="examplecode prettyprint"> document.addEventListener('deviceready', onDeviceReady, false);
+
+ function onDeviceReady() {
+ document.addEventListener('offline', onOffline, false);
+ }
+
+ function onOffline() {
+ // Handle the offline event
+ }
+ </pre>
+</div>
+</div>
+</div>
+<h2 id="api-features">2. Related Feature</h2>
+<div id="def-api-features" class="def-api-features">
+ You can check if this API is supported with <em>tizen.systeminfo.getCapability()</em> and decide enable/disable codes that need this API.
+ <div class="def-api-feature">
+<p><div class="description">
+ <p>
+To guarantee that the NetworkInformation application runs on a device with the NetworkInformation feature declare the following feature requirements in the config file:
+ </p>
+ </div></p>
+<li class="feature">http://tizen.org/feature/network.telephony</li>
+</div>
+<p></p>
+ For more information, see <a href="../../org.tizen.gettingstarted/html/tizen_overview/application_filtering.htm">Application Filtering.</a>
+</div>
+<h2 id="full-webidl">3. Full WebIDL</h2>
+<pre class="webidl prettyprint">module NetworkInformation {
+ [NoInterfaceObject] interface NetworkInformationManagerObject {
+ readonly attribute <a href="#NetworkInformationManager">NetworkInformationManager</a> connection;
+ };
+ implements <a href="#NetworkInformationManagerObject">NetworkInformationManagerObject</a>;
+ [NoInterfaceObject] interface NetworkInformationManager {
+ readonly attribute DOMString type;
+ };
+ interface Connection {
+ readonly attribute DOMString UNKNOWN;
+ readonly attribute DOMString ETHERNET;
+ readonly attribute DOMString WIFI;
+ readonly attribute DOMString CELL_2G;
+ readonly attribute DOMString CELL_3G;
+ readonly attribute DOMString CELL_4G;
+ readonly attribute DOMString CELL;
+ readonly attribute DOMString NONE;
+ };
+
+ [NoInterfaceObject, Callback=FunctionOnly]
+ interface OnlineEventCallback {
+ void online();
+ };
+ [NoInterfaceObject, Callback=FunctionOnly]
+ interface OfflineEventCallback {
+ void offline();
+ };
+};</pre>
+</div>
+<div id="page-footer">
+<div class="copyright" align="center">
+ Except as noted, this content - excluding the Code Examples - is licensed under <a href="http://creativecommons.org/licenses/by/3.0/legalcode" target="_blank">Creative Commons Attribution 3.0</a> and all of the Code Examples contained herein are licensed under <a href="https://www.tizen.org/bsd-3-clause-license" target="_blank">BSD-3-Clause</a>. <br>For details, see the <a href="https://www.tizen.org/content-license" target="_blank">Content License</a>.
+ </div>
+<script type="text/javascript">
+
+ var _gaq = _gaq || [];
+ _gaq.push(['_setAccount', 'UA-25976949-1']);
+ _gaq.push(['_setDomainName', 'tizen.org']);
+ _gaq.push(['_trackPageview']);
+
+ (function() {
+ var ga = document.createElement('script'); ga.type = 'text/javascript'; ga.async = true;
+ var s = document.getElementsByTagName('script')[0]; s.parentNode.insertBefore(ga, s);
+ })();
+
+ </script>
+</div>
+</body>
+</html>
</tr>
</tbody>
</table>
+ <h4 id="Cordova">Cordova</h4>
+ <table width="90%">
+ <thead>
+ <tr><th style="width:20%">API</th><th>Description</th><th style="width:5%">Version</th></tr>
+ </thead>
+ <tbody>
+ <tr><td><a href="tizen/cordova/console.html">
+ Console</a></td>
+ <td>The Console module provides function to access the console.</td>
+ <td>3.0</td>
+
+ </tr><tr><td><a href="tizen/cordova/cordova.html">
+ Cordova</a></td>
+ <td>This API provides common Cordova functionality.</td>
+ <td>3.0</td>
+
+ </tr><tr><td><a href="tizen/cordova/device.html">
+ Device</a></td>
+ <td>This plugin defines a global device object, which describes the device's hardware and software.</td>
+ <td>3.0</td>
+
+ </tr><tr><td><a href="tizen/cordova/device-motion.html">
+ Device Motion</a></td>
+ <td>This plugin provides access to the device's accelerometer.</td>
+ <td>3.0</td>
+
+ </tr><tr><td><a href="tizen/cordova/dialogs.html">
+ Dialogs</a></td>
+ <td>This plugin provides the ability to make different types of notifications to the user.</td>
+ <td>3.0</td>
+
+ </tr><tr><td><a href="tizen/cordova/events.html">
+ Events</a></td>
+ <td>This plugin provides information about events defined in cordova.</td>
+ <td>3.0</td>
+
+ </tr><tr><td><a href="tizen/cordova/file.html">
+ File</a></td>
+ <td>This plugin implements a File API allowing read/write access to files residing on the device.</td>
+ <td>3.0</td>
+
+ </tr><tr><td><a href="tizen/cordova/filetransfer.html">
+ File Transfer</a></td>
+ <td>This module allows you to upload and download files.</td>
+ <td>3.0</td>
+
+ </tr><tr><td><a href="tizen/cordova/globalization.html">
+ Globalization</a></td>
+ <td>This plugin obtains information and performs operations specific to the user's locale, language, and timezone.</td>
+ <td>3.0</td>
+
+ </tr><tr><td><a href="tizen/cordova/media.html">
+ Media</a></td>
+ <td>This plugin provides the ability to record and play back audio files on a device.</td>
+ <td>3.0</td>
+
+ </tr><tr><td><a href="tizen/cordova/networkInformation.html">
+ Network Information</a></td>
+ <td>This plugin provides information about the device's cellular and wifi connection, and whether the device has an internet connection. </td>
+ <td>3.0</td>
+
+ </tr></tbody></table>
<div id="footer">
<!--div class="copyright" align="center">
--- /dev/null
+<!DOCTYPE html PUBLIC "html">
+<html>
+<head>
+<meta http-equiv="Content-Type" content="text/html; charset=utf-8">
+<link rel="stylesheet" type="text/css" href="../tizen.css" media="screen">
+<script type="text/javascript" src="snippet.js"></script><title>Console API</title>
+</head>
+<body id="page-content" onload="prettyPrint()">
+<div class="api" id="::Console">
+
+<div class="title"><h1>Console API</h1></div>
+<div class="brief">
+ the Console module provides function to access the console.
+Original documentation: <a href="https://www.npmjs.com/package/cordova-plugin-console">Cordova Console</a>.
+ </div>
+<h2>Table of Contents</h2>
+<ul class="toc">
+<li>1. <a href="#interfaces-section">Interfaces</a><ul class="toc">
+<li>1.1. <a href="#ConsoleManagerObject">ConsoleManagerObject</a>
+</li>
+<li>1.2. <a href="#ConsoleManager">ConsoleManager</a>
+</li>
+</ul>
+</li>
+<li>2. <a href="#full-webidl">Full WebIDL</a>
+</li>
+</ul>
+<hr>
+<h2 id="method-summary">Summary of Interfaces and Methods</h2>
+<table class="informaltable">
+<thead><tr>
+<th>Interface</th>
+<th>Method</th>
+</tr></thead>
+<tbody>
+<tr>
+<td><a href="#ConsoleManagerObject">ConsoleManagerObject</a></td>
+<td></td>
+</tr>
+<tr>
+<td><a href="#ConsoleManager">ConsoleManager</a></td>
+<td>
+<div>void <a href="#ConsoleManager::log">log</a> (DOMString text)</div>
+<div>void <a href="#ConsoleManager::error">error</a> (DOMString text)</div>
+<div>void <a href="#ConsoleManager::warn">warn</a> (DOMString text)</div>
+<div>void <a href="#ConsoleManager::info">info</a> (DOMString text)</div>
+<div>void <a href="#ConsoleManager::debug">debug</a> (DOMString text)</div>
+<div>void <a href="#ConsoleManager::assert">assert</a> (boolean expression, DOMString message)</div>
+<div>void <a href="#ConsoleManager::dir">dir</a> (Object obj)</div>
+<div>void <a href="#ConsoleManager::dirxml">dirxml</a> (Object obj)</div>
+<div>void <a href="#ConsoleManager::time">time</a> (DOMString label)</div>
+<div>void <a href="#ConsoleManager::timeEnd">timeEnd</a> (DOMString label)</div>
+</td>
+</tr>
+</tbody>
+</table>
+<div class="interfaces" id="interfaces-section">
+<h2>1. Interfaces</h2>
+<div class="interface" id="ConsoleManagerObject">
+<a class="backward-compatibility-anchor" name="::Console::ConsoleManagerObject"></a><h3>1.1. ConsoleManagerObject</h3>
+<pre class="webidl prettyprint"> [NoInterfaceObject] interface ConsoleManagerObject {
+ readonly attribute <a href="#ConsoleManager">ConsoleManager</a> console;
+ };</pre>
+<pre class="webidl prettyprint"> Window implements <a href="#ConsoleManagerObject">ConsoleManagerObject</a>;</pre>
+<div class="description">
+ <p>
+The ConsoleManagerObject interface.
+ </p>
+ </div>
+</div>
+<div class="interface" id="ConsoleManager">
+<a class="backward-compatibility-anchor" name="::Console::ConsoleManager"></a><h3>1.2. ConsoleManager</h3>
+<div class="brief">
+ the ConsoleManager interface embodies Console module methods.
+ </div>
+<pre class="webidl prettyprint"> [NoInterfaceObject] interface ConsoleManager {
+ void log(DOMString text);
+
+ void error(DOMString text);
+
+ void warn(DOMString text);
+
+ void info(DOMString text);
+
+ void debug(DOMString text);
+
+ void assert(boolean expression, DOMString message);
+
+ void dir(Object obj);
+
+ void dirxml(Object obj);
+
+ void time(DOMString label);
+
+ void timeEnd(DOMString label);
+ };</pre>
+<div class="methods">
+<h4>Methods</h4>
+<dl>
+<dt class="method" id="ConsoleManager::log">
+<a class="backward-compatibility-anchor" name="::Console::ConsoleManager::log"></a><code><b><span class="methodName">log</span></b></code>
+</dt>
+<dd>
+<div class="brief">
+ Prints a line of text to a standard output.
+The text will be logged as a standard message.
+ </div>
+<div class="synopsis"><pre class="signature prettyprint">void log(DOMString text);
+ </pre></div>
+<p><span class="version">
+ Since: </span>
+ 3.0
+ </p>
+<div class="parameters">
+<p><span class="param">Parameters:</span></p>
+<ul>
+ <li class="param">
+<span class="name">text</span>:
+ The text to be printed.
+ </li>
+ </ul>
+</div>
+<div class="example">
+<span class="example"><p>Code example:</p></span><pre name="code" class="examplecode prettyprint"> console.log('A is for Alice.');
+ </pre>
+</div>
+<div class="output">
+<span class="title"><p>Output example:</p></span><pre>A is for Alice.
+</pre>
+</div>
+</dd>
+<dt class="method" id="ConsoleManager::error">
+<a class="backward-compatibility-anchor" name="::Console::ConsoleManager::error"></a><code><b><span class="methodName">error</span></b></code>
+</dt>
+<dd>
+<div class="brief">
+ Prints a line of text to a standard output.
+The text will be logged as an error message.
+ </div>
+<div class="synopsis"><pre class="signature prettyprint">void error(DOMString text);
+ </pre></div>
+<p><span class="version">
+ Since: </span>
+ 3.0
+ </p>
+<div class="parameters">
+<p><span class="param">Parameters:</span></p>
+<ul>
+ <li class="param">
+<span class="name">text</span>:
+ The text to be printed.
+ </li>
+ </ul>
+</div>
+<div class="example">
+<span class="example"><p>Code example:</p></span><pre name="code" class="examplecode prettyprint"> console.error('B is for Bob.');
+ </pre>
+</div>
+<div class="output">
+<span class="title"><p>Output example:</p></span><pre>B is for Bob.
+</pre>
+</div>
+</dd>
+<dt class="method" id="ConsoleManager::warn">
+<a class="backward-compatibility-anchor" name="::Console::ConsoleManager::warn"></a><code><b><span class="methodName">warn</span></b></code>
+</dt>
+<dd>
+<div class="brief">
+ Prints a line of text to a standard output.
+The text will be logged as a warning message.
+ </div>
+<div class="synopsis"><pre class="signature prettyprint">void warn(DOMString text);
+ </pre></div>
+<p><span class="version">
+ Since: </span>
+ 3.0
+ </p>
+<div class="parameters">
+<p><span class="param">Parameters:</span></p>
+<ul>
+ <li class="param">
+<span class="name">text</span>:
+ The text to be printed.
+ </li>
+ </ul>
+</div>
+<div class="example">
+<span class="example"><p>Code example:</p></span><pre name="code" class="examplecode prettyprint"> console.warn('C is for Christopher.');
+ </pre>
+</div>
+<div class="output">
+<span class="title"><p>Output example:</p></span><pre>C is for Christopher.
+</pre>
+</div>
+</dd>
+<dt class="method" id="ConsoleManager::info">
+<a class="backward-compatibility-anchor" name="::Console::ConsoleManager::info"></a><code><b><span class="methodName">info</span></b></code>
+</dt>
+<dd>
+<div class="brief">
+ Prints a line of text to a standard output.
+The text will be logged as an info message.
+ </div>
+<div class="synopsis"><pre class="signature prettyprint">void info(DOMString text);
+ </pre></div>
+<p><span class="version">
+ Since: </span>
+ 3.0
+ </p>
+<div class="parameters">
+<p><span class="param">Parameters:</span></p>
+<ul>
+ <li class="param">
+<span class="name">text</span>:
+ The text to be printed.
+ </li>
+ </ul>
+</div>
+<div class="example">
+<span class="example"><p>Code example:</p></span><pre name="code" class="examplecode prettyprint"> console.info('D is for Dorothy.');
+ </pre>
+</div>
+<div class="output">
+<span class="title"><p>Output example:</p></span><pre>D is for Dorothy.
+</pre>
+</div>
+</dd>
+<dt class="method" id="ConsoleManager::debug">
+<a class="backward-compatibility-anchor" name="::Console::ConsoleManager::debug"></a><code><b><span class="methodName">debug</span></b></code>
+</dt>
+<dd>
+<div class="brief">
+ Prints a line of text to a standard output.
+The text will be logged as a debug message.
+ </div>
+<div class="synopsis"><pre class="signature prettyprint">void debug(DOMString text);
+ </pre></div>
+<p><span class="version">
+ Since: </span>
+ 3.0
+ </p>
+<div class="parameters">
+<p><span class="param">Parameters:</span></p>
+<ul>
+ <li class="param">
+<span class="name">text</span>:
+ The text to be printed.
+ </li>
+ </ul>
+</div>
+<div class="example">
+<span class="example"><p>Code example:</p></span><pre name="code" class="examplecode prettyprint"> console.debug('E is for Eve.');
+ </pre>
+</div>
+<div class="output">
+<span class="title"><p>Output example:</p></span><pre>E is for Eve.
+</pre>
+</div>
+</dd>
+<dt class="method" id="ConsoleManager::assert">
+<a class="backward-compatibility-anchor" name="::Console::ConsoleManager::assert"></a><code><b><span class="methodName">assert</span></b></code>
+</dt>
+<dd>
+<div class="brief">
+ If the specified expression is false,
+the message is written to the console.
+ </div>
+<div class="synopsis"><pre class="signature prettyprint">void assert(boolean expression, DOMString message);
+ </pre></div>
+<p><span class="version">
+ Since: </span>
+ 3.0
+ </p>
+<div class="parameters">
+<p><span class="param">Parameters:</span></p>
+<ul>
+ <li class="param">
+<span class="name">expression</span>:
+ The expression to be evaluated.
+ </li>
+ <li class="param">
+<span class="name">message</span>:
+ The message to be displayed if an expression is false.
+ </li>
+ </ul>
+</div>
+<div class="example">
+<span class="example"><p>Code example:</p></span><pre name="code" class="examplecode prettyprint"> var felix = 'Felix';
+
+ // This assertion checks whether the first letter in name 'Felix' is 'A':
+ console.assert(felix.charAt(0) === 'A', felix + ' does not start with A.');
+ </pre>
+</div>
+<div class="output">
+<span class="title"><p>Output example:</p></span><pre>Felix does not start with A.
+</pre>
+</div>
+</dd>
+<dt class="method" id="ConsoleManager::dir">
+<a class="backward-compatibility-anchor" name="::Console::ConsoleManager::dir"></a><code><b><span class="methodName">dir</span></b></code>
+</dt>
+<dd>
+<div class="brief">
+ Prints a JavaScript representation of the specified object.
+If the object being logged is an HTML element, the JavaScript
+Object view is forced.
+ </div>
+<div class="synopsis"><pre class="signature prettyprint">void dir(Object obj);
+ </pre></div>
+<p><span class="version">
+ Since: </span>
+ 3.0
+ </p>
+<div class="parameters">
+<p><span class="param">Parameters:</span></p>
+<ul>
+ <li class="param">
+<span class="name">obj</span>:
+ An object whose JavaScript representation will be printed.
+ </li>
+ </ul>
+</div>
+<div class="example">
+<span class="example"><p>Code example:</p></span><pre name="code" class="examplecode prettyprint"> var john = {name: "John", surname: "Doe"};
+ console.dir(john.name);
+ </pre>
+</div>
+<div class="output">
+<span class="title"><p>Output example:</p></span><pre>John
+</pre>
+</div>
+</dd>
+<dt class="method" id="ConsoleManager::dirxml">
+<a class="backward-compatibility-anchor" name="::Console::ConsoleManager::dirxml"></a><code><b><span class="methodName">dirxml</span></b></code>
+</dt>
+<dd>
+<div class="brief">
+ Prints an XML/HTML Element representation of the specified object
+if possible or the JavaScript Object if it is not.
+ </div>
+<div class="synopsis"><pre class="signature prettyprint">void dirxml(Object obj);
+ </pre></div>
+<p><span class="version">
+ Since: </span>
+ 3.0
+ </p>
+<div class="parameters">
+<p><span class="param">Parameters:</span></p>
+<ul>
+ <li class="param">
+<span class="name">obj</span>:
+ An object whose XML/HTML Element representation will be printed.
+ </li>
+ </ul>
+</div>
+<div class="example">
+<span class="example"><p>Code example:</p></span><pre name="code" class="examplecode prettyprint"> var john = {name: "John", surname: "Doe"};
+ console.dirxml(john.surname);
+ </pre>
+</div>
+<div class="output">
+<span class="title"><p>Output example:</p></span><pre>Doe
+</pre>
+</div>
+</dd>
+<dt class="method" id="ConsoleManager::time">
+<a class="backward-compatibility-anchor" name="::Console::ConsoleManager::time"></a><code><b><span class="methodName">time</span></b></code>
+</dt>
+<dd>
+<div class="brief">
+ Starts a new timer with an associated label. When <var>console.timeEnd()
+</var> is called with the same label, the timer is stopped and the elapsed time
+is displayed in the console. Timer values are accurate to the sub-millisecond.
+ </div>
+<div class="synopsis"><pre class="signature prettyprint">void time(DOMString label);
+ </pre></div>
+<p><span class="version">
+ Since: </span>
+ 3.0
+ </p>
+<div class="parameters">
+<p><span class="param">Parameters:</span></p>
+<ul>
+ <li class="param">
+<span class="name">label</span>:
+ The label to start timing with.
+ </li>
+ </ul>
+</div>
+<div class="example">
+<span class="example"><p>Code example:</p></span><pre name="code" class="examplecode prettyprint"> console.time("Big array initialization");
+ var array = new Array(1000000);
+ for (var i = array.length - 1; i >= 0; i -= 1) {
+ array[i] = new Object();
+ };
+ console.timeEnd("Big array initialization");
+ </pre>
+</div>
+<div class="output">
+<span class="title"><p>Output example:</p></span><pre>Big array initialization: 461.989ms
+</pre>
+</div>
+</dd>
+<dt class="method" id="ConsoleManager::timeEnd">
+<a class="backward-compatibility-anchor" name="::Console::ConsoleManager::timeEnd"></a><code><b><span class="methodName">timeEnd</span></b></code>
+</dt>
+<dd>
+<div class="brief">
+ Stops the timer with the specified label and prints the elapsed time.
+ </div>
+<div class="synopsis"><pre class="signature prettyprint">void timeEnd(DOMString label);
+ </pre></div>
+<p><span class="version">
+ Since: </span>
+ 3.0
+ </p>
+<div class="parameters">
+<p><span class="param">Parameters:</span></p>
+<ul>
+ <li class="param">
+<span class="name">label</span>:
+ The label associated to the timing (with the use of <var>console.time()</var>method).
+ </li>
+ </ul>
+</div>
+<div class="example">
+<span class="example"><p>Code example:</p></span><pre name="code" class="examplecode prettyprint"> console.time("Big array initialization");
+ var array = new Array(1000000);
+ for (var i = array.length - 1; i >= 0; i -= 1) {
+ array[i] = new Object();
+ };
+ console.timeEnd("Big array initialization");
+ </pre>
+</div>
+<div class="output">
+<span class="title"><p>Output example:</p></span><pre>Big array initialization: 461.989ms
+</pre>
+</div>
+</dd>
+</dl>
+</div>
+</div>
+</div>
+<h2 id="full-webidl">2. Full WebIDL</h2>
+<pre class="webidl prettyprint">module Console {
+ [NoInterfaceObject] interface ConsoleManagerObject {
+ readonly attribute <a href="#ConsoleManager">ConsoleManager</a> console;
+ };
+
+ Window implements <a href="#ConsoleManagerObject">ConsoleManagerObject</a>;
+
+ [NoInterfaceObject] interface ConsoleManager {
+ void log(DOMString text);
+
+ void error(DOMString text);
+
+ void warn(DOMString text);
+
+ void info(DOMString text);
+
+ void debug(DOMString text);
+
+ void assert(boolean expression, DOMString message);
+
+ void dir(Object obj);
+
+ void dirxml(Object obj);
+
+ void time(DOMString label);
+
+ void timeEnd(DOMString label);
+ };
+};</pre>
+</div>
+<div id="page-footer">
+<div class="copyright" align="center">
+ Except as noted, this content - excluding the Code Examples - is licensed under <a href="http://creativecommons.org/licenses/by/3.0/legalcode" target="_blank">Creative Commons Attribution 3.0</a> and all of the Code Examples contained herein are licensed under <a href="https://www.tizen.org/bsd-3-clause-license" target="_blank">BSD-3-Clause</a>. <br>For details, see the <a href="https://www.tizen.org/content-license" target="_blank">Content License</a>.
+ </div>
+<script type="text/javascript">
+
+ var _gaq = _gaq || [];
+ _gaq.push(['_setAccount', 'UA-25976949-1']);
+ _gaq.push(['_setDomainName', 'tizen.org']);
+ _gaq.push(['_trackPageview']);
+
+ (function() {
+ var ga = document.createElement('script'); ga.type = 'text/javascript'; ga.async = true;
+ var s = document.getElementsByTagName('script')[0]; s.parentNode.insertBefore(ga, s);
+ })();
+
+ </script>
+</div>
+</body>
+</html>
--- /dev/null
+<!DOCTYPE html PUBLIC "html">
+<html>
+<head>
+<meta http-equiv="Content-Type" content="text/html; charset=utf-8">
+<link rel="stylesheet" type="text/css" href="../tizen.css" media="screen">
+<script type="text/javascript" src="snippet.js"></script><title>Cordova API</title>
+</head>
+<body id="page-content" onload="prettyPrint()">
+<div class="api" id="::Cordova">
+
+<div class="title"><h1>Cordova API</h1></div>
+<div class="brief">
+ This API provides common Cordova functionality.
+ </div>
+<h2>Table of Contents</h2>
+<ul class="toc">
+<li>1. <a href="#interfaces-section">Interfaces</a><ul class="toc">
+<li>1.1. <a href="#CordovaManagerObject">CordovaManagerObject</a>
+</li>
+<li>1.2. <a href="#Cordova">Cordova</a>
+</li>
+<li>1.3. <a href="#SuccessCallback">SuccessCallback</a>
+</li>
+<li>1.4. <a href="#ErrorCallback">ErrorCallback</a>
+</li>
+<li>1.5. <a href="#DOMException">DOMException</a>
+</li>
+</ul>
+</li>
+<li>2. <a href="#full-webidl">Full WebIDL</a>
+</li>
+</ul>
+<hr>
+<h2 id="method-summary">Summary of Interfaces and Methods</h2>
+<table class="informaltable">
+<thead><tr>
+<th>Interface</th>
+<th>Method</th>
+</tr></thead>
+<tbody>
+<tr>
+<td><a href="#CordovaManagerObject">CordovaManagerObject</a></td>
+<td></td>
+</tr>
+<tr>
+<td><a href="#Cordova">Cordova</a></td>
+<td></td>
+</tr>
+<tr>
+<td><a href="#SuccessCallback">SuccessCallback</a></td>
+<td><div>void <a href="#SuccessCallback::onsuccess">onsuccess</a> ()</div></td>
+</tr>
+<tr>
+<td><a href="#ErrorCallback">ErrorCallback</a></td>
+<td><div>void <a href="#ErrorCallback::onerror">onerror</a> (<a href="#DOMException">DOMException</a> error)</div></td>
+</tr>
+<tr>
+<td><a href="#DOMException">DOMException</a></td>
+<td></td>
+</tr>
+</tbody>
+</table>
+<div class="interfaces" id="interfaces-section">
+<h2>1. Interfaces</h2>
+<div class="interface" id="CordovaManagerObject">
+<a class="backward-compatibility-anchor" name="::Cordova::CordovaManagerObject"></a><h3>1.1. CordovaManagerObject</h3>
+<div class="brief">
+ CordovaManagerObject implemented in Window
+ </div>
+<pre class="webidl prettyprint"> [NoInterfaceObject] interface CordovaManagerObject {
+ readonly attribute <a href="#Cordova">Cordova</a> cordova;
+ };</pre>
+<pre class="webidl prettyprint"> Window implements <a href="#CordovaManagerObject">CordovaManagerObject</a>;</pre>
+</div>
+<div class="interface" id="Cordova">
+<a class="backward-compatibility-anchor" name="::Cordova::Cordova"></a><h3>1.2. Cordova</h3>
+<div class="brief">
+ The Cordova interface defines what is instantiated by the cordova object
+ </div>
+<pre class="webidl prettyprint"> [NoInterfaceObject] interface Cordova {
+ };</pre>
+</div>
+<div class="interface" id="SuccessCallback">
+<a class="backward-compatibility-anchor" name="::Cordova::SuccessCallback"></a><h3>1.3. SuccessCallback</h3>
+<div class="brief">
+ Basic success callback, no parameters.
+ </div>
+<pre class="webidl prettyprint">[Callback=FunctionOnly,NoInterfaceObject]
+interface SuccessCallback {
+ void onsuccess();
+};</pre>
+<div class="methods">
+<h4>Methods</h4>
+<dl>
+<dt class="method" id="SuccessCallback::onsuccess">
+<a class="backward-compatibility-anchor" name="::Cordova::SuccessCallback::onsuccess"></a><code><b><span class="methodName">onsuccess</span></b></code>
+</dt>
+<dd>
+<div class="brief">
+ Success
+ </div>
+<div class="synopsis"><pre class="signature prettyprint">void onsuccess();
+ </pre></div>
+<p><span class="version">
+ Since: </span>
+ 3.0
+ </p>
+</dd>
+</dl>
+</div>
+</div>
+<div class="interface" id="ErrorCallback">
+<a class="backward-compatibility-anchor" name="::Cordova::ErrorCallback"></a><h3>1.4. ErrorCallback</h3>
+<div class="brief">
+ Basic error callback.
+ </div>
+<pre class="webidl prettyprint">[Callback=FunctionOnly,NoInterfaceObject]
+interface ErrorCallback {
+ void onerror(<a href="#DOMException">DOMException</a> error);
+};</pre>
+<div class="methods">
+<h4>Methods</h4>
+<dl>
+<dt class="method" id="ErrorCallback::onerror">
+<a class="backward-compatibility-anchor" name="::Cordova::ErrorCallback::onerror"></a><code><b><span class="methodName">onerror</span></b></code>
+</dt>
+<dd>
+<div class="brief">
+ Success
+ </div>
+<div class="synopsis"><pre class="signature prettyprint">void onerror(<a href="#DOMException">DOMException</a> error);
+ </pre></div>
+<p><span class="version">
+ Since: </span>
+ 3.0
+ </p>
+<div class="parameters">
+<p><span class="param">Parameters:</span></p>
+<ul>
+ <li class="param">
+<span class="name">error</span>:
+ Error object containing some information about the error.
+ </li>
+ </ul>
+</div>
+</dd>
+</dl>
+</div>
+</div>
+<div class="interface" id="DOMException">
+<a class="backward-compatibility-anchor" name="::Cordova::DOMException"></a><h3>1.5. DOMException</h3>
+<div class="brief">
+ See <a href="https://developer.mozilla.org/en/docs/Web/API/DOMException">DOMException</a>.
+ </div>
+<pre class="webidl prettyprint">interface DOMException {
+ readonly attribute short code;
+
+ readonly attribute DOMString name;
+
+ readonly attribute DOMString message;
+};</pre>
+<div class="attributes">
+<h4>Attributes</h4>
+<ul>
+<li class="attribute" id="DOMException::code">
+<span class="attrName"><span class="readonly"> readonly
+</span><span class="type">short </span><span class="name">code</span></span><div class="brief">
+ The number representing the type of the error.
+ </div>
+<p><span class="version">
+ Since: </span>
+ 3.0
+ </p>
+</li>
+<li class="attribute" id="DOMException::name">
+<span class="attrName"><span class="readonly"> readonly
+</span><span class="type">DOMString </span><span class="name">name</span></span><div class="brief">
+ The short text representing the type of the error.
+ </div>
+<p><span class="version">
+ Since: </span>
+ 3.0
+ </p>
+</li>
+<li class="attribute" id="DOMException::message">
+<span class="attrName"><span class="readonly"> readonly
+</span><span class="type">DOMString </span><span class="name">message</span></span><div class="brief">
+ A text containing information about the error.
+ </div>
+<p><span class="version">
+ Since: </span>
+ 3.0
+ </p>
+</li>
+</ul>
+</div>
+</div>
+</div>
+<h2 id="full-webidl">2. Full WebIDL</h2>
+<pre class="webidl prettyprint">module Cordova {
+
+ [NoInterfaceObject] interface CordovaManagerObject {
+ readonly attribute <a href="#Cordova">Cordova</a> cordova;
+ };
+ Window implements <a href="#CordovaManagerObject">CordovaManagerObject</a>;
+
+ [NoInterfaceObject] interface Cordova {
+ };
+
+
+
+[Callback=FunctionOnly,NoInterfaceObject]
+interface SuccessCallback {
+ void onsuccess();
+};
+
+[Callback=FunctionOnly,NoInterfaceObject]
+interface ErrorCallback {
+ void onerror(<a href="#DOMException">DOMException</a> error);
+};
+
+interface DOMException {
+ readonly attribute short code;
+
+ readonly attribute DOMString name;
+
+ readonly attribute DOMString message;
+};
+
+};</pre>
+</div>
+<div id="page-footer">
+<div class="copyright" align="center">
+ Except as noted, this content - excluding the Code Examples - is licensed under <a href="http://creativecommons.org/licenses/by/3.0/legalcode" target="_blank">Creative Commons Attribution 3.0</a> and all of the Code Examples contained herein are licensed under <a href="https://www.tizen.org/bsd-3-clause-license" target="_blank">BSD-3-Clause</a>. <br>For details, see the <a href="https://www.tizen.org/content-license" target="_blank">Content License</a>.
+ </div>
+<script type="text/javascript">
+
+ var _gaq = _gaq || [];
+ _gaq.push(['_setAccount', 'UA-25976949-1']);
+ _gaq.push(['_setDomainName', 'tizen.org']);
+ _gaq.push(['_trackPageview']);
+
+ (function() {
+ var ga = document.createElement('script'); ga.type = 'text/javascript'; ga.async = true;
+ var s = document.getElementsByTagName('script')[0]; s.parentNode.insertBefore(ga, s);
+ })();
+
+ </script>
+</div>
+</body>
+</html>
--- /dev/null
+<!DOCTYPE html PUBLIC "html">
+<html>
+<head>
+<meta http-equiv="Content-Type" content="text/html; charset=utf-8">
+<link rel="stylesheet" type="text/css" href="../tizen.css" media="screen">
+<script type="text/javascript" src="snippet.js"></script><title>DeviceMotion API</title>
+</head>
+<body id="page-content" onload="prettyPrint()">
+<div class="api" id="::DeviceMotion">
+
+<div class="title"><h1>DeviceMotion API</h1></div>
+<div class="brief">
+ This plugin provides access to the device's accelerometer. The accelerometer is a motion sensor that detects the change (delta) in movement relative to the current device orientation, in three dimensions along the x, y, and z axis.
+ </div>
+<div class="description">
+ <p>
+Original documentation: <a href="https://cordova.apache.org/docs/en/3.0.0/cordova/accelerometer/accelerometer.html">Cordova Accelerometer</a>.
+ </p>
+ </div>
+<h2>Table of Contents</h2>
+<ul class="toc">
+<li>1. <a href="#interfaces-section">Interfaces</a><ul class="toc">
+<li>1.1. <a href="#AccelerometerManagerObject">AccelerometerManagerObject</a>
+</li>
+<li>1.2. <a href="#Accelerometer">Accelerometer</a>
+</li>
+<li>1.3. <a href="#Acceleration">Acceleration</a>
+</li>
+<li>1.4. <a href="#AccelerationOptions">AccelerationOptions</a>
+</li>
+<li>1.5. <a href="#AccelerometerSuccessCallback">AccelerometerSuccessCallback</a>
+</li>
+</ul>
+</li>
+<li>2. <a href="#api-features">Related Feature</a>
+</li>
+<li>3. <a href="#full-webidl">Full WebIDL</a>
+</li>
+</ul>
+<hr>
+<h2 id="method-summary">Summary of Interfaces and Methods</h2>
+<table class="informaltable">
+<thead><tr>
+<th>Interface</th>
+<th>Method</th>
+</tr></thead>
+<tbody>
+<tr>
+<td><a href="#AccelerometerManagerObject">AccelerometerManagerObject</a></td>
+<td></td>
+</tr>
+<tr>
+<td><a href="#Accelerometer">Accelerometer</a></td>
+<td>
+<div>void <a href="#Accelerometer::getCurrentAcceleration">getCurrentAcceleration</a> (<a href="#AccelerometerSuccessCallback">AccelerometerSuccessCallback</a> onsuccess, <a href="cordova.html#ErrorCallback">ErrorCallback</a><a href="file.html#ErrorCallback">ErrorCallback</a> onerror)</div>
+<div>DOMString <a href="#Accelerometer::watchAcceleration">watchAcceleration</a> (<a href="#AccelerometerSuccessCallback">AccelerometerSuccessCallback</a> onsuccess, <a href="cordova.html#ErrorCallback">ErrorCallback</a><a href="file.html#ErrorCallback">ErrorCallback</a> onerror, optional <a href="#AccelerationOptions">AccelerationOptions</a>? options)</div>
+<div>void <a href="#Accelerometer::clearWatch">clearWatch</a> (DOMString watchID)</div>
+</td>
+</tr>
+<tr>
+<td><a href="#Acceleration">Acceleration</a></td>
+<td></td>
+</tr>
+<tr>
+<td><a href="#AccelerationOptions">AccelerationOptions</a></td>
+<td></td>
+</tr>
+<tr>
+<td><a href="#AccelerometerSuccessCallback">AccelerometerSuccessCallback</a></td>
+<td><div>void <a href="#AccelerometerSuccessCallback::onsuccess">onsuccess</a> (<a href="#Acceleration">Acceleration</a> acceleration)</div></td>
+</tr>
+</tbody>
+</table>
+<div class="interfaces" id="interfaces-section">
+<h2>1. Interfaces</h2>
+<div class="interface" id="AccelerometerManagerObject">
+<a class="backward-compatibility-anchor" name="::DeviceMotion::AccelerometerManagerObject"></a><h3>1.1. AccelerometerManagerObject</h3>
+<div class="brief">
+ The <em>navigator.accelerometer </em>object allows access to the functionality of the DeviceMotion API.
+ </div>
+<pre class="webidl prettyprint"> [NoInterfaceObject] interface AccelerometerManagerObject {
+ readonly attribute <a href="#Accelerometer">Accelerometer</a> accelerometer;
+ };</pre>
+<pre class="webidl prettyprint"> implements <a href="#AccelerometerManagerObject">AccelerometerManagerObject</a>;</pre>
+</div>
+<div class="interface" id="Accelerometer">
+<a class="backward-compatibility-anchor" name="::DeviceMotion::Accelerometer"></a><h3>1.2. Accelerometer</h3>
+<div class="brief">
+ The Accelerometer object captures device motion in the x, y, and z direction.
+ </div>
+<pre class="webidl prettyprint"> [NoInterfaceObject] interface Accelerometer {
+ void getCurrentAcceleration(<a href="#AccelerometerSuccessCallback">AccelerometerSuccessCallback</a> onsuccess, <a href="cordova.html#ErrorCallback">ErrorCallback</a><a href="file.html#ErrorCallback">ErrorCallback</a> onerror);
+
+ DOMString watchAcceleration(<a href="#AccelerometerSuccessCallback">AccelerometerSuccessCallback</a> onsuccess, <a href="cordova.html#ErrorCallback">ErrorCallback</a><a href="file.html#ErrorCallback">ErrorCallback</a> onerror, optional <a href="#AccelerationOptions">AccelerationOptions</a>? options);
+
+ void clearWatch(DOMString watchID);
+
+ };</pre>
+<div class="methods">
+<h4>Methods</h4>
+<dl>
+<dt class="method" id="Accelerometer::getCurrentAcceleration">
+<a class="backward-compatibility-anchor" name="::DeviceMotion::Accelerometer::getCurrentAcceleration"></a><code><b><span class="methodName">getCurrentAcceleration</span></b></code>
+</dt>
+<dd>
+<div class="brief">
+ Gets the current acceleration along the x, y, and z axes.
+ </div>
+<div class="synopsis"><pre class="signature prettyprint">void getCurrentAcceleration(<a href="#AccelerometerSuccessCallback">AccelerometerSuccessCallback</a> onsuccess, <a href="cordova.html#ErrorCallback">ErrorCallback</a><a href="file.html#ErrorCallback">ErrorCallback</a> onerror);
+ </pre></div>
+<p><span class="version">
+ Since: </span>
+ 3.0
+ </p>
+<div class="parameters">
+<p><span class="param">Parameters:</span></p>
+<ul>
+ <li class="param">
+<span class="name">onsuccess</span>:
+ The callback method to be invoked with current acceleration values.
+ </li>
+ <li class="param">
+<span class="name">onerror</span>:
+ The callback method called when errors occur
+ </li>
+ </ul>
+</div>
+<div class="exceptionlist">
+<p><span class="except">Exceptions:</span></p>
+ <ul class="exception"><li>TypeError<ul><li class="list"><p>
+ if any of the input parameters contains an invalid value.
+ </p></li></ul>
+</li></ul>
+ </div>
+<div class="example">
+<span class="example"><p>Code example:</p></span><pre name="code" class="examplecode prettyprint"> function onSuccess(acceleration) {
+ console.log('Acceleration X: ' + acceleration.x + '\n' +
+ 'Acceleration Y: ' + acceleration.y + '\n' +
+ 'Acceleration Z: ' + acceleration.z + '\n' +
+ 'Timestamp: ' + acceleration.timestamp);
+ };
+
+ function onError() {
+ console.log('onError!');
+ };
+
+ navigator.accelerometer.getCurrentAcceleration(onSuccess, onError);
+ </pre>
+</div>
+<div class="output">
+<span class="title"><p>Output example:</p></span><pre>Acceleration X: 0.00
+Acceleration Y: 0.00
+Acceleration Z: 9.82
+Timestamp: 1456480118000
+</pre>
+</div>
+</dd>
+<dt class="method" id="Accelerometer::watchAcceleration">
+<a class="backward-compatibility-anchor" name="::DeviceMotion::Accelerometer::watchAcceleration"></a><code><b><span class="methodName">watchAcceleration</span></b></code>
+</dt>
+<dd>
+<div class="brief">
+ Gets the acceleration along the x, y, and z axes at a regular interval.
+ </div>
+<div class="synopsis"><pre class="signature prettyprint">DOMString watchAcceleration(<a href="#AccelerometerSuccessCallback">AccelerometerSuccessCallback</a> onsuccess, <a href="cordova.html#ErrorCallback">ErrorCallback</a><a href="file.html#ErrorCallback">ErrorCallback</a> onerror, optional <a href="#AccelerationOptions">AccelerationOptions</a>? options);
+ </pre></div>
+<p><span class="version">
+ Since: </span>
+ 3.0
+ </p>
+<div class="parameters">
+<p><span class="param">Parameters:</span></p>
+<ul>
+ <li class="param">
+<span class="name">onsuccess</span>:
+ The callback method to be invoked with current acceleration values.
+ </li>
+ <li class="param">
+<span class="name">onerror</span>:
+ The callback method called when errors occur
+ </li>
+ <li class="param">
+<span class="name">options</span><span class="optional"> [optional]</span><span class="optional"> [nullable]</span>:
+ Specifies the interval of calling successcallback in miliseconds. If not provided, default value for frequency is 10000 (10 seconds).
+ </li>
+ </ul>
+</div>
+<div class="returntype">
+<p><span class="return">Return value:</span></p>
+ DOMString The watch id that must be passed to <a href="device-motion.html#Accelerometer::clearWatch">clearWatch</a> to stop watching.
+ </div>
+<div class="exceptionlist">
+<p><span class="except">Exceptions:</span></p>
+ <ul class="exception"><li>TypeError<ul><li class="list"><p>
+ if any of the input parameters contains an invalid value.
+ </p></li></ul>
+</li></ul>
+ </div>
+<div class="example">
+<span class="example"><p>Code example:</p></span><pre name="code" class="examplecode prettyprint"> function onSuccess(acceleration) {
+ console.log('Acceleration X: ' + acceleration.x + '\n' +
+ 'Acceleration Y: ' + acceleration.y + '\n' +
+ 'Acceleration Z: ' + acceleration.z + '\n' +
+ 'Timestamp: ' + acceleration.timestamp);
+ console.log('Please wait 3 seconds for the next measurement...');
+ };
+
+ function onError() {
+ console.log('onError!');
+ };
+
+ var options = { frequency: 3000 }; // Update every 3 seconds
+
+ var watchID = navigator.accelerometer.watchAcceleration(onSuccess, onError, options);
+ </pre>
+</div>
+<div class="output">
+<span class="title"><p>Output example:</p></span><pre>Acceleration X: 0.00
+Acceleration Y: 0.00
+Acceleration Z: 9.82
+Timestamp: 1456480118000
+Please wait 3 seconds for the next measurement...
+Acceleration X: 0.00
+Acceleration Y: 0.00
+Acceleration Z: 9.82
+Timestamp: 1456480121000
+Please wait 3 seconds for the next measurement...
+(...)
+</pre>
+</div>
+</dd>
+<dt class="method" id="Accelerometer::clearWatch">
+<a class="backward-compatibility-anchor" name="::DeviceMotion::Accelerometer::clearWatch"></a><code><b><span class="methodName">clearWatch</span></b></code>
+</dt>
+<dd>
+<div class="brief">
+ Stop watching the Acceleration referenced by the watchID parameter.
+ </div>
+<div class="synopsis"><pre class="signature prettyprint">void clearWatch(DOMString watchID);
+ </pre></div>
+<p><span class="version">
+ Since: </span>
+ 3.0
+ </p>
+<div class="parameters">
+<p><span class="param">Parameters:</span></p>
+<ul>
+ <li class="param">
+<span class="name">watchID</span>:
+ The id of the watch returned from <a href="device-motion.html#Accelerometer::watchAcceleration">watchAcceleration</a>.
+ </li>
+ </ul>
+</div>
+<div class="exceptionlist">
+<p><span class="except">Exceptions:</span></p>
+ <ul class="exception"><li>TypeError<ul><li class="list"><p>
+ if any of the input parameters contains an invalid value.
+ </p></li></ul>
+</li></ul>
+ </div>
+<div class="example">
+<span class="example"><p>Code example:</p></span><pre name="code" class="examplecode prettyprint"> var counter = 0, watchID;
+
+ function onSuccess(acceleration) {
+ console.log('Acceleration X: ' + acceleration.x + '\n' +
+ 'Acceleration Y: ' + acceleration.y + '\n' +
+ 'Acceleration Z: ' + acceleration.z + '\n' +
+ 'Timestamp: ' + acceleration.timestamp);
+ if(3 == ++counter) {
+ navigator.accelerometer.clearWatch(watchID);
+ }
+ };
+
+ function onError() {
+ console.log('onError!');
+ };
+
+ var options = { frequency: 30 }; // Update every 0.03 seconds
+
+ watchID = navigator.accelerometer.watchAcceleration(onSuccess, onError, options);
+ </pre>
+</div>
+<div class="output">
+<span class="title"><p>Output example:</p></span><pre>Acceleration X: 0.00
+Acceleration Y: 0.00
+Acceleration Z: 9.82
+Timestamp: 1456483774000
+Acceleration X: 0.00
+Acceleration Y: 0.00
+Acceleration Z: 9.82
+Timestamp: 1456483774030
+Acceleration X: 0.00
+Acceleration Y: 0.00
+Acceleration Z: 9.82
+Timestamp: 1456483774060
+</pre>
+</div>
+</dd>
+</dl>
+</div>
+</div>
+<div class="interface" id="Acceleration">
+<a class="backward-compatibility-anchor" name="::DeviceMotion::Acceleration"></a><h3>1.3. Acceleration</h3>
+<div class="brief">
+ Contains Accelerometer data captured at a specific point in time.
+Acceleration values include the effect of gravity (9.81 m/s^2), so that when a device lies flat and facing up, x, y, and z values returned should be 0, 0, and 9.81.
+ </div>
+<pre class="webidl prettyprint"> [NoInterfaceObject] interface Acceleration {
+ readonly attribute double x;
+
+ readonly attribute double y;
+
+ readonly attribute double z;
+
+ readonly attribute long timestamp;
+
+ };</pre>
+<div class="attributes">
+<h4>Attributes</h4>
+<ul>
+<li class="attribute" id="Acceleration::x">
+<span class="attrName"><span class="readonly"> readonly
+</span><span class="type">double </span><span class="name">x</span></span><div class="brief">
+ Amount of acceleration on the x-axis. (in m/s^2)
+ </div>
+<p><span class="version">
+ Since: </span>
+ 3.0
+ </p>
+</li>
+<li class="attribute" id="Acceleration::y">
+<span class="attrName"><span class="readonly"> readonly
+</span><span class="type">double </span><span class="name">y</span></span><div class="brief">
+ Amount of acceleration on the y-axis. (in m/s^2)
+ </div>
+<p><span class="version">
+ Since: </span>
+ 3.0
+ </p>
+</li>
+<li class="attribute" id="Acceleration::z">
+<span class="attrName"><span class="readonly"> readonly
+</span><span class="type">double </span><span class="name">z</span></span><div class="brief">
+ Amount of acceleration on the z-axis. (in m/s^2)
+ </div>
+<p><span class="version">
+ Since: </span>
+ 3.0
+ </p>
+</li>
+<li class="attribute" id="Acceleration::timestamp">
+<span class="attrName"><span class="readonly"> readonly
+</span><span class="type">long </span><span class="name">timestamp</span></span><div class="brief">
+ Creation timestamp in milliseconds.
+ </div>
+<p><span class="version">
+ Since: </span>
+ 3.0
+ </p>
+</li>
+</ul>
+</div>
+</div>
+<div class="dictionary" id="AccelerationOptions">
+<a class="backward-compatibility-anchor" name="::DeviceMotion::AccelerationOptions"></a><h3>1.4. AccelerationOptions</h3>
+<div class="brief">
+ An optional parameter to customize the retrieval of accelerometer values.
+ </div>
+<pre class="webidl prettyprint"> dictionary AccelerationOptions {
+ long frequency;
+ };</pre>
+<div class="attributes">
+<h4>Dictionary members</h4>
+<dl>
+<dt class="member" id="AccelerationOptions::frequency"><span class="attrName">long frequency</span></dt>
+<dd>
+<div class="brief">
+ Interval defining how often to retrieve Acceleration in milliseconds.
+ </div>
+<p><span class="version">
+ Since: </span>
+ 3.0
+ </p>
+</dd>
+</dl>
+</div>
+</div>
+<div class="interface" id="AccelerometerSuccessCallback">
+<a class="backward-compatibility-anchor" name="::DeviceMotion::AccelerometerSuccessCallback"></a><h3>1.5. AccelerometerSuccessCallback</h3>
+<div class="brief">
+ The AccelerometerSuccessCallback interface provides a SuccessCallback for the getCurrentAcceleration and watchAcceleration methods.
+ </div>
+<pre class="webidl prettyprint"> [Callback=FunctionOnly, NoInterfaceObject] interface AccelerometerSuccessCallback {
+ void onsuccess(<a href="#Acceleration">Acceleration</a> acceleration);
+ };</pre>
+<div class="methods">
+<h4>Methods</h4>
+<dl>
+<dt class="method" id="AccelerometerSuccessCallback::onsuccess">
+<a class="backward-compatibility-anchor" name="::DeviceMotion::AccelerometerSuccessCallback::onsuccess"></a><code><b><span class="methodName">onsuccess</span></b></code>
+</dt>
+<dd>
+<div class="synopsis"><pre class="signature prettyprint">void onsuccess(<a href="#Acceleration">Acceleration</a> acceleration);
+ </pre></div>
+<p><span class="version">
+ Since: </span>
+ 3.0
+ </p>
+<div class="parameters">
+<p><span class="param">Parameters:</span></p>
+<ul>
+ <li class="param">
+<span class="name">acceleration</span>:
+ The acceleration at a single moment in time.
+ </li>
+ </ul>
+</div>
+</dd>
+</dl>
+</div>
+</div>
+</div>
+<h2 id="api-features">2. Related Feature</h2>
+<div id="def-api-features" class="def-api-features">
+ You can check if this API is supported with <em>tizen.systeminfo.getCapability()</em> and decide enable/disable codes that need this API.
+ <div class="def-api-feature">
+<p><div class="description">
+ <p>
+To guarantee that the DeviceMotion application runs on a device with the DeviceMotion feature declare the following feature requirements in the config file:
+ </p>
+ </div></p>
+<li class="feature">http://tizen.org/feature/sensor.accelerometer</li>
+</div>
+<p></p>
+ For more information, see <a href="../../org.tizen.gettingstarted/html/tizen_overview/application_filtering.htm">Application Filtering.</a>
+</div>
+<h2 id="full-webidl">3. Full WebIDL</h2>
+<pre class="webidl prettyprint">module DeviceMotion {
+ [NoInterfaceObject] interface AccelerometerManagerObject {
+ readonly attribute <a href="#Accelerometer">Accelerometer</a> accelerometer;
+ };
+ implements <a href="#AccelerometerManagerObject">AccelerometerManagerObject</a>;
+ [NoInterfaceObject] interface Accelerometer {
+ void getCurrentAcceleration(<a href="#AccelerometerSuccessCallback">AccelerometerSuccessCallback</a> onsuccess, <a href="cordova.html#ErrorCallback">ErrorCallback</a><a href="file.html#ErrorCallback">ErrorCallback</a> onerror);
+
+ DOMString watchAcceleration(<a href="#AccelerometerSuccessCallback">AccelerometerSuccessCallback</a> onsuccess, <a href="cordova.html#ErrorCallback">ErrorCallback</a><a href="file.html#ErrorCallback">ErrorCallback</a> onerror, optional <a href="#AccelerationOptions">AccelerationOptions</a>? options);
+
+ void clearWatch(DOMString watchID);
+
+ };
+
+ [NoInterfaceObject] interface Acceleration {
+ readonly attribute double x;
+
+ readonly attribute double y;
+
+ readonly attribute double z;
+
+ readonly attribute long timestamp;
+
+ };
+
+ dictionary AccelerationOptions {
+ long frequency;
+ };
+
+ [Callback=FunctionOnly, NoInterfaceObject] interface AccelerometerSuccessCallback {
+ void onsuccess(<a href="#Acceleration">Acceleration</a> acceleration);
+ };
+
+};</pre>
+</div>
+<div id="page-footer">
+<div class="copyright" align="center">
+ Except as noted, this content - excluding the Code Examples - is licensed under <a href="http://creativecommons.org/licenses/by/3.0/legalcode" target="_blank">Creative Commons Attribution 3.0</a> and all of the Code Examples contained herein are licensed under <a href="https://www.tizen.org/bsd-3-clause-license" target="_blank">BSD-3-Clause</a>. <br>For details, see the <a href="https://www.tizen.org/content-license" target="_blank">Content License</a>.
+ </div>
+<script type="text/javascript">
+
+ var _gaq = _gaq || [];
+ _gaq.push(['_setAccount', 'UA-25976949-1']);
+ _gaq.push(['_setDomainName', 'tizen.org']);
+ _gaq.push(['_trackPageview']);
+
+ (function() {
+ var ga = document.createElement('script'); ga.type = 'text/javascript'; ga.async = true;
+ var s = document.getElementsByTagName('script')[0]; s.parentNode.insertBefore(ga, s);
+ })();
+
+ </script>
+</div>
+</body>
+</html>
--- /dev/null
+<!DOCTYPE html PUBLIC "html">
+<html>
+<head>
+<meta http-equiv="Content-Type" content="text/html; charset=utf-8">
+<link rel="stylesheet" type="text/css" href="../tizen.css" media="screen">
+<script type="text/javascript" src="snippet.js"></script><title>Device API</title>
+</head>
+<body id="page-content" onload="prettyPrint()">
+<div class="api" id="::Device">
+
+<div class="title"><h1>Device API</h1></div>
+<div class="brief">
+ This plugin defines a global device object, which describes the device's hardware and software.
+Although the object is in the global scope, it is not available until the deviceready event.
+ </div>
+<div class="description">
+ <p>
+Original documentation: <a href="https://cordova.apache.org/docs/en/3.0.0/cordova/device/device.html">Cordova Device</a>.
+ </p>
+ </div>
+<p><span class="version">
+ Since: </span>
+ 3.0
+ </p>
+<h2>Table of Contents</h2>
+<ul class="toc">
+<li>1. <a href="#interfaces-section">Interfaces</a><ul class="toc">
+<li>1.1. <a href="#DeviceManagerObject">DeviceManagerObject</a>
+</li>
+<li>1.2. <a href="#Device">Device</a>
+</li>
+</ul>
+</li>
+<li>2. <a href="#full-webidl">Full WebIDL</a>
+</li>
+</ul>
+<hr>
+<h2 id="method-summary">Summary of Interfaces and Methods</h2>
+<table class="informaltable">
+<thead><tr>
+<th>Interface</th>
+<th>Method</th>
+</tr></thead>
+<tbody>
+<tr>
+<td><a href="#DeviceManagerObject">DeviceManagerObject</a></td>
+<td></td>
+</tr>
+<tr>
+<td><a href="#Device">Device</a></td>
+<td></td>
+</tr>
+</tbody>
+</table>
+<div class="interfaces" id="interfaces-section">
+<h2>1. Interfaces</h2>
+<div class="interface" id="DeviceManagerObject">
+<a class="backward-compatibility-anchor" name="::Device::DeviceManagerObject"></a><h3>1.1. DeviceManagerObject</h3>
+<div class="brief">
+ The <em>window.device </em>object allows access to the functionality of the Device API.
+ </div>
+<pre class="webidl prettyprint"> [NoInterfaceObject] interface DeviceManagerObject {
+ readonly attribute <a href="#Device">Device</a> device;
+ };</pre>
+<pre class="webidl prettyprint"> Window implements <a href="#DeviceManagerObject">DeviceManagerObject</a>;</pre>
+<p><span class="version">
+ Since: </span>
+ 3.0
+ </p>
+</div>
+<div class="interface" id="Device">
+<a class="backward-compatibility-anchor" name="::Device::Device"></a><h3>1.2. Device</h3>
+<div class="brief">
+ The device object describes the device's hardware and software.
+ </div>
+<pre class="webidl prettyprint"> [NoInterfaceObject] interface Device {
+ readonly attribute DOMString cordova;
+
+ readonly attribute DOMString model;
+
+ readonly attribute DOMString platform;
+
+ readonly attribute DOMString uuid;
+
+ readonly attribute DOMString version;
+
+ };</pre>
+<div class="attributes">
+<h4>Attributes</h4>
+<ul>
+<li class="attribute" id="Device::cordova">
+<span class="attrName"><span class="readonly"> readonly
+</span><span class="type">DOMString </span><span class="name">cordova</span></span><div class="brief">
+ Returns the version of Cordova running on the device.
+ </div>
+<div class="example">
+<span class="example"><p>Code example:</p></span><pre name="code" class="examplecode prettyprint"> document.addEventListener('deviceready', onDeviceReady, false);
+
+ function onDeviceReady() {
+ console.log('Device Cordova: ' + device.cordova);
+ }
+ </pre>
+</div>
+<div class="output">
+<span class="title"><p>Output example:</p></span><pre>Device Cordova: 5.1.1
+</pre>
+</div>
+</li>
+<li class="attribute" id="Device::model">
+<span class="attrName"><span class="readonly"> readonly
+</span><span class="type">DOMString </span><span class="name">model</span></span><div class="brief">
+ Get the the name of the device's model or product. The value is set by the device manufacturer and may be different across versions of the same product.
+ </div>
+<div class="example">
+<span class="example"><p>Code example:</p></span><pre name="code" class="examplecode prettyprint"> document.addEventListener('deviceready', onDeviceReady, false);
+
+ function onDeviceReady() {
+ console.log('Device Model: ' + device.model);
+ }
+ </pre>
+</div>
+<div class="output">
+<span class="title"><p>Output example:</p></span><pre>Device Model: tm1
+</pre>
+</div>
+</li>
+<li class="attribute" id="Device::platform">
+<span class="attrName"><span class="readonly"> readonly
+</span><span class="type">DOMString </span><span class="name">platform</span></span><div class="brief">
+ Get the device's operating system name.
+ </div>
+<div class="example">
+<span class="example"><p>Code example:</p></span><pre name="code" class="examplecode prettyprint"> document.addEventListener('deviceready', onDeviceReady, false);
+
+ function onDeviceReady() {
+ console.log('Device Platform: ' + device.platform);
+ }
+ </pre>
+</div>
+<div class="output">
+<span class="title"><p>Output example:</p></span><pre>Device Platform: Tizen
+</pre>
+</div>
+</li>
+<li class="attribute" id="Device::uuid">
+<span class="attrName"><span class="readonly"> readonly
+</span><span class="type">DOMString </span><span class="name">uuid</span></span><div class="brief">
+ Get the device's Universally Unique Identifier (UUID). The details of how a UUID is generated are determined by the device manufacturer and are specific to the device's platform or model.
+ </div>
+<div class="example">
+<span class="example"><p>Code example:</p></span><pre name="code" class="examplecode prettyprint"> document.addEventListener('deviceready', onDeviceReady, false);
+
+ function onDeviceReady() {
+ console.log('Device UUID: ' + device.uuid);
+ }
+ </pre>
+</div>
+<div class="output">
+<span class="title"><p>Output example:</p></span><pre>Device UUID: 2LR1b3MXfEUSFvH04m4e1EXYvQA=
+</pre>
+</div>
+</li>
+<li class="attribute" id="Device::version">
+<span class="attrName"><span class="readonly"> readonly
+</span><span class="type">DOMString </span><span class="name">version</span></span><div class="brief">
+ Get the operating system version.
+ </div>
+<div class="example">
+<span class="example"><p>Code example:</p></span><pre name="code" class="examplecode prettyprint"> document.addEventListener('deviceready', onDeviceReady, false);
+
+ function onDeviceReady() {
+ console.log('Device Version: ' + device.version);
+ }
+ </pre>
+</div>
+<div class="output">
+<span class="title"><p>Output example:</p></span><pre>Device Version: 3.0
+</pre>
+</div>
+</li>
+</ul>
+</div>
+</div>
+</div>
+<h2 id="full-webidl">2. Full WebIDL</h2>
+<pre class="webidl prettyprint">module Device {
+ [NoInterfaceObject] interface DeviceManagerObject {
+ readonly attribute <a href="#Device">Device</a> device;
+ };
+ Window implements <a href="#DeviceManagerObject">DeviceManagerObject</a>;
+ [NoInterfaceObject] interface Device {
+ readonly attribute DOMString cordova;
+
+ readonly attribute DOMString model;
+
+ readonly attribute DOMString platform;
+
+ readonly attribute DOMString uuid;
+
+ readonly attribute DOMString version;
+
+ };
+};</pre>
+</div>
+<div id="page-footer">
+<div class="copyright" align="center">
+ Except as noted, this content - excluding the Code Examples - is licensed under <a href="http://creativecommons.org/licenses/by/3.0/legalcode" target="_blank">Creative Commons Attribution 3.0</a> and all of the Code Examples contained herein are licensed under <a href="https://www.tizen.org/bsd-3-clause-license" target="_blank">BSD-3-Clause</a>. <br>For details, see the <a href="https://www.tizen.org/content-license" target="_blank">Content License</a>.
+ </div>
+<script type="text/javascript">
+
+ var _gaq = _gaq || [];
+ _gaq.push(['_setAccount', 'UA-25976949-1']);
+ _gaq.push(['_setDomainName', 'tizen.org']);
+ _gaq.push(['_trackPageview']);
+
+ (function() {
+ var ga = document.createElement('script'); ga.type = 'text/javascript'; ga.async = true;
+ var s = document.getElementsByTagName('script')[0]; s.parentNode.insertBefore(ga, s);
+ })();
+
+ </script>
+</div>
+</body>
+</html>
--- /dev/null
+<!DOCTYPE html PUBLIC "html">
+<html>
+<head>
+<meta http-equiv="Content-Type" content="text/html; charset=utf-8">
+<link rel="stylesheet" type="text/css" href="../tizen.css" media="screen">
+<script type="text/javascript" src="snippet.js"></script><title>Dialogs API</title>
+</head>
+<body id="page-content" onload="prettyPrint()">
+<div class="api" id="::Dialogs">
+
+<div class="title"><h1>Dialogs API</h1></div>
+<div class="brief">
+ This plugin provides the ability to make different types of notifications to the user.
+ </div>
+<div class="description">
+ <p>
+Original documentation: <a href="https://www.npmjs.com/package/cordova-plugin-dialogs">Cordova Dialogs</a>.
+ </p>
+ </div>
+<h2>Table of Contents</h2>
+<ul class="toc">
+<li>1. <a href="#interfaces-section">Interfaces</a><ul class="toc">
+<li>1.1. <a href="#DialogsManagerObject">DialogsManagerObject</a>
+</li>
+<li>1.2. <a href="#DialogsManager">DialogsManager</a>
+</li>
+<li>1.3. <a href="#PromptData">PromptData</a>
+</li>
+<li>1.4. <a href="#ConfirmCallback">ConfirmCallback</a>
+</li>
+<li>1.5. <a href="#PromptCallback">PromptCallback</a>
+</li>
+</ul>
+</li>
+<li>2. <a href="#full-webidl">Full WebIDL</a>
+</li>
+</ul>
+<hr>
+<h2 id="method-summary">Summary of Interfaces and Methods</h2>
+<table class="informaltable">
+<thead><tr>
+<th>Interface</th>
+<th>Method</th>
+</tr></thead>
+<tbody>
+<tr>
+<td><a href="#DialogsManagerObject">DialogsManagerObject</a></td>
+<td></td>
+</tr>
+<tr>
+<td><a href="#DialogsManager">DialogsManager</a></td>
+<td>
+<div>void <a href="#DialogsManager::alert">alert</a> (DOMString message, <a href="cordova.html#SuccessCallback">SuccessCallback</a> alertCallback, optional DOMString? title, optional DOMString? buttonName)</div>
+<div>void <a href="#DialogsManager::confirm">confirm</a> (DOMString message, <a href="#ConfirmCallback">ConfirmCallback</a> confirmCallback, optional DOMString? title, optional DOMString[]? buttonNames)</div>
+<div>void <a href="#DialogsManager::prompt">prompt</a> (DOMString message, <a href="#PromptCallback">PromptCallback</a> promptCallback, optional DOMString? title, optional DOMString[]? buttonNames, optional DOMString? defaultText)</div>
+<div>void <a href="#DialogsManager::beep">beep</a> (long times)</div>
+</td>
+</tr>
+<tr>
+<td><a href="#PromptData">PromptData</a></td>
+<td></td>
+</tr>
+<tr>
+<td><a href="#ConfirmCallback">ConfirmCallback</a></td>
+<td><div>void <a href="#ConfirmCallback::onsuccess">onsuccess</a> (long buttonIndex)</div></td>
+</tr>
+<tr>
+<td><a href="#PromptCallback">PromptCallback</a></td>
+<td><div>void <a href="#PromptCallback::onsuccess">onsuccess</a> (<a href="#PromptData">PromptData</a> data)</div></td>
+</tr>
+</tbody>
+</table>
+<div class="interfaces" id="interfaces-section">
+<h2>1. Interfaces</h2>
+<div class="interface" id="DialogsManagerObject">
+<a class="backward-compatibility-anchor" name="::Dialogs::DialogsManagerObject"></a><h3>1.1. DialogsManagerObject</h3>
+<div class="brief">
+ The <em>DialogsManagerObject</em> interface defines what is instantiated in the <em>Navigator</em> object.
+ </div>
+<pre class="webidl prettyprint"> [NoInterfaceObject] interface DialogsManagerObject {
+ readonly attribute <a href="#DialogsManager">DialogsManager</a> notification;
+ };</pre>
+<pre class="webidl prettyprint"> implements <a href="#DialogsManagerObject">DialogsManagerObject</a>;</pre>
+<div class="description">
+ <p>
+The <em>navigator.notification</em> object allows access to the Dialogs API.
+ </p>
+ </div>
+</div>
+<div class="interface" id="DialogsManager">
+<a class="backward-compatibility-anchor" name="::Dialogs::DialogsManager"></a><h3>1.2. DialogsManager</h3>
+<div class="brief">
+ The <em>DialogsManager</em> interface provides methods for global operations related to notifications to the user.
+ </div>
+<pre class="webidl prettyprint"> [NoInterfaceObject] interface DialogsManager {
+ void alert(DOMString message, <a href="cordova.html#SuccessCallback">SuccessCallback</a> alertCallback, optional DOMString? title, optional DOMString? buttonName);
+
+ void confirm(DOMString message, <a href="#ConfirmCallback">ConfirmCallback</a> confirmCallback, optional DOMString? title, optional DOMString[]? buttonNames);
+
+ void prompt(DOMString message, <a href="#PromptCallback">PromptCallback</a> promptCallback,
+ optional DOMString? title, optional DOMString[]? buttonNames, optional DOMString? defaultText);
+
+ void beep(long times);
+ };</pre>
+<div class="methods">
+<h4>Methods</h4>
+<dl>
+<dt class="method" id="DialogsManager::alert">
+<a class="backward-compatibility-anchor" name="::Dialogs::DialogsManager::alert"></a><code><b><span class="methodName">alert</span></b></code>
+</dt>
+<dd>
+<div class="brief">
+ Shows a custom alert with one button.
+ </div>
+<div class="synopsis"><pre class="signature prettyprint">void alert(DOMString message, <a href="cordova.html#SuccessCallback">SuccessCallback</a> alertCallback, optional DOMString? title, optional DOMString? buttonName);
+ </pre></div>
+<p><span class="version">
+ Since: </span>
+ 3.0
+ </p>
+<div class="parameters">
+<p><span class="param">Parameters:</span></p>
+<ul>
+ <li class="param">
+<span class="name">message</span>:
+ The message to be shown to the user by dialog dialog.
+ </li>
+ <li class="param">
+<span class="name">alertCallback</span>:
+ The callback to be invoked when alert dialog would be dismissed.
+ </li>
+ <li class="param">
+<span class="name">title</span><span class="optional"> [optional]</span><span class="optional"> [nullable]</span>:
+ The title of dialog box. Default value is 'Dialog'.
+ </li>
+ <li class="param">
+<span class="name">buttonName</span><span class="optional"> [optional]</span><span class="optional"> [nullable]</span>:
+ Button name to be shown on dialog box. Default value is 'OK'.
+ </li>
+ </ul>
+</div>
+<div class="example">
+<span class="example"><p>Code example:</p></span><pre name="code" class="examplecode prettyprint"> var alertDismissed = function() {
+ console.log('Alert was dismissed');
+ }
+
+ navigator.notification.alert('Please click OK button', alertDismissed,
+ 'OK click alert', 'OK');
+ </pre>
+</div>
+<div class="output">
+<span class="title"><p>Output example:</p></span><pre>Alert was dismissed
+</pre>
+</div>
+</dd>
+<dt class="method" id="DialogsManager::confirm">
+<a class="backward-compatibility-anchor" name="::Dialogs::DialogsManager::confirm"></a><code><b><span class="methodName">confirm</span></b></code>
+</dt>
+<dd>
+<div class="brief">
+ Shows a custom confirm box with set of buttons.
+ </div>
+<div class="synopsis"><pre class="signature prettyprint">void confirm(DOMString message, <a href="#ConfirmCallback">ConfirmCallback</a> confirmCallback, optional DOMString? title, optional DOMString[]? buttonNames);
+ </pre></div>
+<p><span class="version">
+ Since: </span>
+ 3.0
+ </p>
+<div class="parameters">
+<p><span class="param">Parameters:</span></p>
+<ul>
+ <li class="param">
+<span class="name">message</span>:
+ The message to be shown to the user by dialog box.
+ </li>
+ <li class="param">
+<span class="name">confirmCallback</span>:
+ The callback to be invoked when user perform an action on dialog box.
+Callback provides index of button pressed (1,2,3 etc.) or 0, if dialog was dismissed without button press.
+ </li>
+ <li class="param">
+<span class="name">title</span><span class="optional"> [optional]</span><span class="optional"> [nullable]</span>:
+ The title of dialog box. Default value is 'Confirm'.
+ </li>
+ <li class="param">
+<span class="name">buttonNames</span><span class="optional"> [optional]</span><span class="optional"> [nullable]</span>:
+ Button names to be shown on dialog box. Default values are ['OK', 'Cancel'].
+ </li>
+ </ul>
+</div>
+<div class="example">
+<span class="example"><p>Code example:</p></span><pre name="code" class="examplecode prettyprint"> var confirmCallback = function(buttonIndex) {
+ console.log('Selected option was ' + buttonIndex);
+ }
+
+ navigator.notification.confirm('Choose one option', confirmCallback,
+ 'Options', ['Option1', 'Option2']);
+ </pre>
+</div>
+<div class="output">
+<span class="title"><p>Output example:</p></span><pre>Selected option was 1
+</pre>
+</div>
+</dd>
+<dt class="method" id="DialogsManager::prompt">
+<a class="backward-compatibility-anchor" name="::Dialogs::DialogsManager::prompt"></a><code><b><span class="methodName">prompt</span></b></code>
+</dt>
+<dd>
+<div class="brief">
+ Shows a custom confirm box with set of buttons.
+ </div>
+<div class="synopsis"><pre class="signature prettyprint">void prompt(DOMString message, <a href="#PromptCallback">PromptCallback</a> promptCallback, optional DOMString? title, optional DOMString[]? buttonNames, optional DOMString? defaultText);
+ </pre></div>
+<p><span class="version">
+ Since: </span>
+ 3.0
+ </p>
+<div class="parameters">
+<p><span class="param">Parameters:</span></p>
+<ul>
+ <li class="param">
+<span class="name">message</span>:
+ The message to be shown to the user by dialog box.
+ </li>
+ <li class="param">
+<span class="name">promptCallback</span>:
+ The callback to be invoked when user perform an action on dialog box.
+Callback provides <em>PromptData</em> object, which holds all data provided by user.
+ </li>
+ <li class="param">
+<span class="name">title</span><span class="optional"> [optional]</span><span class="optional"> [nullable]</span>:
+ The title of dialog box. Default value is 'Prompt'.
+ </li>
+ <li class="param">
+<span class="name">buttonNames</span><span class="optional"> [optional]</span><span class="optional"> [nullable]</span>:
+ Button names to be shown on dialog box. Default values are ['OK', 'Cancel'].
+ </li>
+ <li class="param">
+<span class="name">defaultText</span><span class="optional"> [optional]</span><span class="optional"> [nullable]</span>:
+ Default text to be shown in textbox of dialog box. Default value is an empty string ('').
+ </li>
+ </ul>
+</div>
+<div class="example">
+<span class="example"><p>Code example:</p></span><pre name="code" class="examplecode prettyprint"> var promptCallback = function(results) {
+ console.log('Hello ' + results.input1 + ', you selected option ' + results.buttonIndex);
+ }
+
+ navigator.notification.prompt('Please enter your name',
+ promptCallback,
+ 'Registration Box',
+ ['Ok', 'Exit'],
+ 'e.g. Jane Doe');
+ </pre>
+</div>
+<div class="output">
+<span class="title"><p>Output example:</p></span><pre>Hello Jane Doe, you selected option 1
+</pre>
+</div>
+</dd>
+<dt class="method" id="DialogsManager::beep">
+<a class="backward-compatibility-anchor" name="::Dialogs::DialogsManager::beep"></a><code><b><span class="methodName">beep</span></b></code>
+</dt>
+<dd>
+<div class="brief">
+ Method allows to make custom number of beeps by device.
+ </div>
+<div class="synopsis"><pre class="signature prettyprint">void beep(long times);
+ </pre></div>
+<p><span class="version">
+ Since: </span>
+ 3.0
+ </p>
+<div class="parameters">
+<p><span class="param">Parameters:</span></p>
+<ul>
+ <li class="param">
+<span class="name">times</span>:
+ The number of times to repeat the beep.
+ </li>
+ </ul>
+</div>
+<div class="example">
+<span class="example"><p>Code example:</p></span><pre name="code" class="examplecode prettyprint"> var times = 2;
+ console.log('Device would beep ' + times + ' times');
+ navigator.notification.beep(times);
+ </pre>
+</div>
+<div class="output">
+<span class="title"><p>Output example:</p></span><pre>Device would beep 2 times
+</pre>
+</div>
+</dd>
+</dl>
+</div>
+</div>
+<div class="interface" id="PromptData">
+<a class="backward-compatibility-anchor" name="::Dialogs::PromptData"></a><h3>1.3. PromptData</h3>
+<div class="brief">
+ The object returned from prompt dialog.
+ </div>
+<pre class="webidl prettyprint"> [NoInterfaceObject] interface PromptData {
+ readonly attribute long buttonIndex;
+
+ readonly attribute DOMString input1;
+ };</pre>
+<p><span class="remark"> Remark : </span>
+ Example usage is described on method <a href="#DialogsManager::prompt">prompt</a>.
+ </p>
+<div class="attributes">
+<h4>Attributes</h4>
+<ul>
+<li class="attribute" id="PromptData::buttonIndex">
+<span class="attrName"><span class="readonly"> readonly
+</span><span class="type">long </span><span class="name">buttonIndex</span></span><div class="brief">
+ The index of button, which was pressed by user.
+the index uses one-based indexing, so the values could be 1, 2, 3, etc.
+ </div>
+<p><span class="version">
+ Since: </span>
+ 3.0
+ </p>
+</li>
+<li class="attribute" id="PromptData::input1">
+<span class="attrName"><span class="readonly"> readonly
+</span><span class="type">DOMString </span><span class="name">input1</span></span><div class="brief">
+ The text entered by user in the prompt of dialog box.
+ </div>
+<p><span class="version">
+ Since: </span>
+ 3.0
+ </p>
+</li>
+</ul>
+</div>
+</div>
+<div class="interface" id="ConfirmCallback">
+<a class="backward-compatibility-anchor" name="::Dialogs::ConfirmCallback"></a><h3>1.4. ConfirmCallback</h3>
+<div class="brief">
+ The callback function used to return index of pressed button of confirm dialog.
+ </div>
+<pre class="webidl prettyprint"> [Callback=FunctionOnly, NoInterfaceObject] interface ConfirmCallback {
+ void onsuccess(long buttonIndex);
+ };</pre>
+<p><span class="remark"> Remark : </span>
+ Example usage is described on method <a href="#DialogsManager::confirm">confirm</a>.
+ </p>
+<div class="methods">
+<h4>Methods</h4>
+<dl>
+<dt class="method" id="ConfirmCallback::onsuccess">
+<a class="backward-compatibility-anchor" name="::Dialogs::ConfirmCallback::onsuccess"></a><code><b><span class="methodName">onsuccess</span></b></code>
+</dt>
+<dd>
+<div class="brief">
+ Called when the user perform action on confirm dialog.
+ </div>
+<div class="synopsis"><pre class="signature prettyprint">void onsuccess(long buttonIndex);
+ </pre></div>
+<p><span class="version">
+ Since: </span>
+ 3.0
+ </p>
+<div class="parameters">
+<p><span class="param">Parameters:</span></p>
+<ul>
+ <li class="param">
+<span class="name">buttonIndex</span>:
+ The index of button, which was pressed by user.
+the index uses one-based indexing, so the values could be 1, 2, 3, etc.
+ </li>
+ </ul>
+</div>
+</dd>
+</dl>
+</div>
+</div>
+<div class="interface" id="PromptCallback">
+<a class="backward-compatibility-anchor" name="::Dialogs::PromptCallback"></a><h3>1.5. PromptCallback</h3>
+<div class="brief">
+ The callback function used to return data from prompt dialog.
+ </div>
+<pre class="webidl prettyprint"> [Callback=FunctionOnly, NoInterfaceObject] interface PromptCallback {
+ void onsuccess(<a href="#PromptData">PromptData</a> data);
+ };</pre>
+<p><span class="remark"> Remark : </span>
+ Example usage is described on method <a href="#DialogsManager::prompt">prompt</a>.
+ </p>
+<div class="methods">
+<h4>Methods</h4>
+<dl>
+<dt class="method" id="PromptCallback::onsuccess">
+<a class="backward-compatibility-anchor" name="::Dialogs::PromptCallback::onsuccess"></a><code><b><span class="methodName">onsuccess</span></b></code>
+</dt>
+<dd>
+<div class="brief">
+ Called when the user perform action on prompt dialog.
+ </div>
+<div class="synopsis"><pre class="signature prettyprint">void onsuccess(<a href="#PromptData">PromptData</a> data);
+ </pre></div>
+<p><span class="version">
+ Since: </span>
+ 3.0
+ </p>
+<div class="parameters">
+<p><span class="param">Parameters:</span></p>
+<ul>
+ <li class="param">
+<span class="name">data</span>:
+ The data input into dialog box.
+ </li>
+ </ul>
+</div>
+</dd>
+</dl>
+</div>
+</div>
+</div>
+<h2 id="full-webidl">2. Full WebIDL</h2>
+<pre class="webidl prettyprint">module Dialogs {
+ [NoInterfaceObject] interface DialogsManagerObject {
+ readonly attribute <a href="#DialogsManager">DialogsManager</a> notification;
+ };
+
+ implements <a href="#DialogsManagerObject">DialogsManagerObject</a>;
+
+ [NoInterfaceObject] interface DialogsManager {
+ void alert(DOMString message, <a href="cordova.html#SuccessCallback">SuccessCallback</a> alertCallback, optional DOMString? title, optional DOMString? buttonName);
+
+ void confirm(DOMString message, <a href="#ConfirmCallback">ConfirmCallback</a> confirmCallback, optional DOMString? title, optional DOMString[]? buttonNames);
+
+ void prompt(DOMString message, <a href="#PromptCallback">PromptCallback</a> promptCallback,
+ optional DOMString? title, optional DOMString[]? buttonNames, optional DOMString? defaultText);
+
+ void beep(long times);
+ };
+
+ [NoInterfaceObject] interface PromptData {
+ readonly attribute long buttonIndex;
+
+ readonly attribute DOMString input1;
+ };
+
+ [Callback=FunctionOnly, NoInterfaceObject] interface ConfirmCallback {
+ void onsuccess(long buttonIndex);
+ };
+
+ [Callback=FunctionOnly, NoInterfaceObject] interface PromptCallback {
+ void onsuccess(<a href="#PromptData">PromptData</a> data);
+ };
+
+};</pre>
+</div>
+<div id="page-footer">
+<div class="copyright" align="center">
+ Except as noted, this content - excluding the Code Examples - is licensed under <a href="http://creativecommons.org/licenses/by/3.0/legalcode" target="_blank">Creative Commons Attribution 3.0</a> and all of the Code Examples contained herein are licensed under <a href="https://www.tizen.org/bsd-3-clause-license" target="_blank">BSD-3-Clause</a>. <br>For details, see the <a href="https://www.tizen.org/content-license" target="_blank">Content License</a>.
+ </div>
+<script type="text/javascript">
+
+ var _gaq = _gaq || [];
+ _gaq.push(['_setAccount', 'UA-25976949-1']);
+ _gaq.push(['_setDomainName', 'tizen.org']);
+ _gaq.push(['_trackPageview']);
+
+ (function() {
+ var ga = document.createElement('script'); ga.type = 'text/javascript'; ga.async = true;
+ var s = document.getElementsByTagName('script')[0]; s.parentNode.insertBefore(ga, s);
+ })();
+
+ </script>
+</div>
+</body>
+</html>
--- /dev/null
+<!DOCTYPE html PUBLIC "html">
+<html>
+<head>
+<meta http-equiv="Content-Type" content="text/html; charset=utf-8">
+<link rel="stylesheet" type="text/css" href="../tizen.css" media="screen">
+<script type="text/javascript" src="snippet.js"></script><title>Events API</title>
+</head>
+<body id="page-content" onload="prettyPrint()">
+<div class="api" id="::Events">
+
+<div class="title"><h1>Events API</h1></div>
+<div class="brief">
+ This plugin provides information about events defined in cordova.
+ </div>
+<div class="description">
+ <p>
+Original documentation: <a href="https://cordova.apache.org/docs/en/latest/cordova/events/events.html">Cordova Events</a>.
+ </p>
+ <table>
+ <tr>
+ <th>
+Event name </th>
+ <th>
+Event handler callback </th>
+ </tr>
+ <tr>
+ <td>
+deviceready </td>
+ <td>
+<a href="#DeviceReadyEventCallback">DeviceReadyEventCallback</a> </td>
+ </tr>
+ <tr>
+ <td>
+pause </td>
+ <td>
+<a href="#PauseEventCallback">PauseEventCallback</a> </td>
+ </tr>
+ <tr>
+ <td>
+resume </td>
+ <td>
+<a href="#ResumeEventCallback">ResumeEventCallback</a> </td>
+ </tr>
+ <tr>
+ <td>
+backbutton </td>
+ <td>
+<a href="#BackButtonEventCallback">BackButtonEventCallback</a> </td>
+ </tr>
+ <tr>
+ <td>
+menubutton </td>
+ <td>
+<a href="#MenuButtonEventCallback">MenuButtonEventCallback</a> </td>
+ </tr>
+ <tr>
+ <td>
+searchbutton </td>
+ <td>
+<a href="#SearchButtonEventCallback">SearchButtonEventCallback</a> </td>
+ </tr>
+ <tr>
+ <td>
+startcallbutton </td>
+ <td>
+<a href="#StartCallEventCallback">StartCallEventCallback</a> </td>
+ </tr>
+ <tr>
+ <td>
+endcallbutton </td>
+ <td>
+<a href="#EndCallButtonEventCallback">EndCallButtonEventCallback</a> </td>
+ </tr>
+ <tr>
+ <td>
+volumedownbutton </td>
+ <td>
+<a href="#VolumeDownButtonEventCallback">VolumeDownButtonEventCallback</a> </td>
+ </tr>
+ <tr>
+ <td>
+volumeupbutton </td>
+ <td>
+<a href="#VolumeUpButtonEventCallback">VolumeUpButtonEventCallback</a> </td>
+ </tr>
+ <tr>
+ <th colspan="2">
+Network Information events </th>
+ </tr>
+ <tr>
+ <td>
+online </td>
+ <td>
+<a href="networkInformation.html#OnlineEventCallback">OnlineEventCallback</a> </td>
+ </tr>
+ <tr>
+ <td>
+offline </td>
+ <td>
+<a href="networkInformation.html#OfflineEventCallback">OfflineEventCallback</a> </td>
+ </tr>
+ </table>
+ </div>
+<h2>Table of Contents</h2>
+<ul class="toc">
+<li>1. <a href="#interfaces-section">Interfaces</a><ul class="toc">
+<li>1.1. <a href="#DeviceReadyEventCallback">DeviceReadyEventCallback</a>
+</li>
+<li>1.2. <a href="#PauseEventCallback">PauseEventCallback</a>
+</li>
+<li>1.3. <a href="#ResumeEventCallback">ResumeEventCallback</a>
+</li>
+<li>1.4. <a href="#BackButtonEventCallback">BackButtonEventCallback</a>
+</li>
+<li>1.5. <a href="#MenuButtonEventCallback">MenuButtonEventCallback</a>
+</li>
+<li>1.6. <a href="#SearchButtonEventCallback">SearchButtonEventCallback</a>
+</li>
+<li>1.7. <a href="#StartCallEventCallback">StartCallEventCallback</a>
+</li>
+<li>1.8. <a href="#EndCallButtonEventCallback">EndCallButtonEventCallback</a>
+</li>
+<li>1.9. <a href="#VolumeDownButtonEventCallback">VolumeDownButtonEventCallback</a>
+</li>
+<li>1.10. <a href="#VolumeUpButtonEventCallback">VolumeUpButtonEventCallback</a>
+</li>
+</ul>
+</li>
+<li>2. <a href="#full-webidl">Full WebIDL</a>
+</li>
+</ul>
+<hr>
+<h2 id="method-summary">Summary of Interfaces and Methods</h2>
+<table class="informaltable">
+<thead><tr>
+<th>Interface</th>
+<th>Method</th>
+</tr></thead>
+<tbody>
+<tr>
+<td><a href="#DeviceReadyEventCallback">DeviceReadyEventCallback</a></td>
+<td><div>void <a href="#DeviceReadyEventCallback::ondeviceready">ondeviceready</a> ()</div></td>
+</tr>
+<tr>
+<td><a href="#PauseEventCallback">PauseEventCallback</a></td>
+<td><div>void <a href="#PauseEventCallback::onpause">onpause</a> ()</div></td>
+</tr>
+<tr>
+<td><a href="#ResumeEventCallback">ResumeEventCallback</a></td>
+<td><div>void <a href="#ResumeEventCallback::onresume">onresume</a> ()</div></td>
+</tr>
+<tr>
+<td><a href="#BackButtonEventCallback">BackButtonEventCallback</a></td>
+<td><div>void <a href="#BackButtonEventCallback::onbackbutton">onbackbutton</a> ()</div></td>
+</tr>
+<tr>
+<td><a href="#MenuButtonEventCallback">MenuButtonEventCallback</a></td>
+<td><div>void <a href="#MenuButtonEventCallback::onmenubutton">onmenubutton</a> ()</div></td>
+</tr>
+<tr>
+<td><a href="#SearchButtonEventCallback">SearchButtonEventCallback</a></td>
+<td><div>void <a href="#SearchButtonEventCallback::onsearchbutton">onsearchbutton</a> ()</div></td>
+</tr>
+<tr>
+<td><a href="#StartCallEventCallback">StartCallEventCallback</a></td>
+<td><div>void <a href="#StartCallEventCallback::onstartcallbutton">onstartcallbutton</a> ()</div></td>
+</tr>
+<tr>
+<td><a href="#EndCallButtonEventCallback">EndCallButtonEventCallback</a></td>
+<td><div>void <a href="#EndCallButtonEventCallback::onendcallbutton">onendcallbutton</a> ()</div></td>
+</tr>
+<tr>
+<td><a href="#VolumeDownButtonEventCallback">VolumeDownButtonEventCallback</a></td>
+<td><div>void <a href="#VolumeDownButtonEventCallback::onvolumedownbutton">onvolumedownbutton</a> ()</div></td>
+</tr>
+<tr>
+<td><a href="#VolumeUpButtonEventCallback">VolumeUpButtonEventCallback</a></td>
+<td><div>void <a href="#VolumeUpButtonEventCallback::onvolumeupbutton">onvolumeupbutton</a> ()</div></td>
+</tr>
+</tbody>
+</table>
+<div class="interfaces" id="interfaces-section">
+<h2>1. Interfaces</h2>
+<div class="interface" id="DeviceReadyEventCallback">
+<a class="backward-compatibility-anchor" name="::Events::DeviceReadyEventCallback"></a><h3>1.1. DeviceReadyEventCallback</h3>
+<div class="brief">
+ Callback for the event which fires when Cordova is fully loaded
+ </div>
+<pre class="webidl prettyprint">[NoInterfaceObject, Callback=FunctionOnly]
+interface DeviceReadyEventCallback {
+ void ondeviceready();
+};</pre>
+<p><span class="version">
+ Since: </span>
+ 3.0
+ </p>
+<div class="description">
+ <p>
+The <var>domready</var> event is essential to any application. It signals that Cordova's device APIs have loaded and are ready to access.
+ </p>
+ <p>
+Cordova consists of two code bases: native and JavaScript. While the native code loads, a custom loading image displays. However, JavaScript only loads once the DOM loads. This means the web app may potentially call a Cordova JavaScript function before the corresponding native code becomes available.
+ </p>
+ <p>
+The deviceready event fires once Cordova has fully loaded. Once the event fires, you can safely make calls to Cordova APIs. Applications typically attach an event listener with document.addEventListener once the HTML document's DOM has loaded.
+ </p>
+ <p>
+The deviceready event behaves somewhat differently from others. Any event handler registered after the deviceready event fires has its callback function called immediately.
+ </p>
+ <p>
+Original documentation: <a href="https://cordova.apache.org/docs/en/latest/cordova/events/events.deviceready.html">Cordova deviceredy event</a> </p>
+ </div>
+<div class="example">
+<span class="example"><p>Code example:</p></span><pre name="code" class="examplecode prettyprint"> document.addEventListener('deviceready', onDeviceReady, false);
+
+ function onDeviceReady() {
+ // Now safe to use device APIs
+ }
+ </pre>
+</div>
+</div>
+<div class="interface" id="PauseEventCallback">
+<a class="backward-compatibility-anchor" name="::Events::PauseEventCallback"></a><h3>1.2. PauseEventCallback</h3>
+<div class="brief">
+ Callback for the event which fires when an application is put into the background
+ </div>
+<pre class="webidl prettyprint">[NoInterfaceObject, Callback=FunctionOnly]
+interface PauseEventCallback {
+ void onpause();
+};</pre>
+<p><span class="version">
+ Since: </span>
+ 3.0
+ </p>
+<div class="description">
+ <p>
+The <var>pause</var> event fires when the native platform puts the application into the background, typically when the user switches to a different application.
+ </p>
+ <p>
+Applications typically should use document.addEventListener() to attach an event listener once the <a href="#DeviceReadyEventCallback">deviceready</a> event fires.
+ </p>
+ <p>
+Original documentation: <a href="https://cordova.apache.org/docs/en/latest/cordova/events/events.pause.html">Cordova pause event</a> </p>
+ </div>
+<div class="example">
+<span class="example"><p>Code example:</p></span><pre name="code" class="examplecode prettyprint"> document.addEventListener('deviceready', onDeviceReady, false);
+
+ function onDeviceReady() {
+ document.addEventListener('pause', onPause, false);
+ }
+
+ function onPause() {
+ // Handle the pause event
+ }
+ </pre>
+</div>
+</div>
+<div class="interface" id="ResumeEventCallback">
+<a class="backward-compatibility-anchor" name="::Events::ResumeEventCallback"></a><h3>1.3. ResumeEventCallback</h3>
+<div class="brief">
+ Callback for the event which fires when an application is retrieved from the background
+ </div>
+<pre class="webidl prettyprint">[NoInterfaceObject, Callback=FunctionOnly]
+interface ResumeEventCallback {
+ void onresume();
+};</pre>
+<p><span class="version">
+ Since: </span>
+ 3.0
+ </p>
+<div class="description">
+ <p>
+The <var>resume</var> event fires when the native platform pulls the application out from the background.
+ </p>
+ <p>
+Applications typically should use document.addEventListener() to attach an event listener once the <a href="#DeviceReadyEventCallback">deviceready</a> event fires.
+ </p>
+ <p>
+Original documentation: <a href="https://cordova.apache.org/docs/en/latest/cordova/events/events.resume.html">Cordova resume event</a> </p>
+ </div>
+<div class="example">
+<span class="example"><p>Code example:</p></span><pre name="code" class="examplecode prettyprint"> document.addEventListener('deviceready', onDeviceReady, false);
+
+ function onDeviceReady() {
+ document.addEventListener('resume', onResume, false);
+ }
+
+ function onResume() {
+ // Handle the resume event
+ }
+ </pre>
+</div>
+</div>
+<div class="interface" id="BackButtonEventCallback">
+<a class="backward-compatibility-anchor" name="::Events::BackButtonEventCallback"></a><h3>1.4. BackButtonEventCallback</h3>
+<div class="brief">
+ Callback for the event which fires when the user presses the back button
+ </div>
+<pre class="webidl prettyprint">[NoInterfaceObject, Callback=FunctionOnly]
+interface BackButtonEventCallback {
+ void onbackbutton();
+};</pre>
+<p><span class="version">
+ Since: </span>
+ 3.0
+ </p>
+<div class="description">
+ <p>
+To override the default back-button behavior, register an event listener for the backbutton event, typically by calling document.addEventListener() once you receive the <a href="#DeviceReadyEventCallback">deviceready</a> event.
+It is no longer necessary to call any other method to override the back-button behavior.
+ </p>
+ <p>
+Original documentation: <a href="https://cordova.apache.org/docs/en/latest/cordova/events/events.backbutton.html">Cordova backbutton event</a> </p>
+ </div>
+<div class="example">
+<span class="example"><p>Code example:</p></span><pre name="code" class="examplecode prettyprint"> document.addEventListener('deviceready', onDeviceReady, false);
+
+ function onDeviceReady() {
+ document.addEventListener('backbutton', onBackKeyDown, false);
+ }
+
+ function onBackKeyDown() {
+ // Handle the back button
+ }
+ </pre>
+</div>
+</div>
+<div class="interface" id="MenuButtonEventCallback">
+<a class="backward-compatibility-anchor" name="::Events::MenuButtonEventCallback"></a><h3>1.5. MenuButtonEventCallback</h3>
+<div class="brief">
+ Callback for the event which fires when the user presses the menu button
+ </div>
+<pre class="webidl prettyprint">[NoInterfaceObject, Callback=FunctionOnly]
+interface MenuButtonEventCallback {
+ void onmenubutton();
+};</pre>
+<p><span class="version">
+ Since: </span>
+ 3.0
+ </p>
+<div class="description">
+ <p>
+Applying an event handler for the <var>menubutton</var> event overrides the default menu button behavior.
+ </p>
+ <p>
+Applications typically should use document.addEventListener() to attach an event listener once the <a href="#DeviceReadyEventCallback">deviceready</a> event fires.
+ </p>
+ <p>
+Original documentation: <a href="https://cordova.apache.org/docs/en/latest/cordova/events/events.menubutton.html">Cordova menubutton event</a> </p>
+ </div>
+<div class="example">
+<span class="example"><p>Code example:</p></span><pre name="code" class="examplecode prettyprint"> document.addEventListener('deviceready', onDeviceReady, false);
+
+ function onDeviceReady() {
+ document.addEventListener('menubutton', onMenuKeyDown, false);
+ }
+
+ function onMenuKeyDown() {
+ // Handle the back button
+ }
+ </pre>
+</div>
+</div>
+<div class="interface" id="SearchButtonEventCallback">
+<a class="backward-compatibility-anchor" name="::Events::SearchButtonEventCallback"></a><h3>1.6. SearchButtonEventCallback</h3>
+<div class="brief">
+ Callback for the event which fires when the user presses the search button
+ </div>
+<pre class="webidl prettyprint">[NoInterfaceObject, Callback=FunctionOnly]
+interface SearchButtonEventCallback {
+ void onsearchbutton();
+};</pre>
+<p><span class="version">
+ Since: </span>
+ 3.0
+ </p>
+<div class="description">
+ <p>
+If you need to override the default search button behavior on Android you can register an event listener for the <var>searchbutton</var> event.
+ </p>
+ <p>
+Applications typically should use document.addEventListener() to attach an event listener once the <a href="#DeviceReadyEventCallback">deviceready</a> event fires.
+ </p>
+ <p>
+Original documentation: <a href="https://cordova.apache.org/docs/en/latest/cordova/events/events.searchbutton.html">Cordova searchbutton event</a> </p>
+ </div>
+<div class="example">
+<span class="example"><p>Code example:</p></span><pre name="code" class="examplecode prettyprint"> document.addEventListener('deviceready', onDeviceReady, false);
+
+ function onDeviceReady() {
+ document.addEventListener('searchbutton', onSearchKeyDown, false);
+ }
+
+ function onSearchKeyDown() {
+ // Handle the search button
+ }
+ </pre>
+</div>
+</div>
+<div class="interface" id="StartCallEventCallback">
+<a class="backward-compatibility-anchor" name="::Events::StartCallEventCallback"></a><h3>1.7. StartCallEventCallback</h3>
+<div class="brief">
+ Callback for the event which fires when the user presses the start call button
+ </div>
+<pre class="webidl prettyprint">[NoInterfaceObject, Callback=FunctionOnly]
+interface StartCallEventCallback {
+ void onstartcallbutton();
+};</pre>
+<p><span class="version">
+ Since: </span>
+ 3.0
+ </p>
+<div class="description">
+ <p>
+If you need to override the default start call behavior you can register an event listener for the <var>startcallbutton</var> event.
+ </p>
+ <p>
+Applications typically should use document.addEventListener() to attach an event listener once the <a href="#DeviceReadyEventCallback">deviceready</a> event fires.
+ </p>
+ <p>
+Original documentation: <a href="https://cordova.apache.org/docs/en/latest/cordova/events/events.startcallbutton.html">Cordova startcallbutton event</a> </p>
+ </div>
+<div class="example">
+<span class="example"><p>Code example:</p></span><pre name="code" class="examplecode prettyprint"> document.addEventListener('deviceready', onDeviceReady, false);
+
+ function onDeviceReady() {
+ document.addEventListener('startcallbutton', onStartCallKeyDown, false);
+ }
+
+ function onStartCallKeyDown() {
+ // Handle the start call button
+ }
+ </pre>
+</div>
+</div>
+<div class="interface" id="EndCallButtonEventCallback">
+<a class="backward-compatibility-anchor" name="::Events::EndCallButtonEventCallback"></a><h3>1.8. EndCallButtonEventCallback</h3>
+<div class="brief">
+ Callback for the event which fires when the user presses the end call button
+ </div>
+<pre class="webidl prettyprint">[NoInterfaceObject, Callback=FunctionOnly]
+interface EndCallButtonEventCallback {
+ void onendcallbutton();
+};</pre>
+<p><span class="version">
+ Since: </span>
+ 3.0
+ </p>
+<div class="description">
+ <p>
+The <var>endcallbutton</var> event overrides the default end call behavior.
+ </p>
+ <p>
+Applications typically should use document.addEventListener() to attach an event listener once the <a href="#DeviceReadyEventCallback">deviceready</a> event fires.
+ </p>
+ <p>
+Original documentation: <a href="https://cordova.apache.org/docs/en/latest/cordova/events/events.endcallbutton.html">Cordova endcallbutton event</a> </p>
+ </div>
+<div class="example">
+<span class="example"><p>Code example:</p></span><pre name="code" class="examplecode prettyprint"> document.addEventListener('deviceready', onDeviceReady, false);
+
+ function onDeviceReady() {
+ document.addEventListener('endcallbutton', onEndCallKeyDown, false);
+ }
+
+ function onEndCallKeyDown() {
+ // Handle the end call button
+ }
+ </pre>
+</div>
+</div>
+<div class="interface" id="VolumeDownButtonEventCallback">
+<a class="backward-compatibility-anchor" name="::Events::VolumeDownButtonEventCallback"></a><h3>1.9. VolumeDownButtonEventCallback</h3>
+<div class="brief">
+ Callback for the event which fires when the user presses the volume down button
+ </div>
+<pre class="webidl prettyprint">[NoInterfaceObject, Callback=FunctionOnly]
+interface VolumeDownButtonEventCallback {
+ void onvolumedownbutton();
+};</pre>
+<p><span class="version">
+ Since: </span>
+ 3.0
+ </p>
+<div class="description">
+ <p>
+If you need to override the default volume down behavior you can register an event listener for the <var>volumedownbutton</var> event.
+ </p>
+ <p>
+Applications typically should use document.addEventListener() to attach an event listener once the <a href="#DeviceReadyEventCallback">deviceready</a> event fires.
+ </p>
+ <p>
+Original documentation: <a href="https://cordova.apache.org/docs/en/latest/cordova/events/events.volumedownbutton.html">Cordova volumedownbutton event</a> </p>
+ </div>
+<div class="example">
+<span class="example"><p>Code example:</p></span><pre name="code" class="examplecode prettyprint"> document.addEventListener('deviceready', onDeviceReady, false);
+
+ function onDeviceReady() {
+ document.addEventListener('volumedownbutton', onVolumeDownKeyDown, false);
+ }
+
+ function onVolumeDownKeyDown() {
+ // Handle the volume down button
+ }
+ </pre>
+</div>
+</div>
+<div class="interface" id="VolumeUpButtonEventCallback">
+<a class="backward-compatibility-anchor" name="::Events::VolumeUpButtonEventCallback"></a><h3>1.10. VolumeUpButtonEventCallback</h3>
+<div class="brief">
+ Callback for the event which fires when the user presses the volume up button
+ </div>
+<pre class="webidl prettyprint">[NoInterfaceObject, Callback=FunctionOnly]
+interface VolumeUpButtonEventCallback {
+ void onvolumeupbutton();
+};</pre>
+<p><span class="version">
+ Since: </span>
+ 3.0
+ </p>
+<div class="description">
+ <p>
+If you need to override the default volume up behavior you can register an event listener for the <var>volumeupbutton</var> event.
+ </p>
+ <p>
+Applications typically should use document.addEventListener() to attach an event listener once the <a href="#DeviceReadyEventCallback">deviceready</a> event fires.
+ </p>
+ <p>
+Original documentation: <a href="https://cordova.apache.org/docs/en/latest/cordova/events/events.volumeupbutton.html">Cordova volumeupbutton event</a> </p>
+ </div>
+<div class="example">
+<span class="example"><p>Code example:</p></span><pre name="code" class="examplecode prettyprint"> document.addEventListener('deviceready', onDeviceReady, false);
+
+ function onDeviceReady() {
+ document.addEventListener('volumeupbutton', onVolumeUpKeyDown, false);
+ }
+
+ function onVolumeUpKeyDown() {
+ // Handle the volume up button
+ }
+ </pre>
+</div>
+</div>
+</div>
+<h2 id="full-webidl">2. Full WebIDL</h2>
+<pre class="webidl prettyprint">module Events {
+
+[NoInterfaceObject, Callback=FunctionOnly]
+interface DeviceReadyEventCallback {
+ void ondeviceready();
+};
+
+[NoInterfaceObject, Callback=FunctionOnly]
+interface PauseEventCallback {
+ void onpause();
+};
+
+[NoInterfaceObject, Callback=FunctionOnly]
+interface ResumeEventCallback {
+ void onresume();
+};
+
+[NoInterfaceObject, Callback=FunctionOnly]
+interface BackButtonEventCallback {
+ void onbackbutton();
+};
+
+[NoInterfaceObject, Callback=FunctionOnly]
+interface MenuButtonEventCallback {
+ void onmenubutton();
+};
+
+[NoInterfaceObject, Callback=FunctionOnly]
+interface SearchButtonEventCallback {
+ void onsearchbutton();
+};
+
+[NoInterfaceObject, Callback=FunctionOnly]
+interface StartCallEventCallback {
+ void onstartcallbutton();
+};
+
+[NoInterfaceObject, Callback=FunctionOnly]
+interface EndCallButtonEventCallback {
+ void onendcallbutton();
+};
+
+[NoInterfaceObject, Callback=FunctionOnly]
+interface VolumeDownButtonEventCallback {
+ void onvolumedownbutton();
+};
+
+[NoInterfaceObject, Callback=FunctionOnly]
+interface VolumeUpButtonEventCallback {
+ void onvolumeupbutton();
+};
+};</pre>
+</div>
+<div id="page-footer">
+<div class="copyright" align="center">
+ Except as noted, this content - excluding the Code Examples - is licensed under <a href="http://creativecommons.org/licenses/by/3.0/legalcode" target="_blank">Creative Commons Attribution 3.0</a> and all of the Code Examples contained herein are licensed under <a href="https://www.tizen.org/bsd-3-clause-license" target="_blank">BSD-3-Clause</a>. <br>For details, see the <a href="https://www.tizen.org/content-license" target="_blank">Content License</a>.
+ </div>
+<script type="text/javascript">
+
+ var _gaq = _gaq || [];
+ _gaq.push(['_setAccount', 'UA-25976949-1']);
+ _gaq.push(['_setDomainName', 'tizen.org']);
+ _gaq.push(['_trackPageview']);
+
+ (function() {
+ var ga = document.createElement('script'); ga.type = 'text/javascript'; ga.async = true;
+ var s = document.getElementsByTagName('script')[0]; s.parentNode.insertBefore(ga, s);
+ })();
+
+ </script>
+</div>
+</body>
+</html>
--- /dev/null
+<!DOCTYPE html PUBLIC "html">
+<html>
+<head>
+<meta http-equiv="Content-Type" content="text/html; charset=utf-8">
+<link rel="stylesheet" type="text/css" href="../tizen.css" media="screen">
+<script type="text/javascript" src="snippet.js"></script><title>File API</title>
+</head>
+<body id="page-content" onload="prettyPrint()">
+<div class="api" id="::File">
+
+<div class="title"><h1>File API</h1></div>
+<div class="brief">
+ This plugin implements a File API allowing read/write access to files residing on the device.
+ </div>
+<div class="description">
+ <p>
+Original documentation: <a href="https://www.npmjs.com/package/cordova-plugin-file">Cordova File</a>.
+ </p>
+ </div>
+<p><span class="version">
+ Since: </span>
+ 3.0
+ </p>
+<h2>Table of Contents</h2>
+<ul class="toc">
+<li>1. <a href="#typedefs-section">Type Definitions</a><ul class="toc">
+<li>
+ 1.1. <a href="#WriteData">WriteData</a>
+</li>
+<li>
+ 1.2. <a href="#ReadResultData">ReadResultData</a>
+</li>
+</ul>
+</li>
+<li>2. <a href="#interfaces-section">Interfaces</a><ul class="toc">
+<li>2.1. <a href="#FilePropertyBag">FilePropertyBag</a>
+</li>
+<li>2.2. <a href="#ProgressEventInit">ProgressEventInit</a>
+</li>
+<li>2.3. <a href="#ProgressEvent">ProgressEvent</a>
+</li>
+<li>2.4. <a href="#FileSystemManagerObject">FileSystemManagerObject</a>
+</li>
+<li>2.5. <a href="#FileSystemManager">FileSystemManager</a>
+</li>
+<li>2.6. <a href="#FileSystem">FileSystem</a>
+</li>
+<li>2.7. <a href="#Metadata">Metadata</a>
+</li>
+<li>2.8. <a href="#FileError">FileError</a>
+</li>
+<li>2.9. <a href="#File">File</a>
+</li>
+<li>2.10. <a href="#LocalFileSystem">LocalFileSystem</a>
+</li>
+<li>2.11. <a href="#Entry">Entry</a>
+</li>
+<li>2.12. <a href="#DirectoryEntry">DirectoryEntry</a>
+</li>
+<li>2.13. <a href="#DirectoryReader">DirectoryReader</a>
+</li>
+<li>2.14. <a href="#FileEntry">FileEntry</a>
+</li>
+<li>2.15. <a href="#FileReader">FileReader</a>
+</li>
+<li>2.16. <a href="#FileWriter">FileWriter</a>
+</li>
+<li>2.17. <a href="#ProgressCallback">ProgressCallback</a>
+</li>
+<li>2.18. <a href="#FileSystemCallback">FileSystemCallback</a>
+</li>
+<li>2.19. <a href="#EntryCallback">EntryCallback</a>
+</li>
+<li>2.20. <a href="#EntriesCallback">EntriesCallback</a>
+</li>
+<li>2.21. <a href="#MetadataCallback">MetadataCallback</a>
+</li>
+<li>2.22. <a href="#FileWriterCallback">FileWriterCallback</a>
+</li>
+<li>2.23. <a href="#FileCallback">FileCallback</a>
+</li>
+<li>2.24. <a href="#VoidCallback">VoidCallback</a>
+</li>
+<li>2.25. <a href="#ErrorCallback">ErrorCallback</a>
+</li>
+</ul>
+</li>
+<li>3. <a href="#full-webidl">Full WebIDL</a>
+</li>
+</ul>
+<hr>
+<h2 id="method-summary">Summary of Interfaces and Methods</h2>
+<table class="informaltable">
+<thead><tr>
+<th>Interface</th>
+<th>Method</th>
+</tr></thead>
+<tbody>
+<tr>
+<td><a href="#FilePropertyBag">FilePropertyBag</a></td>
+<td></td>
+</tr>
+<tr>
+<td><a href="#ProgressEventInit">ProgressEventInit</a></td>
+<td></td>
+</tr>
+<tr>
+<td><a href="#ProgressEvent">ProgressEvent</a></td>
+<td></td>
+</tr>
+<tr>
+<td><a href="#FileSystemManagerObject">FileSystemManagerObject</a></td>
+<td></td>
+</tr>
+<tr>
+<td><a href="#FileSystemManager">FileSystemManager</a></td>
+<td></td>
+</tr>
+<tr>
+<td><a href="#FileSystem">FileSystem</a></td>
+<td></td>
+</tr>
+<tr>
+<td><a href="#Metadata">Metadata</a></td>
+<td></td>
+</tr>
+<tr>
+<td><a href="#FileError">FileError</a></td>
+<td></td>
+</tr>
+<tr>
+<td><a href="#File">File</a></td>
+<td></td>
+</tr>
+<tr>
+<td><a href="#LocalFileSystem">LocalFileSystem</a></td>
+<td>
+<div>void <a href="#LocalFileSystem::requestFileSystem">requestFileSystem</a> (short type, long long size, optional <a href="#FileSystemCallback">FileSystemCallback</a>? successCallback, optional <a href="#ErrorCallback">ErrorCallback</a>? errorCallback)</div>
+<div>void <a href="#LocalFileSystem::resolveLocalFileSystemURL">resolveLocalFileSystemURL</a> (DOMString uri, optional <a href="#EntryCallback">EntryCallback</a>? successCallback, optional <a href="#ErrorCallback">ErrorCallback</a>? errorCallback)</div>
+</td>
+</tr>
+<tr>
+<td><a href="#Entry">Entry</a></td>
+<td>
+<div>void <a href="#Entry::getMetadata">getMetadata</a> (<a href="#MetadataCallback">MetadataCallback</a> onsuccess, optional <a href="#ErrorCallback">ErrorCallback</a>? onerror)</div>
+<div>void <a href="#Entry::moveTo">moveTo</a> (<a href="#DirectoryEntry">DirectoryEntry</a> parent, optional DOMString? newName, optional <a href="#EntryCallback">EntryCallback</a>? onsuccess, optional <a href="#ErrorCallback">ErrorCallback</a>? onerror)</div>
+<div>void <a href="#Entry::copyTo">copyTo</a> (<a href="#DirectoryEntry">DirectoryEntry</a> parent, optional DOMString? newName, optional <a href="#EntryCallback">EntryCallback</a>? onsuccess, optional <a href="#ErrorCallback">ErrorCallback</a>? onerror)</div>
+<div>void <a href="#Entry::getParent">getParent</a> (<a href="#EntryCallback">EntryCallback</a> onsuccess, optional <a href="#ErrorCallback">ErrorCallback</a>? onerror)</div>
+<div>void <a href="#Entry::remove">remove</a> (<a href="#VoidCallback">VoidCallback</a> onsuccess, optional <a href="#ErrorCallback">ErrorCallback</a>? onerror)</div>
+<div>DOMString <a href="#Entry::toURL">toURL</a> ()</div>
+</td>
+</tr>
+<tr>
+<td><a href="#DirectoryEntry">DirectoryEntry</a></td>
+<td>
+<div>
+<a href="#DirectoryReader">DirectoryReader</a> <a href="#DirectoryEntry::createReader">createReader</a> ()</div>
+<div>void <a href="#DirectoryEntry::getDirectory">getDirectory</a> (DOMString path, optional ? options, optional <a href="#EntryCallback">EntryCallback</a>? onsuccess, optional <a href="#ErrorCallback">ErrorCallback</a>? onerror)</div>
+<div>void <a href="#DirectoryEntry::getFile">getFile</a> (DOMString path, optional ? options, optional <a href="#EntryCallback">EntryCallback</a>? onsuccess, optional <a href="#ErrorCallback">ErrorCallback</a>? onerror)</div>
+<div>void <a href="#DirectoryEntry::removeRecursively">removeRecursively</a> (<a href="#VoidCallback">VoidCallback</a> onsuccess, optional <a href="#ErrorCallback">ErrorCallback</a>? onerror)</div>
+</td>
+</tr>
+<tr>
+<td><a href="#DirectoryReader">DirectoryReader</a></td>
+<td><div>void <a href="#DirectoryReader::readEntries">readEntries</a> (<a href="#EntriesCallback">EntriesCallback</a> onsuccess, optional <a href="#ErrorCallback">ErrorCallback</a>? onerror)</div></td>
+</tr>
+<tr>
+<td><a href="#FileEntry">FileEntry</a></td>
+<td>
+<div>void <a href="#FileEntry::createWriter">createWriter</a> (<a href="#FileWriterCallback">FileWriterCallback</a> onsuccess, optional <a href="#ErrorCallback">ErrorCallback</a>? onerror)</div>
+<div>void <a href="#FileEntry::file">file</a> (<a href="#FileCallback">FileCallback</a> onsuccess, optional <a href="#ErrorCallback">ErrorCallback</a> onerror)</div>
+</td>
+</tr>
+<tr>
+<td><a href="#FileReader">FileReader</a></td>
+<td>
+<div>void <a href="#FileReader::abort">abort</a> ()</div>
+<div>void <a href="#FileReader::readAsDataURL">readAsDataURL</a> ( blob)</div>
+<div>void <a href="#FileReader::readAsText">readAsText</a> ( blob, optional DOMString? label)</div>
+<div>void <a href="#FileReader::readAsBinaryString">readAsBinaryString</a> ( blob)</div>
+<div>void <a href="#FileReader::readAsArrayBuffer">readAsArrayBuffer</a> ( blob)</div>
+</td>
+</tr>
+<tr>
+<td><a href="#FileWriter">FileWriter</a></td>
+<td>
+<div>void <a href="#FileWriter::abort">abort</a> ()</div>
+<div>void <a href="#FileWriter::seek">seek</a> (long offset)</div>
+<div>void <a href="#FileWriter::truncate">truncate</a> (long size)</div>
+<div>void <a href="#FileWriter::write">write</a> (<a href="#WriteData">WriteData</a> data)</div>
+</td>
+</tr>
+<tr>
+<td><a href="#ProgressCallback">ProgressCallback</a></td>
+<td><div>void <a href="#ProgressCallback::onsuccess">onsuccess</a> (<a href="#ProgressEvent">ProgressEvent</a> event)</div></td>
+</tr>
+<tr>
+<td><a href="#FileSystemCallback">FileSystemCallback</a></td>
+<td><div>void <a href="#FileSystemCallback::handleEvent">handleEvent</a> (<a href="#FileSystem">FileSystem</a> filesystem)</div></td>
+</tr>
+<tr>
+<td><a href="#EntryCallback">EntryCallback</a></td>
+<td><div>void <a href="#EntryCallback::handleEvent">handleEvent</a> (<a href="#Entry">Entry</a> entry)</div></td>
+</tr>
+<tr>
+<td><a href="#EntriesCallback">EntriesCallback</a></td>
+<td><div>void <a href="#EntriesCallback::handleEvent">handleEvent</a> (<a href="#Entry">Entry</a>[] entries)</div></td>
+</tr>
+<tr>
+<td><a href="#MetadataCallback">MetadataCallback</a></td>
+<td><div>void <a href="#MetadataCallback::handleEvent">handleEvent</a> (<a href="#Metadata">Metadata</a> metadata)</div></td>
+</tr>
+<tr>
+<td><a href="#FileWriterCallback">FileWriterCallback</a></td>
+<td><div>void <a href="#FileWriterCallback::handleEvent">handleEvent</a> (<a href="#FileWriter">FileWriter</a> fileWriter)</div></td>
+</tr>
+<tr>
+<td><a href="#FileCallback">FileCallback</a></td>
+<td><div>void <a href="#FileCallback::handleEvent">handleEvent</a> (<a href="#File">File</a> file)</div></td>
+</tr>
+<tr>
+<td><a href="#VoidCallback">VoidCallback</a></td>
+<td><div>void <a href="#VoidCallback::handleEvent">handleEvent</a> ()</div></td>
+</tr>
+<tr>
+<td><a href="#ErrorCallback">ErrorCallback</a></td>
+<td><div>void <a href="#ErrorCallback::handleEvent">handleEvent</a> (<a href="#FileError">FileError</a> err)</div></td>
+</tr>
+</tbody>
+</table>
+<div class="typedefs" id="typedefs-section">
+<h2>1. Type Definitions</h2>
+<div class="typedef" id="WriteData">
+<a class="backward-compatibility-anchor" name="::File::WriteData"></a><h3>1.1. WriteData</h3>
+<div class="brief">
+ Specifies the user or system defined event data.
+ </div>
+<pre class="webidl prettyprint"> typedef ( or DOMString) WriteData;</pre>
+<p><span class="version">
+ Since: </span>
+ 3.0
+ </p>
+</div>
+<div class="typedef" id="ReadResultData">
+<a class="backward-compatibility-anchor" name="::File::ReadResultData"></a><h3>1.2. ReadResultData</h3>
+<div class="brief">
+ Specifies the result data of <em>FileReader</em> object.
+ </div>
+<pre class="webidl prettyprint"> typedef (DOMString or byte[]) ReadResultData;</pre>
+<p><span class="version">
+ Since: </span>
+ 3.0
+ </p>
+</div>
+</div>
+<div class="interfaces" id="interfaces-section">
+<h2>2. Interfaces</h2>
+<div class="dictionary" id="FilePropertyBag">
+<a class="backward-compatibility-anchor" name="::File::FilePropertyBag"></a><h3>2.1. FilePropertyBag</h3>
+<div class="brief">
+ FilePropertyBag.
+ </div>
+<pre class="webidl prettyprint"> dictionary FilePropertyBag {
+
+ DOMString type;
+
+ long long lastModified;
+ };</pre>
+<p><span class="version">
+ Since: </span>
+ 3.0
+ </p>
+<div class="attributes">
+<h4>Dictionary members</h4>
+<dl>
+<dt class="member" id="FilePropertyBag::type"><span class="attrName">DOMString type</span></dt>
+<dd>
+<div class="brief">
+ The ASCII-encoded string in lower case representing the media type of the File. Normative conditions for this member are provided in the File constructor steps.
+ </div>
+<p><span class="version">
+ Since: </span>
+ 3.0
+ </p>
+</dd>
+<dt class="member" id="FilePropertyBag::lastModified"><span class="attrName">long long lastModified</span></dt>
+<dd>
+<div class="brief">
+ conditions for this member are provided in the File constructor steps.
+ </div>
+<p><span class="version">
+ Since: </span>
+ 3.0
+ </p>
+</dd>
+</dl>
+</div>
+</div>
+<div class="dictionary" id="ProgressEventInit">
+<a class="backward-compatibility-anchor" name="::File::ProgressEventInit"></a><h3>2.2. ProgressEventInit</h3>
+<div class="brief">
+ A dictionary used to initialize ProgressEvent object.
+ </div>
+<pre class="webidl prettyprint"> dictionary ProgressEventInit {
+ unsigned long long loaded = false;
+ unsigned long long total = false;
+ target = null;
+ };</pre>
+<p><span class="version">
+ Since: </span>
+ 3.0
+ </p>
+</div>
+<div class="interface" id="ProgressEvent">
+<a class="backward-compatibility-anchor" name="::File::ProgressEvent"></a><h3>2.3. ProgressEvent</h3>
+<div class="brief">
+ The interface that indicates progression event.
+ </div>
+<pre class="webidl prettyprint"> [Constructor(DOMString type, optional <a href="#ProgressEventInit">ProgressEventInit</a> eventInitDict)]
+ interface ProgressEvent {
+ readonly attribute DOMString type;
+ readonly attribute boolean bubbles;
+ readonly attribute boolean cancelBubble;
+ readonly attribute boolean cancelable;
+ readonly attribute boolean lengthComputable;
+ readonly attribute unsigned long long loaded;
+ readonly attribute unsigned long long total;
+ readonly attribute target;
+ };</pre>
+<p><span class="version">
+ Since: </span>
+ 3.0
+ </p>
+<div class="example">
+<span class="example"><p>Code example:</p></span><pre name="code" class="examplecode prettyprint"> var eventInit = {
+ loaded: 128,
+ total: 1024
+ };
+ var event = new ProgressEvent('submit', eventInit);
+ </pre>
+</div>
+<div class="constructors">
+<h4 id="ProgressEvent::constructor">Constructors</h4>
+<dl><pre class="webidl prettyprint">ProgressEvent(DOMString type, optional <a href="#ProgressEventInit">ProgressEventInit</a> eventInitDict);</pre></dl>
+</div>
+<div class="attributes">
+<h4>Attributes</h4>
+<ul>
+<li class="attribute" id="ProgressEvent::type">
+<span class="attrName"><span class="readonly"> readonly
+</span><span class="type">DOMString </span><span class="name">type</span></span><div class="brief">
+ The type of event, e.g. 'click', 'hashchange', or 'submit'.
+ </div>
+<p><span class="version">
+ Since: </span>
+ 3.0
+ </p>
+</li>
+<li class="attribute" id="ProgressEvent::bubbles">
+<span class="attrName"><span class="readonly"> readonly
+</span><span class="type">boolean </span><span class="name">bubbles</span></span><div class="brief">
+ True if event's goes through its target attribute value's ancestors in reverse tree order, and false otherwise.
+ </div>
+<p><span class="version">
+ Since: </span>
+ 3.0
+ </p>
+</li>
+<li class="attribute" id="ProgressEvent::cancelBubble">
+<span class="attrName"><span class="readonly"> readonly
+</span><span class="type">boolean </span><span class="name">cancelBubble</span></span><div class="brief">
+ Cancel bubble
+ </div>
+<p><span class="version">
+ Since: </span>
+ 3.0
+ </p>
+</li>
+<li class="attribute" id="ProgressEvent::cancelable">
+<span class="attrName"><span class="readonly"> readonly
+</span><span class="type">boolean </span><span class="name">cancelable</span></span><div class="brief">
+ Its return value does not always carry meaning, but true can indicate that part of the operation during which event was dispatched, can be canceled.
+ </div>
+<p><span class="version">
+ Since: </span>
+ 3.0
+ </p>
+</li>
+<li class="attribute" id="ProgressEvent::lengthComputable">
+<span class="attrName"><span class="readonly"> readonly
+</span><span class="type">boolean </span><span class="name">lengthComputable</span></span><div class="brief">
+ True when the length of the transferred content is known.
+ </div>
+<p><span class="version">
+ Since: </span>
+ 3.0
+ </p>
+</li>
+<li class="attribute" id="ProgressEvent::loaded">
+<span class="attrName"><span class="readonly"> readonly
+</span><span class="type">unsigned long long </span><span class="name">loaded</span></span><div class="brief">
+ Number of bytes transferred.
+ </div>
+<p><span class="version">
+ Since: </span>
+ 3.0
+ </p>
+</li>
+<li class="attribute" id="ProgressEvent::total">
+<span class="attrName"><span class="readonly"> readonly
+</span><span class="type">unsigned long long </span><span class="name">total</span></span><div class="brief">
+ The total length of the content. This attribute is set when lengthComputable is true.
+ </div>
+<p><span class="version">
+ Since: </span>
+ 3.0
+ </p>
+</li>
+<li class="attribute" id="ProgressEvent::target">
+<span class="attrName"><span class="readonly"> readonly
+</span><span class="type">EventTarget </span><span class="name">target</span></span><div class="brief">
+ The object to which event is dispatched.
+ </div>
+<p><span class="version">
+ Since: </span>
+ 3.0
+ </p>
+</li>
+</ul>
+</div>
+</div>
+<div class="interface" id="FileSystemManagerObject">
+<a class="backward-compatibility-anchor" name="::File::FileSystemManagerObject"></a><h3>2.4. FileSystemManagerObject</h3>
+<div class="brief">
+ The FileSystemManagerObject interface defines what is instantiated by the Cordova object.
+ </div>
+<pre class="webidl prettyprint"> [NoInterfaceObject] interface FileSystemManagerObject {
+ readonly attribute <a href="#FileSystemManager">FileSystemManager</a> file;
+ };</pre>
+<pre class="webidl prettyprint"> <a href="cordova.html#Cordova">Cordova</a> implements <a href="#FileSystemManagerObject">FileSystemManagerObject</a>;</pre>
+<p><span class="version">
+ Since: </span>
+ 3.0
+ </p>
+<div class="description">
+ <p>
+There is a <em>cordova.file </em>object that allows accessing the functionality of the Filesystem API.
+ </p>
+ </div>
+</div>
+<div class="interface" id="FileSystemManager">
+<a class="backward-compatibility-anchor" name="::File::FileSystemManager"></a><h3>2.5. FileSystemManager</h3>
+<div class="brief">
+ The FileSystemManager interface provides access to the Filesystem API.
+ </div>
+<pre class="webidl prettyprint"> [NoInterfaceObject] interface FileSystemManager {
+ readonly attribute DOMString applicationDirectory;
+
+ readonly attribute DOMString applicationStorageDirectory;
+
+ readonly attribute DOMString dataDirectory;
+
+ readonly attribute DOMString cacheDirectory;
+
+ readonly attribute DOMString externalApplicationStorageDirectory;
+
+ readonly attribute DOMString externalDataDirectory;
+
+ readonly attribute DOMString externalCacheDirectory;
+
+ readonly attribute DOMString externalRootDirectory;
+
+ readonly attribute DOMString tempDirectory;
+
+ readonly attribute DOMString syncedDataDirectory;
+
+ readonly attribute DOMString documentsDirectory;
+
+ readonly attribute DOMString sharedDirectory;
+
+ };</pre>
+<p><span class="version">
+ Since: </span>
+ 3.0
+ </p>
+<div class="description">
+ <p>
+This manager interface exposes the Filesystem base API constants.
+ </p>
+ </div>
+<div class="attributes">
+<h4>Attributes</h4>
+<ul>
+<li class="attribute" id="FileSystemManager::applicationDirectory">
+<span class="attrName"><span class="readonly"> readonly
+</span><span class="type">DOMString </span><span class="name">applicationDirectory</span></span><div class="brief">
+ Read-only directory where the application is installed.
+ </div>
+<p><span class="version">
+ Since: </span>
+ 3.0
+ </p>
+<div class="example">
+<span class="example"><p>Code example:</p></span><pre name="code" class="examplecode prettyprint"> console.log("The directory where the application is installed " + cordova.file.applicationDirectory);
+ </pre>
+</div>
+<div class="output">
+<span class="title"><p>Output example:</p></span><pre>The directory where the application is installed file:///opt/usr/apps/WfigBlWDyf/res/wgt/
+</pre>
+</div>
+</li>
+<li class="attribute" id="FileSystemManager::applicationStorageDirectory">
+<span class="attrName"><span class="readonly"> readonly
+</span><span class="type">DOMString </span><span class="name">applicationStorageDirectory</span></span><div class="brief">
+ Root directory of the application's sandbox.
+ </div>
+<p><span class="version">
+ Since: </span>
+ 3.0
+ </p>
+<div class="example">
+<span class="example"><p>Code example:</p></span><pre name="code" class="examplecode prettyprint"> console.log("Root directory of the application's sandbox " + cordova.file.applicationStorageDirectory);
+ </pre>
+</div>
+<div class="output">
+<span class="title"><p>Output example:</p></span><pre>Root directory of the application's sandbox file:///opt/usr/apps/WfigBlWDyf/
+</pre>
+</div>
+</li>
+<li class="attribute" id="FileSystemManager::dataDirectory">
+<span class="attrName"><span class="readonly"> readonly
+</span><span class="type">DOMString </span><span class="name">dataDirectory</span></span><div class="brief">
+ Persistent and private data storage within the application's sandbox using internal memory
+ </div>
+<p><span class="version">
+ Since: </span>
+ 3.0
+ </p>
+<div class="example">
+<span class="example"><p>Code example:</p></span><pre name="code" class="examplecode prettyprint"> console.log("Data directory " + cordova.file.dataDirectory);
+ </pre>
+</div>
+<div class="output">
+<span class="title"><p>Output example:</p></span><pre>Data directory file:///opt/usr/apps/WfigBlWDyf/data/
+</pre>
+</div>
+</li>
+<li class="attribute" id="FileSystemManager::cacheDirectory">
+<span class="attrName"><span class="readonly"> readonly
+</span><span class="type">DOMString </span><span class="name">cacheDirectory</span></span><div class="brief">
+ Directory for cached data files or any files that your app can re-create easily. The OS may delete these files when the device runs low on storage, nevertheless, apps should not rely on the OS to delete files in here.
+ </div>
+<p><span class="version">
+ Since: </span>
+ 3.0
+ </p>
+<div class="example">
+<span class="example"><p>Code example:</p></span><pre name="code" class="examplecode prettyprint"> console.log("Cache directory " + cordova.file.cacheDirectory);
+ </pre>
+</div>
+<div class="output">
+<span class="title"><p>Output example:</p></span><pre>Cache directory file:///opt/usr/apps/WfigBlWDyf/tmp/
+</pre>
+</div>
+</li>
+<li class="attribute" id="FileSystemManager::externalApplicationStorageDirectory">
+<span class="attrName"><span class="readonly"> readonly
+</span><span class="type">DOMString </span><span class="name">externalApplicationStorageDirectory</span></span><div class="brief">
+ Application space on external storage.
+ </div>
+<p><span class="version">
+ Since: </span>
+ 3.0
+ </p>
+<div class="example">
+<span class="example"><p>Code example:</p></span><pre name="code" class="examplecode prettyprint"> console.log("Space on external storage " + cordova.file.externalApplicationStorageDirectory);
+ </pre>
+</div>
+<div class="output">
+<span class="title"><p>Output example:</p></span><pre>Space on external storage null
+</pre>
+</div>
+</li>
+<li class="attribute" id="FileSystemManager::externalDataDirectory">
+<span class="attrName"><span class="readonly"> readonly
+</span><span class="type">DOMString </span><span class="name">externalDataDirectory</span></span><div class="brief">
+ Where to put app-specific data files on external storage.
+ </div>
+<p><span class="version">
+ Since: </span>
+ 3.0
+ </p>
+<div class="example">
+<span class="example"><p>Code example:</p></span><pre name="code" class="examplecode prettyprint"> console.log("Data files on external storage " + cordova.file.externalDataDirectory);
+ </pre>
+</div>
+<div class="output">
+<span class="title"><p>Output example:</p></span><pre>Data files on external storage null
+</pre>
+</div>
+</li>
+<li class="attribute" id="FileSystemManager::externalCacheDirectory">
+<span class="attrName"><span class="readonly"> readonly
+</span><span class="type">DOMString </span><span class="name">externalCacheDirectory</span></span><div class="brief">
+ Application cache on external storage.
+ </div>
+<p><span class="version">
+ Since: </span>
+ 3.0
+ </p>
+<div class="example">
+<span class="example"><p>Code example:</p></span><pre name="code" class="examplecode prettyprint"> console.log("Cache on external storage " + cordova.file.externalCacheDirectory);
+ </pre>
+</div>
+<div class="output">
+<span class="title"><p>Output example:</p></span><pre>Cache on external storage null
+</pre>
+</div>
+</li>
+<li class="attribute" id="FileSystemManager::externalRootDirectory">
+<span class="attrName"><span class="readonly"> readonly
+</span><span class="type">DOMString </span><span class="name">externalRootDirectory</span></span><div class="brief">
+ External storage root.
+ </div>
+<p><span class="version">
+ Since: </span>
+ 3.0
+ </p>
+<div class="example">
+<span class="example"><p>Code example:</p></span><pre name="code" class="examplecode prettyprint"> console.log("Root on external storage " + cordova.file.externalRootDirectory);
+ </pre>
+</div>
+<div class="output">
+<span class="title"><p>Output example:</p></span><pre>Root on external storage file:///usr/storage/sdcard/
+</pre>
+</div>
+</li>
+<li class="attribute" id="FileSystemManager::tempDirectory">
+<span class="attrName"><span class="readonly"> readonly
+</span><span class="type">DOMString </span><span class="name">tempDirectory</span></span><div class="brief">
+ Temp directory that the OS can clear at will. Do not rely on the OS to clear this directory; your app should always remove files as applicable.
+ </div>
+<p><span class="version">
+ Since: </span>
+ 3.0
+ </p>
+<div class="example">
+<span class="example"><p>Code example:</p></span><pre name="code" class="examplecode prettyprint"> console.log("Temp directory " + cordova.file.tempDirectory);
+ </pre>
+</div>
+<div class="output">
+<span class="title"><p>Output example:</p></span><pre>Temp directory null
+</pre>
+</div>
+</li>
+<li class="attribute" id="FileSystemManager::syncedDataDirectory">
+<span class="attrName"><span class="readonly"> readonly
+</span><span class="type">DOMString </span><span class="name">syncedDataDirectory</span></span><div class="brief">
+ Holds app-specific files that should be synced.
+ </div>
+<p><span class="version">
+ Since: </span>
+ 3.0
+ </p>
+<div class="example">
+<span class="example"><p>Code example:</p></span><pre name="code" class="examplecode prettyprint"> console.log("Synced data directory " + cordova.file.syncedDataDirectory);
+ </pre>
+</div>
+<div class="output">
+<span class="title"><p>Output example:</p></span><pre>Synced data directory null
+</pre>
+</div>
+</li>
+<li class="attribute" id="FileSystemManager::documentsDirectory">
+<span class="attrName"><span class="readonly"> readonly
+</span><span class="type">DOMString </span><span class="name">documentsDirectory</span></span><div class="brief">
+ Files private to the app, but that are meaningful to other application (e.g. Office files).
+ </div>
+<p><span class="version">
+ Since: </span>
+ 3.0
+ </p>
+<div class="example">
+<span class="example"><p>Code example:</p></span><pre name="code" class="examplecode prettyprint"> console.log("Documents directory " + cordova.file.documentsDirectory);
+ </pre>
+</div>
+<div class="output">
+<span class="title"><p>Output example:</p></span><pre>Documents directory null
+</pre>
+</div>
+</li>
+<li class="attribute" id="FileSystemManager::sharedDirectory">
+<span class="attrName"><span class="readonly"> readonly
+</span><span class="type">DOMString </span><span class="name">sharedDirectory</span></span><div class="brief">
+ Files globally available to all applications.
+ </div>
+<p><span class="version">
+ Since: </span>
+ 3.0
+ </p>
+<div class="example">
+<span class="example"><p>Code example:</p></span><pre name="code" class="examplecode prettyprint"> console.log("Files globally available to all applications " + cordova.file.sharedDirectory);
+ </pre>
+</div>
+<div class="output">
+<span class="title"><p>Output example:</p></span><pre>Files globally available to all applications file:///opt/usr/media/
+</pre>
+</div>
+</li>
+</ul>
+</div>
+</div>
+<div class="interface" id="FileSystem">
+<a class="backward-compatibility-anchor" name="::File::FileSystem"></a><h3>2.6. FileSystem</h3>
+<div class="brief">
+ This interface provides object that represents a file system.
+ </div>
+<pre class="webidl prettyprint"> [NoInterfaceObject] interface FileSystem {
+
+ readonly attribute DOMString name;
+
+ readonly attribute <a href="#DirectoryEntry">DirectoryEntry</a> root;
+ };</pre>
+<p><span class="version">
+ Since: </span>
+ 3.0
+ </p>
+<div class="attributes">
+<h4>Attributes</h4>
+<ul>
+<li class="attribute" id="FileSystem::name">
+<span class="attrName"><span class="readonly"> readonly
+</span><span class="type">DOMString </span><span class="name">name</span></span><div class="brief">
+ This is the name of the file system.
+ </div>
+<div class="description">
+ <p>
+The specifics of naming filesystems is unspecified, but a name must be unique across the list of exposed file systems.
+ </p>
+ </div>
+<p><span class="version">
+ Since: </span>
+ 3.0
+ </p>
+<div class="example">
+<span class="example"><p>Code example:</p></span><pre name="code" class="examplecode prettyprint"> requestFileSystem(TEMPORARY, 100, function (fileSystem) {
+ console.log('Name of the filesystem: '+fileSystem.name);
+ });
+ </pre>
+</div>
+<div class="output">
+<span class="title"><p>Output example:</p></span><pre>Name of the filesystem: temporary
+</pre>
+</div>
+</li>
+<li class="attribute" id="FileSystem::root">
+<span class="attrName"><span class="readonly"> readonly
+</span><span class="type">DirectoryEntry </span><span class="name">root</span></span><div class="brief">
+ The root directory of the file system.
+ </div>
+<p><span class="version">
+ Since: </span>
+ 3.0
+ </p>
+</li>
+</ul>
+</div>
+</div>
+<div class="interface" id="Metadata">
+<a class="backward-compatibility-anchor" name="::File::Metadata"></a><h3>2.7. Metadata</h3>
+<div class="brief">
+ This interface supplies information about the state of a file or directory.
+ </div>
+<pre class="webidl prettyprint"> interface Metadata {
+ readonly attribute Date modificationTime;
+
+ readonly attribute unsigned long long size;
+ };</pre>
+<p><span class="version">
+ Since: </span>
+ 3.0
+ </p>
+<div class="attributes">
+<h4>Attributes</h4>
+<ul>
+<li class="attribute" id="Metadata::modificationTime">
+<span class="attrName"><span class="readonly"> readonly
+</span><span class="type">Date </span><span class="name">modificationTime</span></span><div class="brief">
+ This is the time at which the file or directory was last modified.
+ </div>
+<p><span class="version">
+ Since: </span>
+ 3.0
+ </p>
+</li>
+<li class="attribute" id="Metadata::size">
+<span class="attrName"><span class="readonly"> readonly
+</span><span class="type">unsigned long long </span><span class="name">size</span></span><div class="brief">
+ The size of the file, in bytes. This must return 0 for directories.
+ </div>
+<p><span class="version">
+ Since: </span>
+ 3.0
+ </p>
+</li>
+</ul>
+</div>
+</div>
+<div class="interface" id="FileError">
+<a class="backward-compatibility-anchor" name="::File::FileError"></a><h3>2.8. FileError</h3>
+<div class="brief">
+ File Error
+ </div>
+<pre class="webidl prettyprint"> [NoInterfaceObject] interface FileError {
+ const unsigned short NOT_FOUND_ERR = 1;
+ const unsigned short SECURITY_ERR = 2;
+ const unsigned short ABORT_ERR = 3;
+ const unsigned short NOT_READABLE_ERR = 4;
+ const unsigned short ENCODING_ERR = 5;
+ const unsigned short NO_MODIFICATION_ALLOWED_ERR = 6;
+ const unsigned short INVALID_STATE_ERR = 7;
+ const unsigned short SYNTAX_ERR = 8;
+ const unsigned short INVALID_MODIFICATION_ERR = 9;
+ const unsigned short QUOTA_EXCEEDED_ERR = 10;
+ const unsigned short TYPE_MISMATCH_ERR = 11;
+ const unsigned short PATH_EXISTS_ERR = 12;
+ attribute unsigned short code;
+ };</pre>
+<p><span class="version">
+ Since: </span>
+ 3.0
+ </p>
+</div>
+<div class="interface" id="File">
+<a class="backward-compatibility-anchor" name="::File::File"></a><h3>2.9. File</h3>
+<div class="brief">
+ The File interface provides access to file's properties. File object could be created with using of <em>FileEntry.file()</em> method.
+ </div>
+<pre class="webidl prettyprint"> [NoInterfaceObject] interface File {
+
+ readonly attribute DOMString name;
+
+ readonly attribute DOMString localURL;
+
+ readonly attribute DOMString type;
+
+ readonly attribute Date lastModified;
+
+ readonly attribute long long size;
+ };</pre>
+<p><span class="version">
+ Since: </span>
+ 3.0
+ </p>
+<div class="attributes">
+<h4>Attributes</h4>
+<ul>
+<li class="attribute" id="File::name">
+<span class="attrName"><span class="readonly"> readonly
+</span><span class="type">DOMString </span><span class="name">name</span></span><div class="brief">
+ The name of the file.
+ </div>
+<p><span class="version">
+ Since: </span>
+ 3.0
+ </p>
+</li>
+<li class="attribute" id="File::localURL">
+<span class="attrName"><span class="readonly"> readonly
+</span><span class="type">DOMString </span><span class="name">localURL</span></span><div class="brief">
+ The full path of the file, including the name.
+ </div>
+<p><span class="version">
+ Since: </span>
+ 3.0
+ </p>
+</li>
+<li class="attribute" id="File::type">
+<span class="attrName"><span class="readonly"> readonly
+</span><span class="type">DOMString </span><span class="name">type</span></span><div class="brief">
+ The mime type of the file.
+ </div>
+<p><span class="version">
+ Since: </span>
+ 3.0
+ </p>
+</li>
+<li class="attribute" id="File::lastModified">
+<span class="attrName"><span class="readonly"> readonly
+</span><span class="type">Date </span><span class="name">lastModified</span></span><div class="brief">
+ The last modified date of the file.
+ </div>
+<p><span class="version">
+ Since: </span>
+ 3.0
+ </p>
+</li>
+<li class="attribute" id="File::size">
+<span class="attrName"><span class="readonly"> readonly
+</span><span class="type">long long </span><span class="name">size</span></span><div class="brief">
+ The size of the file in bytes.
+ </div>
+<p><span class="version">
+ Since: </span>
+ 3.0
+ </p>
+</li>
+</ul>
+</div>
+</div>
+<div class="interface" id="LocalFileSystem">
+<a class="backward-compatibility-anchor" name="::File::LocalFileSystem"></a><h3>2.10. LocalFileSystem</h3>
+<div class="brief">
+ This interface provides a way to obtain <em>Entry</em> and <em>FileSystem</em> objects.
+ </div>
+<pre class="webidl prettyprint"> [NoInterfaceObject] interface LocalFileSystem {
+
+ const short TEMPORARY = 0;
+
+ const short PERSISTENT = 1;
+
+ void requestFileSystem(short type, long long size, optional <a href="#FileSystemCallback">FileSystemCallback</a>? successCallback, optional <a href="#ErrorCallback">ErrorCallback</a>? errorCallback);
+
+ void resolveLocalFileSystemURL(DOMString uri, optional <a href="#EntryCallback">EntryCallback</a>? successCallback, optional <a href="#ErrorCallback">ErrorCallback</a>? errorCallback);
+
+ };</pre>
+<pre class="webidl prettyprint"> Window implements <a href="#LocalFileSystem">LocalFileSystem</a>;</pre>
+<p><span class="version">
+ Since: </span>
+ 3.0
+ </p>
+<div class="consts">
+<h4>Constants</h4>
+<dl>
+<li class="const" id="LocalFileSystem::TEMPORARY">
+<a class="backward-compatibility-anchor" name="::File::LocalFileSystem::TEMPORARY"></a><span class="name">TEMPORARY</span><div class="brief">
+ Used for storage with no guarantee of persistence.
+ </div>
+<p><span class="version">
+ Since: </span>
+ 3.0
+ </p>
+<br><br>
+</li>
+<li class="const" id="LocalFileSystem::PERSISTENT">
+<a class="backward-compatibility-anchor" name="::File::LocalFileSystem::PERSISTENT"></a><span class="name">PERSISTENT</span><div class="brief">
+ Used for storage that should not be removed by the user agent without application or user permission.
+ </div>
+<p><span class="version">
+ Since: </span>
+ 3.0
+ </p>
+<br><br>
+</li>
+</dl>
+</div>
+<div class="methods">
+<h4>Methods</h4>
+<dl>
+<dt class="method" id="LocalFileSystem::requestFileSystem">
+<a class="backward-compatibility-anchor" name="::File::LocalFileSystem::requestFileSystem"></a><code><b><span class="methodName">requestFileSystem</span></b></code>
+</dt>
+<dd>
+<div class="brief">
+ Request a file system in which to store application data.
+ </div>
+<div class="synopsis"><pre class="signature prettyprint">void requestFileSystem(short type, long long size, optional <a href="#FileSystemCallback">FileSystemCallback</a>? successCallback, optional <a href="#ErrorCallback">ErrorCallback</a>? errorCallback);
+ </pre></div>
+<p><span class="version">
+ Since: </span>
+ 3.0
+ </p>
+<p><span class="privilegelevel">
+ Privilege level: </span>
+ public
+ </p>
+<p><span class="privilege">
+ Privilege: </span>
+ http://tizen.org/privilege/filesystem.read
+ </p>
+<div class="parameters">
+<p><span class="param">Parameters:</span></p>
+<ul>
+ <li class="param">
+<span class="name">type</span>:
+ Local file system type, either TEMPORARY or PERSISTENT.
+ </li>
+ <li class="param">
+<span class="name">size</span>:
+ Indicates how much storage space, in bytes, the application expects to need.
+ </li>
+ <li class="param">
+<span class="name">successCallback</span><span class="optional"> [optional]</span><span class="optional"> [nullable]</span>:
+ Invoked with a <em>FileSystem</em> object.
+ </li>
+ <li class="param">
+<span class="name">errorCallback</span><span class="optional"> [optional]</span><span class="optional"> [nullable]</span>:
+ Invoked if error occurs retrieving file system.
+ </li>
+ </ul>
+</div>
+<div class="exceptionlist">
+<p><span class="except">Exceptions:</span></p>
+ <ul class="exception"><li>TypeError<ul><li class="list"><p>
+ if any of the input parameters has incorrect type.
+ </p></li></ul>
+</li></ul>
+ </div>
+<div class="example">
+<span class="example"><p>Code example:</p></span><pre name="code" class="examplecode prettyprint"> successCallback = function(fs) {
+ console.log('File system name ' + fs.name);
+ };
+
+ errorCallback = function(err) {
+ console.log(err.code);
+ };
+
+ requestFileSystem(TEMPORARY, 1024*1024, successCallback, errorCallback);
+
+ </pre>
+</div>
+<div class="output">
+<span class="title"><p>Output example:</p></span><pre>File system name temporary
+</pre>
+</div>
+</dd>
+<dt class="method" id="LocalFileSystem::resolveLocalFileSystemURL">
+<a class="backward-compatibility-anchor" name="::File::LocalFileSystem::resolveLocalFileSystemURL"></a><code><b><span class="methodName">resolveLocalFileSystemURL</span></b></code>
+</dt>
+<dd>
+<div class="brief">
+ Retrieves a <em>DirectoryEntry</em> or <em>FileEntry</em> using local URI.
+ </div>
+<div class="synopsis"><pre class="signature prettyprint">void resolveLocalFileSystemURL(DOMString uri, optional <a href="#EntryCallback">EntryCallback</a>? successCallback, optional <a href="#ErrorCallback">ErrorCallback</a>? errorCallback);
+ </pre></div>
+<p><span class="version">
+ Since: </span>
+ 3.0
+ </p>
+<p><span class="privilegelevel">
+ Privilege level: </span>
+ public
+ </p>
+<p><span class="privilege">
+ Privilege: </span>
+ http://tizen.org/privilege/filesystem.read
+ </p>
+<div class="parameters">
+<p><span class="param">Parameters:</span></p>
+<ul>
+ <li class="param">
+<span class="name">uri</span>:
+ URI referring to a local file or directory.
+ </li>
+ <li class="param">
+<span class="name">successCallback</span><span class="optional"> [optional]</span><span class="optional"> [nullable]</span>:
+ Invoked with <em>Entry</em> object corresponding to URI.
+ </li>
+ <li class="param">
+<span class="name">errorCallback</span><span class="optional"> [optional]</span><span class="optional"> [nullable]</span>:
+ Invoked if error occurs retrieving file system entry.
+ </li>
+ </ul>
+</div>
+<div class="exceptionlist">
+<p><span class="except">Exceptions:</span></p>
+ <ul class="exception"><li>TypeError<ul><li class="list"><p>
+ if any of the input parameters has incorrect type.
+ </p></li></ul>
+</li></ul>
+ </div>
+<div class="example">
+<span class="example"><p>Code example:</p></span><pre name="code" class="examplecode prettyprint"> successCallback = function(entry) {
+ console.log('Entry name ' + entry.name);
+ };
+
+ errorCallback = function(err) {
+ console.log(err.code);
+ };
+
+ var uri = 'file:///home/owner/content/Documents/example.txt';
+ resolveLocalFileSystemURL(uri, successCallback, errorCallback);
+
+ </pre>
+</div>
+<div class="output">
+<span class="title"><p>Output example:</p></span><pre>Entry name example.txt
+</pre>
+</div>
+</dd>
+</dl>
+</div>
+</div>
+<div class="interface" id="Entry">
+<a class="backward-compatibility-anchor" name="::File::Entry"></a><h3>2.11. Entry</h3>
+<div class="brief">
+ The Entry interface.
+ </div>
+<pre class="webidl prettyprint"> [NoInterfaceObject] interface Entry {
+
+ readonly attribute boolean isFile;
+
+ readonly attribute boolean isDirectory;
+
+ readonly attribute DOMString fullPath;
+
+ readonly attribute DOMString name;
+
+ readonly attribute <a href="#FileSystem">FileSystem</a> filesystem;
+
+ void getMetadata(<a href="#MetadataCallback">MetadataCallback</a> onsuccess, optional <a href="#ErrorCallback">ErrorCallback</a>? onerror);
+
+ void moveTo(<a href="#DirectoryEntry">DirectoryEntry</a> parent, optional DOMString? newName, optional <a href="#EntryCallback">EntryCallback</a>? onsuccess, optional <a href="#ErrorCallback">ErrorCallback</a>? onerror);
+
+ void copyTo(<a href="#DirectoryEntry">DirectoryEntry</a> parent, optional DOMString? newName, optional <a href="#EntryCallback">EntryCallback</a>? onsuccess, optional <a href="#ErrorCallback">ErrorCallback</a>? onerror);
+
+ void getParent(<a href="#EntryCallback">EntryCallback</a> onsuccess, optional <a href="#ErrorCallback">ErrorCallback</a>? onerror);
+
+ void remove(<a href="#VoidCallback">VoidCallback</a> onsuccess, optional <a href="#ErrorCallback">ErrorCallback</a>? onerror);
+
+ DOMString toURL();
+ };</pre>
+<p><span class="version">
+ Since: </span>
+ 3.0
+ </p>
+<div class="attributes">
+<h4>Attributes</h4>
+<ul>
+<li class="attribute" id="Entry::isFile">
+<span class="attrName"><span class="readonly"> readonly
+</span><span class="type">boolean </span><span class="name">isFile</span></span><div class="brief">
+ True if the entry is a file.
+ </div>
+<p><span class="version">
+ Since: </span>
+ 3.0
+ </p>
+</li>
+<li class="attribute" id="Entry::isDirectory">
+<span class="attrName"><span class="readonly"> readonly
+</span><span class="type">boolean </span><span class="name">isDirectory</span></span><div class="brief">
+ True if the entry is a directory.
+ </div>
+<p><span class="version">
+ Since: </span>
+ 3.0
+ </p>
+</li>
+<li class="attribute" id="Entry::fullPath">
+<span class="attrName"><span class="readonly"> readonly
+</span><span class="type">DOMString </span><span class="name">fullPath</span></span><div class="brief">
+ The full absolute path from the root to the entry. An absolute path is a relative path from the root directory, prepended with a '/'.
+ </div>
+<p><span class="version">
+ Since: </span>
+ 3.0
+ </p>
+</li>
+<li class="attribute" id="Entry::name">
+<span class="attrName"><span class="readonly"> readonly
+</span><span class="type">DOMString </span><span class="name">name</span></span><div class="brief">
+ The name of the entry, excluding the path leading to it.
+ </div>
+<p><span class="version">
+ Since: </span>
+ 3.0
+ </p>
+</li>
+<li class="attribute" id="Entry::filesystem">
+<span class="attrName"><span class="readonly"> readonly
+</span><span class="type">FileSystem </span><span class="name">filesystem</span></span><div class="brief">
+ The file system where the entry resides.
+ </div>
+<p><span class="version">
+ Since: </span>
+ 3.0
+ </p>
+</li>
+</ul>
+</div>
+<div class="methods">
+<h4>Methods</h4>
+<dl>
+<dt class="method" id="Entry::getMetadata">
+<a class="backward-compatibility-anchor" name="::File::Entry::getMetadata"></a><code><b><span class="methodName">getMetadata</span></b></code>
+</dt>
+<dd>
+<div class="brief">
+ Look up metadata about this entry.
+ </div>
+<div class="synopsis"><pre class="signature prettyprint">void getMetadata(<a href="#MetadataCallback">MetadataCallback</a> onsuccess, optional <a href="#ErrorCallback">ErrorCallback</a>? onerror);
+ </pre></div>
+<p><span class="version">
+ Since: </span>
+ 3.0
+ </p>
+<p><span class="privilegelevel">
+ Privilege level: </span>
+ public
+ </p>
+<p><span class="privilege">
+ Privilege: </span>
+ http://tizen.org/privilege/filesystem.read
+ </p>
+<div class="parameters">
+<p><span class="param">Parameters:</span></p>
+<ul>
+ <li class="param">
+<span class="name">onsuccess</span>:
+ A callback that is called with the time of the last modification.
+ </li>
+ <li class="param">
+<span class="name">onerror</span><span class="optional"> [optional]</span><span class="optional"> [nullable]</span>:
+ A callback that is called when errors happen.
+ </li>
+ </ul>
+</div>
+<div class="exceptionlist">
+<p><span class="except">Exceptions:</span></p>
+ <ul class="exception"><li>FileException<ul><li class="list"><p>
+ with error type TYPE_MISMATCH_ERR, if any of the input parameter is not compatible with the expected type for that parameter.
+ </p></li></ul>
+</li></ul>
+ </div>
+<div class="example">
+<span class="example"><p>Code example:</p></span><pre name="code" class="examplecode prettyprint"> requestFileSystem(TEMPORARY, 100, function(fs) {
+ fs.root.getMetadata(function (metadata) {
+ console.log("Last modification time: " + metadata.modificationTime);// get metadata successfully
+ });
+ });
+ </pre>
+</div>
+<div class="output">
+<span class="title"><p>Output example:</p></span><pre>Last modification time: Fri Jan 02 2015 03:58:08 GMT+0900 (KST)
+</pre>
+</div>
+</dd>
+<dt class="method" id="Entry::moveTo">
+<a class="backward-compatibility-anchor" name="::File::Entry::moveTo"></a><code><b><span class="methodName">moveTo</span></b></code>
+</dt>
+<dd>
+<div class="brief">
+ Move an entry to a different location on the file system.
+ </div>
+<div class="synopsis"><pre class="signature prettyprint">void moveTo(<a href="#DirectoryEntry">DirectoryEntry</a> parent, optional DOMString? newName, optional <a href="#EntryCallback">EntryCallback</a>? onsuccess, optional <a href="#ErrorCallback">ErrorCallback</a>? onerror);
+ </pre></div>
+<p><span class="version">
+ Since: </span>
+ 3.0
+ </p>
+<div class="description">
+ <p>
+It is an error to try to:
+ </p>
+ <ul>
+ <li>
+move a directory inside itself or to any child at any depth </li>
+ <li>
+move an entry into its parent if a name different from its current one isn't provided </li>
+ <li>
+move a file to a path occupied by a directory </li>
+ <li>
+move a directory to a path occupied by a file </li>
+ <li>
+move any element to a path occupied by a directory which is not empty </li>
+ </ul>
+ <p>
+A move of a file on top of an existing file must attempt to delete and replace that file.
+A move of a directory on top of an existing empty directory must attempt to delete and replace that directory.
+ </p>
+ </div>
+<p><span class="privilegelevel">
+ Privilege level: </span>
+ public
+ </p>
+<p><span class="privilege">
+ Privilege: </span>
+ http://tizen.org/privilege/filesystem.read
+ </p>
+<p><span class="privilege">
+ Privilege: </span>
+ http://tizen.org/privilege/filesystem.write
+ </p>
+<div class="parameters">
+<p><span class="param">Parameters:</span></p>
+<ul>
+ <li class="param">
+<span class="name">parent</span>:
+ The directory to which to move the entry.
+ </li>
+ <li class="param">
+<span class="name">newName</span><span class="optional"> [optional]</span><span class="optional"> [nullable]</span>:
+ The new name of the entry. Defaults to the Entry's current name if unspecified.
+ </li>
+ <li class="param">
+<span class="name">onsuccess</span><span class="optional"> [optional]</span><span class="optional"> [nullable]</span>:
+ A callback that is called with the Entry for the new location.
+ </li>
+ <li class="param">
+<span class="name">onerror</span><span class="optional"> [optional]</span><span class="optional"> [nullable]</span>:
+ Callback method to be invoked when an error has occurred
+ </li>
+ </ul>
+</div>
+<div class="exceptionlist">
+<p><span class="except">Exceptions:</span></p>
+ <ul class="exception"><li>FileException<ul><li class="list"><p>
+ with error type TYPE_MISMATCH_ERR, if any of the input parameter is not compatible with the expected type for that parameter.
+ </p></li></ul>
+</li></ul>
+ </div>
+<div class="example">
+<span class="example"><p>Code example:</p></span><pre name="code" class="examplecode prettyprint"> successCallback = function(entry){console.log('Full path to the moved file: '+entry.fullPath)};
+ requestFileSystem(TEMPORARY, 100, function(fs) {
+ fs.root.getDirectory('testDirectory', {create:true}, function(direntry) {
+ fs.root.getFile("aa.txt", {create:true}, function(fileentry) {
+ console.log('Full path before move: '+fileentry.fullPath);
+ fileentry.moveTo(direntry,'newname.txt',successCallback);
+ });
+ });
+ });
+ </pre>
+</div>
+<div class="output">
+<span class="title"><p>Output example:</p></span><pre>Full path before move: /aa.txt
+Full path to the moved file: /testDirectory/newname.txt
+</pre>
+</div>
+</dd>
+<dt class="method" id="Entry::copyTo">
+<a class="backward-compatibility-anchor" name="::File::Entry::copyTo"></a><code><b><span class="methodName">copyTo</span></b></code>
+</dt>
+<dd>
+<div class="brief">
+ Copy an entry to a different location on the file system.
+ </div>
+<div class="synopsis"><pre class="signature prettyprint">void copyTo(<a href="#DirectoryEntry">DirectoryEntry</a> parent, optional DOMString? newName, optional <a href="#EntryCallback">EntryCallback</a>? onsuccess, optional <a href="#ErrorCallback">ErrorCallback</a>? onerror);
+ </pre></div>
+<p><span class="version">
+ Since: </span>
+ 3.0
+ </p>
+<div class="description">
+ <p>
+It is an error to try to:
+ </p>
+ <ul>
+ <li>
+copy a directory inside itself or to any child at any depth </li>
+ <li>
+copy an entry into its parent if a name different from its current one isn't provided </li>
+ <li>
+copy a file to a path occupied by a directory </li>
+ <li>
+copy a directory to a path occupied by a file </li>
+ <li>
+copy any element to a path occupied by a directory which is not empty </li>
+ </ul>
+ <p>
+A copy of a file on top of an existing file must attempt to delete and replace that file.
+A copy of a directory on top of an existing empty directory must attempt to delete and replace that directory.
+Directory copies are always recursive--that is, they copy all contents of the directory.
+ </p>
+ </div>
+<p><span class="privilegelevel">
+ Privilege level: </span>
+ public
+ </p>
+<p><span class="privilege">
+ Privilege: </span>
+ http://tizen.org/privilege/filesystem.read
+ </p>
+<p><span class="privilege">
+ Privilege: </span>
+ http://tizen.org/privilege/filesystem.write
+ </p>
+<div class="parameters">
+<p><span class="param">Parameters:</span></p>
+<ul>
+ <li class="param">
+<span class="name">parent</span>:
+ The directory to which to copy the entry.
+ </li>
+ <li class="param">
+<span class="name">newName</span><span class="optional"> [optional]</span><span class="optional"> [nullable]</span>:
+ The new name of the entry. Defaults to the Entry's current name if unspecified.
+ </li>
+ <li class="param">
+<span class="name">onsuccess</span><span class="optional"> [optional]</span><span class="optional"> [nullable]</span>:
+ A callback that is called with the Entry for the new location.
+ </li>
+ <li class="param">
+<span class="name">onerror</span><span class="optional"> [optional]</span><span class="optional"> [nullable]</span>:
+ Callback method to be invoked when an error has occurred.
+ </li>
+ </ul>
+</div>
+<div class="exceptionlist">
+<p><span class="except">Exceptions:</span></p>
+ <ul class="exception"><li>FileException<ul><li class="list"><p>
+ with error type TYPE_MISMATCH_ERR, if any of the input parameter is not compatible with the expected type for that parameter.
+ </p></li></ul>
+</li></ul>
+ </div>
+<div class="example">
+<span class="example"><p>Code example:</p></span><pre name="code" class="examplecode prettyprint"> successCallback = function(entry){console.log('Full path to the copied file: '+entry.fullPath);};
+ requestFileSystem(TEMPORARY, 100, function(fs) {
+ fs.root.getDirectory('testDirectory', {create:true},
+ function(direntry) {
+ fs.root.getFile("test.txt", {create:true},
+ function(fileentry) {
+ fileentry.copyTo(direntry,'newname.txt',successCallback);
+ }
+ );
+ });
+ });
+ </pre>
+</div>
+<div class="output">
+<span class="title"><p>Output example:</p></span><pre>Full path to the copied file: /testDirectory/newname.txt
+</pre>
+</div>
+</dd>
+<dt class="method" id="Entry::getParent">
+<a class="backward-compatibility-anchor" name="::File::Entry::getParent"></a><code><b><span class="methodName">getParent</span></b></code>
+</dt>
+<dd>
+<div class="brief">
+ Look up the parent DirectoryEntry containing this Entry. If this Entry is the root of its filesystem, its parent is itself.
+ </div>
+<div class="synopsis"><pre class="signature prettyprint">void getParent(<a href="#EntryCallback">EntryCallback</a> onsuccess, optional <a href="#ErrorCallback">ErrorCallback</a>? onerror);
+ </pre></div>
+<p><span class="version">
+ Since: </span>
+ 3.0
+ </p>
+<p><span class="privilegelevel">
+ Privilege level: </span>
+ public
+ </p>
+<p><span class="privilege">
+ Privilege: </span>
+ http://tizen.org/privilege/filesystem.read
+ </p>
+<div class="parameters">
+<p><span class="param">Parameters:</span></p>
+<ul>
+ <li class="param">
+<span class="name">onsuccess</span>:
+ A callback that is called to return the parent Entry.
+ </li>
+ <li class="param">
+<span class="name">onerror</span><span class="optional"> [optional]</span><span class="optional"> [nullable]</span>:
+ Callback method to be invoked when an error has occurred.
+ </li>
+ </ul>
+</div>
+<div class="exceptionlist">
+<p><span class="except">Exceptions:</span></p>
+ <ul class="exception"><li>FileException<ul><li class="list"><p>
+ with error type TYPE_MISMATCH_ERR, if any of the input parameter is not compatible with the expected type for that parameter.
+ </p></li></ul>
+</li></ul>
+ </div>
+<div class="example">
+<span class="example"><p>Code example:</p></span><pre name="code" class="examplecode prettyprint"> requestFileSystem(TEMPORARY, 100, function(fs) {
+ fs.root.getParent(function (entry) {
+ console.log("success");
+ });
+ });
+ </pre>
+</div>
+<div class="output">
+<span class="title"><p>Output example:</p></span><pre>success
+</pre>
+</div>
+</dd>
+<dt class="method" id="Entry::remove">
+<a class="backward-compatibility-anchor" name="::File::Entry::remove"></a><code><b><span class="methodName">remove</span></b></code>
+</dt>
+<dd>
+<div class="brief">
+ Deletes a file or directory. It is an error to attempt to delete a directory that is not empty. It is an error to attempt to delete the root directory of a filesystem.
+ </div>
+<div class="synopsis"><pre class="signature prettyprint">void remove(<a href="#VoidCallback">VoidCallback</a> onsuccess, optional <a href="#ErrorCallback">ErrorCallback</a>? onerror);
+ </pre></div>
+<p><span class="version">
+ Since: </span>
+ 3.0
+ </p>
+<p><span class="privilegelevel">
+ Privilege level: </span>
+ public
+ </p>
+<p><span class="privilege">
+ Privilege: </span>
+ http://tizen.org/privilege/filesystem.read
+ </p>
+<p><span class="privilege">
+ Privilege: </span>
+ http://tizen.org/privilege/filesystem.write
+ </p>
+<div class="parameters">
+<p><span class="param">Parameters:</span></p>
+<ul>
+ <li class="param">
+<span class="name">onsuccess</span>:
+ A callback that is called on success.
+ </li>
+ <li class="param">
+<span class="name">onerror</span><span class="optional"> [optional]</span><span class="optional"> [nullable]</span>:
+ Callback method to be invoked when an error has occurred.
+ </li>
+ </ul>
+</div>
+<div class="exceptionlist">
+<p><span class="except">Exceptions:</span></p>
+ <ul class="exception"><li>FileException<ul><li class="list"><p>
+ with error type TYPE_MISMATCH_ERR, if any of the input parameter is not compatible with the expected type for that parameter.
+ </p></li></ul>
+</li></ul>
+ </div>
+<div class="example">
+<span class="example"><p>Code example:</p></span><pre name="code" class="examplecode prettyprint"> requestFileSystem(TEMPORARY, 100, function(fs) {
+ fs.root.getFile('test.txt', {create: true}, function(fileEntry) {
+ fileEntry.remove(function () {
+ console.log("success");
+ });
+ });
+ });
+ </pre>
+</div>
+<div class="output">
+<span class="title"><p>Output example:</p></span><pre>success
+</pre>
+</div>
+</dd>
+<dt class="method" id="Entry::toURL">
+<a class="backward-compatibility-anchor" name="::File::Entry::toURL"></a><code><b><span class="methodName">toURL</span></b></code>
+</dt>
+<dd>
+<div class="brief">
+ Returns a URL that can be used to identify this entry. Unlike the URN defined in [FILE-API-ED], it has no specific expiration; as it describes a location on disk, it should be valid at least as long as that location exists.
+ </div>
+<div class="synopsis"><pre class="signature prettyprint">DOMString toURL();
+ </pre></div>
+<p><span class="version">
+ Since: </span>
+ 3.0
+ </p>
+<div class="returntype">
+<p><span class="return">Return value:</span></p>
+ URL that can be used to identify this entry.
+ </div>
+<div class="example">
+<span class="example"><p>Code example:</p></span><pre name="code" class="examplecode prettyprint"> requestFileSystem(TEMPORARY, 100, function(fs) {
+ fs.root.getDirectory('testDirectory', {create:true},
+ function(entry) {
+ var url = entry.toURL();
+ console.log('URL: '+url);
+ });
+ });
+ </pre>
+</div>
+<div class="output">
+<span class="title"><p>Output example:</p></span><pre>URL: file:///home/owner/apps_rw/WfigBlWDyf/tmp/testDirectory/
+</pre>
+</div>
+</dd>
+</dl>
+</div>
+</div>
+<div class="interface" id="DirectoryEntry">
+<a class="backward-compatibility-anchor" name="::File::DirectoryEntry"></a><h3>2.12. DirectoryEntry</h3>
+<div class="brief">
+ The DirectoryEntry interface provides access to the Filesystem API.
+ </div>
+<pre class="webidl prettyprint"> interface DirectoryEntry : <a href="#Entry">Entry</a> {
+
+ <a href="#DirectoryReader">DirectoryReader</a> createReader();
+
+ void getDirectory(DOMString path, optional ? options, optional <a href="#EntryCallback">EntryCallback</a>? onsuccess, optional <a href="#ErrorCallback">ErrorCallback</a>? onerror);
+
+ void getFile(DOMString path, optional ? options, optional <a href="#EntryCallback">EntryCallback</a>? onsuccess, optional <a href="#ErrorCallback">ErrorCallback</a>? onerror);
+
+ void removeRecursively(<a href="#VoidCallback">VoidCallback</a> onsuccess, optional <a href="#ErrorCallback">ErrorCallback</a>? onerror);
+ };</pre>
+<p><span class="version">
+ Since: </span>
+ 3.0
+ </p>
+
+ <div class="methods">
+<h4>Methods</h4>
+<dl>
+<dt class="method" id="DirectoryEntry::createReader">
+<a class="backward-compatibility-anchor" name="::File::DirectoryEntry::createReader"></a><code><b><span class="methodName">createReader</span></b></code>
+</dt>
+<dd>
+<div class="brief">
+ Creates a new DirectoryReader to read Entries from this Directory.
+ </div>
+<div class="synopsis"><pre class="signature prettyprint"><a href="#DirectoryReader">DirectoryReader</a> createReader();
+ </pre></div>
+<p><span class="version">
+ Since: </span>
+ 3.0
+ </p>
+<p><span class="privilegelevel">
+ Privilege level: </span>
+ public
+ </p>
+<p><span class="privilege">
+ Privilege: </span>
+ http://tizen.org/privilege/filesystem.read
+ </p>
+<div class="returntype">
+<p><span class="return">Return value:</span></p>
+ DirectoryReader
+ </div>
+<div class="example">
+<span class="example"><p>Code example:</p></span><pre name="code" class="examplecode prettyprint"> requestFileSystem(TEMPORARY, 100, function (entry) {
+ entry.root.getDirectory("MyDocument", {create:true}, function(dirEntry) {
+ var directoryReader = dirEntry.createReader();
+ });
+ });
+ </pre>
+</div>
+</dd>
+<dt class="method" id="DirectoryEntry::getDirectory">
+<a class="backward-compatibility-anchor" name="::File::DirectoryEntry::getDirectory"></a><code><b><span class="methodName">getDirectory</span></b></code>
+</dt>
+<dd>
+<div class="brief">
+ Creates or looks up a directory.
+ </div>
+<div class="synopsis"><pre class="signature prettyprint">void getDirectory(DOMString path, optional ? options, optional <a href="#EntryCallback">EntryCallback</a>? onsuccess, optional <a href="#ErrorCallback">ErrorCallback</a>? onerror);
+ </pre></div>
+<p><span class="version">
+ Since: </span>
+ 3.0
+ </p>
+<div class="description">
+ <ul>
+ <li>
+If create and exclusive are both true and the path already exists, getDirectory must fail. </li>
+ <li>
+If create is true, the path doesn't exist, and no other error occurs, getDirectory must create and return a corresponding DirectoryEntry. </li>
+ <li>
+If create is not true and the path doesn't exist, getDirectory must fail. </li>
+ <li>
+If create is not true and the path exists, but is a file, getDirectory must fail. </li>
+ <li>
+Otherwise, if no other error occurs, getDirectory must return a DirectoryEntry corresponding to path. </li>
+ </ul>
+ </div>
+<p><span class="privilegelevel">
+ Privilege level: </span>
+ public
+ </p>
+<p><span class="privilege">
+ Privilege: </span>
+ http://tizen.org/privilege/filesystem.read
+ </p>
+<p><span class="privilege">
+ Privilege: </span>
+ http://tizen.org/privilege/filesystem.write
+ </p>
+<div class="parameters">
+<p><span class="param">Parameters:</span></p>
+<ul>
+ <li class="param">
+<span class="name">path</span>:
+ Either an absolute path or a relative path from this DirectoryEntry to the directory to be looked up or created. It is an error to attempt to create a directory whose immediate parent does not yet exist.
+ </li>
+ <li class="param">
+<span class="name">options</span><span class="optional"> [optional]</span><span class="optional"> [nullable]</span>:
+ Flags
+ </li>
+ <li class="param">
+<span class="name">onsuccess</span><span class="optional"> [optional]</span><span class="optional"> [nullable]</span>:
+ A callback that is called to return the DirectoryEntry selected or created.
+ </li>
+ <li class="param">
+<span class="name">onerror</span><span class="optional"> [optional]</span><span class="optional"> [nullable]</span>:
+ Callback method to be invoked when an error has occurred.
+ </li>
+ </ul>
+</div>
+<div class="exceptionlist">
+<p><span class="except">Exceptions:</span></p>
+ <ul class="exception"><li>FileException<ul><li class="list"><p>
+ with error type TYPE_MISMATCH_ERR, if any of the input parameter is not compatible with the expected type for that parameter.
+ </p></li></ul>
+</li></ul>
+ </div>
+<div class="example">
+<span class="example"><p>Code example:</p></span><pre name="code" class="examplecode prettyprint"> requestFileSystem(TEMPORARY, 100, function(fs) {
+ fs.root.getDirectory("ert",{create:true},function(dir){
+ console.log('Created dir: '+dir.name);
+ })
+ });
+ </pre>
+</div>
+<div class="output">
+<span class="title"><p>Output example:</p></span><pre>Created dir: ert
+</pre>
+</div>
+</dd>
+<dt class="method" id="DirectoryEntry::getFile">
+<a class="backward-compatibility-anchor" name="::File::DirectoryEntry::getFile"></a><code><b><span class="methodName">getFile</span></b></code>
+</dt>
+<dd>
+<div class="brief">
+ Creates or looks up a file.
+ </div>
+<div class="synopsis"><pre class="signature prettyprint">void getFile(DOMString path, optional ? options, optional <a href="#EntryCallback">EntryCallback</a>? onsuccess, optional <a href="#ErrorCallback">ErrorCallback</a>? onerror);
+ </pre></div>
+<p><span class="version">
+ Since: </span>
+ 3.0
+ </p>
+<div class="description">
+ <ul>
+ <li>
+If create and exclusive are both true, and the path already exists, getFile must fail. </li>
+ <li>
+If create is true, the path doesn't exist, and no other error occurs, getFile must create it as a zero-length file and return a corresponding FileEntry. </li>
+ <li>
+If create is not true and the path doesn't exist, getFile must fail. </li>
+ <li>
+If create is not true and the path exists, but is a directory, getFile must fail. </li>
+ <li>
+Otherwise, if no other error occurs, getFile must return a FileEntry corresponding to path. </li>
+ </ul>
+ </div>
+<p><span class="privilegelevel">
+ Privilege level: </span>
+ public
+ </p>
+<p><span class="privilege">
+ Privilege: </span>
+ http://tizen.org/privilege/filesystem.read
+ </p>
+<p><span class="privilege">
+ Privilege: </span>
+ http://tizen.org/privilege/filesystem.write
+ </p>
+<div class="parameters">
+<p><span class="param">Parameters:</span></p>
+<ul>
+ <li class="param">
+<span class="name">path</span>:
+ Either an absolute path or a relative path from this DirectoryEntry to the file to be looked up or created. It is an error to attempt to create a file whose immediate parent does not yet exist.
+ </li>
+ <li class="param">
+<span class="name">options</span><span class="optional"> [optional]</span><span class="optional"> [nullable]</span>:
+ Flags
+ </li>
+ <li class="param">
+<span class="name">onsuccess</span><span class="optional"> [optional]</span><span class="optional"> [nullable]</span>:
+ A callback that is called to return the File selected or created.
+ </li>
+ <li class="param">
+<span class="name">onerror</span><span class="optional"> [optional]</span><span class="optional"> [nullable]</span>:
+ Callback method to be invoked when an error has occurred.
+ </li>
+ </ul>
+</div>
+<div class="exceptionlist">
+<p><span class="except">Exceptions:</span></p>
+ <ul class="exception"><li>FileException<ul><li class="list"><p>
+ with error type TYPE_MISMATCH_ERR, if any of the input parameter is not compatible with the expected type for that parameter.
+ </p></li></ul>
+</li></ul>
+ </div>
+<div class="example">
+<span class="example"><p>Code example:</p></span><pre name="code" class="examplecode prettyprint"> requestFileSystem(TEMPORARY, 100, function(fs) {
+ fs.root.getFile("qa.txt",{create:true},function(file){
+ console.log('Created file: '+file.name);
+ });
+ });
+ </pre>
+</div>
+<div class="output">
+<span class="title"><p>Output example:</p></span><pre>Created file: qa.txt
+</pre>
+</div>
+</dd>
+<dt class="method" id="DirectoryEntry::removeRecursively">
+<a class="backward-compatibility-anchor" name="::File::DirectoryEntry::removeRecursively"></a><code><b><span class="methodName">removeRecursively</span></b></code>
+</dt>
+<dd>
+<div class="brief">
+ Deletes a directory and all of its contents, if any. In the event of an error [e.g. trying to delete a directory that contains a file that cannot be removed], some of the contents of the directory may be deleted. It is an error to attempt to delete the root directory of a filesystem.
+ </div>
+<div class="synopsis"><pre class="signature prettyprint">void removeRecursively(<a href="#VoidCallback">VoidCallback</a> onsuccess, optional <a href="#ErrorCallback">ErrorCallback</a>? onerror);
+ </pre></div>
+<p><span class="version">
+ Since: </span>
+ 3.0
+ </p>
+<p><span class="privilegelevel">
+ Privilege level: </span>
+ public
+ </p>
+<p><span class="privilege">
+ Privilege: </span>
+ http://tizen.org/privilege/filesystem.read
+ </p>
+<p><span class="privilege">
+ Privilege: </span>
+ http://tizen.org/privilege/filesystem.write
+ </p>
+<div class="parameters">
+<p><span class="param">Parameters:</span></p>
+<ul>
+ <li class="param">
+<span class="name">onsuccess</span>:
+ A callback that is called on success.
+ </li>
+ <li class="param">
+<span class="name">onerror</span><span class="optional"> [optional]</span><span class="optional"> [nullable]</span>:
+ Callback method to be invoked when an error has occurred.
+ </li>
+ </ul>
+</div>
+<div class="exceptionlist">
+<p><span class="except">Exceptions:</span></p>
+ <ul class="exception"><li>FileException<ul><li class="list"><p>
+ with error type TYPE_MISMATCH_ERR, if any of the input parameter is not compatible with the expected type for that parameter.
+ </p></li></ul>
+</li></ul>
+ </div>
+<div class="example">
+<span class="example"><p>Code example:</p></span><pre name="code" class="examplecode prettyprint"> requestFileSystem(TEMPORARY, 100, function(fs) {
+ fs.root.getDirectory("testDirectory", {create:true},
+ function(directoryEntry) {
+ directoryEntry.removeRecursively(function() {
+ console.log("success");
+ });
+ });
+ });
+ </pre>
+</div>
+<div class="output">
+<span class="title"><p>Output example:</p></span><pre>success
+</pre>
+</div>
+</dd>
+</dl>
+</div>
+</div>
+<div class="interface" id="DirectoryReader">
+<a class="backward-compatibility-anchor" name="::File::DirectoryReader"></a><h3>2.13. DirectoryReader</h3>
+<div class="brief">
+ The DirectoryReader interface provides access to the Filesystem API.
+ </div>
+<pre class="webidl prettyprint"> [NoInterfaceObject] interface DirectoryReader {
+
+ void readEntries(<a href="#EntriesCallback">EntriesCallback</a> onsuccess, optional <a href="#ErrorCallback">ErrorCallback</a>? onerror);
+ };</pre>
+<div class="methods">
+<h4>Methods</h4>
+<dl>
+<dt class="method" id="DirectoryReader::readEntries">
+<a class="backward-compatibility-anchor" name="::File::DirectoryReader::readEntries"></a><code><b><span class="methodName">readEntries</span></b></code>
+</dt>
+<dd>
+<div class="brief">
+ Read the next block of entries from this directory.
+ </div>
+<div class="synopsis"><pre class="signature prettyprint">void readEntries(<a href="#EntriesCallback">EntriesCallback</a> onsuccess, optional <a href="#ErrorCallback">ErrorCallback</a>? onerror);
+ </pre></div>
+<p><span class="version">
+ Since: </span>
+ 3.0
+ </p>
+<p><span class="privilegelevel">
+ Privilege level: </span>
+ public
+ </p>
+<p><span class="privilege">
+ Privilege: </span>
+ http://tizen.org/privilege/filesystem.read
+ </p>
+<div class="parameters">
+<p><span class="param">Parameters:</span></p>
+<ul>
+ <li class="param">
+<span class="name">onsuccess</span>:
+ Called once per successful call to readEntries to deliver the next previously-unreported set of Entries in the associated Directory. If all Entries have already been returned from previous invocations of readEntries, successCallback must be called with a zero-length array as an argument.
+ </li>
+ <li class="param">
+<span class="name">onerror</span><span class="optional"> [optional]</span><span class="optional"> [nullable]</span>:
+ A callback indicating that there was an error reading from the Directory.
+ </li>
+ </ul>
+</div>
+<div class="exceptionlist">
+<p><span class="except">Exceptions:</span></p>
+ <ul class="exception"><li>FileException<ul><li class="list"><p>
+ with error type TYPE_MISMATCH_ERR, if any of the input parameter is not compatible with the expected type for that parameter.
+ </p></li></ul>
+</li></ul>
+ </div>
+<div class="example">
+<span class="example"><p>Code example:</p></span><pre name="code" class="examplecode prettyprint"> requestFileSystem(TEMPORARY, 100, function(fs) {
+ var a = fs.root.createReader();
+ a.readEntries(function successCallback(entries) {
+ console.log("success");
+ });
+ });
+ </pre>
+</div>
+<div class="output">
+<span class="title"><p>Output example:</p></span><pre>success
+</pre>
+</div>
+</dd>
+</dl>
+</div>
+</div>
+<div class="interface" id="FileEntry">
+<a class="backward-compatibility-anchor" name="::File::FileEntry"></a><h3>2.14. FileEntry</h3>
+<div class="brief">
+ The FileEntry interface provides access to the Filesystem API.
+ </div>
+<pre class="webidl prettyprint"> [NoInterfaceObject] interface FileEntry : <a href="#Entry">Entry</a> {
+
+ void createWriter(<a href="#FileWriterCallback">FileWriterCallback</a> onsuccess, optional <a href="#ErrorCallback">ErrorCallback</a>? onerror);
+
+ void file (<a href="#FileCallback">FileCallback</a> onsuccess, optional <a href="#ErrorCallback">ErrorCallback</a> onerror);
+ };</pre>
+
+ <div class="methods">
+<h4>Methods</h4>
+<dl>
+<dt class="method" id="FileEntry::createWriter">
+<a class="backward-compatibility-anchor" name="::File::FileEntry::createWriter"></a><code><b><span class="methodName">createWriter</span></b></code>
+</dt>
+<dd>
+<div class="brief">
+ Creates a new FileWriter associated with the file that this FileEntry represents.
+ </div>
+<div class="synopsis"><pre class="signature prettyprint">void createWriter(<a href="#FileWriterCallback">FileWriterCallback</a> onsuccess, optional <a href="#ErrorCallback">ErrorCallback</a>? onerror);
+ </pre></div>
+<p><span class="version">
+ Since: </span>
+ 3.0
+ </p>
+<p><span class="privilegelevel">
+ Privilege level: </span>
+ public
+ </p>
+<p><span class="privilege">
+ Privilege: </span>
+ http://tizen.org/privilege/filesystem.read
+ </p>
+<p><span class="privilege">
+ Privilege: </span>
+ http://tizen.org/privilege/filesystem.write
+ </p>
+<div class="parameters">
+<p><span class="param">Parameters:</span></p>
+<ul>
+ <li class="param">
+<span class="name">onsuccess</span>:
+ A callback that is called with the new FileWriter.
+ </li>
+ <li class="param">
+<span class="name">onerror</span><span class="optional"> [optional]</span><span class="optional"> [nullable]</span>:
+ Callback method to be invoked when an error has occurred.
+ </li>
+ </ul>
+</div>
+<div class="example">
+<span class="example"><p>Code example:</p></span><pre name="code" class="examplecode prettyprint"> requestFileSystem(TEMPORARY, 100, function(fs) {
+ fs.root.getFile("logFile.txt", {create: true}, function (f) {
+ f.createWriter(function(fileWriter) {
+ fileWriter.write(new Blob(['hello']));
+ fileWriter.onerror = function(e) {
+ console.log('Write file failed:' + e);
+ };
+ fileWriter.onwriteend = function () {
+ console.log("success");
+ };
+ });
+ });
+ });
+ </pre>
+</div>
+<div class="output">
+<span class="title"><p>Output example:</p></span><pre>success
+</pre>
+</div>
+</dd>
+<dt class="method" id="FileEntry::file">
+<a class="backward-compatibility-anchor" name="::File::FileEntry::file"></a><code><b><span class="methodName">file</span></b></code>
+</dt>
+<dd>
+<div class="brief">
+ Returns a File that represents the current state of the file that this FileEntry represents.
+ </div>
+<div class="synopsis"><pre class="signature prettyprint">void file(<a href="#FileCallback">FileCallback</a> onsuccess, optional <a href="#ErrorCallback">ErrorCallback</a> onerror);
+ </pre></div>
+<p><span class="version">
+ Since: </span>
+ 3.0
+ </p>
+<p><span class="privilegelevel">
+ Privilege level: </span>
+ public
+ </p>
+<p><span class="privilege">
+ Privilege: </span>
+ http://tizen.org/privilege/filesystem.read
+ </p>
+<div class="parameters">
+<p><span class="param">Parameters:</span></p>
+<ul>
+ <li class="param">
+<span class="name">onsuccess</span>:
+ A callback that is called with the File.
+ </li>
+ <li class="param">
+<span class="name">onerror</span><span class="optional"> [optional]</span>:
+ Callback method to be invoked when an error has occurred.
+ </li>
+ </ul>
+</div>
+<div class="example">
+<span class="example"><p>Code example:</p></span><pre name="code" class="examplecode prettyprint"> requestFileSystem(TEMPORARY, 100, function(fs) {
+ fs.root.getFile("abcdz.txt", {create: true}, function (f) {
+ f.file(function (file) {
+ console.log("success");
+ });
+ });
+ });
+ </pre>
+</div>
+<div class="output">
+<span class="title"><p>Output example:</p></span><pre>success
+</pre>
+</div>
+</dd>
+</dl>
+</div>
+</div>
+<div class="interface" id="FileReader">
+<a class="backward-compatibility-anchor" name="::File::FileReader"></a><h3>2.15. FileReader</h3>
+<div class="brief">
+ The FileReader interface provides access to capabilities of reading <em>Blob</em> objects.
+ </div>
+<pre class="webidl prettyprint"> [Constructor()]
+ interface FileReader {
+ const short EMPTY = 0;
+ const short LOADING = 1;
+ const short DONE = 2;
+
+ readonly attribute short readyState;
+
+ readonly attribute <a href="#ReadResultData">ReadResultData</a>? result;
+
+ readonly attribute <a href="#FileError">FileError</a>? error;
+
+ attribute <a href="#ProgressCallback">ProgressCallback</a>? onloadstart;
+
+ attribute <a href="#ProgressCallback">ProgressCallback</a>? onload;
+
+ attribute <a href="#ProgressCallback">ProgressCallback</a>? onabort;
+
+ attribute <a href="#ProgressCallback">ProgressCallback</a>? onerror;
+
+ attribute <a href="#ProgressCallback">ProgressCallback</a>? onloadend;
+
+ void abort();
+
+ void readAsDataURL( blob);
+
+ void readAsText( blob, optional DOMString? label);
+
+ void readAsBinaryString( blob);
+
+ void readAsArrayBuffer( blob);
+ };</pre>
+<p><span class="version">
+ Since: </span>
+ 3.0
+ </p>
+<div class="example">
+<span class="example"><p>Code example:</p></span><pre name="code" class="examplecode prettyprint"> var deviceReady, fileReader;
+ deviceReady = function() {
+ fileReader = new FileReader();
+ };
+ document.addEventListener('deviceready', deviceReady, true);
+ </pre>
+</div>
+<div class="constructors">
+<h4 id="FileReader::constructor">Constructors</h4>
+<dl><pre class="webidl prettyprint">FileReader();</pre></dl>
+</div>
+<div class="consts">
+<h4>Constants</h4>
+<dl>
+<li class="const" id="FileReader::EMPTY">
+<a class="backward-compatibility-anchor" name="::File::FileReader::EMPTY"></a><span class="name">EMPTY</span><div class="brief">
+ The FileReader object has been constructed, and there are no pending reads. None of the read methods have been called.
+This is the default state of a newly minted FileReader object, until one of the read methods have been called on it.
+ </div>
+<p><span class="version">
+ Since: </span>
+ 3.0
+ </p>
+<br><br>
+</li>
+<li class="const" id="FileReader::LOADING">
+<a class="backward-compatibility-anchor" name="::File::FileReader::LOADING"></a><span class="name">LOADING</span><div class="brief">
+ A File or Blob is being read. One of the read methods is being processed, and no error has occurred during the read.
+ </div>
+<p><span class="version">
+ Since: </span>
+ 3.0
+ </p>
+<br><br>
+</li>
+<li class="const" id="FileReader::DONE">
+<a class="backward-compatibility-anchor" name="::File::FileReader::DONE"></a><span class="name">DONE</span><div class="brief">
+ The entire File or Blob has been read into memory, OR a file error occurred during read, OR the read was aborted using abort().
+The FileReader is no longer reading a File or Blob. If readyState is set to DONE it means at least one of the read methods have been called on this FileReader.
+ </div>
+<p><span class="version">
+ Since: </span>
+ 3.0
+ </p>
+<br><br>
+</li>
+</dl>
+</div>
+<div class="attributes">
+<h4>Attributes</h4>
+<ul>
+<li class="attribute" id="FileReader::readyState">
+<span class="attrName"><span class="readonly"> readonly
+</span><span class="type">short </span><span class="name">readyState</span></span><div class="brief">
+ The state of FileReader. Possible values are <em>FileReader.EMPTY</em>, <em>FileReader.LOADING</em> or <em>FileReader.DONE</em>.
+ </div>
+<p><span class="version">
+ Since: </span>
+ 3.0
+ </p>
+</li>
+<li class="attribute" id="FileReader::result">
+<span class="attrName"><span class="readonly"> readonly
+</span><span class="type">ReadResultData </span><span class="name">result</span><span class="optional"> [nullable]</span></span><div class="brief">
+ The contents of the file, that have been read.
+Returns a Blob's data as a DOMString, or byte[], or null, depending on the read method that has been called on the FileReader. It is <em>null</em> if any errors occurred.
+ </div>
+<p><span class="version">
+ Since: </span>
+ 3.0
+ </p>
+</li>
+<li class="attribute" id="FileReader::error">
+<span class="attrName"><span class="readonly"> readonly
+</span><span class="type">FileError </span><span class="name">error</span><span class="optional"> [nullable]</span></span><div class="brief">
+ An object describing error, if any occured.
+ </div>
+<p><span class="version">
+ Since: </span>
+ 3.0
+ </p>
+</li>
+<li class="attribute" id="FileReader::onloadstart">
+<span class="attrName"><span class="type">ProgressCallback </span><span class="name">onloadstart</span><span class="optional"> [nullable]</span></span><div class="brief">
+ Callback, which is triggered, when the read starts.
+ </div>
+<p><span class="version">
+ Since: </span>
+ 3.0
+ </p>
+</li>
+<li class="attribute" id="FileReader::onload">
+<span class="attrName"><span class="type">ProgressCallback </span><span class="name">onload</span><span class="optional"> [nullable]</span></span><div class="brief">
+ Callback, which is triggered, when the read has successfully completed.
+ </div>
+<p><span class="version">
+ Since: </span>
+ 3.0
+ </p>
+</li>
+<li class="attribute" id="FileReader::onabort">
+<span class="attrName"><span class="type">ProgressCallback </span><span class="name">onabort</span><span class="optional"> [nullable]</span></span><div class="brief">
+ Callback, which is triggered, when the read has been aborted. For instance, by invoking the abort() method.
+ </div>
+<p><span class="version">
+ Since: </span>
+ 3.0
+ </p>
+</li>
+<li class="attribute" id="FileReader::onerror">
+<span class="attrName"><span class="type">ProgressCallback </span><span class="name">onerror</span><span class="optional"> [nullable]</span></span><div class="brief">
+ Callback, which is triggered, when the read has failed.
+ </div>
+<p><span class="version">
+ Since: </span>
+ 3.0
+ </p>
+</li>
+<li class="attribute" id="FileReader::onloadend">
+<span class="attrName"><span class="type">ProgressCallback </span><span class="name">onloadend</span><span class="optional"> [nullable]</span></span><div class="brief">
+ Callback, which is triggered, when the request has completed (either in success or failure).
+ </div>
+<p><span class="version">
+ Since: </span>
+ 3.0
+ </p>
+</li>
+</ul>
+</div>
+<div class="methods">
+<h4>Methods</h4>
+<dl>
+<dt class="method" id="FileReader::abort">
+<a class="backward-compatibility-anchor" name="::File::FileReader::abort"></a><code><b><span class="methodName">abort</span></b></code>
+</dt>
+<dd>
+<div class="brief">
+ Aborts current operation of reading file.
+ </div>
+<div class="synopsis"><pre class="signature prettyprint">void abort();
+ </pre></div>
+<p><span class="version">
+ Since: </span>
+ 3.0
+ </p>
+<div class="example">
+<span class="example"><p>Code example:</p></span><pre name="code" class="examplecode prettyprint"> var blob = new Blob(['abc']);
+ var fileReader = new FileReader();
+ fileReader.onload = function(){
+ console.log('Loaded');
+ };
+ fileReader.onabort = function(){
+ console.log('aborted');
+ };
+ fileReader.readAsDataURL(blob);
+ fileReader.abort();
+ </pre>
+</div>
+<div class="output">
+<span class="title"><p>Output example:</p></span><pre>aborted
+</pre>
+</div>
+</dd>
+<dt class="method" id="FileReader::readAsDataURL">
+<a class="backward-compatibility-anchor" name="::File::FileReader::readAsDataURL"></a><code><b><span class="methodName">readAsDataURL</span></b></code>
+</dt>
+<dd>
+<div class="brief">
+ Reads file and return data as a base64-encoded data URL.
+ </div>
+<div class="synopsis"><pre class="signature prettyprint">void readAsDataURL( blob);
+ </pre></div>
+<p><span class="version">
+ Since: </span>
+ 3.0
+ </p>
+<p><span class="privilegelevel">
+ Privilege level: </span>
+ public
+ </p>
+<p><span class="privilege">
+ Privilege: </span>
+ http://tizen.org/privilege/filesystem.read
+ </p>
+<div class="parameters">
+<p><span class="param">Parameters:</span></p>
+<ul>
+ <li class="param">
+<span class="name">blob</span>:
+ The <em>Blob</em> object to be read as data URL.
+ </li>
+ </ul>
+</div>
+<div class="exceptionlist">
+<p><span class="except">Exceptions:</span></p>
+ <ul class="exception"><li>TypeError<ul><li class="list"><p>
+ if input parameter is missing.
+ </p></li></ul>
+</li></ul>
+ <ul class="exception"><li>FileError<ul><li class="list"><p>
+ with error type INVALID_STATE_ERR, if it is already reading a file.
+ </p></li></ul>
+</li></ul>
+ </div>
+<div class="example">
+<span class="example"><p>Code example:</p></span><pre name="code" class="examplecode prettyprint"> var blob = new Blob(['abc']);
+ var fileReader = new FileReader();
+ fileReader.onload = function(){
+ console.log('Loaded, result = '+fileReader.result);
+ };
+ fileReader.readAsDataURL(blob);
+ </pre>
+</div>
+<div class="output">
+<span class="title"><p>Output example:</p></span><pre>Loaded, result = data:;base64,YWJj
+</pre>
+</div>
+</dd>
+<dt class="method" id="FileReader::readAsText">
+<a class="backward-compatibility-anchor" name="::File::FileReader::readAsText"></a><code><b><span class="methodName">readAsText</span></b></code>
+</dt>
+<dd>
+<div class="brief">
+ Reads text file.
+ </div>
+<div class="synopsis"><pre class="signature prettyprint">void readAsText( blob, optional DOMString? label);
+ </pre></div>
+<p><span class="version">
+ Since: </span>
+ 3.0
+ </p>
+<p><span class="privilegelevel">
+ Privilege level: </span>
+ public
+ </p>
+<p><span class="privilege">
+ Privilege: </span>
+ http://tizen.org/privilege/filesystem.read
+ </p>
+<div class="parameters">
+<p><span class="param">Parameters:</span></p>
+<ul>
+ <li class="param">
+<span class="name">blob</span>:
+ The <em>Blob</em> object to be read as text.
+ </li>
+ <li class="param">
+<span class="name">label</span><span class="optional"> [optional]</span><span class="optional"> [nullable]</span>:
+ An optional argument, that represents the label of an encoding
+ </li>
+ </ul>
+</div>
+<div class="exceptionlist">
+<p><span class="except">Exceptions:</span></p>
+ <ul class="exception"><li>TypeError<ul><li class="list"><p>
+ if input parameter is missing.
+ </p></li></ul>
+</li></ul>
+ <ul class="exception"><li>FileError<ul><li class="list"><p>
+ with error type INVALID_STATE_ERR, if it is already reading a file.
+ </p></li></ul>
+</li></ul>
+ </div>
+<div class="example">
+<span class="example"><p>Code example:</p></span><pre name="code" class="examplecode prettyprint"> var blob = new Blob(['abc']);
+ var fileReader = new FileReader();
+ fileReader.onload = function(){
+ console.log('Loaded, result = '+fileReader.result);
+ };
+ fileReader.readAsText(blob);
+ </pre>
+</div>
+<div class="output">
+<span class="title"><p>Output example:</p></span><pre>Loaded, result = abc
+</pre>
+</div>
+</dd>
+<dt class="method" id="FileReader::readAsBinaryString">
+<a class="backward-compatibility-anchor" name="::File::FileReader::readAsBinaryString"></a><code><b><span class="methodName">readAsBinaryString</span></b></code>
+</dt>
+<dd>
+<div class="brief">
+ Reads file as binary and returns a binary string.
+ </div>
+<div class="synopsis"><pre class="signature prettyprint">void readAsBinaryString( blob);
+ </pre></div>
+<p><span class="version">
+ Since: </span>
+ 3.0
+ </p>
+<p><span class="privilegelevel">
+ Privilege level: </span>
+ public
+ </p>
+<p><span class="privilege">
+ Privilege: </span>
+ http://tizen.org/privilege/filesystem.read
+ </p>
+<div class="parameters">
+<p><span class="param">Parameters:</span></p>
+<ul>
+ <li class="param">
+<span class="name">blob</span>:
+ The <em>Blob</em> object to be read as binary.
+ </li>
+ </ul>
+</div>
+<div class="exceptionlist">
+<p><span class="except">Exceptions:</span></p>
+ <ul class="exception"><li>TypeError<ul><li class="list"><p>
+ if input parameter is missing.
+ </p></li></ul>
+</li></ul>
+ <ul class="exception"><li>FileError<ul><li class="list"><p>
+ with error type INVALID_STATE_ERR, if it is already reading a file.
+ </p></li></ul>
+</li></ul>
+ </div>
+<div class="example">
+<span class="example"><p>Code example:</p></span><pre name="code" class="examplecode prettyprint"> var blob = new Blob(['abc']);
+ var fileReader = new FileReader();
+ fileReader.onload = function(){
+ console.log('Loaded, result = '+fileReader.result);
+ };
+ fileReader.readAsBinaryString(blob);
+ </pre>
+</div>
+<div class="output">
+<span class="title"><p>Output example:</p></span><pre>Loaded, result = abc
+</pre>
+</div>
+</dd>
+<dt class="method" id="FileReader::readAsArrayBuffer">
+<a class="backward-compatibility-anchor" name="::File::FileReader::readAsArrayBuffer"></a><code><b><span class="methodName">readAsArrayBuffer</span></b></code>
+</dt>
+<dd>
+<div class="brief">
+ Reads file as an array buffer and result would be <em>byte[]</em>.
+ </div>
+<div class="synopsis"><pre class="signature prettyprint">void readAsArrayBuffer( blob);
+ </pre></div>
+<p><span class="version">
+ Since: </span>
+ 3.0
+ </p>
+<p><span class="privilegelevel">
+ Privilege level: </span>
+ public
+ </p>
+<p><span class="privilege">
+ Privilege: </span>
+ http://tizen.org/privilege/filesystem.read
+ </p>
+<div class="parameters">
+<p><span class="param">Parameters:</span></p>
+<ul>
+ <li class="param">
+<span class="name">blob</span>:
+ The <em>Blob</em> object to be read as array buffer.
+ </li>
+ </ul>
+</div>
+<div class="exceptionlist">
+<p><span class="except">Exceptions:</span></p>
+ <ul class="exception"><li>TypeError<ul><li class="list"><p>
+ if input parameter is missing.
+ </p></li></ul>
+</li></ul>
+ <ul class="exception"><li>FileError<ul><li class="list"><p>
+ with error type INVALID_STATE_ERR, if it is already reading a file.
+ </p></li></ul>
+</li></ul>
+ </div>
+<div class="example">
+<span class="example"><p>Code example:</p></span><pre name="code" class="examplecode prettyprint"> var blob = new Blob(['abc']);
+ var fileReader = new FileReader();
+ fileReader.onload = function(){
+ resultValue = fileReader.result;
+ console.log("Result: "+resultValue.toString()+'<br>'+'ByteLength: '+resultValue.byteLength);
+ };
+ fileReader.readAsArrayBuffer(blob);
+ </pre>
+</div>
+<div class="output">
+<span class="title"><p>Output example:</p></span><pre>Result: [object ArrayBuffer]
+ByteLength: 3
+</pre>
+</div>
+</dd>
+</dl>
+</div>
+</div>
+<div class="interface" id="FileWriter">
+<a class="backward-compatibility-anchor" name="::File::FileWriter"></a><h3>2.16. FileWriter</h3>
+<div class="brief">
+ FileWriter interface allows to create and write data to file.
+ </div>
+<pre class="webidl prettyprint"> [NoInterfaceObject] interface FileWriter {
+ const short INIT = 0;
+ const short WRITING = 1;
+ const short DONE = 2;
+
+ attribute short readyState;
+
+ attribute DOMString fileName;
+
+ attribute long length;
+
+ attribute long position;
+
+ attribute <a href="#FileError">FileError</a>? error;
+
+ attribute <a href="#ProgressCallback">ProgressCallback</a>? onwritestart;
+
+ attribute <a href="#ProgressCallback">ProgressCallback</a>? onwrite;
+
+ attribute <a href="#ProgressCallback">ProgressCallback</a>? onabort;
+
+ attribute <a href="#ProgressCallback">ProgressCallback</a>? onerror;
+
+ attribute <a href="#ProgressCallback">ProgressCallback</a>? onwriteend;
+
+ void abort ();
+
+ void seek (long offset);
+
+ void truncate (long size);
+
+ void write (<a href="#WriteData">WriteData</a> data);
+ };</pre>
+<p><span class="version">
+ Since: </span>
+ 3.0
+ </p>
+<div class="consts">
+<h4>Constants</h4>
+<dl>
+<li class="const" id="FileWriter::INIT">
+<a class="backward-compatibility-anchor" name="::File::FileWriter::INIT"></a><span class="name">INIT</span><br><br>
+</li>
+<li class="const" id="FileWriter::WRITING">
+<a class="backward-compatibility-anchor" name="::File::FileWriter::WRITING"></a><span class="name">WRITING</span><br><br>
+</li>
+<li class="const" id="FileWriter::DONE">
+<a class="backward-compatibility-anchor" name="::File::FileWriter::DONE"></a><span class="name">DONE</span><div class="brief">
+ Above constants describe current state of FileWriter object.
+ </div>
+<br><br>
+</li>
+</dl>
+</div>
+<div class="attributes">
+<h4>Attributes</h4>
+<ul>
+<li class="attribute" id="FileWriter::readyState">
+<span class="attrName"><span class="type">short </span><span class="name">readyState</span></span><div class="brief">
+ One of the three possible states, either INIT, WRITING, or DONE.
+ </div>
+<p><span class="version">
+ Since: </span>
+ 3.0
+ </p>
+</li>
+<li class="attribute" id="FileWriter::fileName">
+<span class="attrName"><span class="type">DOMString </span><span class="name">fileName</span></span><div class="brief">
+ The name of the file to be written.
+ </div>
+<p><span class="version">
+ Since: </span>
+ 3.0
+ </p>
+</li>
+<li class="attribute" id="FileWriter::length">
+<span class="attrName"><span class="type">long </span><span class="name">length</span></span><div class="brief">
+ The length of the file to be written.
+ </div>
+<p><span class="version">
+ Since: </span>
+ 3.0
+ </p>
+</li>
+<li class="attribute" id="FileWriter::position">
+<span class="attrName"><span class="type">long </span><span class="name">position</span></span><div class="brief">
+ The current position of the file pointer.
+ </div>
+<p><span class="version">
+ Since: </span>
+ 3.0
+ </p>
+</li>
+<li class="attribute" id="FileWriter::error">
+<span class="attrName"><span class="type">FileError </span><span class="name">error</span><span class="optional"> [nullable]</span></span><div class="brief">
+ An object containing errors.
+ </div>
+<p><span class="version">
+ Since: </span>
+ 3.0
+ </p>
+</li>
+<li class="attribute" id="FileWriter::onwritestart">
+<span class="attrName"><span class="type">ProgressCallback </span><span class="name">onwritestart</span><span class="optional"> [nullable]</span></span><div class="brief">
+ Called when the write starts.
+ </div>
+<p><span class="version">
+ Since: </span>
+ 3.0
+ </p>
+</li>
+<li class="attribute" id="FileWriter::onwrite">
+<span class="attrName"><span class="type">ProgressCallback </span><span class="name">onwrite</span><span class="optional"> [nullable]</span></span><div class="brief">
+ Called when the request has completed successfully.
+ </div>
+<p><span class="version">
+ Since: </span>
+ 3.0
+ </p>
+</li>
+<li class="attribute" id="FileWriter::onabort">
+<span class="attrName"><span class="type">ProgressCallback </span><span class="name">onabort</span><span class="optional"> [nullable]</span></span><div class="brief">
+ Called when the write has been aborted. For instance, by invoking the abort() method.
+ </div>
+<p><span class="version">
+ Since: </span>
+ 3.0
+ </p>
+</li>
+<li class="attribute" id="FileWriter::onerror">
+<span class="attrName"><span class="type">ProgressCallback </span><span class="name">onerror</span><span class="optional"> [nullable]</span></span><div class="brief">
+ Called when the write has failed.
+ </div>
+<p><span class="version">
+ Since: </span>
+ 3.0
+ </p>
+</li>
+<li class="attribute" id="FileWriter::onwriteend">
+<span class="attrName"><span class="type">ProgressCallback </span><span class="name">onwriteend</span><span class="optional"> [nullable]</span></span><div class="brief">
+ Called when the request has completed (either in success or failure).
+ </div>
+<p><span class="version">
+ Since: </span>
+ 3.0
+ </p>
+</li>
+</ul>
+</div>
+<div class="methods">
+<h4>Methods</h4>
+<dl>
+<dt class="method" id="FileWriter::abort">
+<a class="backward-compatibility-anchor" name="::File::FileWriter::abort"></a><code><b><span class="methodName">abort</span></b></code>
+</dt>
+<dd>
+<div class="brief">
+ Aborts writing the file.
+ </div>
+<div class="synopsis"><pre class="signature prettyprint">void abort();
+ </pre></div>
+<p><span class="version">
+ Since: </span>
+ 3.0
+ </p>
+<div class="exceptionlist">
+<p><span class="except">Exceptions:</span></p>
+ <ul class="exception"><li>FileException<ul><li class="list"><p>
+ with error type TYPE_MISMATCH_ERR, if any of the input parameter is not compatible with the expected type for that parameter.
+ </p></li></ul>
+</li></ul>
+ </div>
+<div class="example">
+<span class="example"><p>Code example:</p></span><pre name="code" class="examplecode prettyprint"> successCallback = function(writer) {
+ writer.onwrite = function(evt) {
+ console.log('write success');
+ };
+ writer.onabort = function(e){
+ console.log('abort');
+ };
+ writer.write('some sample text');
+ writer.abort();
+ };
+
+ errorCallback = function(err) {
+ console.log(err.code);
+ };
+
+ // entry is FileEntry object retrieved by getFile() function of DirectoryEntry interface.
+ entry.createWriter(successCallback, errorCallback);
+ </pre>
+</div>
+<div class="output">
+<span class="title"><p>Output example:</p></span><pre>abort
+</pre>
+</div>
+</dd>
+<dt class="method" id="FileWriter::seek">
+<a class="backward-compatibility-anchor" name="::File::FileWriter::seek"></a><code><b><span class="methodName">seek</span></b></code>
+</dt>
+<dd>
+<div class="brief">
+ Moves the file pointer to the specified byte.
+ </div>
+<div class="synopsis"><pre class="signature prettyprint">void seek(long offset);
+ </pre></div>
+<p><span class="version">
+ Since: </span>
+ 3.0
+ </p>
+<div class="description">
+ <p>
+If the offset is a negative number the position of the file pointer is rewound. If the offset is greater than the file size the position is set to the end of the file.
+ </p>
+ </div>
+<div class="parameters">
+<p><span class="param">Parameters:</span></p>
+<ul>
+ <li class="param">
+<span class="name">offset</span>:
+ Location to move the file pointer to.
+ </li>
+ </ul>
+</div>
+<div class="exceptionlist">
+<p><span class="except">Exceptions:</span></p>
+ <ul class="exception"><li>FileException<ul><li class="list"><p>
+ with error type INVALID_STATE_ERR, if it is already writing a file.
+ </p></li></ul>
+</li></ul>
+ </div>
+<div class="example">
+<span class="example"><p>Code example:</p></span><pre name="code" class="examplecode prettyprint"> successCallback = function(writer) {
+ // fast forwards file pointer to the end of file.
+ writer.seek(writer.length);
+ };
+
+ errorCallback = function(err) {
+ console.log(err.code);
+ };
+
+ // entry is FileEntry object retrieved by getFile() function of DirectoryEntry interface.
+ entry.createWriter(successCallback, errorCallback);
+ </pre>
+</div>
+</dd>
+<dt class="method" id="FileWriter::truncate">
+<a class="backward-compatibility-anchor" name="::File::FileWriter::truncate"></a><code><b><span class="methodName">truncate</span></b></code>
+</dt>
+<dd>
+<div class="brief">
+ Shortens the file to the specified length.
+ </div>
+<div class="synopsis"><pre class="signature prettyprint">void truncate(long size);
+ </pre></div>
+<p><span class="version">
+ Since: </span>
+ 3.0
+ </p>
+<p><span class="privilegelevel">
+ Privilege level: </span>
+ public
+ </p>
+<p><span class="privilege">
+ Privilege: </span>
+ http://tizen.org/privilege/filesystem.write
+ </p>
+<div class="parameters">
+<p><span class="param">Parameters:</span></p>
+<ul>
+ <li class="param">
+<span class="name">size</span>:
+ Size to chop the file at.
+ </li>
+ </ul>
+</div>
+<div class="exceptionlist">
+<p><span class="except">Exceptions:</span></p>
+ <ul class="exception"><li>FileException<ul><li class="list"><p>
+ with error type INVALID_STATE_ERR, if it is already writing a file.
+ </p></li></ul>
+</li></ul>
+ </div>
+<div class="example">
+<span class="example"><p>Code example:</p></span><pre name="code" class="examplecode prettyprint"> successCallback = function(writer) {
+ writer.onwrite = function(evt) {
+ console.log('truncate success');
+ };
+
+ writer.truncate(10);
+ };
+
+ errorCallback = function(err) {
+ console.log(err.code);
+ };
+
+ // entry is FileEntry object retrieved by getFile() function of DirectoryEntry interface.
+ entry.createWriter(successCallback, errorCallback);
+ </pre>
+</div>
+<div class="output">
+<span class="title"><p>Output example:</p></span><pre>truncate success
+</pre>
+</div>
+</dd>
+<dt class="method" id="FileWriter::write">
+<a class="backward-compatibility-anchor" name="::File::FileWriter::write"></a><code><b><span class="methodName">write</span></b></code>
+</dt>
+<dd>
+<div class="brief">
+ Writes data to the file.
+ </div>
+<div class="synopsis"><pre class="signature prettyprint">void write(<a href="#WriteData">WriteData</a> data);
+ </pre></div>
+<p><span class="version">
+ Since: </span>
+ 3.0
+ </p>
+<p><span class="privilegelevel">
+ Privilege level: </span>
+ public
+ </p>
+<p><span class="privilege">
+ Privilege: </span>
+ http://tizen.org/privilege/filesystem.read
+ </p>
+<p><span class="privilege">
+ Privilege: </span>
+ http://tizen.org/privilege/filesystem.write
+ </p>
+<div class="parameters">
+<p><span class="param">Parameters:</span></p>
+<ul>
+ <li class="param">
+<span class="name">data</span>:
+ Text or Blob to be written.
+ </li>
+ </ul>
+</div>
+<div class="exceptionlist">
+<p><span class="except">Exceptions:</span></p>
+ <ul class="exception"><li>FileException<ul><li class="list"><p>
+ with error type INVALID_STATE_ERR, if it is already writing a file.
+ </p></li></ul>
+</li></ul>
+ </div>
+<div class="example">
+<span class="example"><p>Code example:</p></span><pre name="code" class="examplecode prettyprint"> successCallback = function(writer) {
+ writer.onwrite = function(evt) {
+ console.log('write success');
+ };
+
+ writer.write('some sample text');
+ };
+
+ errorCallback = function(err) {
+ console.log(err.code);
+ };
+
+ // entry is FileEntry object retrieved by getFile() function of DirectoryEntry interface.
+ entry.createWriter(successCallback, errorCallback);
+ </pre>
+</div>
+<div class="output">
+<span class="title"><p>Output example:</p></span><pre>write success
+</pre>
+</div>
+</dd>
+</dl>
+</div>
+</div>
+<div class="interface" id="ProgressCallback">
+<a class="backward-compatibility-anchor" name="::File::ProgressCallback"></a><h3>2.17. ProgressCallback</h3>
+<div class="brief">
+ The interface that defines a callback function which is called with the ProgressEvent object.
+ </div>
+<pre class="webidl prettyprint"> [Callback=FunctionOnly, NoInterfaceObject] interface ProgressCallback {
+ void onsuccess(<a href="#ProgressEvent">ProgressEvent</a> event);
+ };</pre>
+<div class="methods">
+<h4>Methods</h4>
+<dl>
+<dt class="method" id="ProgressCallback::onsuccess">
+<a class="backward-compatibility-anchor" name="::File::ProgressCallback::onsuccess"></a><code><b><span class="methodName">onsuccess</span></b></code>
+</dt>
+<dd>
+<div class="brief">
+ Called with a ProgressEvent object.
+ </div>
+<div class="synopsis"><pre class="signature prettyprint">void onsuccess(<a href="#ProgressEvent">ProgressEvent</a> event);
+ </pre></div>
+<p><span class="version">
+ Since: </span>
+ 3.0
+ </p>
+<div class="parameters">
+<p><span class="param">Parameters:</span></p>
+<ul>
+ <li class="param">
+<span class="name">event</span>:
+ A progress event.
+ </li>
+ </ul>
+</div>
+</dd>
+</dl>
+</div>
+</div>
+<div class="interface" id="FileSystemCallback">
+<a class="backward-compatibility-anchor" name="::File::FileSystemCallback"></a><h3>2.18. FileSystemCallback</h3>
+<div class="brief">
+ The FileSystemCallback interface.
+ </div>
+<pre class="webidl prettyprint"> [Callback=FunctionOnly, NoInterfaceObject] interface FileSystemCallback {
+ void handleEvent(<a href="#FileSystem">FileSystem</a> filesystem);
+ };</pre>
+<p><span class="version">
+ Since: </span>
+ 3.0
+ </p>
+<p><span class="remark"> Remark : </span>
+ Example of using can be find at <a href="file.html#FileSystem">FileSystem</a> code example.
+ </p>
+<div class="methods">
+<h4>Methods</h4>
+<dl>
+<dt class="method" id="FileSystemCallback::handleEvent">
+<a class="backward-compatibility-anchor" name="::File::FileSystemCallback::handleEvent"></a><code><b><span class="methodName">handleEvent</span></b></code>
+</dt>
+<dd>
+<div class="brief">
+ Called when the file system was successfully obtained.
+ </div>
+<div class="synopsis"><pre class="signature prettyprint">void handleEvent(<a href="#FileSystem">FileSystem</a> filesystem);
+ </pre></div>
+<p><span class="version">
+ Since: </span>
+ 3.0
+ </p>
+<div class="parameters">
+<p><span class="param">Parameters:</span></p>
+<ul>
+ <li class="param">
+<span class="name">filesystem</span>:
+ FileSystem The file systems to which the app is granted access.
+ </li>
+ </ul>
+</div>
+</dd>
+</dl>
+</div>
+</div>
+<div class="interface" id="EntryCallback">
+<a class="backward-compatibility-anchor" name="::File::EntryCallback"></a><h3>2.19. EntryCallback</h3>
+<div class="brief">
+ The EntryCallback interface.
+ </div>
+<pre class="webidl prettyprint"> [Callback=FunctionOnly, NoInterfaceObject] interface EntryCallback {
+ void handleEvent(<a href="#Entry">Entry</a> entry);
+ };</pre>
+<p><span class="version">
+ Since: </span>
+ 3.0
+ </p>
+<p><span class="remark"> Remark : </span>
+ Example of using can be find at <a href="file.html#DirectoryEntry::getDirectory">DirectoryEntry::getDirectory</a> code example.
+ </p>
+<div class="methods">
+<h4>Methods</h4>
+<dl>
+<dt class="method" id="EntryCallback::handleEvent">
+<a class="backward-compatibility-anchor" name="::File::EntryCallback::handleEvent"></a><code><b><span class="methodName">handleEvent</span></b></code>
+</dt>
+<dd>
+<div class="brief">
+ Used to supply an Entry as a response to a user query.
+ </div>
+<div class="synopsis"><pre class="signature prettyprint">void handleEvent(<a href="#Entry">Entry</a> entry);
+ </pre></div>
+<p><span class="version">
+ Since: </span>
+ 3.0
+ </p>
+<div class="parameters">
+<p><span class="param">Parameters:</span></p>
+<ul>
+ <li class="param">
+<span class="name">entry</span>:
+ Entry
+ </li>
+ </ul>
+</div>
+</dd>
+</dl>
+</div>
+</div>
+<div class="interface" id="EntriesCallback">
+<a class="backward-compatibility-anchor" name="::File::EntriesCallback"></a><h3>2.20. EntriesCallback</h3>
+<div class="brief">
+ The EntriesCallback interface.
+ </div>
+<pre class="webidl prettyprint"> [Callback=FunctionOnly, NoInterfaceObject] interface EntriesCallback {
+ void handleEvent(<a href="#Entry">Entry</a>[] entries);
+ };</pre>
+<p><span class="version">
+ Since: </span>
+ 3.0
+ </p>
+<p><span class="remark"> Remark : </span>
+ Example of using can be find at <a href="file.html#DirectoryReader::readEntries">DirectoryReader::readEntries</a> code example.
+ </p>
+<div class="methods">
+<h4>Methods</h4>
+<dl>
+<dt class="method" id="EntriesCallback::handleEvent">
+<a class="backward-compatibility-anchor" name="::File::EntriesCallback::handleEvent"></a><code><b><span class="methodName">handleEvent</span></b></code>
+</dt>
+<dd>
+<div class="brief">
+ Used to supply an array of Entries as a response to a user query.
+ </div>
+<div class="synopsis"><pre class="signature prettyprint">void handleEvent(<a href="#Entry">Entry</a>[] entries);
+ </pre></div>
+<p><span class="version">
+ Since: </span>
+ 3.0
+ </p>
+<div class="parameters">
+<p><span class="param">Parameters:</span></p>
+<ul>
+ <li class="param">
+<span class="name">entries</span>:
+ Entry[]
+ </li>
+ </ul>
+</div>
+</dd>
+</dl>
+</div>
+</div>
+<div class="interface" id="MetadataCallback">
+<a class="backward-compatibility-anchor" name="::File::MetadataCallback"></a><h3>2.21. MetadataCallback</h3>
+<div class="brief">
+ The MetadataCallback interface.
+ </div>
+<pre class="webidl prettyprint"> [Callback=FunctionOnly, NoInterfaceObject] interface MetadataCallback {
+ void handleEvent(<a href="#Metadata">Metadata</a> metadata);
+ };</pre>
+<p><span class="version">
+ Since: </span>
+ 3.0
+ </p>
+<p><span class="remark"> Remark : </span>
+ Example of using can be find at <a href="file.html#Entry::getMetadata">Entry::getMetadata</a> code example.
+ </p>
+<div class="methods">
+<h4>Methods</h4>
+<dl>
+<dt class="method" id="MetadataCallback::handleEvent">
+<a class="backward-compatibility-anchor" name="::File::MetadataCallback::handleEvent"></a><code><b><span class="methodName">handleEvent</span></b></code>
+</dt>
+<dd>
+<div class="brief">
+ Used to supply file or directory metadata as a response to a user query.
+ </div>
+<div class="synopsis"><pre class="signature prettyprint">void handleEvent(<a href="#Metadata">Metadata</a> metadata);
+ </pre></div>
+<p><span class="version">
+ Since: </span>
+ 3.0
+ </p>
+<div class="parameters">
+<p><span class="param">Parameters:</span></p>
+<ul>
+ <li class="param">
+<span class="name">metadata</span>:
+ Metadata
+ </li>
+ </ul>
+</div>
+</dd>
+</dl>
+</div>
+</div>
+<div class="interface" id="FileWriterCallback">
+<a class="backward-compatibility-anchor" name="::File::FileWriterCallback"></a><h3>2.22. FileWriterCallback</h3>
+<div class="brief">
+ The FileWriterCallback interface.
+ </div>
+<pre class="webidl prettyprint"> [Callback=FunctionOnly, NoInterfaceObject] interface FileWriterCallback {
+ void handleEvent(<a href="#FileWriter">FileWriter</a> fileWriter);
+ };</pre>
+<p><span class="version">
+ Since: </span>
+ 3.0
+ </p>
+<p><span class="remark"> Remark : </span>
+ Example of using can be find at <a href="file.html#FileEntry::createWriter">FileEntry::createWriter</a> code example.
+ </p>
+<div class="methods">
+<h4>Methods</h4>
+<dl>
+<dt class="method" id="FileWriterCallback::handleEvent">
+<a class="backward-compatibility-anchor" name="::File::FileWriterCallback::handleEvent"></a><code><b><span class="methodName">handleEvent</span></b></code>
+</dt>
+<dd>
+<div class="brief">
+ Used to supply a FileWriter as a response to a user query.
+ </div>
+<div class="synopsis"><pre class="signature prettyprint">void handleEvent(<a href="#FileWriter">FileWriter</a> fileWriter);
+ </pre></div>
+<p><span class="version">
+ Since: </span>
+ 3.0
+ </p>
+<div class="parameters">
+<p><span class="param">Parameters:</span></p>
+<ul>
+ <li class="param">
+<span class="name">fileWriter</span>:
+ FileWriter
+ </li>
+ </ul>
+</div>
+</dd>
+</dl>
+</div>
+</div>
+<div class="interface" id="FileCallback">
+<a class="backward-compatibility-anchor" name="::File::FileCallback"></a><h3>2.23. FileCallback</h3>
+<div class="brief">
+ The FileCallback interface.
+ </div>
+<pre class="webidl prettyprint"> [Callback=FunctionOnly, NoInterfaceObject] interface FileCallback {
+ void handleEvent(<a href="#File">File</a> file);
+ };</pre>
+<p><span class="version">
+ Since: </span>
+ 3.0
+ </p>
+<p><span class="remark"> Remark : </span>
+ Example of using can be find at <a href="file.html#FileEntry::file">FileEntry::file</a> code example.
+ </p>
+<div class="methods">
+<h4>Methods</h4>
+<dl>
+<dt class="method" id="FileCallback::handleEvent">
+<a class="backward-compatibility-anchor" name="::File::FileCallback::handleEvent"></a><code><b><span class="methodName">handleEvent</span></b></code>
+</dt>
+<dd>
+<div class="brief">
+ Used to supply a File as a response to a user query.
+ </div>
+<div class="synopsis"><pre class="signature prettyprint">void handleEvent(<a href="#File">File</a> file);
+ </pre></div>
+<div class="parameters">
+<p><span class="param">Parameters:</span></p>
+<ul>
+ <li class="param">
+<span class="name">file</span>:
+ File
+ </li>
+ </ul>
+</div>
+</dd>
+</dl>
+</div>
+</div>
+<div class="interface" id="VoidCallback">
+<a class="backward-compatibility-anchor" name="::File::VoidCallback"></a><h3>2.24. VoidCallback</h3>
+<div class="brief">
+ The VoidCallback interface.
+ </div>
+<pre class="webidl prettyprint"> [Callback=FunctionOnly, NoInterfaceObject] interface VoidCallback {
+ void handleEvent();
+ };</pre>
+<p><span class="version">
+ Since: </span>
+ 3.0
+ </p>
+<p><span class="remark"> Remark : </span>
+ Example of using can be find at <a href="file.html#Entry::remove">Entry::remove</a> code example.
+ </p>
+<div class="methods">
+<h4>Methods</h4>
+<dl>
+<dt class="method" id="VoidCallback::handleEvent">
+<a class="backward-compatibility-anchor" name="::File::VoidCallback::handleEvent"></a><code><b><span class="methodName">handleEvent</span></b></code>
+</dt>
+<dd>
+<div class="brief">
+ .
+ </div>
+<div class="synopsis"><pre class="signature prettyprint">void handleEvent();
+ </pre></div>
+<p><span class="version">
+ Since: </span>
+ 3.0
+ </p>
+</dd>
+</dl>
+</div>
+</div>
+<div class="interface" id="ErrorCallback">
+<a class="backward-compatibility-anchor" name="::File::ErrorCallback"></a><h3>2.25. ErrorCallback</h3>
+<div class="brief">
+ The ErrorCallback interface.
+ </div>
+<pre class="webidl prettyprint"> [Callback=FunctionOnly, NoInterfaceObject] interface ErrorCallback {
+ void handleEvent(<a href="#FileError">FileError</a> err);
+ };</pre>
+<p><span class="version">
+ Since: </span>
+ 3.0
+ </p>
+<p><span class="remark"> Remark : </span>
+ Example of using can be find at <a href="file.html#Entry::getMetadata">Entry::getMetadata</a> code example.
+ </p>
+<div class="methods">
+<h4>Methods</h4>
+<dl>
+<dt class="method" id="ErrorCallback::handleEvent">
+<a class="backward-compatibility-anchor" name="::File::ErrorCallback::handleEvent"></a><code><b><span class="methodName">handleEvent</span></b></code>
+</dt>
+<dd>
+<div class="brief">
+ There was an error with the request. Details are provided by the FileError parameter.
+ </div>
+<div class="synopsis"><pre class="signature prettyprint">void handleEvent(<a href="#FileError">FileError</a> err);
+ </pre></div>
+<p><span class="version">
+ Since: </span>
+ 3.0
+ </p>
+<div class="parameters">
+<p><span class="param">Parameters:</span></p>
+<ul>
+ <li class="param">
+<span class="name">err</span>:
+ FileError
+ </li>
+ </ul>
+</div>
+</dd>
+</dl>
+</div>
+</div>
+</div>
+<h2 id="full-webidl">3. Full WebIDL</h2>
+<pre class="webidl prettyprint">module File {
+
+ typedef ( or DOMString) WriteData;
+
+ typedef (DOMString or byte[]) ReadResultData;
+
+ dictionary FilePropertyBag {
+
+ DOMString type;
+
+ long long lastModified;
+ };
+
+ dictionary ProgressEventInit {
+ unsigned long long loaded = false;
+ unsigned long long total = false;
+ target = null;
+ };
+
+ [Constructor(DOMString type, optional <a href="#ProgressEventInit">ProgressEventInit</a> eventInitDict)]
+ interface ProgressEvent {
+ readonly attribute DOMString type;
+ readonly attribute boolean bubbles;
+ readonly attribute boolean cancelBubble;
+ readonly attribute boolean cancelable;
+ readonly attribute boolean lengthComputable;
+ readonly attribute unsigned long long loaded;
+ readonly attribute unsigned long long total;
+ readonly attribute target;
+ };
+
+ [NoInterfaceObject] interface FileSystemManagerObject {
+ readonly attribute <a href="#FileSystemManager">FileSystemManager</a> file;
+ };
+ <a href="cordova.html#Cordova">Cordova</a> implements <a href="#FileSystemManagerObject">FileSystemManagerObject</a>;
+
+
+ [NoInterfaceObject] interface FileSystemManager {
+ readonly attribute DOMString applicationDirectory;
+
+ readonly attribute DOMString applicationStorageDirectory;
+
+ readonly attribute DOMString dataDirectory;
+
+ readonly attribute DOMString cacheDirectory;
+
+ readonly attribute DOMString externalApplicationStorageDirectory;
+
+ readonly attribute DOMString externalDataDirectory;
+
+ readonly attribute DOMString externalCacheDirectory;
+
+ readonly attribute DOMString externalRootDirectory;
+
+ readonly attribute DOMString tempDirectory;
+
+ readonly attribute DOMString syncedDataDirectory;
+
+ readonly attribute DOMString documentsDirectory;
+
+ readonly attribute DOMString sharedDirectory;
+
+ };
+
+ [NoInterfaceObject] interface FileSystem {
+
+ readonly attribute DOMString name;
+
+ readonly attribute <a href="#DirectoryEntry">DirectoryEntry</a> root;
+ };
+
+ interface Metadata {
+ readonly attribute Date modificationTime;
+
+ readonly attribute unsigned long long size;
+ };
+
+ [NoInterfaceObject] interface FileError {
+ const unsigned short NOT_FOUND_ERR = 1;
+ const unsigned short SECURITY_ERR = 2;
+ const unsigned short ABORT_ERR = 3;
+ const unsigned short NOT_READABLE_ERR = 4;
+ const unsigned short ENCODING_ERR = 5;
+ const unsigned short NO_MODIFICATION_ALLOWED_ERR = 6;
+ const unsigned short INVALID_STATE_ERR = 7;
+ const unsigned short SYNTAX_ERR = 8;
+ const unsigned short INVALID_MODIFICATION_ERR = 9;
+ const unsigned short QUOTA_EXCEEDED_ERR = 10;
+ const unsigned short TYPE_MISMATCH_ERR = 11;
+ const unsigned short PATH_EXISTS_ERR = 12;
+ attribute unsigned short code;
+ };
+
+ [NoInterfaceObject] interface File {
+
+ readonly attribute DOMString name;
+
+ readonly attribute DOMString localURL;
+
+ readonly attribute DOMString type;
+
+ readonly attribute Date lastModified;
+
+ readonly attribute long long size;
+ };
+
+ [NoInterfaceObject] interface LocalFileSystem {
+
+ const short TEMPORARY = 0;
+
+ const short PERSISTENT = 1;
+
+ void requestFileSystem(short type, long long size, optional <a href="#FileSystemCallback">FileSystemCallback</a>? successCallback, optional <a href="#ErrorCallback">ErrorCallback</a>? errorCallback);
+
+ void resolveLocalFileSystemURL(DOMString uri, optional <a href="#EntryCallback">EntryCallback</a>? successCallback, optional <a href="#ErrorCallback">ErrorCallback</a>? errorCallback);
+
+ };
+
+ Window implements <a href="#LocalFileSystem">LocalFileSystem</a>;
+
+ [NoInterfaceObject] interface Entry {
+
+ readonly attribute boolean isFile;
+
+ readonly attribute boolean isDirectory;
+
+ readonly attribute DOMString fullPath;
+
+ readonly attribute DOMString name;
+
+ readonly attribute <a href="#FileSystem">FileSystem</a> filesystem;
+
+ void getMetadata(<a href="#MetadataCallback">MetadataCallback</a> onsuccess, optional <a href="#ErrorCallback">ErrorCallback</a>? onerror);
+
+ void moveTo(<a href="#DirectoryEntry">DirectoryEntry</a> parent, optional DOMString? newName, optional <a href="#EntryCallback">EntryCallback</a>? onsuccess, optional <a href="#ErrorCallback">ErrorCallback</a>? onerror);
+
+ void copyTo(<a href="#DirectoryEntry">DirectoryEntry</a> parent, optional DOMString? newName, optional <a href="#EntryCallback">EntryCallback</a>? onsuccess, optional <a href="#ErrorCallback">ErrorCallback</a>? onerror);
+
+ void getParent(<a href="#EntryCallback">EntryCallback</a> onsuccess, optional <a href="#ErrorCallback">ErrorCallback</a>? onerror);
+
+ void remove(<a href="#VoidCallback">VoidCallback</a> onsuccess, optional <a href="#ErrorCallback">ErrorCallback</a>? onerror);
+
+ DOMString toURL();
+ };
+
+ interface DirectoryEntry : <a href="#Entry">Entry</a> {
+
+ <a href="#DirectoryReader">DirectoryReader</a> createReader();
+
+ void getDirectory(DOMString path, optional ? options, optional <a href="#EntryCallback">EntryCallback</a>? onsuccess, optional <a href="#ErrorCallback">ErrorCallback</a>? onerror);
+
+ void getFile(DOMString path, optional ? options, optional <a href="#EntryCallback">EntryCallback</a>? onsuccess, optional <a href="#ErrorCallback">ErrorCallback</a>? onerror);
+
+ void removeRecursively(<a href="#VoidCallback">VoidCallback</a> onsuccess, optional <a href="#ErrorCallback">ErrorCallback</a>? onerror);
+ };
+
+ [NoInterfaceObject] interface DirectoryReader {
+
+ void readEntries(<a href="#EntriesCallback">EntriesCallback</a> onsuccess, optional <a href="#ErrorCallback">ErrorCallback</a>? onerror);
+ };
+
+ [NoInterfaceObject] interface FileEntry : <a href="#Entry">Entry</a> {
+
+ void createWriter(<a href="#FileWriterCallback">FileWriterCallback</a> onsuccess, optional <a href="#ErrorCallback">ErrorCallback</a>? onerror);
+
+ void file (<a href="#FileCallback">FileCallback</a> onsuccess, optional <a href="#ErrorCallback">ErrorCallback</a> onerror);
+ };
+
+ [Constructor()]
+ interface FileReader {
+ const short EMPTY = 0;
+ const short LOADING = 1;
+ const short DONE = 2;
+
+ readonly attribute short readyState;
+
+ readonly attribute <a href="#ReadResultData">ReadResultData</a>? result;
+
+ readonly attribute <a href="#FileError">FileError</a>? error;
+
+ attribute <a href="#ProgressCallback">ProgressCallback</a>? onloadstart;
+
+ attribute <a href="#ProgressCallback">ProgressCallback</a>? onload;
+
+ attribute <a href="#ProgressCallback">ProgressCallback</a>? onabort;
+
+ attribute <a href="#ProgressCallback">ProgressCallback</a>? onerror;
+
+ attribute <a href="#ProgressCallback">ProgressCallback</a>? onloadend;
+
+ void abort();
+
+ void readAsDataURL( blob);
+
+ void readAsText( blob, optional DOMString? label);
+
+ void readAsBinaryString( blob);
+
+ void readAsArrayBuffer( blob);
+ };
+
+ [NoInterfaceObject] interface FileWriter {
+ const short INIT = 0;
+ const short WRITING = 1;
+ const short DONE = 2;
+
+ attribute short readyState;
+
+ attribute DOMString fileName;
+
+ attribute long length;
+
+ attribute long position;
+
+ attribute <a href="#FileError">FileError</a>? error;
+
+ attribute <a href="#ProgressCallback">ProgressCallback</a>? onwritestart;
+
+ attribute <a href="#ProgressCallback">ProgressCallback</a>? onwrite;
+
+ attribute <a href="#ProgressCallback">ProgressCallback</a>? onabort;
+
+ attribute <a href="#ProgressCallback">ProgressCallback</a>? onerror;
+
+ attribute <a href="#ProgressCallback">ProgressCallback</a>? onwriteend;
+
+ void abort ();
+
+ void seek (long offset);
+
+ void truncate (long size);
+
+ void write (<a href="#WriteData">WriteData</a> data);
+ };
+
+ [Callback=FunctionOnly, NoInterfaceObject] interface ProgressCallback {
+ void onsuccess(<a href="#ProgressEvent">ProgressEvent</a> event);
+ };
+
+ [Callback=FunctionOnly, NoInterfaceObject] interface FileSystemCallback {
+ void handleEvent(<a href="#FileSystem">FileSystem</a> filesystem);
+ };
+
+ [Callback=FunctionOnly, NoInterfaceObject] interface EntryCallback {
+ void handleEvent(<a href="#Entry">Entry</a> entry);
+ };
+
+ [Callback=FunctionOnly, NoInterfaceObject] interface EntriesCallback {
+ void handleEvent(<a href="#Entry">Entry</a>[] entries);
+ };
+
+ [Callback=FunctionOnly, NoInterfaceObject] interface MetadataCallback {
+ void handleEvent(<a href="#Metadata">Metadata</a> metadata);
+ };
+
+ [Callback=FunctionOnly, NoInterfaceObject] interface FileWriterCallback {
+ void handleEvent(<a href="#FileWriter">FileWriter</a> fileWriter);
+ };
+
+ [Callback=FunctionOnly, NoInterfaceObject] interface FileCallback {
+ void handleEvent(<a href="#File">File</a> file);
+ };
+
+ [Callback=FunctionOnly, NoInterfaceObject] interface VoidCallback {
+ void handleEvent();
+ };
+
+ [Callback=FunctionOnly, NoInterfaceObject] interface ErrorCallback {
+ void handleEvent(<a href="#FileError">FileError</a> err);
+ };
+
+};</pre>
+</div>
+<div id="page-footer">
+<div class="copyright" align="center">
+ Except as noted, this content - excluding the Code Examples - is licensed under <a href="http://creativecommons.org/licenses/by/3.0/legalcode" target="_blank">Creative Commons Attribution 3.0</a> and all of the Code Examples contained herein are licensed under <a href="https://www.tizen.org/bsd-3-clause-license" target="_blank">BSD-3-Clause</a>. <br>For details, see the <a href="https://www.tizen.org/content-license" target="_blank">Content License</a>.
+ </div>
+<script type="text/javascript">
+
+ var _gaq = _gaq || [];
+ _gaq.push(['_setAccount', 'UA-25976949-1']);
+ _gaq.push(['_setDomainName', 'tizen.org']);
+ _gaq.push(['_trackPageview']);
+
+ (function() {
+ var ga = document.createElement('script'); ga.type = 'text/javascript'; ga.async = true;
+ var s = document.getElementsByTagName('script')[0]; s.parentNode.insertBefore(ga, s);
+ })();
+
+ </script>
+</div>
+</body>
+</html>
--- /dev/null
+<!DOCTYPE html PUBLIC "html">
+<html>
+<head>
+<meta http-equiv="Content-Type" content="text/html; charset=utf-8">
+<link rel="stylesheet" type="text/css" href="../tizen.css" media="screen">
+<script type="text/javascript" src="snippet.js"></script><title>FileTransfer API</title>
+</head>
+<body id="page-content" onload="prettyPrint()">
+<div class="api" id="::FileTransfer">
+
+<div class="title"><h1>FileTransfer API</h1></div>
+<div class="brief">
+ This module allows you to upload and download files.
+ </div>
+<div class="description">
+ <p>
+Original documetation: <a href="https://www.npmjs.com/package/cordova-plugin-file-transfer">Cordova FileTransfer</a> </p>
+ </div>
+<p><span class="version">
+ Since: </span>
+ 3.0
+ </p>
+<h2>Table of Contents</h2>
+<ul class="toc">
+<li>1. <a href="#typedefs-section">Type Definitions</a><ul class="toc">
+<li>
+ 1.1. <a href="#FileUploadParams">FileUploadParams</a>
+</li>
+<li>
+ 1.2. <a href="#HeaderFields">HeaderFields</a>
+</li>
+<li>
+ 1.3. <a href="#FileDownloadOptions">FileDownloadOptions</a>
+</li>
+</ul>
+</li>
+<li>2. <a href="#interfaces-section">Interfaces</a><ul class="toc">
+<li>2.1. <a href="#FileUploadOptions">FileUploadOptions</a>
+</li>
+<li>2.2. <a href="#FileUploadResult">FileUploadResult</a>
+</li>
+<li>2.3. <a href="#FileTransferError">FileTransferError</a>
+</li>
+<li>2.4. <a href="#FileTransfer">FileTransfer</a>
+</li>
+<li>2.5. <a href="#FileUploadSuccessCallback">FileUploadSuccessCallback</a>
+</li>
+<li>2.6. <a href="#FileDownloadSuccessCallback">FileDownloadSuccessCallback</a>
+</li>
+<li>2.7. <a href="#FileTransferErrorCallback">FileTransferErrorCallback</a>
+</li>
+</ul>
+</li>
+<li>3. <a href="#full-webidl">Full WebIDL</a>
+</li>
+</ul>
+<hr>
+<h2 id="method-summary">Summary of Interfaces and Methods</h2>
+<table class="informaltable">
+<thead><tr>
+<th>Interface</th>
+<th>Method</th>
+</tr></thead>
+<tbody>
+<tr>
+<td><a href="#FileUploadOptions">FileUploadOptions</a></td>
+<td></td>
+</tr>
+<tr>
+<td><a href="#FileUploadResult">FileUploadResult</a></td>
+<td></td>
+</tr>
+<tr>
+<td><a href="#FileTransferError">FileTransferError</a></td>
+<td></td>
+</tr>
+<tr>
+<td><a href="#FileTransfer">FileTransfer</a></td>
+<td>
+<div>void <a href="#FileTransfer::upload">upload</a> (DOMString fileURL, DOMString server, optional <a href="#FileUploadSuccessCallback">FileUploadSuccessCallback</a>? successCallback, optional <a href="#FileTransferErrorCallback">FileTransferErrorCallback</a>? errorCallback, optional <a href="#FileUploadOptions">FileUploadOptions</a>? options, optional boolean? trustAllHosts)</div>
+<div>void <a href="#FileTransfer::download">download</a> (DOMString source, DOMString target, optional <a href="#FileDownloadSuccessCallback">FileDownloadSuccessCallback</a>? successCallback, optional <a href="#FileTransferErrorCallback">FileTransferErrorCallback</a>? errorCallback, optional boolean? trustAllHosts, optional <a href="#FileDownloadOptions">FileDownloadOptions</a>? options)</div>
+<div>void <a href="#FileTransfer::abort">abort</a> ()</div>
+</td>
+</tr>
+<tr>
+<td><a href="#FileUploadSuccessCallback">FileUploadSuccessCallback</a></td>
+<td><div>void <a href="#FileUploadSuccessCallback::onsuccess">onsuccess</a> (<a href="#FileUploadResult">FileUploadResult</a> result)</div></td>
+</tr>
+<tr>
+<td><a href="#FileDownloadSuccessCallback">FileDownloadSuccessCallback</a></td>
+<td><div>void <a href="#FileDownloadSuccessCallback::onsuccess">onsuccess</a> (<a href="file.html#FileEntry">FileEntry</a> file)</div></td>
+</tr>
+<tr>
+<td><a href="#FileTransferErrorCallback">FileTransferErrorCallback</a></td>
+<td><div>void <a href="#FileTransferErrorCallback::onerror">onerror</a> (<a href="#FileTransferError">FileTransferError</a> error)</div></td>
+</tr>
+</tbody>
+</table>
+<div class="typedefs" id="typedefs-section">
+<h2>1. Type Definitions</h2>
+<div class="typedef" id="FileUploadParams">
+<a class="backward-compatibility-anchor" name="::FileTransfer::FileUploadParams"></a><h3>1.1. FileUploadParams</h3>
+<div class="brief">
+ A set of additional upload HTTP request parameters.
+ </div>
+<pre class="webidl prettyprint"> typedef object FileUploadParams;</pre>
+<p><span class="version">
+ Since: </span>
+ 3.0
+ </p>
+<div class="description">
+ <p>
+The key / value type to pass in the HTTP request.
+ </p>
+ </div>
+</div>
+<div class="typedef" id="HeaderFields">
+<a class="backward-compatibility-anchor" name="::FileTransfer::HeaderFields"></a><h3>1.2. HeaderFields</h3>
+<div class="brief">
+ A set of HTTP header fields.
+ </div>
+<pre class="webidl prettyprint"> typedef object HeaderFields;</pre>
+<p><span class="version">
+ Since: </span>
+ 3.0
+ </p>
+<div class="description">
+ <p>
+The key / value type of each HTTP header field should be DOMString.
+ </p>
+ </div>
+</div>
+<div class="typedef" id="FileDownloadOptions">
+<a class="backward-compatibility-anchor" name="::FileTransfer::FileDownloadOptions"></a><h3>1.3. FileDownloadOptions</h3>
+<div class="brief">
+ A set of download options.
+ </div>
+<pre class="webidl prettyprint"> typedef object FileDownloadOptions;</pre>
+<p><span class="version">
+ Since: </span>
+ 3.0
+ </p>
+<div class="description">
+ <p>
+The key / value type of download options values. Currently only supports headers (such as Authorization (Basic Authentication), etc).
+ </p>
+ </div>
+</div>
+</div>
+<div class="interfaces" id="interfaces-section">
+<h2>2. Interfaces</h2>
+<div class="interface" id="FileUploadOptions">
+<a class="backward-compatibility-anchor" name="::FileTransfer::FileUploadOptions"></a><h3>2.1. FileUploadOptions</h3>
+<div class="brief">
+ A FileUploadOptions object can be passed to the FileTransfer objects upload method in order to specify additional parameters to the upload script
+ </div>
+<pre class="webidl prettyprint"> [Constructor(DOMString fileKey, DOMString fileName, DOMString mimeType, <a href="#FileUploadParams">FileUploadParams</a> params, <a href="#HeaderFields">HeaderFields</a> headers, DOMString httpMethod)]
+ interface FileUploadOptions {
+ attribute DOMString fileKey;
+ attribute DOMString fileName;
+ attribute DOMString httpMethod;
+ attribute DOMString mimeType;
+ attribute <a href="#FileUploadParams">FileUploadParams</a> params;
+ attribute boolean chunkedMode;
+ attribute <a href="#HeaderFields">HeaderFields</a> headers;
+ };</pre>
+<p><span class="version">
+ Since: </span>
+ 3.0
+ </p>
+<div class="example">
+<span class="example"><p>Code example:</p></span><pre name="code" class="examplecode prettyprint"> var fileURL; // We assume the variable fileURL contains a valid URL to a text file on the device.
+
+ var win = function (r) {
+ console.log('Code = ' + r.responseCode);
+ console.log('Response = ' + r.response);
+ console.log('Sent = ' + r.bytesSent);
+ }
+
+ var fail = function (error) {
+ alert('An error has occurred: Code = ' + error.code);
+ console.log('upload error source ' + error.source);
+ console.log('upload error target ' + error.target);
+ }
+
+ var options = new FileUploadOptions();
+ options.fileKey = 'file';
+ options.fileName = fileURL.substr(fileURL.lastIndexOf('/') + 1);
+ options.mimeType = 'text/plain';
+
+ var params = {};
+ params.value1 = 'test';
+ params.value2 = 'param';
+
+ options.params = params;
+
+ var ft = new FileTransfer();
+ ft.upload(fileURL, encodeURI('http://some.server.com/upload.php'), win, fail, options);
+ </pre>
+</div>
+<div class="output">
+<span class="title"><p>Output example:</p></span><pre>Code = 200
+Response = OK
+Sent = 1024
+</pre>
+</div>
+<div class="constructors">
+<h4 id="FileUploadOptions::constructor">Constructors</h4>
+<dl>
+<pre class="webidl prettyprint">FileUploadOptions(DOMString fileKey, DOMString fileName, DOMString mimeType, <a href="#FileUploadParams">FileUploadParams</a> params, <a href="#HeaderFields">HeaderFields</a> headers, DOMString httpMethod);</pre>
+<div class="example">
+<span class="example"><p>Code example:</p></span><pre name="code" class="examplecode prettyprint"> // Creates a FileUploadOptions object.
+ var options = new FileUploadOptions('file', 'doc.txt', 'text/plain', null, null, 'POST');
+ </pre>
+</div>
+</dl>
+</div>
+<div class="attributes">
+<h4>Attributes</h4>
+<ul>
+<li class="attribute" id="FileUploadOptions::fileKey">
+<span class="attrName"><span class="type">DOMString </span><span class="name">fileKey</span></span><div class="brief">
+ The name of the form element. Defaults to file
+ </div>
+<p><span class="version">
+ Since: </span>
+ 3.0
+ </p>
+</li>
+<li class="attribute" id="FileUploadOptions::fileName">
+<span class="attrName"><span class="type">DOMString </span><span class="name">fileName</span></span><div class="brief">
+ The file name to use when saving the file on the server. Defaults to image.jpg.
+ </div>
+<p><span class="version">
+ Since: </span>
+ 3.0
+ </p>
+</li>
+<li class="attribute" id="FileUploadOptions::httpMethod">
+<span class="attrName"><span class="type">DOMString </span><span class="name">httpMethod</span></span><div class="brief">
+ The HTTP method to use - either PUT or POST. Defaults to POST.
+ </div>
+<p><span class="version">
+ Since: </span>
+ 3.0
+ </p>
+</li>
+<li class="attribute" id="FileUploadOptions::mimeType">
+<span class="attrName"><span class="type">DOMString </span><span class="name">mimeType</span></span><div class="brief">
+ The mime type of the data to upload. Defaults to image/jpeg.
+ </div>
+<p><span class="version">
+ Since: </span>
+ 3.0
+ </p>
+</li>
+<li class="attribute" id="FileUploadOptions::params">
+<span class="attrName"><span class="type">FileUploadParams </span><span class="name">params</span></span><div class="brief">
+ A set of optional key/value pairs to pass in the HTTP request.
+ </div>
+<p><span class="version">
+ Since: </span>
+ 3.0
+ </p>
+</li>
+<li class="attribute" id="FileUploadOptions::chunkedMode">
+<span class="attrName"><span class="type">boolean </span><span class="name">chunkedMode</span></span><div class="brief">
+ Whether to upload the data in chunked streaming mode. Defaults to true.
+ </div>
+<p><span class="version">
+ Since: </span>
+ 3.0
+ </p>
+</li>
+<li class="attribute" id="FileUploadOptions::headers">
+<span class="attrName"><span class="type">HeaderFields </span><span class="name">headers</span></span><div class="brief">
+ A map of header name/header values. Use an array to specify more than one value.
+ </div>
+<p><span class="version">
+ Since: </span>
+ 3.0
+ </p>
+</li>
+</ul>
+</div>
+</div>
+<div class="interface" id="FileUploadResult">
+<a class="backward-compatibility-anchor" name="::FileTransfer::FileUploadResult"></a><h3>2.2. FileUploadResult</h3>
+<div class="brief">
+ A FileUploadResult object is passed to the success callback of the FileTransfer object's upload() method.
+ </div>
+<pre class="webidl prettyprint"> [NoInterfaceObject] interface FileUploadResult {
+ attribute long bytesSent;
+ attribute long responseCode;
+ attribute DOMString response;
+ attribute <a href="#HeaderFields">HeaderFields</a> headers;
+ };</pre>
+<p><span class="version">
+ Since: </span>
+ 3.0
+ </p>
+<div class="attributes">
+<h4>Attributes</h4>
+<ul>
+<li class="attribute" id="FileUploadResult::bytesSent">
+<span class="attrName"><span class="type">long </span><span class="name">bytesSent</span></span><div class="brief">
+ The number of bytes sent to the server as part of the upload.
+ </div>
+<p><span class="version">
+ Since: </span>
+ 3.0
+ </p>
+</li>
+<li class="attribute" id="FileUploadResult::responseCode">
+<span class="attrName"><span class="type">long </span><span class="name">responseCode</span></span><div class="brief">
+ The HTTP response code returned by the server.
+ </div>
+<p><span class="version">
+ Since: </span>
+ 3.0
+ </p>
+</li>
+<li class="attribute" id="FileUploadResult::response">
+<span class="attrName"><span class="type">DOMString </span><span class="name">response</span></span><div class="brief">
+ The HTTP response returned by the server.
+ </div>
+<p><span class="version">
+ Since: </span>
+ 3.0
+ </p>
+</li>
+<li class="attribute" id="FileUploadResult::headers">
+<span class="attrName"><span class="type">HeaderFields </span><span class="name">headers</span></span><div class="brief">
+ The HTTP response headers by the server.
+ </div>
+<p><span class="version">
+ Since: </span>
+ 3.0
+ </p>
+</li>
+</ul>
+</div>
+</div>
+<div class="interface" id="FileTransferError">
+<a class="backward-compatibility-anchor" name="::FileTransfer::FileTransferError"></a><h3>2.3. FileTransferError</h3>
+<div class="brief">
+ A FileTransferError object is passed to an error callback when an error occurs.
+ </div>
+<pre class="webidl prettyprint"> interface FileTransferError {
+ attribute short code;
+ attribute DOMString source;
+ attribute DOMString target;
+ attribute long http_status;
+ attribute DOMString body;
+ attribute DOMString exception;
+ const short FILE_NOT_FOUND_ERR = 1;
+ const short INVALID_URL_ERR = 2;
+ const short CONNECTION_ERR = 3;
+ const short ABORT_ERR = 4;
+ const short NOT_MODIFIED_ERR = 5;
+ };</pre>
+<p><span class="version">
+ Since: </span>
+ 3.0
+ </p>
+<div class="consts">
+<h4>Constants</h4>
+<dl>
+<li class="const" id="FileTransferError::FILE_NOT_FOUND_ERR">
+<a class="backward-compatibility-anchor" name="::FileTransfer::FileTransferError::FILE_NOT_FOUND_ERR"></a><span class="name">FILE_NOT_FOUND_ERR</span><div class="brief">
+ File Not Found error.
+ </div>
+<p><span class="version">
+ Since: </span>
+ 3.0
+ </p>
+<br><br>
+</li>
+<li class="const" id="FileTransferError::INVALID_URL_ERR">
+<a class="backward-compatibility-anchor" name="::FileTransfer::FileTransferError::INVALID_URL_ERR"></a><span class="name">INVALID_URL_ERR</span><div class="brief">
+ Invalid URL error.
+ </div>
+<p><span class="version">
+ Since: </span>
+ 3.0
+ </p>
+<br><br>
+</li>
+<li class="const" id="FileTransferError::CONNECTION_ERR">
+<a class="backward-compatibility-anchor" name="::FileTransfer::FileTransferError::CONNECTION_ERR"></a><span class="name">CONNECTION_ERR</span><div class="brief">
+ Connection error.
+ </div>
+<p><span class="version">
+ Since: </span>
+ 3.0
+ </p>
+<br><br>
+</li>
+<li class="const" id="FileTransferError::ABORT_ERR">
+<a class="backward-compatibility-anchor" name="::FileTransfer::FileTransferError::ABORT_ERR"></a><span class="name">ABORT_ERR</span><div class="brief">
+ Abort error.
+ </div>
+<p><span class="version">
+ Since: </span>
+ 3.0
+ </p>
+<br><br>
+</li>
+<li class="const" id="FileTransferError::NOT_MODIFIED_ERR">
+<a class="backward-compatibility-anchor" name="::FileTransfer::FileTransferError::NOT_MODIFIED_ERR"></a><span class="name">NOT_MODIFIED_ERR</span><div class="brief">
+ Not Modified error.
+ </div>
+<p><span class="version">
+ Since: </span>
+ 3.0
+ </p>
+<br><br>
+</li>
+</dl>
+</div>
+<div class="attributes">
+<h4>Attributes</h4>
+<ul>
+<li class="attribute" id="FileTransferError::code">
+<span class="attrName"><span class="type">short </span><span class="name">code</span></span><div class="brief">
+ One of the predefined error codes listed above.
+ </div>
+<p><span class="version">
+ Since: </span>
+ 3.0
+ </p>
+</li>
+<li class="attribute" id="FileTransferError::source">
+<span class="attrName"><span class="type">DOMString </span><span class="name">source</span></span><div class="brief">
+ URL to the source.
+ </div>
+<p><span class="version">
+ Since: </span>
+ 3.0
+ </p>
+</li>
+<li class="attribute" id="FileTransferError::target">
+<span class="attrName"><span class="type">DOMString </span><span class="name">target</span></span><div class="brief">
+ URL to the target.
+ </div>
+<p><span class="version">
+ Since: </span>
+ 3.0
+ </p>
+</li>
+<li class="attribute" id="FileTransferError::http_status">
+<span class="attrName"><span class="type">long </span><span class="name">http_status</span></span><div class="brief">
+ HTTP status code. This attribute is only available when a response code is received from the HTTP connection.
+ </div>
+<p><span class="version">
+ Since: </span>
+ 3.0
+ </p>
+</li>
+<li class="attribute" id="FileTransferError::body">
+<span class="attrName"><span class="type">DOMString </span><span class="name">body</span></span><div class="brief">
+ Response body. This attribute is only available when a response is received from the HTTP connection.
+ </div>
+<p><span class="version">
+ Since: </span>
+ 3.0
+ </p>
+</li>
+<li class="attribute" id="FileTransferError::exception">
+<span class="attrName"><span class="type">DOMString </span><span class="name">exception</span></span><div class="brief">
+ Either e.getMessage or e.toString
+ </div>
+<p><span class="version">
+ Since: </span>
+ 3.0
+ </p>
+</li>
+</ul>
+</div>
+</div>
+<div class="interface" id="FileTransfer">
+<a class="backward-compatibility-anchor" name="::FileTransfer::FileTransfer"></a><h3>2.4. FileTransfer</h3>
+<div class="brief">
+ The FileTransfer object provides a way to upload files using an HTTP multi-part POST or PUT request, and to download files as well.
+ </div>
+<pre class="webidl prettyprint"> [Constructor()]
+ interface FileTransfer {
+ [TreatNonCallableAsNull] attribute <a href="file.html#ProgressCallback">ProgressCallback</a>? onprogress;
+
+ void upload(DOMString fileURL, DOMString server, optional <a href="#FileUploadSuccessCallback">FileUploadSuccessCallback</a>? successCallback, optional <a href="#FileTransferErrorCallback">FileTransferErrorCallback</a>? errorCallback, optional <a href="#FileUploadOptions">FileUploadOptions</a>? options, optional boolean? trustAllHosts);
+
+ void download(DOMString source, DOMString target, optional <a href="#FileDownloadSuccessCallback">FileDownloadSuccessCallback</a>? successCallback, optional <a href="#FileTransferErrorCallback">FileTransferErrorCallback</a>? errorCallback, optional boolean? trustAllHosts, optional <a href="#FileDownloadOptions">FileDownloadOptions</a>? options);
+
+ void abort();
+ };</pre>
+<p><span class="version">
+ Since: </span>
+ 3.0
+ </p>
+<div class="constructors">
+<h4 id="FileTransfer::constructor">Constructors</h4>
+<dl>
+<pre class="webidl prettyprint">FileTransfer();</pre>
+<div class="example">
+<span class="example"><p>Code example:</p></span><pre name="code" class="examplecode prettyprint"> // Creates a FileTransfer object.
+ var file_transfer = new FileTransfer();
+ </pre>
+</div>
+</dl>
+</div>
+<div class="attributes">
+<h4>Attributes</h4>
+<ul><li class="attribute" id="FileTransfer::onprogress">
+<span class="attrName"><span class="type">ProgressCallback </span><span class="name">onprogress</span><span class="optional"> [nullable]</span></span><div class="brief">
+ Called with a ProgressEvent whenever a new chunk of data is transferred.
+ </div>
+<p><span class="version">
+ Since: </span>
+ 3.0
+ </p>
+<div class="example">
+<span class="example"><p>Code example:</p></span><pre name="code" class="examplecode prettyprint"> var fileURL; // should be a valid url eg. cdvfile://localhost/persistent/path/to/file.txt
+
+ var win = function(r) {
+ console.log('Success. File uploaded.');
+ }
+
+ var fail = function(error) {
+ // error.code == FileTransferError.ABORT_ERR
+ alert('An error has occurred: Code = ' + error.code);
+ console.log('upload error source ' + error.source);
+ console.log('upload error target ' + error.target);
+ };
+
+ var ft = new FileTransfer();
+
+ ft.onprogress = function(event) {
+ console.log('uploaded: ' + event.loaded);
+ };
+
+ ft.upload(fileURL, encodeURI('http://some.server.com/upload.php'), win, fail);
+ </pre>
+</div>
+<div class="output">
+<span class="title"><p>Output example:</p></span><pre>uploaded: 512
+uploaded: 1024
+Success. File uploaded.
+</pre>
+</div>
+</li></ul>
+</div>
+<div class="methods">
+<h4>Methods</h4>
+<dl>
+<dt class="method" id="FileTransfer::upload">
+<a class="backward-compatibility-anchor" name="::FileTransfer::FileTransfer::upload"></a><code><b><span class="methodName">upload</span></b></code>
+</dt>
+<dd>
+<div class="brief">
+ Sends a file to a server.
+ </div>
+<div class="synopsis"><pre class="signature prettyprint">void upload(DOMString fileURL, DOMString server, optional <a href="#FileUploadSuccessCallback">FileUploadSuccessCallback</a>? successCallback, optional <a href="#FileTransferErrorCallback">FileTransferErrorCallback</a>? errorCallback, optional <a href="#FileUploadOptions">FileUploadOptions</a>? options, optional boolean? trustAllHosts);
+ </pre></div>
+<p><span class="version">
+ Since: </span>
+ 3.0
+ </p>
+<p><span class="privilegelevel">
+ Privilege level: </span>
+ public
+ </p>
+<p><span class="privilege">
+ Privilege: </span>
+ http://tizen.org/privilege/filesystem.read
+ </p>
+<p><span class="privilege">
+ Privilege: </span>
+ http://tizen.org/privilege/internet
+ </p>
+<div class="parameters">
+<p><span class="param">Parameters:</span></p>
+<ul>
+ <li class="param">
+<span class="name">fileURL</span>:
+ Filesystem URL representing the file on the device. For backwards compatibility, this can also be the full path of the file on the device.
+ </li>
+ <li class="param">
+<span class="name">server</span>:
+ URL of the server to receive the file, as encoded by encodeURI().
+ </li>
+ <li class="param">
+<span class="name">successCallback</span><span class="optional"> [optional]</span><span class="optional"> [nullable]</span>:
+ A callback that is passed a FileUploadResult object.
+ </li>
+ <li class="param">
+<span class="name">errorCallback</span><span class="optional"> [optional]</span><span class="optional"> [nullable]</span>:
+ : A callback that executes if an error occurs retrieving the FileUploadResult. Invoked with a FileTransferError object.
+ </li>
+ <li class="param">
+<span class="name">options</span><span class="optional"> [optional]</span><span class="optional"> [nullable]</span>:
+ Optional parameters
+ </li>
+ <li class="param">
+<span class="name">trustAllHosts</span><span class="optional"> [optional]</span><span class="optional"> [nullable]</span>:
+ Optional parameter, defaults to false. If set to true, it accepts all security certificates.
+ </li>
+ </ul>
+</div>
+<div class="example">
+<span class="example"><p>Code example:</p></span><pre name="code" class="examplecode prettyprint"> var fileURL; // should be a valid url eg. cdvfile://localhost/persistent/path/to/file.txt
+
+ var win = function (r) {
+ console.log('Code = ' + r.responseCode);
+ console.log('Response = ' + r.response);
+ console.log('Sent = ' + r.bytesSent);
+ }
+
+ var fail = function (error) {
+ alert('An error has occurred: Code = ' + error.code);
+ console.log('upload error source ' + error.source);
+ console.log('upload error target ' + error.target);
+ }
+
+ var ft = new FileTransfer();
+ ft.upload(fileURL, encodeURI('http://some.server.com/upload.php'), win, fail);
+ </pre>
+</div>
+<div class="output">
+<span class="title"><p>Output example:</p></span><pre>Code = 200
+Response = OK
+Sent = 1024
+</pre>
+</div>
+</dd>
+<dt class="method" id="FileTransfer::download">
+<a class="backward-compatibility-anchor" name="::FileTransfer::FileTransfer::download"></a><code><b><span class="methodName">download</span></b></code>
+</dt>
+<dd>
+<div class="brief">
+ Downloads a file from a server.
+ </div>
+<div class="synopsis"><pre class="signature prettyprint">void download(DOMString source, DOMString target, optional <a href="#FileDownloadSuccessCallback">FileDownloadSuccessCallback</a>? successCallback, optional <a href="#FileTransferErrorCallback">FileTransferErrorCallback</a>? errorCallback, optional boolean? trustAllHosts, optional <a href="#FileDownloadOptions">FileDownloadOptions</a>? options);
+ </pre></div>
+<p><span class="version">
+ Since: </span>
+ 3.0
+ </p>
+<p><span class="privilegelevel">
+ Privilege level: </span>
+ public
+ </p>
+<p><span class="privilege">
+ Privilege: </span>
+ http://tizen.org/privilege/filesystem.read
+ </p>
+<p><span class="privilege">
+ Privilege: </span>
+ http://tizen.org/privilege/filesystem.write
+ </p>
+<div class="parameters">
+<p><span class="param">Parameters:</span></p>
+<ul>
+ <li class="param">
+<span class="name">source</span>:
+ URL of the server to download the file, as encoded by encodeURI().
+ </li>
+ <li class="param">
+<span class="name">target</span>:
+ Filesystem url representing the file on the device. For backwards compatibility, this can also be the full path of the file on the device.
+ </li>
+ <li class="param">
+<span class="name">successCallback</span><span class="optional"> [optional]</span><span class="optional"> [nullable]</span>:
+ A callback that is passed a FileEntry object.
+ </li>
+ <li class="param">
+<span class="name">errorCallback</span><span class="optional"> [optional]</span><span class="optional"> [nullable]</span>:
+ A callback that executes if an error occurs when retrieving the FileEntry. Invoked with a FileTransferError object.
+ </li>
+ <li class="param">
+<span class="name">trustAllHosts</span><span class="optional"> [optional]</span><span class="optional"> [nullable]</span>:
+ Optional parameter, defaults to false. If set to true, it accepts all security certificates.
+ </li>
+ <li class="param">
+<span class="name">options</span><span class="optional"> [optional]</span><span class="optional"> [nullable]</span>:
+ Optional parameters, currently only supports headers (such as Authorization (Basic Authentication), etc).
+ </li>
+ </ul>
+</div>
+<div class="example">
+<span class="example"><p>Code example:</p></span><pre name="code" class="examplecode prettyprint"> var fileURL; // should be a valid url eg. cdvfile://localhost/persistent/path/to/file.txt
+
+ var fileTransfer = new FileTransfer();
+ var uri = encodeURI('http://some.server.com/download.php');
+
+ fileTransfer.download(
+ uri,
+ fileURL,
+ function(entry) {
+ console.log('download complete: ' + entry.toURL());
+ },
+ function(error) {
+ console.log('download error source ' + error.source);
+ console.log('download error target ' + error.target);
+ console.log('upload error code' + error.code);
+ },
+ false,
+ {
+ headers: {
+ 'Authorization': 'Basic dGVzdHVzZXJuYW1lOnRlc3RwYXNzd29yZA=='
+ }
+ }
+ );
+ </pre>
+</div>
+<div class="output">
+<span class="title"><p>Output example:</p></span><pre>download complete: file:///home/owner/apps_rw/Gk6hf8hjk/tmp/file.txt
+</pre>
+</div>
+</dd>
+<dt class="method" id="FileTransfer::abort">
+<a class="backward-compatibility-anchor" name="::FileTransfer::FileTransfer::abort"></a><code><b><span class="methodName">abort</span></b></code>
+</dt>
+<dd>
+<div class="brief">
+ Aborts an in-progress transfer. The onerror callback is passed a FileTransferError object which has an error code of FileTransferError.ABORT_ERR.
+ </div>
+<div class="synopsis"><pre class="signature prettyprint">void abort();
+ </pre></div>
+<p><span class="version">
+ Since: </span>
+ 3.0
+ </p>
+<p><span class="privilegelevel">
+ Privilege level: </span>
+ public
+ </p>
+<p><span class="privilege">
+ Privilege: </span>
+ http://tizen.org/privilege/internet
+ </p>
+<div class="example">
+<span class="example"><p>Code example:</p></span><pre name="code" class="examplecode prettyprint"> var fileURL; // should be a valid url eg. cdvfile://localhost/persistent/path/to/file.txt
+
+ var win = function(r) {
+ console.log('Should not be called.');
+ }
+
+ var fail = function(error) {
+ // error.code == FileTransferError.ABORT_ERR
+ alert('An error has occurred: Code = ' + error.code);
+ console.log('upload error source ' + error.source);
+ console.log('upload error target ' + error.target);
+ };
+
+ var ft = new FileTransfer();
+ ft.upload(fileURL, encodeURI('http://some.server.com/upload.php'), win, fail);
+ ft.abort();
+ </pre>
+</div>
+<div class="output">
+<span class="title"><p>Output example:</p></span><pre>An error has occured: Code = 4
+upload error source file:///home/owner/apps_rw/Gk6hf8hjk/tmp/file.txt
+upload error target http://some.server.com/file.txt
+</pre>
+</div>
+</dd>
+</dl>
+</div>
+</div>
+<div class="interface" id="FileUploadSuccessCallback">
+<a class="backward-compatibility-anchor" name="::FileTransfer::FileUploadSuccessCallback"></a><h3>2.5. FileUploadSuccessCallback</h3>
+<div class="brief">
+ The interface that defines a callback function which is called when an upload is successfully finished.
+ </div>
+<pre class="webidl prettyprint"> [Callback=FunctionOnly, NoInterfaceObject] interface FileUploadSuccessCallback {
+ void onsuccess(<a href="#FileUploadResult">FileUploadResult</a> result);
+ };</pre>
+<p><span class="version">
+ Since: </span>
+ 3.0
+ </p>
+<div class="methods">
+<h4>Methods</h4>
+<dl>
+<dt class="method" id="FileUploadSuccessCallback::onsuccess">
+<a class="backward-compatibility-anchor" name="::FileTransfer::FileUploadSuccessCallback::onsuccess"></a><code><b><span class="methodName">onsuccess</span></b></code>
+</dt>
+<dd>
+<div class="brief">
+ Called when upload is successfully finished.
+ </div>
+<div class="synopsis"><pre class="signature prettyprint">void onsuccess(<a href="#FileUploadResult">FileUploadResult</a> result);
+ </pre></div>
+<p><span class="version">
+ Since: </span>
+ 3.0
+ </p>
+<p><span class="remark"> Remark : </span>
+ See the <a href="#FileTransfer::upload">example</a> </p>
+<div class="parameters">
+<p><span class="param">Parameters:</span></p>
+<ul>
+ <li class="param">
+<span class="name">result</span>:
+ A result object that defines an upload result.
+ </li>
+ </ul>
+</div>
+</dd>
+</dl>
+</div>
+</div>
+<div class="interface" id="FileDownloadSuccessCallback">
+<a class="backward-compatibility-anchor" name="::FileTransfer::FileDownloadSuccessCallback"></a><h3>2.6. FileDownloadSuccessCallback</h3>
+<div class="brief">
+ The interface that defines a callback function which is called when download is successfully finished.
+ </div>
+<pre class="webidl prettyprint"> [Callback=FunctionOnly, NoInterfaceObject] interface FileDownloadSuccessCallback {
+ void onsuccess(<a href="file.html#FileEntry">FileEntry</a> file);
+ };</pre>
+<div class="methods">
+<h4>Methods</h4>
+<dl>
+<dt class="method" id="FileDownloadSuccessCallback::onsuccess">
+<a class="backward-compatibility-anchor" name="::FileTransfer::FileDownloadSuccessCallback::onsuccess"></a><code><b><span class="methodName">onsuccess</span></b></code>
+</dt>
+<dd>
+<div class="brief">
+ Called when download is successfully finished.
+ </div>
+<div class="synopsis"><pre class="signature prettyprint">void onsuccess(<a href="file.html#FileEntry">FileEntry</a> file);
+ </pre></div>
+<p><span class="version">
+ Since: </span>
+ 3.0
+ </p>
+<p><span class="remark"> Remark : </span>
+ See the <a href="#FileTransfer::download">example</a> </p>
+<div class="parameters">
+<p><span class="param">Parameters:</span></p>
+<ul>
+ <li class="param">
+<span class="name">file</span>:
+ An object that defines a downloaded file.
+ </li>
+ </ul>
+</div>
+</dd>
+</dl>
+</div>
+</div>
+<div class="interface" id="FileTransferErrorCallback">
+<a class="backward-compatibility-anchor" name="::FileTransfer::FileTransferErrorCallback"></a><h3>2.7. FileTransferErrorCallback</h3>
+<div class="brief">
+ The interface that defines an error callback function which is called when an error occur.
+ </div>
+<pre class="webidl prettyprint"> [Callback=FunctionOnly, NoInterfaceObject] interface FileTransferErrorCallback {
+ void onerror(<a href="#FileTransferError">FileTransferError</a> error);
+ };</pre>
+<div class="methods">
+<h4>Methods</h4>
+<dl>
+<dt class="method" id="FileTransferErrorCallback::onerror">
+<a class="backward-compatibility-anchor" name="::FileTransfer::FileTransferErrorCallback::onerror"></a><code><b><span class="methodName">onerror</span></b></code>
+</dt>
+<dd>
+<div class="brief">
+ Called when file transfer is finished with an error
+ </div>
+<div class="synopsis"><pre class="signature prettyprint">void onerror(<a href="#FileTransferError">FileTransferError</a> error);
+ </pre></div>
+<p><span class="version">
+ Since: </span>
+ 3.0
+ </p>
+<p><span class="remark"> Remark : </span>
+ See the <a href="#FileTransfer::download">example</a> </p>
+<div class="parameters">
+<p><span class="param">Parameters:</span></p>
+<ul>
+ <li class="param">
+<span class="name">error</span>:
+ An object that defines details of the error
+ </li>
+ </ul>
+</div>
+</dd>
+</dl>
+</div>
+</div>
+</div>
+<h2 id="full-webidl">3. Full WebIDL</h2>
+<pre class="webidl prettyprint">module FileTransfer {
+ typedef object FileUploadParams;
+
+ typedef object HeaderFields;
+
+ typedef object FileDownloadOptions;
+
+ [Constructor(DOMString fileKey, DOMString fileName, DOMString mimeType, <a href="#FileUploadParams">FileUploadParams</a> params, <a href="#HeaderFields">HeaderFields</a> headers, DOMString httpMethod)]
+ interface FileUploadOptions {
+ attribute DOMString fileKey;
+ attribute DOMString fileName;
+ attribute DOMString httpMethod;
+ attribute DOMString mimeType;
+ attribute <a href="#FileUploadParams">FileUploadParams</a> params;
+ attribute boolean chunkedMode;
+ attribute <a href="#HeaderFields">HeaderFields</a> headers;
+ };
+
+ [NoInterfaceObject] interface FileUploadResult {
+ attribute long bytesSent;
+ attribute long responseCode;
+ attribute DOMString response;
+ attribute <a href="#HeaderFields">HeaderFields</a> headers;
+ };
+
+ interface FileTransferError {
+ attribute short code;
+ attribute DOMString source;
+ attribute DOMString target;
+ attribute long http_status;
+ attribute DOMString body;
+ attribute DOMString exception;
+ const short FILE_NOT_FOUND_ERR = 1;
+ const short INVALID_URL_ERR = 2;
+ const short CONNECTION_ERR = 3;
+ const short ABORT_ERR = 4;
+ const short NOT_MODIFIED_ERR = 5;
+ };
+
+ [Constructor()]
+ interface FileTransfer {
+ [TreatNonCallableAsNull] attribute <a href="file.html#ProgressCallback">ProgressCallback</a>? onprogress;
+
+ void upload(DOMString fileURL, DOMString server, optional <a href="#FileUploadSuccessCallback">FileUploadSuccessCallback</a>? successCallback, optional <a href="#FileTransferErrorCallback">FileTransferErrorCallback</a>? errorCallback, optional <a href="#FileUploadOptions">FileUploadOptions</a>? options, optional boolean? trustAllHosts);
+
+ void download(DOMString source, DOMString target, optional <a href="#FileDownloadSuccessCallback">FileDownloadSuccessCallback</a>? successCallback, optional <a href="#FileTransferErrorCallback">FileTransferErrorCallback</a>? errorCallback, optional boolean? trustAllHosts, optional <a href="#FileDownloadOptions">FileDownloadOptions</a>? options);
+
+ void abort();
+ };
+
+ [Callback=FunctionOnly, NoInterfaceObject] interface FileUploadSuccessCallback {
+ void onsuccess(<a href="#FileUploadResult">FileUploadResult</a> result);
+ };
+
+ [Callback=FunctionOnly, NoInterfaceObject] interface FileDownloadSuccessCallback {
+ void onsuccess(<a href="file.html#FileEntry">FileEntry</a> file);
+ };
+
+ [Callback=FunctionOnly, NoInterfaceObject] interface FileTransferErrorCallback {
+ void onerror(<a href="#FileTransferError">FileTransferError</a> error);
+ };
+};</pre>
+</div>
+<div id="page-footer">
+<div class="copyright" align="center">
+ Except as noted, this content - excluding the Code Examples - is licensed under <a href="http://creativecommons.org/licenses/by/3.0/legalcode" target="_blank">Creative Commons Attribution 3.0</a> and all of the Code Examples contained herein are licensed under <a href="https://www.tizen.org/bsd-3-clause-license" target="_blank">BSD-3-Clause</a>. <br>For details, see the <a href="https://www.tizen.org/content-license" target="_blank">Content License</a>.
+ </div>
+<script type="text/javascript">
+
+ var _gaq = _gaq || [];
+ _gaq.push(['_setAccount', 'UA-25976949-1']);
+ _gaq.push(['_setDomainName', 'tizen.org']);
+ _gaq.push(['_trackPageview']);
+
+ (function() {
+ var ga = document.createElement('script'); ga.type = 'text/javascript'; ga.async = true;
+ var s = document.getElementsByTagName('script')[0]; s.parentNode.insertBefore(ga, s);
+ })();
+
+ </script>
+</div>
+</body>
+</html>
--- /dev/null
+<!DOCTYPE html PUBLIC "html">
+<html>
+<head>
+<meta http-equiv="Content-Type" content="text/html; charset=utf-8">
+<link rel="stylesheet" type="text/css" href="../tizen.css" media="screen">
+<script type="text/javascript" src="snippet.js"></script><title>Globalization API</title>
+</head>
+<body id="page-content" onload="prettyPrint()">
+<div class="api" id="::Globalization">
+
+<div class="title"><h1>Globalization API</h1></div>
+<div class="brief">
+ This plugin obtains information and performs operations specific to the user's locale,
+language, and timezone. Note the difference between locale and language: locale controls how numbers,
+dates, and times are displayed for a region, while language determines what language text appears as,
+independently of locale settings. Often developers use locale to set both settings, but there is no reason
+a user couldn't set her language to "English" but locale to "French", so that text is displayed in English
+but dates, times, etc., are displayed as they are in France. Unfortunately, most mobile platforms
+currently do not make a distinction between these settings.
+ </div>
+<div class="description">
+ <p>
+Original documentation: <a href="https://www.npmjs.com/package/cordova-plugin-globalization">Cordova Globalization</a> </p>
+ </div>
+<p><span class="version">
+ Since: </span>
+ 3.0
+ </p>
+<h2>Table of Contents</h2>
+<ul class="toc">
+<li>1. <a href="#interfaces-section">Interfaces</a><ul class="toc">
+<li>1.1. <a href="#GlobalizationManager">GlobalizationManager</a>
+</li>
+<li>1.2. <a href="#DateOptions">DateOptions</a>
+</li>
+<li>1.3. <a href="#CurrencyPattern">CurrencyPattern</a>
+</li>
+<li>1.4. <a href="#GetDateNamesOptions">GetDateNamesOptions</a>
+</li>
+<li>1.5. <a href="#NumberPatternOptions">NumberPatternOptions</a>
+</li>
+<li>1.6. <a href="#DatePattern">DatePattern</a>
+</li>
+<li>1.7. <a href="#NumberPattern">NumberPattern</a>
+</li>
+<li>1.8. <a href="#GlobalizationDate">GlobalizationDate</a>
+</li>
+<li>1.9. <a href="#DSTSuccessCallback">DSTSuccessCallback</a>
+</li>
+<li>1.10. <a href="#StringSuccessCallback">StringSuccessCallback</a>
+</li>
+<li>1.11. <a href="#ArrayStringSuccessCallback">ArrayStringSuccessCallback</a>
+</li>
+<li>1.12. <a href="#LongSuccessCallback">LongSuccessCallback</a>
+</li>
+<li>1.13. <a href="#DoubleSuccessCallback">DoubleSuccessCallback</a>
+</li>
+<li>1.14. <a href="#GlobalizationDateSuccessCallback">GlobalizationDateSuccessCallback</a>
+</li>
+<li>1.15. <a href="#PatternSuccessCallback">PatternSuccessCallback</a>
+</li>
+<li>1.16. <a href="#GetDatePatternSuccessCallback">GetDatePatternSuccessCallback</a>
+</li>
+<li>1.17. <a href="#GetNumberPatternSuccessCallback">GetNumberPatternSuccessCallback</a>
+</li>
+<li>1.18. <a href="#GlobalizationError">GlobalizationError</a>
+</li>
+</ul>
+</li>
+<li>2. <a href="#full-webidl">Full WebIDL</a>
+</li>
+</ul>
+<hr>
+<h2 id="method-summary">Summary of Interfaces and Methods</h2>
+<table class="informaltable">
+<thead><tr>
+<th>Interface</th>
+<th>Method</th>
+</tr></thead>
+<tbody>
+<tr>
+<td><a href="#GlobalizationManager">GlobalizationManager</a></td>
+<td>
+<div>void <a href="#GlobalizationManager::getPreferredLanguage">getPreferredLanguage</a> (<a href="#StringSuccessCallback">StringSuccessCallback</a> onsuccess, <a href="cordova.html#ErrorCallback">ErrorCallback</a><a href="file.html#ErrorCallback">ErrorCallback</a> onerror)</div>
+<div>void <a href="#GlobalizationManager::getLocaleName">getLocaleName</a> (<a href="#StringSuccessCallback">StringSuccessCallback</a> onsuccess, <a href="cordova.html#ErrorCallback">ErrorCallback</a><a href="file.html#ErrorCallback">ErrorCallback</a> onerror)</div>
+<div>void <a href="#GlobalizationManager::dateToString">dateToString</a> (Date date, <a href="#StringSuccessCallback">StringSuccessCallback</a> onsuccess, <a href="cordova.html#ErrorCallback">ErrorCallback</a><a href="file.html#ErrorCallback">ErrorCallback</a> onerror, optional <a href="#DateOptions">DateOptions</a> options)</div>
+<div>void <a href="#GlobalizationManager::getCurrencyPattern">getCurrencyPattern</a> (DOMString currencyCode, <a href="#PatternSuccessCallback">PatternSuccessCallback</a> onsuccess, <a href="cordova.html#ErrorCallback">ErrorCallback</a><a href="file.html#ErrorCallback">ErrorCallback</a> onerror)</div>
+<div>void <a href="#GlobalizationManager::getDateNames">getDateNames</a> (<a href="#ArrayStringSuccessCallback">ArrayStringSuccessCallback</a> onsuccess, <a href="cordova.html#ErrorCallback">ErrorCallback</a><a href="file.html#ErrorCallback">ErrorCallback</a> onerror, optional <a href="#GetDateNamesOptions">GetDateNamesOptions</a> options)</div>
+<div>void <a href="#GlobalizationManager::getDatePattern">getDatePattern</a> (<a href="#GetDatePatternSuccessCallback">GetDatePatternSuccessCallback</a> onsuccess, <a href="cordova.html#ErrorCallback">ErrorCallback</a><a href="file.html#ErrorCallback">ErrorCallback</a> onerror, optional <a href="#DateOptions">DateOptions</a> options)</div>
+<div>void <a href="#GlobalizationManager::getFirstDayOfWeek">getFirstDayOfWeek</a> (<a href="#LongSuccessCallback">LongSuccessCallback</a> onsuccess, <a href="cordova.html#ErrorCallback">ErrorCallback</a><a href="file.html#ErrorCallback">ErrorCallback</a> onerror)</div>
+<div>void <a href="#GlobalizationManager::getNumberPattern">getNumberPattern</a> (<a href="#GetNumberPatternSuccessCallback">GetNumberPatternSuccessCallback</a> onsuccess, <a href="cordova.html#ErrorCallback">ErrorCallback</a><a href="file.html#ErrorCallback">ErrorCallback</a> onerror, optional <a href="#NumberPatternOptions">NumberPatternOptions</a> options)</div>
+<div>void <a href="#GlobalizationManager::isDayLightSavingsTime">isDayLightSavingsTime</a> (Date date, <a href="#DSTSuccessCallback">DSTSuccessCallback</a> onsuccess, <a href="cordova.html#ErrorCallback">ErrorCallback</a><a href="file.html#ErrorCallback">ErrorCallback</a> onerror)</div>
+<div>void <a href="#GlobalizationManager::numberToString">numberToString</a> (double number, <a href="#StringSuccessCallback">StringSuccessCallback</a> onsuccess, <a href="cordova.html#ErrorCallback">ErrorCallback</a><a href="file.html#ErrorCallback">ErrorCallback</a> onerror, optional <a href="#NumberPatternOptions">NumberPatternOptions</a> options)</div>
+<div>void <a href="#GlobalizationManager::stringToDate">stringToDate</a> (DOMString dateString, <a href="#GlobalizationDateSuccessCallback">GlobalizationDateSuccessCallback</a> onsuccess, <a href="cordova.html#ErrorCallback">ErrorCallback</a><a href="file.html#ErrorCallback">ErrorCallback</a> onerror, optional <a href="#DateOptions">DateOptions</a> options)</div>
+<div>void <a href="#GlobalizationManager::stringToNumber">stringToNumber</a> (DOMString numberString, <a href="#DoubleSuccessCallback">DoubleSuccessCallback</a> onsuccess, <a href="cordova.html#ErrorCallback">ErrorCallback</a><a href="file.html#ErrorCallback">ErrorCallback</a> onerror, optional <a href="#NumberPatternOptions">NumberPatternOptions</a> options)</div>
+</td>
+</tr>
+<tr>
+<td><a href="#DateOptions">DateOptions</a></td>
+<td></td>
+</tr>
+<tr>
+<td><a href="#CurrencyPattern">CurrencyPattern</a></td>
+<td></td>
+</tr>
+<tr>
+<td><a href="#GetDateNamesOptions">GetDateNamesOptions</a></td>
+<td></td>
+</tr>
+<tr>
+<td><a href="#NumberPatternOptions">NumberPatternOptions</a></td>
+<td></td>
+</tr>
+<tr>
+<td><a href="#DatePattern">DatePattern</a></td>
+<td></td>
+</tr>
+<tr>
+<td><a href="#NumberPattern">NumberPattern</a></td>
+<td></td>
+</tr>
+<tr>
+<td><a href="#GlobalizationDate">GlobalizationDate</a></td>
+<td></td>
+</tr>
+<tr>
+<td><a href="#DSTSuccessCallback">DSTSuccessCallback</a></td>
+<td><div>void <a href="#DSTSuccessCallback::onsuccess">onsuccess</a> (object properties)</div></td>
+</tr>
+<tr>
+<td><a href="#StringSuccessCallback">StringSuccessCallback</a></td>
+<td><div>void <a href="#StringSuccessCallback::onsuccess">onsuccess</a> (object properties)</div></td>
+</tr>
+<tr>
+<td><a href="#ArrayStringSuccessCallback">ArrayStringSuccessCallback</a></td>
+<td><div>void <a href="#ArrayStringSuccessCallback::onsuccess">onsuccess</a> (object properties)</div></td>
+</tr>
+<tr>
+<td><a href="#LongSuccessCallback">LongSuccessCallback</a></td>
+<td><div>void <a href="#LongSuccessCallback::onsuccess">onsuccess</a> (object properties)</div></td>
+</tr>
+<tr>
+<td><a href="#DoubleSuccessCallback">DoubleSuccessCallback</a></td>
+<td><div>void <a href="#DoubleSuccessCallback::onsuccess">onsuccess</a> (object properties)</div></td>
+</tr>
+<tr>
+<td><a href="#GlobalizationDateSuccessCallback">GlobalizationDateSuccessCallback</a></td>
+<td><div>void <a href="#GlobalizationDateSuccessCallback::onsuccess">onsuccess</a> (Date date)</div></td>
+</tr>
+<tr>
+<td><a href="#PatternSuccessCallback">PatternSuccessCallback</a></td>
+<td><div>void <a href="#PatternSuccessCallback::onsuccess">onsuccess</a> (<a href="#CurrencyPattern">CurrencyPattern</a> pattern)</div></td>
+</tr>
+<tr>
+<td><a href="#GetDatePatternSuccessCallback">GetDatePatternSuccessCallback</a></td>
+<td><div>void <a href="#GetDatePatternSuccessCallback::onsuccess">onsuccess</a> (<a href="#DatePattern">DatePattern</a> pattern)</div></td>
+</tr>
+<tr>
+<td><a href="#GetNumberPatternSuccessCallback">GetNumberPatternSuccessCallback</a></td>
+<td><div>void <a href="#GetNumberPatternSuccessCallback::onsuccess">onsuccess</a> (<a href="#NumberPattern">NumberPattern</a> pattern)</div></td>
+</tr>
+<tr>
+<td><a href="#GlobalizationError">GlobalizationError</a></td>
+<td></td>
+</tr>
+</tbody>
+</table>
+<div class="interfaces" id="interfaces-section">
+<h2>1. Interfaces</h2>
+<div class="interface" id="GlobalizationManager">
+<a class="backward-compatibility-anchor" name="::Globalization::GlobalizationManager"></a><h3>1.2. GlobalizationManager</h3>
+<div class="brief">
+ the GlobalizationManager interface embodies Globalization module methods.
+ </div>
+<pre class="webidl prettyprint"> [NoInterfaceObject] interface GlobalizationManager {
+
+ void getPreferredLanguage(<a href="#StringSuccessCallback">StringSuccessCallback</a> onsuccess,
+ <a href="cordova.html#ErrorCallback">ErrorCallback</a><a href="file.html#ErrorCallback">ErrorCallback</a> onerror);
+
+ void getLocaleName(<a href="#StringSuccessCallback">StringSuccessCallback</a> onsuccess,
+ <a href="cordova.html#ErrorCallback">ErrorCallback</a><a href="file.html#ErrorCallback">ErrorCallback</a> onerror);
+
+ void dateToString(Date date, <a href="#StringSuccessCallback">StringSuccessCallback</a> onsuccess, <a href="cordova.html#ErrorCallback">ErrorCallback</a><a href="file.html#ErrorCallback">ErrorCallback</a> onerror,
+ optional <a href="#DateOptions">DateOptions</a> options);
+
+ void getCurrencyPattern(DOMString currencyCode,
+ <a href="#PatternSuccessCallback">PatternSuccessCallback</a> onsuccess,
+ <a href="cordova.html#ErrorCallback">ErrorCallback</a><a href="file.html#ErrorCallback">ErrorCallback</a> onerror);
+
+ void getDateNames(<a href="#ArrayStringSuccessCallback">ArrayStringSuccessCallback</a> onsuccess, <a href="cordova.html#ErrorCallback">ErrorCallback</a><a href="file.html#ErrorCallback">ErrorCallback</a> onerror,
+ optional <a href="#GetDateNamesOptions">GetDateNamesOptions</a> options);
+
+ void getDatePattern(<a href="#GetDatePatternSuccessCallback">GetDatePatternSuccessCallback</a> onsuccess, <a href="cordova.html#ErrorCallback">ErrorCallback</a><a href="file.html#ErrorCallback">ErrorCallback</a> onerror,
+ optional <a href="#DateOptions">DateOptions</a> options);
+
+ void getFirstDayOfWeek(<a href="#LongSuccessCallback">LongSuccessCallback</a> onsuccess,
+ <a href="cordova.html#ErrorCallback">ErrorCallback</a><a href="file.html#ErrorCallback">ErrorCallback</a> onerror);
+
+ void getNumberPattern(<a href="#GetNumberPatternSuccessCallback">GetNumberPatternSuccessCallback</a> onsuccess,
+ <a href="cordova.html#ErrorCallback">ErrorCallback</a><a href="file.html#ErrorCallback">ErrorCallback</a> onerror,
+ optional <a href="#NumberPatternOptions">NumberPatternOptions</a> options);
+
+ void isDayLightSavingsTime(Date date, <a href="#DSTSuccessCallback">DSTSuccessCallback</a> onsuccess,
+ <a href="cordova.html#ErrorCallback">ErrorCallback</a><a href="file.html#ErrorCallback">ErrorCallback</a> onerror);
+
+ void numberToString(double number, <a href="#StringSuccessCallback">StringSuccessCallback</a> onsuccess, <a href="cordova.html#ErrorCallback">ErrorCallback</a><a href="file.html#ErrorCallback">ErrorCallback</a> onerror,
+ optional <a href="#NumberPatternOptions">NumberPatternOptions</a> options);
+
+ void stringToDate(DOMString dateString, <a href="#GlobalizationDateSuccessCallback">GlobalizationDateSuccessCallback</a> onsuccess,
+ <a href="cordova.html#ErrorCallback">ErrorCallback</a><a href="file.html#ErrorCallback">ErrorCallback</a> onerror,
+ optional <a href="#DateOptions">DateOptions</a> options);
+ void stringToNumber(DOMString numberString, <a href="#DoubleSuccessCallback">DoubleSuccessCallback</a> onsuccess,
+ <a href="cordova.html#ErrorCallback">ErrorCallback</a><a href="file.html#ErrorCallback">ErrorCallback</a> onerror,
+ optional <a href="#NumberPatternOptions">NumberPatternOptions</a> options);
+ };</pre>
+<p><span class="version">
+ Since: </span>
+ 3.0
+ </p>
+<div class="methods">
+<h4>Methods</h4>
+<dl>
+<dt class="method" id="GlobalizationManager::getPreferredLanguage">
+<a class="backward-compatibility-anchor" name="::Globalization::GlobalizationManager::getPreferredLanguage"></a><code><b><span class="methodName">getPreferredLanguage</span></b></code>
+</dt>
+<dd>
+<div class="brief">
+ Gets the BCP 47 language tag for the client's current language.
+ </div>
+<div class="synopsis"><pre class="signature prettyprint">void getPreferredLanguage(<a href="#StringSuccessCallback">StringSuccessCallback</a> onsuccess, <a href="cordova.html#ErrorCallback">ErrorCallback</a><a href="file.html#ErrorCallback">ErrorCallback</a> onerror);
+ </pre></div>
+<p><span class="version">
+ Since: </span>
+ 3.0
+ </p>
+<div class="description">
+ <p>
+Returns the BCP-47 compliant language identifier tag to the successCallback
+with a properties object as a parameter. That object should have a value property
+with a String value.
+ </p>
+ </div>
+<div class="parameters">
+<p><span class="param">Parameters:</span></p>
+<ul>
+ <li class="param">
+<span class="name">onsuccess</span>:
+ The callback method to be invoked if the preferred language
+is obtained successfully.
+ </li>
+ <li class="param">
+<span class="name">onerror</span>:
+ The callback method called when errors occur
+during this method's execution.
+ </li>
+ </ul>
+</div>
+<div class="exceptionlist">
+<p><span class="except">Exceptions:</span></p>
+ <ul class="exception"><li>TypeError<ul><li class="list"><p>
+ if any of the input parameters contains an invalid value.
+ </p></li></ul>
+</li></ul>
+ </div>
+<div class="example">
+<span class="example"><p>Code example:</p></span><pre name="code" class="examplecode prettyprint"> // When the browser is set to the en-US language,
+ // this should output the text
+ // similar to the results that follow.
+
+ navigator.globalization.getPreferredLanguage(
+ function (language) { console.log('Language: ' + language.value); },
+ function () { console.log('Error getting language.'); }
+ );
+ </pre>
+</div>
+<div class="output">
+<span class="title"><p>Output example:</p></span><pre>Language: en-US
+</pre>
+</div>
+</dd>
+<dt class="method" id="GlobalizationManager::getLocaleName">
+<a class="backward-compatibility-anchor" name="::Globalization::GlobalizationManager::getLocaleName"></a><code><b><span class="methodName">getLocaleName</span></b></code>
+</dt>
+<dd>
+<div class="brief">
+ Returns the BCP 47 compliant tag for the client's current locale settings.
+ </div>
+<div class="synopsis"><pre class="signature prettyprint">void getLocaleName(<a href="#StringSuccessCallback">StringSuccessCallback</a> onsuccess, <a href="cordova.html#ErrorCallback">ErrorCallback</a><a href="file.html#ErrorCallback">ErrorCallback</a> onerror);
+ </pre></div>
+<p><span class="version">
+ Since: </span>
+ 3.0
+ </p>
+<div class="description">
+ <p>
+Returns the BCP 47 compliant locale identifier string to the successCallback
+with a properties object as a parameter. That object should have a value
+property with a String value. The locale tag will consist of a two-letter
+lower case language code, two-letter upper case country code, and (unspecified)
+variant code, separated by a hyphen.
+ </p>
+ </div>
+<div class="parameters">
+<p><span class="param">Parameters:</span></p>
+<ul>
+ <li class="param">
+<span class="name">onsuccess</span>:
+ The callback function called when the locale name
+has been obtained successfully.
+ </li>
+ <li class="param">
+<span class="name">onerror</span>:
+ The callback method invoked in case of errors
+occuring while getting a locale name.
+ </li>
+ </ul>
+</div>
+<div class="exceptionlist">
+<p><span class="except">Exceptions:</span></p>
+ <ul class="exception"><li>TypeError<ul><li class="list"><p>
+ if any of the input parameters contains an invalid value.
+ </p></li></ul>
+</li></ul>
+ </div>
+<div class="example">
+<span class="example"><p>Code example:</p></span><pre name="code" class="examplecode prettyprint"> // When the browser is set to the en-US language,
+ // this should output the text
+ // similar to the results that follow.
+
+ navigator.globalization.getLocaleName(
+ function (locale) { console.log('Locale: ' + locale.value); },
+ function () { console.log('Error getting locale.'); }
+ );
+ </pre>
+</div>
+<div class="output">
+<span class="title"><p>Output example:</p></span><pre>Locale: en-US
+</pre>
+</div>
+</dd>
+<dt class="method" id="GlobalizationManager::dateToString">
+<a class="backward-compatibility-anchor" name="::Globalization::GlobalizationManager::dateToString"></a><code><b><span class="methodName">dateToString</span></b></code>
+</dt>
+<dd>
+<div class="brief">
+ Returns a date formatted as a string according to the client's locale and timezone.
+ </div>
+<div class="synopsis"><pre class="signature prettyprint">void dateToString(Date date, <a href="#StringSuccessCallback">StringSuccessCallback</a> onsuccess, <a href="cordova.html#ErrorCallback">ErrorCallback</a><a href="file.html#ErrorCallback">ErrorCallback</a> onerror, optional <a href="#DateOptions">DateOptions</a> options);
+ </pre></div>
+<p><span class="version">
+ Since: </span>
+ 3.0
+ </p>
+<div class="description">
+ <p>
+Returns the date formatted as a String via a value property accessible from the object
+passed as a parameter to the successCallback.
+ </p>
+ </div>
+<div class="parameters">
+<p><span class="param">Parameters:</span></p>
+<ul>
+ <li class="param">
+<span class="name">date</span>:
+ The date to be converted to a DOMString. It should be of type Date.
+ </li>
+ <li class="param">
+<span class="name">onsuccess</span>:
+ The callback method called after a successful conversion.
+ </li>
+ <li class="param">
+<span class="name">onerror</span>:
+ The callback method called if errors occur during conversion.
+ </li>
+ <li class="param">
+<span class="name">options</span><span class="optional"> [optional]</span>:
+ Optional parameter defining conversion options. The default values are:
+<var>{formatLength : 'short', selector : 'date and time'}</var>.
+ </li>
+ </ul>
+</div>
+<div class="exceptionlist">
+<p><span class="except">Exceptions:</span></p>
+ <ul class="exception"><li>TypeError<ul><li class="list"><p>
+ if any of the input parameters contains an invalid value.
+ </p></li></ul>
+</li></ul>
+ </div>
+<div class="example">
+<span class="example"><p>Code example:</p></span><pre name="code" class="examplecode prettyprint"> // When the browser is set to the en-US language,
+ // this should output text similar to the results that follow.
+ // This example uses the default conversion options.
+
+ navigator.globalization.dateToString(
+ new Date(),
+ function (date) { console.log('Date: ' + date.value); },
+ function () { console.log('Error getting dateString.'); },
+ { formatLength: 'short', selector: 'date and time' }
+ );
+ </pre>
+</div>
+<div class="output">
+<span class="title"><p>Output example:</p></span><pre>Date: 9/25/2012 4:21PM
+</pre>
+</div>
+</dd>
+<dt class="method" id="GlobalizationManager::getCurrencyPattern">
+<a class="backward-compatibility-anchor" name="::Globalization::GlobalizationManager::getCurrencyPattern"></a><code><b><span class="methodName">getCurrencyPattern</span></b></code>
+</dt>
+<dd>
+<div class="brief">
+ Returns a pattern string to format and parse currency values according to
+the client's user preferences and ISO 4217 currency code.
+ </div>
+<div class="synopsis"><pre class="signature prettyprint">void getCurrencyPattern(DOMString currencyCode, <a href="#PatternSuccessCallback">PatternSuccessCallback</a> onsuccess, <a href="cordova.html#ErrorCallback">ErrorCallback</a><a href="file.html#ErrorCallback">ErrorCallback</a> onerror);
+ </pre></div>
+<p><span class="version">
+ Since: </span>
+ 3.0
+ </p>
+<div class="description">
+ <p>
+The pattern information is returned in the onsuccess callback with pattern object
+as a parameter.
+ </p>
+ </div>
+<div class="parameters">
+<p><span class="param">Parameters:</span></p>
+<ul>
+ <li class="param">
+<span class="name">currencyCode</span>:
+ ISO 4217 compliant currency code provided as a DOMString,
+for example 'USD'.
+ </li>
+ <li class="param">
+<span class="name">onsuccess</span>:
+ The callback method invoked after a successful conversion.
+ </li>
+ <li class="param">
+<span class="name">onerror</span>:
+ The callback method called if errors occur during the conversion.
+ </li>
+ </ul>
+</div>
+<div class="exceptionlist">
+<p><span class="except">Exceptions:</span></p>
+ <ul class="exception"><li>TypeError<ul><li class="list"><p>
+ if any of the input parameters contains an invalid value.
+ </p></li></ul>
+</li></ul>
+ </div>
+<div class="example">
+<span class="example"><p>Code example:</p></span><pre name="code" class="examplecode prettyprint"> // When the browser is set to the en-US locale and the selected
+ // currency is United States Dollars, this example outputs
+ // text similar to the results that follow.
+
+ navigator.globalization.getCurrencyPattern(
+ 'USD',
+ function (pattern) {
+ console.log('pattern: ' + pattern.pattern);
+ console.log('code: ' + pattern.code);
+ console.log('fraction: ' + pattern.fraction);
+ console.log('rounding: ' + pattern.rounding);
+ console.log('decimal: ' + pattern.decimal);
+ console.log('grouping: ' + pattern.grouping);
+ },
+ function () { console.log('Error getting pattern.'); }
+ );
+
+ </pre>
+</div>
+<div class="output">
+<span class="title"><p>Output example:</p></span><pre>pattern: $#,##0.##;($#,##0.##)
+code: USD
+fraction: 2
+rounding: 0
+decimal: .
+grouping: ,
+</pre>
+</div>
+</dd>
+<dt class="method" id="GlobalizationManager::getDateNames">
+<a class="backward-compatibility-anchor" name="::Globalization::GlobalizationManager::getDateNames"></a><code><b><span class="methodName">getDateNames</span></b></code>
+</dt>
+<dd>
+<div class="brief">
+ Returns an array of the names of the months or the days of the week,
+depending on the client's user preferences and calendar.
+ </div>
+<div class="synopsis"><pre class="signature prettyprint">void getDateNames(<a href="#ArrayStringSuccessCallback">ArrayStringSuccessCallback</a> onsuccess, <a href="cordova.html#ErrorCallback">ErrorCallback</a><a href="file.html#ErrorCallback">ErrorCallback</a> onerror, optional <a href="#GetDateNamesOptions">GetDateNamesOptions</a> options);
+ </pre></div>
+<p><span class="version">
+ Since: </span>
+ 3.0
+ </p>
+<div class="description">
+ <p>
+If this method executes successfully, it invokes the onsuccess callback
+with months' or days' names passed as an Array of DOMString values
+in a parameter. This array features names starting from either
+the first month in the year or the first day of the week
+depending on the option selected.
+ </p>
+ </div>
+<div class="parameters">
+<p><span class="param">Parameters:</span></p>
+<ul>
+ <li class="param">
+<span class="name">onsuccess</span>:
+ The function to be called if this method returns the names correctly.
+ </li>
+ <li class="param">
+<span class="name">onerror</span>:
+ The function to be called in case of error occuring.
+ </li>
+ <li class="param">
+<span class="name">options</span><span class="optional"> [optional]</span>:
+ An optional parameter specifying additional options.
+The default value is <var>{type: 'wide', item: 'months'}</var> </li>
+ </ul>
+</div>
+<div class="exceptionlist">
+<p><span class="except">Exceptions:</span></p>
+ <ul class="exception"><li>TypeError<ul><li class="list"><p>
+ if any of the input parameters contains an invalid value.
+ </p></li></ul>
+</li></ul>
+ </div>
+<div class="example">
+<span class="example"><p>Code example:</p></span><pre name="code" class="examplecode prettyprint"> // When the browser is set to the en_US locale,
+ // this example logs the names of months, as per locale settings,
+ // with text similar to the results that follow.
+
+ navigator.globalization.getDateNames(
+ function (names) {
+ for (var i = 0; i < names.value.length; i++) {
+ console.log('month: ' + names.value[i]);
+ }
+ },
+ function () { console.log('Error getting names.'); },
+ { type: 'wide', item: 'months' }
+ );
+ </pre>
+</div>
+<div class="output">
+<span class="title"><p>Output example:</p></span><pre>month: January
+month: February
+month: March
+month: April
+month: May
+month: June
+month: July
+month: August
+month: September
+month: October
+month: November
+month: December
+</pre>
+</div>
+</dd>
+<dt class="method" id="GlobalizationManager::getDatePattern">
+<a class="backward-compatibility-anchor" name="::Globalization::GlobalizationManager::getDatePattern"></a><code><b><span class="methodName">getDatePattern</span></b></code>
+</dt>
+<dd>
+<div class="brief">
+ Gets a pattern string to format and parse dates according to the client's
+user preferences.
+ </div>
+<div class="synopsis"><pre class="signature prettyprint">void getDatePattern(<a href="#GetDatePatternSuccessCallback">GetDatePatternSuccessCallback</a> onsuccess, <a href="cordova.html#ErrorCallback">ErrorCallback</a><a href="file.html#ErrorCallback">ErrorCallback</a> onerror, optional <a href="#DateOptions">DateOptions</a> options);
+ </pre></div>
+<p><span class="version">
+ Since: </span>
+ 3.0
+ </p>
+<div class="description">
+ <p>
+If this method executes successfully, the onsuccess callback is invoked
+with a DatePattern object passed as a parameter.
+ </p>
+ </div>
+<div class="parameters">
+<p><span class="param">Parameters:</span></p>
+<ul>
+ <li class="param">
+<span class="name">onsuccess</span>:
+ The method to be invoked when this function executes successfully.
+ </li>
+ <li class="param">
+<span class="name">onerror</span>:
+ The function to be invoked in case of errors occuring.
+ </li>
+ <li class="param">
+<span class="name">options</span><span class="optional"> [optional]</span>:
+ The DateOptions object containing additional options.
+The default value is <var>{formatLength: 'short', selector: 'date and time'}</var>.
+ </li>
+ </ul>
+</div>
+<div class="exceptionlist">
+<p><span class="except">Exceptions:</span></p>
+ <ul class="exception"><li>TypeError<ul><li class="list"><p>
+ if any of the input parameters contains an invalid value.
+ </p></li></ul>
+</li></ul>
+ </div>
+<div class="example">
+<span class="example"><p>Code example:</p></span><pre name="code" class="examplecode prettyprint"> // This example displays the locale date pattern.
+ // When the browser is set to the en_US locale,
+ // the text displayed is similar to the results that follow.
+
+ function checkDatePattern () {
+ navigator.globalization.getDatePattern(
+ function (date) { console.log('Date pattern: ' + date.pattern); },
+ function () { console.log('Error getting pattern'); },
+ { formatLength: 'short', selector: 'date and time' }
+ );
+ }
+
+ checkDatePattern();
+ </pre>
+</div>
+<div class="output">
+<span class="title"><p>Output example:</p></span><pre>Date pattern: M/d/yyyy h:mm a
+</pre>
+</div>
+</dd>
+<dt class="method" id="GlobalizationManager::getFirstDayOfWeek">
+<a class="backward-compatibility-anchor" name="::Globalization::GlobalizationManager::getFirstDayOfWeek"></a><code><b><span class="methodName">getFirstDayOfWeek</span></b></code>
+</dt>
+<dd>
+<div class="brief">
+ Gets the first day of the week according to the client's
+user preferences and calendar.
+ </div>
+<div class="synopsis"><pre class="signature prettyprint">void getFirstDayOfWeek(<a href="#LongSuccessCallback">LongSuccessCallback</a> onsuccess, <a href="cordova.html#ErrorCallback">ErrorCallback</a><a href="file.html#ErrorCallback">ErrorCallback</a> onerror);
+ </pre></div>
+<p><span class="version">
+ Since: </span>
+ 3.0
+ </p>
+<div class="description">
+ <p>
+The days of the week are numbered starting from 1, where 1 is assumed to be Sunday.
+If successful, it invokes onsuccess callback with a LongSuccessCallback object
+as a parameter. That object has a value property representing the number of
+the first day of a week.
+ </p>
+ </div>
+<div class="parameters">
+<p><span class="param">Parameters:</span></p>
+<ul>
+ <li class="param">
+<span class="name">onsuccess</span>:
+ The method to be called when this function executes successfully.
+ </li>
+ <li class="param">
+<span class="name">onerror</span>:
+ The method to be invoked in case of errors occuring.
+ </li>
+ </ul>
+</div>
+<div class="exceptionlist">
+<p><span class="except">Exceptions:</span></p>
+ <ul class="exception"><li>TypeError<ul><li class="list"><p>
+ if any of the input parameters contains an invalid value.
+ </p></li></ul>
+</li></ul>
+ </div>
+<div class="example">
+<span class="example"><p>Code example:</p></span><pre name="code" class="examplecode prettyprint"> // When the browser is set to the en_US locale,
+ // this outputs the text similar to "day: 1".
+
+ navigator.globalization.getFirstDayOfWeek(
+ function (day) { console.log('day: ' + day.value); },
+ function () { console.log('Error getting first day of week.'); }
+ );
+ </pre>
+</div>
+<div class="output">
+<span class="title"><p>Output example:</p></span><pre>day: 1
+</pre>
+</div>
+</dd>
+<dt class="method" id="GlobalizationManager::getNumberPattern">
+<a class="backward-compatibility-anchor" name="::Globalization::GlobalizationManager::getNumberPattern"></a><code><b><span class="methodName">getNumberPattern</span></b></code>
+</dt>
+<dd>
+<div class="brief">
+ Gets a pattern string to format and parse numbers
+according to the client's user preferences.
+ </div>
+<div class="synopsis"><pre class="signature prettyprint">void getNumberPattern(<a href="#GetNumberPatternSuccessCallback">GetNumberPatternSuccessCallback</a> onsuccess, <a href="cordova.html#ErrorCallback">ErrorCallback</a><a href="file.html#ErrorCallback">ErrorCallback</a> onerror, optional <a href="#NumberPatternOptions">NumberPatternOptions</a> options);
+ </pre></div>
+<p><span class="version">
+ Since: </span>
+ 3.0
+ </p>
+<div class="description">
+ <p>
+The obtained pattern is then passed to the onsuccess callback
+as a parameter.
+ </p>
+ </div>
+<div class="parameters">
+<p><span class="param">Parameters:</span></p>
+<ul>
+ <li class="param">
+<span class="name">onsuccess</span>:
+ The callback method to be invoked
+when this function executes successfully.
+ </li>
+ <li class="param">
+<span class="name">onerror</span>:
+ The callback method to be invoked
+in case of errors occuring during this method's execution.
+ </li>
+ <li class="param">
+<span class="name">options</span><span class="optional"> [optional]</span>:
+ Defines the type of numeric value for which
+the pattern will be returned.
+ </li>
+ </ul>
+</div>
+<div class="exceptionlist">
+<p><span class="except">Exceptions:</span></p>
+ <ul class="exception"><li>TypeError<ul><li class="list"><p>
+ if any of the input parameters contains an invalid value.
+ </p></li></ul>
+</li></ul>
+ </div>
+<div class="example">
+<span class="example"><p>Code example:</p></span><pre name="code" class="examplecode prettyprint"> // When the browser is set to the en_US locale,
+ // this example outputs the text
+ // similar to the results that follow.
+
+ navigator.globalization.getNumberPattern(
+ function (pattern) {
+ console.log('pattern: ' + pattern.pattern);
+ console.log('symbol: ' + pattern.symbol);
+ console.log('fraction: ' + pattern.fraction);
+ console.log('rounding: ' + pattern.rounding);
+ console.log('positive: ' + pattern.positive);
+ console.log('negative: ' + pattern.negative);
+ console.log('decimal: ' + pattern.decimal);
+ console.log('grouping: ' + pattern.grouping);
+ },
+ function() { console.log('An error occurred.'); },
+ { type: 'decimal' }
+ );
+
+ </pre>
+</div>
+<div class="output">
+<span class="title"><p>Output example:</p></span><pre>pattern: #,##0.###
+symbol: .
+fraction: 0
+rounding: 0
+positive:
+negative: -
+decimal: .
+grouping: ,
+</pre>
+</div>
+</dd>
+<dt class="method" id="GlobalizationManager::isDayLightSavingsTime">
+<a class="backward-compatibility-anchor" name="::Globalization::GlobalizationManager::isDayLightSavingsTime"></a><code><b><span class="methodName">isDayLightSavingsTime</span></b></code>
+</dt>
+<dd>
+<div class="brief">
+ Indicates whether or not daylight savings time is in effect
+for a given date using the client's time zone and calendar.
+ </div>
+<div class="synopsis"><pre class="signature prettyprint">void isDayLightSavingsTime(Date date, <a href="#DSTSuccessCallback">DSTSuccessCallback</a> onsuccess, <a href="cordova.html#ErrorCallback">ErrorCallback</a><a href="file.html#ErrorCallback">ErrorCallback</a> onerror);
+ </pre></div>
+<p><span class="version">
+ Since: </span>
+ 3.0
+ </p>
+<div class="description">
+ <p>
+If this function executes successfully, the onsuccess callback
+will be invoked with a dstStatus object as a parameter. That object
+would contain a dst property with a Boolean value. The true value
+indicates that the DST is in effect for the given date.
+ </p>
+ </div>
+<div class="parameters">
+<p><span class="param">Parameters:</span></p>
+<ul>
+ <li class="param">
+<span class="name">date</span>:
+ The Date object for which the daylight savings time status will be checked.
+ </li>
+ <li class="param">
+<span class="name">onsuccess</span>:
+ The callback method to be called when this function
+successfully completes its execution.
+ </li>
+ <li class="param">
+<span class="name">onerror</span>:
+ The callback method to be called in case of
+errors occuring during this method's execution.
+ </li>
+ </ul>
+</div>
+<div class="exceptionlist">
+<p><span class="except">Exceptions:</span></p>
+ <ul class="exception"><li>TypeError<ul><li class="list"><p>
+ if any of the input parameters contains an invalid value.
+ </p></li></ul>
+</li></ul>
+ </div>
+<div class="example">
+<span class="example"><p>Code example:</p></span><pre name="code" class="examplecode prettyprint"> // During the summer, and if the browser
+ // is set to a DST-enabled timezone,
+ // this should log text similar to "dst: true":
+
+ navigator.globalization.isDayLightSavingsTime(
+ new Date(),
+ function (date) { console.log('dst: ' + date.dst); },
+ function () { console.log('Error getting the DST state.'); }
+ );
+ </pre>
+</div>
+<div class="output">
+<span class="title"><p>Output example:</p></span><pre>dst: true
+</pre>
+</div>
+</dd>
+<dt class="method" id="GlobalizationManager::numberToString">
+<a class="backward-compatibility-anchor" name="::Globalization::GlobalizationManager::numberToString"></a><code><b><span class="methodName">numberToString</span></b></code>
+</dt>
+<dd>
+<div class="brief">
+ Returns a number formatted as a string
+according to the client's user preferences.
+ </div>
+<div class="synopsis"><pre class="signature prettyprint">void numberToString(double number, <a href="#StringSuccessCallback">StringSuccessCallback</a> onsuccess, <a href="cordova.html#ErrorCallback">ErrorCallback</a><a href="file.html#ErrorCallback">ErrorCallback</a> onerror, optional <a href="#NumberPatternOptions">NumberPatternOptions</a> options);
+ </pre></div>
+<p><span class="version">
+ Since: </span>
+ 3.0
+ </p>
+<div class="description">
+ <p>
+The formatted number string is returned by onsuccess callback with
+a properties object as a parameter. That object contains a property value
+of DOMString type containing the result of the conversion.
+ </p>
+ </div>
+<div class="parameters">
+<p><span class="param">Parameters:</span></p>
+<ul>
+ <li class="param">
+<span class="name">number</span>:
+ The number that will be converted to a DOMString
+in accordance with the client's user preferences.
+ </li>
+ <li class="param">
+<span class="name">onsuccess</span>:
+ The callback function executed when the conversion
+is done successfully. The results of the conversion are passed
+as a parameter to this callback function.
+ </li>
+ <li class="param">
+<span class="name">onerror</span>:
+ The callback function executed in case of errors
+occuring during the conversion. The GlobalizationError object with
+the details is passed as a parameter to this callback function.
+ </li>
+ <li class="param">
+<span class="name">options</span><span class="optional"> [optional]</span>:
+ Additional options specifying the details of conversion.
+It is a dictionary with a single property <var>type</var>.
+The default value of this parameter is <var>{type: 'decimal'}</var>.
+ </li>
+ </ul>
+</div>
+<div class="exceptionlist">
+<p><span class="except">Exceptions:</span></p>
+ <ul class="exception"><li>TypeError<ul><li class="list"><p>
+ if any of the input parameters contains an invalid value.
+ </p></li></ul>
+</li></ul>
+ </div>
+<div class="example">
+<span class="example"><p>Code example:</p></span><pre name="code" class="examplecode prettyprint"> // When the browser is set to the en_US locale,
+ // this code displays the results that follow.
+
+ navigator.globalization.numberToString(
+ 3.1415926,
+ function (number) { console.log('decimal number: ' + number.value); },
+ function () { console.log('Error getting number.'); },
+ { type: 'decimal' }
+ );
+
+ navigator.globalization.numberToString(
+ 1000003,
+ function (number) { console.log('big decimal number: ' + number.value); },
+ function () { console.log('Error getting number.'); },
+ { type: 'decimal' }
+ );
+
+ navigator.globalization.numberToString(
+ 0.3183099,
+ function (number) { console.log('percentile: ' + number.value); },
+ function () { console.log('Error getting number.'); },
+ { type: 'percent' }
+ );
+
+ navigator.globalization.numberToString(
+ 1099.95,
+ function (number) { console.log('currency: ' + number.value); },
+ function () { console.log('Error getting number'); },
+ { type: 'currency' }
+ );
+ </pre>
+</div>
+<div class="output">
+<span class="title"><p>Output example:</p></span><pre>decimal number: 3.142
+big decimal number: 1,000,003
+percentile: 32%
+currency: $1,099.95
+</pre>
+</div>
+</dd>
+<dt class="method" id="GlobalizationManager::stringToDate">
+<a class="backward-compatibility-anchor" name="::Globalization::GlobalizationManager::stringToDate"></a><code><b><span class="methodName">stringToDate</span></b></code>
+</dt>
+<dd>
+<div class="brief">
+ Parses a date formatted as a DOMString according to the client's
+user preferences and calendar using the time zone of the client.
+Returns the corresponding date object.
+ </div>
+<div class="synopsis"><pre class="signature prettyprint">void stringToDate(DOMString dateString, <a href="#GlobalizationDateSuccessCallback">GlobalizationDateSuccessCallback</a> onsuccess, <a href="cordova.html#ErrorCallback">ErrorCallback</a><a href="file.html#ErrorCallback">ErrorCallback</a> onerror, optional <a href="#DateOptions">DateOptions</a> options);
+ </pre></div>
+<p><span class="version">
+ Since: </span>
+ 3.0
+ </p>
+<div class="parameters">
+<p><span class="param">Parameters:</span></p>
+<ul>
+ <li class="param">
+<span class="name">dateString</span>:
+ a string containing the representation of a date to be converted
+to a Date object.
+ </li>
+ <li class="param">
+<span class="name">onsuccess</span>:
+ The callback method invoked when the conversion completes successfully.
+The result of conversion is passed as a parameter to this callback.
+ </li>
+ <li class="param">
+<span class="name">onerror</span>:
+ The callback method invoked in case of errors occuring during
+the conversion. A GlobalizationError object is passed as a parameter
+to this callback.
+ </li>
+ <li class="param">
+<span class="name">options</span><span class="optional"> [optional]</span>:
+ Additional options specifying the details of the conversion.
+The default value is <var>{formatLength: 'short', selector: 'date and time'}</var>.
+ </li>
+ </ul>
+</div>
+<div class="exceptionlist">
+<p><span class="except">Exceptions:</span></p>
+ <ul class="exception"><li>TypeError<ul><li class="list"><p>
+ if any of the input parameters contains an invalid value.
+ </p></li></ul>
+</li></ul>
+ </div>
+<div class="example">
+<span class="example"><p>Code example:</p></span><pre name="code" class="examplecode prettyprint"> // when the browser is set to the en_US locale,
+ // this example outputs text similar to the results that follow.
+ // Note that the month integer is one less than the string,
+ // as the month integer represents an array index.
+
+ navigator.globalization.stringToDate(
+ '9/25/2012',
+ function (date) {
+ console.log('month: ' + date.month +
+ ', day: ' + date.day +
+ ', year: ' + date.year)
+ },
+ function () { console.log('Error getting date.'); },
+ { selector: 'date' }
+ );
+ </pre>
+</div>
+<div class="output">
+<span class="title"><p>Output example:</p></span><pre>month: 8, day: 25, year: 2012
+</pre>
+</div>
+</dd>
+<dt class="method" id="GlobalizationManager::stringToNumber">
+<a class="backward-compatibility-anchor" name="::Globalization::GlobalizationManager::stringToNumber"></a><code><b><span class="methodName">stringToNumber</span></b></code>
+</dt>
+<dd>
+<div class="brief">
+ Parses a number formatted as a string according to the client's
+user preferences and returns the corresponding number.
+ </div>
+<div class="synopsis"><pre class="signature prettyprint">void stringToNumber(DOMString numberString, <a href="#DoubleSuccessCallback">DoubleSuccessCallback</a> onsuccess, <a href="cordova.html#ErrorCallback">ErrorCallback</a><a href="file.html#ErrorCallback">ErrorCallback</a> onerror, optional <a href="#NumberPatternOptions">NumberPatternOptions</a> options);
+ </pre></div>
+<p><span class="version">
+ Since: </span>
+ 3.0
+ </p>
+<div class="description">
+ <p>
+If successful, the result of the conversion is passed as a parameter to the onsuccess
+callback method.
+ </p>
+ </div>
+<div class="parameters">
+<p><span class="param">Parameters:</span></p>
+<ul>
+ <li class="param">
+<span class="name">numberString</span>:
+ The DOMString containing a text representation of a number
+to be converted to a double data type.
+ </li>
+ <li class="param">
+<span class="name">onsuccess</span>:
+ The callback method called after a successful conversion.
+The result of a conversion is passed as a parameter of this callback method.
+ </li>
+ <li class="param">
+<span class="name">onerror</span>:
+ The callback method invoked in case of errors occuring during
+the conversion. The error is passed as a parameter of this callback method.
+ </li>
+ <li class="param">
+<span class="name">options</span><span class="optional"> [optional]</span>:
+ Additional options specifying the details of the conversion.
+The default value is <var>{type: 'decimal'}</var> </li>
+ </ul>
+</div>
+<div class="exceptionlist">
+<p><span class="except">Exceptions:</span></p>
+ <ul class="exception"><li>TypeError<ul><li class="list"><p>
+ if any of the input parameters contains an invalid value.
+ </p></li></ul>
+</li></ul>
+ </div>
+<div class="example">
+<span class="example"><p>Code example:</p></span><pre name="code" class="examplecode prettyprint"> // When the browser is set to the en_US locale,
+ // this should display the text similar to the results that follow.
+
+ navigator.globalization.stringToNumber(
+ '1234.56',
+ function (number) { console.log('number: ' + number.value); },
+ function () { console.log('Error getting number.'); },
+ { type: 'decimal' }
+ );
+ </pre>
+</div>
+<div class="output">
+<span class="title"><p>Output example:</p></span><pre>number: 1234.56
+</pre>
+</div>
+</dd>
+</dl>
+</div>
+</div>
+<div class="dictionary" id="DateOptions">
+<a class="backward-compatibility-anchor" name="::Globalization::DateOptions"></a><h3>1.3. DateOptions</h3>
+<div class="brief">
+ DateOptions is a dictionary containing options for date conversions.
+ </div>
+<pre class="webidl prettyprint"> dictionary DateOptions {
+ DOMString formatLength;
+ DOMString selector;
+ };</pre>
+<p><span class="version">
+ Since: </span>
+ 3.0
+ </p>
+<div class="attributes">
+<h4>Dictionary members</h4>
+<dl>
+<dt class="member" id="DateOptions::formatLength"><span class="attrName">DOMString formatLength</span></dt>
+<dd>
+<div class="brief">
+ Indicates the length of DOMString representation of the date.
+ </div>
+<div class="description">
+ <p>
+Valid values are:
+ </p>
+ <ul>
+ <li>
+'short' </li>
+ <li>
+'medium' </li>
+ <li>
+'long' </li>
+ <li>
+'full' </li>
+ </ul>
+ </div>
+</dd>
+<dt class="member" id="DateOptions::selector"><span class="attrName">DOMString selector</span></dt>
+<dd>
+<div class="brief">
+ Indicates the selector for DOMString representation of the date.
+ </div>
+<div class="description">
+ <p>
+Valid values are:
+ </p>
+ <ul>
+ <li>
+'date' </li>
+ <li>
+'time' </li>
+ <li>
+'date and time' </li>
+ </ul>
+ </div>
+</dd>
+</dl>
+</div>
+</div>
+<div class="dictionary" id="CurrencyPattern">
+<a class="backward-compatibility-anchor" name="::Globalization::CurrencyPattern"></a><h3>1.4. CurrencyPattern</h3>
+<div class="brief">
+ CurrencyPattern is a dictionary containing currency formatting properties.
+ </div>
+<pre class="webidl prettyprint"> dictionary CurrencyPattern {
+ DOMString pattern;
+ DOMString code;
+ long fraction;
+ double rounding;
+ DOMString decimal;
+ DOMString grouping;
+ };</pre>
+<div class="attributes">
+<h4>Dictionary members</h4>
+<dl>
+<dt class="member" id="CurrencyPattern::pattern"><span class="attrName">DOMString pattern</span></dt>
+<dd>
+<div class="brief">
+ The currency pattern to format and parse the currency values.
+The patterns follow Unicode Technical Standard #35.
+ </div>
+<p><span class="version">
+ Since: </span>
+ 3.0
+ </p>
+</dd>
+<dt class="member" id="CurrencyPattern::code"><span class="attrName">DOMString code</span></dt>
+<dd>
+<div class="brief">
+ The ISO 4217 currency code for the pattern.
+ </div>
+<p><span class="version">
+ Since: </span>
+ 3.0
+ </p>
+</dd>
+<dt class="member" id="CurrencyPattern::fraction"><span class="attrName">long fraction</span></dt>
+<dd>
+<div class="brief">
+ The number of fractional digits to use when parsing and formatting currency.
+ </div>
+<p><span class="version">
+ Since: </span>
+ 3.0
+ </p>
+</dd>
+<dt class="member" id="CurrencyPattern::rounding"><span class="attrName">double rounding</span></dt>
+<dd>
+<div class="brief">
+ The rounding increment to use when parsing and formatting.
+ </div>
+<p><span class="version">
+ Since: </span>
+ 3.0
+ </p>
+</dd>
+<dt class="member" id="CurrencyPattern::decimal"><span class="attrName">DOMString decimal</span></dt>
+<dd>
+<div class="brief">
+ The decimal symbol to use for parsing and formatting.
+ </div>
+<p><span class="version">
+ Since: </span>
+ 3.0
+ </p>
+</dd>
+<dt class="member" id="CurrencyPattern::grouping"><span class="attrName">DOMString grouping</span></dt>
+<dd>
+<div class="brief">
+ The grouping symbol to use for parsing and formatting.
+ </div>
+<p><span class="version">
+ Since: </span>
+ 3.0
+ </p>
+</dd>
+</dl>
+</div>
+</div>
+<div class="dictionary" id="GetDateNamesOptions">
+<a class="backward-compatibility-anchor" name="::Globalization::GetDateNamesOptions"></a><h3>1.5. GetDateNamesOptions</h3>
+<div class="brief">
+ The GetDateNamesOptions dictionary contains options used in getDateNames method.
+ </div>
+<pre class="webidl prettyprint"> dictionary GetDateNamesOptions {
+ DOMString type;
+ DOMString item;
+ };</pre>
+<p><span class="version">
+ Since: </span>
+ 3.0
+ </p>
+<div class="attributes">
+<h4>Dictionary members</h4>
+<dl>
+<dt class="member" id="GetDateNamesOptions::type"><span class="attrName">DOMString type</span></dt>
+<dd>
+<div class="brief">
+ Determines whether to use abbreviated (narrow) or full-length (wide) names.
+ </div>
+<div class="description">
+ <p>
+The following values are valid:
+ </p>
+ <ul>
+ <li>
+'narrow' - Abbreviated names will be returned. </li>
+ <li>
+'wide' - Full names will be returned. </li>
+ </ul>
+ </div>
+<p><span class="version">
+ Since: </span>
+ 3.0
+ </p>
+</dd>
+<dt class="member" id="GetDateNamesOptions::item"><span class="attrName">DOMString item</span></dt>
+<dd>
+<div class="brief">
+ Determines whether to return the names of months or the names of days.
+ </div>
+<div class="description">
+ <p>
+The following values are valid:
+ </p>
+ <ul>
+ <li>
+'months' - The names of months will be returned. </li>
+ <li>
+'days' - The names of days of the week will be returned. </li>
+ </ul>
+ </div>
+<p><span class="version">
+ Since: </span>
+ 3.0
+ </p>
+</dd>
+</dl>
+</div>
+</div>
+<div class="dictionary" id="NumberPatternOptions">
+<a class="backward-compatibility-anchor" name="::Globalization::NumberPatternOptions"></a><h3>1.6. NumberPatternOptions</h3>
+<div class="brief">
+ The NumberPatternOptions dictionary contains options
+used in handling numerical locale settings.
+ </div>
+<pre class="webidl prettyprint"> dictionary NumberPatternOptions {
+ DOMString type;
+ };</pre>
+<p><span class="version">
+ Since: </span>
+ 3.0
+ </p>
+<div class="attributes">
+<h4>Dictionary members</h4>
+<dl>
+<dt class="member" id="NumberPatternOptions::type"><span class="attrName">DOMString type</span></dt>
+<dd>
+<div class="brief">
+ The type determines the genus of numeric value,
+for which the pattern will be extracted.
+ </div>
+<div class="description">
+ <p>
+The following values are valid:
+ </p>
+ <ul>
+ <li>
+'decimal' - Indicates that the pattern for the
+decimal numbers should be extracted. </li>
+ <li>
+'percent' - Indicates that the pattern for the
+percents should be extracted. </li>
+ <li>
+'currency' - Indicates that the pattern for the
+currency values should be extracted. </li>
+ </ul>
+ </div>
+<p><span class="version">
+ Since: </span>
+ 3.0
+ </p>
+</dd>
+</dl>
+</div>
+</div>
+<div class="dictionary" id="DatePattern">
+<a class="backward-compatibility-anchor" name="::Globalization::DatePattern"></a><h3>1.7. DatePattern</h3>
+<div class="brief">
+ The DatePattern dictionary contains the information obtained in getDatePattern method.
+ </div>
+<pre class="webidl prettyprint"> dictionary DatePattern {
+ DOMString pattern;
+ DOMString timezone;
+ long utc_offset;
+ long dst_offset;
+ };</pre>
+<p><span class="version">
+ Since: </span>
+ 3.0
+ </p>
+<div class="attributes">
+<h4>Dictionary members</h4>
+<dl>
+<dt class="member" id="DatePattern::pattern"><span class="attrName">DOMString pattern</span></dt>
+<dd>
+<div class="brief">
+ The date and time pattern to format and parse dates.
+The patterns follow Unicode Technical Standard #35.
+ </div>
+<p><span class="version">
+ Since: </span>
+ 3.0
+ </p>
+</dd>
+<dt class="member" id="DatePattern::timezone"><span class="attrName">DOMString timezone</span></dt>
+<dd>
+<div class="brief">
+ The abbreviated name of the time zone on client's device.
+ </div>
+<p><span class="version">
+ Since: </span>
+ 3.0
+ </p>
+</dd>
+<dt class="member" id="DatePattern::utc_offset"><span class="attrName">long utc_offset</span></dt>
+<dd>
+<div class="brief">
+ The current difference in seconds between the client's time zone
+and coordinated universal time.
+ </div>
+<p><span class="version">
+ Since: </span>
+ 3.0
+ </p>
+</dd>
+<dt class="member" id="DatePattern::dst_offset"><span class="attrName">long dst_offset</span></dt>
+<dd>
+<div class="brief">
+ The current daylight saving time offset in seconds between the client's
+non-daylight saving time zone and the client's daylight saving time zone.
+ </div>
+<p><span class="version">
+ Since: </span>
+ 3.0
+ </p>
+</dd>
+</dl>
+</div>
+</div>
+<div class="dictionary" id="NumberPattern">
+<a class="backward-compatibility-anchor" name="::Globalization::NumberPattern"></a><h3>1.8. NumberPattern</h3>
+<div class="brief">
+ The NumberPattern dictionary contains the information obtained
+by calling the getNumberPattern method.
+ </div>
+<pre class="webidl prettyprint"> dictionary NumberPattern {
+ DOMString pattern;
+ DOMString symbol;
+ long fraction;
+ double rounding;
+ DOMString positive;
+ DOMString negative;
+ DOMString decimal;
+ DOMString grouping;
+ };</pre>
+<p><span class="version">
+ Since: </span>
+ 3.0
+ </p>
+<div class="attributes">
+<h4>Dictionary members</h4>
+<dl>
+<dt class="member" id="NumberPattern::pattern"><span class="attrName">DOMString pattern</span></dt>
+<dd>
+<div class="brief">
+ The number pattern to format and parse numbers.
+The patterns follow Unicode Technical Standard #35.
+ </div>
+<p><span class="version">
+ Since: </span>
+ 3.0
+ </p>
+</dd>
+<dt class="member" id="NumberPattern::symbol"><span class="attrName">DOMString symbol</span></dt>
+<dd>
+<div class="brief">
+ The symbol to use when formatting and parsing,
+such as percent or currency symbol.
+ </div>
+<p><span class="version">
+ Since: </span>
+ 3.0
+ </p>
+</dd>
+<dt class="member" id="NumberPattern::fraction"><span class="attrName">long fraction</span></dt>
+<dd>
+<div class="brief">
+ The number of fractional digits to use
+when parsing and formatting.
+ </div>
+<p><span class="version">
+ Since: </span>
+ 3.0
+ </p>
+</dd>
+<dt class="member" id="NumberPattern::rounding"><span class="attrName">double rounding</span></dt>
+<dd>
+<div class="brief">
+ The rounding increment to use when parsing and formatting.
+ </div>
+<p><span class="version">
+ Since: </span>
+ 3.0
+ </p>
+</dd>
+<dt class="member" id="NumberPattern::positive"><span class="attrName">DOMString positive</span></dt>
+<dd>
+<div class="brief">
+ The symbol to use for positive numbers
+when parsing and formatting.
+ </div>
+<p><span class="version">
+ Since: </span>
+ 3.0
+ </p>
+</dd>
+<dt class="member" id="NumberPattern::negative"><span class="attrName">DOMString negative</span></dt>
+<dd>
+<div class="brief">
+ The symbol to use for negative numbers
+when parsing and formatting.
+ </div>
+<p><span class="version">
+ Since: </span>
+ 3.0
+ </p>
+</dd>
+<dt class="member" id="NumberPattern::decimal"><span class="attrName">DOMString decimal</span></dt>
+<dd>
+<div class="brief">
+ The decimal symbol to use for parsing and formatting.
+ </div>
+<p><span class="version">
+ Since: </span>
+ 3.0
+ </p>
+</dd>
+<dt class="member" id="NumberPattern::grouping"><span class="attrName">DOMString grouping</span></dt>
+<dd>
+<div class="brief">
+ The grouping symbol to use for parsing and formatting.
+ </div>
+<p><span class="version">
+ Since: </span>
+ 3.0
+ </p>
+</dd>
+</dl>
+</div>
+</div>
+<div class="dictionary" id="GlobalizationDate">
+<a class="backward-compatibility-anchor" name="::Globalization::GlobalizationDate"></a><h3>1.9. GlobalizationDate</h3>
+<div class="brief">
+ the GlobalizationDate dictionary represents a point in time,
+similar to a Date object in javascript.
+ </div>
+<pre class="webidl prettyprint"> dictionary GlobalizationDate {
+ long year;
+ long month;
+ long day;
+ long hour;
+ long minute;
+ long second;
+ long millisecond;
+ };</pre>
+<p><span class="version">
+ Since: </span>
+ 3.0
+ </p>
+<div class="attributes">
+<h4>Dictionary members</h4>
+<dl>
+<dt class="member" id="GlobalizationDate::year"><span class="attrName">long year</span></dt>
+<dd>
+<div class="brief">
+ The four digit year.
+ </div>
+<p><span class="version">
+ Since: </span>
+ 3.0
+ </p>
+</dd>
+<dt class="member" id="GlobalizationDate::month"><span class="attrName">long month</span></dt>
+<dd>
+<div class="brief">
+ The month index in range (0, 11) inclusively.
+ </div>
+<p><span class="version">
+ Since: </span>
+ 3.0
+ </p>
+</dd>
+<dt class="member" id="GlobalizationDate::day"><span class="attrName">long day</span></dt>
+<dd>
+<div class="brief">
+ The day of month in range (1, 31) inclusively.
+ </div>
+<p><span class="version">
+ Since: </span>
+ 3.0
+ </p>
+</dd>
+<dt class="member" id="GlobalizationDate::hour"><span class="attrName">long hour</span></dt>
+<dd>
+<div class="brief">
+ The hour in range (0, 23) inclusively.
+ </div>
+<p><span class="version">
+ Since: </span>
+ 3.0
+ </p>
+</dd>
+<dt class="member" id="GlobalizationDate::minute"><span class="attrName">long minute</span></dt>
+<dd>
+<div class="brief">
+ The minute in range (0, 59) inclusively.
+ </div>
+<p><span class="version">
+ Since: </span>
+ 3.0
+ </p>
+</dd>
+<dt class="member" id="GlobalizationDate::second"><span class="attrName">long second</span></dt>
+<dd>
+<div class="brief">
+ The second in range (0, 59) inclusively.
+ </div>
+<p><span class="version">
+ Since: </span>
+ 3.0
+ </p>
+</dd>
+<dt class="member" id="GlobalizationDate::millisecond"><span class="attrName">long millisecond</span></dt>
+<dd>
+<div class="brief">
+ The milliseconds in range (0, 999) inclusively.
+ </div>
+<p><span class="version">
+ Since: </span>
+ 3.0
+ </p>
+</dd>
+</dl>
+</div>
+</div>
+<div class="interface" id="DSTSuccessCallback">
+<a class="backward-compatibility-anchor" name="::Globalization::DSTSuccessCallback"></a><h3>1.10. DSTSuccessCallback</h3>
+<div class="brief">
+ A callback method invoked on successful extraction
+of Daylight Saving Time data.
+ </div>
+<pre class="webidl prettyprint"> [Callback=FunctionOnly, NoInterfaceObject] interface DSTSuccessCallback {
+ void onsuccess(object properties);
+ };</pre>
+<p><span class="version">
+ Since: </span>
+ 3.0
+ </p>
+<div class="methods">
+<h4>Methods</h4>
+<dl>
+<dt class="method" id="DSTSuccessCallback::onsuccess">
+<a class="backward-compatibility-anchor" name="::Globalization::DSTSuccessCallback::onsuccess"></a><code><b><span class="methodName">onsuccess</span></b></code>
+</dt>
+<dd>
+<div class="brief">
+ Called when a function returns the DST data successfully.
+ </div>
+<div class="synopsis"><pre class="signature prettyprint">void onsuccess(object properties);
+ </pre></div>
+<p><span class="version">
+ Since: </span>
+ 3.0
+ </p>
+<div class="parameters">
+<p><span class="param">Parameters:</span></p>
+<ul>
+ <li class="param">
+<span class="name">properties</span>:
+ An object containing the field "dst" of boolean type.
+ </li>
+ </ul>
+</div>
+</dd>
+</dl>
+</div>
+</div>
+<div class="interface" id="StringSuccessCallback">
+<a class="backward-compatibility-anchor" name="::Globalization::StringSuccessCallback"></a><h3>1.11. StringSuccessCallback</h3>
+<div class="brief">
+ A callback method invoked on successful extraction of
+a data encoded as a DOMString.
+ </div>
+<pre class="webidl prettyprint"> [Callback=FunctionOnly, NoInterfaceObject] interface StringSuccessCallback {
+ void onsuccess(object properties);
+ };</pre>
+<p><span class="version">
+ Since: </span>
+ 3.0
+ </p>
+<div class="methods">
+<h4>Methods</h4>
+<dl>
+<dt class="method" id="StringSuccessCallback::onsuccess">
+<a class="backward-compatibility-anchor" name="::Globalization::StringSuccessCallback::onsuccess"></a><code><b><span class="methodName">onsuccess</span></b></code>
+</dt>
+<dd>
+<div class="brief">
+ Called when a function returns the properties object with data successfully.
+ </div>
+<div class="synopsis"><pre class="signature prettyprint">void onsuccess(object properties);
+ </pre></div>
+<p><span class="version">
+ Since: </span>
+ 3.0
+ </p>
+<div class="parameters">
+<p><span class="param">Parameters:</span></p>
+<ul>
+ <li class="param">
+<span class="name">properties</span>:
+ An object containing the field "value" of a DOMString type.
+ </li>
+ </ul>
+</div>
+</dd>
+</dl>
+</div>
+</div>
+<div class="interface" id="ArrayStringSuccessCallback">
+<a class="backward-compatibility-anchor" name="::Globalization::ArrayStringSuccessCallback"></a><h3>1.12. ArrayStringSuccessCallback</h3>
+<div class="brief">
+ The callback method invoked on successful extraction of
+the data represented as an array of DOMString values.
+ </div>
+<pre class="webidl prettyprint"> [Callback=FunctionOnly, NoInterfaceObject] interface ArrayStringSuccessCallback {
+ void onsuccess(object properties);
+ };</pre>
+<p><span class="version">
+ Since: </span>
+ 3.0
+ </p>
+<div class="methods">
+<h4>Methods</h4>
+<dl>
+<dt class="method" id="ArrayStringSuccessCallback::onsuccess">
+<a class="backward-compatibility-anchor" name="::Globalization::ArrayStringSuccessCallback::onsuccess"></a><code><b><span class="methodName">onsuccess</span></b></code>
+</dt>
+<dd>
+<div class="brief">
+ Called when a function returns the array of DOMString values succesfully.
+ </div>
+<div class="synopsis"><pre class="signature prettyprint">void onsuccess(object properties);
+ </pre></div>
+<p><span class="version">
+ Since: </span>
+ 3.0
+ </p>
+<div class="parameters">
+<p><span class="param">Parameters:</span></p>
+<ul>
+ <li class="param">
+<span class="name">properties</span>:
+ an object with the field "value"
+containing an Array of DOMString values.
+ </li>
+ </ul>
+</div>
+</dd>
+</dl>
+</div>
+</div>
+<div class="interface" id="LongSuccessCallback">
+<a class="backward-compatibility-anchor" name="::Globalization::LongSuccessCallback"></a><h3>1.13. LongSuccessCallback</h3>
+<div class="brief">
+ The callback method invoked on successful extraction
+of the data represented as a long integer value.
+ </div>
+<pre class="webidl prettyprint"> [Callback=FunctionOnly, NoInterfaceObject] interface LongSuccessCallback {
+ void onsuccess(object properties);
+ };</pre>
+<p><span class="version">
+ Since: </span>
+ 3.0
+ </p>
+<div class="methods">
+<h4>Methods</h4>
+<dl>
+<dt class="method" id="LongSuccessCallback::onsuccess">
+<a class="backward-compatibility-anchor" name="::Globalization::LongSuccessCallback::onsuccess"></a><code><b><span class="methodName">onsuccess</span></b></code>
+</dt>
+<dd>
+<div class="brief">
+ Called when a function returns a numeric (long) data successfully.
+ </div>
+<div class="synopsis"><pre class="signature prettyprint">void onsuccess(object properties);
+ </pre></div>
+<p><span class="version">
+ Since: </span>
+ 3.0
+ </p>
+<div class="parameters">
+<p><span class="param">Parameters:</span></p>
+<ul>
+ <li class="param">
+<span class="name">properties</span>:
+ An object containing the field "value" of a long type.
+ </li>
+ </ul>
+</div>
+</dd>
+</dl>
+</div>
+</div>
+<div class="interface" id="DoubleSuccessCallback">
+<a class="backward-compatibility-anchor" name="::Globalization::DoubleSuccessCallback"></a><h3>1.14. DoubleSuccessCallback</h3>
+<div class="brief">
+ The callback method invoked on successful extraction
+of the data represented as a double precision numeric value.
+ </div>
+<pre class="webidl prettyprint"> [Callback=FunctionOnly, NoInterfaceObject] interface DoubleSuccessCallback {
+ void onsuccess(object properties);
+ };</pre>
+<p><span class="version">
+ Since: </span>
+ 3.0
+ </p>
+<div class="methods">
+<h4>Methods</h4>
+<dl>
+<dt class="method" id="DoubleSuccessCallback::onsuccess">
+<a class="backward-compatibility-anchor" name="::Globalization::DoubleSuccessCallback::onsuccess"></a><code><b><span class="methodName">onsuccess</span></b></code>
+</dt>
+<dd>
+<div class="brief">
+ Called when a function returns a numeric (double) data successfully.
+ </div>
+<div class="synopsis"><pre class="signature prettyprint">void onsuccess(object properties);
+ </pre></div>
+<p><span class="version">
+ Since: </span>
+ 3.0
+ </p>
+<div class="parameters">
+<p><span class="param">Parameters:</span></p>
+<ul>
+ <li class="param">
+<span class="name">properties</span>:
+ An object containing the field "value" of a double type.
+ </li>
+ </ul>
+</div>
+</dd>
+</dl>
+</div>
+</div>
+<div class="interface" id="GlobalizationDateSuccessCallback">
+<a class="backward-compatibility-anchor" name="::Globalization::GlobalizationDateSuccessCallback"></a><h3>1.15. GlobalizationDateSuccessCallback</h3>
+<div class="brief">
+ The callback method invoked on successful extraction
+of the GlobalizationDate object.
+ </div>
+<pre class="webidl prettyprint"> [Callback=FunctionOnly, NoInterfaceObject] interface GlobalizationDateSuccessCallback {
+ void onsuccess(Date date);
+ };</pre>
+<p><span class="version">
+ Since: </span>
+ 3.0
+ </p>
+<div class="methods">
+<h4>Methods</h4>
+<dl>
+<dt class="method" id="GlobalizationDateSuccessCallback::onsuccess">
+<a class="backward-compatibility-anchor" name="::Globalization::GlobalizationDateSuccessCallback::onsuccess"></a><code><b><span class="methodName">onsuccess</span></b></code>
+</dt>
+<dd>
+<div class="brief">
+ Called when a function returns a GlobalizationDate object successfully.
+ </div>
+<div class="synopsis"><pre class="signature prettyprint">void onsuccess(Date date);
+ </pre></div>
+<p><span class="version">
+ Since: </span>
+ 3.0
+ </p>
+<div class="parameters">
+<p><span class="param">Parameters:</span></p>
+<ul>
+ <li class="param">
+<span class="name">date</span>:
+ a GlobalizationDate object containing the date information.
+ </li>
+ </ul>
+</div>
+</dd>
+</dl>
+</div>
+</div>
+<div class="interface" id="PatternSuccessCallback">
+<a class="backward-compatibility-anchor" name="::Globalization::PatternSuccessCallback"></a><h3>1.16. PatternSuccessCallback</h3>
+<div class="brief">
+ The callback method invoked on successful extraction
+of a CurrencyPattern object.
+ </div>
+<pre class="webidl prettyprint"> [Callback=FunctionOnly, NoInterfaceObject] interface PatternSuccessCallback {
+ void onsuccess(<a href="#CurrencyPattern">CurrencyPattern</a> pattern);
+ };</pre>
+<p><span class="version">
+ Since: </span>
+ 3.0
+ </p>
+<div class="methods">
+<h4>Methods</h4>
+<dl>
+<dt class="method" id="PatternSuccessCallback::onsuccess">
+<a class="backward-compatibility-anchor" name="::Globalization::PatternSuccessCallback::onsuccess"></a><code><b><span class="methodName">onsuccess</span></b></code>
+</dt>
+<dd>
+<div class="brief">
+ Called when a function returns the currency pattern information succesfully.
+ </div>
+<div class="synopsis"><pre class="signature prettyprint">void onsuccess(<a href="#CurrencyPattern">CurrencyPattern</a> pattern);
+ </pre></div>
+<p><span class="version">
+ Since: </span>
+ 3.0
+ </p>
+<div class="parameters">
+<p><span class="param">Parameters:</span></p>
+<ul>
+ <li class="param">
+<span class="name">pattern</span>:
+ a CurrencyPattern object containing retrieved information.
+ </li>
+ </ul>
+</div>
+</dd>
+</dl>
+</div>
+</div>
+<div class="interface" id="GetDatePatternSuccessCallback">
+<a class="backward-compatibility-anchor" name="::Globalization::GetDatePatternSuccessCallback"></a><h3>1.17. GetDatePatternSuccessCallback</h3>
+<div class="brief">
+ The callback method invoked on succesful extraction
+of a DatePattern object.
+ </div>
+<pre class="webidl prettyprint"> [Callback=FunctionOnly, NoInterfaceObject] interface GetDatePatternSuccessCallback {
+ void onsuccess(<a href="#DatePattern">DatePattern</a> pattern);
+ };</pre>
+<p><span class="version">
+ Since: </span>
+ 3.0
+ </p>
+<div class="methods">
+<h4>Methods</h4>
+<dl>
+<dt class="method" id="GetDatePatternSuccessCallback::onsuccess">
+<a class="backward-compatibility-anchor" name="::Globalization::GetDatePatternSuccessCallback::onsuccess"></a><code><b><span class="methodName">onsuccess</span></b></code>
+</dt>
+<dd>
+<div class="brief">
+ Called when a function returns the date pattern information successfully.
+ </div>
+<div class="synopsis"><pre class="signature prettyprint">void onsuccess(<a href="#DatePattern">DatePattern</a> pattern);
+ </pre></div>
+<p><span class="version">
+ Since: </span>
+ 3.0
+ </p>
+<div class="parameters">
+<p><span class="param">Parameters:</span></p>
+<ul>
+ <li class="param">
+<span class="name">pattern</span>:
+ a DatePattern object containing retrieved information.
+ </li>
+ </ul>
+</div>
+</dd>
+</dl>
+</div>
+</div>
+<div class="interface" id="GetNumberPatternSuccessCallback">
+<a class="backward-compatibility-anchor" name="::Globalization::GetNumberPatternSuccessCallback"></a><h3>1.18. GetNumberPatternSuccessCallback</h3>
+<div class="brief">
+ The callback method invoked on successful extraction
+of a NumberPattern object.
+ </div>
+<pre class="webidl prettyprint"> [Callback=FunctionOnly, NoInterfaceObject] interface GetNumberPatternSuccessCallback {
+ void onsuccess(<a href="#NumberPattern">NumberPattern</a> pattern);
+ };</pre>
+<p><span class="version">
+ Since: </span>
+ 3.0
+ </p>
+<div class="methods">
+<h4>Methods</h4>
+<dl>
+<dt class="method" id="GetNumberPatternSuccessCallback::onsuccess">
+<a class="backward-compatibility-anchor" name="::Globalization::GetNumberPatternSuccessCallback::onsuccess"></a><code><b><span class="methodName">onsuccess</span></b></code>
+</dt>
+<dd>
+<div class="brief">
+ Called when a function returns the number pattern information successfully.
+ </div>
+<div class="synopsis"><pre class="signature prettyprint">void onsuccess(<a href="#NumberPattern">NumberPattern</a> pattern);
+ </pre></div>
+<p><span class="version">
+ Since: </span>
+ 3.0
+ </p>
+<div class="parameters">
+<p><span class="param">Parameters:</span></p>
+<ul>
+ <li class="param">
+<span class="name">pattern</span>:
+ a NumberPattern object containing retrieved information.
+ </li>
+ </ul>
+</div>
+</dd>
+</dl>
+</div>
+</div>
+<div class="interface" id="GlobalizationError">
+<a class="backward-compatibility-anchor" name="::Globalization::GlobalizationError"></a><h3>1.19. GlobalizationError</h3>
+<pre class="webidl prettyprint"> interface GlobalizationError {
+ attribute long code;
+ attribute DOMString message;
+ const short UNKNOWN_ERROR = 0;
+ const short FORMATTING_ERROR = 1;
+ const short PARSING_ERROR = 2;
+ const short PATTERN_ERROR = 3;
+ };</pre>
+<p><span class="version">
+ Since: </span>
+ 3.0
+ </p>
+<div class="description">
+ <p>
+The GlobalizationError interface
+ </p>
+ </div>
+<div class="consts">
+<h4>Constants</h4>
+<dl>
+<li class="const" id="GlobalizationError::UNKNOWN_ERROR">
+<a class="backward-compatibility-anchor" name="::Globalization::GlobalizationError::UNKNOWN_ERROR"></a><span class="name">UNKNOWN_ERROR</span><div class="brief">
+ Unknown error
+ </div>
+<p><span class="version">
+ Since: </span>
+ 3.0
+ </p>
+<br><br>
+</li>
+<li class="const" id="GlobalizationError::FORMATTING_ERROR">
+<a class="backward-compatibility-anchor" name="::Globalization::GlobalizationError::FORMATTING_ERROR"></a><span class="name">FORMATTING_ERROR</span><div class="brief">
+ Formatting error
+ </div>
+<p><span class="version">
+ Since: </span>
+ 3.0
+ </p>
+<br><br>
+</li>
+<li class="const" id="GlobalizationError::PARSING_ERROR">
+<a class="backward-compatibility-anchor" name="::Globalization::GlobalizationError::PARSING_ERROR"></a><span class="name">PARSING_ERROR</span><div class="brief">
+ Parsing error
+ </div>
+<p><span class="version">
+ Since: </span>
+ 3.0
+ </p>
+<br><br>
+</li>
+<li class="const" id="GlobalizationError::PATTERN_ERROR">
+<a class="backward-compatibility-anchor" name="::Globalization::GlobalizationError::PATTERN_ERROR"></a><span class="name">PATTERN_ERROR</span><div class="brief">
+ Pattern error
+ </div>
+<p><span class="version">
+ Since: </span>
+ 3.0
+ </p>
+<br><br>
+</li>
+</dl>
+</div>
+<div class="attributes">
+<h4>Attributes</h4>
+<ul>
+<li class="attribute" id="GlobalizationError::code">
+<span class="attrName"><span class="type">long </span><span class="name">code</span></span><div class="brief">
+ One of the following codes representing the error type.
+ </div>
+<div class="description">
+ <ul>
+ <li>
+0: GlobalizationError.UNKNOWN_ERROR </li>
+ <li>
+1: GlobalizationError.FORMATTING_ERROR </li>
+ <li>
+2: GlobalizationError.PARSING_ERROR </li>
+ <li>
+3: GlobalizationError.PATTERN_ERROR </li>
+ </ul>
+ </div>
+<p><span class="version">
+ Since: </span>
+ 3.0
+ </p>
+</li>
+<li class="attribute" id="GlobalizationError::message">
+<span class="attrName"><span class="type">DOMString </span><span class="name">message</span></span><div class="brief">
+ A text message that includes the error's explaination and/or details.
+ </div>
+<p><span class="version">
+ Since: </span>
+ 3.0
+ </p>
+</li>
+</ul>
+</div>
+</div>
+</div>
+<h2 id="full-webidl">2. Full WebIDL</h2>
+<pre class="webidl prettyprint"> module Globalization {
+
+ [NoInterfaceObject] interface GlobalizationManagerObject {
+ readonly attribute <a href="#GlobalizationManager">GlobalizationManager</a> globalization;
+ };
+
+ implements <a href="#GlobalizationManagerObject">GlobalizationManagerObject</a>;
+
+ [NoInterfaceObject] interface GlobalizationManager {
+
+ void getPreferredLanguage(<a href="#StringSuccessCallback">StringSuccessCallback</a> onsuccess,
+ <a href="cordova.html#ErrorCallback">ErrorCallback</a><a href="file.html#ErrorCallback">ErrorCallback</a> onerror);
+
+ void getLocaleName(<a href="#StringSuccessCallback">StringSuccessCallback</a> onsuccess,
+ <a href="cordova.html#ErrorCallback">ErrorCallback</a><a href="file.html#ErrorCallback">ErrorCallback</a> onerror);
+
+ void dateToString(Date date, <a href="#StringSuccessCallback">StringSuccessCallback</a> onsuccess, <a href="cordova.html#ErrorCallback">ErrorCallback</a><a href="file.html#ErrorCallback">ErrorCallback</a> onerror,
+ optional <a href="#DateOptions">DateOptions</a> options);
+
+ void getCurrencyPattern(DOMString currencyCode,
+ <a href="#PatternSuccessCallback">PatternSuccessCallback</a> onsuccess,
+ <a href="cordova.html#ErrorCallback">ErrorCallback</a><a href="file.html#ErrorCallback">ErrorCallback</a> onerror);
+
+ void getDateNames(<a href="#ArrayStringSuccessCallback">ArrayStringSuccessCallback</a> onsuccess, <a href="cordova.html#ErrorCallback">ErrorCallback</a><a href="file.html#ErrorCallback">ErrorCallback</a> onerror,
+ optional <a href="#GetDateNamesOptions">GetDateNamesOptions</a> options);
+
+ void getDatePattern(<a href="#GetDatePatternSuccessCallback">GetDatePatternSuccessCallback</a> onsuccess, <a href="cordova.html#ErrorCallback">ErrorCallback</a><a href="file.html#ErrorCallback">ErrorCallback</a> onerror,
+ optional <a href="#DateOptions">DateOptions</a> options);
+
+ void getFirstDayOfWeek(<a href="#LongSuccessCallback">LongSuccessCallback</a> onsuccess,
+ <a href="cordova.html#ErrorCallback">ErrorCallback</a><a href="file.html#ErrorCallback">ErrorCallback</a> onerror);
+
+ void getNumberPattern(<a href="#GetNumberPatternSuccessCallback">GetNumberPatternSuccessCallback</a> onsuccess,
+ <a href="cordova.html#ErrorCallback">ErrorCallback</a><a href="file.html#ErrorCallback">ErrorCallback</a> onerror,
+ optional <a href="#NumberPatternOptions">NumberPatternOptions</a> options);
+
+ void isDayLightSavingsTime(Date date, <a href="#DSTSuccessCallback">DSTSuccessCallback</a> onsuccess,
+ <a href="cordova.html#ErrorCallback">ErrorCallback</a><a href="file.html#ErrorCallback">ErrorCallback</a> onerror);
+
+ void numberToString(double number, <a href="#StringSuccessCallback">StringSuccessCallback</a> onsuccess, <a href="cordova.html#ErrorCallback">ErrorCallback</a><a href="file.html#ErrorCallback">ErrorCallback</a> onerror,
+ optional <a href="#NumberPatternOptions">NumberPatternOptions</a> options);
+
+ void stringToDate(DOMString dateString, <a href="#GlobalizationDateSuccessCallback">GlobalizationDateSuccessCallback</a> onsuccess,
+ <a href="cordova.html#ErrorCallback">ErrorCallback</a><a href="file.html#ErrorCallback">ErrorCallback</a> onerror,
+ optional <a href="#DateOptions">DateOptions</a> options);
+ void stringToNumber(DOMString numberString, <a href="#DoubleSuccessCallback">DoubleSuccessCallback</a> onsuccess,
+ <a href="cordova.html#ErrorCallback">ErrorCallback</a><a href="file.html#ErrorCallback">ErrorCallback</a> onerror,
+ optional <a href="#NumberPatternOptions">NumberPatternOptions</a> options);
+ };
+
+ dictionary DateOptions {
+ DOMString formatLength;
+ DOMString selector;
+ };
+
+ dictionary CurrencyPattern {
+ DOMString pattern;
+ DOMString code;
+ long fraction;
+ double rounding;
+ DOMString decimal;
+ DOMString grouping;
+ };
+
+ dictionary GetDateNamesOptions {
+ DOMString type;
+ DOMString item;
+ };
+
+ dictionary NumberPatternOptions {
+ DOMString type;
+ };
+
+ dictionary DatePattern {
+ DOMString pattern;
+ DOMString timezone;
+ long utc_offset;
+ long dst_offset;
+ };
+
+ dictionary NumberPattern {
+ DOMString pattern;
+ DOMString symbol;
+ long fraction;
+ double rounding;
+ DOMString positive;
+ DOMString negative;
+ DOMString decimal;
+ DOMString grouping;
+ };
+
+ dictionary GlobalizationDate {
+ long year;
+ long month;
+ long day;
+ long hour;
+ long minute;
+ long second;
+ long millisecond;
+ };
+
+
+ [Callback=FunctionOnly, NoInterfaceObject] interface DSTSuccessCallback {
+ void onsuccess(object properties);
+ };
+
+ [Callback=FunctionOnly, NoInterfaceObject] interface StringSuccessCallback {
+ void onsuccess(object properties);
+ };
+
+ [Callback=FunctionOnly, NoInterfaceObject] interface ArrayStringSuccessCallback {
+ void onsuccess(object properties);
+ };
+
+ [Callback=FunctionOnly, NoInterfaceObject] interface LongSuccessCallback {
+ void onsuccess(object properties);
+ };
+
+ [Callback=FunctionOnly, NoInterfaceObject] interface DoubleSuccessCallback {
+ void onsuccess(object properties);
+ };
+
+ [Callback=FunctionOnly, NoInterfaceObject] interface GlobalizationDateSuccessCallback {
+ void onsuccess(Date date);
+ };
+
+ [Callback=FunctionOnly, NoInterfaceObject] interface PatternSuccessCallback {
+ void onsuccess(<a href="#CurrencyPattern">CurrencyPattern</a> pattern);
+ };
+
+ [Callback=FunctionOnly, NoInterfaceObject] interface GetDatePatternSuccessCallback {
+ void onsuccess(<a href="#DatePattern">DatePattern</a> pattern);
+ };
+
+ [Callback=FunctionOnly, NoInterfaceObject] interface GetNumberPatternSuccessCallback {
+ void onsuccess(<a href="#NumberPattern">NumberPattern</a> pattern);
+ };
+
+ interface GlobalizationError {
+ attribute long code;
+ attribute DOMString message;
+ const short UNKNOWN_ERROR = 0;
+ const short FORMATTING_ERROR = 1;
+ const short PARSING_ERROR = 2;
+ const short PATTERN_ERROR = 3;
+ };
+};</pre>
+</div>
+<div id="page-footer">
+<div class="copyright" align="center">
+ Except as noted, this content - excluding the Code Examples - is licensed under <a href="http://creativecommons.org/licenses/by/3.0/legalcode" target="_blank">Creative Commons Attribution 3.0</a> and all of the Code Examples contained herein are licensed under <a href="https://www.tizen.org/bsd-3-clause-license" target="_blank">BSD-3-Clause</a>. <br>For details, see the <a href="https://www.tizen.org/content-license" target="_blank">Content License</a>.
+ </div>
+<script type="text/javascript">
+
+ var _gaq = _gaq || [];
+ _gaq.push(['_setAccount', 'UA-25976949-1']);
+ _gaq.push(['_setDomainName', 'tizen.org']);
+ _gaq.push(['_trackPageview']);
+
+ (function() {
+ var ga = document.createElement('script'); ga.type = 'text/javascript'; ga.async = true;
+ var s = document.getElementsByTagName('script')[0]; s.parentNode.insertBefore(ga, s);
+ })();
+
+ </script>
+</div>
+</body>
+</html>
--- /dev/null
+<!DOCTYPE html PUBLIC "html">
+<html>
+<head>
+<meta http-equiv="Content-Type" content="text/html; charset=utf-8">
+<link rel="stylesheet" type="text/css" href="../tizen.css" media="screen">
+<script type="text/javascript" src="snippet.js"></script><title>Media API</title>
+</head>
+<body id="page-content" onload="prettyPrint()">
+<div class="api" id="::Media">
+
+<div class="title"><h1>Media API</h1></div>
+<div class="brief">
+ This plugin provides the ability to record and play back audio files on a device.
+ </div>
+<div class="description">
+ <p>
+This plugin defines a global Media Constructor.
+ </p>
+ <p>
+Original documentation: <a href="https://www.npmjs.com/package/cordova-plugin-media">Cordova Media</a>.
+ </p>
+ </div>
+<h2>Table of Contents</h2>
+<ul class="toc">
+<li>1. <a href="#interfaces-section">Interfaces</a><ul class="toc">
+<li>1.1. <a href="#Media">Media</a>
+</li>
+<li>1.2. <a href="#MediaError">MediaError</a>
+</li>
+<li>1.3. <a href="#MediaErrorCallback">MediaErrorCallback</a>
+</li>
+<li>1.4. <a href="#StatusChangeCallback">StatusChangeCallback</a>
+</li>
+<li>1.5. <a href="#PositionSuccessCallback">PositionSuccessCallback</a>
+</li>
+</ul>
+</li>
+<li>2. <a href="#api-features">Related Feature</a>
+</li>
+<li>3. <a href="#full-webidl">Full WebIDL</a>
+</li>
+</ul>
+<hr>
+<h2 id="method-summary">Summary of Interfaces and Methods</h2>
+<table class="informaltable">
+<thead><tr>
+<th>Interface</th>
+<th>Method</th>
+</tr></thead>
+<tbody>
+<tr>
+<td><a href="#Media">Media</a></td>
+<td>
+<div>void <a href="#Media::getCurrentPosition">getCurrentPosition</a> (<a href="#PositionSuccessCallback">PositionSuccessCallback</a> positionSuccessCallback, optional <a href="#MediaErrorCallback">MediaErrorCallback</a> errorCallback)</div>
+<div>double <a href="#Media::getDuration">getDuration</a> ()</div>
+<div>void <a href="#Media::pause">pause</a> ()</div>
+<div>void <a href="#Media::play">play</a> ()</div>
+<div>void <a href="#Media::release">release</a> ()</div>
+<div>void <a href="#Media::seekTo">seekTo</a> (double position)</div>
+<div>void <a href="#Media::setVolume">setVolume</a> (double volume)</div>
+<div>void <a href="#Media::startRecord">startRecord</a> ()</div>
+<div>void <a href="#Media::stopRecord">stopRecord</a> ()</div>
+<div>void <a href="#Media::stop">stop</a> ()</div>
+</td>
+</tr>
+<tr>
+<td><a href="#MediaError">MediaError</a></td>
+<td></td>
+</tr>
+<tr>
+<td><a href="#MediaErrorCallback">MediaErrorCallback</a></td>
+<td><div>void <a href="#MediaErrorCallback::onerror">onerror</a> (<a href="#MediaError">MediaError</a> error)</div></td>
+</tr>
+<tr>
+<td><a href="#StatusChangeCallback">StatusChangeCallback</a></td>
+<td><div>void <a href="#StatusChangeCallback::onchanged">onchanged</a> (short status)</div></td>
+</tr>
+<tr>
+<td><a href="#PositionSuccessCallback">PositionSuccessCallback</a></td>
+<td><div>void <a href="#PositionSuccessCallback::onsuccess">onsuccess</a> (double position)</div></td>
+</tr>
+</tbody>
+</table>
+<div class="interfaces" id="interfaces-section">
+<h2>1. Interfaces</h2>
+<div class="interface" id="Media">
+<a class="backward-compatibility-anchor" name="::Media::Media"></a><h3>1.1. Media</h3>
+<div class="brief">
+ The Media interface provides the audio object.
+ </div>
+<pre class="webidl prettyprint"> [Constructor(DOMString src, optional <a href="cordova.html#SuccessCallback">SuccessCallback</a>? successCallback, optional <a href="#MediaErrorCallback">MediaErrorCallback</a>? errorCallback, optional <a href="#StatusChangeCallback">StatusChangeCallback</a>? mediaStatus)]
+ interface Media {
+ const short MEDIA_NONE = 0;
+ const short MEDIA_STARTING = 1;
+ const short MEDIA_RUNNING = 2;
+ const short MEDIA_PAUSED = 3;
+ const short MEDIA_STOPPED = 4;
+
+ attribute DOMString src;
+
+ attribute <a href="cordova.html#SuccessCallback">SuccessCallback</a>? successCallback;
+
+ attribute <a href="#MediaErrorCallback">MediaErrorCallback</a>? errorCallback;
+
+ attribute <a href="#StatusChangeCallback">StatusChangeCallback</a>? statusCallback;
+
+ void getCurrentPosition(<a href="#PositionSuccessCallback">PositionSuccessCallback</a> positionSuccessCallback, optional <a href="#MediaErrorCallback">MediaErrorCallback</a> errorCallback);
+
+ double getDuration();
+
+ void pause();
+
+ void play();
+
+ void release();
+
+ void seekTo(double position);
+
+ void setVolume(double volume);
+
+ void startRecord();
+
+ void stopRecord();
+
+ void stop();
+ };</pre>
+<div class="example">
+<span class="example"><p>Code example:</p></span><pre name="code" class="examplecode prettyprint"> var myMedia = new Media(src, successCallback, errorCallback, statusCallback);
+ </pre>
+</div>
+<div class="constructors">
+<h4 id="Media::constructor">Constructors</h4>
+<dl>
+<div class="brief">
+ The Media interface provides interface and functions to manage audio objects.
+ </div>
+<pre class="webidl prettyprint">Media(DOMString src, optional <a href="cordova.html#SuccessCallback">SuccessCallback</a>? successCallback, optional <a href="#MediaErrorCallback">MediaErrorCallback</a>? errorCallback, optional <a href="#StatusChangeCallback">StatusChangeCallback</a>? mediaStatus);</pre>
+<div class="description">
+ <ul>
+ <li>
+<b>TypeError</b> <ul>
+ <li>
+ <p>
+ Is thrown if any of the input parameters has incorrect type. </p>
+ </li>
+ </ul>
+ </li>
+ </ul>
+ </div>
+</dl>
+</div>
+<div class="consts">
+<h4>Constants</h4>
+<dl>
+<li class="const" id="Media::MEDIA_NONE">
+<a class="backward-compatibility-anchor" name="::Media::Media::MEDIA_NONE"></a><span class="name">MEDIA_NONE</span><br><br>
+</li>
+<li class="const" id="Media::MEDIA_STARTING">
+<a class="backward-compatibility-anchor" name="::Media::Media::MEDIA_STARTING"></a><span class="name">MEDIA_STARTING</span><br><br>
+</li>
+<li class="const" id="Media::MEDIA_RUNNING">
+<a class="backward-compatibility-anchor" name="::Media::Media::MEDIA_RUNNING"></a><span class="name">MEDIA_RUNNING</span><br><br>
+</li>
+<li class="const" id="Media::MEDIA_PAUSED">
+<a class="backward-compatibility-anchor" name="::Media::Media::MEDIA_PAUSED"></a><span class="name">MEDIA_PAUSED</span><br><br>
+</li>
+<li class="const" id="Media::MEDIA_STOPPED">
+<a class="backward-compatibility-anchor" name="::Media::Media::MEDIA_STOPPED"></a><span class="name">MEDIA_STOPPED</span><div class="brief">
+ Above constants are reported as the only parameter to the mediaStatus callback.
+ </div>
+<p><span class="version">
+ Since: </span>
+ 3.0
+ </p>
+<br><br>
+</li>
+</dl>
+</div>
+<div class="attributes">
+<h4>Attributes</h4>
+<ul>
+<li class="attribute" id="Media::src">
+<span class="attrName"><span class="type">DOMString </span><span class="name">src</span></span><div class="brief">
+ A URI containing the audio content.
+ </div>
+<p><span class="version">
+ Since: </span>
+ 3.0
+ </p>
+</li>
+<li class="attribute" id="Media::successCallback">
+<span class="attrName"><span class="type">SuccessCallback </span><span class="name">successCallback</span><span class="optional"> [nullable]</span></span><div class="brief">
+ The callback that executes after a Media object has completed the current play, record, or stop action.
+ </div>
+<p><span class="version">
+ Since: </span>
+ 3.0
+ </p>
+</li>
+<li class="attribute" id="Media::errorCallback">
+<span class="attrName"><span class="type">MediaErrorCallback </span><span class="name">errorCallback</span><span class="optional"> [nullable]</span></span><div class="brief">
+ The callback that executes if an error occurs.
+ </div>
+<p><span class="version">
+ Since: </span>
+ 3.0
+ </p>
+</li>
+<li class="attribute" id="Media::statusCallback">
+<span class="attrName"><span class="type">StatusChangeCallback </span><span class="name">statusCallback</span><span class="optional"> [nullable]</span></span><div class="brief">
+ The callback that executes to indicate status changes.
+ </div>
+<p><span class="version">
+ Since: </span>
+ 3.0
+ </p>
+</li>
+</ul>
+</div>
+<div class="methods">
+<h4>Methods</h4>
+<dl>
+<dt class="method" id="Media::getCurrentPosition">
+<a class="backward-compatibility-anchor" name="::Media::Media::getCurrentPosition"></a><code><b><span class="methodName">getCurrentPosition</span></b></code>
+</dt>
+<dd>
+<div class="brief">
+ Returns the current position within an audio file in seconds.
+ </div>
+<div class="synopsis"><pre class="signature prettyprint">void getCurrentPosition(<a href="#PositionSuccessCallback">PositionSuccessCallback</a> positionSuccessCallback, optional <a href="#MediaErrorCallback">MediaErrorCallback</a> errorCallback);
+ </pre></div>
+<p><span class="version">
+ Since: </span>
+ 3.0
+ </p>
+<div class="parameters">
+<p><span class="param">Parameters:</span></p>
+<ul>
+ <li class="param">
+<span class="name">positionSuccessCallback</span>:
+ The callback that is passed the current position in seconds.
+ </li>
+ <li class="param">
+<span class="name">errorCallback</span><span class="optional"> [optional]</span>:
+ The callback to execute if an error occurs.
+ </li>
+ </ul>
+</div>
+<div class="example">
+<span class="example"><p>Code example:</p></span><pre name="code" class="examplecode prettyprint"> successCallback = function() {
+ console.log('Audio file has been played back.');
+ }
+
+ errorCallback = function(err) {
+ console.log('Error occurred ' + err.message);
+ }
+
+ positionSuccessCallback = function(position) {
+ console.log('Current position is ' + position);
+ }
+
+ var src = 'file:///home/app/content/Documents/play.mp3';
+ var myMedia = new Media(src, successCallback, errorCallback);
+
+ myMedia.play();
+
+ setTimeout(function() {
+ myMedia.getCurrentPosition(positionSuccessCallback);
+ }, 2000);
+
+ </pre>
+</div>
+<div class="output">
+<span class="title"><p>Output example:</p></span><pre>Audio file has been played back.
+Current position is 2.000
+</pre>
+</div>
+</dd>
+<dt class="method" id="Media::getDuration">
+<a class="backward-compatibility-anchor" name="::Media::Media::getDuration"></a><code><b><span class="methodName">getDuration</span></b></code>
+</dt>
+<dd>
+<div class="brief">
+ Returns the duration of an audio file in seconds. If the duration is unknown, it returns a value of -1.
+ </div>
+<div class="synopsis"><pre class="signature prettyprint">double getDuration();
+ </pre></div>
+<p><span class="version">
+ Since: </span>
+ 3.0
+ </p>
+<div class="example">
+<span class="example"><p>Code example:</p></span><pre name="code" class="examplecode prettyprint"> successCallback = function() {
+ console.log('Audio file has been played back.);
+ }
+
+ errorCallback = function(err) {
+ console.log('Error occurred ' + err.message);
+ }
+
+ var src = 'file:///home/app/content/Documents/play.mp3';
+ var myMedia = new Media(src, successCallback, errorCallback);
+
+ var duration = myMedia.getDuration();
+ console.log('Audio duration is ' + duration);
+ </pre>
+</div>
+<div class="output">
+<span class="title"><p>Output example:</p></span><pre>Audio duration is 281.035
+</pre>
+</div>
+</dd>
+<dt class="method" id="Media::pause">
+<a class="backward-compatibility-anchor" name="::Media::Media::pause"></a><code><b><span class="methodName">pause</span></b></code>
+</dt>
+<dd>
+<div class="brief">
+ Pauses playing an audio file.
+ </div>
+<div class="synopsis"><pre class="signature prettyprint">void pause();
+ </pre></div>
+<p><span class="version">
+ Since: </span>
+ 3.0
+ </p>
+<div class="example">
+<span class="example"><p>Code example:</p></span><pre name="code" class="examplecode prettyprint"> successCallback = function() {
+ console.log('Audio file has been played back.');
+ }
+
+ errorCallback = function(err) {
+ console.log('Error occurred ' + err.message);
+ }
+
+ statusCallback = function(status) {
+ if (status == Media.MEDIA_PAUSED) {
+ console.log('Audio file has been paused');
+ }
+ }
+
+ var src = 'file:///home/app/content/Documents/play.mp3';
+ var myMedia = new Media(src, successCallback, errorCallback, statusCallback);
+
+ myMedia.play();
+
+ //Pause after 2 seconds
+ setTimeout(function() {
+ myMedia.pause();
+ }, 2000);
+
+ </pre>
+</div>
+<div class="output">
+<span class="title"><p>Output example:</p></span><pre>Audio file has been paused.
+</pre>
+</div>
+</dd>
+<dt class="method" id="Media::play">
+<a class="backward-compatibility-anchor" name="::Media::Media::play"></a><code><b><span class="methodName">play</span></b></code>
+</dt>
+<dd>
+<div class="brief">
+ Starts or resumes playing an audio file.
+ </div>
+<div class="synopsis"><pre class="signature prettyprint">void play();
+ </pre></div>
+<p><span class="version">
+ Since: </span>
+ 3.0
+ </p>
+<div class="example">
+<span class="example"><p>Code example:</p></span><pre name="code" class="examplecode prettyprint"> successCallback = function() {
+ console.log('Audio file has been played back.');
+ }
+
+ errorCallback = function(err) {
+ console.log('Error occurred ' + err.message);
+ }
+
+ var src = 'file:///home/app/content/Documents/play.mp3';
+ var myMedia = new Media(src, successCallback, errorCallback);
+
+ myMedia.play();
+ </pre>
+</div>
+<div class="output">
+<span class="title"><p>Output example:</p></span><pre>Audio file has been played back.
+</pre>
+</div>
+</dd>
+<dt class="method" id="Media::release">
+<a class="backward-compatibility-anchor" name="::Media::Media::release"></a><code><b><span class="methodName">release</span></b></code>
+</dt>
+<dd>
+<div class="brief">
+ Releases the underlying operating system's audio resources.
+Applications should call the release function for any Media resource that is no longer needed.
+ </div>
+<div class="synopsis"><pre class="signature prettyprint">void release();
+ </pre></div>
+<p><span class="version">
+ Since: </span>
+ 3.0
+ </p>
+<div class="example">
+<span class="example"><p>Code example:</p></span><pre name="code" class="examplecode prettyprint"> successCallback = function() {
+ console.log('Audio file has been stopped or released.');
+ }
+
+ errorCallback = function(err) {
+ console.log('An error occurred: ' + err.message);
+ }
+
+ var src = 'file://home/app/content/Documents/play.mp3';
+ var myMedia = new Media(src, successCallback, errorCallback);
+
+ myMedia.play();
+ myMedia.stop();
+ myMedia.release();
+ </pre>
+</div>
+<div class="output">
+<span class="title"><p>Output example:</p></span><pre>Audio file has been stopped or released.
+Audio file has been stopped or released.
+</pre>
+</div>
+</dd>
+<dt class="method" id="Media::seekTo">
+<a class="backward-compatibility-anchor" name="::Media::Media::seekTo"></a><code><b><span class="methodName">seekTo</span></b></code>
+</dt>
+<dd>
+<div class="brief">
+ Sets the current position within an audio file.
+ </div>
+<div class="synopsis"><pre class="signature prettyprint">void seekTo(double position);
+ </pre></div>
+<p><span class="version">
+ Since: </span>
+ 3.0
+ </p>
+<div class="parameters">
+<p><span class="param">Parameters:</span></p>
+<ul>
+ <li class="param">
+<span class="name">position</span>:
+ The position to set the playback position within the audio, in milliseconds.
+ </li>
+ </ul>
+</div>
+<div class="example">
+<span class="example"><p>Code example:</p></span><pre name="code" class="examplecode prettyprint"> successCallback = function() {
+ console.log('Audio file has been played back.');
+ }
+
+ errorCallback = function(err) {
+ console.log('An error occurred: ' + err.message);
+ }
+
+ var src = 'file://home/app/content/Documents/play.mp3';
+ var myMedia = new Media(src, successCallback, errorCallback);
+
+ myMedia.play();
+
+ //SeekTo to 10 seconds after 5 seconds
+ setTimeout(function() {
+ myMedia.seekTo(10000);
+ console.log('Playback position has been set to 10 seconds.');
+ }, 5000);
+ </pre>
+</div>
+<div class="output">
+<span class="title"><p>Output example:</p></span><pre>Playback position has been set to 10 seconds.
+Audio file has been played back.
+</pre>
+</div>
+</dd>
+<dt class="method" id="Media::setVolume">
+<a class="backward-compatibility-anchor" name="::Media::Media::setVolume"></a><code><b><span class="methodName">setVolume</span></b></code>
+</dt>
+<dd>
+<div class="brief">
+ Set the volume for an audio file.
+ </div>
+<div class="synopsis"><pre class="signature prettyprint">void setVolume(double volume);
+ </pre></div>
+<p><span class="version">
+ Since: </span>
+ 3.0
+ </p>
+<p><span class="privilegelevel">
+ Privilege level: </span>
+ public
+ </p>
+<p><span class="privilege">
+ Privilege: </span>
+ http://tizen.org/privilege/volume.set
+ </p>
+<div class="parameters">
+<p><span class="param">Parameters:</span></p>
+<ul>
+ <li class="param">
+<span class="name">volume</span>:
+ The volume to set for playback. The value must be within the range of 0.0 to 1.0.
+ </li>
+ </ul>
+</div>
+<div class="example">
+<span class="example"><p>Code example:</p></span><pre name="code" class="examplecode prettyprint"> successCallback = function() {
+ console.log('Audio file has been played back.');
+ }
+
+ errorCallback = function(err) {
+ console.log('Error occurred ' + err.message);
+ }
+
+ var src = 'file://home/app/content/Documents/play.mp3';
+ var myMedia = new Media(src, successCallback, errorCallback);
+
+ myMedia.play();
+
+ // Mute volume after 2 seconds
+ setTimeout(function() {
+ myMedia.setVolume(0.0);
+ console.log('Playback volume has been muted.');
+ }, 2000);
+
+ // Set volume to 1.0 after 5 seconds
+ setTimeout(function() {
+ myMedia.setVolume(1.0);
+ console.log('Playback volume has been set to 1.0.');
+ }, 5000);
+ </pre>
+</div>
+<div class="output">
+<span class="title"><p>Output example:</p></span><pre>Playback volume has been muted.
+Playback volume has been set to 1.0.
+Audio file has been played back.
+</pre>
+</div>
+</dd>
+<dt class="method" id="Media::startRecord">
+<a class="backward-compatibility-anchor" name="::Media::Media::startRecord"></a><code><b><span class="methodName">startRecord</span></b></code>
+</dt>
+<dd>
+<div class="brief">
+ Starts recording an audio file.
+ </div>
+<div class="synopsis"><pre class="signature prettyprint">void startRecord();
+ </pre></div>
+<p><span class="version">
+ Since: </span>
+ 3.0
+ </p>
+<p><span class="privilegelevel">
+ Privilege level: </span>
+ public
+ </p>
+<p><span class="privilege">
+ Privilege: </span>
+ http://tizen.org/privilege/mediacapture
+ </p>
+<div class="example">
+<span class="example"><p>Code example:</p></span><pre name="code" class="examplecode prettyprint"> successCallback = function() {
+ console.log('Started recording an audio file.');
+ }
+
+ errorCallback = function(err) {
+ console.log('Error occurred ' + err.message);
+ }
+
+ var src = 'recordAudio.mp3';
+ var myRecMedia = new Media(src, successCallback, errorCallback);
+
+ myRecMedia.startRecord();
+ </pre>
+</div>
+<div class="output">
+<span class="title"><p>Output example:</p></span><pre>Started recording an audio file.
+</pre>
+</div>
+</dd>
+<dt class="method" id="Media::stopRecord">
+<a class="backward-compatibility-anchor" name="::Media::Media::stopRecord"></a><code><b><span class="methodName">stopRecord</span></b></code>
+</dt>
+<dd>
+<div class="brief">
+ Stops recording an audio file.
+ </div>
+<div class="synopsis"><pre class="signature prettyprint">void stopRecord();
+ </pre></div>
+<p><span class="version">
+ Since: </span>
+ 3.0
+ </p>
+<p><span class="privilegelevel">
+ Privilege level: </span>
+ public
+ </p>
+<p><span class="privilege">
+ Privilege: </span>
+ http://tizen.org/privilege/mediacapture
+ </p>
+<div class="example">
+<span class="example"><p>Code example:</p></span><pre name="code" class="examplecode prettyprint"> successCallback = function() {
+ console.log('Started recording an audio file.');
+ }
+
+ errorCallback = function(err) {
+ console.log('Error occurred ' + err.message);
+ }
+
+ var src = 'recordAudio.mp3';
+ var myRecMedia = new Media(src, successCallback, errorCallback);
+
+ myRecMedia.startRecord();
+
+ // Stop recording after 10 seconds
+ setTimeout(function() {
+ myRecMedia.stopRecord();
+ console.log('Stopped recording an audio file.');
+ }, 10000);
+ </pre>
+</div>
+<div class="output">
+<span class="title"><p>Output example:</p></span><pre>Started recording an audio file.
+Stopped recording an audio file.
+</pre>
+</div>
+</dd>
+<dt class="method" id="Media::stop">
+<a class="backward-compatibility-anchor" name="::Media::Media::stop"></a><code><b><span class="methodName">stop</span></b></code>
+</dt>
+<dd>
+<div class="brief">
+ Stops playing an audio file.
+ </div>
+<div class="synopsis"><pre class="signature prettyprint">void stop();
+ </pre></div>
+<p><span class="version">
+ Since: </span>
+ 3.0
+ </p>
+<div class="example">
+<span class="example"><p>Code example:</p></span><pre name="code" class="examplecode prettyprint"> successCallback = function() {
+ console.log('Audio file has been stopped.');
+ }
+
+ errorCallback = function(err) {
+ console.log('Error occurred ' + err.message);
+ }
+
+ var src = 'file://home/app/content/Documents/play.mp3';
+ var myMedia = new Media(src, successCallback, errorCallback);
+
+ myMedia.play();
+
+ // Stop after 10 seconds
+ setTimeout(function() {
+ myMedia.stop();
+ }, 10000);
+ </pre>
+</div>
+<div class="output">
+<span class="title"><p>Output example:</p></span><pre>Audio playback has been stopped.
+</pre>
+</div>
+</dd>
+</dl>
+</div>
+</div>
+<div class="interface" id="MediaError">
+<a class="backward-compatibility-anchor" name="::Media::MediaError"></a><h3>1.2. MediaError</h3>
+<div class="brief">
+ A <em>MediaError</em> object is returned to the <a href="media.html#MediaErrorCallback">MediaErrorCallback</a> function when an error occurs.
+ </div>
+<pre class="webidl prettyprint"> interface MediaError {
+ const short MEDIA_ERR_ABORTED = 1;
+ const short MEDIA_ERR_NETWORK = 2;
+ const short MEDIA_ERR_DECODE = 3;
+ const short MEDIA_ERR_NONE_SUPPORTED = 4;
+
+ readonly attribute short code;
+ };</pre>
+<div class="attributes">
+<h4>Attributes</h4>
+<ul><li class="attribute" id="MediaError::code">
+<span class="attrName"><span class="readonly"> readonly
+</span><span class="type">short </span><span class="name">code</span></span><div class="brief">
+ One of the predefined error codes listed above.
+ </div>
+<p><span class="version">
+ Since: </span>
+ 3.0
+ </p>
+</li></ul>
+</div>
+</div>
+<div class="interface" id="MediaErrorCallback">
+<a class="backward-compatibility-anchor" name="::Media::MediaErrorCallback"></a><h3>1.3. MediaErrorCallback</h3>
+<div class="brief">
+ Basic error callback.
+ </div>
+<pre class="webidl prettyprint"> [Callback=FunctionOnly,NoInterfaceObject] interface MediaErrorCallback {
+ void onerror(<a href="#MediaError">MediaError</a> error);
+ };</pre>
+<div class="methods">
+<h4>Methods</h4>
+<dl>
+<dt class="method" id="MediaErrorCallback::onerror">
+<a class="backward-compatibility-anchor" name="::Media::MediaErrorCallback::onerror"></a><code><b><span class="methodName">onerror</span></b></code>
+</dt>
+<dd>
+<div class="brief">
+ Success
+ </div>
+<div class="synopsis"><pre class="signature prettyprint">void onerror(<a href="#MediaError">MediaError</a> error);
+ </pre></div>
+<p><span class="version">
+ Since: </span>
+ 3.0
+ </p>
+<div class="parameters">
+<p><span class="param">Parameters:</span></p>
+<ul>
+ <li class="param">
+<span class="name">error</span>:
+ Error object containing some information about the error.
+ </li>
+ </ul>
+</div>
+</dd>
+</dl>
+</div>
+</div>
+<div class="interface" id="StatusChangeCallback">
+<a class="backward-compatibility-anchor" name="::Media::StatusChangeCallback"></a><h3>1.4. StatusChangeCallback</h3>
+<div class="brief">
+ The callback function used to return status of the Media object.
+ </div>
+<pre class="webidl prettyprint"> [Callback=FunctionOnly, NoInterfaceObject] interface StatusChangeCallback {
+ void onchanged(short status);
+ };</pre>
+<div class="methods">
+<h4>Methods</h4>
+<dl>
+<dt class="method" id="StatusChangeCallback::onchanged">
+<a class="backward-compatibility-anchor" name="::Media::StatusChangeCallback::onchanged"></a><code><b><span class="methodName">onchanged</span></b></code>
+</dt>
+<dd>
+<div class="brief">
+ Called when the status of the <em>Media</em> object has been changed.
+ </div>
+<div class="synopsis"><pre class="signature prettyprint">void onchanged(short status);
+ </pre></div>
+<p><span class="version">
+ Since: </span>
+ 3.0
+ </p>
+<div class="parameters">
+<p><span class="param">Parameters:</span></p>
+<ul>
+ <li class="param">
+<span class="name">status</span>:
+ The status of the <a href="media.html#Media">Media</a> object. It is equal to one of the Media interface constant: MEDIA_NONE, MEDIA_STARTING, MEDIA_RUNNING, MEDIA_PAUSED or MEDIA_STOPPED.
+ </li>
+ </ul>
+</div>
+</dd>
+</dl>
+</div>
+</div>
+<div class="interface" id="PositionSuccessCallback">
+<a class="backward-compatibility-anchor" name="::Media::PositionSuccessCallback"></a><h3>1.5. PositionSuccessCallback</h3>
+<div class="brief">
+ The callback function used to return current position of the Media object.
+ </div>
+<pre class="webidl prettyprint"> [Callback=FunctionOnly, NoInterfaceObject] interface PositionSuccessCallback {
+ void onsuccess(double position);
+ };</pre>
+<div class="methods">
+<h4>Methods</h4>
+<dl>
+<dt class="method" id="PositionSuccessCallback::onsuccess">
+<a class="backward-compatibility-anchor" name="::Media::PositionSuccessCallback::onsuccess"></a><code><b><span class="methodName">onsuccess</span></b></code>
+</dt>
+<dd>
+<div class="brief">
+ Called when getting current position of the media file is retrieved successfully.
+ </div>
+<div class="synopsis"><pre class="signature prettyprint">void onsuccess(double position);
+ </pre></div>
+<p><span class="version">
+ Since: </span>
+ 3.0
+ </p>
+<div class="parameters">
+<p><span class="param">Parameters:</span></p>
+<ul>
+ <li class="param">
+<span class="name">position</span>:
+ The current position of the media file.
+ </li>
+ </ul>
+</div>
+</dd>
+</dl>
+</div>
+</div>
+</div>
+<h2 id="api-features">2. Related Feature</h2>
+<div id="def-api-features" class="def-api-features">
+ You can check if this API is supported with <em>tizen.systeminfo.getCapability()</em> and decide enable/disable codes that need this API.
+ <div class="def-api-feature">
+<p><div class="description">
+ <p>
+If an application uses startRecord() or stopRecord(), declare the following feature requirements in the config file:
+ </p>
+ </div></p>
+<li class="feature">http://tizen.org/feature/microphone</li>
+</div>
+<div class="def-api-feature">
+<p></p>
+<li class="feature">http://tizen.org/feature/camera</li>
+</div>
+<div class="def-api-feature">
+<p></p>
+<li class="feature">http://tizen.org/feature/media.audio_recording</li>
+</div>
+<p></p>
+ For more information, see <a href="../../org.tizen.gettingstarted/html/tizen_overview/application_filtering.htm">Application Filtering.</a>
+</div>
+<h2 id="full-webidl">3. Full WebIDL</h2>
+<pre class="webidl prettyprint">module Media {
+ [Constructor(DOMString src, optional <a href="cordova.html#SuccessCallback">SuccessCallback</a>? successCallback, optional <a href="#MediaErrorCallback">MediaErrorCallback</a>? errorCallback, optional <a href="#StatusChangeCallback">StatusChangeCallback</a>? mediaStatus)]
+ interface Media {
+ const short MEDIA_NONE = 0;
+ const short MEDIA_STARTING = 1;
+ const short MEDIA_RUNNING = 2;
+ const short MEDIA_PAUSED = 3;
+ const short MEDIA_STOPPED = 4;
+
+ attribute DOMString src;
+
+ attribute <a href="cordova.html#SuccessCallback">SuccessCallback</a>? successCallback;
+
+ attribute <a href="#MediaErrorCallback">MediaErrorCallback</a>? errorCallback;
+
+ attribute <a href="#StatusChangeCallback">StatusChangeCallback</a>? statusCallback;
+
+ void getCurrentPosition(<a href="#PositionSuccessCallback">PositionSuccessCallback</a> positionSuccessCallback, optional <a href="#MediaErrorCallback">MediaErrorCallback</a> errorCallback);
+
+ double getDuration();
+
+ void pause();
+
+ void play();
+
+ void release();
+
+ void seekTo(double position);
+
+ void setVolume(double volume);
+
+ void startRecord();
+
+ void stopRecord();
+
+ void stop();
+ };
+
+ interface MediaError {
+ const short MEDIA_ERR_ABORTED = 1;
+ const short MEDIA_ERR_NETWORK = 2;
+ const short MEDIA_ERR_DECODE = 3;
+ const short MEDIA_ERR_NONE_SUPPORTED = 4;
+
+ readonly attribute short code;
+ };
+
+ [Callback=FunctionOnly,NoInterfaceObject] interface MediaErrorCallback {
+ void onerror(<a href="#MediaError">MediaError</a> error);
+ };
+
+ [Callback=FunctionOnly, NoInterfaceObject] interface StatusChangeCallback {
+ void onchanged(short status);
+ };
+
+ [Callback=FunctionOnly, NoInterfaceObject] interface PositionSuccessCallback {
+ void onsuccess(double position);
+ };
+};</pre>
+</div>
+<div id="page-footer">
+<div class="copyright" align="center">
+ Except as noted, this content - excluding the Code Examples - is licensed under <a href="http://creativecommons.org/licenses/by/3.0/legalcode" target="_blank">Creative Commons Attribution 3.0</a> and all of the Code Examples contained herein are licensed under <a href="https://www.tizen.org/bsd-3-clause-license" target="_blank">BSD-3-Clause</a>. <br>For details, see the <a href="https://www.tizen.org/content-license" target="_blank">Content License</a>.
+ </div>
+<script type="text/javascript">
+
+ var _gaq = _gaq || [];
+ _gaq.push(['_setAccount', 'UA-25976949-1']);
+ _gaq.push(['_setDomainName', 'tizen.org']);
+ _gaq.push(['_trackPageview']);
+
+ (function() {
+ var ga = document.createElement('script'); ga.type = 'text/javascript'; ga.async = true;
+ var s = document.getElementsByTagName('script')[0]; s.parentNode.insertBefore(ga, s);
+ })();
+
+ </script>
+</div>
+</body>
+</html>
--- /dev/null
+<!DOCTYPE html PUBLIC "html">
+<html>
+<head>
+<meta http-equiv="Content-Type" content="text/html; charset=utf-8">
+<link rel="stylesheet" type="text/css" href="../tizen.css" media="screen">
+<script type="text/javascript" src="snippet.js"></script><title>NetworkInformation API</title>
+</head>
+<body id="page-content" onload="prettyPrint()">
+<div class="api" id="::NetworkInformation">
+
+<div class="title"><h1>NetworkInformation API</h1></div>
+<div class="brief">
+ This plugin provides information about the device's cellular and wifi connection, and whether the device has an internet connection.
+ </div>
+<div class="description">
+ <p>
+Original documentation: <a href="https://www.npmjs.com/package/cordova-plugin-network-information">Cordova Network Information</a>.
+ </p>
+ </div>
+<h2>Table of Contents</h2>
+<ul class="toc">
+<li>1. <a href="#interfaces-section">Interfaces</a><ul class="toc">
+<li>1.1. <a href="#NetworkInformationManagerObject">NetworkInformationManagerObject</a>
+</li>
+<li>1.2. <a href="#NetworkInformationManager">NetworkInformationManager</a>
+</li>
+<li>1.3. <a href="#Connection">Connection</a>
+</li>
+<li>1.4. <a href="#OnlineEventCallback">OnlineEventCallback</a>
+</li>
+<li>1.5. <a href="#OfflineEventCallback">OfflineEventCallback</a>
+</li>
+</ul>
+</li>
+<li>2. <a href="#api-features">Related Feature</a>
+</li>
+<li>3. <a href="#full-webidl">Full WebIDL</a>
+</li>
+</ul>
+<hr>
+<h2 id="method-summary">Summary of Interfaces and Methods</h2>
+<table class="informaltable">
+<thead><tr>
+<th>Interface</th>
+<th>Method</th>
+</tr></thead>
+<tbody>
+<tr>
+<td><a href="#NetworkInformationManagerObject">NetworkInformationManagerObject</a></td>
+<td></td>
+</tr>
+<tr>
+<td><a href="#NetworkInformationManager">NetworkInformationManager</a></td>
+<td></td>
+</tr>
+<tr>
+<td><a href="#Connection">Connection</a></td>
+<td></td>
+</tr>
+<tr>
+<td><a href="#OnlineEventCallback">OnlineEventCallback</a></td>
+<td><div>void <a href="#OnlineEventCallback::online">online</a> ()</div></td>
+</tr>
+<tr>
+<td><a href="#OfflineEventCallback">OfflineEventCallback</a></td>
+<td><div>void <a href="#OfflineEventCallback::offline">offline</a> ()</div></td>
+</tr>
+</tbody>
+</table>
+<div class="interfaces" id="interfaces-section">
+<h2>1. Interfaces</h2>
+<div class="interface" id="NetworkInformationManagerObject">
+<a class="backward-compatibility-anchor" name="::NetworkInformation::NetworkInformationManagerObject"></a><h3>1.1. NetworkInformationManagerObject</h3>
+<div class="brief">
+ The <em>NetworkInformationManagerObject</em> interface defines what is instantiated in the <em>Navigator</em> object.
+ </div>
+<pre class="webidl prettyprint"> [NoInterfaceObject] interface NetworkInformationManagerObject {
+ readonly attribute <a href="#NetworkInformationManager">NetworkInformationManager</a> connection;
+ };</pre>
+<pre class="webidl prettyprint"> implements <a href="#NetworkInformationManagerObject">NetworkInformationManagerObject</a>;</pre>
+<div class="description">
+ <p>
+The <em>navigator.connection</em> object allows access to the NetworkInformation API.
+ </p>
+ </div>
+</div>
+<div class="interface" id="NetworkInformationManager">
+<a class="backward-compatibility-anchor" name="::NetworkInformation::NetworkInformationManager"></a><h3>1.2. NetworkInformationManager</h3>
+<div class="brief">
+ The <em>NetworkInformationManager</em> interface provides methods for global operations related to notifications to the user.
+ </div>
+<pre class="webidl prettyprint"> [NoInterfaceObject] interface NetworkInformationManager {
+ readonly attribute DOMString type;
+ };</pre>
+<div class="attributes">
+<h4>Attributes</h4>
+<ul><li class="attribute" id="NetworkInformationManager::type">
+<span class="attrName"><span class="readonly"> readonly
+</span><span class="type">DOMString </span><span class="name">type</span></span><div class="brief">
+ Returns the current connection type. The value returned is one of the following strings, case-sensitively: unknown, ethernet, wifi, 2g, 3g, 4g, none.
+ </div>
+<p><span class="version">
+ Since: </span>
+ 3.0
+ </p>
+<p><span class="privilegelevel">
+ Privilege level: </span>
+ public
+ </p>
+<p><span class="privilege">
+ Privilege: </span>
+ http://tizen.org/privilege/telephony
+ </p>
+<div class="example">
+<span class="example"><p>Code example:</p></span><pre name="code" class="examplecode prettyprint"> function checkConnection() {
+ var networkState = navigator.connection.type;
+
+ var states = {};
+ states[Connection.UNKNOWN] = 'Unknown connection';
+ states[Connection.ETHERNET] = 'Ethernet connection';
+ states[Connection.WIFI] = 'WiFi connection';
+ states[Connection.CELL_2G] = 'Cell 2G connection';
+ states[Connection.CELL_3G] = 'Cell 3G connection';
+ states[Connection.CELL_4G] = 'Cell 4G connection';
+ states[Connection.CELL] = 'Cell generic connection';
+ states[Connection.NONE] = 'No network connection';
+ alert('Connection type: ' + states[networkState]);
+ }
+
+ checkConnection();
+ </pre>
+</div>
+<div class="output">
+<span class="title"><p>Output example:</p></span><pre>Connection type: Cell 3G connection
+</pre>
+</div>
+</li></ul>
+</div>
+</div>
+<div class="interface" id="Connection">
+<a class="backward-compatibility-anchor" name="::NetworkInformation::Connection"></a><h3>1.3. Connection</h3>
+<div class="brief">
+ The <em>Connection</em> is available as window attribute.
+ </div>
+<pre class="webidl prettyprint"> interface Connection {
+ readonly attribute DOMString UNKNOWN;
+ readonly attribute DOMString ETHERNET;
+ readonly attribute DOMString WIFI;
+ readonly attribute DOMString CELL_2G;
+ readonly attribute DOMString CELL_3G;
+ readonly attribute DOMString CELL_4G;
+ readonly attribute DOMString CELL;
+ readonly attribute DOMString NONE;
+ };</pre>
+<div class="attributes">
+<h4>Attributes</h4>
+<ul>
+<li class="attribute" id="Connection::UNKNOWN">
+<span class="attrName"><span class="readonly"> readonly
+</span><span class="type">DOMString </span><span class="name">UNKNOWN</span></span><div class="brief">
+ The value returned is 'unknown'.
+ </div>
+<p><span class="version">
+ Since: </span>
+ 3.0
+ </p>
+<div class="example">
+<span class="example"><p>Code example:</p></span><pre name="code" class="examplecode prettyprint"> console.log(Connection.UNKNOWN);
+ </pre>
+</div>
+<div class="output">
+<span class="title"><p>Output example:</p></span><pre>unknown
+</pre>
+</div>
+</li>
+<li class="attribute" id="Connection::ETHERNET">
+<span class="attrName"><span class="readonly"> readonly
+</span><span class="type">DOMString </span><span class="name">ETHERNET</span></span><div class="brief">
+ The value returned is 'ethernet'.
+ </div>
+<p><span class="version">
+ Since: </span>
+ 3.0
+ </p>
+<div class="example">
+<span class="example"><p>Code example:</p></span><pre name="code" class="examplecode prettyprint"> console.log(Connection.ETHERNET);
+ </pre>
+</div>
+<div class="output">
+<span class="title"><p>Output example:</p></span><pre>ethernet
+</pre>
+</div>
+</li>
+<li class="attribute" id="Connection::WIFI">
+<span class="attrName"><span class="readonly"> readonly
+</span><span class="type">DOMString </span><span class="name">WIFI</span></span><div class="brief">
+ The value returned is 'wifi'.
+ </div>
+<p><span class="version">
+ Since: </span>
+ 3.0
+ </p>
+<div class="example">
+<span class="example"><p>Code example:</p></span><pre name="code" class="examplecode prettyprint"> console.log(Connection.WIFI);
+ </pre>
+</div>
+<div class="output">
+<span class="title"><p>Output example:</p></span><pre>wifi
+</pre>
+</div>
+</li>
+<li class="attribute" id="Connection::CELL_2G">
+<span class="attrName"><span class="readonly"> readonly
+</span><span class="type">DOMString </span><span class="name">CELL_2G</span></span><div class="brief">
+ The value returned is '2g'.
+ </div>
+<p><span class="version">
+ Since: </span>
+ 3.0
+ </p>
+<div class="example">
+<span class="example"><p>Code example:</p></span><pre name="code" class="examplecode prettyprint"> console.log(Connection.CELL_2G);
+ </pre>
+</div>
+<div class="output">
+<span class="title"><p>Output example:</p></span><pre>2g
+</pre>
+</div>
+</li>
+<li class="attribute" id="Connection::CELL_3G">
+<span class="attrName"><span class="readonly"> readonly
+</span><span class="type">DOMString </span><span class="name">CELL_3G</span></span><div class="brief">
+ The value returned is '3g'.
+ </div>
+<p><span class="version">
+ Since: </span>
+ 3.0
+ </p>
+<div class="example">
+<span class="example"><p>Code example:</p></span><pre name="code" class="examplecode prettyprint"> console.log(Connection.CELL_3G);
+ </pre>
+</div>
+<div class="output">
+<span class="title"><p>Output example:</p></span><pre>3g
+</pre>
+</div>
+</li>
+<li class="attribute" id="Connection::CELL_4G">
+<span class="attrName"><span class="readonly"> readonly
+</span><span class="type">DOMString </span><span class="name">CELL_4G</span></span><div class="brief">
+ The value returned is '4g'.
+ </div>
+<p><span class="version">
+ Since: </span>
+ 3.0
+ </p>
+<div class="example">
+<span class="example"><p>Code example:</p></span><pre name="code" class="examplecode prettyprint"> console.log(Connection.CELL_4G);
+ </pre>
+</div>
+<div class="output">
+<span class="title"><p>Output example:</p></span><pre>4g
+</pre>
+</div>
+</li>
+<li class="attribute" id="Connection::CELL">
+<span class="attrName"><span class="readonly"> readonly
+</span><span class="type">DOMString </span><span class="name">CELL</span></span><div class="brief">
+ The value returned is 'cellular'.
+ </div>
+<p><span class="version">
+ Since: </span>
+ 3.0
+ </p>
+<div class="example">
+<span class="example"><p>Code example:</p></span><pre name="code" class="examplecode prettyprint"> console.log(Connection.CELL);
+ </pre>
+</div>
+<div class="output">
+<span class="title"><p>Output example:</p></span><pre>cellular
+</pre>
+</div>
+</li>
+<li class="attribute" id="Connection::NONE">
+<span class="attrName"><span class="readonly"> readonly
+</span><span class="type">DOMString </span><span class="name">NONE</span></span><div class="brief">
+ The value returned is 'none'.
+ </div>
+<p><span class="version">
+ Since: </span>
+ 3.0
+ </p>
+<div class="example">
+<span class="example"><p>Code example:</p></span><pre name="code" class="examplecode prettyprint"> console.log(Connection.NONE);
+ </pre>
+</div>
+<div class="output">
+<span class="title"><p>Output example:</p></span><pre>none
+</pre>
+</div>
+</li>
+</ul>
+</div>
+</div>
+<div class="interface" id="OnlineEventCallback">
+<a class="backward-compatibility-anchor" name="::NetworkInformation::OnlineEventCallback"></a><h3>1.4. OnlineEventCallback</h3>
+<div class="brief">
+ Callback for the event when an application goes online, and the device becomes connected to the Internet.
+ </div>
+<pre class="webidl prettyprint"> [NoInterfaceObject, Callback=FunctionOnly]
+ interface OnlineEventCallback {
+ void online();
+ };</pre>
+<p><span class="version">
+ Since: </span>
+ 3.0
+ </p>
+<div class="description">
+ <p>
+The <var>online</var> event fires when an application goes online, and the device becomes connected to the Internet.
+ </p>
+ <p>
+Applications typically should use document.addEventListener() to attach an event listener once the <a href="events.html#DeviceReadyEventCallback">deviceready</a> event fires.
+ </p>
+ <p>
+Original documentation: <a href="https://www.npmjs.com/package/cordova-plugin-network-information#online">Cordova online event</a> </p>
+ </div>
+<div class="example">
+<span class="example"><p>Code example:</p></span><pre name="code" class="examplecode prettyprint"> document.addEventListener('deviceready', onDeviceReady, false);
+
+ function onDeviceReady() {
+ document.addEventListener('online', onOnline, false);
+ }
+
+ function onOnline() {
+ // Handle the online event
+ }
+ </pre>
+</div>
+</div>
+<div class="interface" id="OfflineEventCallback">
+<a class="backward-compatibility-anchor" name="::NetworkInformation::OfflineEventCallback"></a><h3>1.5. OfflineEventCallback</h3>
+<div class="brief">
+ Callback for the event when an application goes offline, and the device is not connected to the Internet.
+ </div>
+<pre class="webidl prettyprint"> [NoInterfaceObject, Callback=FunctionOnly]
+ interface OfflineEventCallback {
+ void offline();
+ };</pre>
+<p><span class="version">
+ Since: </span>
+ 3.0
+ </p>
+<div class="description">
+ <p>
+The <var>online</var> event fires when an application goes online, and the device becomes connected to the Internet.
+ </p>
+ <p>
+Applications typically should use document.addEventListener() to attach an event listener once the <a href="events.html#DeviceReadyEventCallback">deviceready</a> event fires.
+ </p>
+ <p>
+Original documentation: <a href="https://www.npmjs.com/package/cordova-plugin-network-information#offline">Cordova offline event</a> </p>
+ </div>
+<div class="example">
+<span class="example"><p>Code example:</p></span><pre name="code" class="examplecode prettyprint"> document.addEventListener('deviceready', onDeviceReady, false);
+
+ function onDeviceReady() {
+ document.addEventListener('offline', onOffline, false);
+ }
+
+ function onOffline() {
+ // Handle the offline event
+ }
+ </pre>
+</div>
+</div>
+</div>
+<h2 id="api-features">2. Related Feature</h2>
+<div id="def-api-features" class="def-api-features">
+ You can check if this API is supported with <em>tizen.systeminfo.getCapability()</em> and decide enable/disable codes that need this API.
+ <div class="def-api-feature">
+<p><div class="description">
+ <p>
+To guarantee that the NetworkInformation application runs on a device with the NetworkInformation feature declare the following feature requirements in the config file:
+ </p>
+ </div></p>
+<li class="feature">http://tizen.org/feature/network.telephony</li>
+</div>
+<p></p>
+ For more information, see <a href="../../org.tizen.gettingstarted/html/tizen_overview/application_filtering.htm">Application Filtering.</a>
+</div>
+<h2 id="full-webidl">3. Full WebIDL</h2>
+<pre class="webidl prettyprint">module NetworkInformation {
+ [NoInterfaceObject] interface NetworkInformationManagerObject {
+ readonly attribute <a href="#NetworkInformationManager">NetworkInformationManager</a> connection;
+ };
+ implements <a href="#NetworkInformationManagerObject">NetworkInformationManagerObject</a>;
+ [NoInterfaceObject] interface NetworkInformationManager {
+ readonly attribute DOMString type;
+ };
+ interface Connection {
+ readonly attribute DOMString UNKNOWN;
+ readonly attribute DOMString ETHERNET;
+ readonly attribute DOMString WIFI;
+ readonly attribute DOMString CELL_2G;
+ readonly attribute DOMString CELL_3G;
+ readonly attribute DOMString CELL_4G;
+ readonly attribute DOMString CELL;
+ readonly attribute DOMString NONE;
+ };
+
+ [NoInterfaceObject, Callback=FunctionOnly]
+ interface OnlineEventCallback {
+ void online();
+ };
+ [NoInterfaceObject, Callback=FunctionOnly]
+ interface OfflineEventCallback {
+ void offline();
+ };
+};</pre>
+</div>
+<div id="page-footer">
+<div class="copyright" align="center">
+ Except as noted, this content - excluding the Code Examples - is licensed under <a href="http://creativecommons.org/licenses/by/3.0/legalcode" target="_blank">Creative Commons Attribution 3.0</a> and all of the Code Examples contained herein are licensed under <a href="https://www.tizen.org/bsd-3-clause-license" target="_blank">BSD-3-Clause</a>. <br>For details, see the <a href="https://www.tizen.org/content-license" target="_blank">Content License</a>.
+ </div>
+<script type="text/javascript">
+
+ var _gaq = _gaq || [];
+ _gaq.push(['_setAccount', 'UA-25976949-1']);
+ _gaq.push(['_setDomainName', 'tizen.org']);
+ _gaq.push(['_trackPageview']);
+
+ (function() {
+ var ga = document.createElement('script'); ga.type = 'text/javascript'; ga.async = true;
+ var s = document.getElementsByTagName('script')[0]; s.parentNode.insertBefore(ga, s);
+ })();
+
+ </script>
+</div>
+</body>
+</html>
<td>1.0</td>
<td>Mandatory</td>
<td>Yes</td>
+
+ </tr></tbody></table><h4 id="Cordova">Cordova</h4>
+ <table class="api-list"><thead><tr><th>API</th><th>Description</th><th>Version (Since)</th><th>Mobile</th><th>Supported on<br>Mobile Emulator</th></tr>
+ </thead><tbody><tr><td><a href="tizen/cordova/console.html">
+ Console</a></td>
+ <td>The Console module provides function to access the console.</td>
+ <td>3.0</td>
+ <td>Mandatory</td>
+ <td>Yes</td>
+
+ </tr><tr><td><a href="tizen/cordova/cordova.html">
+ Cordova</a></td>
+ <td>This API provides common Cordova functionality.</td>
+ <td>3.0</td>
+ <td>Mandatory</td>
+ <td>Yes</td>
+
+ </tr><tr><td><a href="tizen/cordova/device.html">
+ Device</a></td>
+ <td>This plugin defines a global device object, which describes the device's hardware and software.</td>
+ <td>3.0</td>
+ <td>Mandatory</td>
+ <td>Yes</td>
+
+ </tr><tr><td><a href="tizen/cordova/device-motion.html">
+ Device Motion</a></td>
+ <td>This plugin provides access to the device's accelerometer.</td>
+ <td>3.0</td>
+ <td>Mandatory</td>
+ <td>Yes</td>
+
+ </tr><tr><td><a href="tizen/cordova/dialogs.html">
+ Dialogs</a></td>
+ <td>This plugin provides the ability to make different types of notifications to the user.</td>
+ <td>3.0</td>
+ <td>Mandatory</td>
+ <td>Yes</td>
+
+ </tr><tr><td><a href="tizen/cordova/events.html">
+ Events</a></td>
+ <td>This plugin provides information about events defined in cordova.</td>
+ <td>3.0</td>
+ <td>Mandatory</td>
+ <td>Yes</td>
+
+ </tr><tr><td><a href="tizen/cordova/file.html">
+ File</a></td>
+ <td>This plugin implements a File API allowing read/write access to files residing on the device.</td>
+ <td>3.0</td>
+ <td>Mandatory</td>
+ <td>Yes</td>
+
+ </tr><tr><td><a href="tizen/cordova/filetransfer.html">
+ File Transfer</a></td>
+ <td>This module allows you to upload and download files.</td>
+ <td>3.0</td>
+ <td>Mandatory</td>
+ <td>Yes</td>
+
+ </tr><tr><td><a href="tizen/cordova/globalization.html">
+ Globalization</a></td>
+ <td>This plugin obtains information and performs operations specific to the user's locale, language, and timezone.</td>
+ <td>3.0</td>
+ <td>Mandatory</td>
+ <td>Yes</td>
+
+ </tr><tr><td><a href="tizen/cordova/media.html">
+ Media</a></td>
+ <td>This plugin provides the ability to record and play back audio files on a device.</td>
+ <td>3.0</td>
+ <td>Mandatory</td>
+ <td>Yes</td>
+
+ </tr><tr><td><a href="tizen/cordova/networkInformation.html">
+ Network Information</a></td>
+ <td>This plugin provides information about the device's cellular and wifi connection, and whether the device has an internet connection. </td>
+ <td>3.0</td>
+ <td>Mandatory</td>
+ <td>Yes</td>
+
</tr></tbody></table><div id="footer">
<div class="copyright" align="center">
Except as noted, this content - excluding the Code Examples - is licensed under <a href="http://creativecommons.org/licenses/by/3.0/legalcode" target="_blank">Creative Commons Attribution 3.0</a> and all of the Code Examples contained herein are licensed under <a href="https://www.tizen.org/bsd-3-clause-license" target="_blank">BSD-3-Clause</a>. <br>For details, see the <a href="https://www.tizen.org/content-license" target="_blank">Content License</a>.
--- /dev/null
+<!DOCTYPE html PUBLIC "html">
+<html>
+<head>
+<meta http-equiv="Content-Type" content="text/html; charset=utf-8">
+<link rel="stylesheet" type="text/css" href="../tizen.css" media="screen">
+<script type="text/javascript" src="snippet.js"></script><title>Console API</title>
+</head>
+<body id="page-content" onload="prettyPrint()">
+<div class="api" id="::Console">
+<div class="supported-platforms"><img class="wearable-mandatory emulator" title="Mandatory, Supported by Tizen Wearable emulator" src="../wearable_s_w.png"></div>
+<div class="title"><h1>Console API</h1></div>
+<div class="brief">
+ the Console module provides function to access the console.
+Original documentation: <a href="https://www.npmjs.com/package/cordova-plugin-console">Cordova Console</a>.
+ </div>
+<h2>Table of Contents</h2>
+<ul class="toc">
+<li>1. <a href="#interfaces-section">Interfaces</a><ul class="toc">
+<li>1.1. <a href="#ConsoleManagerObject">ConsoleManagerObject</a>
+</li>
+<li>1.2. <a href="#ConsoleManager">ConsoleManager</a>
+</li>
+</ul>
+</li>
+<li>2. <a href="#full-webidl">Full WebIDL</a>
+</li>
+</ul>
+<hr>
+<h2 id="method-summary">Summary of Interfaces and Methods</h2>
+<table class="informaltable">
+<thead><tr>
+<th>Interface</th>
+<th>Method</th>
+</tr></thead>
+<tbody>
+<tr>
+<td><a href="#ConsoleManagerObject">ConsoleManagerObject</a></td>
+<td></td>
+</tr>
+<tr>
+<td><a href="#ConsoleManager">ConsoleManager</a></td>
+<td>
+<div>void <a href="#ConsoleManager::log">log</a> (DOMString text)</div>
+<div>void <a href="#ConsoleManager::error">error</a> (DOMString text)</div>
+<div>void <a href="#ConsoleManager::warn">warn</a> (DOMString text)</div>
+<div>void <a href="#ConsoleManager::info">info</a> (DOMString text)</div>
+<div>void <a href="#ConsoleManager::debug">debug</a> (DOMString text)</div>
+<div>void <a href="#ConsoleManager::assert">assert</a> (boolean expression, DOMString message)</div>
+<div>void <a href="#ConsoleManager::dir">dir</a> (Object obj)</div>
+<div>void <a href="#ConsoleManager::dirxml">dirxml</a> (Object obj)</div>
+<div>void <a href="#ConsoleManager::time">time</a> (DOMString label)</div>
+<div>void <a href="#ConsoleManager::timeEnd">timeEnd</a> (DOMString label)</div>
+</td>
+</tr>
+</tbody>
+</table>
+<div class="interfaces" id="interfaces-section">
+<h2>1. Interfaces</h2>
+<div class="interface" id="ConsoleManagerObject">
+<a class="backward-compatibility-anchor" name="::Console::ConsoleManagerObject"></a><h3>1.1. ConsoleManagerObject</h3>
+<pre class="webidl prettyprint"> [NoInterfaceObject] interface ConsoleManagerObject {
+ readonly attribute <a href="#ConsoleManager">ConsoleManager</a> console;
+ };</pre>
+<pre class="webidl prettyprint"> Window implements <a href="#ConsoleManagerObject">ConsoleManagerObject</a>;</pre>
+<div class="description">
+ <p>
+The ConsoleManagerObject interface.
+ </p>
+ </div>
+</div>
+<div class="interface" id="ConsoleManager">
+<a class="backward-compatibility-anchor" name="::Console::ConsoleManager"></a><h3>1.2. ConsoleManager</h3>
+<div class="brief">
+ the ConsoleManager interface embodies Console module methods.
+ </div>
+<pre class="webidl prettyprint"> [NoInterfaceObject] interface ConsoleManager {
+ void log(DOMString text);
+
+ void error(DOMString text);
+
+ void warn(DOMString text);
+
+ void info(DOMString text);
+
+ void debug(DOMString text);
+
+ void assert(boolean expression, DOMString message);
+
+ void dir(Object obj);
+
+ void dirxml(Object obj);
+
+ void time(DOMString label);
+
+ void timeEnd(DOMString label);
+ };</pre>
+<div class="methods">
+<h4>Methods</h4>
+<dl>
+<dt class="method" id="ConsoleManager::log">
+<a class="backward-compatibility-anchor" name="::Console::ConsoleManager::log"></a><code><b><span class="methodName">log</span></b></code>
+</dt>
+<dd>
+<div class="brief">
+ Prints a line of text to a standard output.
+The text will be logged as a standard message.
+ </div>
+<div class="synopsis"><pre class="signature prettyprint">void log(DOMString text);
+ </pre></div>
+<p><span class="version">
+ Since: </span>
+ 3.0
+ </p>
+<div class="parameters">
+<p><span class="param">Parameters:</span></p>
+<ul>
+ <li class="param">
+<span class="name">text</span>:
+ The text to be printed.
+ </li>
+ </ul>
+</div>
+<div class="example">
+<span class="example"><p>Code example:</p></span><pre name="code" class="examplecode prettyprint"> console.log('A is for Alice.');
+ </pre>
+</div>
+<div class="output">
+<span class="title"><p>Output example:</p></span><pre>A is for Alice.
+</pre>
+</div>
+</dd>
+<dt class="method" id="ConsoleManager::error">
+<a class="backward-compatibility-anchor" name="::Console::ConsoleManager::error"></a><code><b><span class="methodName">error</span></b></code>
+</dt>
+<dd>
+<div class="brief">
+ Prints a line of text to a standard output.
+The text will be logged as an error message.
+ </div>
+<div class="synopsis"><pre class="signature prettyprint">void error(DOMString text);
+ </pre></div>
+<p><span class="version">
+ Since: </span>
+ 3.0
+ </p>
+<div class="parameters">
+<p><span class="param">Parameters:</span></p>
+<ul>
+ <li class="param">
+<span class="name">text</span>:
+ The text to be printed.
+ </li>
+ </ul>
+</div>
+<div class="example">
+<span class="example"><p>Code example:</p></span><pre name="code" class="examplecode prettyprint"> console.error('B is for Bob.');
+ </pre>
+</div>
+<div class="output">
+<span class="title"><p>Output example:</p></span><pre>B is for Bob.
+</pre>
+</div>
+</dd>
+<dt class="method" id="ConsoleManager::warn">
+<a class="backward-compatibility-anchor" name="::Console::ConsoleManager::warn"></a><code><b><span class="methodName">warn</span></b></code>
+</dt>
+<dd>
+<div class="brief">
+ Prints a line of text to a standard output.
+The text will be logged as a warning message.
+ </div>
+<div class="synopsis"><pre class="signature prettyprint">void warn(DOMString text);
+ </pre></div>
+<p><span class="version">
+ Since: </span>
+ 3.0
+ </p>
+<div class="parameters">
+<p><span class="param">Parameters:</span></p>
+<ul>
+ <li class="param">
+<span class="name">text</span>:
+ The text to be printed.
+ </li>
+ </ul>
+</div>
+<div class="example">
+<span class="example"><p>Code example:</p></span><pre name="code" class="examplecode prettyprint"> console.warn('C is for Christopher.');
+ </pre>
+</div>
+<div class="output">
+<span class="title"><p>Output example:</p></span><pre>C is for Christopher.
+</pre>
+</div>
+</dd>
+<dt class="method" id="ConsoleManager::info">
+<a class="backward-compatibility-anchor" name="::Console::ConsoleManager::info"></a><code><b><span class="methodName">info</span></b></code>
+</dt>
+<dd>
+<div class="brief">
+ Prints a line of text to a standard output.
+The text will be logged as an info message.
+ </div>
+<div class="synopsis"><pre class="signature prettyprint">void info(DOMString text);
+ </pre></div>
+<p><span class="version">
+ Since: </span>
+ 3.0
+ </p>
+<div class="parameters">
+<p><span class="param">Parameters:</span></p>
+<ul>
+ <li class="param">
+<span class="name">text</span>:
+ The text to be printed.
+ </li>
+ </ul>
+</div>
+<div class="example">
+<span class="example"><p>Code example:</p></span><pre name="code" class="examplecode prettyprint"> console.info('D is for Dorothy.');
+ </pre>
+</div>
+<div class="output">
+<span class="title"><p>Output example:</p></span><pre>D is for Dorothy.
+</pre>
+</div>
+</dd>
+<dt class="method" id="ConsoleManager::debug">
+<a class="backward-compatibility-anchor" name="::Console::ConsoleManager::debug"></a><code><b><span class="methodName">debug</span></b></code>
+</dt>
+<dd>
+<div class="brief">
+ Prints a line of text to a standard output.
+The text will be logged as a debug message.
+ </div>
+<div class="synopsis"><pre class="signature prettyprint">void debug(DOMString text);
+ </pre></div>
+<p><span class="version">
+ Since: </span>
+ 3.0
+ </p>
+<div class="parameters">
+<p><span class="param">Parameters:</span></p>
+<ul>
+ <li class="param">
+<span class="name">text</span>:
+ The text to be printed.
+ </li>
+ </ul>
+</div>
+<div class="example">
+<span class="example"><p>Code example:</p></span><pre name="code" class="examplecode prettyprint"> console.debug('E is for Eve.');
+ </pre>
+</div>
+<div class="output">
+<span class="title"><p>Output example:</p></span><pre>E is for Eve.
+</pre>
+</div>
+</dd>
+<dt class="method" id="ConsoleManager::assert">
+<a class="backward-compatibility-anchor" name="::Console::ConsoleManager::assert"></a><code><b><span class="methodName">assert</span></b></code>
+</dt>
+<dd>
+<div class="brief">
+ If the specified expression is false,
+the message is written to the console.
+ </div>
+<div class="synopsis"><pre class="signature prettyprint">void assert(boolean expression, DOMString message);
+ </pre></div>
+<p><span class="version">
+ Since: </span>
+ 3.0
+ </p>
+<div class="parameters">
+<p><span class="param">Parameters:</span></p>
+<ul>
+ <li class="param">
+<span class="name">expression</span>:
+ The expression to be evaluated.
+ </li>
+ <li class="param">
+<span class="name">message</span>:
+ The message to be displayed if an expression is false.
+ </li>
+ </ul>
+</div>
+<div class="example">
+<span class="example"><p>Code example:</p></span><pre name="code" class="examplecode prettyprint"> var felix = 'Felix';
+
+ // This assertion checks whether the first letter in name 'Felix' is 'A':
+ console.assert(felix.charAt(0) === 'A', felix + ' does not start with A.');
+ </pre>
+</div>
+<div class="output">
+<span class="title"><p>Output example:</p></span><pre>Felix does not start with A.
+</pre>
+</div>
+</dd>
+<dt class="method" id="ConsoleManager::dir">
+<a class="backward-compatibility-anchor" name="::Console::ConsoleManager::dir"></a><code><b><span class="methodName">dir</span></b></code>
+</dt>
+<dd>
+<div class="brief">
+ Prints a JavaScript representation of the specified object.
+If the object being logged is an HTML element, the JavaScript
+Object view is forced.
+ </div>
+<div class="synopsis"><pre class="signature prettyprint">void dir(Object obj);
+ </pre></div>
+<p><span class="version">
+ Since: </span>
+ 3.0
+ </p>
+<div class="parameters">
+<p><span class="param">Parameters:</span></p>
+<ul>
+ <li class="param">
+<span class="name">obj</span>:
+ An object whose JavaScript representation will be printed.
+ </li>
+ </ul>
+</div>
+<div class="example">
+<span class="example"><p>Code example:</p></span><pre name="code" class="examplecode prettyprint"> var john = {name: "John", surname: "Doe"};
+ console.dir(john.name);
+ </pre>
+</div>
+<div class="output">
+<span class="title"><p>Output example:</p></span><pre>John
+</pre>
+</div>
+</dd>
+<dt class="method" id="ConsoleManager::dirxml">
+<a class="backward-compatibility-anchor" name="::Console::ConsoleManager::dirxml"></a><code><b><span class="methodName">dirxml</span></b></code>
+</dt>
+<dd>
+<div class="brief">
+ Prints an XML/HTML Element representation of the specified object
+if possible or the JavaScript Object if it is not.
+ </div>
+<div class="synopsis"><pre class="signature prettyprint">void dirxml(Object obj);
+ </pre></div>
+<p><span class="version">
+ Since: </span>
+ 3.0
+ </p>
+<div class="parameters">
+<p><span class="param">Parameters:</span></p>
+<ul>
+ <li class="param">
+<span class="name">obj</span>:
+ An object whose XML/HTML Element representation will be printed.
+ </li>
+ </ul>
+</div>
+<div class="example">
+<span class="example"><p>Code example:</p></span><pre name="code" class="examplecode prettyprint"> var john = {name: "John", surname: "Doe"};
+ console.dirxml(john.surname);
+ </pre>
+</div>
+<div class="output">
+<span class="title"><p>Output example:</p></span><pre>Doe
+</pre>
+</div>
+</dd>
+<dt class="method" id="ConsoleManager::time">
+<a class="backward-compatibility-anchor" name="::Console::ConsoleManager::time"></a><code><b><span class="methodName">time</span></b></code>
+</dt>
+<dd>
+<div class="brief">
+ Starts a new timer with an associated label. When <var>console.timeEnd()
+</var> is called with the same label, the timer is stopped and the elapsed time
+is displayed in the console. Timer values are accurate to the sub-millisecond.
+ </div>
+<div class="synopsis"><pre class="signature prettyprint">void time(DOMString label);
+ </pre></div>
+<p><span class="version">
+ Since: </span>
+ 3.0
+ </p>
+<div class="parameters">
+<p><span class="param">Parameters:</span></p>
+<ul>
+ <li class="param">
+<span class="name">label</span>:
+ The label to start timing with.
+ </li>
+ </ul>
+</div>
+<div class="example">
+<span class="example"><p>Code example:</p></span><pre name="code" class="examplecode prettyprint"> console.time("Big array initialization");
+ var array = new Array(1000000);
+ for (var i = array.length - 1; i >= 0; i -= 1) {
+ array[i] = new Object();
+ };
+ console.timeEnd("Big array initialization");
+ </pre>
+</div>
+<div class="output">
+<span class="title"><p>Output example:</p></span><pre>Big array initialization: 461.989ms
+</pre>
+</div>
+</dd>
+<dt class="method" id="ConsoleManager::timeEnd">
+<a class="backward-compatibility-anchor" name="::Console::ConsoleManager::timeEnd"></a><code><b><span class="methodName">timeEnd</span></b></code>
+</dt>
+<dd>
+<div class="brief">
+ Stops the timer with the specified label and prints the elapsed time.
+ </div>
+<div class="synopsis"><pre class="signature prettyprint">void timeEnd(DOMString label);
+ </pre></div>
+<p><span class="version">
+ Since: </span>
+ 3.0
+ </p>
+<div class="parameters">
+<p><span class="param">Parameters:</span></p>
+<ul>
+ <li class="param">
+<span class="name">label</span>:
+ The label associated to the timing (with the use of <var>console.time()</var>method).
+ </li>
+ </ul>
+</div>
+<div class="example">
+<span class="example"><p>Code example:</p></span><pre name="code" class="examplecode prettyprint"> console.time("Big array initialization");
+ var array = new Array(1000000);
+ for (var i = array.length - 1; i >= 0; i -= 1) {
+ array[i] = new Object();
+ };
+ console.timeEnd("Big array initialization");
+ </pre>
+</div>
+<div class="output">
+<span class="title"><p>Output example:</p></span><pre>Big array initialization: 461.989ms
+</pre>
+</div>
+</dd>
+</dl>
+</div>
+</div>
+</div>
+<h2 id="full-webidl">2. Full WebIDL</h2>
+<pre class="webidl prettyprint">module Console {
+ [NoInterfaceObject] interface ConsoleManagerObject {
+ readonly attribute <a href="#ConsoleManager">ConsoleManager</a> console;
+ };
+
+ Window implements <a href="#ConsoleManagerObject">ConsoleManagerObject</a>;
+
+ [NoInterfaceObject] interface ConsoleManager {
+ void log(DOMString text);
+
+ void error(DOMString text);
+
+ void warn(DOMString text);
+
+ void info(DOMString text);
+
+ void debug(DOMString text);
+
+ void assert(boolean expression, DOMString message);
+
+ void dir(Object obj);
+
+ void dirxml(Object obj);
+
+ void time(DOMString label);
+
+ void timeEnd(DOMString label);
+ };
+};</pre>
+</div>
+<div id="page-footer">
+<div class="copyright" align="center">
+ Except as noted, this content - excluding the Code Examples - is licensed under <a href="http://creativecommons.org/licenses/by/3.0/legalcode" target="_blank">Creative Commons Attribution 3.0</a> and all of the Code Examples contained herein are licensed under <a href="https://www.tizen.org/bsd-3-clause-license" target="_blank">BSD-3-Clause</a>. <br>For details, see the <a href="https://www.tizen.org/content-license" target="_blank">Content License</a>.
+ </div>
+<script type="text/javascript">
+
+ var _gaq = _gaq || [];
+ _gaq.push(['_setAccount', 'UA-25976949-1']);
+ _gaq.push(['_setDomainName', 'tizen.org']);
+ _gaq.push(['_trackPageview']);
+
+ (function() {
+ var ga = document.createElement('script'); ga.type = 'text/javascript'; ga.async = true;
+ var s = document.getElementsByTagName('script')[0]; s.parentNode.insertBefore(ga, s);
+ })();
+
+ </script>
+</div>
+</body>
+</html>
--- /dev/null
+<!DOCTYPE html PUBLIC "html">
+<html>
+<head>
+<meta http-equiv="Content-Type" content="text/html; charset=utf-8">
+<link rel="stylesheet" type="text/css" href="../tizen.css" media="screen">
+<script type="text/javascript" src="snippet.js"></script><title>Cordova API</title>
+</head>
+<body id="page-content" onload="prettyPrint()">
+<div class="api" id="::Cordova">
+<div class="supported-platforms"><img class="wearable-mandatory emulator" title="Mandatory, Supported by Tizen Wearable emulator" src="../wearable_s_w.png"></div>
+<div class="title"><h1>Cordova API</h1></div>
+<div class="brief">
+ This API provides common Cordova functionality.
+ </div>
+<h2>Table of Contents</h2>
+<ul class="toc">
+<li>1. <a href="#interfaces-section">Interfaces</a><ul class="toc">
+<li>1.1. <a href="#CordovaManagerObject">CordovaManagerObject</a>
+</li>
+<li>1.2. <a href="#Cordova">Cordova</a>
+</li>
+<li>1.3. <a href="#SuccessCallback">SuccessCallback</a>
+</li>
+<li>1.4. <a href="#ErrorCallback">ErrorCallback</a>
+</li>
+<li>1.5. <a href="#DOMException">DOMException</a>
+</li>
+</ul>
+</li>
+<li>2. <a href="#full-webidl">Full WebIDL</a>
+</li>
+</ul>
+<hr>
+<h2 id="method-summary">Summary of Interfaces and Methods</h2>
+<table class="informaltable">
+<thead><tr>
+<th>Interface</th>
+<th>Method</th>
+</tr></thead>
+<tbody>
+<tr>
+<td><a href="#CordovaManagerObject">CordovaManagerObject</a></td>
+<td></td>
+</tr>
+<tr>
+<td><a href="#Cordova">Cordova</a></td>
+<td></td>
+</tr>
+<tr>
+<td><a href="#SuccessCallback">SuccessCallback</a></td>
+<td><div>void <a href="#SuccessCallback::onsuccess">onsuccess</a> ()</div></td>
+</tr>
+<tr>
+<td><a href="#ErrorCallback">ErrorCallback</a></td>
+<td><div>void <a href="#ErrorCallback::onerror">onerror</a> (<a href="#DOMException">DOMException</a> error)</div></td>
+</tr>
+<tr>
+<td><a href="#DOMException">DOMException</a></td>
+<td></td>
+</tr>
+</tbody>
+</table>
+<div class="interfaces" id="interfaces-section">
+<h2>1. Interfaces</h2>
+<div class="interface" id="CordovaManagerObject">
+<a class="backward-compatibility-anchor" name="::Cordova::CordovaManagerObject"></a><h3>1.1. CordovaManagerObject</h3>
+<div class="brief">
+ CordovaManagerObject implemented in Window
+ </div>
+<pre class="webidl prettyprint"> [NoInterfaceObject] interface CordovaManagerObject {
+ readonly attribute <a href="#Cordova">Cordova</a> cordova;
+ };</pre>
+<pre class="webidl prettyprint"> Window implements <a href="#CordovaManagerObject">CordovaManagerObject</a>;</pre>
+</div>
+<div class="interface" id="Cordova">
+<a class="backward-compatibility-anchor" name="::Cordova::Cordova"></a><h3>1.2. Cordova</h3>
+<div class="brief">
+ The Cordova interface defines what is instantiated by the cordova object
+ </div>
+<pre class="webidl prettyprint"> [NoInterfaceObject] interface Cordova {
+ };</pre>
+</div>
+<div class="interface" id="SuccessCallback">
+<a class="backward-compatibility-anchor" name="::Cordova::SuccessCallback"></a><h3>1.3. SuccessCallback</h3>
+<div class="brief">
+ Basic success callback, no parameters.
+ </div>
+<pre class="webidl prettyprint">[Callback=FunctionOnly,NoInterfaceObject]
+interface SuccessCallback {
+ void onsuccess();
+};</pre>
+<div class="methods">
+<h4>Methods</h4>
+<dl>
+<dt class="method" id="SuccessCallback::onsuccess">
+<a class="backward-compatibility-anchor" name="::Cordova::SuccessCallback::onsuccess"></a><code><b><span class="methodName">onsuccess</span></b></code>
+</dt>
+<dd>
+<div class="brief">
+ Success
+ </div>
+<div class="synopsis"><pre class="signature prettyprint">void onsuccess();
+ </pre></div>
+<p><span class="version">
+ Since: </span>
+ 3.0
+ </p>
+</dd>
+</dl>
+</div>
+</div>
+<div class="interface" id="ErrorCallback">
+<a class="backward-compatibility-anchor" name="::Cordova::ErrorCallback"></a><h3>1.4. ErrorCallback</h3>
+<div class="brief">
+ Basic error callback.
+ </div>
+<pre class="webidl prettyprint">[Callback=FunctionOnly,NoInterfaceObject]
+interface ErrorCallback {
+ void onerror(<a href="#DOMException">DOMException</a> error);
+};</pre>
+<div class="methods">
+<h4>Methods</h4>
+<dl>
+<dt class="method" id="ErrorCallback::onerror">
+<a class="backward-compatibility-anchor" name="::Cordova::ErrorCallback::onerror"></a><code><b><span class="methodName">onerror</span></b></code>
+</dt>
+<dd>
+<div class="brief">
+ Success
+ </div>
+<div class="synopsis"><pre class="signature prettyprint">void onerror(<a href="#DOMException">DOMException</a> error);
+ </pre></div>
+<p><span class="version">
+ Since: </span>
+ 3.0
+ </p>
+<div class="parameters">
+<p><span class="param">Parameters:</span></p>
+<ul>
+ <li class="param">
+<span class="name">error</span>:
+ Error object containing some information about the error.
+ </li>
+ </ul>
+</div>
+</dd>
+</dl>
+</div>
+</div>
+<div class="interface" id="DOMException">
+<a class="backward-compatibility-anchor" name="::Cordova::DOMException"></a><h3>1.5. DOMException</h3>
+<div class="brief">
+ See <a href="https://developer.mozilla.org/en/docs/Web/API/DOMException">DOMException</a>.
+ </div>
+<pre class="webidl prettyprint">interface DOMException {
+ readonly attribute short code;
+
+ readonly attribute DOMString name;
+
+ readonly attribute DOMString message;
+};</pre>
+<div class="attributes">
+<h4>Attributes</h4>
+<ul>
+<li class="attribute" id="DOMException::code">
+<span class="attrName"><span class="readonly"> readonly
+</span><span class="type">short </span><span class="name">code</span></span><div class="brief">
+ The number representing the type of the error.
+ </div>
+<p><span class="version">
+ Since: </span>
+ 3.0
+ </p>
+</li>
+<li class="attribute" id="DOMException::name">
+<span class="attrName"><span class="readonly"> readonly
+</span><span class="type">DOMString </span><span class="name">name</span></span><div class="brief">
+ The short text representing the type of the error.
+ </div>
+<p><span class="version">
+ Since: </span>
+ 3.0
+ </p>
+</li>
+<li class="attribute" id="DOMException::message">
+<span class="attrName"><span class="readonly"> readonly
+</span><span class="type">DOMString </span><span class="name">message</span></span><div class="brief">
+ A text containing information about the error.
+ </div>
+<p><span class="version">
+ Since: </span>
+ 3.0
+ </p>
+</li>
+</ul>
+</div>
+</div>
+</div>
+<h2 id="full-webidl">2. Full WebIDL</h2>
+<pre class="webidl prettyprint">module Cordova {
+
+ [NoInterfaceObject] interface CordovaManagerObject {
+ readonly attribute <a href="#Cordova">Cordova</a> cordova;
+ };
+ Window implements <a href="#CordovaManagerObject">CordovaManagerObject</a>;
+
+ [NoInterfaceObject] interface Cordova {
+ };
+
+
+
+[Callback=FunctionOnly,NoInterfaceObject]
+interface SuccessCallback {
+ void onsuccess();
+};
+
+[Callback=FunctionOnly,NoInterfaceObject]
+interface ErrorCallback {
+ void onerror(<a href="#DOMException">DOMException</a> error);
+};
+
+interface DOMException {
+ readonly attribute short code;
+
+ readonly attribute DOMString name;
+
+ readonly attribute DOMString message;
+};
+
+};</pre>
+</div>
+<div id="page-footer">
+<div class="copyright" align="center">
+ Except as noted, this content - excluding the Code Examples - is licensed under <a href="http://creativecommons.org/licenses/by/3.0/legalcode" target="_blank">Creative Commons Attribution 3.0</a> and all of the Code Examples contained herein are licensed under <a href="https://www.tizen.org/bsd-3-clause-license" target="_blank">BSD-3-Clause</a>. <br>For details, see the <a href="https://www.tizen.org/content-license" target="_blank">Content License</a>.
+ </div>
+<script type="text/javascript">
+
+ var _gaq = _gaq || [];
+ _gaq.push(['_setAccount', 'UA-25976949-1']);
+ _gaq.push(['_setDomainName', 'tizen.org']);
+ _gaq.push(['_trackPageview']);
+
+ (function() {
+ var ga = document.createElement('script'); ga.type = 'text/javascript'; ga.async = true;
+ var s = document.getElementsByTagName('script')[0]; s.parentNode.insertBefore(ga, s);
+ })();
+
+ </script>
+</div>
+</body>
+</html>
--- /dev/null
+<!DOCTYPE html PUBLIC "html">
+<html>
+<head>
+<meta http-equiv="Content-Type" content="text/html; charset=utf-8">
+<link rel="stylesheet" type="text/css" href="../tizen.css" media="screen">
+<script type="text/javascript" src="snippet.js"></script><title>DeviceMotion API</title>
+</head>
+<body id="page-content" onload="prettyPrint()">
+<div class="api" id="::DeviceMotion">
+<div class="supported-platforms"><img class="wearable-mandatory emulator" title="Mandatory, Supported by Tizen Wearable emulator" src="../wearable_s_w.png"></div>
+<div class="title"><h1>DeviceMotion API</h1></div>
+<div class="brief">
+ This plugin provides access to the device's accelerometer. The accelerometer is a motion sensor that detects the change (delta) in movement relative to the current device orientation, in three dimensions along the x, y, and z axis.
+ </div>
+<div class="description">
+ <p>
+Original documentation: <a href="https://cordova.apache.org/docs/en/3.0.0/cordova/accelerometer/accelerometer.html">Cordova Accelerometer</a>.
+ </p>
+ </div>
+<h2>Table of Contents</h2>
+<ul class="toc">
+<li>1. <a href="#interfaces-section">Interfaces</a><ul class="toc">
+<li>1.1. <a href="#AccelerometerManagerObject">AccelerometerManagerObject</a>
+</li>
+<li>1.2. <a href="#Accelerometer">Accelerometer</a>
+</li>
+<li>1.3. <a href="#Acceleration">Acceleration</a>
+</li>
+<li>1.4. <a href="#AccelerationOptions">AccelerationOptions</a>
+</li>
+<li>1.5. <a href="#AccelerometerSuccessCallback">AccelerometerSuccessCallback</a>
+</li>
+</ul>
+</li>
+<li>2. <a href="#api-features">Related Feature</a>
+</li>
+<li>3. <a href="#full-webidl">Full WebIDL</a>
+</li>
+</ul>
+<hr>
+<h2 id="method-summary">Summary of Interfaces and Methods</h2>
+<table class="informaltable">
+<thead><tr>
+<th>Interface</th>
+<th>Method</th>
+</tr></thead>
+<tbody>
+<tr>
+<td><a href="#AccelerometerManagerObject">AccelerometerManagerObject</a></td>
+<td></td>
+</tr>
+<tr>
+<td><a href="#Accelerometer">Accelerometer</a></td>
+<td>
+<div>void <a href="#Accelerometer::getCurrentAcceleration">getCurrentAcceleration</a> (<a href="#AccelerometerSuccessCallback">AccelerometerSuccessCallback</a> onsuccess, <a href="cordova.html#ErrorCallback">ErrorCallback</a><a href="file.html#ErrorCallback">ErrorCallback</a> onerror)</div>
+<div>DOMString <a href="#Accelerometer::watchAcceleration">watchAcceleration</a> (<a href="#AccelerometerSuccessCallback">AccelerometerSuccessCallback</a> onsuccess, <a href="cordova.html#ErrorCallback">ErrorCallback</a><a href="file.html#ErrorCallback">ErrorCallback</a> onerror, optional <a href="#AccelerationOptions">AccelerationOptions</a>? options)</div>
+<div>void <a href="#Accelerometer::clearWatch">clearWatch</a> (DOMString watchID)</div>
+</td>
+</tr>
+<tr>
+<td><a href="#Acceleration">Acceleration</a></td>
+<td></td>
+</tr>
+<tr>
+<td><a href="#AccelerationOptions">AccelerationOptions</a></td>
+<td></td>
+</tr>
+<tr>
+<td><a href="#AccelerometerSuccessCallback">AccelerometerSuccessCallback</a></td>
+<td><div>void <a href="#AccelerometerSuccessCallback::onsuccess">onsuccess</a> (<a href="#Acceleration">Acceleration</a> acceleration)</div></td>
+</tr>
+</tbody>
+</table>
+<div class="interfaces" id="interfaces-section">
+<h2>1. Interfaces</h2>
+<div class="interface" id="AccelerometerManagerObject">
+<a class="backward-compatibility-anchor" name="::DeviceMotion::AccelerometerManagerObject"></a><h3>1.1. AccelerometerManagerObject</h3>
+<div class="brief">
+ The <em>navigator.accelerometer </em>object allows access to the functionality of the DeviceMotion API.
+ </div>
+<pre class="webidl prettyprint"> [NoInterfaceObject] interface AccelerometerManagerObject {
+ readonly attribute <a href="#Accelerometer">Accelerometer</a> accelerometer;
+ };</pre>
+<pre class="webidl prettyprint"> implements <a href="#AccelerometerManagerObject">AccelerometerManagerObject</a>;</pre>
+</div>
+<div class="interface" id="Accelerometer">
+<a class="backward-compatibility-anchor" name="::DeviceMotion::Accelerometer"></a><h3>1.2. Accelerometer</h3>
+<div class="brief">
+ The Accelerometer object captures device motion in the x, y, and z direction.
+ </div>
+<pre class="webidl prettyprint"> [NoInterfaceObject] interface Accelerometer {
+ void getCurrentAcceleration(<a href="#AccelerometerSuccessCallback">AccelerometerSuccessCallback</a> onsuccess, <a href="cordova.html#ErrorCallback">ErrorCallback</a><a href="file.html#ErrorCallback">ErrorCallback</a> onerror);
+
+ DOMString watchAcceleration(<a href="#AccelerometerSuccessCallback">AccelerometerSuccessCallback</a> onsuccess, <a href="cordova.html#ErrorCallback">ErrorCallback</a><a href="file.html#ErrorCallback">ErrorCallback</a> onerror, optional <a href="#AccelerationOptions">AccelerationOptions</a>? options);
+
+ void clearWatch(DOMString watchID);
+
+ };</pre>
+<div class="methods">
+<h4>Methods</h4>
+<dl>
+<dt class="method" id="Accelerometer::getCurrentAcceleration">
+<a class="backward-compatibility-anchor" name="::DeviceMotion::Accelerometer::getCurrentAcceleration"></a><code><b><span class="methodName">getCurrentAcceleration</span></b></code>
+</dt>
+<dd>
+<div class="brief">
+ Gets the current acceleration along the x, y, and z axes.
+ </div>
+<div class="synopsis"><pre class="signature prettyprint">void getCurrentAcceleration(<a href="#AccelerometerSuccessCallback">AccelerometerSuccessCallback</a> onsuccess, <a href="cordova.html#ErrorCallback">ErrorCallback</a><a href="file.html#ErrorCallback">ErrorCallback</a> onerror);
+ </pre></div>
+<p><span class="version">
+ Since: </span>
+ 3.0
+ </p>
+<div class="parameters">
+<p><span class="param">Parameters:</span></p>
+<ul>
+ <li class="param">
+<span class="name">onsuccess</span>:
+ The callback method to be invoked with current acceleration values.
+ </li>
+ <li class="param">
+<span class="name">onerror</span>:
+ The callback method called when errors occur
+ </li>
+ </ul>
+</div>
+<div class="exceptionlist">
+<p><span class="except">Exceptions:</span></p>
+ <ul class="exception"><li>TypeError<ul><li class="list"><p>
+ if any of the input parameters contains an invalid value.
+ </p></li></ul>
+</li></ul>
+ </div>
+<div class="example">
+<span class="example"><p>Code example:</p></span><pre name="code" class="examplecode prettyprint"> function onSuccess(acceleration) {
+ console.log('Acceleration X: ' + acceleration.x + '\n' +
+ 'Acceleration Y: ' + acceleration.y + '\n' +
+ 'Acceleration Z: ' + acceleration.z + '\n' +
+ 'Timestamp: ' + acceleration.timestamp);
+ };
+
+ function onError() {
+ console.log('onError!');
+ };
+
+ navigator.accelerometer.getCurrentAcceleration(onSuccess, onError);
+ </pre>
+</div>
+<div class="output">
+<span class="title"><p>Output example:</p></span><pre>Acceleration X: 0.00
+Acceleration Y: 0.00
+Acceleration Z: 9.82
+Timestamp: 1456480118000
+</pre>
+</div>
+</dd>
+<dt class="method" id="Accelerometer::watchAcceleration">
+<a class="backward-compatibility-anchor" name="::DeviceMotion::Accelerometer::watchAcceleration"></a><code><b><span class="methodName">watchAcceleration</span></b></code>
+</dt>
+<dd>
+<div class="brief">
+ Gets the acceleration along the x, y, and z axes at a regular interval.
+ </div>
+<div class="synopsis"><pre class="signature prettyprint">DOMString watchAcceleration(<a href="#AccelerometerSuccessCallback">AccelerometerSuccessCallback</a> onsuccess, <a href="cordova.html#ErrorCallback">ErrorCallback</a><a href="file.html#ErrorCallback">ErrorCallback</a> onerror, optional <a href="#AccelerationOptions">AccelerationOptions</a>? options);
+ </pre></div>
+<p><span class="version">
+ Since: </span>
+ 3.0
+ </p>
+<div class="parameters">
+<p><span class="param">Parameters:</span></p>
+<ul>
+ <li class="param">
+<span class="name">onsuccess</span>:
+ The callback method to be invoked with current acceleration values.
+ </li>
+ <li class="param">
+<span class="name">onerror</span>:
+ The callback method called when errors occur
+ </li>
+ <li class="param">
+<span class="name">options</span><span class="optional"> [optional]</span><span class="optional"> [nullable]</span>:
+ Specifies the interval of calling successcallback in miliseconds. If not provided, default value for frequency is 10000 (10 seconds).
+ </li>
+ </ul>
+</div>
+<div class="returntype">
+<p><span class="return">Return value:</span></p>
+ DOMString The watch id that must be passed to <a href="device-motion.html#Accelerometer::clearWatch">clearWatch</a> to stop watching.
+ </div>
+<div class="exceptionlist">
+<p><span class="except">Exceptions:</span></p>
+ <ul class="exception"><li>TypeError<ul><li class="list"><p>
+ if any of the input parameters contains an invalid value.
+ </p></li></ul>
+</li></ul>
+ </div>
+<div class="example">
+<span class="example"><p>Code example:</p></span><pre name="code" class="examplecode prettyprint"> function onSuccess(acceleration) {
+ console.log('Acceleration X: ' + acceleration.x + '\n' +
+ 'Acceleration Y: ' + acceleration.y + '\n' +
+ 'Acceleration Z: ' + acceleration.z + '\n' +
+ 'Timestamp: ' + acceleration.timestamp);
+ console.log('Please wait 3 seconds for the next measurement...');
+ };
+
+ function onError() {
+ console.log('onError!');
+ };
+
+ var options = { frequency: 3000 }; // Update every 3 seconds
+
+ var watchID = navigator.accelerometer.watchAcceleration(onSuccess, onError, options);
+ </pre>
+</div>
+<div class="output">
+<span class="title"><p>Output example:</p></span><pre>Acceleration X: 0.00
+Acceleration Y: 0.00
+Acceleration Z: 9.82
+Timestamp: 1456480118000
+Please wait 3 seconds for the next measurement...
+Acceleration X: 0.00
+Acceleration Y: 0.00
+Acceleration Z: 9.82
+Timestamp: 1456480121000
+Please wait 3 seconds for the next measurement...
+(...)
+</pre>
+</div>
+</dd>
+<dt class="method" id="Accelerometer::clearWatch">
+<a class="backward-compatibility-anchor" name="::DeviceMotion::Accelerometer::clearWatch"></a><code><b><span class="methodName">clearWatch</span></b></code>
+</dt>
+<dd>
+<div class="brief">
+ Stop watching the Acceleration referenced by the watchID parameter.
+ </div>
+<div class="synopsis"><pre class="signature prettyprint">void clearWatch(DOMString watchID);
+ </pre></div>
+<p><span class="version">
+ Since: </span>
+ 3.0
+ </p>
+<div class="parameters">
+<p><span class="param">Parameters:</span></p>
+<ul>
+ <li class="param">
+<span class="name">watchID</span>:
+ The id of the watch returned from <a href="device-motion.html#Accelerometer::watchAcceleration">watchAcceleration</a>.
+ </li>
+ </ul>
+</div>
+<div class="exceptionlist">
+<p><span class="except">Exceptions:</span></p>
+ <ul class="exception"><li>TypeError<ul><li class="list"><p>
+ if any of the input parameters contains an invalid value.
+ </p></li></ul>
+</li></ul>
+ </div>
+<div class="example">
+<span class="example"><p>Code example:</p></span><pre name="code" class="examplecode prettyprint"> var counter = 0, watchID;
+
+ function onSuccess(acceleration) {
+ console.log('Acceleration X: ' + acceleration.x + '\n' +
+ 'Acceleration Y: ' + acceleration.y + '\n' +
+ 'Acceleration Z: ' + acceleration.z + '\n' +
+ 'Timestamp: ' + acceleration.timestamp);
+ if(3 == ++counter) {
+ navigator.accelerometer.clearWatch(watchID);
+ }
+ };
+
+ function onError() {
+ console.log('onError!');
+ };
+
+ var options = { frequency: 30 }; // Update every 0.03 seconds
+
+ watchID = navigator.accelerometer.watchAcceleration(onSuccess, onError, options);
+ </pre>
+</div>
+<div class="output">
+<span class="title"><p>Output example:</p></span><pre>Acceleration X: 0.00
+Acceleration Y: 0.00
+Acceleration Z: 9.82
+Timestamp: 1456483774000
+Acceleration X: 0.00
+Acceleration Y: 0.00
+Acceleration Z: 9.82
+Timestamp: 1456483774030
+Acceleration X: 0.00
+Acceleration Y: 0.00
+Acceleration Z: 9.82
+Timestamp: 1456483774060
+</pre>
+</div>
+</dd>
+</dl>
+</div>
+</div>
+<div class="interface" id="Acceleration">
+<a class="backward-compatibility-anchor" name="::DeviceMotion::Acceleration"></a><h3>1.3. Acceleration</h3>
+<div class="brief">
+ Contains Accelerometer data captured at a specific point in time.
+Acceleration values include the effect of gravity (9.81 m/s^2), so that when a device lies flat and facing up, x, y, and z values returned should be 0, 0, and 9.81.
+ </div>
+<pre class="webidl prettyprint"> [NoInterfaceObject] interface Acceleration {
+ readonly attribute double x;
+
+ readonly attribute double y;
+
+ readonly attribute double z;
+
+ readonly attribute long timestamp;
+
+ };</pre>
+<div class="attributes">
+<h4>Attributes</h4>
+<ul>
+<li class="attribute" id="Acceleration::x">
+<span class="attrName"><span class="readonly"> readonly
+</span><span class="type">double </span><span class="name">x</span></span><div class="brief">
+ Amount of acceleration on the x-axis. (in m/s^2)
+ </div>
+<p><span class="version">
+ Since: </span>
+ 3.0
+ </p>
+</li>
+<li class="attribute" id="Acceleration::y">
+<span class="attrName"><span class="readonly"> readonly
+</span><span class="type">double </span><span class="name">y</span></span><div class="brief">
+ Amount of acceleration on the y-axis. (in m/s^2)
+ </div>
+<p><span class="version">
+ Since: </span>
+ 3.0
+ </p>
+</li>
+<li class="attribute" id="Acceleration::z">
+<span class="attrName"><span class="readonly"> readonly
+</span><span class="type">double </span><span class="name">z</span></span><div class="brief">
+ Amount of acceleration on the z-axis. (in m/s^2)
+ </div>
+<p><span class="version">
+ Since: </span>
+ 3.0
+ </p>
+</li>
+<li class="attribute" id="Acceleration::timestamp">
+<span class="attrName"><span class="readonly"> readonly
+</span><span class="type">long </span><span class="name">timestamp</span></span><div class="brief">
+ Creation timestamp in milliseconds.
+ </div>
+<p><span class="version">
+ Since: </span>
+ 3.0
+ </p>
+</li>
+</ul>
+</div>
+</div>
+<div class="dictionary" id="AccelerationOptions">
+<a class="backward-compatibility-anchor" name="::DeviceMotion::AccelerationOptions"></a><h3>1.4. AccelerationOptions</h3>
+<div class="brief">
+ An optional parameter to customize the retrieval of accelerometer values.
+ </div>
+<pre class="webidl prettyprint"> dictionary AccelerationOptions {
+ long frequency;
+ };</pre>
+<div class="attributes">
+<h4>Dictionary members</h4>
+<dl>
+<dt class="member" id="AccelerationOptions::frequency"><span class="attrName">long frequency</span></dt>
+<dd>
+<div class="brief">
+ Interval defining how often to retrieve Acceleration in milliseconds.
+ </div>
+<p><span class="version">
+ Since: </span>
+ 3.0
+ </p>
+</dd>
+</dl>
+</div>
+</div>
+<div class="interface" id="AccelerometerSuccessCallback">
+<a class="backward-compatibility-anchor" name="::DeviceMotion::AccelerometerSuccessCallback"></a><h3>1.5. AccelerometerSuccessCallback</h3>
+<div class="brief">
+ The AccelerometerSuccessCallback interface provides a SuccessCallback for the getCurrentAcceleration and watchAcceleration methods.
+ </div>
+<pre class="webidl prettyprint"> [Callback=FunctionOnly, NoInterfaceObject] interface AccelerometerSuccessCallback {
+ void onsuccess(<a href="#Acceleration">Acceleration</a> acceleration);
+ };</pre>
+<div class="methods">
+<h4>Methods</h4>
+<dl>
+<dt class="method" id="AccelerometerSuccessCallback::onsuccess">
+<a class="backward-compatibility-anchor" name="::DeviceMotion::AccelerometerSuccessCallback::onsuccess"></a><code><b><span class="methodName">onsuccess</span></b></code>
+</dt>
+<dd>
+<div class="synopsis"><pre class="signature prettyprint">void onsuccess(<a href="#Acceleration">Acceleration</a> acceleration);
+ </pre></div>
+<p><span class="version">
+ Since: </span>
+ 3.0
+ </p>
+<div class="parameters">
+<p><span class="param">Parameters:</span></p>
+<ul>
+ <li class="param">
+<span class="name">acceleration</span>:
+ The acceleration at a single moment in time.
+ </li>
+ </ul>
+</div>
+</dd>
+</dl>
+</div>
+</div>
+</div>
+<h2 id="api-features">2. Related Feature</h2>
+<div id="def-api-features" class="def-api-features">
+ You can check if this API is supported with <em>tizen.systeminfo.getCapability()</em> and decide enable/disable codes that need this API.
+ <div class="def-api-feature">
+<p><div class="description">
+ <p>
+To guarantee that the DeviceMotion application runs on a device with the DeviceMotion feature declare the following feature requirements in the config file:
+ </p>
+ </div></p>
+<li class="feature">http://tizen.org/feature/sensor.accelerometer</li>
+</div>
+<p></p>
+ For more information, see <a href="../../org.tizen.gettingstarted/html/tizen_overview/application_filtering.htm">Application Filtering.</a>
+</div>
+<h2 id="full-webidl">3. Full WebIDL</h2>
+<pre class="webidl prettyprint">module DeviceMotion {
+ [NoInterfaceObject] interface AccelerometerManagerObject {
+ readonly attribute <a href="#Accelerometer">Accelerometer</a> accelerometer;
+ };
+ implements <a href="#AccelerometerManagerObject">AccelerometerManagerObject</a>;
+ [NoInterfaceObject] interface Accelerometer {
+ void getCurrentAcceleration(<a href="#AccelerometerSuccessCallback">AccelerometerSuccessCallback</a> onsuccess, <a href="cordova.html#ErrorCallback">ErrorCallback</a><a href="file.html#ErrorCallback">ErrorCallback</a> onerror);
+
+ DOMString watchAcceleration(<a href="#AccelerometerSuccessCallback">AccelerometerSuccessCallback</a> onsuccess, <a href="cordova.html#ErrorCallback">ErrorCallback</a><a href="file.html#ErrorCallback">ErrorCallback</a> onerror, optional <a href="#AccelerationOptions">AccelerationOptions</a>? options);
+
+ void clearWatch(DOMString watchID);
+
+ };
+
+ [NoInterfaceObject] interface Acceleration {
+ readonly attribute double x;
+
+ readonly attribute double y;
+
+ readonly attribute double z;
+
+ readonly attribute long timestamp;
+
+ };
+
+ dictionary AccelerationOptions {
+ long frequency;
+ };
+
+ [Callback=FunctionOnly, NoInterfaceObject] interface AccelerometerSuccessCallback {
+ void onsuccess(<a href="#Acceleration">Acceleration</a> acceleration);
+ };
+
+};</pre>
+</div>
+<div id="page-footer">
+<div class="copyright" align="center">
+ Except as noted, this content - excluding the Code Examples - is licensed under <a href="http://creativecommons.org/licenses/by/3.0/legalcode" target="_blank">Creative Commons Attribution 3.0</a> and all of the Code Examples contained herein are licensed under <a href="https://www.tizen.org/bsd-3-clause-license" target="_blank">BSD-3-Clause</a>. <br>For details, see the <a href="https://www.tizen.org/content-license" target="_blank">Content License</a>.
+ </div>
+<script type="text/javascript">
+
+ var _gaq = _gaq || [];
+ _gaq.push(['_setAccount', 'UA-25976949-1']);
+ _gaq.push(['_setDomainName', 'tizen.org']);
+ _gaq.push(['_trackPageview']);
+
+ (function() {
+ var ga = document.createElement('script'); ga.type = 'text/javascript'; ga.async = true;
+ var s = document.getElementsByTagName('script')[0]; s.parentNode.insertBefore(ga, s);
+ })();
+
+ </script>
+</div>
+</body>
+</html>
--- /dev/null
+<!DOCTYPE html PUBLIC "html">
+<html>
+<head>
+<meta http-equiv="Content-Type" content="text/html; charset=utf-8">
+<link rel="stylesheet" type="text/css" href="../tizen.css" media="screen">
+<script type="text/javascript" src="snippet.js"></script><title>Device API</title>
+</head>
+<body id="page-content" onload="prettyPrint()">
+<div class="api" id="::Device">
+<div class="supported-platforms"><img class="wearable-mandatory emulator" title="Mandatory, Supported by Tizen Wearable emulator" src="../wearable_s_w.png"></div>
+<div class="title"><h1>Device API</h1></div>
+<div class="brief">
+ This plugin defines a global device object, which describes the device's hardware and software.
+Although the object is in the global scope, it is not available until the deviceready event.
+ </div>
+<div class="description">
+ <p>
+Original documentation: <a href="https://cordova.apache.org/docs/en/3.0.0/cordova/device/device.html">Cordova Device</a>.
+ </p>
+ </div>
+<p><span class="version">
+ Since: </span>
+ 3.0
+ </p>
+<h2>Table of Contents</h2>
+<ul class="toc">
+<li>1. <a href="#interfaces-section">Interfaces</a><ul class="toc">
+<li>1.1. <a href="#DeviceManagerObject">DeviceManagerObject</a>
+</li>
+<li>1.2. <a href="#Device">Device</a>
+</li>
+</ul>
+</li>
+<li>2. <a href="#full-webidl">Full WebIDL</a>
+</li>
+</ul>
+<hr>
+<h2 id="method-summary">Summary of Interfaces and Methods</h2>
+<table class="informaltable">
+<thead><tr>
+<th>Interface</th>
+<th>Method</th>
+</tr></thead>
+<tbody>
+<tr>
+<td><a href="#DeviceManagerObject">DeviceManagerObject</a></td>
+<td></td>
+</tr>
+<tr>
+<td><a href="#Device">Device</a></td>
+<td></td>
+</tr>
+</tbody>
+</table>
+<div class="interfaces" id="interfaces-section">
+<h2>1. Interfaces</h2>
+<div class="interface" id="DeviceManagerObject">
+<a class="backward-compatibility-anchor" name="::Device::DeviceManagerObject"></a><h3>1.1. DeviceManagerObject</h3>
+<div class="brief">
+ The <em>window.device </em>object allows access to the functionality of the Device API.
+ </div>
+<pre class="webidl prettyprint"> [NoInterfaceObject] interface DeviceManagerObject {
+ readonly attribute <a href="#Device">Device</a> device;
+ };</pre>
+<pre class="webidl prettyprint"> Window implements <a href="#DeviceManagerObject">DeviceManagerObject</a>;</pre>
+<p><span class="version">
+ Since: </span>
+ 3.0
+ </p>
+</div>
+<div class="interface" id="Device">
+<a class="backward-compatibility-anchor" name="::Device::Device"></a><h3>1.2. Device</h3>
+<div class="brief">
+ The device object describes the device's hardware and software.
+ </div>
+<pre class="webidl prettyprint"> [NoInterfaceObject] interface Device {
+ readonly attribute DOMString cordova;
+
+ readonly attribute DOMString model;
+
+ readonly attribute DOMString platform;
+
+ readonly attribute DOMString uuid;
+
+ readonly attribute DOMString version;
+
+ };</pre>
+<div class="attributes">
+<h4>Attributes</h4>
+<ul>
+<li class="attribute" id="Device::cordova">
+<span class="attrName"><span class="readonly"> readonly
+</span><span class="type">DOMString </span><span class="name">cordova</span></span><div class="brief">
+ Returns the version of Cordova running on the device.
+ </div>
+<div class="example">
+<span class="example"><p>Code example:</p></span><pre name="code" class="examplecode prettyprint"> document.addEventListener('deviceready', onDeviceReady, false);
+
+ function onDeviceReady() {
+ console.log('Device Cordova: ' + device.cordova);
+ }
+ </pre>
+</div>
+<div class="output">
+<span class="title"><p>Output example:</p></span><pre>Device Cordova: 5.1.1
+</pre>
+</div>
+</li>
+<li class="attribute" id="Device::model">
+<span class="attrName"><span class="readonly"> readonly
+</span><span class="type">DOMString </span><span class="name">model</span></span><div class="brief">
+ Get the the name of the device's model or product. The value is set by the device manufacturer and may be different across versions of the same product.
+ </div>
+<div class="example">
+<span class="example"><p>Code example:</p></span><pre name="code" class="examplecode prettyprint"> document.addEventListener('deviceready', onDeviceReady, false);
+
+ function onDeviceReady() {
+ console.log('Device Model: ' + device.model);
+ }
+ </pre>
+</div>
+<div class="output">
+<span class="title"><p>Output example:</p></span><pre>Device Model: tm1
+</pre>
+</div>
+</li>
+<li class="attribute" id="Device::platform">
+<span class="attrName"><span class="readonly"> readonly
+</span><span class="type">DOMString </span><span class="name">platform</span></span><div class="brief">
+ Get the device's operating system name.
+ </div>
+<div class="example">
+<span class="example"><p>Code example:</p></span><pre name="code" class="examplecode prettyprint"> document.addEventListener('deviceready', onDeviceReady, false);
+
+ function onDeviceReady() {
+ console.log('Device Platform: ' + device.platform);
+ }
+ </pre>
+</div>
+<div class="output">
+<span class="title"><p>Output example:</p></span><pre>Device Platform: Tizen
+</pre>
+</div>
+</li>
+<li class="attribute" id="Device::uuid">
+<span class="attrName"><span class="readonly"> readonly
+</span><span class="type">DOMString </span><span class="name">uuid</span></span><div class="brief">
+ Get the device's Universally Unique Identifier (UUID). The details of how a UUID is generated are determined by the device manufacturer and are specific to the device's platform or model.
+ </div>
+<div class="example">
+<span class="example"><p>Code example:</p></span><pre name="code" class="examplecode prettyprint"> document.addEventListener('deviceready', onDeviceReady, false);
+
+ function onDeviceReady() {
+ console.log('Device UUID: ' + device.uuid);
+ }
+ </pre>
+</div>
+<div class="output">
+<span class="title"><p>Output example:</p></span><pre>Device UUID: 2LR1b3MXfEUSFvH04m4e1EXYvQA=
+</pre>
+</div>
+</li>
+<li class="attribute" id="Device::version">
+<span class="attrName"><span class="readonly"> readonly
+</span><span class="type">DOMString </span><span class="name">version</span></span><div class="brief">
+ Get the operating system version.
+ </div>
+<div class="example">
+<span class="example"><p>Code example:</p></span><pre name="code" class="examplecode prettyprint"> document.addEventListener('deviceready', onDeviceReady, false);
+
+ function onDeviceReady() {
+ console.log('Device Version: ' + device.version);
+ }
+ </pre>
+</div>
+<div class="output">
+<span class="title"><p>Output example:</p></span><pre>Device Version: 3.0
+</pre>
+</div>
+</li>
+</ul>
+</div>
+</div>
+</div>
+<h2 id="full-webidl">2. Full WebIDL</h2>
+<pre class="webidl prettyprint">module Device {
+ [NoInterfaceObject] interface DeviceManagerObject {
+ readonly attribute <a href="#Device">Device</a> device;
+ };
+ Window implements <a href="#DeviceManagerObject">DeviceManagerObject</a>;
+ [NoInterfaceObject] interface Device {
+ readonly attribute DOMString cordova;
+
+ readonly attribute DOMString model;
+
+ readonly attribute DOMString platform;
+
+ readonly attribute DOMString uuid;
+
+ readonly attribute DOMString version;
+
+ };
+};</pre>
+</div>
+<div id="page-footer">
+<div class="copyright" align="center">
+ Except as noted, this content - excluding the Code Examples - is licensed under <a href="http://creativecommons.org/licenses/by/3.0/legalcode" target="_blank">Creative Commons Attribution 3.0</a> and all of the Code Examples contained herein are licensed under <a href="https://www.tizen.org/bsd-3-clause-license" target="_blank">BSD-3-Clause</a>. <br>For details, see the <a href="https://www.tizen.org/content-license" target="_blank">Content License</a>.
+ </div>
+<script type="text/javascript">
+
+ var _gaq = _gaq || [];
+ _gaq.push(['_setAccount', 'UA-25976949-1']);
+ _gaq.push(['_setDomainName', 'tizen.org']);
+ _gaq.push(['_trackPageview']);
+
+ (function() {
+ var ga = document.createElement('script'); ga.type = 'text/javascript'; ga.async = true;
+ var s = document.getElementsByTagName('script')[0]; s.parentNode.insertBefore(ga, s);
+ })();
+
+ </script>
+</div>
+</body>
+</html>
--- /dev/null
+<!DOCTYPE html PUBLIC "html">
+<html>
+<head>
+<meta http-equiv="Content-Type" content="text/html; charset=utf-8">
+<link rel="stylesheet" type="text/css" href="../tizen.css" media="screen">
+<script type="text/javascript" src="snippet.js"></script><title>Dialogs API</title>
+</head>
+<body id="page-content" onload="prettyPrint()">
+<div class="api" id="::Dialogs">
+<div class="supported-platforms"><img class="wearable-mandatory emulator" title="Mandatory, Supported by Tizen Wearable emulator" src="../wearable_s_w.png"></div>
+<div class="title"><h1>Dialogs API</h1></div>
+<div class="brief">
+ This plugin provides the ability to make different types of notifications to the user.
+ </div>
+<div class="description">
+ <p>
+Original documentation: <a href="https://www.npmjs.com/package/cordova-plugin-dialogs">Cordova Dialogs</a>.
+ </p>
+ </div>
+<h2>Table of Contents</h2>
+<ul class="toc">
+<li>1. <a href="#interfaces-section">Interfaces</a><ul class="toc">
+<li>1.1. <a href="#DialogsManagerObject">DialogsManagerObject</a>
+</li>
+<li>1.2. <a href="#DialogsManager">DialogsManager</a>
+</li>
+<li>1.3. <a href="#PromptData">PromptData</a>
+</li>
+<li>1.4. <a href="#ConfirmCallback">ConfirmCallback</a>
+</li>
+<li>1.5. <a href="#PromptCallback">PromptCallback</a>
+</li>
+</ul>
+</li>
+<li>2. <a href="#full-webidl">Full WebIDL</a>
+</li>
+</ul>
+<hr>
+<h2 id="method-summary">Summary of Interfaces and Methods</h2>
+<table class="informaltable">
+<thead><tr>
+<th>Interface</th>
+<th>Method</th>
+</tr></thead>
+<tbody>
+<tr>
+<td><a href="#DialogsManagerObject">DialogsManagerObject</a></td>
+<td></td>
+</tr>
+<tr>
+<td><a href="#DialogsManager">DialogsManager</a></td>
+<td>
+<div>void <a href="#DialogsManager::alert">alert</a> (DOMString message, <a href="cordova.html#SuccessCallback">SuccessCallback</a> alertCallback, optional DOMString? title, optional DOMString? buttonName)</div>
+<div>void <a href="#DialogsManager::confirm">confirm</a> (DOMString message, <a href="#ConfirmCallback">ConfirmCallback</a> confirmCallback, optional DOMString? title, optional DOMString[]? buttonNames)</div>
+<div>void <a href="#DialogsManager::prompt">prompt</a> (DOMString message, <a href="#PromptCallback">PromptCallback</a> promptCallback, optional DOMString? title, optional DOMString[]? buttonNames, optional DOMString? defaultText)</div>
+<div>void <a href="#DialogsManager::beep">beep</a> (long times)</div>
+</td>
+</tr>
+<tr>
+<td><a href="#PromptData">PromptData</a></td>
+<td></td>
+</tr>
+<tr>
+<td><a href="#ConfirmCallback">ConfirmCallback</a></td>
+<td><div>void <a href="#ConfirmCallback::onsuccess">onsuccess</a> (long buttonIndex)</div></td>
+</tr>
+<tr>
+<td><a href="#PromptCallback">PromptCallback</a></td>
+<td><div>void <a href="#PromptCallback::onsuccess">onsuccess</a> (<a href="#PromptData">PromptData</a> data)</div></td>
+</tr>
+</tbody>
+</table>
+<div class="interfaces" id="interfaces-section">
+<h2>1. Interfaces</h2>
+<div class="interface" id="DialogsManagerObject">
+<a class="backward-compatibility-anchor" name="::Dialogs::DialogsManagerObject"></a><h3>1.1. DialogsManagerObject</h3>
+<div class="brief">
+ The <em>DialogsManagerObject</em> interface defines what is instantiated in the <em>Navigator</em> object.
+ </div>
+<pre class="webidl prettyprint"> [NoInterfaceObject] interface DialogsManagerObject {
+ readonly attribute <a href="#DialogsManager">DialogsManager</a> notification;
+ };</pre>
+<pre class="webidl prettyprint"> implements <a href="#DialogsManagerObject">DialogsManagerObject</a>;</pre>
+<div class="description">
+ <p>
+The <em>navigator.notification</em> object allows access to the Dialogs API.
+ </p>
+ </div>
+</div>
+<div class="interface" id="DialogsManager">
+<a class="backward-compatibility-anchor" name="::Dialogs::DialogsManager"></a><h3>1.2. DialogsManager</h3>
+<div class="brief">
+ The <em>DialogsManager</em> interface provides methods for global operations related to notifications to the user.
+ </div>
+<pre class="webidl prettyprint"> [NoInterfaceObject] interface DialogsManager {
+ void alert(DOMString message, <a href="cordova.html#SuccessCallback">SuccessCallback</a> alertCallback, optional DOMString? title, optional DOMString? buttonName);
+
+ void confirm(DOMString message, <a href="#ConfirmCallback">ConfirmCallback</a> confirmCallback, optional DOMString? title, optional DOMString[]? buttonNames);
+
+ void prompt(DOMString message, <a href="#PromptCallback">PromptCallback</a> promptCallback,
+ optional DOMString? title, optional DOMString[]? buttonNames, optional DOMString? defaultText);
+
+ void beep(long times);
+ };</pre>
+<div class="methods">
+<h4>Methods</h4>
+<dl>
+<dt class="method" id="DialogsManager::alert">
+<a class="backward-compatibility-anchor" name="::Dialogs::DialogsManager::alert"></a><code><b><span class="methodName">alert</span></b></code>
+</dt>
+<dd>
+<div class="brief">
+ Shows a custom alert with one button.
+ </div>
+<div class="synopsis"><pre class="signature prettyprint">void alert(DOMString message, <a href="cordova.html#SuccessCallback">SuccessCallback</a> alertCallback, optional DOMString? title, optional DOMString? buttonName);
+ </pre></div>
+<p><span class="version">
+ Since: </span>
+ 3.0
+ </p>
+<div class="parameters">
+<p><span class="param">Parameters:</span></p>
+<ul>
+ <li class="param">
+<span class="name">message</span>:
+ The message to be shown to the user by dialog dialog.
+ </li>
+ <li class="param">
+<span class="name">alertCallback</span>:
+ The callback to be invoked when alert dialog would be dismissed.
+ </li>
+ <li class="param">
+<span class="name">title</span><span class="optional"> [optional]</span><span class="optional"> [nullable]</span>:
+ The title of dialog box. Default value is 'Dialog'.
+ </li>
+ <li class="param">
+<span class="name">buttonName</span><span class="optional"> [optional]</span><span class="optional"> [nullable]</span>:
+ Button name to be shown on dialog box. Default value is 'OK'.
+ </li>
+ </ul>
+</div>
+<div class="example">
+<span class="example"><p>Code example:</p></span><pre name="code" class="examplecode prettyprint"> var alertDismissed = function() {
+ console.log('Alert was dismissed');
+ }
+
+ navigator.notification.alert('Please click OK button', alertDismissed,
+ 'OK click alert', 'OK');
+ </pre>
+</div>
+<div class="output">
+<span class="title"><p>Output example:</p></span><pre>Alert was dismissed
+</pre>
+</div>
+</dd>
+<dt class="method" id="DialogsManager::confirm">
+<a class="backward-compatibility-anchor" name="::Dialogs::DialogsManager::confirm"></a><code><b><span class="methodName">confirm</span></b></code>
+</dt>
+<dd>
+<div class="brief">
+ Shows a custom confirm box with set of buttons.
+ </div>
+<div class="synopsis"><pre class="signature prettyprint">void confirm(DOMString message, <a href="#ConfirmCallback">ConfirmCallback</a> confirmCallback, optional DOMString? title, optional DOMString[]? buttonNames);
+ </pre></div>
+<p><span class="version">
+ Since: </span>
+ 3.0
+ </p>
+<div class="parameters">
+<p><span class="param">Parameters:</span></p>
+<ul>
+ <li class="param">
+<span class="name">message</span>:
+ The message to be shown to the user by dialog box.
+ </li>
+ <li class="param">
+<span class="name">confirmCallback</span>:
+ The callback to be invoked when user perform an action on dialog box.
+Callback provides index of button pressed (1,2,3 etc.) or 0, if dialog was dismissed without button press.
+ </li>
+ <li class="param">
+<span class="name">title</span><span class="optional"> [optional]</span><span class="optional"> [nullable]</span>:
+ The title of dialog box. Default value is 'Confirm'.
+ </li>
+ <li class="param">
+<span class="name">buttonNames</span><span class="optional"> [optional]</span><span class="optional"> [nullable]</span>:
+ Button names to be shown on dialog box. Default values are ['OK', 'Cancel'].
+ </li>
+ </ul>
+</div>
+<div class="example">
+<span class="example"><p>Code example:</p></span><pre name="code" class="examplecode prettyprint"> var confirmCallback = function(buttonIndex) {
+ console.log('Selected option was ' + buttonIndex);
+ }
+
+ navigator.notification.confirm('Choose one option', confirmCallback,
+ 'Options', ['Option1', 'Option2']);
+ </pre>
+</div>
+<div class="output">
+<span class="title"><p>Output example:</p></span><pre>Selected option was 1
+</pre>
+</div>
+</dd>
+<dt class="method" id="DialogsManager::prompt">
+<a class="backward-compatibility-anchor" name="::Dialogs::DialogsManager::prompt"></a><code><b><span class="methodName">prompt</span></b></code>
+</dt>
+<dd>
+<div class="brief">
+ Shows a custom confirm box with set of buttons.
+ </div>
+<div class="synopsis"><pre class="signature prettyprint">void prompt(DOMString message, <a href="#PromptCallback">PromptCallback</a> promptCallback, optional DOMString? title, optional DOMString[]? buttonNames, optional DOMString? defaultText);
+ </pre></div>
+<p><span class="version">
+ Since: </span>
+ 3.0
+ </p>
+<div class="parameters">
+<p><span class="param">Parameters:</span></p>
+<ul>
+ <li class="param">
+<span class="name">message</span>:
+ The message to be shown to the user by dialog box.
+ </li>
+ <li class="param">
+<span class="name">promptCallback</span>:
+ The callback to be invoked when user perform an action on dialog box.
+Callback provides <em>PromptData</em> object, which holds all data provided by user.
+ </li>
+ <li class="param">
+<span class="name">title</span><span class="optional"> [optional]</span><span class="optional"> [nullable]</span>:
+ The title of dialog box. Default value is 'Prompt'.
+ </li>
+ <li class="param">
+<span class="name">buttonNames</span><span class="optional"> [optional]</span><span class="optional"> [nullable]</span>:
+ Button names to be shown on dialog box. Default values are ['OK', 'Cancel'].
+ </li>
+ <li class="param">
+<span class="name">defaultText</span><span class="optional"> [optional]</span><span class="optional"> [nullable]</span>:
+ Default text to be shown in textbox of dialog box. Default value is an empty string ('').
+ </li>
+ </ul>
+</div>
+<div class="example">
+<span class="example"><p>Code example:</p></span><pre name="code" class="examplecode prettyprint"> var promptCallback = function(results) {
+ console.log('Hello ' + results.input1 + ', you selected option ' + results.buttonIndex);
+ }
+
+ navigator.notification.prompt('Please enter your name',
+ promptCallback,
+ 'Registration Box',
+ ['Ok', 'Exit'],
+ 'e.g. Jane Doe');
+ </pre>
+</div>
+<div class="output">
+<span class="title"><p>Output example:</p></span><pre>Hello Jane Doe, you selected option 1
+</pre>
+</div>
+</dd>
+<dt class="method" id="DialogsManager::beep">
+<a class="backward-compatibility-anchor" name="::Dialogs::DialogsManager::beep"></a><code><b><span class="methodName">beep</span></b></code>
+</dt>
+<dd>
+<div class="brief">
+ Method allows to make custom number of beeps by device.
+ </div>
+<div class="synopsis"><pre class="signature prettyprint">void beep(long times);
+ </pre></div>
+<p><span class="version">
+ Since: </span>
+ 3.0
+ </p>
+<div class="parameters">
+<p><span class="param">Parameters:</span></p>
+<ul>
+ <li class="param">
+<span class="name">times</span>:
+ The number of times to repeat the beep.
+ </li>
+ </ul>
+</div>
+<div class="example">
+<span class="example"><p>Code example:</p></span><pre name="code" class="examplecode prettyprint"> var times = 2;
+ console.log('Device would beep ' + times + ' times');
+ navigator.notification.beep(times);
+ </pre>
+</div>
+<div class="output">
+<span class="title"><p>Output example:</p></span><pre>Device would beep 2 times
+</pre>
+</div>
+</dd>
+</dl>
+</div>
+</div>
+<div class="interface" id="PromptData">
+<a class="backward-compatibility-anchor" name="::Dialogs::PromptData"></a><h3>1.3. PromptData</h3>
+<div class="brief">
+ The object returned from prompt dialog.
+ </div>
+<pre class="webidl prettyprint"> [NoInterfaceObject] interface PromptData {
+ readonly attribute long buttonIndex;
+
+ readonly attribute DOMString input1;
+ };</pre>
+<p><span class="remark"> Remark : </span>
+ Example usage is described on method <a href="#DialogsManager::prompt">prompt</a>.
+ </p>
+<div class="attributes">
+<h4>Attributes</h4>
+<ul>
+<li class="attribute" id="PromptData::buttonIndex">
+<span class="attrName"><span class="readonly"> readonly
+</span><span class="type">long </span><span class="name">buttonIndex</span></span><div class="brief">
+ The index of button, which was pressed by user.
+the index uses one-based indexing, so the values could be 1, 2, 3, etc.
+ </div>
+<p><span class="version">
+ Since: </span>
+ 3.0
+ </p>
+</li>
+<li class="attribute" id="PromptData::input1">
+<span class="attrName"><span class="readonly"> readonly
+</span><span class="type">DOMString </span><span class="name">input1</span></span><div class="brief">
+ The text entered by user in the prompt of dialog box.
+ </div>
+<p><span class="version">
+ Since: </span>
+ 3.0
+ </p>
+</li>
+</ul>
+</div>
+</div>
+<div class="interface" id="ConfirmCallback">
+<a class="backward-compatibility-anchor" name="::Dialogs::ConfirmCallback"></a><h3>1.4. ConfirmCallback</h3>
+<div class="brief">
+ The callback function used to return index of pressed button of confirm dialog.
+ </div>
+<pre class="webidl prettyprint"> [Callback=FunctionOnly, NoInterfaceObject] interface ConfirmCallback {
+ void onsuccess(long buttonIndex);
+ };</pre>
+<p><span class="remark"> Remark : </span>
+ Example usage is described on method <a href="#DialogsManager::confirm">confirm</a>.
+ </p>
+<div class="methods">
+<h4>Methods</h4>
+<dl>
+<dt class="method" id="ConfirmCallback::onsuccess">
+<a class="backward-compatibility-anchor" name="::Dialogs::ConfirmCallback::onsuccess"></a><code><b><span class="methodName">onsuccess</span></b></code>
+</dt>
+<dd>
+<div class="brief">
+ Called when the user perform action on confirm dialog.
+ </div>
+<div class="synopsis"><pre class="signature prettyprint">void onsuccess(long buttonIndex);
+ </pre></div>
+<p><span class="version">
+ Since: </span>
+ 3.0
+ </p>
+<div class="parameters">
+<p><span class="param">Parameters:</span></p>
+<ul>
+ <li class="param">
+<span class="name">buttonIndex</span>:
+ The index of button, which was pressed by user.
+the index uses one-based indexing, so the values could be 1, 2, 3, etc.
+ </li>
+ </ul>
+</div>
+</dd>
+</dl>
+</div>
+</div>
+<div class="interface" id="PromptCallback">
+<a class="backward-compatibility-anchor" name="::Dialogs::PromptCallback"></a><h3>1.5. PromptCallback</h3>
+<div class="brief">
+ The callback function used to return data from prompt dialog.
+ </div>
+<pre class="webidl prettyprint"> [Callback=FunctionOnly, NoInterfaceObject] interface PromptCallback {
+ void onsuccess(<a href="#PromptData">PromptData</a> data);
+ };</pre>
+<p><span class="remark"> Remark : </span>
+ Example usage is described on method <a href="#DialogsManager::prompt">prompt</a>.
+ </p>
+<div class="methods">
+<h4>Methods</h4>
+<dl>
+<dt class="method" id="PromptCallback::onsuccess">
+<a class="backward-compatibility-anchor" name="::Dialogs::PromptCallback::onsuccess"></a><code><b><span class="methodName">onsuccess</span></b></code>
+</dt>
+<dd>
+<div class="brief">
+ Called when the user perform action on prompt dialog.
+ </div>
+<div class="synopsis"><pre class="signature prettyprint">void onsuccess(<a href="#PromptData">PromptData</a> data);
+ </pre></div>
+<p><span class="version">
+ Since: </span>
+ 3.0
+ </p>
+<div class="parameters">
+<p><span class="param">Parameters:</span></p>
+<ul>
+ <li class="param">
+<span class="name">data</span>:
+ The data input into dialog box.
+ </li>
+ </ul>
+</div>
+</dd>
+</dl>
+</div>
+</div>
+</div>
+<h2 id="full-webidl">2. Full WebIDL</h2>
+<pre class="webidl prettyprint">module Dialogs {
+ [NoInterfaceObject] interface DialogsManagerObject {
+ readonly attribute <a href="#DialogsManager">DialogsManager</a> notification;
+ };
+
+ implements <a href="#DialogsManagerObject">DialogsManagerObject</a>;
+
+ [NoInterfaceObject] interface DialogsManager {
+ void alert(DOMString message, <a href="cordova.html#SuccessCallback">SuccessCallback</a> alertCallback, optional DOMString? title, optional DOMString? buttonName);
+
+ void confirm(DOMString message, <a href="#ConfirmCallback">ConfirmCallback</a> confirmCallback, optional DOMString? title, optional DOMString[]? buttonNames);
+
+ void prompt(DOMString message, <a href="#PromptCallback">PromptCallback</a> promptCallback,
+ optional DOMString? title, optional DOMString[]? buttonNames, optional DOMString? defaultText);
+
+ void beep(long times);
+ };
+
+ [NoInterfaceObject] interface PromptData {
+ readonly attribute long buttonIndex;
+
+ readonly attribute DOMString input1;
+ };
+
+ [Callback=FunctionOnly, NoInterfaceObject] interface ConfirmCallback {
+ void onsuccess(long buttonIndex);
+ };
+
+ [Callback=FunctionOnly, NoInterfaceObject] interface PromptCallback {
+ void onsuccess(<a href="#PromptData">PromptData</a> data);
+ };
+
+};</pre>
+</div>
+<div id="page-footer">
+<div class="copyright" align="center">
+ Except as noted, this content - excluding the Code Examples - is licensed under <a href="http://creativecommons.org/licenses/by/3.0/legalcode" target="_blank">Creative Commons Attribution 3.0</a> and all of the Code Examples contained herein are licensed under <a href="https://www.tizen.org/bsd-3-clause-license" target="_blank">BSD-3-Clause</a>. <br>For details, see the <a href="https://www.tizen.org/content-license" target="_blank">Content License</a>.
+ </div>
+<script type="text/javascript">
+
+ var _gaq = _gaq || [];
+ _gaq.push(['_setAccount', 'UA-25976949-1']);
+ _gaq.push(['_setDomainName', 'tizen.org']);
+ _gaq.push(['_trackPageview']);
+
+ (function() {
+ var ga = document.createElement('script'); ga.type = 'text/javascript'; ga.async = true;
+ var s = document.getElementsByTagName('script')[0]; s.parentNode.insertBefore(ga, s);
+ })();
+
+ </script>
+</div>
+</body>
+</html>
--- /dev/null
+<!DOCTYPE html PUBLIC "html">
+<html>
+<head>
+<meta http-equiv="Content-Type" content="text/html; charset=utf-8">
+<link rel="stylesheet" type="text/css" href="../tizen.css" media="screen">
+<script type="text/javascript" src="snippet.js"></script><title>Events API</title>
+</head>
+<body id="page-content" onload="prettyPrint()">
+<div class="api" id="::Events">
+<div class="supported-platforms"><img class="wearable-mandatory emulator" title="Mandatory, Supported by Tizen Wearable emulator" src="../wearable_s_w.png"></div>
+<div class="title"><h1>Events API</h1></div>
+<div class="brief">
+ This plugin provides information about events defined in cordova.
+ </div>
+<div class="description">
+ <p>
+Original documentation: <a href="https://cordova.apache.org/docs/en/latest/cordova/events/events.html">Cordova Events</a>.
+ </p>
+ <table>
+ <tr>
+ <th>
+Event name </th>
+ <th>
+Event handler callback </th>
+ </tr>
+ <tr>
+ <td>
+deviceready </td>
+ <td>
+<a href="#DeviceReadyEventCallback">DeviceReadyEventCallback</a> </td>
+ </tr>
+ <tr>
+ <td>
+pause </td>
+ <td>
+<a href="#PauseEventCallback">PauseEventCallback</a> </td>
+ </tr>
+ <tr>
+ <td>
+resume </td>
+ <td>
+<a href="#ResumeEventCallback">ResumeEventCallback</a> </td>
+ </tr>
+ <tr>
+ <td>
+backbutton </td>
+ <td>
+<a href="#BackButtonEventCallback">BackButtonEventCallback</a> </td>
+ </tr>
+ <tr>
+ <td>
+menubutton </td>
+ <td>
+<a href="#MenuButtonEventCallback">MenuButtonEventCallback</a> </td>
+ </tr>
+ <tr>
+ <td>
+searchbutton </td>
+ <td>
+<a href="#SearchButtonEventCallback">SearchButtonEventCallback</a> </td>
+ </tr>
+ <tr>
+ <td>
+startcallbutton </td>
+ <td>
+<a href="#StartCallEventCallback">StartCallEventCallback</a> </td>
+ </tr>
+ <tr>
+ <td>
+endcallbutton </td>
+ <td>
+<a href="#EndCallButtonEventCallback">EndCallButtonEventCallback</a> </td>
+ </tr>
+ <tr>
+ <td>
+volumedownbutton </td>
+ <td>
+<a href="#VolumeDownButtonEventCallback">VolumeDownButtonEventCallback</a> </td>
+ </tr>
+ <tr>
+ <td>
+volumeupbutton </td>
+ <td>
+<a href="#VolumeUpButtonEventCallback">VolumeUpButtonEventCallback</a> </td>
+ </tr>
+ <tr>
+ <th colspan="2">
+Network Information events </th>
+ </tr>
+ <tr>
+ <td>
+online </td>
+ <td>
+<a href="networkInformation.html#OnlineEventCallback">OnlineEventCallback</a> </td>
+ </tr>
+ <tr>
+ <td>
+offline </td>
+ <td>
+<a href="networkInformation.html#OfflineEventCallback">OfflineEventCallback</a> </td>
+ </tr>
+ </table>
+ </div>
+<h2>Table of Contents</h2>
+<ul class="toc">
+<li>1. <a href="#interfaces-section">Interfaces</a><ul class="toc">
+<li>1.1. <a href="#DeviceReadyEventCallback">DeviceReadyEventCallback</a>
+</li>
+<li>1.2. <a href="#PauseEventCallback">PauseEventCallback</a>
+</li>
+<li>1.3. <a href="#ResumeEventCallback">ResumeEventCallback</a>
+</li>
+<li>1.4. <a href="#BackButtonEventCallback">BackButtonEventCallback</a>
+</li>
+<li>1.5. <a href="#MenuButtonEventCallback">MenuButtonEventCallback</a>
+</li>
+<li>1.6. <a href="#SearchButtonEventCallback">SearchButtonEventCallback</a>
+</li>
+<li>1.7. <a href="#StartCallEventCallback">StartCallEventCallback</a>
+</li>
+<li>1.8. <a href="#EndCallButtonEventCallback">EndCallButtonEventCallback</a>
+</li>
+<li>1.9. <a href="#VolumeDownButtonEventCallback">VolumeDownButtonEventCallback</a>
+</li>
+<li>1.10. <a href="#VolumeUpButtonEventCallback">VolumeUpButtonEventCallback</a>
+</li>
+</ul>
+</li>
+<li>2. <a href="#full-webidl">Full WebIDL</a>
+</li>
+</ul>
+<hr>
+<h2 id="method-summary">Summary of Interfaces and Methods</h2>
+<table class="informaltable">
+<thead><tr>
+<th>Interface</th>
+<th>Method</th>
+</tr></thead>
+<tbody>
+<tr>
+<td><a href="#DeviceReadyEventCallback">DeviceReadyEventCallback</a></td>
+<td><div>void <a href="#DeviceReadyEventCallback::ondeviceready">ondeviceready</a> ()</div></td>
+</tr>
+<tr>
+<td><a href="#PauseEventCallback">PauseEventCallback</a></td>
+<td><div>void <a href="#PauseEventCallback::onpause">onpause</a> ()</div></td>
+</tr>
+<tr>
+<td><a href="#ResumeEventCallback">ResumeEventCallback</a></td>
+<td><div>void <a href="#ResumeEventCallback::onresume">onresume</a> ()</div></td>
+</tr>
+<tr>
+<td><a href="#BackButtonEventCallback">BackButtonEventCallback</a></td>
+<td><div>void <a href="#BackButtonEventCallback::onbackbutton">onbackbutton</a> ()</div></td>
+</tr>
+<tr>
+<td><a href="#MenuButtonEventCallback">MenuButtonEventCallback</a></td>
+<td><div>void <a href="#MenuButtonEventCallback::onmenubutton">onmenubutton</a> ()</div></td>
+</tr>
+<tr>
+<td><a href="#SearchButtonEventCallback">SearchButtonEventCallback</a></td>
+<td><div>void <a href="#SearchButtonEventCallback::onsearchbutton">onsearchbutton</a> ()</div></td>
+</tr>
+<tr>
+<td><a href="#StartCallEventCallback">StartCallEventCallback</a></td>
+<td><div>void <a href="#StartCallEventCallback::onstartcallbutton">onstartcallbutton</a> ()</div></td>
+</tr>
+<tr>
+<td><a href="#EndCallButtonEventCallback">EndCallButtonEventCallback</a></td>
+<td><div>void <a href="#EndCallButtonEventCallback::onendcallbutton">onendcallbutton</a> ()</div></td>
+</tr>
+<tr>
+<td><a href="#VolumeDownButtonEventCallback">VolumeDownButtonEventCallback</a></td>
+<td><div>void <a href="#VolumeDownButtonEventCallback::onvolumedownbutton">onvolumedownbutton</a> ()</div></td>
+</tr>
+<tr>
+<td><a href="#VolumeUpButtonEventCallback">VolumeUpButtonEventCallback</a></td>
+<td><div>void <a href="#VolumeUpButtonEventCallback::onvolumeupbutton">onvolumeupbutton</a> ()</div></td>
+</tr>
+</tbody>
+</table>
+<div class="interfaces" id="interfaces-section">
+<h2>1. Interfaces</h2>
+<div class="interface" id="DeviceReadyEventCallback">
+<a class="backward-compatibility-anchor" name="::Events::DeviceReadyEventCallback"></a><h3>1.1. DeviceReadyEventCallback</h3>
+<div class="brief">
+ Callback for the event which fires when Cordova is fully loaded
+ </div>
+<pre class="webidl prettyprint">[NoInterfaceObject, Callback=FunctionOnly]
+interface DeviceReadyEventCallback {
+ void ondeviceready();
+};</pre>
+<p><span class="version">
+ Since: </span>
+ 3.0
+ </p>
+<div class="description">
+ <p>
+The <var>domready</var> event is essential to any application. It signals that Cordova's device APIs have loaded and are ready to access.
+ </p>
+ <p>
+Cordova consists of two code bases: native and JavaScript. While the native code loads, a custom loading image displays. However, JavaScript only loads once the DOM loads. This means the web app may potentially call a Cordova JavaScript function before the corresponding native code becomes available.
+ </p>
+ <p>
+The deviceready event fires once Cordova has fully loaded. Once the event fires, you can safely make calls to Cordova APIs. Applications typically attach an event listener with document.addEventListener once the HTML document's DOM has loaded.
+ </p>
+ <p>
+The deviceready event behaves somewhat differently from others. Any event handler registered after the deviceready event fires has its callback function called immediately.
+ </p>
+ <p>
+Original documentation: <a href="https://cordova.apache.org/docs/en/latest/cordova/events/events.deviceready.html">Cordova deviceredy event</a> </p>
+ </div>
+<div class="example">
+<span class="example"><p>Code example:</p></span><pre name="code" class="examplecode prettyprint"> document.addEventListener('deviceready', onDeviceReady, false);
+
+ function onDeviceReady() {
+ // Now safe to use device APIs
+ }
+ </pre>
+</div>
+</div>
+<div class="interface" id="PauseEventCallback">
+<a class="backward-compatibility-anchor" name="::Events::PauseEventCallback"></a><h3>1.2. PauseEventCallback</h3>
+<div class="brief">
+ Callback for the event which fires when an application is put into the background
+ </div>
+<pre class="webidl prettyprint">[NoInterfaceObject, Callback=FunctionOnly]
+interface PauseEventCallback {
+ void onpause();
+};</pre>
+<p><span class="version">
+ Since: </span>
+ 3.0
+ </p>
+<div class="description">
+ <p>
+The <var>pause</var> event fires when the native platform puts the application into the background, typically when the user switches to a different application.
+ </p>
+ <p>
+Applications typically should use document.addEventListener() to attach an event listener once the <a href="#DeviceReadyEventCallback">deviceready</a> event fires.
+ </p>
+ <p>
+Original documentation: <a href="https://cordova.apache.org/docs/en/latest/cordova/events/events.pause.html">Cordova pause event</a> </p>
+ </div>
+<div class="example">
+<span class="example"><p>Code example:</p></span><pre name="code" class="examplecode prettyprint"> document.addEventListener('deviceready', onDeviceReady, false);
+
+ function onDeviceReady() {
+ document.addEventListener('pause', onPause, false);
+ }
+
+ function onPause() {
+ // Handle the pause event
+ }
+ </pre>
+</div>
+</div>
+<div class="interface" id="ResumeEventCallback">
+<a class="backward-compatibility-anchor" name="::Events::ResumeEventCallback"></a><h3>1.3. ResumeEventCallback</h3>
+<div class="brief">
+ Callback for the event which fires when an application is retrieved from the background
+ </div>
+<pre class="webidl prettyprint">[NoInterfaceObject, Callback=FunctionOnly]
+interface ResumeEventCallback {
+ void onresume();
+};</pre>
+<p><span class="version">
+ Since: </span>
+ 3.0
+ </p>
+<div class="description">
+ <p>
+The <var>resume</var> event fires when the native platform pulls the application out from the background.
+ </p>
+ <p>
+Applications typically should use document.addEventListener() to attach an event listener once the <a href="#DeviceReadyEventCallback">deviceready</a> event fires.
+ </p>
+ <p>
+Original documentation: <a href="https://cordova.apache.org/docs/en/latest/cordova/events/events.resume.html">Cordova resume event</a> </p>
+ </div>
+<div class="example">
+<span class="example"><p>Code example:</p></span><pre name="code" class="examplecode prettyprint"> document.addEventListener('deviceready', onDeviceReady, false);
+
+ function onDeviceReady() {
+ document.addEventListener('resume', onResume, false);
+ }
+
+ function onResume() {
+ // Handle the resume event
+ }
+ </pre>
+</div>
+</div>
+<div class="interface" id="BackButtonEventCallback">
+<a class="backward-compatibility-anchor" name="::Events::BackButtonEventCallback"></a><h3>1.4. BackButtonEventCallback</h3>
+<div class="brief">
+ Callback for the event which fires when the user presses the back button
+ </div>
+<pre class="webidl prettyprint">[NoInterfaceObject, Callback=FunctionOnly]
+interface BackButtonEventCallback {
+ void onbackbutton();
+};</pre>
+<p><span class="version">
+ Since: </span>
+ 3.0
+ </p>
+<div class="description">
+ <p>
+To override the default back-button behavior, register an event listener for the backbutton event, typically by calling document.addEventListener() once you receive the <a href="#DeviceReadyEventCallback">deviceready</a> event.
+It is no longer necessary to call any other method to override the back-button behavior.
+ </p>
+ <p>
+Original documentation: <a href="https://cordova.apache.org/docs/en/latest/cordova/events/events.backbutton.html">Cordova backbutton event</a> </p>
+ </div>
+<div class="example">
+<span class="example"><p>Code example:</p></span><pre name="code" class="examplecode prettyprint"> document.addEventListener('deviceready', onDeviceReady, false);
+
+ function onDeviceReady() {
+ document.addEventListener('backbutton', onBackKeyDown, false);
+ }
+
+ function onBackKeyDown() {
+ // Handle the back button
+ }
+ </pre>
+</div>
+</div>
+<div class="interface" id="MenuButtonEventCallback">
+<a class="backward-compatibility-anchor" name="::Events::MenuButtonEventCallback"></a><h3>1.5. MenuButtonEventCallback</h3>
+<div class="brief">
+ Callback for the event which fires when the user presses the menu button
+ </div>
+<pre class="webidl prettyprint">[NoInterfaceObject, Callback=FunctionOnly]
+interface MenuButtonEventCallback {
+ void onmenubutton();
+};</pre>
+<p><span class="version">
+ Since: </span>
+ 3.0
+ </p>
+<div class="description">
+ <p>
+Applying an event handler for the <var>menubutton</var> event overrides the default menu button behavior.
+ </p>
+ <p>
+Applications typically should use document.addEventListener() to attach an event listener once the <a href="#DeviceReadyEventCallback">deviceready</a> event fires.
+ </p>
+ <p>
+Original documentation: <a href="https://cordova.apache.org/docs/en/latest/cordova/events/events.menubutton.html">Cordova menubutton event</a> </p>
+ </div>
+<div class="example">
+<span class="example"><p>Code example:</p></span><pre name="code" class="examplecode prettyprint"> document.addEventListener('deviceready', onDeviceReady, false);
+
+ function onDeviceReady() {
+ document.addEventListener('menubutton', onMenuKeyDown, false);
+ }
+
+ function onMenuKeyDown() {
+ // Handle the back button
+ }
+ </pre>
+</div>
+</div>
+<div class="interface" id="SearchButtonEventCallback">
+<a class="backward-compatibility-anchor" name="::Events::SearchButtonEventCallback"></a><h3>1.6. SearchButtonEventCallback</h3>
+<div class="brief">
+ Callback for the event which fires when the user presses the search button
+ </div>
+<pre class="webidl prettyprint">[NoInterfaceObject, Callback=FunctionOnly]
+interface SearchButtonEventCallback {
+ void onsearchbutton();
+};</pre>
+<p><span class="version">
+ Since: </span>
+ 3.0
+ </p>
+<div class="description">
+ <p>
+If you need to override the default search button behavior on Android you can register an event listener for the <var>searchbutton</var> event.
+ </p>
+ <p>
+Applications typically should use document.addEventListener() to attach an event listener once the <a href="#DeviceReadyEventCallback">deviceready</a> event fires.
+ </p>
+ <p>
+Original documentation: <a href="https://cordova.apache.org/docs/en/latest/cordova/events/events.searchbutton.html">Cordova searchbutton event</a> </p>
+ </div>
+<div class="example">
+<span class="example"><p>Code example:</p></span><pre name="code" class="examplecode prettyprint"> document.addEventListener('deviceready', onDeviceReady, false);
+
+ function onDeviceReady() {
+ document.addEventListener('searchbutton', onSearchKeyDown, false);
+ }
+
+ function onSearchKeyDown() {
+ // Handle the search button
+ }
+ </pre>
+</div>
+</div>
+<div class="interface" id="StartCallEventCallback">
+<a class="backward-compatibility-anchor" name="::Events::StartCallEventCallback"></a><h3>1.7. StartCallEventCallback</h3>
+<div class="brief">
+ Callback for the event which fires when the user presses the start call button
+ </div>
+<pre class="webidl prettyprint">[NoInterfaceObject, Callback=FunctionOnly]
+interface StartCallEventCallback {
+ void onstartcallbutton();
+};</pre>
+<p><span class="version">
+ Since: </span>
+ 3.0
+ </p>
+<div class="description">
+ <p>
+If you need to override the default start call behavior you can register an event listener for the <var>startcallbutton</var> event.
+ </p>
+ <p>
+Applications typically should use document.addEventListener() to attach an event listener once the <a href="#DeviceReadyEventCallback">deviceready</a> event fires.
+ </p>
+ <p>
+Original documentation: <a href="https://cordova.apache.org/docs/en/latest/cordova/events/events.startcallbutton.html">Cordova startcallbutton event</a> </p>
+ </div>
+<div class="example">
+<span class="example"><p>Code example:</p></span><pre name="code" class="examplecode prettyprint"> document.addEventListener('deviceready', onDeviceReady, false);
+
+ function onDeviceReady() {
+ document.addEventListener('startcallbutton', onStartCallKeyDown, false);
+ }
+
+ function onStartCallKeyDown() {
+ // Handle the start call button
+ }
+ </pre>
+</div>
+</div>
+<div class="interface" id="EndCallButtonEventCallback">
+<a class="backward-compatibility-anchor" name="::Events::EndCallButtonEventCallback"></a><h3>1.8. EndCallButtonEventCallback</h3>
+<div class="brief">
+ Callback for the event which fires when the user presses the end call button
+ </div>
+<pre class="webidl prettyprint">[NoInterfaceObject, Callback=FunctionOnly]
+interface EndCallButtonEventCallback {
+ void onendcallbutton();
+};</pre>
+<p><span class="version">
+ Since: </span>
+ 3.0
+ </p>
+<div class="description">
+ <p>
+The <var>endcallbutton</var> event overrides the default end call behavior.
+ </p>
+ <p>
+Applications typically should use document.addEventListener() to attach an event listener once the <a href="#DeviceReadyEventCallback">deviceready</a> event fires.
+ </p>
+ <p>
+Original documentation: <a href="https://cordova.apache.org/docs/en/latest/cordova/events/events.endcallbutton.html">Cordova endcallbutton event</a> </p>
+ </div>
+<div class="example">
+<span class="example"><p>Code example:</p></span><pre name="code" class="examplecode prettyprint"> document.addEventListener('deviceready', onDeviceReady, false);
+
+ function onDeviceReady() {
+ document.addEventListener('endcallbutton', onEndCallKeyDown, false);
+ }
+
+ function onEndCallKeyDown() {
+ // Handle the end call button
+ }
+ </pre>
+</div>
+</div>
+<div class="interface" id="VolumeDownButtonEventCallback">
+<a class="backward-compatibility-anchor" name="::Events::VolumeDownButtonEventCallback"></a><h3>1.9. VolumeDownButtonEventCallback</h3>
+<div class="brief">
+ Callback for the event which fires when the user presses the volume down button
+ </div>
+<pre class="webidl prettyprint">[NoInterfaceObject, Callback=FunctionOnly]
+interface VolumeDownButtonEventCallback {
+ void onvolumedownbutton();
+};</pre>
+<p><span class="version">
+ Since: </span>
+ 3.0
+ </p>
+<div class="description">
+ <p>
+If you need to override the default volume down behavior you can register an event listener for the <var>volumedownbutton</var> event.
+ </p>
+ <p>
+Applications typically should use document.addEventListener() to attach an event listener once the <a href="#DeviceReadyEventCallback">deviceready</a> event fires.
+ </p>
+ <p>
+Original documentation: <a href="https://cordova.apache.org/docs/en/latest/cordova/events/events.volumedownbutton.html">Cordova volumedownbutton event</a> </p>
+ </div>
+<div class="example">
+<span class="example"><p>Code example:</p></span><pre name="code" class="examplecode prettyprint"> document.addEventListener('deviceready', onDeviceReady, false);
+
+ function onDeviceReady() {
+ document.addEventListener('volumedownbutton', onVolumeDownKeyDown, false);
+ }
+
+ function onVolumeDownKeyDown() {
+ // Handle the volume down button
+ }
+ </pre>
+</div>
+</div>
+<div class="interface" id="VolumeUpButtonEventCallback">
+<a class="backward-compatibility-anchor" name="::Events::VolumeUpButtonEventCallback"></a><h3>1.10. VolumeUpButtonEventCallback</h3>
+<div class="brief">
+ Callback for the event which fires when the user presses the volume up button
+ </div>
+<pre class="webidl prettyprint">[NoInterfaceObject, Callback=FunctionOnly]
+interface VolumeUpButtonEventCallback {
+ void onvolumeupbutton();
+};</pre>
+<p><span class="version">
+ Since: </span>
+ 3.0
+ </p>
+<div class="description">
+ <p>
+If you need to override the default volume up behavior you can register an event listener for the <var>volumeupbutton</var> event.
+ </p>
+ <p>
+Applications typically should use document.addEventListener() to attach an event listener once the <a href="#DeviceReadyEventCallback">deviceready</a> event fires.
+ </p>
+ <p>
+Original documentation: <a href="https://cordova.apache.org/docs/en/latest/cordova/events/events.volumeupbutton.html">Cordova volumeupbutton event</a> </p>
+ </div>
+<div class="example">
+<span class="example"><p>Code example:</p></span><pre name="code" class="examplecode prettyprint"> document.addEventListener('deviceready', onDeviceReady, false);
+
+ function onDeviceReady() {
+ document.addEventListener('volumeupbutton', onVolumeUpKeyDown, false);
+ }
+
+ function onVolumeUpKeyDown() {
+ // Handle the volume up button
+ }
+ </pre>
+</div>
+</div>
+</div>
+<h2 id="full-webidl">2. Full WebIDL</h2>
+<pre class="webidl prettyprint">module Events {
+
+[NoInterfaceObject, Callback=FunctionOnly]
+interface DeviceReadyEventCallback {
+ void ondeviceready();
+};
+
+[NoInterfaceObject, Callback=FunctionOnly]
+interface PauseEventCallback {
+ void onpause();
+};
+
+[NoInterfaceObject, Callback=FunctionOnly]
+interface ResumeEventCallback {
+ void onresume();
+};
+
+[NoInterfaceObject, Callback=FunctionOnly]
+interface BackButtonEventCallback {
+ void onbackbutton();
+};
+
+[NoInterfaceObject, Callback=FunctionOnly]
+interface MenuButtonEventCallback {
+ void onmenubutton();
+};
+
+[NoInterfaceObject, Callback=FunctionOnly]
+interface SearchButtonEventCallback {
+ void onsearchbutton();
+};
+
+[NoInterfaceObject, Callback=FunctionOnly]
+interface StartCallEventCallback {
+ void onstartcallbutton();
+};
+
+[NoInterfaceObject, Callback=FunctionOnly]
+interface EndCallButtonEventCallback {
+ void onendcallbutton();
+};
+
+[NoInterfaceObject, Callback=FunctionOnly]
+interface VolumeDownButtonEventCallback {
+ void onvolumedownbutton();
+};
+
+[NoInterfaceObject, Callback=FunctionOnly]
+interface VolumeUpButtonEventCallback {
+ void onvolumeupbutton();
+};
+};</pre>
+</div>
+<div id="page-footer">
+<div class="copyright" align="center">
+ Except as noted, this content - excluding the Code Examples - is licensed under <a href="http://creativecommons.org/licenses/by/3.0/legalcode" target="_blank">Creative Commons Attribution 3.0</a> and all of the Code Examples contained herein are licensed under <a href="https://www.tizen.org/bsd-3-clause-license" target="_blank">BSD-3-Clause</a>. <br>For details, see the <a href="https://www.tizen.org/content-license" target="_blank">Content License</a>.
+ </div>
+<script type="text/javascript">
+
+ var _gaq = _gaq || [];
+ _gaq.push(['_setAccount', 'UA-25976949-1']);
+ _gaq.push(['_setDomainName', 'tizen.org']);
+ _gaq.push(['_trackPageview']);
+
+ (function() {
+ var ga = document.createElement('script'); ga.type = 'text/javascript'; ga.async = true;
+ var s = document.getElementsByTagName('script')[0]; s.parentNode.insertBefore(ga, s);
+ })();
+
+ </script>
+</div>
+</body>
+</html>
--- /dev/null
+<!DOCTYPE html PUBLIC "html">
+<html>
+<head>
+<meta http-equiv="Content-Type" content="text/html; charset=utf-8">
+<link rel="stylesheet" type="text/css" href="../tizen.css" media="screen">
+<script type="text/javascript" src="snippet.js"></script><title>File API</title>
+</head>
+<body id="page-content" onload="prettyPrint()">
+<div class="api" id="::File">
+<div class="supported-platforms"><img class="wearable-mandatory emulator" title="Mandatory, Supported by Tizen Wearable emulator" src="../wearable_s_w.png"></div>
+<div class="title"><h1>File API</h1></div>
+<div class="brief">
+ This plugin implements a File API allowing read/write access to files residing on the device.
+ </div>
+<div class="description">
+ <p>
+Original documentation: <a href="https://www.npmjs.com/package/cordova-plugin-file">Cordova File</a>.
+ </p>
+ </div>
+<p><span class="version">
+ Since: </span>
+ 3.0
+ </p>
+<h2>Table of Contents</h2>
+<ul class="toc">
+<li>1. <a href="#typedefs-section">Type Definitions</a><ul class="toc">
+<li>
+ 1.1. <a href="#WriteData">WriteData</a>
+</li>
+<li>
+ 1.2. <a href="#ReadResultData">ReadResultData</a>
+</li>
+</ul>
+</li>
+<li>2. <a href="#interfaces-section">Interfaces</a><ul class="toc">
+<li>2.1. <a href="#FilePropertyBag">FilePropertyBag</a>
+</li>
+<li>2.2. <a href="#ProgressEventInit">ProgressEventInit</a>
+</li>
+<li>2.3. <a href="#ProgressEvent">ProgressEvent</a>
+</li>
+<li>2.4. <a href="#FileSystemManagerObject">FileSystemManagerObject</a>
+</li>
+<li>2.5. <a href="#FileSystemManager">FileSystemManager</a>
+</li>
+<li>2.6. <a href="#FileSystem">FileSystem</a>
+</li>
+<li>2.7. <a href="#Metadata">Metadata</a>
+</li>
+<li>2.8. <a href="#FileError">FileError</a>
+</li>
+<li>2.9. <a href="#File">File</a>
+</li>
+<li>2.10. <a href="#LocalFileSystem">LocalFileSystem</a>
+</li>
+<li>2.11. <a href="#Entry">Entry</a>
+</li>
+<li>2.12. <a href="#DirectoryEntry">DirectoryEntry</a>
+</li>
+<li>2.13. <a href="#DirectoryReader">DirectoryReader</a>
+</li>
+<li>2.14. <a href="#FileEntry">FileEntry</a>
+</li>
+<li>2.15. <a href="#FileReader">FileReader</a>
+</li>
+<li>2.16. <a href="#FileWriter">FileWriter</a>
+</li>
+<li>2.17. <a href="#ProgressCallback">ProgressCallback</a>
+</li>
+<li>2.18. <a href="#FileSystemCallback">FileSystemCallback</a>
+</li>
+<li>2.19. <a href="#EntryCallback">EntryCallback</a>
+</li>
+<li>2.20. <a href="#EntriesCallback">EntriesCallback</a>
+</li>
+<li>2.21. <a href="#MetadataCallback">MetadataCallback</a>
+</li>
+<li>2.22. <a href="#FileWriterCallback">FileWriterCallback</a>
+</li>
+<li>2.23. <a href="#FileCallback">FileCallback</a>
+</li>
+<li>2.24. <a href="#VoidCallback">VoidCallback</a>
+</li>
+<li>2.25. <a href="#ErrorCallback">ErrorCallback</a>
+</li>
+</ul>
+</li>
+<li>3. <a href="#full-webidl">Full WebIDL</a>
+</li>
+</ul>
+<hr>
+<h2 id="method-summary">Summary of Interfaces and Methods</h2>
+<table class="informaltable">
+<thead><tr>
+<th>Interface</th>
+<th>Method</th>
+</tr></thead>
+<tbody>
+<tr>
+<td><a href="#FilePropertyBag">FilePropertyBag</a></td>
+<td></td>
+</tr>
+<tr>
+<td><a href="#ProgressEventInit">ProgressEventInit</a></td>
+<td></td>
+</tr>
+<tr>
+<td><a href="#ProgressEvent">ProgressEvent</a></td>
+<td></td>
+</tr>
+<tr>
+<td><a href="#FileSystemManagerObject">FileSystemManagerObject</a></td>
+<td></td>
+</tr>
+<tr>
+<td><a href="#FileSystemManager">FileSystemManager</a></td>
+<td></td>
+</tr>
+<tr>
+<td><a href="#FileSystem">FileSystem</a></td>
+<td></td>
+</tr>
+<tr>
+<td><a href="#Metadata">Metadata</a></td>
+<td></td>
+</tr>
+<tr>
+<td><a href="#FileError">FileError</a></td>
+<td></td>
+</tr>
+<tr>
+<td><a href="#File">File</a></td>
+<td></td>
+</tr>
+<tr>
+<td><a href="#LocalFileSystem">LocalFileSystem</a></td>
+<td>
+<div>void <a href="#LocalFileSystem::requestFileSystem">requestFileSystem</a> (short type, long long size, optional <a href="#FileSystemCallback">FileSystemCallback</a>? successCallback, optional <a href="#ErrorCallback">ErrorCallback</a>? errorCallback)</div>
+<div>void <a href="#LocalFileSystem::resolveLocalFileSystemURL">resolveLocalFileSystemURL</a> (DOMString uri, optional <a href="#EntryCallback">EntryCallback</a>? successCallback, optional <a href="#ErrorCallback">ErrorCallback</a>? errorCallback)</div>
+</td>
+</tr>
+<tr>
+<td><a href="#Entry">Entry</a></td>
+<td>
+<div>void <a href="#Entry::getMetadata">getMetadata</a> (<a href="#MetadataCallback">MetadataCallback</a> onsuccess, optional <a href="#ErrorCallback">ErrorCallback</a>? onerror)</div>
+<div>void <a href="#Entry::moveTo">moveTo</a> (<a href="#DirectoryEntry">DirectoryEntry</a> parent, optional DOMString? newName, optional <a href="#EntryCallback">EntryCallback</a>? onsuccess, optional <a href="#ErrorCallback">ErrorCallback</a>? onerror)</div>
+<div>void <a href="#Entry::copyTo">copyTo</a> (<a href="#DirectoryEntry">DirectoryEntry</a> parent, optional DOMString? newName, optional <a href="#EntryCallback">EntryCallback</a>? onsuccess, optional <a href="#ErrorCallback">ErrorCallback</a>? onerror)</div>
+<div>void <a href="#Entry::getParent">getParent</a> (<a href="#EntryCallback">EntryCallback</a> onsuccess, optional <a href="#ErrorCallback">ErrorCallback</a>? onerror)</div>
+<div>void <a href="#Entry::remove">remove</a> (<a href="#VoidCallback">VoidCallback</a> onsuccess, optional <a href="#ErrorCallback">ErrorCallback</a>? onerror)</div>
+<div>DOMString <a href="#Entry::toURL">toURL</a> ()</div>
+</td>
+</tr>
+<tr>
+<td><a href="#DirectoryEntry">DirectoryEntry</a></td>
+<td>
+<div>
+<a href="#DirectoryReader">DirectoryReader</a> <a href="#DirectoryEntry::createReader">createReader</a> ()</div>
+<div>void <a href="#DirectoryEntry::getDirectory">getDirectory</a> (DOMString path, optional ? options, optional <a href="#EntryCallback">EntryCallback</a>? onsuccess, optional <a href="#ErrorCallback">ErrorCallback</a>? onerror)</div>
+<div>void <a href="#DirectoryEntry::getFile">getFile</a> (DOMString path, optional ? options, optional <a href="#EntryCallback">EntryCallback</a>? onsuccess, optional <a href="#ErrorCallback">ErrorCallback</a>? onerror)</div>
+<div>void <a href="#DirectoryEntry::removeRecursively">removeRecursively</a> (<a href="#VoidCallback">VoidCallback</a> onsuccess, optional <a href="#ErrorCallback">ErrorCallback</a>? onerror)</div>
+</td>
+</tr>
+<tr>
+<td><a href="#DirectoryReader">DirectoryReader</a></td>
+<td><div>void <a href="#DirectoryReader::readEntries">readEntries</a> (<a href="#EntriesCallback">EntriesCallback</a> onsuccess, optional <a href="#ErrorCallback">ErrorCallback</a>? onerror)</div></td>
+</tr>
+<tr>
+<td><a href="#FileEntry">FileEntry</a></td>
+<td>
+<div>void <a href="#FileEntry::createWriter">createWriter</a> (<a href="#FileWriterCallback">FileWriterCallback</a> onsuccess, optional <a href="#ErrorCallback">ErrorCallback</a>? onerror)</div>
+<div>void <a href="#FileEntry::file">file</a> (<a href="#FileCallback">FileCallback</a> onsuccess, optional <a href="#ErrorCallback">ErrorCallback</a> onerror)</div>
+</td>
+</tr>
+<tr>
+<td><a href="#FileReader">FileReader</a></td>
+<td>
+<div>void <a href="#FileReader::abort">abort</a> ()</div>
+<div>void <a href="#FileReader::readAsDataURL">readAsDataURL</a> ( blob)</div>
+<div>void <a href="#FileReader::readAsText">readAsText</a> ( blob, optional DOMString? label)</div>
+<div>void <a href="#FileReader::readAsBinaryString">readAsBinaryString</a> ( blob)</div>
+<div>void <a href="#FileReader::readAsArrayBuffer">readAsArrayBuffer</a> ( blob)</div>
+</td>
+</tr>
+<tr>
+<td><a href="#FileWriter">FileWriter</a></td>
+<td>
+<div>void <a href="#FileWriter::abort">abort</a> ()</div>
+<div>void <a href="#FileWriter::seek">seek</a> (long offset)</div>
+<div>void <a href="#FileWriter::truncate">truncate</a> (long size)</div>
+<div>void <a href="#FileWriter::write">write</a> (<a href="#WriteData">WriteData</a> data)</div>
+</td>
+</tr>
+<tr>
+<td><a href="#ProgressCallback">ProgressCallback</a></td>
+<td><div>void <a href="#ProgressCallback::onsuccess">onsuccess</a> (<a href="#ProgressEvent">ProgressEvent</a> event)</div></td>
+</tr>
+<tr>
+<td><a href="#FileSystemCallback">FileSystemCallback</a></td>
+<td><div>void <a href="#FileSystemCallback::handleEvent">handleEvent</a> (<a href="#FileSystem">FileSystem</a> filesystem)</div></td>
+</tr>
+<tr>
+<td><a href="#EntryCallback">EntryCallback</a></td>
+<td><div>void <a href="#EntryCallback::handleEvent">handleEvent</a> (<a href="#Entry">Entry</a> entry)</div></td>
+</tr>
+<tr>
+<td><a href="#EntriesCallback">EntriesCallback</a></td>
+<td><div>void <a href="#EntriesCallback::handleEvent">handleEvent</a> (<a href="#Entry">Entry</a>[] entries)</div></td>
+</tr>
+<tr>
+<td><a href="#MetadataCallback">MetadataCallback</a></td>
+<td><div>void <a href="#MetadataCallback::handleEvent">handleEvent</a> (<a href="#Metadata">Metadata</a> metadata)</div></td>
+</tr>
+<tr>
+<td><a href="#FileWriterCallback">FileWriterCallback</a></td>
+<td><div>void <a href="#FileWriterCallback::handleEvent">handleEvent</a> (<a href="#FileWriter">FileWriter</a> fileWriter)</div></td>
+</tr>
+<tr>
+<td><a href="#FileCallback">FileCallback</a></td>
+<td><div>void <a href="#FileCallback::handleEvent">handleEvent</a> (<a href="#File">File</a> file)</div></td>
+</tr>
+<tr>
+<td><a href="#VoidCallback">VoidCallback</a></td>
+<td><div>void <a href="#VoidCallback::handleEvent">handleEvent</a> ()</div></td>
+</tr>
+<tr>
+<td><a href="#ErrorCallback">ErrorCallback</a></td>
+<td><div>void <a href="#ErrorCallback::handleEvent">handleEvent</a> (<a href="#FileError">FileError</a> err)</div></td>
+</tr>
+</tbody>
+</table>
+<div class="typedefs" id="typedefs-section">
+<h2>1. Type Definitions</h2>
+<div class="typedef" id="WriteData">
+<a class="backward-compatibility-anchor" name="::File::WriteData"></a><h3>1.1. WriteData</h3>
+<div class="brief">
+ Specifies the user or system defined event data.
+ </div>
+<pre class="webidl prettyprint"> typedef ( or DOMString) WriteData;</pre>
+<p><span class="version">
+ Since: </span>
+ 3.0
+ </p>
+</div>
+<div class="typedef" id="ReadResultData">
+<a class="backward-compatibility-anchor" name="::File::ReadResultData"></a><h3>1.2. ReadResultData</h3>
+<div class="brief">
+ Specifies the result data of <em>FileReader</em> object.
+ </div>
+<pre class="webidl prettyprint"> typedef (DOMString or byte[]) ReadResultData;</pre>
+<p><span class="version">
+ Since: </span>
+ 3.0
+ </p>
+</div>
+</div>
+<div class="interfaces" id="interfaces-section">
+<h2>2. Interfaces</h2>
+<div class="dictionary" id="FilePropertyBag">
+<a class="backward-compatibility-anchor" name="::File::FilePropertyBag"></a><h3>2.1. FilePropertyBag</h3>
+<div class="brief">
+ FilePropertyBag.
+ </div>
+<pre class="webidl prettyprint"> dictionary FilePropertyBag {
+
+ DOMString type;
+
+ long long lastModified;
+ };</pre>
+<p><span class="version">
+ Since: </span>
+ 3.0
+ </p>
+<div class="attributes">
+<h4>Dictionary members</h4>
+<dl>
+<dt class="member" id="FilePropertyBag::type"><span class="attrName">DOMString type</span></dt>
+<dd>
+<div class="brief">
+ The ASCII-encoded string in lower case representing the media type of the File. Normative conditions for this member are provided in the File constructor steps.
+ </div>
+<p><span class="version">
+ Since: </span>
+ 3.0
+ </p>
+</dd>
+<dt class="member" id="FilePropertyBag::lastModified"><span class="attrName">long long lastModified</span></dt>
+<dd>
+<div class="brief">
+ conditions for this member are provided in the File constructor steps.
+ </div>
+<p><span class="version">
+ Since: </span>
+ 3.0
+ </p>
+</dd>
+</dl>
+</div>
+</div>
+<div class="dictionary" id="ProgressEventInit">
+<a class="backward-compatibility-anchor" name="::File::ProgressEventInit"></a><h3>2.2. ProgressEventInit</h3>
+<div class="brief">
+ A dictionary used to initialize ProgressEvent object.
+ </div>
+<pre class="webidl prettyprint"> dictionary ProgressEventInit {
+ unsigned long long loaded = false;
+ unsigned long long total = false;
+ target = null;
+ };</pre>
+<p><span class="version">
+ Since: </span>
+ 3.0
+ </p>
+</div>
+<div class="interface" id="ProgressEvent">
+<a class="backward-compatibility-anchor" name="::File::ProgressEvent"></a><h3>2.3. ProgressEvent</h3>
+<div class="brief">
+ The interface that indicates progression event.
+ </div>
+<pre class="webidl prettyprint"> [Constructor(DOMString type, optional <a href="#ProgressEventInit">ProgressEventInit</a> eventInitDict)]
+ interface ProgressEvent {
+ readonly attribute DOMString type;
+ readonly attribute boolean bubbles;
+ readonly attribute boolean cancelBubble;
+ readonly attribute boolean cancelable;
+ readonly attribute boolean lengthComputable;
+ readonly attribute unsigned long long loaded;
+ readonly attribute unsigned long long total;
+ readonly attribute target;
+ };</pre>
+<p><span class="version">
+ Since: </span>
+ 3.0
+ </p>
+<div class="example">
+<span class="example"><p>Code example:</p></span><pre name="code" class="examplecode prettyprint"> var eventInit = {
+ loaded: 128,
+ total: 1024
+ };
+ var event = new ProgressEvent('submit', eventInit);
+ </pre>
+</div>
+<div class="constructors">
+<h4 id="ProgressEvent::constructor">Constructors</h4>
+<dl><pre class="webidl prettyprint">ProgressEvent(DOMString type, optional <a href="#ProgressEventInit">ProgressEventInit</a> eventInitDict);</pre></dl>
+</div>
+<div class="attributes">
+<h4>Attributes</h4>
+<ul>
+<li class="attribute" id="ProgressEvent::type">
+<span class="attrName"><span class="readonly"> readonly
+</span><span class="type">DOMString </span><span class="name">type</span></span><div class="brief">
+ The type of event, e.g. 'click', 'hashchange', or 'submit'.
+ </div>
+<p><span class="version">
+ Since: </span>
+ 3.0
+ </p>
+</li>
+<li class="attribute" id="ProgressEvent::bubbles">
+<span class="attrName"><span class="readonly"> readonly
+</span><span class="type">boolean </span><span class="name">bubbles</span></span><div class="brief">
+ True if event's goes through its target attribute value's ancestors in reverse tree order, and false otherwise.
+ </div>
+<p><span class="version">
+ Since: </span>
+ 3.0
+ </p>
+</li>
+<li class="attribute" id="ProgressEvent::cancelBubble">
+<span class="attrName"><span class="readonly"> readonly
+</span><span class="type">boolean </span><span class="name">cancelBubble</span></span><div class="brief">
+ Cancel bubble
+ </div>
+<p><span class="version">
+ Since: </span>
+ 3.0
+ </p>
+</li>
+<li class="attribute" id="ProgressEvent::cancelable">
+<span class="attrName"><span class="readonly"> readonly
+</span><span class="type">boolean </span><span class="name">cancelable</span></span><div class="brief">
+ Its return value does not always carry meaning, but true can indicate that part of the operation during which event was dispatched, can be canceled.
+ </div>
+<p><span class="version">
+ Since: </span>
+ 3.0
+ </p>
+</li>
+<li class="attribute" id="ProgressEvent::lengthComputable">
+<span class="attrName"><span class="readonly"> readonly
+</span><span class="type">boolean </span><span class="name">lengthComputable</span></span><div class="brief">
+ True when the length of the transferred content is known.
+ </div>
+<p><span class="version">
+ Since: </span>
+ 3.0
+ </p>
+</li>
+<li class="attribute" id="ProgressEvent::loaded">
+<span class="attrName"><span class="readonly"> readonly
+</span><span class="type">unsigned long long </span><span class="name">loaded</span></span><div class="brief">
+ Number of bytes transferred.
+ </div>
+<p><span class="version">
+ Since: </span>
+ 3.0
+ </p>
+</li>
+<li class="attribute" id="ProgressEvent::total">
+<span class="attrName"><span class="readonly"> readonly
+</span><span class="type">unsigned long long </span><span class="name">total</span></span><div class="brief">
+ The total length of the content. This attribute is set when lengthComputable is true.
+ </div>
+<p><span class="version">
+ Since: </span>
+ 3.0
+ </p>
+</li>
+<li class="attribute" id="ProgressEvent::target">
+<span class="attrName"><span class="readonly"> readonly
+</span><span class="type">EventTarget </span><span class="name">target</span></span><div class="brief">
+ The object to which event is dispatched.
+ </div>
+<p><span class="version">
+ Since: </span>
+ 3.0
+ </p>
+</li>
+</ul>
+</div>
+</div>
+<div class="interface" id="FileSystemManagerObject">
+<a class="backward-compatibility-anchor" name="::File::FileSystemManagerObject"></a><h3>2.4. FileSystemManagerObject</h3>
+<div class="brief">
+ The FileSystemManagerObject interface defines what is instantiated by the Cordova object.
+ </div>
+<pre class="webidl prettyprint"> [NoInterfaceObject] interface FileSystemManagerObject {
+ readonly attribute <a href="#FileSystemManager">FileSystemManager</a> file;
+ };</pre>
+<pre class="webidl prettyprint"> <a href="cordova.html#Cordova">Cordova</a> implements <a href="#FileSystemManagerObject">FileSystemManagerObject</a>;</pre>
+<p><span class="version">
+ Since: </span>
+ 3.0
+ </p>
+<div class="description">
+ <p>
+There is a <em>cordova.file </em>object that allows accessing the functionality of the Filesystem API.
+ </p>
+ </div>
+</div>
+<div class="interface" id="FileSystemManager">
+<a class="backward-compatibility-anchor" name="::File::FileSystemManager"></a><h3>2.5. FileSystemManager</h3>
+<div class="brief">
+ The FileSystemManager interface provides access to the Filesystem API.
+ </div>
+<pre class="webidl prettyprint"> [NoInterfaceObject] interface FileSystemManager {
+ readonly attribute DOMString applicationDirectory;
+
+ readonly attribute DOMString applicationStorageDirectory;
+
+ readonly attribute DOMString dataDirectory;
+
+ readonly attribute DOMString cacheDirectory;
+
+ readonly attribute DOMString externalApplicationStorageDirectory;
+
+ readonly attribute DOMString externalDataDirectory;
+
+ readonly attribute DOMString externalCacheDirectory;
+
+ readonly attribute DOMString externalRootDirectory;
+
+ readonly attribute DOMString tempDirectory;
+
+ readonly attribute DOMString syncedDataDirectory;
+
+ readonly attribute DOMString documentsDirectory;
+
+ readonly attribute DOMString sharedDirectory;
+
+ };</pre>
+<p><span class="version">
+ Since: </span>
+ 3.0
+ </p>
+<div class="description">
+ <p>
+This manager interface exposes the Filesystem base API constants.
+ </p>
+ </div>
+<div class="attributes">
+<h4>Attributes</h4>
+<ul>
+<li class="attribute" id="FileSystemManager::applicationDirectory">
+<span class="attrName"><span class="readonly"> readonly
+</span><span class="type">DOMString </span><span class="name">applicationDirectory</span></span><div class="brief">
+ Read-only directory where the application is installed.
+ </div>
+<p><span class="version">
+ Since: </span>
+ 3.0
+ </p>
+<div class="example">
+<span class="example"><p>Code example:</p></span><pre name="code" class="examplecode prettyprint"> console.log("The directory where the application is installed " + cordova.file.applicationDirectory);
+ </pre>
+</div>
+<div class="output">
+<span class="title"><p>Output example:</p></span><pre>The directory where the application is installed file:///opt/usr/apps/WfigBlWDyf/res/wgt/
+</pre>
+</div>
+</li>
+<li class="attribute" id="FileSystemManager::applicationStorageDirectory">
+<span class="attrName"><span class="readonly"> readonly
+</span><span class="type">DOMString </span><span class="name">applicationStorageDirectory</span></span><div class="brief">
+ Root directory of the application's sandbox.
+ </div>
+<p><span class="version">
+ Since: </span>
+ 3.0
+ </p>
+<div class="example">
+<span class="example"><p>Code example:</p></span><pre name="code" class="examplecode prettyprint"> console.log("Root directory of the application's sandbox " + cordova.file.applicationStorageDirectory);
+ </pre>
+</div>
+<div class="output">
+<span class="title"><p>Output example:</p></span><pre>Root directory of the application's sandbox file:///opt/usr/apps/WfigBlWDyf/
+</pre>
+</div>
+</li>
+<li class="attribute" id="FileSystemManager::dataDirectory">
+<span class="attrName"><span class="readonly"> readonly
+</span><span class="type">DOMString </span><span class="name">dataDirectory</span></span><div class="brief">
+ Persistent and private data storage within the application's sandbox using internal memory
+ </div>
+<p><span class="version">
+ Since: </span>
+ 3.0
+ </p>
+<div class="example">
+<span class="example"><p>Code example:</p></span><pre name="code" class="examplecode prettyprint"> console.log("Data directory " + cordova.file.dataDirectory);
+ </pre>
+</div>
+<div class="output">
+<span class="title"><p>Output example:</p></span><pre>Data directory file:///opt/usr/apps/WfigBlWDyf/data/
+</pre>
+</div>
+</li>
+<li class="attribute" id="FileSystemManager::cacheDirectory">
+<span class="attrName"><span class="readonly"> readonly
+</span><span class="type">DOMString </span><span class="name">cacheDirectory</span></span><div class="brief">
+ Directory for cached data files or any files that your app can re-create easily. The OS may delete these files when the device runs low on storage, nevertheless, apps should not rely on the OS to delete files in here.
+ </div>
+<p><span class="version">
+ Since: </span>
+ 3.0
+ </p>
+<div class="example">
+<span class="example"><p>Code example:</p></span><pre name="code" class="examplecode prettyprint"> console.log("Cache directory " + cordova.file.cacheDirectory);
+ </pre>
+</div>
+<div class="output">
+<span class="title"><p>Output example:</p></span><pre>Cache directory file:///opt/usr/apps/WfigBlWDyf/tmp/
+</pre>
+</div>
+</li>
+<li class="attribute" id="FileSystemManager::externalApplicationStorageDirectory">
+<span class="attrName"><span class="readonly"> readonly
+</span><span class="type">DOMString </span><span class="name">externalApplicationStorageDirectory</span></span><div class="brief">
+ Application space on external storage.
+ </div>
+<p><span class="version">
+ Since: </span>
+ 3.0
+ </p>
+<div class="example">
+<span class="example"><p>Code example:</p></span><pre name="code" class="examplecode prettyprint"> console.log("Space on external storage " + cordova.file.externalApplicationStorageDirectory);
+ </pre>
+</div>
+<div class="output">
+<span class="title"><p>Output example:</p></span><pre>Space on external storage null
+</pre>
+</div>
+</li>
+<li class="attribute" id="FileSystemManager::externalDataDirectory">
+<span class="attrName"><span class="readonly"> readonly
+</span><span class="type">DOMString </span><span class="name">externalDataDirectory</span></span><div class="brief">
+ Where to put app-specific data files on external storage.
+ </div>
+<p><span class="version">
+ Since: </span>
+ 3.0
+ </p>
+<div class="example">
+<span class="example"><p>Code example:</p></span><pre name="code" class="examplecode prettyprint"> console.log("Data files on external storage " + cordova.file.externalDataDirectory);
+ </pre>
+</div>
+<div class="output">
+<span class="title"><p>Output example:</p></span><pre>Data files on external storage null
+</pre>
+</div>
+</li>
+<li class="attribute" id="FileSystemManager::externalCacheDirectory">
+<span class="attrName"><span class="readonly"> readonly
+</span><span class="type">DOMString </span><span class="name">externalCacheDirectory</span></span><div class="brief">
+ Application cache on external storage.
+ </div>
+<p><span class="version">
+ Since: </span>
+ 3.0
+ </p>
+<div class="example">
+<span class="example"><p>Code example:</p></span><pre name="code" class="examplecode prettyprint"> console.log("Cache on external storage " + cordova.file.externalCacheDirectory);
+ </pre>
+</div>
+<div class="output">
+<span class="title"><p>Output example:</p></span><pre>Cache on external storage null
+</pre>
+</div>
+</li>
+<li class="attribute" id="FileSystemManager::externalRootDirectory">
+<span class="attrName"><span class="readonly"> readonly
+</span><span class="type">DOMString </span><span class="name">externalRootDirectory</span></span><div class="brief">
+ External storage root.
+ </div>
+<p><span class="version">
+ Since: </span>
+ 3.0
+ </p>
+<div class="example">
+<span class="example"><p>Code example:</p></span><pre name="code" class="examplecode prettyprint"> console.log("Root on external storage " + cordova.file.externalRootDirectory);
+ </pre>
+</div>
+<div class="output">
+<span class="title"><p>Output example:</p></span><pre>Root on external storage file:///usr/storage/sdcard/
+</pre>
+</div>
+</li>
+<li class="attribute" id="FileSystemManager::tempDirectory">
+<span class="attrName"><span class="readonly"> readonly
+</span><span class="type">DOMString </span><span class="name">tempDirectory</span></span><div class="brief">
+ Temp directory that the OS can clear at will. Do not rely on the OS to clear this directory; your app should always remove files as applicable.
+ </div>
+<p><span class="version">
+ Since: </span>
+ 3.0
+ </p>
+<div class="example">
+<span class="example"><p>Code example:</p></span><pre name="code" class="examplecode prettyprint"> console.log("Temp directory " + cordova.file.tempDirectory);
+ </pre>
+</div>
+<div class="output">
+<span class="title"><p>Output example:</p></span><pre>Temp directory null
+</pre>
+</div>
+</li>
+<li class="attribute" id="FileSystemManager::syncedDataDirectory">
+<span class="attrName"><span class="readonly"> readonly
+</span><span class="type">DOMString </span><span class="name">syncedDataDirectory</span></span><div class="brief">
+ Holds app-specific files that should be synced.
+ </div>
+<p><span class="version">
+ Since: </span>
+ 3.0
+ </p>
+<div class="example">
+<span class="example"><p>Code example:</p></span><pre name="code" class="examplecode prettyprint"> console.log("Synced data directory " + cordova.file.syncedDataDirectory);
+ </pre>
+</div>
+<div class="output">
+<span class="title"><p>Output example:</p></span><pre>Synced data directory null
+</pre>
+</div>
+</li>
+<li class="attribute" id="FileSystemManager::documentsDirectory">
+<span class="attrName"><span class="readonly"> readonly
+</span><span class="type">DOMString </span><span class="name">documentsDirectory</span></span><div class="brief">
+ Files private to the app, but that are meaningful to other application (e.g. Office files).
+ </div>
+<p><span class="version">
+ Since: </span>
+ 3.0
+ </p>
+<div class="example">
+<span class="example"><p>Code example:</p></span><pre name="code" class="examplecode prettyprint"> console.log("Documents directory " + cordova.file.documentsDirectory);
+ </pre>
+</div>
+<div class="output">
+<span class="title"><p>Output example:</p></span><pre>Documents directory null
+</pre>
+</div>
+</li>
+<li class="attribute" id="FileSystemManager::sharedDirectory">
+<span class="attrName"><span class="readonly"> readonly
+</span><span class="type">DOMString </span><span class="name">sharedDirectory</span></span><div class="brief">
+ Files globally available to all applications.
+ </div>
+<p><span class="version">
+ Since: </span>
+ 3.0
+ </p>
+<div class="example">
+<span class="example"><p>Code example:</p></span><pre name="code" class="examplecode prettyprint"> console.log("Files globally available to all applications " + cordova.file.sharedDirectory);
+ </pre>
+</div>
+<div class="output">
+<span class="title"><p>Output example:</p></span><pre>Files globally available to all applications file:///opt/usr/media/
+</pre>
+</div>
+</li>
+</ul>
+</div>
+</div>
+<div class="interface" id="FileSystem">
+<a class="backward-compatibility-anchor" name="::File::FileSystem"></a><h3>2.6. FileSystem</h3>
+<div class="brief">
+ This interface provides object that represents a file system.
+ </div>
+<pre class="webidl prettyprint"> [NoInterfaceObject] interface FileSystem {
+
+ readonly attribute DOMString name;
+
+ readonly attribute <a href="#DirectoryEntry">DirectoryEntry</a> root;
+ };</pre>
+<p><span class="version">
+ Since: </span>
+ 3.0
+ </p>
+<div class="attributes">
+<h4>Attributes</h4>
+<ul>
+<li class="attribute" id="FileSystem::name">
+<span class="attrName"><span class="readonly"> readonly
+</span><span class="type">DOMString </span><span class="name">name</span></span><div class="brief">
+ This is the name of the file system.
+ </div>
+<div class="description">
+ <p>
+The specifics of naming filesystems is unspecified, but a name must be unique across the list of exposed file systems.
+ </p>
+ </div>
+<p><span class="version">
+ Since: </span>
+ 3.0
+ </p>
+<div class="example">
+<span class="example"><p>Code example:</p></span><pre name="code" class="examplecode prettyprint"> requestFileSystem(TEMPORARY, 100, function (fileSystem) {
+ console.log('Name of the filesystem: '+fileSystem.name);
+ });
+ </pre>
+</div>
+<div class="output">
+<span class="title"><p>Output example:</p></span><pre>Name of the filesystem: temporary
+</pre>
+</div>
+</li>
+<li class="attribute" id="FileSystem::root">
+<span class="attrName"><span class="readonly"> readonly
+</span><span class="type">DirectoryEntry </span><span class="name">root</span></span><div class="brief">
+ The root directory of the file system.
+ </div>
+<p><span class="version">
+ Since: </span>
+ 3.0
+ </p>
+</li>
+</ul>
+</div>
+</div>
+<div class="interface" id="Metadata">
+<a class="backward-compatibility-anchor" name="::File::Metadata"></a><h3>2.7. Metadata</h3>
+<div class="brief">
+ This interface supplies information about the state of a file or directory.
+ </div>
+<pre class="webidl prettyprint"> interface Metadata {
+ readonly attribute Date modificationTime;
+
+ readonly attribute unsigned long long size;
+ };</pre>
+<p><span class="version">
+ Since: </span>
+ 3.0
+ </p>
+<div class="attributes">
+<h4>Attributes</h4>
+<ul>
+<li class="attribute" id="Metadata::modificationTime">
+<span class="attrName"><span class="readonly"> readonly
+</span><span class="type">Date </span><span class="name">modificationTime</span></span><div class="brief">
+ This is the time at which the file or directory was last modified.
+ </div>
+<p><span class="version">
+ Since: </span>
+ 3.0
+ </p>
+</li>
+<li class="attribute" id="Metadata::size">
+<span class="attrName"><span class="readonly"> readonly
+</span><span class="type">unsigned long long </span><span class="name">size</span></span><div class="brief">
+ The size of the file, in bytes. This must return 0 for directories.
+ </div>
+<p><span class="version">
+ Since: </span>
+ 3.0
+ </p>
+</li>
+</ul>
+</div>
+</div>
+<div class="interface" id="FileError">
+<a class="backward-compatibility-anchor" name="::File::FileError"></a><h3>2.8. FileError</h3>
+<div class="brief">
+ File Error
+ </div>
+<pre class="webidl prettyprint"> [NoInterfaceObject] interface FileError {
+ const unsigned short NOT_FOUND_ERR = 1;
+ const unsigned short SECURITY_ERR = 2;
+ const unsigned short ABORT_ERR = 3;
+ const unsigned short NOT_READABLE_ERR = 4;
+ const unsigned short ENCODING_ERR = 5;
+ const unsigned short NO_MODIFICATION_ALLOWED_ERR = 6;
+ const unsigned short INVALID_STATE_ERR = 7;
+ const unsigned short SYNTAX_ERR = 8;
+ const unsigned short INVALID_MODIFICATION_ERR = 9;
+ const unsigned short QUOTA_EXCEEDED_ERR = 10;
+ const unsigned short TYPE_MISMATCH_ERR = 11;
+ const unsigned short PATH_EXISTS_ERR = 12;
+ attribute unsigned short code;
+ };</pre>
+<p><span class="version">
+ Since: </span>
+ 3.0
+ </p>
+</div>
+<div class="interface" id="File">
+<a class="backward-compatibility-anchor" name="::File::File"></a><h3>2.9. File</h3>
+<div class="brief">
+ The File interface provides access to file's properties. File object could be created with using of <em>FileEntry.file()</em> method.
+ </div>
+<pre class="webidl prettyprint"> [NoInterfaceObject] interface File {
+
+ readonly attribute DOMString name;
+
+ readonly attribute DOMString localURL;
+
+ readonly attribute DOMString type;
+
+ readonly attribute Date lastModified;
+
+ readonly attribute long long size;
+ };</pre>
+<p><span class="version">
+ Since: </span>
+ 3.0
+ </p>
+<div class="attributes">
+<h4>Attributes</h4>
+<ul>
+<li class="attribute" id="File::name">
+<span class="attrName"><span class="readonly"> readonly
+</span><span class="type">DOMString </span><span class="name">name</span></span><div class="brief">
+ The name of the file.
+ </div>
+<p><span class="version">
+ Since: </span>
+ 3.0
+ </p>
+</li>
+<li class="attribute" id="File::localURL">
+<span class="attrName"><span class="readonly"> readonly
+</span><span class="type">DOMString </span><span class="name">localURL</span></span><div class="brief">
+ The full path of the file, including the name.
+ </div>
+<p><span class="version">
+ Since: </span>
+ 3.0
+ </p>
+</li>
+<li class="attribute" id="File::type">
+<span class="attrName"><span class="readonly"> readonly
+</span><span class="type">DOMString </span><span class="name">type</span></span><div class="brief">
+ The mime type of the file.
+ </div>
+<p><span class="version">
+ Since: </span>
+ 3.0
+ </p>
+</li>
+<li class="attribute" id="File::lastModified">
+<span class="attrName"><span class="readonly"> readonly
+</span><span class="type">Date </span><span class="name">lastModified</span></span><div class="brief">
+ The last modified date of the file.
+ </div>
+<p><span class="version">
+ Since: </span>
+ 3.0
+ </p>
+</li>
+<li class="attribute" id="File::size">
+<span class="attrName"><span class="readonly"> readonly
+</span><span class="type">long long </span><span class="name">size</span></span><div class="brief">
+ The size of the file in bytes.
+ </div>
+<p><span class="version">
+ Since: </span>
+ 3.0
+ </p>
+</li>
+</ul>
+</div>
+</div>
+<div class="interface" id="LocalFileSystem">
+<a class="backward-compatibility-anchor" name="::File::LocalFileSystem"></a><h3>2.10. LocalFileSystem</h3>
+<div class="brief">
+ This interface provides a way to obtain <em>Entry</em> and <em>FileSystem</em> objects.
+ </div>
+<pre class="webidl prettyprint"> [NoInterfaceObject] interface LocalFileSystem {
+
+ const short TEMPORARY = 0;
+
+ const short PERSISTENT = 1;
+
+ void requestFileSystem(short type, long long size, optional <a href="#FileSystemCallback">FileSystemCallback</a>? successCallback, optional <a href="#ErrorCallback">ErrorCallback</a>? errorCallback);
+
+ void resolveLocalFileSystemURL(DOMString uri, optional <a href="#EntryCallback">EntryCallback</a>? successCallback, optional <a href="#ErrorCallback">ErrorCallback</a>? errorCallback);
+
+ };</pre>
+<pre class="webidl prettyprint"> Window implements <a href="#LocalFileSystem">LocalFileSystem</a>;</pre>
+<p><span class="version">
+ Since: </span>
+ 3.0
+ </p>
+<div class="consts">
+<h4>Constants</h4>
+<dl>
+<li class="const" id="LocalFileSystem::TEMPORARY">
+<a class="backward-compatibility-anchor" name="::File::LocalFileSystem::TEMPORARY"></a><span class="name">TEMPORARY</span><div class="brief">
+ Used for storage with no guarantee of persistence.
+ </div>
+<p><span class="version">
+ Since: </span>
+ 3.0
+ </p>
+<br><br>
+</li>
+<li class="const" id="LocalFileSystem::PERSISTENT">
+<a class="backward-compatibility-anchor" name="::File::LocalFileSystem::PERSISTENT"></a><span class="name">PERSISTENT</span><div class="brief">
+ Used for storage that should not be removed by the user agent without application or user permission.
+ </div>
+<p><span class="version">
+ Since: </span>
+ 3.0
+ </p>
+<br><br>
+</li>
+</dl>
+</div>
+<div class="methods">
+<h4>Methods</h4>
+<dl>
+<dt class="method" id="LocalFileSystem::requestFileSystem">
+<a class="backward-compatibility-anchor" name="::File::LocalFileSystem::requestFileSystem"></a><code><b><span class="methodName">requestFileSystem</span></b></code>
+</dt>
+<dd>
+<div class="brief">
+ Request a file system in which to store application data.
+ </div>
+<div class="synopsis"><pre class="signature prettyprint">void requestFileSystem(short type, long long size, optional <a href="#FileSystemCallback">FileSystemCallback</a>? successCallback, optional <a href="#ErrorCallback">ErrorCallback</a>? errorCallback);
+ </pre></div>
+<p><span class="version">
+ Since: </span>
+ 3.0
+ </p>
+<p><span class="privilegelevel">
+ Privilege level: </span>
+ public
+ </p>
+<p><span class="privilege">
+ Privilege: </span>
+ http://tizen.org/privilege/filesystem.read
+ </p>
+<div class="parameters">
+<p><span class="param">Parameters:</span></p>
+<ul>
+ <li class="param">
+<span class="name">type</span>:
+ Local file system type, either TEMPORARY or PERSISTENT.
+ </li>
+ <li class="param">
+<span class="name">size</span>:
+ Indicates how much storage space, in bytes, the application expects to need.
+ </li>
+ <li class="param">
+<span class="name">successCallback</span><span class="optional"> [optional]</span><span class="optional"> [nullable]</span>:
+ Invoked with a <em>FileSystem</em> object.
+ </li>
+ <li class="param">
+<span class="name">errorCallback</span><span class="optional"> [optional]</span><span class="optional"> [nullable]</span>:
+ Invoked if error occurs retrieving file system.
+ </li>
+ </ul>
+</div>
+<div class="exceptionlist">
+<p><span class="except">Exceptions:</span></p>
+ <ul class="exception"><li>TypeError<ul><li class="list"><p>
+ if any of the input parameters has incorrect type.
+ </p></li></ul>
+</li></ul>
+ </div>
+<div class="example">
+<span class="example"><p>Code example:</p></span><pre name="code" class="examplecode prettyprint"> successCallback = function(fs) {
+ console.log('File system name ' + fs.name);
+ };
+
+ errorCallback = function(err) {
+ console.log(err.code);
+ };
+
+ requestFileSystem(TEMPORARY, 1024*1024, successCallback, errorCallback);
+
+ </pre>
+</div>
+<div class="output">
+<span class="title"><p>Output example:</p></span><pre>File system name temporary
+</pre>
+</div>
+</dd>
+<dt class="method" id="LocalFileSystem::resolveLocalFileSystemURL">
+<a class="backward-compatibility-anchor" name="::File::LocalFileSystem::resolveLocalFileSystemURL"></a><code><b><span class="methodName">resolveLocalFileSystemURL</span></b></code>
+</dt>
+<dd>
+<div class="brief">
+ Retrieves a <em>DirectoryEntry</em> or <em>FileEntry</em> using local URI.
+ </div>
+<div class="synopsis"><pre class="signature prettyprint">void resolveLocalFileSystemURL(DOMString uri, optional <a href="#EntryCallback">EntryCallback</a>? successCallback, optional <a href="#ErrorCallback">ErrorCallback</a>? errorCallback);
+ </pre></div>
+<p><span class="version">
+ Since: </span>
+ 3.0
+ </p>
+<p><span class="privilegelevel">
+ Privilege level: </span>
+ public
+ </p>
+<p><span class="privilege">
+ Privilege: </span>
+ http://tizen.org/privilege/filesystem.read
+ </p>
+<div class="parameters">
+<p><span class="param">Parameters:</span></p>
+<ul>
+ <li class="param">
+<span class="name">uri</span>:
+ URI referring to a local file or directory.
+ </li>
+ <li class="param">
+<span class="name">successCallback</span><span class="optional"> [optional]</span><span class="optional"> [nullable]</span>:
+ Invoked with <em>Entry</em> object corresponding to URI.
+ </li>
+ <li class="param">
+<span class="name">errorCallback</span><span class="optional"> [optional]</span><span class="optional"> [nullable]</span>:
+ Invoked if error occurs retrieving file system entry.
+ </li>
+ </ul>
+</div>
+<div class="exceptionlist">
+<p><span class="except">Exceptions:</span></p>
+ <ul class="exception"><li>TypeError<ul><li class="list"><p>
+ if any of the input parameters has incorrect type.
+ </p></li></ul>
+</li></ul>
+ </div>
+<div class="example">
+<span class="example"><p>Code example:</p></span><pre name="code" class="examplecode prettyprint"> successCallback = function(entry) {
+ console.log('Entry name ' + entry.name);
+ };
+
+ errorCallback = function(err) {
+ console.log(err.code);
+ };
+
+ var uri = 'file:///home/owner/content/Documents/example.txt';
+ resolveLocalFileSystemURL(uri, successCallback, errorCallback);
+
+ </pre>
+</div>
+<div class="output">
+<span class="title"><p>Output example:</p></span><pre>Entry name example.txt
+</pre>
+</div>
+</dd>
+</dl>
+</div>
+</div>
+<div class="interface" id="Entry">
+<a class="backward-compatibility-anchor" name="::File::Entry"></a><h3>2.11. Entry</h3>
+<div class="brief">
+ The Entry interface.
+ </div>
+<pre class="webidl prettyprint"> [NoInterfaceObject] interface Entry {
+
+ readonly attribute boolean isFile;
+
+ readonly attribute boolean isDirectory;
+
+ readonly attribute DOMString fullPath;
+
+ readonly attribute DOMString name;
+
+ readonly attribute <a href="#FileSystem">FileSystem</a> filesystem;
+
+ void getMetadata(<a href="#MetadataCallback">MetadataCallback</a> onsuccess, optional <a href="#ErrorCallback">ErrorCallback</a>? onerror);
+
+ void moveTo(<a href="#DirectoryEntry">DirectoryEntry</a> parent, optional DOMString? newName, optional <a href="#EntryCallback">EntryCallback</a>? onsuccess, optional <a href="#ErrorCallback">ErrorCallback</a>? onerror);
+
+ void copyTo(<a href="#DirectoryEntry">DirectoryEntry</a> parent, optional DOMString? newName, optional <a href="#EntryCallback">EntryCallback</a>? onsuccess, optional <a href="#ErrorCallback">ErrorCallback</a>? onerror);
+
+ void getParent(<a href="#EntryCallback">EntryCallback</a> onsuccess, optional <a href="#ErrorCallback">ErrorCallback</a>? onerror);
+
+ void remove(<a href="#VoidCallback">VoidCallback</a> onsuccess, optional <a href="#ErrorCallback">ErrorCallback</a>? onerror);
+
+ DOMString toURL();
+ };</pre>
+<p><span class="version">
+ Since: </span>
+ 3.0
+ </p>
+<div class="attributes">
+<h4>Attributes</h4>
+<ul>
+<li class="attribute" id="Entry::isFile">
+<span class="attrName"><span class="readonly"> readonly
+</span><span class="type">boolean </span><span class="name">isFile</span></span><div class="brief">
+ True if the entry is a file.
+ </div>
+<p><span class="version">
+ Since: </span>
+ 3.0
+ </p>
+</li>
+<li class="attribute" id="Entry::isDirectory">
+<span class="attrName"><span class="readonly"> readonly
+</span><span class="type">boolean </span><span class="name">isDirectory</span></span><div class="brief">
+ True if the entry is a directory.
+ </div>
+<p><span class="version">
+ Since: </span>
+ 3.0
+ </p>
+</li>
+<li class="attribute" id="Entry::fullPath">
+<span class="attrName"><span class="readonly"> readonly
+</span><span class="type">DOMString </span><span class="name">fullPath</span></span><div class="brief">
+ The full absolute path from the root to the entry. An absolute path is a relative path from the root directory, prepended with a '/'.
+ </div>
+<p><span class="version">
+ Since: </span>
+ 3.0
+ </p>
+</li>
+<li class="attribute" id="Entry::name">
+<span class="attrName"><span class="readonly"> readonly
+</span><span class="type">DOMString </span><span class="name">name</span></span><div class="brief">
+ The name of the entry, excluding the path leading to it.
+ </div>
+<p><span class="version">
+ Since: </span>
+ 3.0
+ </p>
+</li>
+<li class="attribute" id="Entry::filesystem">
+<span class="attrName"><span class="readonly"> readonly
+</span><span class="type">FileSystem </span><span class="name">filesystem</span></span><div class="brief">
+ The file system where the entry resides.
+ </div>
+<p><span class="version">
+ Since: </span>
+ 3.0
+ </p>
+</li>
+</ul>
+</div>
+<div class="methods">
+<h4>Methods</h4>
+<dl>
+<dt class="method" id="Entry::getMetadata">
+<a class="backward-compatibility-anchor" name="::File::Entry::getMetadata"></a><code><b><span class="methodName">getMetadata</span></b></code>
+</dt>
+<dd>
+<div class="brief">
+ Look up metadata about this entry.
+ </div>
+<div class="synopsis"><pre class="signature prettyprint">void getMetadata(<a href="#MetadataCallback">MetadataCallback</a> onsuccess, optional <a href="#ErrorCallback">ErrorCallback</a>? onerror);
+ </pre></div>
+<p><span class="version">
+ Since: </span>
+ 3.0
+ </p>
+<p><span class="privilegelevel">
+ Privilege level: </span>
+ public
+ </p>
+<p><span class="privilege">
+ Privilege: </span>
+ http://tizen.org/privilege/filesystem.read
+ </p>
+<div class="parameters">
+<p><span class="param">Parameters:</span></p>
+<ul>
+ <li class="param">
+<span class="name">onsuccess</span>:
+ A callback that is called with the time of the last modification.
+ </li>
+ <li class="param">
+<span class="name">onerror</span><span class="optional"> [optional]</span><span class="optional"> [nullable]</span>:
+ A callback that is called when errors happen.
+ </li>
+ </ul>
+</div>
+<div class="exceptionlist">
+<p><span class="except">Exceptions:</span></p>
+ <ul class="exception"><li>FileException<ul><li class="list"><p>
+ with error type TYPE_MISMATCH_ERR, if any of the input parameter is not compatible with the expected type for that parameter.
+ </p></li></ul>
+</li></ul>
+ </div>
+<div class="example">
+<span class="example"><p>Code example:</p></span><pre name="code" class="examplecode prettyprint"> requestFileSystem(TEMPORARY, 100, function(fs) {
+ fs.root.getMetadata(function (metadata) {
+ console.log("Last modification time: " + metadata.modificationTime);// get metadata successfully
+ });
+ });
+ </pre>
+</div>
+<div class="output">
+<span class="title"><p>Output example:</p></span><pre>Last modification time: Fri Jan 02 2015 03:58:08 GMT+0900 (KST)
+</pre>
+</div>
+</dd>
+<dt class="method" id="Entry::moveTo">
+<a class="backward-compatibility-anchor" name="::File::Entry::moveTo"></a><code><b><span class="methodName">moveTo</span></b></code>
+</dt>
+<dd>
+<div class="brief">
+ Move an entry to a different location on the file system.
+ </div>
+<div class="synopsis"><pre class="signature prettyprint">void moveTo(<a href="#DirectoryEntry">DirectoryEntry</a> parent, optional DOMString? newName, optional <a href="#EntryCallback">EntryCallback</a>? onsuccess, optional <a href="#ErrorCallback">ErrorCallback</a>? onerror);
+ </pre></div>
+<p><span class="version">
+ Since: </span>
+ 3.0
+ </p>
+<div class="description">
+ <p>
+It is an error to try to:
+ </p>
+ <ul>
+ <li>
+move a directory inside itself or to any child at any depth </li>
+ <li>
+move an entry into its parent if a name different from its current one isn't provided </li>
+ <li>
+move a file to a path occupied by a directory </li>
+ <li>
+move a directory to a path occupied by a file </li>
+ <li>
+move any element to a path occupied by a directory which is not empty </li>
+ </ul>
+ <p>
+A move of a file on top of an existing file must attempt to delete and replace that file.
+A move of a directory on top of an existing empty directory must attempt to delete and replace that directory.
+ </p>
+ </div>
+<p><span class="privilegelevel">
+ Privilege level: </span>
+ public
+ </p>
+<p><span class="privilege">
+ Privilege: </span>
+ http://tizen.org/privilege/filesystem.read
+ </p>
+<p><span class="privilege">
+ Privilege: </span>
+ http://tizen.org/privilege/filesystem.write
+ </p>
+<div class="parameters">
+<p><span class="param">Parameters:</span></p>
+<ul>
+ <li class="param">
+<span class="name">parent</span>:
+ The directory to which to move the entry.
+ </li>
+ <li class="param">
+<span class="name">newName</span><span class="optional"> [optional]</span><span class="optional"> [nullable]</span>:
+ The new name of the entry. Defaults to the Entry's current name if unspecified.
+ </li>
+ <li class="param">
+<span class="name">onsuccess</span><span class="optional"> [optional]</span><span class="optional"> [nullable]</span>:
+ A callback that is called with the Entry for the new location.
+ </li>
+ <li class="param">
+<span class="name">onerror</span><span class="optional"> [optional]</span><span class="optional"> [nullable]</span>:
+ Callback method to be invoked when an error has occurred
+ </li>
+ </ul>
+</div>
+<div class="exceptionlist">
+<p><span class="except">Exceptions:</span></p>
+ <ul class="exception"><li>FileException<ul><li class="list"><p>
+ with error type TYPE_MISMATCH_ERR, if any of the input parameter is not compatible with the expected type for that parameter.
+ </p></li></ul>
+</li></ul>
+ </div>
+<div class="example">
+<span class="example"><p>Code example:</p></span><pre name="code" class="examplecode prettyprint"> successCallback = function(entry){console.log('Full path to the moved file: '+entry.fullPath)};
+ requestFileSystem(TEMPORARY, 100, function(fs) {
+ fs.root.getDirectory('testDirectory', {create:true}, function(direntry) {
+ fs.root.getFile("aa.txt", {create:true}, function(fileentry) {
+ console.log('Full path before move: '+fileentry.fullPath);
+ fileentry.moveTo(direntry,'newname.txt',successCallback);
+ });
+ });
+ });
+ </pre>
+</div>
+<div class="output">
+<span class="title"><p>Output example:</p></span><pre>Full path before move: /aa.txt
+Full path to the moved file: /testDirectory/newname.txt
+</pre>
+</div>
+</dd>
+<dt class="method" id="Entry::copyTo">
+<a class="backward-compatibility-anchor" name="::File::Entry::copyTo"></a><code><b><span class="methodName">copyTo</span></b></code>
+</dt>
+<dd>
+<div class="brief">
+ Copy an entry to a different location on the file system.
+ </div>
+<div class="synopsis"><pre class="signature prettyprint">void copyTo(<a href="#DirectoryEntry">DirectoryEntry</a> parent, optional DOMString? newName, optional <a href="#EntryCallback">EntryCallback</a>? onsuccess, optional <a href="#ErrorCallback">ErrorCallback</a>? onerror);
+ </pre></div>
+<p><span class="version">
+ Since: </span>
+ 3.0
+ </p>
+<div class="description">
+ <p>
+It is an error to try to:
+ </p>
+ <ul>
+ <li>
+copy a directory inside itself or to any child at any depth </li>
+ <li>
+copy an entry into its parent if a name different from its current one isn't provided </li>
+ <li>
+copy a file to a path occupied by a directory </li>
+ <li>
+copy a directory to a path occupied by a file </li>
+ <li>
+copy any element to a path occupied by a directory which is not empty </li>
+ </ul>
+ <p>
+A copy of a file on top of an existing file must attempt to delete and replace that file.
+A copy of a directory on top of an existing empty directory must attempt to delete and replace that directory.
+Directory copies are always recursive--that is, they copy all contents of the directory.
+ </p>
+ </div>
+<p><span class="privilegelevel">
+ Privilege level: </span>
+ public
+ </p>
+<p><span class="privilege">
+ Privilege: </span>
+ http://tizen.org/privilege/filesystem.read
+ </p>
+<p><span class="privilege">
+ Privilege: </span>
+ http://tizen.org/privilege/filesystem.write
+ </p>
+<div class="parameters">
+<p><span class="param">Parameters:</span></p>
+<ul>
+ <li class="param">
+<span class="name">parent</span>:
+ The directory to which to copy the entry.
+ </li>
+ <li class="param">
+<span class="name">newName</span><span class="optional"> [optional]</span><span class="optional"> [nullable]</span>:
+ The new name of the entry. Defaults to the Entry's current name if unspecified.
+ </li>
+ <li class="param">
+<span class="name">onsuccess</span><span class="optional"> [optional]</span><span class="optional"> [nullable]</span>:
+ A callback that is called with the Entry for the new location.
+ </li>
+ <li class="param">
+<span class="name">onerror</span><span class="optional"> [optional]</span><span class="optional"> [nullable]</span>:
+ Callback method to be invoked when an error has occurred.
+ </li>
+ </ul>
+</div>
+<div class="exceptionlist">
+<p><span class="except">Exceptions:</span></p>
+ <ul class="exception"><li>FileException<ul><li class="list"><p>
+ with error type TYPE_MISMATCH_ERR, if any of the input parameter is not compatible with the expected type for that parameter.
+ </p></li></ul>
+</li></ul>
+ </div>
+<div class="example">
+<span class="example"><p>Code example:</p></span><pre name="code" class="examplecode prettyprint"> successCallback = function(entry){console.log('Full path to the copied file: '+entry.fullPath);};
+ requestFileSystem(TEMPORARY, 100, function(fs) {
+ fs.root.getDirectory('testDirectory', {create:true},
+ function(direntry) {
+ fs.root.getFile("test.txt", {create:true},
+ function(fileentry) {
+ fileentry.copyTo(direntry,'newname.txt',successCallback);
+ }
+ );
+ });
+ });
+ </pre>
+</div>
+<div class="output">
+<span class="title"><p>Output example:</p></span><pre>Full path to the copied file: /testDirectory/newname.txt
+</pre>
+</div>
+</dd>
+<dt class="method" id="Entry::getParent">
+<a class="backward-compatibility-anchor" name="::File::Entry::getParent"></a><code><b><span class="methodName">getParent</span></b></code>
+</dt>
+<dd>
+<div class="brief">
+ Look up the parent DirectoryEntry containing this Entry. If this Entry is the root of its filesystem, its parent is itself.
+ </div>
+<div class="synopsis"><pre class="signature prettyprint">void getParent(<a href="#EntryCallback">EntryCallback</a> onsuccess, optional <a href="#ErrorCallback">ErrorCallback</a>? onerror);
+ </pre></div>
+<p><span class="version">
+ Since: </span>
+ 3.0
+ </p>
+<p><span class="privilegelevel">
+ Privilege level: </span>
+ public
+ </p>
+<p><span class="privilege">
+ Privilege: </span>
+ http://tizen.org/privilege/filesystem.read
+ </p>
+<div class="parameters">
+<p><span class="param">Parameters:</span></p>
+<ul>
+ <li class="param">
+<span class="name">onsuccess</span>:
+ A callback that is called to return the parent Entry.
+ </li>
+ <li class="param">
+<span class="name">onerror</span><span class="optional"> [optional]</span><span class="optional"> [nullable]</span>:
+ Callback method to be invoked when an error has occurred.
+ </li>
+ </ul>
+</div>
+<div class="exceptionlist">
+<p><span class="except">Exceptions:</span></p>
+ <ul class="exception"><li>FileException<ul><li class="list"><p>
+ with error type TYPE_MISMATCH_ERR, if any of the input parameter is not compatible with the expected type for that parameter.
+ </p></li></ul>
+</li></ul>
+ </div>
+<div class="example">
+<span class="example"><p>Code example:</p></span><pre name="code" class="examplecode prettyprint"> requestFileSystem(TEMPORARY, 100, function(fs) {
+ fs.root.getParent(function (entry) {
+ console.log("success");
+ });
+ });
+ </pre>
+</div>
+<div class="output">
+<span class="title"><p>Output example:</p></span><pre>success
+</pre>
+</div>
+</dd>
+<dt class="method" id="Entry::remove">
+<a class="backward-compatibility-anchor" name="::File::Entry::remove"></a><code><b><span class="methodName">remove</span></b></code>
+</dt>
+<dd>
+<div class="brief">
+ Deletes a file or directory. It is an error to attempt to delete a directory that is not empty. It is an error to attempt to delete the root directory of a filesystem.
+ </div>
+<div class="synopsis"><pre class="signature prettyprint">void remove(<a href="#VoidCallback">VoidCallback</a> onsuccess, optional <a href="#ErrorCallback">ErrorCallback</a>? onerror);
+ </pre></div>
+<p><span class="version">
+ Since: </span>
+ 3.0
+ </p>
+<p><span class="privilegelevel">
+ Privilege level: </span>
+ public
+ </p>
+<p><span class="privilege">
+ Privilege: </span>
+ http://tizen.org/privilege/filesystem.read
+ </p>
+<p><span class="privilege">
+ Privilege: </span>
+ http://tizen.org/privilege/filesystem.write
+ </p>
+<div class="parameters">
+<p><span class="param">Parameters:</span></p>
+<ul>
+ <li class="param">
+<span class="name">onsuccess</span>:
+ A callback that is called on success.
+ </li>
+ <li class="param">
+<span class="name">onerror</span><span class="optional"> [optional]</span><span class="optional"> [nullable]</span>:
+ Callback method to be invoked when an error has occurred.
+ </li>
+ </ul>
+</div>
+<div class="exceptionlist">
+<p><span class="except">Exceptions:</span></p>
+ <ul class="exception"><li>FileException<ul><li class="list"><p>
+ with error type TYPE_MISMATCH_ERR, if any of the input parameter is not compatible with the expected type for that parameter.
+ </p></li></ul>
+</li></ul>
+ </div>
+<div class="example">
+<span class="example"><p>Code example:</p></span><pre name="code" class="examplecode prettyprint"> requestFileSystem(TEMPORARY, 100, function(fs) {
+ fs.root.getFile('test.txt', {create: true}, function(fileEntry) {
+ fileEntry.remove(function () {
+ console.log("success");
+ });
+ });
+ });
+ </pre>
+</div>
+<div class="output">
+<span class="title"><p>Output example:</p></span><pre>success
+</pre>
+</div>
+</dd>
+<dt class="method" id="Entry::toURL">
+<a class="backward-compatibility-anchor" name="::File::Entry::toURL"></a><code><b><span class="methodName">toURL</span></b></code>
+</dt>
+<dd>
+<div class="brief">
+ Returns a URL that can be used to identify this entry. Unlike the URN defined in [FILE-API-ED], it has no specific expiration; as it describes a location on disk, it should be valid at least as long as that location exists.
+ </div>
+<div class="synopsis"><pre class="signature prettyprint">DOMString toURL();
+ </pre></div>
+<p><span class="version">
+ Since: </span>
+ 3.0
+ </p>
+<div class="returntype">
+<p><span class="return">Return value:</span></p>
+ URL that can be used to identify this entry.
+ </div>
+<div class="example">
+<span class="example"><p>Code example:</p></span><pre name="code" class="examplecode prettyprint"> requestFileSystem(TEMPORARY, 100, function(fs) {
+ fs.root.getDirectory('testDirectory', {create:true},
+ function(entry) {
+ var url = entry.toURL();
+ console.log('URL: '+url);
+ });
+ });
+ </pre>
+</div>
+<div class="output">
+<span class="title"><p>Output example:</p></span><pre>URL: file:///home/owner/apps_rw/WfigBlWDyf/tmp/testDirectory/
+</pre>
+</div>
+</dd>
+</dl>
+</div>
+</div>
+<div class="interface" id="DirectoryEntry">
+<a class="backward-compatibility-anchor" name="::File::DirectoryEntry"></a><h3>2.12. DirectoryEntry</h3>
+<div class="brief">
+ The DirectoryEntry interface provides access to the Filesystem API.
+ </div>
+<pre class="webidl prettyprint"> interface DirectoryEntry : <a href="#Entry">Entry</a> {
+
+ <a href="#DirectoryReader">DirectoryReader</a> createReader();
+
+ void getDirectory(DOMString path, optional ? options, optional <a href="#EntryCallback">EntryCallback</a>? onsuccess, optional <a href="#ErrorCallback">ErrorCallback</a>? onerror);
+
+ void getFile(DOMString path, optional ? options, optional <a href="#EntryCallback">EntryCallback</a>? onsuccess, optional <a href="#ErrorCallback">ErrorCallback</a>? onerror);
+
+ void removeRecursively(<a href="#VoidCallback">VoidCallback</a> onsuccess, optional <a href="#ErrorCallback">ErrorCallback</a>? onerror);
+ };</pre>
+<p><span class="version">
+ Since: </span>
+ 3.0
+ </p>
+
+ <div class="methods">
+<h4>Methods</h4>
+<dl>
+<dt class="method" id="DirectoryEntry::createReader">
+<a class="backward-compatibility-anchor" name="::File::DirectoryEntry::createReader"></a><code><b><span class="methodName">createReader</span></b></code>
+</dt>
+<dd>
+<div class="brief">
+ Creates a new DirectoryReader to read Entries from this Directory.
+ </div>
+<div class="synopsis"><pre class="signature prettyprint"><a href="#DirectoryReader">DirectoryReader</a> createReader();
+ </pre></div>
+<p><span class="version">
+ Since: </span>
+ 3.0
+ </p>
+<p><span class="privilegelevel">
+ Privilege level: </span>
+ public
+ </p>
+<p><span class="privilege">
+ Privilege: </span>
+ http://tizen.org/privilege/filesystem.read
+ </p>
+<div class="returntype">
+<p><span class="return">Return value:</span></p>
+ DirectoryReader
+ </div>
+<div class="example">
+<span class="example"><p>Code example:</p></span><pre name="code" class="examplecode prettyprint"> requestFileSystem(TEMPORARY, 100, function (entry) {
+ entry.root.getDirectory("MyDocument", {create:true}, function(dirEntry) {
+ var directoryReader = dirEntry.createReader();
+ });
+ });
+ </pre>
+</div>
+</dd>
+<dt class="method" id="DirectoryEntry::getDirectory">
+<a class="backward-compatibility-anchor" name="::File::DirectoryEntry::getDirectory"></a><code><b><span class="methodName">getDirectory</span></b></code>
+</dt>
+<dd>
+<div class="brief">
+ Creates or looks up a directory.
+ </div>
+<div class="synopsis"><pre class="signature prettyprint">void getDirectory(DOMString path, optional ? options, optional <a href="#EntryCallback">EntryCallback</a>? onsuccess, optional <a href="#ErrorCallback">ErrorCallback</a>? onerror);
+ </pre></div>
+<p><span class="version">
+ Since: </span>
+ 3.0
+ </p>
+<div class="description">
+ <ul>
+ <li>
+If create and exclusive are both true and the path already exists, getDirectory must fail. </li>
+ <li>
+If create is true, the path doesn't exist, and no other error occurs, getDirectory must create and return a corresponding DirectoryEntry. </li>
+ <li>
+If create is not true and the path doesn't exist, getDirectory must fail. </li>
+ <li>
+If create is not true and the path exists, but is a file, getDirectory must fail. </li>
+ <li>
+Otherwise, if no other error occurs, getDirectory must return a DirectoryEntry corresponding to path. </li>
+ </ul>
+ </div>
+<p><span class="privilegelevel">
+ Privilege level: </span>
+ public
+ </p>
+<p><span class="privilege">
+ Privilege: </span>
+ http://tizen.org/privilege/filesystem.read
+ </p>
+<p><span class="privilege">
+ Privilege: </span>
+ http://tizen.org/privilege/filesystem.write
+ </p>
+<div class="parameters">
+<p><span class="param">Parameters:</span></p>
+<ul>
+ <li class="param">
+<span class="name">path</span>:
+ Either an absolute path or a relative path from this DirectoryEntry to the directory to be looked up or created. It is an error to attempt to create a directory whose immediate parent does not yet exist.
+ </li>
+ <li class="param">
+<span class="name">options</span><span class="optional"> [optional]</span><span class="optional"> [nullable]</span>:
+ Flags
+ </li>
+ <li class="param">
+<span class="name">onsuccess</span><span class="optional"> [optional]</span><span class="optional"> [nullable]</span>:
+ A callback that is called to return the DirectoryEntry selected or created.
+ </li>
+ <li class="param">
+<span class="name">onerror</span><span class="optional"> [optional]</span><span class="optional"> [nullable]</span>:
+ Callback method to be invoked when an error has occurred.
+ </li>
+ </ul>
+</div>
+<div class="exceptionlist">
+<p><span class="except">Exceptions:</span></p>
+ <ul class="exception"><li>FileException<ul><li class="list"><p>
+ with error type TYPE_MISMATCH_ERR, if any of the input parameter is not compatible with the expected type for that parameter.
+ </p></li></ul>
+</li></ul>
+ </div>
+<div class="example">
+<span class="example"><p>Code example:</p></span><pre name="code" class="examplecode prettyprint"> requestFileSystem(TEMPORARY, 100, function(fs) {
+ fs.root.getDirectory("ert",{create:true},function(dir){
+ console.log('Created dir: '+dir.name);
+ })
+ });
+ </pre>
+</div>
+<div class="output">
+<span class="title"><p>Output example:</p></span><pre>Created dir: ert
+</pre>
+</div>
+</dd>
+<dt class="method" id="DirectoryEntry::getFile">
+<a class="backward-compatibility-anchor" name="::File::DirectoryEntry::getFile"></a><code><b><span class="methodName">getFile</span></b></code>
+</dt>
+<dd>
+<div class="brief">
+ Creates or looks up a file.
+ </div>
+<div class="synopsis"><pre class="signature prettyprint">void getFile(DOMString path, optional ? options, optional <a href="#EntryCallback">EntryCallback</a>? onsuccess, optional <a href="#ErrorCallback">ErrorCallback</a>? onerror);
+ </pre></div>
+<p><span class="version">
+ Since: </span>
+ 3.0
+ </p>
+<div class="description">
+ <ul>
+ <li>
+If create and exclusive are both true, and the path already exists, getFile must fail. </li>
+ <li>
+If create is true, the path doesn't exist, and no other error occurs, getFile must create it as a zero-length file and return a corresponding FileEntry. </li>
+ <li>
+If create is not true and the path doesn't exist, getFile must fail. </li>
+ <li>
+If create is not true and the path exists, but is a directory, getFile must fail. </li>
+ <li>
+Otherwise, if no other error occurs, getFile must return a FileEntry corresponding to path. </li>
+ </ul>
+ </div>
+<p><span class="privilegelevel">
+ Privilege level: </span>
+ public
+ </p>
+<p><span class="privilege">
+ Privilege: </span>
+ http://tizen.org/privilege/filesystem.read
+ </p>
+<p><span class="privilege">
+ Privilege: </span>
+ http://tizen.org/privilege/filesystem.write
+ </p>
+<div class="parameters">
+<p><span class="param">Parameters:</span></p>
+<ul>
+ <li class="param">
+<span class="name">path</span>:
+ Either an absolute path or a relative path from this DirectoryEntry to the file to be looked up or created. It is an error to attempt to create a file whose immediate parent does not yet exist.
+ </li>
+ <li class="param">
+<span class="name">options</span><span class="optional"> [optional]</span><span class="optional"> [nullable]</span>:
+ Flags
+ </li>
+ <li class="param">
+<span class="name">onsuccess</span><span class="optional"> [optional]</span><span class="optional"> [nullable]</span>:
+ A callback that is called to return the File selected or created.
+ </li>
+ <li class="param">
+<span class="name">onerror</span><span class="optional"> [optional]</span><span class="optional"> [nullable]</span>:
+ Callback method to be invoked when an error has occurred.
+ </li>
+ </ul>
+</div>
+<div class="exceptionlist">
+<p><span class="except">Exceptions:</span></p>
+ <ul class="exception"><li>FileException<ul><li class="list"><p>
+ with error type TYPE_MISMATCH_ERR, if any of the input parameter is not compatible with the expected type for that parameter.
+ </p></li></ul>
+</li></ul>
+ </div>
+<div class="example">
+<span class="example"><p>Code example:</p></span><pre name="code" class="examplecode prettyprint"> requestFileSystem(TEMPORARY, 100, function(fs) {
+ fs.root.getFile("qa.txt",{create:true},function(file){
+ console.log('Created file: '+file.name);
+ });
+ });
+ </pre>
+</div>
+<div class="output">
+<span class="title"><p>Output example:</p></span><pre>Created file: qa.txt
+</pre>
+</div>
+</dd>
+<dt class="method" id="DirectoryEntry::removeRecursively">
+<a class="backward-compatibility-anchor" name="::File::DirectoryEntry::removeRecursively"></a><code><b><span class="methodName">removeRecursively</span></b></code>
+</dt>
+<dd>
+<div class="brief">
+ Deletes a directory and all of its contents, if any. In the event of an error [e.g. trying to delete a directory that contains a file that cannot be removed], some of the contents of the directory may be deleted. It is an error to attempt to delete the root directory of a filesystem.
+ </div>
+<div class="synopsis"><pre class="signature prettyprint">void removeRecursively(<a href="#VoidCallback">VoidCallback</a> onsuccess, optional <a href="#ErrorCallback">ErrorCallback</a>? onerror);
+ </pre></div>
+<p><span class="version">
+ Since: </span>
+ 3.0
+ </p>
+<p><span class="privilegelevel">
+ Privilege level: </span>
+ public
+ </p>
+<p><span class="privilege">
+ Privilege: </span>
+ http://tizen.org/privilege/filesystem.read
+ </p>
+<p><span class="privilege">
+ Privilege: </span>
+ http://tizen.org/privilege/filesystem.write
+ </p>
+<div class="parameters">
+<p><span class="param">Parameters:</span></p>
+<ul>
+ <li class="param">
+<span class="name">onsuccess</span>:
+ A callback that is called on success.
+ </li>
+ <li class="param">
+<span class="name">onerror</span><span class="optional"> [optional]</span><span class="optional"> [nullable]</span>:
+ Callback method to be invoked when an error has occurred.
+ </li>
+ </ul>
+</div>
+<div class="exceptionlist">
+<p><span class="except">Exceptions:</span></p>
+ <ul class="exception"><li>FileException<ul><li class="list"><p>
+ with error type TYPE_MISMATCH_ERR, if any of the input parameter is not compatible with the expected type for that parameter.
+ </p></li></ul>
+</li></ul>
+ </div>
+<div class="example">
+<span class="example"><p>Code example:</p></span><pre name="code" class="examplecode prettyprint"> requestFileSystem(TEMPORARY, 100, function(fs) {
+ fs.root.getDirectory("testDirectory", {create:true},
+ function(directoryEntry) {
+ directoryEntry.removeRecursively(function() {
+ console.log("success");
+ });
+ });
+ });
+ </pre>
+</div>
+<div class="output">
+<span class="title"><p>Output example:</p></span><pre>success
+</pre>
+</div>
+</dd>
+</dl>
+</div>
+</div>
+<div class="interface" id="DirectoryReader">
+<a class="backward-compatibility-anchor" name="::File::DirectoryReader"></a><h3>2.13. DirectoryReader</h3>
+<div class="brief">
+ The DirectoryReader interface provides access to the Filesystem API.
+ </div>
+<pre class="webidl prettyprint"> [NoInterfaceObject] interface DirectoryReader {
+
+ void readEntries(<a href="#EntriesCallback">EntriesCallback</a> onsuccess, optional <a href="#ErrorCallback">ErrorCallback</a>? onerror);
+ };</pre>
+<div class="methods">
+<h4>Methods</h4>
+<dl>
+<dt class="method" id="DirectoryReader::readEntries">
+<a class="backward-compatibility-anchor" name="::File::DirectoryReader::readEntries"></a><code><b><span class="methodName">readEntries</span></b></code>
+</dt>
+<dd>
+<div class="brief">
+ Read the next block of entries from this directory.
+ </div>
+<div class="synopsis"><pre class="signature prettyprint">void readEntries(<a href="#EntriesCallback">EntriesCallback</a> onsuccess, optional <a href="#ErrorCallback">ErrorCallback</a>? onerror);
+ </pre></div>
+<p><span class="version">
+ Since: </span>
+ 3.0
+ </p>
+<p><span class="privilegelevel">
+ Privilege level: </span>
+ public
+ </p>
+<p><span class="privilege">
+ Privilege: </span>
+ http://tizen.org/privilege/filesystem.read
+ </p>
+<div class="parameters">
+<p><span class="param">Parameters:</span></p>
+<ul>
+ <li class="param">
+<span class="name">onsuccess</span>:
+ Called once per successful call to readEntries to deliver the next previously-unreported set of Entries in the associated Directory. If all Entries have already been returned from previous invocations of readEntries, successCallback must be called with a zero-length array as an argument.
+ </li>
+ <li class="param">
+<span class="name">onerror</span><span class="optional"> [optional]</span><span class="optional"> [nullable]</span>:
+ A callback indicating that there was an error reading from the Directory.
+ </li>
+ </ul>
+</div>
+<div class="exceptionlist">
+<p><span class="except">Exceptions:</span></p>
+ <ul class="exception"><li>FileException<ul><li class="list"><p>
+ with error type TYPE_MISMATCH_ERR, if any of the input parameter is not compatible with the expected type for that parameter.
+ </p></li></ul>
+</li></ul>
+ </div>
+<div class="example">
+<span class="example"><p>Code example:</p></span><pre name="code" class="examplecode prettyprint"> requestFileSystem(TEMPORARY, 100, function(fs) {
+ var a = fs.root.createReader();
+ a.readEntries(function successCallback(entries) {
+ console.log("success");
+ });
+ });
+ </pre>
+</div>
+<div class="output">
+<span class="title"><p>Output example:</p></span><pre>success
+</pre>
+</div>
+</dd>
+</dl>
+</div>
+</div>
+<div class="interface" id="FileEntry">
+<a class="backward-compatibility-anchor" name="::File::FileEntry"></a><h3>2.14. FileEntry</h3>
+<div class="brief">
+ The FileEntry interface provides access to the Filesystem API.
+ </div>
+<pre class="webidl prettyprint"> [NoInterfaceObject] interface FileEntry : <a href="#Entry">Entry</a> {
+
+ void createWriter(<a href="#FileWriterCallback">FileWriterCallback</a> onsuccess, optional <a href="#ErrorCallback">ErrorCallback</a>? onerror);
+
+ void file (<a href="#FileCallback">FileCallback</a> onsuccess, optional <a href="#ErrorCallback">ErrorCallback</a> onerror);
+ };</pre>
+
+ <div class="methods">
+<h4>Methods</h4>
+<dl>
+<dt class="method" id="FileEntry::createWriter">
+<a class="backward-compatibility-anchor" name="::File::FileEntry::createWriter"></a><code><b><span class="methodName">createWriter</span></b></code>
+</dt>
+<dd>
+<div class="brief">
+ Creates a new FileWriter associated with the file that this FileEntry represents.
+ </div>
+<div class="synopsis"><pre class="signature prettyprint">void createWriter(<a href="#FileWriterCallback">FileWriterCallback</a> onsuccess, optional <a href="#ErrorCallback">ErrorCallback</a>? onerror);
+ </pre></div>
+<p><span class="version">
+ Since: </span>
+ 3.0
+ </p>
+<p><span class="privilegelevel">
+ Privilege level: </span>
+ public
+ </p>
+<p><span class="privilege">
+ Privilege: </span>
+ http://tizen.org/privilege/filesystem.read
+ </p>
+<p><span class="privilege">
+ Privilege: </span>
+ http://tizen.org/privilege/filesystem.write
+ </p>
+<div class="parameters">
+<p><span class="param">Parameters:</span></p>
+<ul>
+ <li class="param">
+<span class="name">onsuccess</span>:
+ A callback that is called with the new FileWriter.
+ </li>
+ <li class="param">
+<span class="name">onerror</span><span class="optional"> [optional]</span><span class="optional"> [nullable]</span>:
+ Callback method to be invoked when an error has occurred.
+ </li>
+ </ul>
+</div>
+<div class="example">
+<span class="example"><p>Code example:</p></span><pre name="code" class="examplecode prettyprint"> requestFileSystem(TEMPORARY, 100, function(fs) {
+ fs.root.getFile("logFile.txt", {create: true}, function (f) {
+ f.createWriter(function(fileWriter) {
+ fileWriter.write(new Blob(['hello']));
+ fileWriter.onerror = function(e) {
+ console.log('Write file failed:' + e);
+ };
+ fileWriter.onwriteend = function () {
+ console.log("success");
+ };
+ });
+ });
+ });
+ </pre>
+</div>
+<div class="output">
+<span class="title"><p>Output example:</p></span><pre>success
+</pre>
+</div>
+</dd>
+<dt class="method" id="FileEntry::file">
+<a class="backward-compatibility-anchor" name="::File::FileEntry::file"></a><code><b><span class="methodName">file</span></b></code>
+</dt>
+<dd>
+<div class="brief">
+ Returns a File that represents the current state of the file that this FileEntry represents.
+ </div>
+<div class="synopsis"><pre class="signature prettyprint">void file(<a href="#FileCallback">FileCallback</a> onsuccess, optional <a href="#ErrorCallback">ErrorCallback</a> onerror);
+ </pre></div>
+<p><span class="version">
+ Since: </span>
+ 3.0
+ </p>
+<p><span class="privilegelevel">
+ Privilege level: </span>
+ public
+ </p>
+<p><span class="privilege">
+ Privilege: </span>
+ http://tizen.org/privilege/filesystem.read
+ </p>
+<div class="parameters">
+<p><span class="param">Parameters:</span></p>
+<ul>
+ <li class="param">
+<span class="name">onsuccess</span>:
+ A callback that is called with the File.
+ </li>
+ <li class="param">
+<span class="name">onerror</span><span class="optional"> [optional]</span>:
+ Callback method to be invoked when an error has occurred.
+ </li>
+ </ul>
+</div>
+<div class="example">
+<span class="example"><p>Code example:</p></span><pre name="code" class="examplecode prettyprint"> requestFileSystem(TEMPORARY, 100, function(fs) {
+ fs.root.getFile("abcdz.txt", {create: true}, function (f) {
+ f.file(function (file) {
+ console.log("success");
+ });
+ });
+ });
+ </pre>
+</div>
+<div class="output">
+<span class="title"><p>Output example:</p></span><pre>success
+</pre>
+</div>
+</dd>
+</dl>
+</div>
+</div>
+<div class="interface" id="FileReader">
+<a class="backward-compatibility-anchor" name="::File::FileReader"></a><h3>2.15. FileReader</h3>
+<div class="brief">
+ The FileReader interface provides access to capabilities of reading <em>Blob</em> objects.
+ </div>
+<pre class="webidl prettyprint"> [Constructor()]
+ interface FileReader {
+ const short EMPTY = 0;
+ const short LOADING = 1;
+ const short DONE = 2;
+
+ readonly attribute short readyState;
+
+ readonly attribute <a href="#ReadResultData">ReadResultData</a>? result;
+
+ readonly attribute <a href="#FileError">FileError</a>? error;
+
+ attribute <a href="#ProgressCallback">ProgressCallback</a>? onloadstart;
+
+ attribute <a href="#ProgressCallback">ProgressCallback</a>? onload;
+
+ attribute <a href="#ProgressCallback">ProgressCallback</a>? onabort;
+
+ attribute <a href="#ProgressCallback">ProgressCallback</a>? onerror;
+
+ attribute <a href="#ProgressCallback">ProgressCallback</a>? onloadend;
+
+ void abort();
+
+ void readAsDataURL( blob);
+
+ void readAsText( blob, optional DOMString? label);
+
+ void readAsBinaryString( blob);
+
+ void readAsArrayBuffer( blob);
+ };</pre>
+<p><span class="version">
+ Since: </span>
+ 3.0
+ </p>
+<div class="example">
+<span class="example"><p>Code example:</p></span><pre name="code" class="examplecode prettyprint"> var deviceReady, fileReader;
+ deviceReady = function() {
+ fileReader = new FileReader();
+ };
+ document.addEventListener('deviceready', deviceReady, true);
+ </pre>
+</div>
+<div class="constructors">
+<h4 id="FileReader::constructor">Constructors</h4>
+<dl><pre class="webidl prettyprint">FileReader();</pre></dl>
+</div>
+<div class="consts">
+<h4>Constants</h4>
+<dl>
+<li class="const" id="FileReader::EMPTY">
+<a class="backward-compatibility-anchor" name="::File::FileReader::EMPTY"></a><span class="name">EMPTY</span><div class="brief">
+ The FileReader object has been constructed, and there are no pending reads. None of the read methods have been called.
+This is the default state of a newly minted FileReader object, until one of the read methods have been called on it.
+ </div>
+<p><span class="version">
+ Since: </span>
+ 3.0
+ </p>
+<br><br>
+</li>
+<li class="const" id="FileReader::LOADING">
+<a class="backward-compatibility-anchor" name="::File::FileReader::LOADING"></a><span class="name">LOADING</span><div class="brief">
+ A File or Blob is being read. One of the read methods is being processed, and no error has occurred during the read.
+ </div>
+<p><span class="version">
+ Since: </span>
+ 3.0
+ </p>
+<br><br>
+</li>
+<li class="const" id="FileReader::DONE">
+<a class="backward-compatibility-anchor" name="::File::FileReader::DONE"></a><span class="name">DONE</span><div class="brief">
+ The entire File or Blob has been read into memory, OR a file error occurred during read, OR the read was aborted using abort().
+The FileReader is no longer reading a File or Blob. If readyState is set to DONE it means at least one of the read methods have been called on this FileReader.
+ </div>
+<p><span class="version">
+ Since: </span>
+ 3.0
+ </p>
+<br><br>
+</li>
+</dl>
+</div>
+<div class="attributes">
+<h4>Attributes</h4>
+<ul>
+<li class="attribute" id="FileReader::readyState">
+<span class="attrName"><span class="readonly"> readonly
+</span><span class="type">short </span><span class="name">readyState</span></span><div class="brief">
+ The state of FileReader. Possible values are <em>FileReader.EMPTY</em>, <em>FileReader.LOADING</em> or <em>FileReader.DONE</em>.
+ </div>
+<p><span class="version">
+ Since: </span>
+ 3.0
+ </p>
+</li>
+<li class="attribute" id="FileReader::result">
+<span class="attrName"><span class="readonly"> readonly
+</span><span class="type">ReadResultData </span><span class="name">result</span><span class="optional"> [nullable]</span></span><div class="brief">
+ The contents of the file, that have been read.
+Returns a Blob's data as a DOMString, or byte[], or null, depending on the read method that has been called on the FileReader. It is <em>null</em> if any errors occurred.
+ </div>
+<p><span class="version">
+ Since: </span>
+ 3.0
+ </p>
+</li>
+<li class="attribute" id="FileReader::error">
+<span class="attrName"><span class="readonly"> readonly
+</span><span class="type">FileError </span><span class="name">error</span><span class="optional"> [nullable]</span></span><div class="brief">
+ An object describing error, if any occured.
+ </div>
+<p><span class="version">
+ Since: </span>
+ 3.0
+ </p>
+</li>
+<li class="attribute" id="FileReader::onloadstart">
+<span class="attrName"><span class="type">ProgressCallback </span><span class="name">onloadstart</span><span class="optional"> [nullable]</span></span><div class="brief">
+ Callback, which is triggered, when the read starts.
+ </div>
+<p><span class="version">
+ Since: </span>
+ 3.0
+ </p>
+</li>
+<li class="attribute" id="FileReader::onload">
+<span class="attrName"><span class="type">ProgressCallback </span><span class="name">onload</span><span class="optional"> [nullable]</span></span><div class="brief">
+ Callback, which is triggered, when the read has successfully completed.
+ </div>
+<p><span class="version">
+ Since: </span>
+ 3.0
+ </p>
+</li>
+<li class="attribute" id="FileReader::onabort">
+<span class="attrName"><span class="type">ProgressCallback </span><span class="name">onabort</span><span class="optional"> [nullable]</span></span><div class="brief">
+ Callback, which is triggered, when the read has been aborted. For instance, by invoking the abort() method.
+ </div>
+<p><span class="version">
+ Since: </span>
+ 3.0
+ </p>
+</li>
+<li class="attribute" id="FileReader::onerror">
+<span class="attrName"><span class="type">ProgressCallback </span><span class="name">onerror</span><span class="optional"> [nullable]</span></span><div class="brief">
+ Callback, which is triggered, when the read has failed.
+ </div>
+<p><span class="version">
+ Since: </span>
+ 3.0
+ </p>
+</li>
+<li class="attribute" id="FileReader::onloadend">
+<span class="attrName"><span class="type">ProgressCallback </span><span class="name">onloadend</span><span class="optional"> [nullable]</span></span><div class="brief">
+ Callback, which is triggered, when the request has completed (either in success or failure).
+ </div>
+<p><span class="version">
+ Since: </span>
+ 3.0
+ </p>
+</li>
+</ul>
+</div>
+<div class="methods">
+<h4>Methods</h4>
+<dl>
+<dt class="method" id="FileReader::abort">
+<a class="backward-compatibility-anchor" name="::File::FileReader::abort"></a><code><b><span class="methodName">abort</span></b></code>
+</dt>
+<dd>
+<div class="brief">
+ Aborts current operation of reading file.
+ </div>
+<div class="synopsis"><pre class="signature prettyprint">void abort();
+ </pre></div>
+<p><span class="version">
+ Since: </span>
+ 3.0
+ </p>
+<div class="example">
+<span class="example"><p>Code example:</p></span><pre name="code" class="examplecode prettyprint"> var blob = new Blob(['abc']);
+ var fileReader = new FileReader();
+ fileReader.onload = function(){
+ console.log('Loaded');
+ };
+ fileReader.onabort = function(){
+ console.log('aborted');
+ };
+ fileReader.readAsDataURL(blob);
+ fileReader.abort();
+ </pre>
+</div>
+<div class="output">
+<span class="title"><p>Output example:</p></span><pre>aborted
+</pre>
+</div>
+</dd>
+<dt class="method" id="FileReader::readAsDataURL">
+<a class="backward-compatibility-anchor" name="::File::FileReader::readAsDataURL"></a><code><b><span class="methodName">readAsDataURL</span></b></code>
+</dt>
+<dd>
+<div class="brief">
+ Reads file and return data as a base64-encoded data URL.
+ </div>
+<div class="synopsis"><pre class="signature prettyprint">void readAsDataURL( blob);
+ </pre></div>
+<p><span class="version">
+ Since: </span>
+ 3.0
+ </p>
+<p><span class="privilegelevel">
+ Privilege level: </span>
+ public
+ </p>
+<p><span class="privilege">
+ Privilege: </span>
+ http://tizen.org/privilege/filesystem.read
+ </p>
+<div class="parameters">
+<p><span class="param">Parameters:</span></p>
+<ul>
+ <li class="param">
+<span class="name">blob</span>:
+ The <em>Blob</em> object to be read as data URL.
+ </li>
+ </ul>
+</div>
+<div class="exceptionlist">
+<p><span class="except">Exceptions:</span></p>
+ <ul class="exception"><li>TypeError<ul><li class="list"><p>
+ if input parameter is missing.
+ </p></li></ul>
+</li></ul>
+ <ul class="exception"><li>FileError<ul><li class="list"><p>
+ with error type INVALID_STATE_ERR, if it is already reading a file.
+ </p></li></ul>
+</li></ul>
+ </div>
+<div class="example">
+<span class="example"><p>Code example:</p></span><pre name="code" class="examplecode prettyprint"> var blob = new Blob(['abc']);
+ var fileReader = new FileReader();
+ fileReader.onload = function(){
+ console.log('Loaded, result = '+fileReader.result);
+ };
+ fileReader.readAsDataURL(blob);
+ </pre>
+</div>
+<div class="output">
+<span class="title"><p>Output example:</p></span><pre>Loaded, result = data:;base64,YWJj
+</pre>
+</div>
+</dd>
+<dt class="method" id="FileReader::readAsText">
+<a class="backward-compatibility-anchor" name="::File::FileReader::readAsText"></a><code><b><span class="methodName">readAsText</span></b></code>
+</dt>
+<dd>
+<div class="brief">
+ Reads text file.
+ </div>
+<div class="synopsis"><pre class="signature prettyprint">void readAsText( blob, optional DOMString? label);
+ </pre></div>
+<p><span class="version">
+ Since: </span>
+ 3.0
+ </p>
+<p><span class="privilegelevel">
+ Privilege level: </span>
+ public
+ </p>
+<p><span class="privilege">
+ Privilege: </span>
+ http://tizen.org/privilege/filesystem.read
+ </p>
+<div class="parameters">
+<p><span class="param">Parameters:</span></p>
+<ul>
+ <li class="param">
+<span class="name">blob</span>:
+ The <em>Blob</em> object to be read as text.
+ </li>
+ <li class="param">
+<span class="name">label</span><span class="optional"> [optional]</span><span class="optional"> [nullable]</span>:
+ An optional argument, that represents the label of an encoding
+ </li>
+ </ul>
+</div>
+<div class="exceptionlist">
+<p><span class="except">Exceptions:</span></p>
+ <ul class="exception"><li>TypeError<ul><li class="list"><p>
+ if input parameter is missing.
+ </p></li></ul>
+</li></ul>
+ <ul class="exception"><li>FileError<ul><li class="list"><p>
+ with error type INVALID_STATE_ERR, if it is already reading a file.
+ </p></li></ul>
+</li></ul>
+ </div>
+<div class="example">
+<span class="example"><p>Code example:</p></span><pre name="code" class="examplecode prettyprint"> var blob = new Blob(['abc']);
+ var fileReader = new FileReader();
+ fileReader.onload = function(){
+ console.log('Loaded, result = '+fileReader.result);
+ };
+ fileReader.readAsText(blob);
+ </pre>
+</div>
+<div class="output">
+<span class="title"><p>Output example:</p></span><pre>Loaded, result = abc
+</pre>
+</div>
+</dd>
+<dt class="method" id="FileReader::readAsBinaryString">
+<a class="backward-compatibility-anchor" name="::File::FileReader::readAsBinaryString"></a><code><b><span class="methodName">readAsBinaryString</span></b></code>
+</dt>
+<dd>
+<div class="brief">
+ Reads file as binary and returns a binary string.
+ </div>
+<div class="synopsis"><pre class="signature prettyprint">void readAsBinaryString( blob);
+ </pre></div>
+<p><span class="version">
+ Since: </span>
+ 3.0
+ </p>
+<p><span class="privilegelevel">
+ Privilege level: </span>
+ public
+ </p>
+<p><span class="privilege">
+ Privilege: </span>
+ http://tizen.org/privilege/filesystem.read
+ </p>
+<div class="parameters">
+<p><span class="param">Parameters:</span></p>
+<ul>
+ <li class="param">
+<span class="name">blob</span>:
+ The <em>Blob</em> object to be read as binary.
+ </li>
+ </ul>
+</div>
+<div class="exceptionlist">
+<p><span class="except">Exceptions:</span></p>
+ <ul class="exception"><li>TypeError<ul><li class="list"><p>
+ if input parameter is missing.
+ </p></li></ul>
+</li></ul>
+ <ul class="exception"><li>FileError<ul><li class="list"><p>
+ with error type INVALID_STATE_ERR, if it is already reading a file.
+ </p></li></ul>
+</li></ul>
+ </div>
+<div class="example">
+<span class="example"><p>Code example:</p></span><pre name="code" class="examplecode prettyprint"> var blob = new Blob(['abc']);
+ var fileReader = new FileReader();
+ fileReader.onload = function(){
+ console.log('Loaded, result = '+fileReader.result);
+ };
+ fileReader.readAsBinaryString(blob);
+ </pre>
+</div>
+<div class="output">
+<span class="title"><p>Output example:</p></span><pre>Loaded, result = abc
+</pre>
+</div>
+</dd>
+<dt class="method" id="FileReader::readAsArrayBuffer">
+<a class="backward-compatibility-anchor" name="::File::FileReader::readAsArrayBuffer"></a><code><b><span class="methodName">readAsArrayBuffer</span></b></code>
+</dt>
+<dd>
+<div class="brief">
+ Reads file as an array buffer and result would be <em>byte[]</em>.
+ </div>
+<div class="synopsis"><pre class="signature prettyprint">void readAsArrayBuffer( blob);
+ </pre></div>
+<p><span class="version">
+ Since: </span>
+ 3.0
+ </p>
+<p><span class="privilegelevel">
+ Privilege level: </span>
+ public
+ </p>
+<p><span class="privilege">
+ Privilege: </span>
+ http://tizen.org/privilege/filesystem.read
+ </p>
+<div class="parameters">
+<p><span class="param">Parameters:</span></p>
+<ul>
+ <li class="param">
+<span class="name">blob</span>:
+ The <em>Blob</em> object to be read as array buffer.
+ </li>
+ </ul>
+</div>
+<div class="exceptionlist">
+<p><span class="except">Exceptions:</span></p>
+ <ul class="exception"><li>TypeError<ul><li class="list"><p>
+ if input parameter is missing.
+ </p></li></ul>
+</li></ul>
+ <ul class="exception"><li>FileError<ul><li class="list"><p>
+ with error type INVALID_STATE_ERR, if it is already reading a file.
+ </p></li></ul>
+</li></ul>
+ </div>
+<div class="example">
+<span class="example"><p>Code example:</p></span><pre name="code" class="examplecode prettyprint"> var blob = new Blob(['abc']);
+ var fileReader = new FileReader();
+ fileReader.onload = function(){
+ resultValue = fileReader.result;
+ console.log("Result: "+resultValue.toString()+'<br>'+'ByteLength: '+resultValue.byteLength);
+ };
+ fileReader.readAsArrayBuffer(blob);
+ </pre>
+</div>
+<div class="output">
+<span class="title"><p>Output example:</p></span><pre>Result: [object ArrayBuffer]
+ByteLength: 3
+</pre>
+</div>
+</dd>
+</dl>
+</div>
+</div>
+<div class="interface" id="FileWriter">
+<a class="backward-compatibility-anchor" name="::File::FileWriter"></a><h3>2.16. FileWriter</h3>
+<div class="brief">
+ FileWriter interface allows to create and write data to file.
+ </div>
+<pre class="webidl prettyprint"> [NoInterfaceObject] interface FileWriter {
+ const short INIT = 0;
+ const short WRITING = 1;
+ const short DONE = 2;
+
+ attribute short readyState;
+
+ attribute DOMString fileName;
+
+ attribute long length;
+
+ attribute long position;
+
+ attribute <a href="#FileError">FileError</a>? error;
+
+ attribute <a href="#ProgressCallback">ProgressCallback</a>? onwritestart;
+
+ attribute <a href="#ProgressCallback">ProgressCallback</a>? onwrite;
+
+ attribute <a href="#ProgressCallback">ProgressCallback</a>? onabort;
+
+ attribute <a href="#ProgressCallback">ProgressCallback</a>? onerror;
+
+ attribute <a href="#ProgressCallback">ProgressCallback</a>? onwriteend;
+
+ void abort ();
+
+ void seek (long offset);
+
+ void truncate (long size);
+
+ void write (<a href="#WriteData">WriteData</a> data);
+ };</pre>
+<p><span class="version">
+ Since: </span>
+ 3.0
+ </p>
+<div class="consts">
+<h4>Constants</h4>
+<dl>
+<li class="const" id="FileWriter::INIT">
+<a class="backward-compatibility-anchor" name="::File::FileWriter::INIT"></a><span class="name">INIT</span><br><br>
+</li>
+<li class="const" id="FileWriter::WRITING">
+<a class="backward-compatibility-anchor" name="::File::FileWriter::WRITING"></a><span class="name">WRITING</span><br><br>
+</li>
+<li class="const" id="FileWriter::DONE">
+<a class="backward-compatibility-anchor" name="::File::FileWriter::DONE"></a><span class="name">DONE</span><div class="brief">
+ Above constants describe current state of FileWriter object.
+ </div>
+<br><br>
+</li>
+</dl>
+</div>
+<div class="attributes">
+<h4>Attributes</h4>
+<ul>
+<li class="attribute" id="FileWriter::readyState">
+<span class="attrName"><span class="type">short </span><span class="name">readyState</span></span><div class="brief">
+ One of the three possible states, either INIT, WRITING, or DONE.
+ </div>
+<p><span class="version">
+ Since: </span>
+ 3.0
+ </p>
+</li>
+<li class="attribute" id="FileWriter::fileName">
+<span class="attrName"><span class="type">DOMString </span><span class="name">fileName</span></span><div class="brief">
+ The name of the file to be written.
+ </div>
+<p><span class="version">
+ Since: </span>
+ 3.0
+ </p>
+</li>
+<li class="attribute" id="FileWriter::length">
+<span class="attrName"><span class="type">long </span><span class="name">length</span></span><div class="brief">
+ The length of the file to be written.
+ </div>
+<p><span class="version">
+ Since: </span>
+ 3.0
+ </p>
+</li>
+<li class="attribute" id="FileWriter::position">
+<span class="attrName"><span class="type">long </span><span class="name">position</span></span><div class="brief">
+ The current position of the file pointer.
+ </div>
+<p><span class="version">
+ Since: </span>
+ 3.0
+ </p>
+</li>
+<li class="attribute" id="FileWriter::error">
+<span class="attrName"><span class="type">FileError </span><span class="name">error</span><span class="optional"> [nullable]</span></span><div class="brief">
+ An object containing errors.
+ </div>
+<p><span class="version">
+ Since: </span>
+ 3.0
+ </p>
+</li>
+<li class="attribute" id="FileWriter::onwritestart">
+<span class="attrName"><span class="type">ProgressCallback </span><span class="name">onwritestart</span><span class="optional"> [nullable]</span></span><div class="brief">
+ Called when the write starts.
+ </div>
+<p><span class="version">
+ Since: </span>
+ 3.0
+ </p>
+</li>
+<li class="attribute" id="FileWriter::onwrite">
+<span class="attrName"><span class="type">ProgressCallback </span><span class="name">onwrite</span><span class="optional"> [nullable]</span></span><div class="brief">
+ Called when the request has completed successfully.
+ </div>
+<p><span class="version">
+ Since: </span>
+ 3.0
+ </p>
+</li>
+<li class="attribute" id="FileWriter::onabort">
+<span class="attrName"><span class="type">ProgressCallback </span><span class="name">onabort</span><span class="optional"> [nullable]</span></span><div class="brief">
+ Called when the write has been aborted. For instance, by invoking the abort() method.
+ </div>
+<p><span class="version">
+ Since: </span>
+ 3.0
+ </p>
+</li>
+<li class="attribute" id="FileWriter::onerror">
+<span class="attrName"><span class="type">ProgressCallback </span><span class="name">onerror</span><span class="optional"> [nullable]</span></span><div class="brief">
+ Called when the write has failed.
+ </div>
+<p><span class="version">
+ Since: </span>
+ 3.0
+ </p>
+</li>
+<li class="attribute" id="FileWriter::onwriteend">
+<span class="attrName"><span class="type">ProgressCallback </span><span class="name">onwriteend</span><span class="optional"> [nullable]</span></span><div class="brief">
+ Called when the request has completed (either in success or failure).
+ </div>
+<p><span class="version">
+ Since: </span>
+ 3.0
+ </p>
+</li>
+</ul>
+</div>
+<div class="methods">
+<h4>Methods</h4>
+<dl>
+<dt class="method" id="FileWriter::abort">
+<a class="backward-compatibility-anchor" name="::File::FileWriter::abort"></a><code><b><span class="methodName">abort</span></b></code>
+</dt>
+<dd>
+<div class="brief">
+ Aborts writing the file.
+ </div>
+<div class="synopsis"><pre class="signature prettyprint">void abort();
+ </pre></div>
+<p><span class="version">
+ Since: </span>
+ 3.0
+ </p>
+<div class="exceptionlist">
+<p><span class="except">Exceptions:</span></p>
+ <ul class="exception"><li>FileException<ul><li class="list"><p>
+ with error type TYPE_MISMATCH_ERR, if any of the input parameter is not compatible with the expected type for that parameter.
+ </p></li></ul>
+</li></ul>
+ </div>
+<div class="example">
+<span class="example"><p>Code example:</p></span><pre name="code" class="examplecode prettyprint"> successCallback = function(writer) {
+ writer.onwrite = function(evt) {
+ console.log('write success');
+ };
+ writer.onabort = function(e){
+ console.log('abort');
+ };
+ writer.write('some sample text');
+ writer.abort();
+ };
+
+ errorCallback = function(err) {
+ console.log(err.code);
+ };
+
+ // entry is FileEntry object retrieved by getFile() function of DirectoryEntry interface.
+ entry.createWriter(successCallback, errorCallback);
+ </pre>
+</div>
+<div class="output">
+<span class="title"><p>Output example:</p></span><pre>abort
+</pre>
+</div>
+</dd>
+<dt class="method" id="FileWriter::seek">
+<a class="backward-compatibility-anchor" name="::File::FileWriter::seek"></a><code><b><span class="methodName">seek</span></b></code>
+</dt>
+<dd>
+<div class="brief">
+ Moves the file pointer to the specified byte.
+ </div>
+<div class="synopsis"><pre class="signature prettyprint">void seek(long offset);
+ </pre></div>
+<p><span class="version">
+ Since: </span>
+ 3.0
+ </p>
+<div class="description">
+ <p>
+If the offset is a negative number the position of the file pointer is rewound. If the offset is greater than the file size the position is set to the end of the file.
+ </p>
+ </div>
+<div class="parameters">
+<p><span class="param">Parameters:</span></p>
+<ul>
+ <li class="param">
+<span class="name">offset</span>:
+ Location to move the file pointer to.
+ </li>
+ </ul>
+</div>
+<div class="exceptionlist">
+<p><span class="except">Exceptions:</span></p>
+ <ul class="exception"><li>FileException<ul><li class="list"><p>
+ with error type INVALID_STATE_ERR, if it is already writing a file.
+ </p></li></ul>
+</li></ul>
+ </div>
+<div class="example">
+<span class="example"><p>Code example:</p></span><pre name="code" class="examplecode prettyprint"> successCallback = function(writer) {
+ // fast forwards file pointer to the end of file.
+ writer.seek(writer.length);
+ };
+
+ errorCallback = function(err) {
+ console.log(err.code);
+ };
+
+ // entry is FileEntry object retrieved by getFile() function of DirectoryEntry interface.
+ entry.createWriter(successCallback, errorCallback);
+ </pre>
+</div>
+</dd>
+<dt class="method" id="FileWriter::truncate">
+<a class="backward-compatibility-anchor" name="::File::FileWriter::truncate"></a><code><b><span class="methodName">truncate</span></b></code>
+</dt>
+<dd>
+<div class="brief">
+ Shortens the file to the specified length.
+ </div>
+<div class="synopsis"><pre class="signature prettyprint">void truncate(long size);
+ </pre></div>
+<p><span class="version">
+ Since: </span>
+ 3.0
+ </p>
+<p><span class="privilegelevel">
+ Privilege level: </span>
+ public
+ </p>
+<p><span class="privilege">
+ Privilege: </span>
+ http://tizen.org/privilege/filesystem.write
+ </p>
+<div class="parameters">
+<p><span class="param">Parameters:</span></p>
+<ul>
+ <li class="param">
+<span class="name">size</span>:
+ Size to chop the file at.
+ </li>
+ </ul>
+</div>
+<div class="exceptionlist">
+<p><span class="except">Exceptions:</span></p>
+ <ul class="exception"><li>FileException<ul><li class="list"><p>
+ with error type INVALID_STATE_ERR, if it is already writing a file.
+ </p></li></ul>
+</li></ul>
+ </div>
+<div class="example">
+<span class="example"><p>Code example:</p></span><pre name="code" class="examplecode prettyprint"> successCallback = function(writer) {
+ writer.onwrite = function(evt) {
+ console.log('truncate success');
+ };
+
+ writer.truncate(10);
+ };
+
+ errorCallback = function(err) {
+ console.log(err.code);
+ };
+
+ // entry is FileEntry object retrieved by getFile() function of DirectoryEntry interface.
+ entry.createWriter(successCallback, errorCallback);
+ </pre>
+</div>
+<div class="output">
+<span class="title"><p>Output example:</p></span><pre>truncate success
+</pre>
+</div>
+</dd>
+<dt class="method" id="FileWriter::write">
+<a class="backward-compatibility-anchor" name="::File::FileWriter::write"></a><code><b><span class="methodName">write</span></b></code>
+</dt>
+<dd>
+<div class="brief">
+ Writes data to the file.
+ </div>
+<div class="synopsis"><pre class="signature prettyprint">void write(<a href="#WriteData">WriteData</a> data);
+ </pre></div>
+<p><span class="version">
+ Since: </span>
+ 3.0
+ </p>
+<p><span class="privilegelevel">
+ Privilege level: </span>
+ public
+ </p>
+<p><span class="privilege">
+ Privilege: </span>
+ http://tizen.org/privilege/filesystem.read
+ </p>
+<p><span class="privilege">
+ Privilege: </span>
+ http://tizen.org/privilege/filesystem.write
+ </p>
+<div class="parameters">
+<p><span class="param">Parameters:</span></p>
+<ul>
+ <li class="param">
+<span class="name">data</span>:
+ Text or Blob to be written.
+ </li>
+ </ul>
+</div>
+<div class="exceptionlist">
+<p><span class="except">Exceptions:</span></p>
+ <ul class="exception"><li>FileException<ul><li class="list"><p>
+ with error type INVALID_STATE_ERR, if it is already writing a file.
+ </p></li></ul>
+</li></ul>
+ </div>
+<div class="example">
+<span class="example"><p>Code example:</p></span><pre name="code" class="examplecode prettyprint"> successCallback = function(writer) {
+ writer.onwrite = function(evt) {
+ console.log('write success');
+ };
+
+ writer.write('some sample text');
+ };
+
+ errorCallback = function(err) {
+ console.log(err.code);
+ };
+
+ // entry is FileEntry object retrieved by getFile() function of DirectoryEntry interface.
+ entry.createWriter(successCallback, errorCallback);
+ </pre>
+</div>
+<div class="output">
+<span class="title"><p>Output example:</p></span><pre>write success
+</pre>
+</div>
+</dd>
+</dl>
+</div>
+</div>
+<div class="interface" id="ProgressCallback">
+<a class="backward-compatibility-anchor" name="::File::ProgressCallback"></a><h3>2.17. ProgressCallback</h3>
+<div class="brief">
+ The interface that defines a callback function which is called with the ProgressEvent object.
+ </div>
+<pre class="webidl prettyprint"> [Callback=FunctionOnly, NoInterfaceObject] interface ProgressCallback {
+ void onsuccess(<a href="#ProgressEvent">ProgressEvent</a> event);
+ };</pre>
+<div class="methods">
+<h4>Methods</h4>
+<dl>
+<dt class="method" id="ProgressCallback::onsuccess">
+<a class="backward-compatibility-anchor" name="::File::ProgressCallback::onsuccess"></a><code><b><span class="methodName">onsuccess</span></b></code>
+</dt>
+<dd>
+<div class="brief">
+ Called with a ProgressEvent object.
+ </div>
+<div class="synopsis"><pre class="signature prettyprint">void onsuccess(<a href="#ProgressEvent">ProgressEvent</a> event);
+ </pre></div>
+<p><span class="version">
+ Since: </span>
+ 3.0
+ </p>
+<div class="parameters">
+<p><span class="param">Parameters:</span></p>
+<ul>
+ <li class="param">
+<span class="name">event</span>:
+ A progress event.
+ </li>
+ </ul>
+</div>
+</dd>
+</dl>
+</div>
+</div>
+<div class="interface" id="FileSystemCallback">
+<a class="backward-compatibility-anchor" name="::File::FileSystemCallback"></a><h3>2.18. FileSystemCallback</h3>
+<div class="brief">
+ The FileSystemCallback interface.
+ </div>
+<pre class="webidl prettyprint"> [Callback=FunctionOnly, NoInterfaceObject] interface FileSystemCallback {
+ void handleEvent(<a href="#FileSystem">FileSystem</a> filesystem);
+ };</pre>
+<p><span class="version">
+ Since: </span>
+ 3.0
+ </p>
+<p><span class="remark"> Remark : </span>
+ Example of using can be find at <a href="file.html#FileSystem">FileSystem</a> code example.
+ </p>
+<div class="methods">
+<h4>Methods</h4>
+<dl>
+<dt class="method" id="FileSystemCallback::handleEvent">
+<a class="backward-compatibility-anchor" name="::File::FileSystemCallback::handleEvent"></a><code><b><span class="methodName">handleEvent</span></b></code>
+</dt>
+<dd>
+<div class="brief">
+ Called when the file system was successfully obtained.
+ </div>
+<div class="synopsis"><pre class="signature prettyprint">void handleEvent(<a href="#FileSystem">FileSystem</a> filesystem);
+ </pre></div>
+<p><span class="version">
+ Since: </span>
+ 3.0
+ </p>
+<div class="parameters">
+<p><span class="param">Parameters:</span></p>
+<ul>
+ <li class="param">
+<span class="name">filesystem</span>:
+ FileSystem The file systems to which the app is granted access.
+ </li>
+ </ul>
+</div>
+</dd>
+</dl>
+</div>
+</div>
+<div class="interface" id="EntryCallback">
+<a class="backward-compatibility-anchor" name="::File::EntryCallback"></a><h3>2.19. EntryCallback</h3>
+<div class="brief">
+ The EntryCallback interface.
+ </div>
+<pre class="webidl prettyprint"> [Callback=FunctionOnly, NoInterfaceObject] interface EntryCallback {
+ void handleEvent(<a href="#Entry">Entry</a> entry);
+ };</pre>
+<p><span class="version">
+ Since: </span>
+ 3.0
+ </p>
+<p><span class="remark"> Remark : </span>
+ Example of using can be find at <a href="file.html#DirectoryEntry::getDirectory">DirectoryEntry::getDirectory</a> code example.
+ </p>
+<div class="methods">
+<h4>Methods</h4>
+<dl>
+<dt class="method" id="EntryCallback::handleEvent">
+<a class="backward-compatibility-anchor" name="::File::EntryCallback::handleEvent"></a><code><b><span class="methodName">handleEvent</span></b></code>
+</dt>
+<dd>
+<div class="brief">
+ Used to supply an Entry as a response to a user query.
+ </div>
+<div class="synopsis"><pre class="signature prettyprint">void handleEvent(<a href="#Entry">Entry</a> entry);
+ </pre></div>
+<p><span class="version">
+ Since: </span>
+ 3.0
+ </p>
+<div class="parameters">
+<p><span class="param">Parameters:</span></p>
+<ul>
+ <li class="param">
+<span class="name">entry</span>:
+ Entry
+ </li>
+ </ul>
+</div>
+</dd>
+</dl>
+</div>
+</div>
+<div class="interface" id="EntriesCallback">
+<a class="backward-compatibility-anchor" name="::File::EntriesCallback"></a><h3>2.20. EntriesCallback</h3>
+<div class="brief">
+ The EntriesCallback interface.
+ </div>
+<pre class="webidl prettyprint"> [Callback=FunctionOnly, NoInterfaceObject] interface EntriesCallback {
+ void handleEvent(<a href="#Entry">Entry</a>[] entries);
+ };</pre>
+<p><span class="version">
+ Since: </span>
+ 3.0
+ </p>
+<p><span class="remark"> Remark : </span>
+ Example of using can be find at <a href="file.html#DirectoryReader::readEntries">DirectoryReader::readEntries</a> code example.
+ </p>
+<div class="methods">
+<h4>Methods</h4>
+<dl>
+<dt class="method" id="EntriesCallback::handleEvent">
+<a class="backward-compatibility-anchor" name="::File::EntriesCallback::handleEvent"></a><code><b><span class="methodName">handleEvent</span></b></code>
+</dt>
+<dd>
+<div class="brief">
+ Used to supply an array of Entries as a response to a user query.
+ </div>
+<div class="synopsis"><pre class="signature prettyprint">void handleEvent(<a href="#Entry">Entry</a>[] entries);
+ </pre></div>
+<p><span class="version">
+ Since: </span>
+ 3.0
+ </p>
+<div class="parameters">
+<p><span class="param">Parameters:</span></p>
+<ul>
+ <li class="param">
+<span class="name">entries</span>:
+ Entry[]
+ </li>
+ </ul>
+</div>
+</dd>
+</dl>
+</div>
+</div>
+<div class="interface" id="MetadataCallback">
+<a class="backward-compatibility-anchor" name="::File::MetadataCallback"></a><h3>2.21. MetadataCallback</h3>
+<div class="brief">
+ The MetadataCallback interface.
+ </div>
+<pre class="webidl prettyprint"> [Callback=FunctionOnly, NoInterfaceObject] interface MetadataCallback {
+ void handleEvent(<a href="#Metadata">Metadata</a> metadata);
+ };</pre>
+<p><span class="version">
+ Since: </span>
+ 3.0
+ </p>
+<p><span class="remark"> Remark : </span>
+ Example of using can be find at <a href="file.html#Entry::getMetadata">Entry::getMetadata</a> code example.
+ </p>
+<div class="methods">
+<h4>Methods</h4>
+<dl>
+<dt class="method" id="MetadataCallback::handleEvent">
+<a class="backward-compatibility-anchor" name="::File::MetadataCallback::handleEvent"></a><code><b><span class="methodName">handleEvent</span></b></code>
+</dt>
+<dd>
+<div class="brief">
+ Used to supply file or directory metadata as a response to a user query.
+ </div>
+<div class="synopsis"><pre class="signature prettyprint">void handleEvent(<a href="#Metadata">Metadata</a> metadata);
+ </pre></div>
+<p><span class="version">
+ Since: </span>
+ 3.0
+ </p>
+<div class="parameters">
+<p><span class="param">Parameters:</span></p>
+<ul>
+ <li class="param">
+<span class="name">metadata</span>:
+ Metadata
+ </li>
+ </ul>
+</div>
+</dd>
+</dl>
+</div>
+</div>
+<div class="interface" id="FileWriterCallback">
+<a class="backward-compatibility-anchor" name="::File::FileWriterCallback"></a><h3>2.22. FileWriterCallback</h3>
+<div class="brief">
+ The FileWriterCallback interface.
+ </div>
+<pre class="webidl prettyprint"> [Callback=FunctionOnly, NoInterfaceObject] interface FileWriterCallback {
+ void handleEvent(<a href="#FileWriter">FileWriter</a> fileWriter);
+ };</pre>
+<p><span class="version">
+ Since: </span>
+ 3.0
+ </p>
+<p><span class="remark"> Remark : </span>
+ Example of using can be find at <a href="file.html#FileEntry::createWriter">FileEntry::createWriter</a> code example.
+ </p>
+<div class="methods">
+<h4>Methods</h4>
+<dl>
+<dt class="method" id="FileWriterCallback::handleEvent">
+<a class="backward-compatibility-anchor" name="::File::FileWriterCallback::handleEvent"></a><code><b><span class="methodName">handleEvent</span></b></code>
+</dt>
+<dd>
+<div class="brief">
+ Used to supply a FileWriter as a response to a user query.
+ </div>
+<div class="synopsis"><pre class="signature prettyprint">void handleEvent(<a href="#FileWriter">FileWriter</a> fileWriter);
+ </pre></div>
+<p><span class="version">
+ Since: </span>
+ 3.0
+ </p>
+<div class="parameters">
+<p><span class="param">Parameters:</span></p>
+<ul>
+ <li class="param">
+<span class="name">fileWriter</span>:
+ FileWriter
+ </li>
+ </ul>
+</div>
+</dd>
+</dl>
+</div>
+</div>
+<div class="interface" id="FileCallback">
+<a class="backward-compatibility-anchor" name="::File::FileCallback"></a><h3>2.23. FileCallback</h3>
+<div class="brief">
+ The FileCallback interface.
+ </div>
+<pre class="webidl prettyprint"> [Callback=FunctionOnly, NoInterfaceObject] interface FileCallback {
+ void handleEvent(<a href="#File">File</a> file);
+ };</pre>
+<p><span class="version">
+ Since: </span>
+ 3.0
+ </p>
+<p><span class="remark"> Remark : </span>
+ Example of using can be find at <a href="file.html#FileEntry::file">FileEntry::file</a> code example.
+ </p>
+<div class="methods">
+<h4>Methods</h4>
+<dl>
+<dt class="method" id="FileCallback::handleEvent">
+<a class="backward-compatibility-anchor" name="::File::FileCallback::handleEvent"></a><code><b><span class="methodName">handleEvent</span></b></code>
+</dt>
+<dd>
+<div class="brief">
+ Used to supply a File as a response to a user query.
+ </div>
+<div class="synopsis"><pre class="signature prettyprint">void handleEvent(<a href="#File">File</a> file);
+ </pre></div>
+<div class="parameters">
+<p><span class="param">Parameters:</span></p>
+<ul>
+ <li class="param">
+<span class="name">file</span>:
+ File
+ </li>
+ </ul>
+</div>
+</dd>
+</dl>
+</div>
+</div>
+<div class="interface" id="VoidCallback">
+<a class="backward-compatibility-anchor" name="::File::VoidCallback"></a><h3>2.24. VoidCallback</h3>
+<div class="brief">
+ The VoidCallback interface.
+ </div>
+<pre class="webidl prettyprint"> [Callback=FunctionOnly, NoInterfaceObject] interface VoidCallback {
+ void handleEvent();
+ };</pre>
+<p><span class="version">
+ Since: </span>
+ 3.0
+ </p>
+<p><span class="remark"> Remark : </span>
+ Example of using can be find at <a href="file.html#Entry::remove">Entry::remove</a> code example.
+ </p>
+<div class="methods">
+<h4>Methods</h4>
+<dl>
+<dt class="method" id="VoidCallback::handleEvent">
+<a class="backward-compatibility-anchor" name="::File::VoidCallback::handleEvent"></a><code><b><span class="methodName">handleEvent</span></b></code>
+</dt>
+<dd>
+<div class="brief">
+ .
+ </div>
+<div class="synopsis"><pre class="signature prettyprint">void handleEvent();
+ </pre></div>
+<p><span class="version">
+ Since: </span>
+ 3.0
+ </p>
+</dd>
+</dl>
+</div>
+</div>
+<div class="interface" id="ErrorCallback">
+<a class="backward-compatibility-anchor" name="::File::ErrorCallback"></a><h3>2.25. ErrorCallback</h3>
+<div class="brief">
+ The ErrorCallback interface.
+ </div>
+<pre class="webidl prettyprint"> [Callback=FunctionOnly, NoInterfaceObject] interface ErrorCallback {
+ void handleEvent(<a href="#FileError">FileError</a> err);
+ };</pre>
+<p><span class="version">
+ Since: </span>
+ 3.0
+ </p>
+<p><span class="remark"> Remark : </span>
+ Example of using can be find at <a href="file.html#Entry::getMetadata">Entry::getMetadata</a> code example.
+ </p>
+<div class="methods">
+<h4>Methods</h4>
+<dl>
+<dt class="method" id="ErrorCallback::handleEvent">
+<a class="backward-compatibility-anchor" name="::File::ErrorCallback::handleEvent"></a><code><b><span class="methodName">handleEvent</span></b></code>
+</dt>
+<dd>
+<div class="brief">
+ There was an error with the request. Details are provided by the FileError parameter.
+ </div>
+<div class="synopsis"><pre class="signature prettyprint">void handleEvent(<a href="#FileError">FileError</a> err);
+ </pre></div>
+<p><span class="version">
+ Since: </span>
+ 3.0
+ </p>
+<div class="parameters">
+<p><span class="param">Parameters:</span></p>
+<ul>
+ <li class="param">
+<span class="name">err</span>:
+ FileError
+ </li>
+ </ul>
+</div>
+</dd>
+</dl>
+</div>
+</div>
+</div>
+<h2 id="full-webidl">3. Full WebIDL</h2>
+<pre class="webidl prettyprint">module File {
+
+ typedef ( or DOMString) WriteData;
+
+ typedef (DOMString or byte[]) ReadResultData;
+
+ dictionary FilePropertyBag {
+
+ DOMString type;
+
+ long long lastModified;
+ };
+
+ dictionary ProgressEventInit {
+ unsigned long long loaded = false;
+ unsigned long long total = false;
+ target = null;
+ };
+
+ [Constructor(DOMString type, optional <a href="#ProgressEventInit">ProgressEventInit</a> eventInitDict)]
+ interface ProgressEvent {
+ readonly attribute DOMString type;
+ readonly attribute boolean bubbles;
+ readonly attribute boolean cancelBubble;
+ readonly attribute boolean cancelable;
+ readonly attribute boolean lengthComputable;
+ readonly attribute unsigned long long loaded;
+ readonly attribute unsigned long long total;
+ readonly attribute target;
+ };
+
+ [NoInterfaceObject] interface FileSystemManagerObject {
+ readonly attribute <a href="#FileSystemManager">FileSystemManager</a> file;
+ };
+ <a href="cordova.html#Cordova">Cordova</a> implements <a href="#FileSystemManagerObject">FileSystemManagerObject</a>;
+
+
+ [NoInterfaceObject] interface FileSystemManager {
+ readonly attribute DOMString applicationDirectory;
+
+ readonly attribute DOMString applicationStorageDirectory;
+
+ readonly attribute DOMString dataDirectory;
+
+ readonly attribute DOMString cacheDirectory;
+
+ readonly attribute DOMString externalApplicationStorageDirectory;
+
+ readonly attribute DOMString externalDataDirectory;
+
+ readonly attribute DOMString externalCacheDirectory;
+
+ readonly attribute DOMString externalRootDirectory;
+
+ readonly attribute DOMString tempDirectory;
+
+ readonly attribute DOMString syncedDataDirectory;
+
+ readonly attribute DOMString documentsDirectory;
+
+ readonly attribute DOMString sharedDirectory;
+
+ };
+
+ [NoInterfaceObject] interface FileSystem {
+
+ readonly attribute DOMString name;
+
+ readonly attribute <a href="#DirectoryEntry">DirectoryEntry</a> root;
+ };
+
+ interface Metadata {
+ readonly attribute Date modificationTime;
+
+ readonly attribute unsigned long long size;
+ };
+
+ [NoInterfaceObject] interface FileError {
+ const unsigned short NOT_FOUND_ERR = 1;
+ const unsigned short SECURITY_ERR = 2;
+ const unsigned short ABORT_ERR = 3;
+ const unsigned short NOT_READABLE_ERR = 4;
+ const unsigned short ENCODING_ERR = 5;
+ const unsigned short NO_MODIFICATION_ALLOWED_ERR = 6;
+ const unsigned short INVALID_STATE_ERR = 7;
+ const unsigned short SYNTAX_ERR = 8;
+ const unsigned short INVALID_MODIFICATION_ERR = 9;
+ const unsigned short QUOTA_EXCEEDED_ERR = 10;
+ const unsigned short TYPE_MISMATCH_ERR = 11;
+ const unsigned short PATH_EXISTS_ERR = 12;
+ attribute unsigned short code;
+ };
+
+ [NoInterfaceObject] interface File {
+
+ readonly attribute DOMString name;
+
+ readonly attribute DOMString localURL;
+
+ readonly attribute DOMString type;
+
+ readonly attribute Date lastModified;
+
+ readonly attribute long long size;
+ };
+
+ [NoInterfaceObject] interface LocalFileSystem {
+
+ const short TEMPORARY = 0;
+
+ const short PERSISTENT = 1;
+
+ void requestFileSystem(short type, long long size, optional <a href="#FileSystemCallback">FileSystemCallback</a>? successCallback, optional <a href="#ErrorCallback">ErrorCallback</a>? errorCallback);
+
+ void resolveLocalFileSystemURL(DOMString uri, optional <a href="#EntryCallback">EntryCallback</a>? successCallback, optional <a href="#ErrorCallback">ErrorCallback</a>? errorCallback);
+
+ };
+
+ Window implements <a href="#LocalFileSystem">LocalFileSystem</a>;
+
+ [NoInterfaceObject] interface Entry {
+
+ readonly attribute boolean isFile;
+
+ readonly attribute boolean isDirectory;
+
+ readonly attribute DOMString fullPath;
+
+ readonly attribute DOMString name;
+
+ readonly attribute <a href="#FileSystem">FileSystem</a> filesystem;
+
+ void getMetadata(<a href="#MetadataCallback">MetadataCallback</a> onsuccess, optional <a href="#ErrorCallback">ErrorCallback</a>? onerror);
+
+ void moveTo(<a href="#DirectoryEntry">DirectoryEntry</a> parent, optional DOMString? newName, optional <a href="#EntryCallback">EntryCallback</a>? onsuccess, optional <a href="#ErrorCallback">ErrorCallback</a>? onerror);
+
+ void copyTo(<a href="#DirectoryEntry">DirectoryEntry</a> parent, optional DOMString? newName, optional <a href="#EntryCallback">EntryCallback</a>? onsuccess, optional <a href="#ErrorCallback">ErrorCallback</a>? onerror);
+
+ void getParent(<a href="#EntryCallback">EntryCallback</a> onsuccess, optional <a href="#ErrorCallback">ErrorCallback</a>? onerror);
+
+ void remove(<a href="#VoidCallback">VoidCallback</a> onsuccess, optional <a href="#ErrorCallback">ErrorCallback</a>? onerror);
+
+ DOMString toURL();
+ };
+
+ interface DirectoryEntry : <a href="#Entry">Entry</a> {
+
+ <a href="#DirectoryReader">DirectoryReader</a> createReader();
+
+ void getDirectory(DOMString path, optional ? options, optional <a href="#EntryCallback">EntryCallback</a>? onsuccess, optional <a href="#ErrorCallback">ErrorCallback</a>? onerror);
+
+ void getFile(DOMString path, optional ? options, optional <a href="#EntryCallback">EntryCallback</a>? onsuccess, optional <a href="#ErrorCallback">ErrorCallback</a>? onerror);
+
+ void removeRecursively(<a href="#VoidCallback">VoidCallback</a> onsuccess, optional <a href="#ErrorCallback">ErrorCallback</a>? onerror);
+ };
+
+ [NoInterfaceObject] interface DirectoryReader {
+
+ void readEntries(<a href="#EntriesCallback">EntriesCallback</a> onsuccess, optional <a href="#ErrorCallback">ErrorCallback</a>? onerror);
+ };
+
+ [NoInterfaceObject] interface FileEntry : <a href="#Entry">Entry</a> {
+
+ void createWriter(<a href="#FileWriterCallback">FileWriterCallback</a> onsuccess, optional <a href="#ErrorCallback">ErrorCallback</a>? onerror);
+
+ void file (<a href="#FileCallback">FileCallback</a> onsuccess, optional <a href="#ErrorCallback">ErrorCallback</a> onerror);
+ };
+
+ [Constructor()]
+ interface FileReader {
+ const short EMPTY = 0;
+ const short LOADING = 1;
+ const short DONE = 2;
+
+ readonly attribute short readyState;
+
+ readonly attribute <a href="#ReadResultData">ReadResultData</a>? result;
+
+ readonly attribute <a href="#FileError">FileError</a>? error;
+
+ attribute <a href="#ProgressCallback">ProgressCallback</a>? onloadstart;
+
+ attribute <a href="#ProgressCallback">ProgressCallback</a>? onload;
+
+ attribute <a href="#ProgressCallback">ProgressCallback</a>? onabort;
+
+ attribute <a href="#ProgressCallback">ProgressCallback</a>? onerror;
+
+ attribute <a href="#ProgressCallback">ProgressCallback</a>? onloadend;
+
+ void abort();
+
+ void readAsDataURL( blob);
+
+ void readAsText( blob, optional DOMString? label);
+
+ void readAsBinaryString( blob);
+
+ void readAsArrayBuffer( blob);
+ };
+
+ [NoInterfaceObject] interface FileWriter {
+ const short INIT = 0;
+ const short WRITING = 1;
+ const short DONE = 2;
+
+ attribute short readyState;
+
+ attribute DOMString fileName;
+
+ attribute long length;
+
+ attribute long position;
+
+ attribute <a href="#FileError">FileError</a>? error;
+
+ attribute <a href="#ProgressCallback">ProgressCallback</a>? onwritestart;
+
+ attribute <a href="#ProgressCallback">ProgressCallback</a>? onwrite;
+
+ attribute <a href="#ProgressCallback">ProgressCallback</a>? onabort;
+
+ attribute <a href="#ProgressCallback">ProgressCallback</a>? onerror;
+
+ attribute <a href="#ProgressCallback">ProgressCallback</a>? onwriteend;
+
+ void abort ();
+
+ void seek (long offset);
+
+ void truncate (long size);
+
+ void write (<a href="#WriteData">WriteData</a> data);
+ };
+
+ [Callback=FunctionOnly, NoInterfaceObject] interface ProgressCallback {
+ void onsuccess(<a href="#ProgressEvent">ProgressEvent</a> event);
+ };
+
+ [Callback=FunctionOnly, NoInterfaceObject] interface FileSystemCallback {
+ void handleEvent(<a href="#FileSystem">FileSystem</a> filesystem);
+ };
+
+ [Callback=FunctionOnly, NoInterfaceObject] interface EntryCallback {
+ void handleEvent(<a href="#Entry">Entry</a> entry);
+ };
+
+ [Callback=FunctionOnly, NoInterfaceObject] interface EntriesCallback {
+ void handleEvent(<a href="#Entry">Entry</a>[] entries);
+ };
+
+ [Callback=FunctionOnly, NoInterfaceObject] interface MetadataCallback {
+ void handleEvent(<a href="#Metadata">Metadata</a> metadata);
+ };
+
+ [Callback=FunctionOnly, NoInterfaceObject] interface FileWriterCallback {
+ void handleEvent(<a href="#FileWriter">FileWriter</a> fileWriter);
+ };
+
+ [Callback=FunctionOnly, NoInterfaceObject] interface FileCallback {
+ void handleEvent(<a href="#File">File</a> file);
+ };
+
+ [Callback=FunctionOnly, NoInterfaceObject] interface VoidCallback {
+ void handleEvent();
+ };
+
+ [Callback=FunctionOnly, NoInterfaceObject] interface ErrorCallback {
+ void handleEvent(<a href="#FileError">FileError</a> err);
+ };
+
+};</pre>
+</div>
+<div id="page-footer">
+<div class="copyright" align="center">
+ Except as noted, this content - excluding the Code Examples - is licensed under <a href="http://creativecommons.org/licenses/by/3.0/legalcode" target="_blank">Creative Commons Attribution 3.0</a> and all of the Code Examples contained herein are licensed under <a href="https://www.tizen.org/bsd-3-clause-license" target="_blank">BSD-3-Clause</a>. <br>For details, see the <a href="https://www.tizen.org/content-license" target="_blank">Content License</a>.
+ </div>
+<script type="text/javascript">
+
+ var _gaq = _gaq || [];
+ _gaq.push(['_setAccount', 'UA-25976949-1']);
+ _gaq.push(['_setDomainName', 'tizen.org']);
+ _gaq.push(['_trackPageview']);
+
+ (function() {
+ var ga = document.createElement('script'); ga.type = 'text/javascript'; ga.async = true;
+ var s = document.getElementsByTagName('script')[0]; s.parentNode.insertBefore(ga, s);
+ })();
+
+ </script>
+</div>
+</body>
+</html>
--- /dev/null
+<!DOCTYPE html PUBLIC "html">
+<html>
+<head>
+<meta http-equiv="Content-Type" content="text/html; charset=utf-8">
+<link rel="stylesheet" type="text/css" href="../tizen.css" media="screen">
+<script type="text/javascript" src="snippet.js"></script><title>FileTransfer API</title>
+</head>
+<body id="page-content" onload="prettyPrint()">
+<div class="api" id="::FileTransfer">
+<div class="supported-platforms"><img class="wearable-mandatory emulator" title="Mandatory, Supported by Tizen Wearable emulator" src="../wearable_s_w.png"></div>
+<div class="title"><h1>FileTransfer API</h1></div>
+<div class="brief">
+ This module allows you to upload and download files.
+ </div>
+<div class="description">
+ <p>
+Original documetation: <a href="https://www.npmjs.com/package/cordova-plugin-file-transfer">Cordova FileTransfer</a> </p>
+ </div>
+<p><span class="version">
+ Since: </span>
+ 3.0
+ </p>
+<h2>Table of Contents</h2>
+<ul class="toc">
+<li>1. <a href="#typedefs-section">Type Definitions</a><ul class="toc">
+<li>
+ 1.1. <a href="#FileUploadParams">FileUploadParams</a>
+</li>
+<li>
+ 1.2. <a href="#HeaderFields">HeaderFields</a>
+</li>
+<li>
+ 1.3. <a href="#FileDownloadOptions">FileDownloadOptions</a>
+</li>
+</ul>
+</li>
+<li>2. <a href="#interfaces-section">Interfaces</a><ul class="toc">
+<li>2.1. <a href="#FileUploadOptions">FileUploadOptions</a>
+</li>
+<li>2.2. <a href="#FileUploadResult">FileUploadResult</a>
+</li>
+<li>2.3. <a href="#FileTransferError">FileTransferError</a>
+</li>
+<li>2.4. <a href="#FileTransfer">FileTransfer</a>
+</li>
+<li>2.5. <a href="#FileUploadSuccessCallback">FileUploadSuccessCallback</a>
+</li>
+<li>2.6. <a href="#FileDownloadSuccessCallback">FileDownloadSuccessCallback</a>
+</li>
+<li>2.7. <a href="#FileTransferErrorCallback">FileTransferErrorCallback</a>
+</li>
+</ul>
+</li>
+<li>3. <a href="#full-webidl">Full WebIDL</a>
+</li>
+</ul>
+<hr>
+<h2 id="method-summary">Summary of Interfaces and Methods</h2>
+<table class="informaltable">
+<thead><tr>
+<th>Interface</th>
+<th>Method</th>
+</tr></thead>
+<tbody>
+<tr>
+<td><a href="#FileUploadOptions">FileUploadOptions</a></td>
+<td></td>
+</tr>
+<tr>
+<td><a href="#FileUploadResult">FileUploadResult</a></td>
+<td></td>
+</tr>
+<tr>
+<td><a href="#FileTransferError">FileTransferError</a></td>
+<td></td>
+</tr>
+<tr>
+<td><a href="#FileTransfer">FileTransfer</a></td>
+<td>
+<div>void <a href="#FileTransfer::upload">upload</a> (DOMString fileURL, DOMString server, optional <a href="#FileUploadSuccessCallback">FileUploadSuccessCallback</a>? successCallback, optional <a href="#FileTransferErrorCallback">FileTransferErrorCallback</a>? errorCallback, optional <a href="#FileUploadOptions">FileUploadOptions</a>? options, optional boolean? trustAllHosts)</div>
+<div>void <a href="#FileTransfer::download">download</a> (DOMString source, DOMString target, optional <a href="#FileDownloadSuccessCallback">FileDownloadSuccessCallback</a>? successCallback, optional <a href="#FileTransferErrorCallback">FileTransferErrorCallback</a>? errorCallback, optional boolean? trustAllHosts, optional <a href="#FileDownloadOptions">FileDownloadOptions</a>? options)</div>
+<div>void <a href="#FileTransfer::abort">abort</a> ()</div>
+</td>
+</tr>
+<tr>
+<td><a href="#FileUploadSuccessCallback">FileUploadSuccessCallback</a></td>
+<td><div>void <a href="#FileUploadSuccessCallback::onsuccess">onsuccess</a> (<a href="#FileUploadResult">FileUploadResult</a> result)</div></td>
+</tr>
+<tr>
+<td><a href="#FileDownloadSuccessCallback">FileDownloadSuccessCallback</a></td>
+<td><div>void <a href="#FileDownloadSuccessCallback::onsuccess">onsuccess</a> (<a href="file.html#FileEntry">FileEntry</a> file)</div></td>
+</tr>
+<tr>
+<td><a href="#FileTransferErrorCallback">FileTransferErrorCallback</a></td>
+<td><div>void <a href="#FileTransferErrorCallback::onerror">onerror</a> (<a href="#FileTransferError">FileTransferError</a> error)</div></td>
+</tr>
+</tbody>
+</table>
+<div class="typedefs" id="typedefs-section">
+<h2>1. Type Definitions</h2>
+<div class="typedef" id="FileUploadParams">
+<a class="backward-compatibility-anchor" name="::FileTransfer::FileUploadParams"></a><h3>1.1. FileUploadParams</h3>
+<div class="brief">
+ A set of additional upload HTTP request parameters.
+ </div>
+<pre class="webidl prettyprint"> typedef object FileUploadParams;</pre>
+<p><span class="version">
+ Since: </span>
+ 3.0
+ </p>
+<div class="description">
+ <p>
+The key / value type to pass in the HTTP request.
+ </p>
+ </div>
+</div>
+<div class="typedef" id="HeaderFields">
+<a class="backward-compatibility-anchor" name="::FileTransfer::HeaderFields"></a><h3>1.2. HeaderFields</h3>
+<div class="brief">
+ A set of HTTP header fields.
+ </div>
+<pre class="webidl prettyprint"> typedef object HeaderFields;</pre>
+<p><span class="version">
+ Since: </span>
+ 3.0
+ </p>
+<div class="description">
+ <p>
+The key / value type of each HTTP header field should be DOMString.
+ </p>
+ </div>
+</div>
+<div class="typedef" id="FileDownloadOptions">
+<a class="backward-compatibility-anchor" name="::FileTransfer::FileDownloadOptions"></a><h3>1.3. FileDownloadOptions</h3>
+<div class="brief">
+ A set of download options.
+ </div>
+<pre class="webidl prettyprint"> typedef object FileDownloadOptions;</pre>
+<p><span class="version">
+ Since: </span>
+ 3.0
+ </p>
+<div class="description">
+ <p>
+The key / value type of download options values. Currently only supports headers (such as Authorization (Basic Authentication), etc).
+ </p>
+ </div>
+</div>
+</div>
+<div class="interfaces" id="interfaces-section">
+<h2>2. Interfaces</h2>
+<div class="interface" id="FileUploadOptions">
+<a class="backward-compatibility-anchor" name="::FileTransfer::FileUploadOptions"></a><h3>2.1. FileUploadOptions</h3>
+<div class="brief">
+ A FileUploadOptions object can be passed to the FileTransfer objects upload method in order to specify additional parameters to the upload script
+ </div>
+<pre class="webidl prettyprint"> [Constructor(DOMString fileKey, DOMString fileName, DOMString mimeType, <a href="#FileUploadParams">FileUploadParams</a> params, <a href="#HeaderFields">HeaderFields</a> headers, DOMString httpMethod)]
+ interface FileUploadOptions {
+ attribute DOMString fileKey;
+ attribute DOMString fileName;
+ attribute DOMString httpMethod;
+ attribute DOMString mimeType;
+ attribute <a href="#FileUploadParams">FileUploadParams</a> params;
+ attribute boolean chunkedMode;
+ attribute <a href="#HeaderFields">HeaderFields</a> headers;
+ };</pre>
+<p><span class="version">
+ Since: </span>
+ 3.0
+ </p>
+<div class="example">
+<span class="example"><p>Code example:</p></span><pre name="code" class="examplecode prettyprint"> var fileURL; // We assume the variable fileURL contains a valid URL to a text file on the device.
+
+ var win = function (r) {
+ console.log('Code = ' + r.responseCode);
+ console.log('Response = ' + r.response);
+ console.log('Sent = ' + r.bytesSent);
+ }
+
+ var fail = function (error) {
+ alert('An error has occurred: Code = ' + error.code);
+ console.log('upload error source ' + error.source);
+ console.log('upload error target ' + error.target);
+ }
+
+ var options = new FileUploadOptions();
+ options.fileKey = 'file';
+ options.fileName = fileURL.substr(fileURL.lastIndexOf('/') + 1);
+ options.mimeType = 'text/plain';
+
+ var params = {};
+ params.value1 = 'test';
+ params.value2 = 'param';
+
+ options.params = params;
+
+ var ft = new FileTransfer();
+ ft.upload(fileURL, encodeURI('http://some.server.com/upload.php'), win, fail, options);
+ </pre>
+</div>
+<div class="output">
+<span class="title"><p>Output example:</p></span><pre>Code = 200
+Response = OK
+Sent = 1024
+</pre>
+</div>
+<div class="constructors">
+<h4 id="FileUploadOptions::constructor">Constructors</h4>
+<dl>
+<pre class="webidl prettyprint">FileUploadOptions(DOMString fileKey, DOMString fileName, DOMString mimeType, <a href="#FileUploadParams">FileUploadParams</a> params, <a href="#HeaderFields">HeaderFields</a> headers, DOMString httpMethod);</pre>
+<div class="example">
+<span class="example"><p>Code example:</p></span><pre name="code" class="examplecode prettyprint"> // Creates a FileUploadOptions object.
+ var options = new FileUploadOptions('file', 'doc.txt', 'text/plain', null, null, 'POST');
+ </pre>
+</div>
+</dl>
+</div>
+<div class="attributes">
+<h4>Attributes</h4>
+<ul>
+<li class="attribute" id="FileUploadOptions::fileKey">
+<span class="attrName"><span class="type">DOMString </span><span class="name">fileKey</span></span><div class="brief">
+ The name of the form element. Defaults to file
+ </div>
+<p><span class="version">
+ Since: </span>
+ 3.0
+ </p>
+</li>
+<li class="attribute" id="FileUploadOptions::fileName">
+<span class="attrName"><span class="type">DOMString </span><span class="name">fileName</span></span><div class="brief">
+ The file name to use when saving the file on the server. Defaults to image.jpg.
+ </div>
+<p><span class="version">
+ Since: </span>
+ 3.0
+ </p>
+</li>
+<li class="attribute" id="FileUploadOptions::httpMethod">
+<span class="attrName"><span class="type">DOMString </span><span class="name">httpMethod</span></span><div class="brief">
+ The HTTP method to use - either PUT or POST. Defaults to POST.
+ </div>
+<p><span class="version">
+ Since: </span>
+ 3.0
+ </p>
+</li>
+<li class="attribute" id="FileUploadOptions::mimeType">
+<span class="attrName"><span class="type">DOMString </span><span class="name">mimeType</span></span><div class="brief">
+ The mime type of the data to upload. Defaults to image/jpeg.
+ </div>
+<p><span class="version">
+ Since: </span>
+ 3.0
+ </p>
+</li>
+<li class="attribute" id="FileUploadOptions::params">
+<span class="attrName"><span class="type">FileUploadParams </span><span class="name">params</span></span><div class="brief">
+ A set of optional key/value pairs to pass in the HTTP request.
+ </div>
+<p><span class="version">
+ Since: </span>
+ 3.0
+ </p>
+</li>
+<li class="attribute" id="FileUploadOptions::chunkedMode">
+<span class="attrName"><span class="type">boolean </span><span class="name">chunkedMode</span></span><div class="brief">
+ Whether to upload the data in chunked streaming mode. Defaults to true.
+ </div>
+<p><span class="version">
+ Since: </span>
+ 3.0
+ </p>
+</li>
+<li class="attribute" id="FileUploadOptions::headers">
+<span class="attrName"><span class="type">HeaderFields </span><span class="name">headers</span></span><div class="brief">
+ A map of header name/header values. Use an array to specify more than one value.
+ </div>
+<p><span class="version">
+ Since: </span>
+ 3.0
+ </p>
+</li>
+</ul>
+</div>
+</div>
+<div class="interface" id="FileUploadResult">
+<a class="backward-compatibility-anchor" name="::FileTransfer::FileUploadResult"></a><h3>2.2. FileUploadResult</h3>
+<div class="brief">
+ A FileUploadResult object is passed to the success callback of the FileTransfer object's upload() method.
+ </div>
+<pre class="webidl prettyprint"> [NoInterfaceObject] interface FileUploadResult {
+ attribute long bytesSent;
+ attribute long responseCode;
+ attribute DOMString response;
+ attribute <a href="#HeaderFields">HeaderFields</a> headers;
+ };</pre>
+<p><span class="version">
+ Since: </span>
+ 3.0
+ </p>
+<div class="attributes">
+<h4>Attributes</h4>
+<ul>
+<li class="attribute" id="FileUploadResult::bytesSent">
+<span class="attrName"><span class="type">long </span><span class="name">bytesSent</span></span><div class="brief">
+ The number of bytes sent to the server as part of the upload.
+ </div>
+<p><span class="version">
+ Since: </span>
+ 3.0
+ </p>
+</li>
+<li class="attribute" id="FileUploadResult::responseCode">
+<span class="attrName"><span class="type">long </span><span class="name">responseCode</span></span><div class="brief">
+ The HTTP response code returned by the server.
+ </div>
+<p><span class="version">
+ Since: </span>
+ 3.0
+ </p>
+</li>
+<li class="attribute" id="FileUploadResult::response">
+<span class="attrName"><span class="type">DOMString </span><span class="name">response</span></span><div class="brief">
+ The HTTP response returned by the server.
+ </div>
+<p><span class="version">
+ Since: </span>
+ 3.0
+ </p>
+</li>
+<li class="attribute" id="FileUploadResult::headers">
+<span class="attrName"><span class="type">HeaderFields </span><span class="name">headers</span></span><div class="brief">
+ The HTTP response headers by the server.
+ </div>
+<p><span class="version">
+ Since: </span>
+ 3.0
+ </p>
+</li>
+</ul>
+</div>
+</div>
+<div class="interface" id="FileTransferError">
+<a class="backward-compatibility-anchor" name="::FileTransfer::FileTransferError"></a><h3>2.3. FileTransferError</h3>
+<div class="brief">
+ A FileTransferError object is passed to an error callback when an error occurs.
+ </div>
+<pre class="webidl prettyprint"> interface FileTransferError {
+ attribute short code;
+ attribute DOMString source;
+ attribute DOMString target;
+ attribute long http_status;
+ attribute DOMString body;
+ attribute DOMString exception;
+ const short FILE_NOT_FOUND_ERR = 1;
+ const short INVALID_URL_ERR = 2;
+ const short CONNECTION_ERR = 3;
+ const short ABORT_ERR = 4;
+ const short NOT_MODIFIED_ERR = 5;
+ };</pre>
+<p><span class="version">
+ Since: </span>
+ 3.0
+ </p>
+<div class="consts">
+<h4>Constants</h4>
+<dl>
+<li class="const" id="FileTransferError::FILE_NOT_FOUND_ERR">
+<a class="backward-compatibility-anchor" name="::FileTransfer::FileTransferError::FILE_NOT_FOUND_ERR"></a><span class="name">FILE_NOT_FOUND_ERR</span><div class="brief">
+ File Not Found error.
+ </div>
+<p><span class="version">
+ Since: </span>
+ 3.0
+ </p>
+<br><br>
+</li>
+<li class="const" id="FileTransferError::INVALID_URL_ERR">
+<a class="backward-compatibility-anchor" name="::FileTransfer::FileTransferError::INVALID_URL_ERR"></a><span class="name">INVALID_URL_ERR</span><div class="brief">
+ Invalid URL error.
+ </div>
+<p><span class="version">
+ Since: </span>
+ 3.0
+ </p>
+<br><br>
+</li>
+<li class="const" id="FileTransferError::CONNECTION_ERR">
+<a class="backward-compatibility-anchor" name="::FileTransfer::FileTransferError::CONNECTION_ERR"></a><span class="name">CONNECTION_ERR</span><div class="brief">
+ Connection error.
+ </div>
+<p><span class="version">
+ Since: </span>
+ 3.0
+ </p>
+<br><br>
+</li>
+<li class="const" id="FileTransferError::ABORT_ERR">
+<a class="backward-compatibility-anchor" name="::FileTransfer::FileTransferError::ABORT_ERR"></a><span class="name">ABORT_ERR</span><div class="brief">
+ Abort error.
+ </div>
+<p><span class="version">
+ Since: </span>
+ 3.0
+ </p>
+<br><br>
+</li>
+<li class="const" id="FileTransferError::NOT_MODIFIED_ERR">
+<a class="backward-compatibility-anchor" name="::FileTransfer::FileTransferError::NOT_MODIFIED_ERR"></a><span class="name">NOT_MODIFIED_ERR</span><div class="brief">
+ Not Modified error.
+ </div>
+<p><span class="version">
+ Since: </span>
+ 3.0
+ </p>
+<br><br>
+</li>
+</dl>
+</div>
+<div class="attributes">
+<h4>Attributes</h4>
+<ul>
+<li class="attribute" id="FileTransferError::code">
+<span class="attrName"><span class="type">short </span><span class="name">code</span></span><div class="brief">
+ One of the predefined error codes listed above.
+ </div>
+<p><span class="version">
+ Since: </span>
+ 3.0
+ </p>
+</li>
+<li class="attribute" id="FileTransferError::source">
+<span class="attrName"><span class="type">DOMString </span><span class="name">source</span></span><div class="brief">
+ URL to the source.
+ </div>
+<p><span class="version">
+ Since: </span>
+ 3.0
+ </p>
+</li>
+<li class="attribute" id="FileTransferError::target">
+<span class="attrName"><span class="type">DOMString </span><span class="name">target</span></span><div class="brief">
+ URL to the target.
+ </div>
+<p><span class="version">
+ Since: </span>
+ 3.0
+ </p>
+</li>
+<li class="attribute" id="FileTransferError::http_status">
+<span class="attrName"><span class="type">long </span><span class="name">http_status</span></span><div class="brief">
+ HTTP status code. This attribute is only available when a response code is received from the HTTP connection.
+ </div>
+<p><span class="version">
+ Since: </span>
+ 3.0
+ </p>
+</li>
+<li class="attribute" id="FileTransferError::body">
+<span class="attrName"><span class="type">DOMString </span><span class="name">body</span></span><div class="brief">
+ Response body. This attribute is only available when a response is received from the HTTP connection.
+ </div>
+<p><span class="version">
+ Since: </span>
+ 3.0
+ </p>
+</li>
+<li class="attribute" id="FileTransferError::exception">
+<span class="attrName"><span class="type">DOMString </span><span class="name">exception</span></span><div class="brief">
+ Either e.getMessage or e.toString
+ </div>
+<p><span class="version">
+ Since: </span>
+ 3.0
+ </p>
+</li>
+</ul>
+</div>
+</div>
+<div class="interface" id="FileTransfer">
+<a class="backward-compatibility-anchor" name="::FileTransfer::FileTransfer"></a><h3>2.4. FileTransfer</h3>
+<div class="brief">
+ The FileTransfer object provides a way to upload files using an HTTP multi-part POST or PUT request, and to download files as well.
+ </div>
+<pre class="webidl prettyprint"> [Constructor()]
+ interface FileTransfer {
+ [TreatNonCallableAsNull] attribute <a href="file.html#ProgressCallback">ProgressCallback</a>? onprogress;
+
+ void upload(DOMString fileURL, DOMString server, optional <a href="#FileUploadSuccessCallback">FileUploadSuccessCallback</a>? successCallback, optional <a href="#FileTransferErrorCallback">FileTransferErrorCallback</a>? errorCallback, optional <a href="#FileUploadOptions">FileUploadOptions</a>? options, optional boolean? trustAllHosts);
+
+ void download(DOMString source, DOMString target, optional <a href="#FileDownloadSuccessCallback">FileDownloadSuccessCallback</a>? successCallback, optional <a href="#FileTransferErrorCallback">FileTransferErrorCallback</a>? errorCallback, optional boolean? trustAllHosts, optional <a href="#FileDownloadOptions">FileDownloadOptions</a>? options);
+
+ void abort();
+ };</pre>
+<p><span class="version">
+ Since: </span>
+ 3.0
+ </p>
+<div class="constructors">
+<h4 id="FileTransfer::constructor">Constructors</h4>
+<dl>
+<pre class="webidl prettyprint">FileTransfer();</pre>
+<div class="example">
+<span class="example"><p>Code example:</p></span><pre name="code" class="examplecode prettyprint"> // Creates a FileTransfer object.
+ var file_transfer = new FileTransfer();
+ </pre>
+</div>
+</dl>
+</div>
+<div class="attributes">
+<h4>Attributes</h4>
+<ul><li class="attribute" id="FileTransfer::onprogress">
+<span class="attrName"><span class="type">ProgressCallback </span><span class="name">onprogress</span><span class="optional"> [nullable]</span></span><div class="brief">
+ Called with a ProgressEvent whenever a new chunk of data is transferred.
+ </div>
+<p><span class="version">
+ Since: </span>
+ 3.0
+ </p>
+<div class="example">
+<span class="example"><p>Code example:</p></span><pre name="code" class="examplecode prettyprint"> var fileURL; // should be a valid url eg. cdvfile://localhost/persistent/path/to/file.txt
+
+ var win = function(r) {
+ console.log('Success. File uploaded.');
+ }
+
+ var fail = function(error) {
+ // error.code == FileTransferError.ABORT_ERR
+ alert('An error has occurred: Code = ' + error.code);
+ console.log('upload error source ' + error.source);
+ console.log('upload error target ' + error.target);
+ };
+
+ var ft = new FileTransfer();
+
+ ft.onprogress = function(event) {
+ console.log('uploaded: ' + event.loaded);
+ };
+
+ ft.upload(fileURL, encodeURI('http://some.server.com/upload.php'), win, fail);
+ </pre>
+</div>
+<div class="output">
+<span class="title"><p>Output example:</p></span><pre>uploaded: 512
+uploaded: 1024
+Success. File uploaded.
+</pre>
+</div>
+</li></ul>
+</div>
+<div class="methods">
+<h4>Methods</h4>
+<dl>
+<dt class="method" id="FileTransfer::upload">
+<a class="backward-compatibility-anchor" name="::FileTransfer::FileTransfer::upload"></a><code><b><span class="methodName">upload</span></b></code>
+</dt>
+<dd>
+<div class="brief">
+ Sends a file to a server.
+ </div>
+<div class="synopsis"><pre class="signature prettyprint">void upload(DOMString fileURL, DOMString server, optional <a href="#FileUploadSuccessCallback">FileUploadSuccessCallback</a>? successCallback, optional <a href="#FileTransferErrorCallback">FileTransferErrorCallback</a>? errorCallback, optional <a href="#FileUploadOptions">FileUploadOptions</a>? options, optional boolean? trustAllHosts);
+ </pre></div>
+<p><span class="version">
+ Since: </span>
+ 3.0
+ </p>
+<p><span class="privilegelevel">
+ Privilege level: </span>
+ public
+ </p>
+<p><span class="privilege">
+ Privilege: </span>
+ http://tizen.org/privilege/filesystem.read
+ </p>
+<p><span class="privilege">
+ Privilege: </span>
+ http://tizen.org/privilege/internet
+ </p>
+<div class="parameters">
+<p><span class="param">Parameters:</span></p>
+<ul>
+ <li class="param">
+<span class="name">fileURL</span>:
+ Filesystem URL representing the file on the device. For backwards compatibility, this can also be the full path of the file on the device.
+ </li>
+ <li class="param">
+<span class="name">server</span>:
+ URL of the server to receive the file, as encoded by encodeURI().
+ </li>
+ <li class="param">
+<span class="name">successCallback</span><span class="optional"> [optional]</span><span class="optional"> [nullable]</span>:
+ A callback that is passed a FileUploadResult object.
+ </li>
+ <li class="param">
+<span class="name">errorCallback</span><span class="optional"> [optional]</span><span class="optional"> [nullable]</span>:
+ : A callback that executes if an error occurs retrieving the FileUploadResult. Invoked with a FileTransferError object.
+ </li>
+ <li class="param">
+<span class="name">options</span><span class="optional"> [optional]</span><span class="optional"> [nullable]</span>:
+ Optional parameters
+ </li>
+ <li class="param">
+<span class="name">trustAllHosts</span><span class="optional"> [optional]</span><span class="optional"> [nullable]</span>:
+ Optional parameter, defaults to false. If set to true, it accepts all security certificates.
+ </li>
+ </ul>
+</div>
+<div class="example">
+<span class="example"><p>Code example:</p></span><pre name="code" class="examplecode prettyprint"> var fileURL; // should be a valid url eg. cdvfile://localhost/persistent/path/to/file.txt
+
+ var win = function (r) {
+ console.log('Code = ' + r.responseCode);
+ console.log('Response = ' + r.response);
+ console.log('Sent = ' + r.bytesSent);
+ }
+
+ var fail = function (error) {
+ alert('An error has occurred: Code = ' + error.code);
+ console.log('upload error source ' + error.source);
+ console.log('upload error target ' + error.target);
+ }
+
+ var ft = new FileTransfer();
+ ft.upload(fileURL, encodeURI('http://some.server.com/upload.php'), win, fail);
+ </pre>
+</div>
+<div class="output">
+<span class="title"><p>Output example:</p></span><pre>Code = 200
+Response = OK
+Sent = 1024
+</pre>
+</div>
+</dd>
+<dt class="method" id="FileTransfer::download">
+<a class="backward-compatibility-anchor" name="::FileTransfer::FileTransfer::download"></a><code><b><span class="methodName">download</span></b></code>
+</dt>
+<dd>
+<div class="brief">
+ Downloads a file from a server.
+ </div>
+<div class="synopsis"><pre class="signature prettyprint">void download(DOMString source, DOMString target, optional <a href="#FileDownloadSuccessCallback">FileDownloadSuccessCallback</a>? successCallback, optional <a href="#FileTransferErrorCallback">FileTransferErrorCallback</a>? errorCallback, optional boolean? trustAllHosts, optional <a href="#FileDownloadOptions">FileDownloadOptions</a>? options);
+ </pre></div>
+<p><span class="version">
+ Since: </span>
+ 3.0
+ </p>
+<p><span class="privilegelevel">
+ Privilege level: </span>
+ public
+ </p>
+<p><span class="privilege">
+ Privilege: </span>
+ http://tizen.org/privilege/filesystem.read
+ </p>
+<p><span class="privilege">
+ Privilege: </span>
+ http://tizen.org/privilege/filesystem.write
+ </p>
+<div class="parameters">
+<p><span class="param">Parameters:</span></p>
+<ul>
+ <li class="param">
+<span class="name">source</span>:
+ URL of the server to download the file, as encoded by encodeURI().
+ </li>
+ <li class="param">
+<span class="name">target</span>:
+ Filesystem url representing the file on the device. For backwards compatibility, this can also be the full path of the file on the device.
+ </li>
+ <li class="param">
+<span class="name">successCallback</span><span class="optional"> [optional]</span><span class="optional"> [nullable]</span>:
+ A callback that is passed a FileEntry object.
+ </li>
+ <li class="param">
+<span class="name">errorCallback</span><span class="optional"> [optional]</span><span class="optional"> [nullable]</span>:
+ A callback that executes if an error occurs when retrieving the FileEntry. Invoked with a FileTransferError object.
+ </li>
+ <li class="param">
+<span class="name">trustAllHosts</span><span class="optional"> [optional]</span><span class="optional"> [nullable]</span>:
+ Optional parameter, defaults to false. If set to true, it accepts all security certificates.
+ </li>
+ <li class="param">
+<span class="name">options</span><span class="optional"> [optional]</span><span class="optional"> [nullable]</span>:
+ Optional parameters, currently only supports headers (such as Authorization (Basic Authentication), etc).
+ </li>
+ </ul>
+</div>
+<div class="example">
+<span class="example"><p>Code example:</p></span><pre name="code" class="examplecode prettyprint"> var fileURL; // should be a valid url eg. cdvfile://localhost/persistent/path/to/file.txt
+
+ var fileTransfer = new FileTransfer();
+ var uri = encodeURI('http://some.server.com/download.php');
+
+ fileTransfer.download(
+ uri,
+ fileURL,
+ function(entry) {
+ console.log('download complete: ' + entry.toURL());
+ },
+ function(error) {
+ console.log('download error source ' + error.source);
+ console.log('download error target ' + error.target);
+ console.log('upload error code' + error.code);
+ },
+ false,
+ {
+ headers: {
+ 'Authorization': 'Basic dGVzdHVzZXJuYW1lOnRlc3RwYXNzd29yZA=='
+ }
+ }
+ );
+ </pre>
+</div>
+<div class="output">
+<span class="title"><p>Output example:</p></span><pre>download complete: file:///home/owner/apps_rw/Gk6hf8hjk/tmp/file.txt
+</pre>
+</div>
+</dd>
+<dt class="method" id="FileTransfer::abort">
+<a class="backward-compatibility-anchor" name="::FileTransfer::FileTransfer::abort"></a><code><b><span class="methodName">abort</span></b></code>
+</dt>
+<dd>
+<div class="brief">
+ Aborts an in-progress transfer. The onerror callback is passed a FileTransferError object which has an error code of FileTransferError.ABORT_ERR.
+ </div>
+<div class="synopsis"><pre class="signature prettyprint">void abort();
+ </pre></div>
+<p><span class="version">
+ Since: </span>
+ 3.0
+ </p>
+<p><span class="privilegelevel">
+ Privilege level: </span>
+ public
+ </p>
+<p><span class="privilege">
+ Privilege: </span>
+ http://tizen.org/privilege/internet
+ </p>
+<div class="example">
+<span class="example"><p>Code example:</p></span><pre name="code" class="examplecode prettyprint"> var fileURL; // should be a valid url eg. cdvfile://localhost/persistent/path/to/file.txt
+
+ var win = function(r) {
+ console.log('Should not be called.');
+ }
+
+ var fail = function(error) {
+ // error.code == FileTransferError.ABORT_ERR
+ alert('An error has occurred: Code = ' + error.code);
+ console.log('upload error source ' + error.source);
+ console.log('upload error target ' + error.target);
+ };
+
+ var ft = new FileTransfer();
+ ft.upload(fileURL, encodeURI('http://some.server.com/upload.php'), win, fail);
+ ft.abort();
+ </pre>
+</div>
+<div class="output">
+<span class="title"><p>Output example:</p></span><pre>An error has occured: Code = 4
+upload error source file:///home/owner/apps_rw/Gk6hf8hjk/tmp/file.txt
+upload error target http://some.server.com/file.txt
+</pre>
+</div>
+</dd>
+</dl>
+</div>
+</div>
+<div class="interface" id="FileUploadSuccessCallback">
+<a class="backward-compatibility-anchor" name="::FileTransfer::FileUploadSuccessCallback"></a><h3>2.5. FileUploadSuccessCallback</h3>
+<div class="brief">
+ The interface that defines a callback function which is called when an upload is successfully finished.
+ </div>
+<pre class="webidl prettyprint"> [Callback=FunctionOnly, NoInterfaceObject] interface FileUploadSuccessCallback {
+ void onsuccess(<a href="#FileUploadResult">FileUploadResult</a> result);
+ };</pre>
+<p><span class="version">
+ Since: </span>
+ 3.0
+ </p>
+<div class="methods">
+<h4>Methods</h4>
+<dl>
+<dt class="method" id="FileUploadSuccessCallback::onsuccess">
+<a class="backward-compatibility-anchor" name="::FileTransfer::FileUploadSuccessCallback::onsuccess"></a><code><b><span class="methodName">onsuccess</span></b></code>
+</dt>
+<dd>
+<div class="brief">
+ Called when upload is successfully finished.
+ </div>
+<div class="synopsis"><pre class="signature prettyprint">void onsuccess(<a href="#FileUploadResult">FileUploadResult</a> result);
+ </pre></div>
+<p><span class="version">
+ Since: </span>
+ 3.0
+ </p>
+<p><span class="remark"> Remark : </span>
+ See the <a href="#FileTransfer::upload">example</a> </p>
+<div class="parameters">
+<p><span class="param">Parameters:</span></p>
+<ul>
+ <li class="param">
+<span class="name">result</span>:
+ A result object that defines an upload result.
+ </li>
+ </ul>
+</div>
+</dd>
+</dl>
+</div>
+</div>
+<div class="interface" id="FileDownloadSuccessCallback">
+<a class="backward-compatibility-anchor" name="::FileTransfer::FileDownloadSuccessCallback"></a><h3>2.6. FileDownloadSuccessCallback</h3>
+<div class="brief">
+ The interface that defines a callback function which is called when download is successfully finished.
+ </div>
+<pre class="webidl prettyprint"> [Callback=FunctionOnly, NoInterfaceObject] interface FileDownloadSuccessCallback {
+ void onsuccess(<a href="file.html#FileEntry">FileEntry</a> file);
+ };</pre>
+<div class="methods">
+<h4>Methods</h4>
+<dl>
+<dt class="method" id="FileDownloadSuccessCallback::onsuccess">
+<a class="backward-compatibility-anchor" name="::FileTransfer::FileDownloadSuccessCallback::onsuccess"></a><code><b><span class="methodName">onsuccess</span></b></code>
+</dt>
+<dd>
+<div class="brief">
+ Called when download is successfully finished.
+ </div>
+<div class="synopsis"><pre class="signature prettyprint">void onsuccess(<a href="file.html#FileEntry">FileEntry</a> file);
+ </pre></div>
+<p><span class="version">
+ Since: </span>
+ 3.0
+ </p>
+<p><span class="remark"> Remark : </span>
+ See the <a href="#FileTransfer::download">example</a> </p>
+<div class="parameters">
+<p><span class="param">Parameters:</span></p>
+<ul>
+ <li class="param">
+<span class="name">file</span>:
+ An object that defines a downloaded file.
+ </li>
+ </ul>
+</div>
+</dd>
+</dl>
+</div>
+</div>
+<div class="interface" id="FileTransferErrorCallback">
+<a class="backward-compatibility-anchor" name="::FileTransfer::FileTransferErrorCallback"></a><h3>2.7. FileTransferErrorCallback</h3>
+<div class="brief">
+ The interface that defines an error callback function which is called when an error occur.
+ </div>
+<pre class="webidl prettyprint"> [Callback=FunctionOnly, NoInterfaceObject] interface FileTransferErrorCallback {
+ void onerror(<a href="#FileTransferError">FileTransferError</a> error);
+ };</pre>
+<div class="methods">
+<h4>Methods</h4>
+<dl>
+<dt class="method" id="FileTransferErrorCallback::onerror">
+<a class="backward-compatibility-anchor" name="::FileTransfer::FileTransferErrorCallback::onerror"></a><code><b><span class="methodName">onerror</span></b></code>
+</dt>
+<dd>
+<div class="brief">
+ Called when file transfer is finished with an error
+ </div>
+<div class="synopsis"><pre class="signature prettyprint">void onerror(<a href="#FileTransferError">FileTransferError</a> error);
+ </pre></div>
+<p><span class="version">
+ Since: </span>
+ 3.0
+ </p>
+<p><span class="remark"> Remark : </span>
+ See the <a href="#FileTransfer::download">example</a> </p>
+<div class="parameters">
+<p><span class="param">Parameters:</span></p>
+<ul>
+ <li class="param">
+<span class="name">error</span>:
+ An object that defines details of the error
+ </li>
+ </ul>
+</div>
+</dd>
+</dl>
+</div>
+</div>
+</div>
+<h2 id="full-webidl">3. Full WebIDL</h2>
+<pre class="webidl prettyprint">module FileTransfer {
+ typedef object FileUploadParams;
+
+ typedef object HeaderFields;
+
+ typedef object FileDownloadOptions;
+
+ [Constructor(DOMString fileKey, DOMString fileName, DOMString mimeType, <a href="#FileUploadParams">FileUploadParams</a> params, <a href="#HeaderFields">HeaderFields</a> headers, DOMString httpMethod)]
+ interface FileUploadOptions {
+ attribute DOMString fileKey;
+ attribute DOMString fileName;
+ attribute DOMString httpMethod;
+ attribute DOMString mimeType;
+ attribute <a href="#FileUploadParams">FileUploadParams</a> params;
+ attribute boolean chunkedMode;
+ attribute <a href="#HeaderFields">HeaderFields</a> headers;
+ };
+
+ [NoInterfaceObject] interface FileUploadResult {
+ attribute long bytesSent;
+ attribute long responseCode;
+ attribute DOMString response;
+ attribute <a href="#HeaderFields">HeaderFields</a> headers;
+ };
+
+ interface FileTransferError {
+ attribute short code;
+ attribute DOMString source;
+ attribute DOMString target;
+ attribute long http_status;
+ attribute DOMString body;
+ attribute DOMString exception;
+ const short FILE_NOT_FOUND_ERR = 1;
+ const short INVALID_URL_ERR = 2;
+ const short CONNECTION_ERR = 3;
+ const short ABORT_ERR = 4;
+ const short NOT_MODIFIED_ERR = 5;
+ };
+
+ [Constructor()]
+ interface FileTransfer {
+ [TreatNonCallableAsNull] attribute <a href="file.html#ProgressCallback">ProgressCallback</a>? onprogress;
+
+ void upload(DOMString fileURL, DOMString server, optional <a href="#FileUploadSuccessCallback">FileUploadSuccessCallback</a>? successCallback, optional <a href="#FileTransferErrorCallback">FileTransferErrorCallback</a>? errorCallback, optional <a href="#FileUploadOptions">FileUploadOptions</a>? options, optional boolean? trustAllHosts);
+
+ void download(DOMString source, DOMString target, optional <a href="#FileDownloadSuccessCallback">FileDownloadSuccessCallback</a>? successCallback, optional <a href="#FileTransferErrorCallback">FileTransferErrorCallback</a>? errorCallback, optional boolean? trustAllHosts, optional <a href="#FileDownloadOptions">FileDownloadOptions</a>? options);
+
+ void abort();
+ };
+
+ [Callback=FunctionOnly, NoInterfaceObject] interface FileUploadSuccessCallback {
+ void onsuccess(<a href="#FileUploadResult">FileUploadResult</a> result);
+ };
+
+ [Callback=FunctionOnly, NoInterfaceObject] interface FileDownloadSuccessCallback {
+ void onsuccess(<a href="file.html#FileEntry">FileEntry</a> file);
+ };
+
+ [Callback=FunctionOnly, NoInterfaceObject] interface FileTransferErrorCallback {
+ void onerror(<a href="#FileTransferError">FileTransferError</a> error);
+ };
+};</pre>
+</div>
+<div id="page-footer">
+<div class="copyright" align="center">
+ Except as noted, this content - excluding the Code Examples - is licensed under <a href="http://creativecommons.org/licenses/by/3.0/legalcode" target="_blank">Creative Commons Attribution 3.0</a> and all of the Code Examples contained herein are licensed under <a href="https://www.tizen.org/bsd-3-clause-license" target="_blank">BSD-3-Clause</a>. <br>For details, see the <a href="https://www.tizen.org/content-license" target="_blank">Content License</a>.
+ </div>
+<script type="text/javascript">
+
+ var _gaq = _gaq || [];
+ _gaq.push(['_setAccount', 'UA-25976949-1']);
+ _gaq.push(['_setDomainName', 'tizen.org']);
+ _gaq.push(['_trackPageview']);
+
+ (function() {
+ var ga = document.createElement('script'); ga.type = 'text/javascript'; ga.async = true;
+ var s = document.getElementsByTagName('script')[0]; s.parentNode.insertBefore(ga, s);
+ })();
+
+ </script>
+</div>
+</body>
+</html>
--- /dev/null
+<!DOCTYPE html PUBLIC "html">
+<html>
+<head>
+<meta http-equiv="Content-Type" content="text/html; charset=utf-8">
+<link rel="stylesheet" type="text/css" href="../tizen.css" media="screen">
+<script type="text/javascript" src="snippet.js"></script><title>Globalization API</title>
+</head>
+<body id="page-content" onload="prettyPrint()">
+<div class="api" id="::Globalization">
+<div class="supported-platforms"><img class="wearable-mandatory emulator" title="Mandatory, Supported by Tizen Wearable emulator" src="../wearable_s_w.png"></div>
+<div class="title"><h1>Globalization API</h1></div>
+<div class="brief">
+ This plugin obtains information and performs operations specific to the user's locale,
+language, and timezone. Note the difference between locale and language: locale controls how numbers,
+dates, and times are displayed for a region, while language determines what language text appears as,
+independently of locale settings. Often developers use locale to set both settings, but there is no reason
+a user couldn't set her language to "English" but locale to "French", so that text is displayed in English
+but dates, times, etc., are displayed as they are in France. Unfortunately, most mobile platforms
+currently do not make a distinction between these settings.
+ </div>
+<div class="description">
+ <p>
+Original documentation: <a href="https://www.npmjs.com/package/cordova-plugin-globalization">Cordova Globalization</a> </p>
+ </div>
+<p><span class="version">
+ Since: </span>
+ 3.0
+ </p>
+<h2>Table of Contents</h2>
+<ul class="toc">
+<li>1. <a href="#interfaces-section">Interfaces</a><ul class="toc">
+<li>1.1. <a href="#GlobalizationManager">GlobalizationManager</a>
+</li>
+<li>1.2. <a href="#DateOptions">DateOptions</a>
+</li>
+<li>1.3. <a href="#CurrencyPattern">CurrencyPattern</a>
+</li>
+<li>1.4. <a href="#GetDateNamesOptions">GetDateNamesOptions</a>
+</li>
+<li>1.5. <a href="#NumberPatternOptions">NumberPatternOptions</a>
+</li>
+<li>1.6. <a href="#DatePattern">DatePattern</a>
+</li>
+<li>1.7. <a href="#NumberPattern">NumberPattern</a>
+</li>
+<li>1.8. <a href="#GlobalizationDate">GlobalizationDate</a>
+</li>
+<li>1.9. <a href="#DSTSuccessCallback">DSTSuccessCallback</a>
+</li>
+<li>1.10. <a href="#StringSuccessCallback">StringSuccessCallback</a>
+</li>
+<li>1.11. <a href="#ArrayStringSuccessCallback">ArrayStringSuccessCallback</a>
+</li>
+<li>1.12. <a href="#LongSuccessCallback">LongSuccessCallback</a>
+</li>
+<li>1.13. <a href="#DoubleSuccessCallback">DoubleSuccessCallback</a>
+</li>
+<li>1.14. <a href="#GlobalizationDateSuccessCallback">GlobalizationDateSuccessCallback</a>
+</li>
+<li>1.15. <a href="#PatternSuccessCallback">PatternSuccessCallback</a>
+</li>
+<li>1.16. <a href="#GetDatePatternSuccessCallback">GetDatePatternSuccessCallback</a>
+</li>
+<li>1.17. <a href="#GetNumberPatternSuccessCallback">GetNumberPatternSuccessCallback</a>
+</li>
+<li>1.18. <a href="#GlobalizationError">GlobalizationError</a>
+</li>
+</ul>
+</li>
+<li>2. <a href="#full-webidl">Full WebIDL</a>
+</li>
+</ul>
+<hr>
+<h2 id="method-summary">Summary of Interfaces and Methods</h2>
+<table class="informaltable">
+<thead><tr>
+<th>Interface</th>
+<th>Method</th>
+</tr></thead>
+<tbody>
+<tr>
+<td><a href="#GlobalizationManager">GlobalizationManager</a></td>
+<td>
+<div>void <a href="#GlobalizationManager::getPreferredLanguage">getPreferredLanguage</a> (<a href="#StringSuccessCallback">StringSuccessCallback</a> onsuccess, <a href="cordova.html#ErrorCallback">ErrorCallback</a><a href="file.html#ErrorCallback">ErrorCallback</a> onerror)</div>
+<div>void <a href="#GlobalizationManager::getLocaleName">getLocaleName</a> (<a href="#StringSuccessCallback">StringSuccessCallback</a> onsuccess, <a href="cordova.html#ErrorCallback">ErrorCallback</a><a href="file.html#ErrorCallback">ErrorCallback</a> onerror)</div>
+<div>void <a href="#GlobalizationManager::dateToString">dateToString</a> (Date date, <a href="#StringSuccessCallback">StringSuccessCallback</a> onsuccess, <a href="cordova.html#ErrorCallback">ErrorCallback</a><a href="file.html#ErrorCallback">ErrorCallback</a> onerror, optional <a href="#DateOptions">DateOptions</a> options)</div>
+<div>void <a href="#GlobalizationManager::getCurrencyPattern">getCurrencyPattern</a> (DOMString currencyCode, <a href="#PatternSuccessCallback">PatternSuccessCallback</a> onsuccess, <a href="cordova.html#ErrorCallback">ErrorCallback</a><a href="file.html#ErrorCallback">ErrorCallback</a> onerror)</div>
+<div>void <a href="#GlobalizationManager::getDateNames">getDateNames</a> (<a href="#ArrayStringSuccessCallback">ArrayStringSuccessCallback</a> onsuccess, <a href="cordova.html#ErrorCallback">ErrorCallback</a><a href="file.html#ErrorCallback">ErrorCallback</a> onerror, optional <a href="#GetDateNamesOptions">GetDateNamesOptions</a> options)</div>
+<div>void <a href="#GlobalizationManager::getDatePattern">getDatePattern</a> (<a href="#GetDatePatternSuccessCallback">GetDatePatternSuccessCallback</a> onsuccess, <a href="cordova.html#ErrorCallback">ErrorCallback</a><a href="file.html#ErrorCallback">ErrorCallback</a> onerror, optional <a href="#DateOptions">DateOptions</a> options)</div>
+<div>void <a href="#GlobalizationManager::getFirstDayOfWeek">getFirstDayOfWeek</a> (<a href="#LongSuccessCallback">LongSuccessCallback</a> onsuccess, <a href="cordova.html#ErrorCallback">ErrorCallback</a><a href="file.html#ErrorCallback">ErrorCallback</a> onerror)</div>
+<div>void <a href="#GlobalizationManager::getNumberPattern">getNumberPattern</a> (<a href="#GetNumberPatternSuccessCallback">GetNumberPatternSuccessCallback</a> onsuccess, <a href="cordova.html#ErrorCallback">ErrorCallback</a><a href="file.html#ErrorCallback">ErrorCallback</a> onerror, optional <a href="#NumberPatternOptions">NumberPatternOptions</a> options)</div>
+<div>void <a href="#GlobalizationManager::isDayLightSavingsTime">isDayLightSavingsTime</a> (Date date, <a href="#DSTSuccessCallback">DSTSuccessCallback</a> onsuccess, <a href="cordova.html#ErrorCallback">ErrorCallback</a><a href="file.html#ErrorCallback">ErrorCallback</a> onerror)</div>
+<div>void <a href="#GlobalizationManager::numberToString">numberToString</a> (double number, <a href="#StringSuccessCallback">StringSuccessCallback</a> onsuccess, <a href="cordova.html#ErrorCallback">ErrorCallback</a><a href="file.html#ErrorCallback">ErrorCallback</a> onerror, optional <a href="#NumberPatternOptions">NumberPatternOptions</a> options)</div>
+<div>void <a href="#GlobalizationManager::stringToDate">stringToDate</a> (DOMString dateString, <a href="#GlobalizationDateSuccessCallback">GlobalizationDateSuccessCallback</a> onsuccess, <a href="cordova.html#ErrorCallback">ErrorCallback</a><a href="file.html#ErrorCallback">ErrorCallback</a> onerror, optional <a href="#DateOptions">DateOptions</a> options)</div>
+<div>void <a href="#GlobalizationManager::stringToNumber">stringToNumber</a> (DOMString numberString, <a href="#DoubleSuccessCallback">DoubleSuccessCallback</a> onsuccess, <a href="cordova.html#ErrorCallback">ErrorCallback</a><a href="file.html#ErrorCallback">ErrorCallback</a> onerror, optional <a href="#NumberPatternOptions">NumberPatternOptions</a> options)</div>
+</td>
+</tr>
+<tr>
+<td><a href="#DateOptions">DateOptions</a></td>
+<td></td>
+</tr>
+<tr>
+<td><a href="#CurrencyPattern">CurrencyPattern</a></td>
+<td></td>
+</tr>
+<tr>
+<td><a href="#GetDateNamesOptions">GetDateNamesOptions</a></td>
+<td></td>
+</tr>
+<tr>
+<td><a href="#NumberPatternOptions">NumberPatternOptions</a></td>
+<td></td>
+</tr>
+<tr>
+<td><a href="#DatePattern">DatePattern</a></td>
+<td></td>
+</tr>
+<tr>
+<td><a href="#NumberPattern">NumberPattern</a></td>
+<td></td>
+</tr>
+<tr>
+<td><a href="#GlobalizationDate">GlobalizationDate</a></td>
+<td></td>
+</tr>
+<tr>
+<td><a href="#DSTSuccessCallback">DSTSuccessCallback</a></td>
+<td><div>void <a href="#DSTSuccessCallback::onsuccess">onsuccess</a> (object properties)</div></td>
+</tr>
+<tr>
+<td><a href="#StringSuccessCallback">StringSuccessCallback</a></td>
+<td><div>void <a href="#StringSuccessCallback::onsuccess">onsuccess</a> (object properties)</div></td>
+</tr>
+<tr>
+<td><a href="#ArrayStringSuccessCallback">ArrayStringSuccessCallback</a></td>
+<td><div>void <a href="#ArrayStringSuccessCallback::onsuccess">onsuccess</a> (object properties)</div></td>
+</tr>
+<tr>
+<td><a href="#LongSuccessCallback">LongSuccessCallback</a></td>
+<td><div>void <a href="#LongSuccessCallback::onsuccess">onsuccess</a> (object properties)</div></td>
+</tr>
+<tr>
+<td><a href="#DoubleSuccessCallback">DoubleSuccessCallback</a></td>
+<td><div>void <a href="#DoubleSuccessCallback::onsuccess">onsuccess</a> (object properties)</div></td>
+</tr>
+<tr>
+<td><a href="#GlobalizationDateSuccessCallback">GlobalizationDateSuccessCallback</a></td>
+<td><div>void <a href="#GlobalizationDateSuccessCallback::onsuccess">onsuccess</a> (Date date)</div></td>
+</tr>
+<tr>
+<td><a href="#PatternSuccessCallback">PatternSuccessCallback</a></td>
+<td><div>void <a href="#PatternSuccessCallback::onsuccess">onsuccess</a> (<a href="#CurrencyPattern">CurrencyPattern</a> pattern)</div></td>
+</tr>
+<tr>
+<td><a href="#GetDatePatternSuccessCallback">GetDatePatternSuccessCallback</a></td>
+<td><div>void <a href="#GetDatePatternSuccessCallback::onsuccess">onsuccess</a> (<a href="#DatePattern">DatePattern</a> pattern)</div></td>
+</tr>
+<tr>
+<td><a href="#GetNumberPatternSuccessCallback">GetNumberPatternSuccessCallback</a></td>
+<td><div>void <a href="#GetNumberPatternSuccessCallback::onsuccess">onsuccess</a> (<a href="#NumberPattern">NumberPattern</a> pattern)</div></td>
+</tr>
+<tr>
+<td><a href="#GlobalizationError">GlobalizationError</a></td>
+<td></td>
+</tr>
+</tbody>
+</table>
+<div class="interfaces" id="interfaces-section">
+<h2>1. Interfaces</h2>
+<div class="interface" id="GlobalizationManager">
+<a class="backward-compatibility-anchor" name="::Globalization::GlobalizationManager"></a><h3>1.2. GlobalizationManager</h3>
+<div class="brief">
+ the GlobalizationManager interface embodies Globalization module methods.
+ </div>
+<pre class="webidl prettyprint"> [NoInterfaceObject] interface GlobalizationManager {
+
+ void getPreferredLanguage(<a href="#StringSuccessCallback">StringSuccessCallback</a> onsuccess,
+ <a href="cordova.html#ErrorCallback">ErrorCallback</a><a href="file.html#ErrorCallback">ErrorCallback</a> onerror);
+
+ void getLocaleName(<a href="#StringSuccessCallback">StringSuccessCallback</a> onsuccess,
+ <a href="cordova.html#ErrorCallback">ErrorCallback</a><a href="file.html#ErrorCallback">ErrorCallback</a> onerror);
+
+ void dateToString(Date date, <a href="#StringSuccessCallback">StringSuccessCallback</a> onsuccess, <a href="cordova.html#ErrorCallback">ErrorCallback</a><a href="file.html#ErrorCallback">ErrorCallback</a> onerror,
+ optional <a href="#DateOptions">DateOptions</a> options);
+
+ void getCurrencyPattern(DOMString currencyCode,
+ <a href="#PatternSuccessCallback">PatternSuccessCallback</a> onsuccess,
+ <a href="cordova.html#ErrorCallback">ErrorCallback</a><a href="file.html#ErrorCallback">ErrorCallback</a> onerror);
+
+ void getDateNames(<a href="#ArrayStringSuccessCallback">ArrayStringSuccessCallback</a> onsuccess, <a href="cordova.html#ErrorCallback">ErrorCallback</a><a href="file.html#ErrorCallback">ErrorCallback</a> onerror,
+ optional <a href="#GetDateNamesOptions">GetDateNamesOptions</a> options);
+
+ void getDatePattern(<a href="#GetDatePatternSuccessCallback">GetDatePatternSuccessCallback</a> onsuccess, <a href="cordova.html#ErrorCallback">ErrorCallback</a><a href="file.html#ErrorCallback">ErrorCallback</a> onerror,
+ optional <a href="#DateOptions">DateOptions</a> options);
+
+ void getFirstDayOfWeek(<a href="#LongSuccessCallback">LongSuccessCallback</a> onsuccess,
+ <a href="cordova.html#ErrorCallback">ErrorCallback</a><a href="file.html#ErrorCallback">ErrorCallback</a> onerror);
+
+ void getNumberPattern(<a href="#GetNumberPatternSuccessCallback">GetNumberPatternSuccessCallback</a> onsuccess,
+ <a href="cordova.html#ErrorCallback">ErrorCallback</a><a href="file.html#ErrorCallback">ErrorCallback</a> onerror,
+ optional <a href="#NumberPatternOptions">NumberPatternOptions</a> options);
+
+ void isDayLightSavingsTime(Date date, <a href="#DSTSuccessCallback">DSTSuccessCallback</a> onsuccess,
+ <a href="cordova.html#ErrorCallback">ErrorCallback</a><a href="file.html#ErrorCallback">ErrorCallback</a> onerror);
+
+ void numberToString(double number, <a href="#StringSuccessCallback">StringSuccessCallback</a> onsuccess, <a href="cordova.html#ErrorCallback">ErrorCallback</a><a href="file.html#ErrorCallback">ErrorCallback</a> onerror,
+ optional <a href="#NumberPatternOptions">NumberPatternOptions</a> options);
+
+ void stringToDate(DOMString dateString, <a href="#GlobalizationDateSuccessCallback">GlobalizationDateSuccessCallback</a> onsuccess,
+ <a href="cordova.html#ErrorCallback">ErrorCallback</a><a href="file.html#ErrorCallback">ErrorCallback</a> onerror,
+ optional <a href="#DateOptions">DateOptions</a> options);
+ void stringToNumber(DOMString numberString, <a href="#DoubleSuccessCallback">DoubleSuccessCallback</a> onsuccess,
+ <a href="cordova.html#ErrorCallback">ErrorCallback</a><a href="file.html#ErrorCallback">ErrorCallback</a> onerror,
+ optional <a href="#NumberPatternOptions">NumberPatternOptions</a> options);
+ };</pre>
+<p><span class="version">
+ Since: </span>
+ 3.0
+ </p>
+<div class="methods">
+<h4>Methods</h4>
+<dl>
+<dt class="method" id="GlobalizationManager::getPreferredLanguage">
+<a class="backward-compatibility-anchor" name="::Globalization::GlobalizationManager::getPreferredLanguage"></a><code><b><span class="methodName">getPreferredLanguage</span></b></code>
+</dt>
+<dd>
+<div class="brief">
+ Gets the BCP 47 language tag for the client's current language.
+ </div>
+<div class="synopsis"><pre class="signature prettyprint">void getPreferredLanguage(<a href="#StringSuccessCallback">StringSuccessCallback</a> onsuccess, <a href="cordova.html#ErrorCallback">ErrorCallback</a><a href="file.html#ErrorCallback">ErrorCallback</a> onerror);
+ </pre></div>
+<p><span class="version">
+ Since: </span>
+ 3.0
+ </p>
+<div class="description">
+ <p>
+Returns the BCP-47 compliant language identifier tag to the successCallback
+with a properties object as a parameter. That object should have a value property
+with a String value.
+ </p>
+ </div>
+<div class="parameters">
+<p><span class="param">Parameters:</span></p>
+<ul>
+ <li class="param">
+<span class="name">onsuccess</span>:
+ The callback method to be invoked if the preferred language
+is obtained successfully.
+ </li>
+ <li class="param">
+<span class="name">onerror</span>:
+ The callback method called when errors occur
+during this method's execution.
+ </li>
+ </ul>
+</div>
+<div class="exceptionlist">
+<p><span class="except">Exceptions:</span></p>
+ <ul class="exception"><li>TypeError<ul><li class="list"><p>
+ if any of the input parameters contains an invalid value.
+ </p></li></ul>
+</li></ul>
+ </div>
+<div class="example">
+<span class="example"><p>Code example:</p></span><pre name="code" class="examplecode prettyprint"> // When the browser is set to the en-US language,
+ // this should output the text
+ // similar to the results that follow.
+
+ navigator.globalization.getPreferredLanguage(
+ function (language) { console.log('Language: ' + language.value); },
+ function () { console.log('Error getting language.'); }
+ );
+ </pre>
+</div>
+<div class="output">
+<span class="title"><p>Output example:</p></span><pre>Language: en-US
+</pre>
+</div>
+</dd>
+<dt class="method" id="GlobalizationManager::getLocaleName">
+<a class="backward-compatibility-anchor" name="::Globalization::GlobalizationManager::getLocaleName"></a><code><b><span class="methodName">getLocaleName</span></b></code>
+</dt>
+<dd>
+<div class="brief">
+ Returns the BCP 47 compliant tag for the client's current locale settings.
+ </div>
+<div class="synopsis"><pre class="signature prettyprint">void getLocaleName(<a href="#StringSuccessCallback">StringSuccessCallback</a> onsuccess, <a href="cordova.html#ErrorCallback">ErrorCallback</a><a href="file.html#ErrorCallback">ErrorCallback</a> onerror);
+ </pre></div>
+<p><span class="version">
+ Since: </span>
+ 3.0
+ </p>
+<div class="description">
+ <p>
+Returns the BCP 47 compliant locale identifier string to the successCallback
+with a properties object as a parameter. That object should have a value
+property with a String value. The locale tag will consist of a two-letter
+lower case language code, two-letter upper case country code, and (unspecified)
+variant code, separated by a hyphen.
+ </p>
+ </div>
+<div class="parameters">
+<p><span class="param">Parameters:</span></p>
+<ul>
+ <li class="param">
+<span class="name">onsuccess</span>:
+ The callback function called when the locale name
+has been obtained successfully.
+ </li>
+ <li class="param">
+<span class="name">onerror</span>:
+ The callback method invoked in case of errors
+occuring while getting a locale name.
+ </li>
+ </ul>
+</div>
+<div class="exceptionlist">
+<p><span class="except">Exceptions:</span></p>
+ <ul class="exception"><li>TypeError<ul><li class="list"><p>
+ if any of the input parameters contains an invalid value.
+ </p></li></ul>
+</li></ul>
+ </div>
+<div class="example">
+<span class="example"><p>Code example:</p></span><pre name="code" class="examplecode prettyprint"> // When the browser is set to the en-US language,
+ // this should output the text
+ // similar to the results that follow.
+
+ navigator.globalization.getLocaleName(
+ function (locale) { console.log('Locale: ' + locale.value); },
+ function () { console.log('Error getting locale.'); }
+ );
+ </pre>
+</div>
+<div class="output">
+<span class="title"><p>Output example:</p></span><pre>Locale: en-US
+</pre>
+</div>
+</dd>
+<dt class="method" id="GlobalizationManager::dateToString">
+<a class="backward-compatibility-anchor" name="::Globalization::GlobalizationManager::dateToString"></a><code><b><span class="methodName">dateToString</span></b></code>
+</dt>
+<dd>
+<div class="brief">
+ Returns a date formatted as a string according to the client's locale and timezone.
+ </div>
+<div class="synopsis"><pre class="signature prettyprint">void dateToString(Date date, <a href="#StringSuccessCallback">StringSuccessCallback</a> onsuccess, <a href="cordova.html#ErrorCallback">ErrorCallback</a><a href="file.html#ErrorCallback">ErrorCallback</a> onerror, optional <a href="#DateOptions">DateOptions</a> options);
+ </pre></div>
+<p><span class="version">
+ Since: </span>
+ 3.0
+ </p>
+<div class="description">
+ <p>
+Returns the date formatted as a String via a value property accessible from the object
+passed as a parameter to the successCallback.
+ </p>
+ </div>
+<div class="parameters">
+<p><span class="param">Parameters:</span></p>
+<ul>
+ <li class="param">
+<span class="name">date</span>:
+ The date to be converted to a DOMString. It should be of type Date.
+ </li>
+ <li class="param">
+<span class="name">onsuccess</span>:
+ The callback method called after a successful conversion.
+ </li>
+ <li class="param">
+<span class="name">onerror</span>:
+ The callback method called if errors occur during conversion.
+ </li>
+ <li class="param">
+<span class="name">options</span><span class="optional"> [optional]</span>:
+ Optional parameter defining conversion options. The default values are:
+<var>{formatLength : 'short', selector : 'date and time'}</var>.
+ </li>
+ </ul>
+</div>
+<div class="exceptionlist">
+<p><span class="except">Exceptions:</span></p>
+ <ul class="exception"><li>TypeError<ul><li class="list"><p>
+ if any of the input parameters contains an invalid value.
+ </p></li></ul>
+</li></ul>
+ </div>
+<div class="example">
+<span class="example"><p>Code example:</p></span><pre name="code" class="examplecode prettyprint"> // When the browser is set to the en-US language,
+ // this should output text similar to the results that follow.
+ // This example uses the default conversion options.
+
+ navigator.globalization.dateToString(
+ new Date(),
+ function (date) { console.log('Date: ' + date.value); },
+ function () { console.log('Error getting dateString.'); },
+ { formatLength: 'short', selector: 'date and time' }
+ );
+ </pre>
+</div>
+<div class="output">
+<span class="title"><p>Output example:</p></span><pre>Date: 9/25/2012 4:21PM
+</pre>
+</div>
+</dd>
+<dt class="method" id="GlobalizationManager::getCurrencyPattern">
+<a class="backward-compatibility-anchor" name="::Globalization::GlobalizationManager::getCurrencyPattern"></a><code><b><span class="methodName">getCurrencyPattern</span></b></code>
+</dt>
+<dd>
+<div class="brief">
+ Returns a pattern string to format and parse currency values according to
+the client's user preferences and ISO 4217 currency code.
+ </div>
+<div class="synopsis"><pre class="signature prettyprint">void getCurrencyPattern(DOMString currencyCode, <a href="#PatternSuccessCallback">PatternSuccessCallback</a> onsuccess, <a href="cordova.html#ErrorCallback">ErrorCallback</a><a href="file.html#ErrorCallback">ErrorCallback</a> onerror);
+ </pre></div>
+<p><span class="version">
+ Since: </span>
+ 3.0
+ </p>
+<div class="description">
+ <p>
+The pattern information is returned in the onsuccess callback with pattern object
+as a parameter.
+ </p>
+ </div>
+<div class="parameters">
+<p><span class="param">Parameters:</span></p>
+<ul>
+ <li class="param">
+<span class="name">currencyCode</span>:
+ ISO 4217 compliant currency code provided as a DOMString,
+for example 'USD'.
+ </li>
+ <li class="param">
+<span class="name">onsuccess</span>:
+ The callback method invoked after a successful conversion.
+ </li>
+ <li class="param">
+<span class="name">onerror</span>:
+ The callback method called if errors occur during the conversion.
+ </li>
+ </ul>
+</div>
+<div class="exceptionlist">
+<p><span class="except">Exceptions:</span></p>
+ <ul class="exception"><li>TypeError<ul><li class="list"><p>
+ if any of the input parameters contains an invalid value.
+ </p></li></ul>
+</li></ul>
+ </div>
+<div class="example">
+<span class="example"><p>Code example:</p></span><pre name="code" class="examplecode prettyprint"> // When the browser is set to the en-US locale and the selected
+ // currency is United States Dollars, this example outputs
+ // text similar to the results that follow.
+
+ navigator.globalization.getCurrencyPattern(
+ 'USD',
+ function (pattern) {
+ console.log('pattern: ' + pattern.pattern);
+ console.log('code: ' + pattern.code);
+ console.log('fraction: ' + pattern.fraction);
+ console.log('rounding: ' + pattern.rounding);
+ console.log('decimal: ' + pattern.decimal);
+ console.log('grouping: ' + pattern.grouping);
+ },
+ function () { console.log('Error getting pattern.'); }
+ );
+
+ </pre>
+</div>
+<div class="output">
+<span class="title"><p>Output example:</p></span><pre>pattern: $#,##0.##;($#,##0.##)
+code: USD
+fraction: 2
+rounding: 0
+decimal: .
+grouping: ,
+</pre>
+</div>
+</dd>
+<dt class="method" id="GlobalizationManager::getDateNames">
+<a class="backward-compatibility-anchor" name="::Globalization::GlobalizationManager::getDateNames"></a><code><b><span class="methodName">getDateNames</span></b></code>
+</dt>
+<dd>
+<div class="brief">
+ Returns an array of the names of the months or the days of the week,
+depending on the client's user preferences and calendar.
+ </div>
+<div class="synopsis"><pre class="signature prettyprint">void getDateNames(<a href="#ArrayStringSuccessCallback">ArrayStringSuccessCallback</a> onsuccess, <a href="cordova.html#ErrorCallback">ErrorCallback</a><a href="file.html#ErrorCallback">ErrorCallback</a> onerror, optional <a href="#GetDateNamesOptions">GetDateNamesOptions</a> options);
+ </pre></div>
+<p><span class="version">
+ Since: </span>
+ 3.0
+ </p>
+<div class="description">
+ <p>
+If this method executes successfully, it invokes the onsuccess callback
+with months' or days' names passed as an Array of DOMString values
+in a parameter. This array features names starting from either
+the first month in the year or the first day of the week
+depending on the option selected.
+ </p>
+ </div>
+<div class="parameters">
+<p><span class="param">Parameters:</span></p>
+<ul>
+ <li class="param">
+<span class="name">onsuccess</span>:
+ The function to be called if this method returns the names correctly.
+ </li>
+ <li class="param">
+<span class="name">onerror</span>:
+ The function to be called in case of error occuring.
+ </li>
+ <li class="param">
+<span class="name">options</span><span class="optional"> [optional]</span>:
+ An optional parameter specifying additional options.
+The default value is <var>{type: 'wide', item: 'months'}</var> </li>
+ </ul>
+</div>
+<div class="exceptionlist">
+<p><span class="except">Exceptions:</span></p>
+ <ul class="exception"><li>TypeError<ul><li class="list"><p>
+ if any of the input parameters contains an invalid value.
+ </p></li></ul>
+</li></ul>
+ </div>
+<div class="example">
+<span class="example"><p>Code example:</p></span><pre name="code" class="examplecode prettyprint"> // When the browser is set to the en_US locale,
+ // this example logs the names of months, as per locale settings,
+ // with text similar to the results that follow.
+
+ navigator.globalization.getDateNames(
+ function (names) {
+ for (var i = 0; i < names.value.length; i++) {
+ console.log('month: ' + names.value[i]);
+ }
+ },
+ function () { console.log('Error getting names.'); },
+ { type: 'wide', item: 'months' }
+ );
+ </pre>
+</div>
+<div class="output">
+<span class="title"><p>Output example:</p></span><pre>month: January
+month: February
+month: March
+month: April
+month: May
+month: June
+month: July
+month: August
+month: September
+month: October
+month: November
+month: December
+</pre>
+</div>
+</dd>
+<dt class="method" id="GlobalizationManager::getDatePattern">
+<a class="backward-compatibility-anchor" name="::Globalization::GlobalizationManager::getDatePattern"></a><code><b><span class="methodName">getDatePattern</span></b></code>
+</dt>
+<dd>
+<div class="brief">
+ Gets a pattern string to format and parse dates according to the client's
+user preferences.
+ </div>
+<div class="synopsis"><pre class="signature prettyprint">void getDatePattern(<a href="#GetDatePatternSuccessCallback">GetDatePatternSuccessCallback</a> onsuccess, <a href="cordova.html#ErrorCallback">ErrorCallback</a><a href="file.html#ErrorCallback">ErrorCallback</a> onerror, optional <a href="#DateOptions">DateOptions</a> options);
+ </pre></div>
+<p><span class="version">
+ Since: </span>
+ 3.0
+ </p>
+<div class="description">
+ <p>
+If this method executes successfully, the onsuccess callback is invoked
+with a DatePattern object passed as a parameter.
+ </p>
+ </div>
+<div class="parameters">
+<p><span class="param">Parameters:</span></p>
+<ul>
+ <li class="param">
+<span class="name">onsuccess</span>:
+ The method to be invoked when this function executes successfully.
+ </li>
+ <li class="param">
+<span class="name">onerror</span>:
+ The function to be invoked in case of errors occuring.
+ </li>
+ <li class="param">
+<span class="name">options</span><span class="optional"> [optional]</span>:
+ The DateOptions object containing additional options.
+The default value is <var>{formatLength: 'short', selector: 'date and time'}</var>.
+ </li>
+ </ul>
+</div>
+<div class="exceptionlist">
+<p><span class="except">Exceptions:</span></p>
+ <ul class="exception"><li>TypeError<ul><li class="list"><p>
+ if any of the input parameters contains an invalid value.
+ </p></li></ul>
+</li></ul>
+ </div>
+<div class="example">
+<span class="example"><p>Code example:</p></span><pre name="code" class="examplecode prettyprint"> // This example displays the locale date pattern.
+ // When the browser is set to the en_US locale,
+ // the text displayed is similar to the results that follow.
+
+ function checkDatePattern () {
+ navigator.globalization.getDatePattern(
+ function (date) { console.log('Date pattern: ' + date.pattern); },
+ function () { console.log('Error getting pattern'); },
+ { formatLength: 'short', selector: 'date and time' }
+ );
+ }
+
+ checkDatePattern();
+ </pre>
+</div>
+<div class="output">
+<span class="title"><p>Output example:</p></span><pre>Date pattern: M/d/yyyy h:mm a
+</pre>
+</div>
+</dd>
+<dt class="method" id="GlobalizationManager::getFirstDayOfWeek">
+<a class="backward-compatibility-anchor" name="::Globalization::GlobalizationManager::getFirstDayOfWeek"></a><code><b><span class="methodName">getFirstDayOfWeek</span></b></code>
+</dt>
+<dd>
+<div class="brief">
+ Gets the first day of the week according to the client's
+user preferences and calendar.
+ </div>
+<div class="synopsis"><pre class="signature prettyprint">void getFirstDayOfWeek(<a href="#LongSuccessCallback">LongSuccessCallback</a> onsuccess, <a href="cordova.html#ErrorCallback">ErrorCallback</a><a href="file.html#ErrorCallback">ErrorCallback</a> onerror);
+ </pre></div>
+<p><span class="version">
+ Since: </span>
+ 3.0
+ </p>
+<div class="description">
+ <p>
+The days of the week are numbered starting from 1, where 1 is assumed to be Sunday.
+If successful, it invokes onsuccess callback with a LongSuccessCallback object
+as a parameter. That object has a value property representing the number of
+the first day of a week.
+ </p>
+ </div>
+<div class="parameters">
+<p><span class="param">Parameters:</span></p>
+<ul>
+ <li class="param">
+<span class="name">onsuccess</span>:
+ The method to be called when this function executes successfully.
+ </li>
+ <li class="param">
+<span class="name">onerror</span>:
+ The method to be invoked in case of errors occuring.
+ </li>
+ </ul>
+</div>
+<div class="exceptionlist">
+<p><span class="except">Exceptions:</span></p>
+ <ul class="exception"><li>TypeError<ul><li class="list"><p>
+ if any of the input parameters contains an invalid value.
+ </p></li></ul>
+</li></ul>
+ </div>
+<div class="example">
+<span class="example"><p>Code example:</p></span><pre name="code" class="examplecode prettyprint"> // When the browser is set to the en_US locale,
+ // this outputs the text similar to "day: 1".
+
+ navigator.globalization.getFirstDayOfWeek(
+ function (day) { console.log('day: ' + day.value); },
+ function () { console.log('Error getting first day of week.'); }
+ );
+ </pre>
+</div>
+<div class="output">
+<span class="title"><p>Output example:</p></span><pre>day: 1
+</pre>
+</div>
+</dd>
+<dt class="method" id="GlobalizationManager::getNumberPattern">
+<a class="backward-compatibility-anchor" name="::Globalization::GlobalizationManager::getNumberPattern"></a><code><b><span class="methodName">getNumberPattern</span></b></code>
+</dt>
+<dd>
+<div class="brief">
+ Gets a pattern string to format and parse numbers
+according to the client's user preferences.
+ </div>
+<div class="synopsis"><pre class="signature prettyprint">void getNumberPattern(<a href="#GetNumberPatternSuccessCallback">GetNumberPatternSuccessCallback</a> onsuccess, <a href="cordova.html#ErrorCallback">ErrorCallback</a><a href="file.html#ErrorCallback">ErrorCallback</a> onerror, optional <a href="#NumberPatternOptions">NumberPatternOptions</a> options);
+ </pre></div>
+<p><span class="version">
+ Since: </span>
+ 3.0
+ </p>
+<div class="description">
+ <p>
+The obtained pattern is then passed to the onsuccess callback
+as a parameter.
+ </p>
+ </div>
+<div class="parameters">
+<p><span class="param">Parameters:</span></p>
+<ul>
+ <li class="param">
+<span class="name">onsuccess</span>:
+ The callback method to be invoked
+when this function executes successfully.
+ </li>
+ <li class="param">
+<span class="name">onerror</span>:
+ The callback method to be invoked
+in case of errors occuring during this method's execution.
+ </li>
+ <li class="param">
+<span class="name">options</span><span class="optional"> [optional]</span>:
+ Defines the type of numeric value for which
+the pattern will be returned.
+ </li>
+ </ul>
+</div>
+<div class="exceptionlist">
+<p><span class="except">Exceptions:</span></p>
+ <ul class="exception"><li>TypeError<ul><li class="list"><p>
+ if any of the input parameters contains an invalid value.
+ </p></li></ul>
+</li></ul>
+ </div>
+<div class="example">
+<span class="example"><p>Code example:</p></span><pre name="code" class="examplecode prettyprint"> // When the browser is set to the en_US locale,
+ // this example outputs the text
+ // similar to the results that follow.
+
+ navigator.globalization.getNumberPattern(
+ function (pattern) {
+ console.log('pattern: ' + pattern.pattern);
+ console.log('symbol: ' + pattern.symbol);
+ console.log('fraction: ' + pattern.fraction);
+ console.log('rounding: ' + pattern.rounding);
+ console.log('positive: ' + pattern.positive);
+ console.log('negative: ' + pattern.negative);
+ console.log('decimal: ' + pattern.decimal);
+ console.log('grouping: ' + pattern.grouping);
+ },
+ function() { console.log('An error occurred.'); },
+ { type: 'decimal' }
+ );
+
+ </pre>
+</div>
+<div class="output">
+<span class="title"><p>Output example:</p></span><pre>pattern: #,##0.###
+symbol: .
+fraction: 0
+rounding: 0
+positive:
+negative: -
+decimal: .
+grouping: ,
+</pre>
+</div>
+</dd>
+<dt class="method" id="GlobalizationManager::isDayLightSavingsTime">
+<a class="backward-compatibility-anchor" name="::Globalization::GlobalizationManager::isDayLightSavingsTime"></a><code><b><span class="methodName">isDayLightSavingsTime</span></b></code>
+</dt>
+<dd>
+<div class="brief">
+ Indicates whether or not daylight savings time is in effect
+for a given date using the client's time zone and calendar.
+ </div>
+<div class="synopsis"><pre class="signature prettyprint">void isDayLightSavingsTime(Date date, <a href="#DSTSuccessCallback">DSTSuccessCallback</a> onsuccess, <a href="cordova.html#ErrorCallback">ErrorCallback</a><a href="file.html#ErrorCallback">ErrorCallback</a> onerror);
+ </pre></div>
+<p><span class="version">
+ Since: </span>
+ 3.0
+ </p>
+<div class="description">
+ <p>
+If this function executes successfully, the onsuccess callback
+will be invoked with a dstStatus object as a parameter. That object
+would contain a dst property with a Boolean value. The true value
+indicates that the DST is in effect for the given date.
+ </p>
+ </div>
+<div class="parameters">
+<p><span class="param">Parameters:</span></p>
+<ul>
+ <li class="param">
+<span class="name">date</span>:
+ The Date object for which the daylight savings time status will be checked.
+ </li>
+ <li class="param">
+<span class="name">onsuccess</span>:
+ The callback method to be called when this function
+successfully completes its execution.
+ </li>
+ <li class="param">
+<span class="name">onerror</span>:
+ The callback method to be called in case of
+errors occuring during this method's execution.
+ </li>
+ </ul>
+</div>
+<div class="exceptionlist">
+<p><span class="except">Exceptions:</span></p>
+ <ul class="exception"><li>TypeError<ul><li class="list"><p>
+ if any of the input parameters contains an invalid value.
+ </p></li></ul>
+</li></ul>
+ </div>
+<div class="example">
+<span class="example"><p>Code example:</p></span><pre name="code" class="examplecode prettyprint"> // During the summer, and if the browser
+ // is set to a DST-enabled timezone,
+ // this should log text similar to "dst: true":
+
+ navigator.globalization.isDayLightSavingsTime(
+ new Date(),
+ function (date) { console.log('dst: ' + date.dst); },
+ function () { console.log('Error getting the DST state.'); }
+ );
+ </pre>
+</div>
+<div class="output">
+<span class="title"><p>Output example:</p></span><pre>dst: true
+</pre>
+</div>
+</dd>
+<dt class="method" id="GlobalizationManager::numberToString">
+<a class="backward-compatibility-anchor" name="::Globalization::GlobalizationManager::numberToString"></a><code><b><span class="methodName">numberToString</span></b></code>
+</dt>
+<dd>
+<div class="brief">
+ Returns a number formatted as a string
+according to the client's user preferences.
+ </div>
+<div class="synopsis"><pre class="signature prettyprint">void numberToString(double number, <a href="#StringSuccessCallback">StringSuccessCallback</a> onsuccess, <a href="cordova.html#ErrorCallback">ErrorCallback</a><a href="file.html#ErrorCallback">ErrorCallback</a> onerror, optional <a href="#NumberPatternOptions">NumberPatternOptions</a> options);
+ </pre></div>
+<p><span class="version">
+ Since: </span>
+ 3.0
+ </p>
+<div class="description">
+ <p>
+The formatted number string is returned by onsuccess callback with
+a properties object as a parameter. That object contains a property value
+of DOMString type containing the result of the conversion.
+ </p>
+ </div>
+<div class="parameters">
+<p><span class="param">Parameters:</span></p>
+<ul>
+ <li class="param">
+<span class="name">number</span>:
+ The number that will be converted to a DOMString
+in accordance with the client's user preferences.
+ </li>
+ <li class="param">
+<span class="name">onsuccess</span>:
+ The callback function executed when the conversion
+is done successfully. The results of the conversion are passed
+as a parameter to this callback function.
+ </li>
+ <li class="param">
+<span class="name">onerror</span>:
+ The callback function executed in case of errors
+occuring during the conversion. The GlobalizationError object with
+the details is passed as a parameter to this callback function.
+ </li>
+ <li class="param">
+<span class="name">options</span><span class="optional"> [optional]</span>:
+ Additional options specifying the details of conversion.
+It is a dictionary with a single property <var>type</var>.
+The default value of this parameter is <var>{type: 'decimal'}</var>.
+ </li>
+ </ul>
+</div>
+<div class="exceptionlist">
+<p><span class="except">Exceptions:</span></p>
+ <ul class="exception"><li>TypeError<ul><li class="list"><p>
+ if any of the input parameters contains an invalid value.
+ </p></li></ul>
+</li></ul>
+ </div>
+<div class="example">
+<span class="example"><p>Code example:</p></span><pre name="code" class="examplecode prettyprint"> // When the browser is set to the en_US locale,
+ // this code displays the results that follow.
+
+ navigator.globalization.numberToString(
+ 3.1415926,
+ function (number) { console.log('decimal number: ' + number.value); },
+ function () { console.log('Error getting number.'); },
+ { type: 'decimal' }
+ );
+
+ navigator.globalization.numberToString(
+ 1000003,
+ function (number) { console.log('big decimal number: ' + number.value); },
+ function () { console.log('Error getting number.'); },
+ { type: 'decimal' }
+ );
+
+ navigator.globalization.numberToString(
+ 0.3183099,
+ function (number) { console.log('percentile: ' + number.value); },
+ function () { console.log('Error getting number.'); },
+ { type: 'percent' }
+ );
+
+ navigator.globalization.numberToString(
+ 1099.95,
+ function (number) { console.log('currency: ' + number.value); },
+ function () { console.log('Error getting number'); },
+ { type: 'currency' }
+ );
+ </pre>
+</div>
+<div class="output">
+<span class="title"><p>Output example:</p></span><pre>decimal number: 3.142
+big decimal number: 1,000,003
+percentile: 32%
+currency: $1,099.95
+</pre>
+</div>
+</dd>
+<dt class="method" id="GlobalizationManager::stringToDate">
+<a class="backward-compatibility-anchor" name="::Globalization::GlobalizationManager::stringToDate"></a><code><b><span class="methodName">stringToDate</span></b></code>
+</dt>
+<dd>
+<div class="brief">
+ Parses a date formatted as a DOMString according to the client's
+user preferences and calendar using the time zone of the client.
+Returns the corresponding date object.
+ </div>
+<div class="synopsis"><pre class="signature prettyprint">void stringToDate(DOMString dateString, <a href="#GlobalizationDateSuccessCallback">GlobalizationDateSuccessCallback</a> onsuccess, <a href="cordova.html#ErrorCallback">ErrorCallback</a><a href="file.html#ErrorCallback">ErrorCallback</a> onerror, optional <a href="#DateOptions">DateOptions</a> options);
+ </pre></div>
+<p><span class="version">
+ Since: </span>
+ 3.0
+ </p>
+<div class="parameters">
+<p><span class="param">Parameters:</span></p>
+<ul>
+ <li class="param">
+<span class="name">dateString</span>:
+ a string containing the representation of a date to be converted
+to a Date object.
+ </li>
+ <li class="param">
+<span class="name">onsuccess</span>:
+ The callback method invoked when the conversion completes successfully.
+The result of conversion is passed as a parameter to this callback.
+ </li>
+ <li class="param">
+<span class="name">onerror</span>:
+ The callback method invoked in case of errors occuring during
+the conversion. A GlobalizationError object is passed as a parameter
+to this callback.
+ </li>
+ <li class="param">
+<span class="name">options</span><span class="optional"> [optional]</span>:
+ Additional options specifying the details of the conversion.
+The default value is <var>{formatLength: 'short', selector: 'date and time'}</var>.
+ </li>
+ </ul>
+</div>
+<div class="exceptionlist">
+<p><span class="except">Exceptions:</span></p>
+ <ul class="exception"><li>TypeError<ul><li class="list"><p>
+ if any of the input parameters contains an invalid value.
+ </p></li></ul>
+</li></ul>
+ </div>
+<div class="example">
+<span class="example"><p>Code example:</p></span><pre name="code" class="examplecode prettyprint"> // when the browser is set to the en_US locale,
+ // this example outputs text similar to the results that follow.
+ // Note that the month integer is one less than the string,
+ // as the month integer represents an array index.
+
+ navigator.globalization.stringToDate(
+ '9/25/2012',
+ function (date) {
+ console.log('month: ' + date.month +
+ ', day: ' + date.day +
+ ', year: ' + date.year)
+ },
+ function () { console.log('Error getting date.'); },
+ { selector: 'date' }
+ );
+ </pre>
+</div>
+<div class="output">
+<span class="title"><p>Output example:</p></span><pre>month: 8, day: 25, year: 2012
+</pre>
+</div>
+</dd>
+<dt class="method" id="GlobalizationManager::stringToNumber">
+<a class="backward-compatibility-anchor" name="::Globalization::GlobalizationManager::stringToNumber"></a><code><b><span class="methodName">stringToNumber</span></b></code>
+</dt>
+<dd>
+<div class="brief">
+ Parses a number formatted as a string according to the client's
+user preferences and returns the corresponding number.
+ </div>
+<div class="synopsis"><pre class="signature prettyprint">void stringToNumber(DOMString numberString, <a href="#DoubleSuccessCallback">DoubleSuccessCallback</a> onsuccess, <a href="cordova.html#ErrorCallback">ErrorCallback</a><a href="file.html#ErrorCallback">ErrorCallback</a> onerror, optional <a href="#NumberPatternOptions">NumberPatternOptions</a> options);
+ </pre></div>
+<p><span class="version">
+ Since: </span>
+ 3.0
+ </p>
+<div class="description">
+ <p>
+If successful, the result of the conversion is passed as a parameter to the onsuccess
+callback method.
+ </p>
+ </div>
+<div class="parameters">
+<p><span class="param">Parameters:</span></p>
+<ul>
+ <li class="param">
+<span class="name">numberString</span>:
+ The DOMString containing a text representation of a number
+to be converted to a double data type.
+ </li>
+ <li class="param">
+<span class="name">onsuccess</span>:
+ The callback method called after a successful conversion.
+The result of a conversion is passed as a parameter of this callback method.
+ </li>
+ <li class="param">
+<span class="name">onerror</span>:
+ The callback method invoked in case of errors occuring during
+the conversion. The error is passed as a parameter of this callback method.
+ </li>
+ <li class="param">
+<span class="name">options</span><span class="optional"> [optional]</span>:
+ Additional options specifying the details of the conversion.
+The default value is <var>{type: 'decimal'}</var> </li>
+ </ul>
+</div>
+<div class="exceptionlist">
+<p><span class="except">Exceptions:</span></p>
+ <ul class="exception"><li>TypeError<ul><li class="list"><p>
+ if any of the input parameters contains an invalid value.
+ </p></li></ul>
+</li></ul>
+ </div>
+<div class="example">
+<span class="example"><p>Code example:</p></span><pre name="code" class="examplecode prettyprint"> // When the browser is set to the en_US locale,
+ // this should display the text similar to the results that follow.
+
+ navigator.globalization.stringToNumber(
+ '1234.56',
+ function (number) { console.log('number: ' + number.value); },
+ function () { console.log('Error getting number.'); },
+ { type: 'decimal' }
+ );
+ </pre>
+</div>
+<div class="output">
+<span class="title"><p>Output example:</p></span><pre>number: 1234.56
+</pre>
+</div>
+</dd>
+</dl>
+</div>
+</div>
+<div class="dictionary" id="DateOptions">
+<a class="backward-compatibility-anchor" name="::Globalization::DateOptions"></a><h3>1.3. DateOptions</h3>
+<div class="brief">
+ DateOptions is a dictionary containing options for date conversions.
+ </div>
+<pre class="webidl prettyprint"> dictionary DateOptions {
+ DOMString formatLength;
+ DOMString selector;
+ };</pre>
+<p><span class="version">
+ Since: </span>
+ 3.0
+ </p>
+<div class="attributes">
+<h4>Dictionary members</h4>
+<dl>
+<dt class="member" id="DateOptions::formatLength"><span class="attrName">DOMString formatLength</span></dt>
+<dd>
+<div class="brief">
+ Indicates the length of DOMString representation of the date.
+ </div>
+<div class="description">
+ <p>
+Valid values are:
+ </p>
+ <ul>
+ <li>
+'short' </li>
+ <li>
+'medium' </li>
+ <li>
+'long' </li>
+ <li>
+'full' </li>
+ </ul>
+ </div>
+</dd>
+<dt class="member" id="DateOptions::selector"><span class="attrName">DOMString selector</span></dt>
+<dd>
+<div class="brief">
+ Indicates the selector for DOMString representation of the date.
+ </div>
+<div class="description">
+ <p>
+Valid values are:
+ </p>
+ <ul>
+ <li>
+'date' </li>
+ <li>
+'time' </li>
+ <li>
+'date and time' </li>
+ </ul>
+ </div>
+</dd>
+</dl>
+</div>
+</div>
+<div class="dictionary" id="CurrencyPattern">
+<a class="backward-compatibility-anchor" name="::Globalization::CurrencyPattern"></a><h3>1.4. CurrencyPattern</h3>
+<div class="brief">
+ CurrencyPattern is a dictionary containing currency formatting properties.
+ </div>
+<pre class="webidl prettyprint"> dictionary CurrencyPattern {
+ DOMString pattern;
+ DOMString code;
+ long fraction;
+ double rounding;
+ DOMString decimal;
+ DOMString grouping;
+ };</pre>
+<div class="attributes">
+<h4>Dictionary members</h4>
+<dl>
+<dt class="member" id="CurrencyPattern::pattern"><span class="attrName">DOMString pattern</span></dt>
+<dd>
+<div class="brief">
+ The currency pattern to format and parse the currency values.
+The patterns follow Unicode Technical Standard #35.
+ </div>
+<p><span class="version">
+ Since: </span>
+ 3.0
+ </p>
+</dd>
+<dt class="member" id="CurrencyPattern::code"><span class="attrName">DOMString code</span></dt>
+<dd>
+<div class="brief">
+ The ISO 4217 currency code for the pattern.
+ </div>
+<p><span class="version">
+ Since: </span>
+ 3.0
+ </p>
+</dd>
+<dt class="member" id="CurrencyPattern::fraction"><span class="attrName">long fraction</span></dt>
+<dd>
+<div class="brief">
+ The number of fractional digits to use when parsing and formatting currency.
+ </div>
+<p><span class="version">
+ Since: </span>
+ 3.0
+ </p>
+</dd>
+<dt class="member" id="CurrencyPattern::rounding"><span class="attrName">double rounding</span></dt>
+<dd>
+<div class="brief">
+ The rounding increment to use when parsing and formatting.
+ </div>
+<p><span class="version">
+ Since: </span>
+ 3.0
+ </p>
+</dd>
+<dt class="member" id="CurrencyPattern::decimal"><span class="attrName">DOMString decimal</span></dt>
+<dd>
+<div class="brief">
+ The decimal symbol to use for parsing and formatting.
+ </div>
+<p><span class="version">
+ Since: </span>
+ 3.0
+ </p>
+</dd>
+<dt class="member" id="CurrencyPattern::grouping"><span class="attrName">DOMString grouping</span></dt>
+<dd>
+<div class="brief">
+ The grouping symbol to use for parsing and formatting.
+ </div>
+<p><span class="version">
+ Since: </span>
+ 3.0
+ </p>
+</dd>
+</dl>
+</div>
+</div>
+<div class="dictionary" id="GetDateNamesOptions">
+<a class="backward-compatibility-anchor" name="::Globalization::GetDateNamesOptions"></a><h3>1.5. GetDateNamesOptions</h3>
+<div class="brief">
+ The GetDateNamesOptions dictionary contains options used in getDateNames method.
+ </div>
+<pre class="webidl prettyprint"> dictionary GetDateNamesOptions {
+ DOMString type;
+ DOMString item;
+ };</pre>
+<p><span class="version">
+ Since: </span>
+ 3.0
+ </p>
+<div class="attributes">
+<h4>Dictionary members</h4>
+<dl>
+<dt class="member" id="GetDateNamesOptions::type"><span class="attrName">DOMString type</span></dt>
+<dd>
+<div class="brief">
+ Determines whether to use abbreviated (narrow) or full-length (wide) names.
+ </div>
+<div class="description">
+ <p>
+The following values are valid:
+ </p>
+ <ul>
+ <li>
+'narrow' - Abbreviated names will be returned. </li>
+ <li>
+'wide' - Full names will be returned. </li>
+ </ul>
+ </div>
+<p><span class="version">
+ Since: </span>
+ 3.0
+ </p>
+</dd>
+<dt class="member" id="GetDateNamesOptions::item"><span class="attrName">DOMString item</span></dt>
+<dd>
+<div class="brief">
+ Determines whether to return the names of months or the names of days.
+ </div>
+<div class="description">
+ <p>
+The following values are valid:
+ </p>
+ <ul>
+ <li>
+'months' - The names of months will be returned. </li>
+ <li>
+'days' - The names of days of the week will be returned. </li>
+ </ul>
+ </div>
+<p><span class="version">
+ Since: </span>
+ 3.0
+ </p>
+</dd>
+</dl>
+</div>
+</div>
+<div class="dictionary" id="NumberPatternOptions">
+<a class="backward-compatibility-anchor" name="::Globalization::NumberPatternOptions"></a><h3>1.6. NumberPatternOptions</h3>
+<div class="brief">
+ The NumberPatternOptions dictionary contains options
+used in handling numerical locale settings.
+ </div>
+<pre class="webidl prettyprint"> dictionary NumberPatternOptions {
+ DOMString type;
+ };</pre>
+<p><span class="version">
+ Since: </span>
+ 3.0
+ </p>
+<div class="attributes">
+<h4>Dictionary members</h4>
+<dl>
+<dt class="member" id="NumberPatternOptions::type"><span class="attrName">DOMString type</span></dt>
+<dd>
+<div class="brief">
+ The type determines the genus of numeric value,
+for which the pattern will be extracted.
+ </div>
+<div class="description">
+ <p>
+The following values are valid:
+ </p>
+ <ul>
+ <li>
+'decimal' - Indicates that the pattern for the
+decimal numbers should be extracted. </li>
+ <li>
+'percent' - Indicates that the pattern for the
+percents should be extracted. </li>
+ <li>
+'currency' - Indicates that the pattern for the
+currency values should be extracted. </li>
+ </ul>
+ </div>
+<p><span class="version">
+ Since: </span>
+ 3.0
+ </p>
+</dd>
+</dl>
+</div>
+</div>
+<div class="dictionary" id="DatePattern">
+<a class="backward-compatibility-anchor" name="::Globalization::DatePattern"></a><h3>1.7. DatePattern</h3>
+<div class="brief">
+ The DatePattern dictionary contains the information obtained in getDatePattern method.
+ </div>
+<pre class="webidl prettyprint"> dictionary DatePattern {
+ DOMString pattern;
+ DOMString timezone;
+ long utc_offset;
+ long dst_offset;
+ };</pre>
+<p><span class="version">
+ Since: </span>
+ 3.0
+ </p>
+<div class="attributes">
+<h4>Dictionary members</h4>
+<dl>
+<dt class="member" id="DatePattern::pattern"><span class="attrName">DOMString pattern</span></dt>
+<dd>
+<div class="brief">
+ The date and time pattern to format and parse dates.
+The patterns follow Unicode Technical Standard #35.
+ </div>
+<p><span class="version">
+ Since: </span>
+ 3.0
+ </p>
+</dd>
+<dt class="member" id="DatePattern::timezone"><span class="attrName">DOMString timezone</span></dt>
+<dd>
+<div class="brief">
+ The abbreviated name of the time zone on client's device.
+ </div>
+<p><span class="version">
+ Since: </span>
+ 3.0
+ </p>
+</dd>
+<dt class="member" id="DatePattern::utc_offset"><span class="attrName">long utc_offset</span></dt>
+<dd>
+<div class="brief">
+ The current difference in seconds between the client's time zone
+and coordinated universal time.
+ </div>
+<p><span class="version">
+ Since: </span>
+ 3.0
+ </p>
+</dd>
+<dt class="member" id="DatePattern::dst_offset"><span class="attrName">long dst_offset</span></dt>
+<dd>
+<div class="brief">
+ The current daylight saving time offset in seconds between the client's
+non-daylight saving time zone and the client's daylight saving time zone.
+ </div>
+<p><span class="version">
+ Since: </span>
+ 3.0
+ </p>
+</dd>
+</dl>
+</div>
+</div>
+<div class="dictionary" id="NumberPattern">
+<a class="backward-compatibility-anchor" name="::Globalization::NumberPattern"></a><h3>1.8. NumberPattern</h3>
+<div class="brief">
+ The NumberPattern dictionary contains the information obtained
+by calling the getNumberPattern method.
+ </div>
+<pre class="webidl prettyprint"> dictionary NumberPattern {
+ DOMString pattern;
+ DOMString symbol;
+ long fraction;
+ double rounding;
+ DOMString positive;
+ DOMString negative;
+ DOMString decimal;
+ DOMString grouping;
+ };</pre>
+<p><span class="version">
+ Since: </span>
+ 3.0
+ </p>
+<div class="attributes">
+<h4>Dictionary members</h4>
+<dl>
+<dt class="member" id="NumberPattern::pattern"><span class="attrName">DOMString pattern</span></dt>
+<dd>
+<div class="brief">
+ The number pattern to format and parse numbers.
+The patterns follow Unicode Technical Standard #35.
+ </div>
+<p><span class="version">
+ Since: </span>
+ 3.0
+ </p>
+</dd>
+<dt class="member" id="NumberPattern::symbol"><span class="attrName">DOMString symbol</span></dt>
+<dd>
+<div class="brief">
+ The symbol to use when formatting and parsing,
+such as percent or currency symbol.
+ </div>
+<p><span class="version">
+ Since: </span>
+ 3.0
+ </p>
+</dd>
+<dt class="member" id="NumberPattern::fraction"><span class="attrName">long fraction</span></dt>
+<dd>
+<div class="brief">
+ The number of fractional digits to use
+when parsing and formatting.
+ </div>
+<p><span class="version">
+ Since: </span>
+ 3.0
+ </p>
+</dd>
+<dt class="member" id="NumberPattern::rounding"><span class="attrName">double rounding</span></dt>
+<dd>
+<div class="brief">
+ The rounding increment to use when parsing and formatting.
+ </div>
+<p><span class="version">
+ Since: </span>
+ 3.0
+ </p>
+</dd>
+<dt class="member" id="NumberPattern::positive"><span class="attrName">DOMString positive</span></dt>
+<dd>
+<div class="brief">
+ The symbol to use for positive numbers
+when parsing and formatting.
+ </div>
+<p><span class="version">
+ Since: </span>
+ 3.0
+ </p>
+</dd>
+<dt class="member" id="NumberPattern::negative"><span class="attrName">DOMString negative</span></dt>
+<dd>
+<div class="brief">
+ The symbol to use for negative numbers
+when parsing and formatting.
+ </div>
+<p><span class="version">
+ Since: </span>
+ 3.0
+ </p>
+</dd>
+<dt class="member" id="NumberPattern::decimal"><span class="attrName">DOMString decimal</span></dt>
+<dd>
+<div class="brief">
+ The decimal symbol to use for parsing and formatting.
+ </div>
+<p><span class="version">
+ Since: </span>
+ 3.0
+ </p>
+</dd>
+<dt class="member" id="NumberPattern::grouping"><span class="attrName">DOMString grouping</span></dt>
+<dd>
+<div class="brief">
+ The grouping symbol to use for parsing and formatting.
+ </div>
+<p><span class="version">
+ Since: </span>
+ 3.0
+ </p>
+</dd>
+</dl>
+</div>
+</div>
+<div class="dictionary" id="GlobalizationDate">
+<a class="backward-compatibility-anchor" name="::Globalization::GlobalizationDate"></a><h3>1.9. GlobalizationDate</h3>
+<div class="brief">
+ the GlobalizationDate dictionary represents a point in time,
+similar to a Date object in javascript.
+ </div>
+<pre class="webidl prettyprint"> dictionary GlobalizationDate {
+ long year;
+ long month;
+ long day;
+ long hour;
+ long minute;
+ long second;
+ long millisecond;
+ };</pre>
+<p><span class="version">
+ Since: </span>
+ 3.0
+ </p>
+<div class="attributes">
+<h4>Dictionary members</h4>
+<dl>
+<dt class="member" id="GlobalizationDate::year"><span class="attrName">long year</span></dt>
+<dd>
+<div class="brief">
+ The four digit year.
+ </div>
+<p><span class="version">
+ Since: </span>
+ 3.0
+ </p>
+</dd>
+<dt class="member" id="GlobalizationDate::month"><span class="attrName">long month</span></dt>
+<dd>
+<div class="brief">
+ The month index in range (0, 11) inclusively.
+ </div>
+<p><span class="version">
+ Since: </span>
+ 3.0
+ </p>
+</dd>
+<dt class="member" id="GlobalizationDate::day"><span class="attrName">long day</span></dt>
+<dd>
+<div class="brief">
+ The day of month in range (1, 31) inclusively.
+ </div>
+<p><span class="version">
+ Since: </span>
+ 3.0
+ </p>
+</dd>
+<dt class="member" id="GlobalizationDate::hour"><span class="attrName">long hour</span></dt>
+<dd>
+<div class="brief">
+ The hour in range (0, 23) inclusively.
+ </div>
+<p><span class="version">
+ Since: </span>
+ 3.0
+ </p>
+</dd>
+<dt class="member" id="GlobalizationDate::minute"><span class="attrName">long minute</span></dt>
+<dd>
+<div class="brief">
+ The minute in range (0, 59) inclusively.
+ </div>
+<p><span class="version">
+ Since: </span>
+ 3.0
+ </p>
+</dd>
+<dt class="member" id="GlobalizationDate::second"><span class="attrName">long second</span></dt>
+<dd>
+<div class="brief">
+ The second in range (0, 59) inclusively.
+ </div>
+<p><span class="version">
+ Since: </span>
+ 3.0
+ </p>
+</dd>
+<dt class="member" id="GlobalizationDate::millisecond"><span class="attrName">long millisecond</span></dt>
+<dd>
+<div class="brief">
+ The milliseconds in range (0, 999) inclusively.
+ </div>
+<p><span class="version">
+ Since: </span>
+ 3.0
+ </p>
+</dd>
+</dl>
+</div>
+</div>
+<div class="interface" id="DSTSuccessCallback">
+<a class="backward-compatibility-anchor" name="::Globalization::DSTSuccessCallback"></a><h3>1.10. DSTSuccessCallback</h3>
+<div class="brief">
+ A callback method invoked on successful extraction
+of Daylight Saving Time data.
+ </div>
+<pre class="webidl prettyprint"> [Callback=FunctionOnly, NoInterfaceObject] interface DSTSuccessCallback {
+ void onsuccess(object properties);
+ };</pre>
+<p><span class="version">
+ Since: </span>
+ 3.0
+ </p>
+<div class="methods">
+<h4>Methods</h4>
+<dl>
+<dt class="method" id="DSTSuccessCallback::onsuccess">
+<a class="backward-compatibility-anchor" name="::Globalization::DSTSuccessCallback::onsuccess"></a><code><b><span class="methodName">onsuccess</span></b></code>
+</dt>
+<dd>
+<div class="brief">
+ Called when a function returns the DST data successfully.
+ </div>
+<div class="synopsis"><pre class="signature prettyprint">void onsuccess(object properties);
+ </pre></div>
+<p><span class="version">
+ Since: </span>
+ 3.0
+ </p>
+<div class="parameters">
+<p><span class="param">Parameters:</span></p>
+<ul>
+ <li class="param">
+<span class="name">properties</span>:
+ An object containing the field "dst" of boolean type.
+ </li>
+ </ul>
+</div>
+</dd>
+</dl>
+</div>
+</div>
+<div class="interface" id="StringSuccessCallback">
+<a class="backward-compatibility-anchor" name="::Globalization::StringSuccessCallback"></a><h3>1.11. StringSuccessCallback</h3>
+<div class="brief">
+ A callback method invoked on successful extraction of
+a data encoded as a DOMString.
+ </div>
+<pre class="webidl prettyprint"> [Callback=FunctionOnly, NoInterfaceObject] interface StringSuccessCallback {
+ void onsuccess(object properties);
+ };</pre>
+<p><span class="version">
+ Since: </span>
+ 3.0
+ </p>
+<div class="methods">
+<h4>Methods</h4>
+<dl>
+<dt class="method" id="StringSuccessCallback::onsuccess">
+<a class="backward-compatibility-anchor" name="::Globalization::StringSuccessCallback::onsuccess"></a><code><b><span class="methodName">onsuccess</span></b></code>
+</dt>
+<dd>
+<div class="brief">
+ Called when a function returns the properties object with data successfully.
+ </div>
+<div class="synopsis"><pre class="signature prettyprint">void onsuccess(object properties);
+ </pre></div>
+<p><span class="version">
+ Since: </span>
+ 3.0
+ </p>
+<div class="parameters">
+<p><span class="param">Parameters:</span></p>
+<ul>
+ <li class="param">
+<span class="name">properties</span>:
+ An object containing the field "value" of a DOMString type.
+ </li>
+ </ul>
+</div>
+</dd>
+</dl>
+</div>
+</div>
+<div class="interface" id="ArrayStringSuccessCallback">
+<a class="backward-compatibility-anchor" name="::Globalization::ArrayStringSuccessCallback"></a><h3>1.12. ArrayStringSuccessCallback</h3>
+<div class="brief">
+ The callback method invoked on successful extraction of
+the data represented as an array of DOMString values.
+ </div>
+<pre class="webidl prettyprint"> [Callback=FunctionOnly, NoInterfaceObject] interface ArrayStringSuccessCallback {
+ void onsuccess(object properties);
+ };</pre>
+<p><span class="version">
+ Since: </span>
+ 3.0
+ </p>
+<div class="methods">
+<h4>Methods</h4>
+<dl>
+<dt class="method" id="ArrayStringSuccessCallback::onsuccess">
+<a class="backward-compatibility-anchor" name="::Globalization::ArrayStringSuccessCallback::onsuccess"></a><code><b><span class="methodName">onsuccess</span></b></code>
+</dt>
+<dd>
+<div class="brief">
+ Called when a function returns the array of DOMString values succesfully.
+ </div>
+<div class="synopsis"><pre class="signature prettyprint">void onsuccess(object properties);
+ </pre></div>
+<p><span class="version">
+ Since: </span>
+ 3.0
+ </p>
+<div class="parameters">
+<p><span class="param">Parameters:</span></p>
+<ul>
+ <li class="param">
+<span class="name">properties</span>:
+ an object with the field "value"
+containing an Array of DOMString values.
+ </li>
+ </ul>
+</div>
+</dd>
+</dl>
+</div>
+</div>
+<div class="interface" id="LongSuccessCallback">
+<a class="backward-compatibility-anchor" name="::Globalization::LongSuccessCallback"></a><h3>1.13. LongSuccessCallback</h3>
+<div class="brief">
+ The callback method invoked on successful extraction
+of the data represented as a long integer value.
+ </div>
+<pre class="webidl prettyprint"> [Callback=FunctionOnly, NoInterfaceObject] interface LongSuccessCallback {
+ void onsuccess(object properties);
+ };</pre>
+<p><span class="version">
+ Since: </span>
+ 3.0
+ </p>
+<div class="methods">
+<h4>Methods</h4>
+<dl>
+<dt class="method" id="LongSuccessCallback::onsuccess">
+<a class="backward-compatibility-anchor" name="::Globalization::LongSuccessCallback::onsuccess"></a><code><b><span class="methodName">onsuccess</span></b></code>
+</dt>
+<dd>
+<div class="brief">
+ Called when a function returns a numeric (long) data successfully.
+ </div>
+<div class="synopsis"><pre class="signature prettyprint">void onsuccess(object properties);
+ </pre></div>
+<p><span class="version">
+ Since: </span>
+ 3.0
+ </p>
+<div class="parameters">
+<p><span class="param">Parameters:</span></p>
+<ul>
+ <li class="param">
+<span class="name">properties</span>:
+ An object containing the field "value" of a long type.
+ </li>
+ </ul>
+</div>
+</dd>
+</dl>
+</div>
+</div>
+<div class="interface" id="DoubleSuccessCallback">
+<a class="backward-compatibility-anchor" name="::Globalization::DoubleSuccessCallback"></a><h3>1.14. DoubleSuccessCallback</h3>
+<div class="brief">
+ The callback method invoked on successful extraction
+of the data represented as a double precision numeric value.
+ </div>
+<pre class="webidl prettyprint"> [Callback=FunctionOnly, NoInterfaceObject] interface DoubleSuccessCallback {
+ void onsuccess(object properties);
+ };</pre>
+<p><span class="version">
+ Since: </span>
+ 3.0
+ </p>
+<div class="methods">
+<h4>Methods</h4>
+<dl>
+<dt class="method" id="DoubleSuccessCallback::onsuccess">
+<a class="backward-compatibility-anchor" name="::Globalization::DoubleSuccessCallback::onsuccess"></a><code><b><span class="methodName">onsuccess</span></b></code>
+</dt>
+<dd>
+<div class="brief">
+ Called when a function returns a numeric (double) data successfully.
+ </div>
+<div class="synopsis"><pre class="signature prettyprint">void onsuccess(object properties);
+ </pre></div>
+<p><span class="version">
+ Since: </span>
+ 3.0
+ </p>
+<div class="parameters">
+<p><span class="param">Parameters:</span></p>
+<ul>
+ <li class="param">
+<span class="name">properties</span>:
+ An object containing the field "value" of a double type.
+ </li>
+ </ul>
+</div>
+</dd>
+</dl>
+</div>
+</div>
+<div class="interface" id="GlobalizationDateSuccessCallback">
+<a class="backward-compatibility-anchor" name="::Globalization::GlobalizationDateSuccessCallback"></a><h3>1.15. GlobalizationDateSuccessCallback</h3>
+<div class="brief">
+ The callback method invoked on successful extraction
+of the GlobalizationDate object.
+ </div>
+<pre class="webidl prettyprint"> [Callback=FunctionOnly, NoInterfaceObject] interface GlobalizationDateSuccessCallback {
+ void onsuccess(Date date);
+ };</pre>
+<p><span class="version">
+ Since: </span>
+ 3.0
+ </p>
+<div class="methods">
+<h4>Methods</h4>
+<dl>
+<dt class="method" id="GlobalizationDateSuccessCallback::onsuccess">
+<a class="backward-compatibility-anchor" name="::Globalization::GlobalizationDateSuccessCallback::onsuccess"></a><code><b><span class="methodName">onsuccess</span></b></code>
+</dt>
+<dd>
+<div class="brief">
+ Called when a function returns a GlobalizationDate object successfully.
+ </div>
+<div class="synopsis"><pre class="signature prettyprint">void onsuccess(Date date);
+ </pre></div>
+<p><span class="version">
+ Since: </span>
+ 3.0
+ </p>
+<div class="parameters">
+<p><span class="param">Parameters:</span></p>
+<ul>
+ <li class="param">
+<span class="name">date</span>:
+ a GlobalizationDate object containing the date information.
+ </li>
+ </ul>
+</div>
+</dd>
+</dl>
+</div>
+</div>
+<div class="interface" id="PatternSuccessCallback">
+<a class="backward-compatibility-anchor" name="::Globalization::PatternSuccessCallback"></a><h3>1.16. PatternSuccessCallback</h3>
+<div class="brief">
+ The callback method invoked on successful extraction
+of a CurrencyPattern object.
+ </div>
+<pre class="webidl prettyprint"> [Callback=FunctionOnly, NoInterfaceObject] interface PatternSuccessCallback {
+ void onsuccess(<a href="#CurrencyPattern">CurrencyPattern</a> pattern);
+ };</pre>
+<p><span class="version">
+ Since: </span>
+ 3.0
+ </p>
+<div class="methods">
+<h4>Methods</h4>
+<dl>
+<dt class="method" id="PatternSuccessCallback::onsuccess">
+<a class="backward-compatibility-anchor" name="::Globalization::PatternSuccessCallback::onsuccess"></a><code><b><span class="methodName">onsuccess</span></b></code>
+</dt>
+<dd>
+<div class="brief">
+ Called when a function returns the currency pattern information succesfully.
+ </div>
+<div class="synopsis"><pre class="signature prettyprint">void onsuccess(<a href="#CurrencyPattern">CurrencyPattern</a> pattern);
+ </pre></div>
+<p><span class="version">
+ Since: </span>
+ 3.0
+ </p>
+<div class="parameters">
+<p><span class="param">Parameters:</span></p>
+<ul>
+ <li class="param">
+<span class="name">pattern</span>:
+ a CurrencyPattern object containing retrieved information.
+ </li>
+ </ul>
+</div>
+</dd>
+</dl>
+</div>
+</div>
+<div class="interface" id="GetDatePatternSuccessCallback">
+<a class="backward-compatibility-anchor" name="::Globalization::GetDatePatternSuccessCallback"></a><h3>1.17. GetDatePatternSuccessCallback</h3>
+<div class="brief">
+ The callback method invoked on succesful extraction
+of a DatePattern object.
+ </div>
+<pre class="webidl prettyprint"> [Callback=FunctionOnly, NoInterfaceObject] interface GetDatePatternSuccessCallback {
+ void onsuccess(<a href="#DatePattern">DatePattern</a> pattern);
+ };</pre>
+<p><span class="version">
+ Since: </span>
+ 3.0
+ </p>
+<div class="methods">
+<h4>Methods</h4>
+<dl>
+<dt class="method" id="GetDatePatternSuccessCallback::onsuccess">
+<a class="backward-compatibility-anchor" name="::Globalization::GetDatePatternSuccessCallback::onsuccess"></a><code><b><span class="methodName">onsuccess</span></b></code>
+</dt>
+<dd>
+<div class="brief">
+ Called when a function returns the date pattern information successfully.
+ </div>
+<div class="synopsis"><pre class="signature prettyprint">void onsuccess(<a href="#DatePattern">DatePattern</a> pattern);
+ </pre></div>
+<p><span class="version">
+ Since: </span>
+ 3.0
+ </p>
+<div class="parameters">
+<p><span class="param">Parameters:</span></p>
+<ul>
+ <li class="param">
+<span class="name">pattern</span>:
+ a DatePattern object containing retrieved information.
+ </li>
+ </ul>
+</div>
+</dd>
+</dl>
+</div>
+</div>
+<div class="interface" id="GetNumberPatternSuccessCallback">
+<a class="backward-compatibility-anchor" name="::Globalization::GetNumberPatternSuccessCallback"></a><h3>1.18. GetNumberPatternSuccessCallback</h3>
+<div class="brief">
+ The callback method invoked on successful extraction
+of a NumberPattern object.
+ </div>
+<pre class="webidl prettyprint"> [Callback=FunctionOnly, NoInterfaceObject] interface GetNumberPatternSuccessCallback {
+ void onsuccess(<a href="#NumberPattern">NumberPattern</a> pattern);
+ };</pre>
+<p><span class="version">
+ Since: </span>
+ 3.0
+ </p>
+<div class="methods">
+<h4>Methods</h4>
+<dl>
+<dt class="method" id="GetNumberPatternSuccessCallback::onsuccess">
+<a class="backward-compatibility-anchor" name="::Globalization::GetNumberPatternSuccessCallback::onsuccess"></a><code><b><span class="methodName">onsuccess</span></b></code>
+</dt>
+<dd>
+<div class="brief">
+ Called when a function returns the number pattern information successfully.
+ </div>
+<div class="synopsis"><pre class="signature prettyprint">void onsuccess(<a href="#NumberPattern">NumberPattern</a> pattern);
+ </pre></div>
+<p><span class="version">
+ Since: </span>
+ 3.0
+ </p>
+<div class="parameters">
+<p><span class="param">Parameters:</span></p>
+<ul>
+ <li class="param">
+<span class="name">pattern</span>:
+ a NumberPattern object containing retrieved information.
+ </li>
+ </ul>
+</div>
+</dd>
+</dl>
+</div>
+</div>
+<div class="interface" id="GlobalizationError">
+<a class="backward-compatibility-anchor" name="::Globalization::GlobalizationError"></a><h3>1.19. GlobalizationError</h3>
+<pre class="webidl prettyprint"> interface GlobalizationError {
+ attribute long code;
+ attribute DOMString message;
+ const short UNKNOWN_ERROR = 0;
+ const short FORMATTING_ERROR = 1;
+ const short PARSING_ERROR = 2;
+ const short PATTERN_ERROR = 3;
+ };</pre>
+<p><span class="version">
+ Since: </span>
+ 3.0
+ </p>
+<div class="description">
+ <p>
+The GlobalizationError interface
+ </p>
+ </div>
+<div class="consts">
+<h4>Constants</h4>
+<dl>
+<li class="const" id="GlobalizationError::UNKNOWN_ERROR">
+<a class="backward-compatibility-anchor" name="::Globalization::GlobalizationError::UNKNOWN_ERROR"></a><span class="name">UNKNOWN_ERROR</span><div class="brief">
+ Unknown error
+ </div>
+<p><span class="version">
+ Since: </span>
+ 3.0
+ </p>
+<br><br>
+</li>
+<li class="const" id="GlobalizationError::FORMATTING_ERROR">
+<a class="backward-compatibility-anchor" name="::Globalization::GlobalizationError::FORMATTING_ERROR"></a><span class="name">FORMATTING_ERROR</span><div class="brief">
+ Formatting error
+ </div>
+<p><span class="version">
+ Since: </span>
+ 3.0
+ </p>
+<br><br>
+</li>
+<li class="const" id="GlobalizationError::PARSING_ERROR">
+<a class="backward-compatibility-anchor" name="::Globalization::GlobalizationError::PARSING_ERROR"></a><span class="name">PARSING_ERROR</span><div class="brief">
+ Parsing error
+ </div>
+<p><span class="version">
+ Since: </span>
+ 3.0
+ </p>
+<br><br>
+</li>
+<li class="const" id="GlobalizationError::PATTERN_ERROR">
+<a class="backward-compatibility-anchor" name="::Globalization::GlobalizationError::PATTERN_ERROR"></a><span class="name">PATTERN_ERROR</span><div class="brief">
+ Pattern error
+ </div>
+<p><span class="version">
+ Since: </span>
+ 3.0
+ </p>
+<br><br>
+</li>
+</dl>
+</div>
+<div class="attributes">
+<h4>Attributes</h4>
+<ul>
+<li class="attribute" id="GlobalizationError::code">
+<span class="attrName"><span class="type">long </span><span class="name">code</span></span><div class="brief">
+ One of the following codes representing the error type.
+ </div>
+<div class="description">
+ <ul>
+ <li>
+0: GlobalizationError.UNKNOWN_ERROR </li>
+ <li>
+1: GlobalizationError.FORMATTING_ERROR </li>
+ <li>
+2: GlobalizationError.PARSING_ERROR </li>
+ <li>
+3: GlobalizationError.PATTERN_ERROR </li>
+ </ul>
+ </div>
+<p><span class="version">
+ Since: </span>
+ 3.0
+ </p>
+</li>
+<li class="attribute" id="GlobalizationError::message">
+<span class="attrName"><span class="type">DOMString </span><span class="name">message</span></span><div class="brief">
+ A text message that includes the error's explaination and/or details.
+ </div>
+<p><span class="version">
+ Since: </span>
+ 3.0
+ </p>
+</li>
+</ul>
+</div>
+</div>
+</div>
+<h2 id="full-webidl">2. Full WebIDL</h2>
+<pre class="webidl prettyprint"> module Globalization {
+
+ [NoInterfaceObject] interface GlobalizationManagerObject {
+ readonly attribute <a href="#GlobalizationManager">GlobalizationManager</a> globalization;
+ };
+
+ implements <a href="#GlobalizationManagerObject">GlobalizationManagerObject</a>;
+
+ [NoInterfaceObject] interface GlobalizationManager {
+
+ void getPreferredLanguage(<a href="#StringSuccessCallback">StringSuccessCallback</a> onsuccess,
+ <a href="cordova.html#ErrorCallback">ErrorCallback</a><a href="file.html#ErrorCallback">ErrorCallback</a> onerror);
+
+ void getLocaleName(<a href="#StringSuccessCallback">StringSuccessCallback</a> onsuccess,
+ <a href="cordova.html#ErrorCallback">ErrorCallback</a><a href="file.html#ErrorCallback">ErrorCallback</a> onerror);
+
+ void dateToString(Date date, <a href="#StringSuccessCallback">StringSuccessCallback</a> onsuccess, <a href="cordova.html#ErrorCallback">ErrorCallback</a><a href="file.html#ErrorCallback">ErrorCallback</a> onerror,
+ optional <a href="#DateOptions">DateOptions</a> options);
+
+ void getCurrencyPattern(DOMString currencyCode,
+ <a href="#PatternSuccessCallback">PatternSuccessCallback</a> onsuccess,
+ <a href="cordova.html#ErrorCallback">ErrorCallback</a><a href="file.html#ErrorCallback">ErrorCallback</a> onerror);
+
+ void getDateNames(<a href="#ArrayStringSuccessCallback">ArrayStringSuccessCallback</a> onsuccess, <a href="cordova.html#ErrorCallback">ErrorCallback</a><a href="file.html#ErrorCallback">ErrorCallback</a> onerror,
+ optional <a href="#GetDateNamesOptions">GetDateNamesOptions</a> options);
+
+ void getDatePattern(<a href="#GetDatePatternSuccessCallback">GetDatePatternSuccessCallback</a> onsuccess, <a href="cordova.html#ErrorCallback">ErrorCallback</a><a href="file.html#ErrorCallback">ErrorCallback</a> onerror,
+ optional <a href="#DateOptions">DateOptions</a> options);
+
+ void getFirstDayOfWeek(<a href="#LongSuccessCallback">LongSuccessCallback</a> onsuccess,
+ <a href="cordova.html#ErrorCallback">ErrorCallback</a><a href="file.html#ErrorCallback">ErrorCallback</a> onerror);
+
+ void getNumberPattern(<a href="#GetNumberPatternSuccessCallback">GetNumberPatternSuccessCallback</a> onsuccess,
+ <a href="cordova.html#ErrorCallback">ErrorCallback</a><a href="file.html#ErrorCallback">ErrorCallback</a> onerror,
+ optional <a href="#NumberPatternOptions">NumberPatternOptions</a> options);
+
+ void isDayLightSavingsTime(Date date, <a href="#DSTSuccessCallback">DSTSuccessCallback</a> onsuccess,
+ <a href="cordova.html#ErrorCallback">ErrorCallback</a><a href="file.html#ErrorCallback">ErrorCallback</a> onerror);
+
+ void numberToString(double number, <a href="#StringSuccessCallback">StringSuccessCallback</a> onsuccess, <a href="cordova.html#ErrorCallback">ErrorCallback</a><a href="file.html#ErrorCallback">ErrorCallback</a> onerror,
+ optional <a href="#NumberPatternOptions">NumberPatternOptions</a> options);
+
+ void stringToDate(DOMString dateString, <a href="#GlobalizationDateSuccessCallback">GlobalizationDateSuccessCallback</a> onsuccess,
+ <a href="cordova.html#ErrorCallback">ErrorCallback</a><a href="file.html#ErrorCallback">ErrorCallback</a> onerror,
+ optional <a href="#DateOptions">DateOptions</a> options);
+ void stringToNumber(DOMString numberString, <a href="#DoubleSuccessCallback">DoubleSuccessCallback</a> onsuccess,
+ <a href="cordova.html#ErrorCallback">ErrorCallback</a><a href="file.html#ErrorCallback">ErrorCallback</a> onerror,
+ optional <a href="#NumberPatternOptions">NumberPatternOptions</a> options);
+ };
+
+ dictionary DateOptions {
+ DOMString formatLength;
+ DOMString selector;
+ };
+
+ dictionary CurrencyPattern {
+ DOMString pattern;
+ DOMString code;
+ long fraction;
+ double rounding;
+ DOMString decimal;
+ DOMString grouping;
+ };
+
+ dictionary GetDateNamesOptions {
+ DOMString type;
+ DOMString item;
+ };
+
+ dictionary NumberPatternOptions {
+ DOMString type;
+ };
+
+ dictionary DatePattern {
+ DOMString pattern;
+ DOMString timezone;
+ long utc_offset;
+ long dst_offset;
+ };
+
+ dictionary NumberPattern {
+ DOMString pattern;
+ DOMString symbol;
+ long fraction;
+ double rounding;
+ DOMString positive;
+ DOMString negative;
+ DOMString decimal;
+ DOMString grouping;
+ };
+
+ dictionary GlobalizationDate {
+ long year;
+ long month;
+ long day;
+ long hour;
+ long minute;
+ long second;
+ long millisecond;
+ };
+
+
+ [Callback=FunctionOnly, NoInterfaceObject] interface DSTSuccessCallback {
+ void onsuccess(object properties);
+ };
+
+ [Callback=FunctionOnly, NoInterfaceObject] interface StringSuccessCallback {
+ void onsuccess(object properties);
+ };
+
+ [Callback=FunctionOnly, NoInterfaceObject] interface ArrayStringSuccessCallback {
+ void onsuccess(object properties);
+ };
+
+ [Callback=FunctionOnly, NoInterfaceObject] interface LongSuccessCallback {
+ void onsuccess(object properties);
+ };
+
+ [Callback=FunctionOnly, NoInterfaceObject] interface DoubleSuccessCallback {
+ void onsuccess(object properties);
+ };
+
+ [Callback=FunctionOnly, NoInterfaceObject] interface GlobalizationDateSuccessCallback {
+ void onsuccess(Date date);
+ };
+
+ [Callback=FunctionOnly, NoInterfaceObject] interface PatternSuccessCallback {
+ void onsuccess(<a href="#CurrencyPattern">CurrencyPattern</a> pattern);
+ };
+
+ [Callback=FunctionOnly, NoInterfaceObject] interface GetDatePatternSuccessCallback {
+ void onsuccess(<a href="#DatePattern">DatePattern</a> pattern);
+ };
+
+ [Callback=FunctionOnly, NoInterfaceObject] interface GetNumberPatternSuccessCallback {
+ void onsuccess(<a href="#NumberPattern">NumberPattern</a> pattern);
+ };
+
+ interface GlobalizationError {
+ attribute long code;
+ attribute DOMString message;
+ const short UNKNOWN_ERROR = 0;
+ const short FORMATTING_ERROR = 1;
+ const short PARSING_ERROR = 2;
+ const short PATTERN_ERROR = 3;
+ };
+};</pre>
+</div>
+<div id="page-footer">
+<div class="copyright" align="center">
+ Except as noted, this content - excluding the Code Examples - is licensed under <a href="http://creativecommons.org/licenses/by/3.0/legalcode" target="_blank">Creative Commons Attribution 3.0</a> and all of the Code Examples contained herein are licensed under <a href="https://www.tizen.org/bsd-3-clause-license" target="_blank">BSD-3-Clause</a>. <br>For details, see the <a href="https://www.tizen.org/content-license" target="_blank">Content License</a>.
+ </div>
+<script type="text/javascript">
+
+ var _gaq = _gaq || [];
+ _gaq.push(['_setAccount', 'UA-25976949-1']);
+ _gaq.push(['_setDomainName', 'tizen.org']);
+ _gaq.push(['_trackPageview']);
+
+ (function() {
+ var ga = document.createElement('script'); ga.type = 'text/javascript'; ga.async = true;
+ var s = document.getElementsByTagName('script')[0]; s.parentNode.insertBefore(ga, s);
+ })();
+
+ </script>
+</div>
+</body>
+</html>
--- /dev/null
+<!DOCTYPE html PUBLIC "html">
+<html>
+<head>
+<meta http-equiv="Content-Type" content="text/html; charset=utf-8">
+<link rel="stylesheet" type="text/css" href="../tizen.css" media="screen">
+<script type="text/javascript" src="snippet.js"></script><title>Media API</title>
+</head>
+<body id="page-content" onload="prettyPrint()">
+<div class="api" id="::Media">
+<div class="supported-platforms"><img class="wearable-mandatory emulator" title="Mandatory, Supported by Tizen Wearable emulator" src="../wearable_s_w.png"></div>
+<div class="title"><h1>Media API</h1></div>
+<div class="brief">
+ This plugin provides the ability to record and play back audio files on a device.
+ </div>
+<div class="description">
+ <p>
+This plugin defines a global Media Constructor.
+ </p>
+ <p>
+Original documentation: <a href="https://www.npmjs.com/package/cordova-plugin-media">Cordova Media</a>.
+ </p>
+ </div>
+<h2>Table of Contents</h2>
+<ul class="toc">
+<li>1. <a href="#interfaces-section">Interfaces</a><ul class="toc">
+<li>1.1. <a href="#Media">Media</a>
+</li>
+<li>1.2. <a href="#MediaError">MediaError</a>
+</li>
+<li>1.3. <a href="#MediaErrorCallback">MediaErrorCallback</a>
+</li>
+<li>1.4. <a href="#StatusChangeCallback">StatusChangeCallback</a>
+</li>
+<li>1.5. <a href="#PositionSuccessCallback">PositionSuccessCallback</a>
+</li>
+</ul>
+</li>
+<li>2. <a href="#api-features">Related Feature</a>
+</li>
+<li>3. <a href="#full-webidl">Full WebIDL</a>
+</li>
+</ul>
+<hr>
+<h2 id="method-summary">Summary of Interfaces and Methods</h2>
+<table class="informaltable">
+<thead><tr>
+<th>Interface</th>
+<th>Method</th>
+</tr></thead>
+<tbody>
+<tr>
+<td><a href="#Media">Media</a></td>
+<td>
+<div>void <a href="#Media::getCurrentPosition">getCurrentPosition</a> (<a href="#PositionSuccessCallback">PositionSuccessCallback</a> positionSuccessCallback, optional <a href="#MediaErrorCallback">MediaErrorCallback</a> errorCallback)</div>
+<div>double <a href="#Media::getDuration">getDuration</a> ()</div>
+<div>void <a href="#Media::pause">pause</a> ()</div>
+<div>void <a href="#Media::play">play</a> ()</div>
+<div>void <a href="#Media::release">release</a> ()</div>
+<div>void <a href="#Media::seekTo">seekTo</a> (double position)</div>
+<div>void <a href="#Media::setVolume">setVolume</a> (double volume)</div>
+<div>void <a href="#Media::startRecord">startRecord</a> ()</div>
+<div>void <a href="#Media::stopRecord">stopRecord</a> ()</div>
+<div>void <a href="#Media::stop">stop</a> ()</div>
+</td>
+</tr>
+<tr>
+<td><a href="#MediaError">MediaError</a></td>
+<td></td>
+</tr>
+<tr>
+<td><a href="#MediaErrorCallback">MediaErrorCallback</a></td>
+<td><div>void <a href="#MediaErrorCallback::onerror">onerror</a> (<a href="#MediaError">MediaError</a> error)</div></td>
+</tr>
+<tr>
+<td><a href="#StatusChangeCallback">StatusChangeCallback</a></td>
+<td><div>void <a href="#StatusChangeCallback::onchanged">onchanged</a> (short status)</div></td>
+</tr>
+<tr>
+<td><a href="#PositionSuccessCallback">PositionSuccessCallback</a></td>
+<td><div>void <a href="#PositionSuccessCallback::onsuccess">onsuccess</a> (double position)</div></td>
+</tr>
+</tbody>
+</table>
+<div class="interfaces" id="interfaces-section">
+<h2>1. Interfaces</h2>
+<div class="interface" id="Media">
+<a class="backward-compatibility-anchor" name="::Media::Media"></a><h3>1.1. Media</h3>
+<div class="brief">
+ The Media interface provides the audio object.
+ </div>
+<pre class="webidl prettyprint"> [Constructor(DOMString src, optional <a href="cordova.html#SuccessCallback">SuccessCallback</a>? successCallback, optional <a href="#MediaErrorCallback">MediaErrorCallback</a>? errorCallback, optional <a href="#StatusChangeCallback">StatusChangeCallback</a>? mediaStatus)]
+ interface Media {
+ const short MEDIA_NONE = 0;
+ const short MEDIA_STARTING = 1;
+ const short MEDIA_RUNNING = 2;
+ const short MEDIA_PAUSED = 3;
+ const short MEDIA_STOPPED = 4;
+
+ attribute DOMString src;
+
+ attribute <a href="cordova.html#SuccessCallback">SuccessCallback</a>? successCallback;
+
+ attribute <a href="#MediaErrorCallback">MediaErrorCallback</a>? errorCallback;
+
+ attribute <a href="#StatusChangeCallback">StatusChangeCallback</a>? statusCallback;
+
+ void getCurrentPosition(<a href="#PositionSuccessCallback">PositionSuccessCallback</a> positionSuccessCallback, optional <a href="#MediaErrorCallback">MediaErrorCallback</a> errorCallback);
+
+ double getDuration();
+
+ void pause();
+
+ void play();
+
+ void release();
+
+ void seekTo(double position);
+
+ void setVolume(double volume);
+
+ void startRecord();
+
+ void stopRecord();
+
+ void stop();
+ };</pre>
+<div class="example">
+<span class="example"><p>Code example:</p></span><pre name="code" class="examplecode prettyprint"> var myMedia = new Media(src, successCallback, errorCallback, statusCallback);
+ </pre>
+</div>
+<div class="constructors">
+<h4 id="Media::constructor">Constructors</h4>
+<dl>
+<div class="brief">
+ The Media interface provides interface and functions to manage audio objects.
+ </div>
+<pre class="webidl prettyprint">Media(DOMString src, optional <a href="cordova.html#SuccessCallback">SuccessCallback</a>? successCallback, optional <a href="#MediaErrorCallback">MediaErrorCallback</a>? errorCallback, optional <a href="#StatusChangeCallback">StatusChangeCallback</a>? mediaStatus);</pre>
+<div class="description">
+ <ul>
+ <li>
+<b>TypeError</b> <ul>
+ <li>
+ <p>
+ Is thrown if any of the input parameters has incorrect type. </p>
+ </li>
+ </ul>
+ </li>
+ </ul>
+ </div>
+</dl>
+</div>
+<div class="consts">
+<h4>Constants</h4>
+<dl>
+<li class="const" id="Media::MEDIA_NONE">
+<a class="backward-compatibility-anchor" name="::Media::Media::MEDIA_NONE"></a><span class="name">MEDIA_NONE</span><br><br>
+</li>
+<li class="const" id="Media::MEDIA_STARTING">
+<a class="backward-compatibility-anchor" name="::Media::Media::MEDIA_STARTING"></a><span class="name">MEDIA_STARTING</span><br><br>
+</li>
+<li class="const" id="Media::MEDIA_RUNNING">
+<a class="backward-compatibility-anchor" name="::Media::Media::MEDIA_RUNNING"></a><span class="name">MEDIA_RUNNING</span><br><br>
+</li>
+<li class="const" id="Media::MEDIA_PAUSED">
+<a class="backward-compatibility-anchor" name="::Media::Media::MEDIA_PAUSED"></a><span class="name">MEDIA_PAUSED</span><br><br>
+</li>
+<li class="const" id="Media::MEDIA_STOPPED">
+<a class="backward-compatibility-anchor" name="::Media::Media::MEDIA_STOPPED"></a><span class="name">MEDIA_STOPPED</span><div class="brief">
+ Above constants are reported as the only parameter to the mediaStatus callback.
+ </div>
+<p><span class="version">
+ Since: </span>
+ 3.0
+ </p>
+<br><br>
+</li>
+</dl>
+</div>
+<div class="attributes">
+<h4>Attributes</h4>
+<ul>
+<li class="attribute" id="Media::src">
+<span class="attrName"><span class="type">DOMString </span><span class="name">src</span></span><div class="brief">
+ A URI containing the audio content.
+ </div>
+<p><span class="version">
+ Since: </span>
+ 3.0
+ </p>
+</li>
+<li class="attribute" id="Media::successCallback">
+<span class="attrName"><span class="type">SuccessCallback </span><span class="name">successCallback</span><span class="optional"> [nullable]</span></span><div class="brief">
+ The callback that executes after a Media object has completed the current play, record, or stop action.
+ </div>
+<p><span class="version">
+ Since: </span>
+ 3.0
+ </p>
+</li>
+<li class="attribute" id="Media::errorCallback">
+<span class="attrName"><span class="type">MediaErrorCallback </span><span class="name">errorCallback</span><span class="optional"> [nullable]</span></span><div class="brief">
+ The callback that executes if an error occurs.
+ </div>
+<p><span class="version">
+ Since: </span>
+ 3.0
+ </p>
+</li>
+<li class="attribute" id="Media::statusCallback">
+<span class="attrName"><span class="type">StatusChangeCallback </span><span class="name">statusCallback</span><span class="optional"> [nullable]</span></span><div class="brief">
+ The callback that executes to indicate status changes.
+ </div>
+<p><span class="version">
+ Since: </span>
+ 3.0
+ </p>
+</li>
+</ul>
+</div>
+<div class="methods">
+<h4>Methods</h4>
+<dl>
+<dt class="method" id="Media::getCurrentPosition">
+<a class="backward-compatibility-anchor" name="::Media::Media::getCurrentPosition"></a><code><b><span class="methodName">getCurrentPosition</span></b></code>
+</dt>
+<dd>
+<div class="brief">
+ Returns the current position within an audio file in seconds.
+ </div>
+<div class="synopsis"><pre class="signature prettyprint">void getCurrentPosition(<a href="#PositionSuccessCallback">PositionSuccessCallback</a> positionSuccessCallback, optional <a href="#MediaErrorCallback">MediaErrorCallback</a> errorCallback);
+ </pre></div>
+<p><span class="version">
+ Since: </span>
+ 3.0
+ </p>
+<div class="parameters">
+<p><span class="param">Parameters:</span></p>
+<ul>
+ <li class="param">
+<span class="name">positionSuccessCallback</span>:
+ The callback that is passed the current position in seconds.
+ </li>
+ <li class="param">
+<span class="name">errorCallback</span><span class="optional"> [optional]</span>:
+ The callback to execute if an error occurs.
+ </li>
+ </ul>
+</div>
+<div class="example">
+<span class="example"><p>Code example:</p></span><pre name="code" class="examplecode prettyprint"> successCallback = function() {
+ console.log('Audio file has been played back.');
+ }
+
+ errorCallback = function(err) {
+ console.log('Error occurred ' + err.message);
+ }
+
+ positionSuccessCallback = function(position) {
+ console.log('Current position is ' + position);
+ }
+
+ var src = 'file:///home/app/content/Documents/play.mp3';
+ var myMedia = new Media(src, successCallback, errorCallback);
+
+ myMedia.play();
+
+ setTimeout(function() {
+ myMedia.getCurrentPosition(positionSuccessCallback);
+ }, 2000);
+
+ </pre>
+</div>
+<div class="output">
+<span class="title"><p>Output example:</p></span><pre>Audio file has been played back.
+Current position is 2.000
+</pre>
+</div>
+</dd>
+<dt class="method" id="Media::getDuration">
+<a class="backward-compatibility-anchor" name="::Media::Media::getDuration"></a><code><b><span class="methodName">getDuration</span></b></code>
+</dt>
+<dd>
+<div class="brief">
+ Returns the duration of an audio file in seconds. If the duration is unknown, it returns a value of -1.
+ </div>
+<div class="synopsis"><pre class="signature prettyprint">double getDuration();
+ </pre></div>
+<p><span class="version">
+ Since: </span>
+ 3.0
+ </p>
+<div class="example">
+<span class="example"><p>Code example:</p></span><pre name="code" class="examplecode prettyprint"> successCallback = function() {
+ console.log('Audio file has been played back.);
+ }
+
+ errorCallback = function(err) {
+ console.log('Error occurred ' + err.message);
+ }
+
+ var src = 'file:///home/app/content/Documents/play.mp3';
+ var myMedia = new Media(src, successCallback, errorCallback);
+
+ var duration = myMedia.getDuration();
+ console.log('Audio duration is ' + duration);
+ </pre>
+</div>
+<div class="output">
+<span class="title"><p>Output example:</p></span><pre>Audio duration is 281.035
+</pre>
+</div>
+</dd>
+<dt class="method" id="Media::pause">
+<a class="backward-compatibility-anchor" name="::Media::Media::pause"></a><code><b><span class="methodName">pause</span></b></code>
+</dt>
+<dd>
+<div class="brief">
+ Pauses playing an audio file.
+ </div>
+<div class="synopsis"><pre class="signature prettyprint">void pause();
+ </pre></div>
+<p><span class="version">
+ Since: </span>
+ 3.0
+ </p>
+<div class="example">
+<span class="example"><p>Code example:</p></span><pre name="code" class="examplecode prettyprint"> successCallback = function() {
+ console.log('Audio file has been played back.');
+ }
+
+ errorCallback = function(err) {
+ console.log('Error occurred ' + err.message);
+ }
+
+ statusCallback = function(status) {
+ if (status == Media.MEDIA_PAUSED) {
+ console.log('Audio file has been paused');
+ }
+ }
+
+ var src = 'file:///home/app/content/Documents/play.mp3';
+ var myMedia = new Media(src, successCallback, errorCallback, statusCallback);
+
+ myMedia.play();
+
+ //Pause after 2 seconds
+ setTimeout(function() {
+ myMedia.pause();
+ }, 2000);
+
+ </pre>
+</div>
+<div class="output">
+<span class="title"><p>Output example:</p></span><pre>Audio file has been paused.
+</pre>
+</div>
+</dd>
+<dt class="method" id="Media::play">
+<a class="backward-compatibility-anchor" name="::Media::Media::play"></a><code><b><span class="methodName">play</span></b></code>
+</dt>
+<dd>
+<div class="brief">
+ Starts or resumes playing an audio file.
+ </div>
+<div class="synopsis"><pre class="signature prettyprint">void play();
+ </pre></div>
+<p><span class="version">
+ Since: </span>
+ 3.0
+ </p>
+<div class="example">
+<span class="example"><p>Code example:</p></span><pre name="code" class="examplecode prettyprint"> successCallback = function() {
+ console.log('Audio file has been played back.');
+ }
+
+ errorCallback = function(err) {
+ console.log('Error occurred ' + err.message);
+ }
+
+ var src = 'file:///home/app/content/Documents/play.mp3';
+ var myMedia = new Media(src, successCallback, errorCallback);
+
+ myMedia.play();
+ </pre>
+</div>
+<div class="output">
+<span class="title"><p>Output example:</p></span><pre>Audio file has been played back.
+</pre>
+</div>
+</dd>
+<dt class="method" id="Media::release">
+<a class="backward-compatibility-anchor" name="::Media::Media::release"></a><code><b><span class="methodName">release</span></b></code>
+</dt>
+<dd>
+<div class="brief">
+ Releases the underlying operating system's audio resources.
+Applications should call the release function for any Media resource that is no longer needed.
+ </div>
+<div class="synopsis"><pre class="signature prettyprint">void release();
+ </pre></div>
+<p><span class="version">
+ Since: </span>
+ 3.0
+ </p>
+<div class="example">
+<span class="example"><p>Code example:</p></span><pre name="code" class="examplecode prettyprint"> successCallback = function() {
+ console.log('Audio file has been stopped or released.');
+ }
+
+ errorCallback = function(err) {
+ console.log('An error occurred: ' + err.message);
+ }
+
+ var src = 'file://home/app/content/Documents/play.mp3';
+ var myMedia = new Media(src, successCallback, errorCallback);
+
+ myMedia.play();
+ myMedia.stop();
+ myMedia.release();
+ </pre>
+</div>
+<div class="output">
+<span class="title"><p>Output example:</p></span><pre>Audio file has been stopped or released.
+Audio file has been stopped or released.
+</pre>
+</div>
+</dd>
+<dt class="method" id="Media::seekTo">
+<a class="backward-compatibility-anchor" name="::Media::Media::seekTo"></a><code><b><span class="methodName">seekTo</span></b></code>
+</dt>
+<dd>
+<div class="brief">
+ Sets the current position within an audio file.
+ </div>
+<div class="synopsis"><pre class="signature prettyprint">void seekTo(double position);
+ </pre></div>
+<p><span class="version">
+ Since: </span>
+ 3.0
+ </p>
+<div class="parameters">
+<p><span class="param">Parameters:</span></p>
+<ul>
+ <li class="param">
+<span class="name">position</span>:
+ The position to set the playback position within the audio, in milliseconds.
+ </li>
+ </ul>
+</div>
+<div class="example">
+<span class="example"><p>Code example:</p></span><pre name="code" class="examplecode prettyprint"> successCallback = function() {
+ console.log('Audio file has been played back.');
+ }
+
+ errorCallback = function(err) {
+ console.log('An error occurred: ' + err.message);
+ }
+
+ var src = 'file://home/app/content/Documents/play.mp3';
+ var myMedia = new Media(src, successCallback, errorCallback);
+
+ myMedia.play();
+
+ //SeekTo to 10 seconds after 5 seconds
+ setTimeout(function() {
+ myMedia.seekTo(10000);
+ console.log('Playback position has been set to 10 seconds.');
+ }, 5000);
+ </pre>
+</div>
+<div class="output">
+<span class="title"><p>Output example:</p></span><pre>Playback position has been set to 10 seconds.
+Audio file has been played back.
+</pre>
+</div>
+</dd>
+<dt class="method" id="Media::setVolume">
+<a class="backward-compatibility-anchor" name="::Media::Media::setVolume"></a><code><b><span class="methodName">setVolume</span></b></code>
+</dt>
+<dd>
+<div class="brief">
+ Set the volume for an audio file.
+ </div>
+<div class="synopsis"><pre class="signature prettyprint">void setVolume(double volume);
+ </pre></div>
+<p><span class="version">
+ Since: </span>
+ 3.0
+ </p>
+<p><span class="privilegelevel">
+ Privilege level: </span>
+ public
+ </p>
+<p><span class="privilege">
+ Privilege: </span>
+ http://tizen.org/privilege/volume.set
+ </p>
+<div class="parameters">
+<p><span class="param">Parameters:</span></p>
+<ul>
+ <li class="param">
+<span class="name">volume</span>:
+ The volume to set for playback. The value must be within the range of 0.0 to 1.0.
+ </li>
+ </ul>
+</div>
+<div class="example">
+<span class="example"><p>Code example:</p></span><pre name="code" class="examplecode prettyprint"> successCallback = function() {
+ console.log('Audio file has been played back.');
+ }
+
+ errorCallback = function(err) {
+ console.log('Error occurred ' + err.message);
+ }
+
+ var src = 'file://home/app/content/Documents/play.mp3';
+ var myMedia = new Media(src, successCallback, errorCallback);
+
+ myMedia.play();
+
+ // Mute volume after 2 seconds
+ setTimeout(function() {
+ myMedia.setVolume(0.0);
+ console.log('Playback volume has been muted.');
+ }, 2000);
+
+ // Set volume to 1.0 after 5 seconds
+ setTimeout(function() {
+ myMedia.setVolume(1.0);
+ console.log('Playback volume has been set to 1.0.');
+ }, 5000);
+ </pre>
+</div>
+<div class="output">
+<span class="title"><p>Output example:</p></span><pre>Playback volume has been muted.
+Playback volume has been set to 1.0.
+Audio file has been played back.
+</pre>
+</div>
+</dd>
+<dt class="method" id="Media::startRecord">
+<a class="backward-compatibility-anchor" name="::Media::Media::startRecord"></a><code><b><span class="methodName">startRecord</span></b></code>
+</dt>
+<dd>
+<div class="brief">
+ Starts recording an audio file.
+ </div>
+<div class="synopsis"><pre class="signature prettyprint">void startRecord();
+ </pre></div>
+<p><span class="version">
+ Since: </span>
+ 3.0
+ </p>
+<p><span class="privilegelevel">
+ Privilege level: </span>
+ public
+ </p>
+<p><span class="privilege">
+ Privilege: </span>
+ http://tizen.org/privilege/mediacapture
+ </p>
+<div class="example">
+<span class="example"><p>Code example:</p></span><pre name="code" class="examplecode prettyprint"> successCallback = function() {
+ console.log('Started recording an audio file.');
+ }
+
+ errorCallback = function(err) {
+ console.log('Error occurred ' + err.message);
+ }
+
+ var src = 'recordAudio.mp3';
+ var myRecMedia = new Media(src, successCallback, errorCallback);
+
+ myRecMedia.startRecord();
+ </pre>
+</div>
+<div class="output">
+<span class="title"><p>Output example:</p></span><pre>Started recording an audio file.
+</pre>
+</div>
+</dd>
+<dt class="method" id="Media::stopRecord">
+<a class="backward-compatibility-anchor" name="::Media::Media::stopRecord"></a><code><b><span class="methodName">stopRecord</span></b></code>
+</dt>
+<dd>
+<div class="brief">
+ Stops recording an audio file.
+ </div>
+<div class="synopsis"><pre class="signature prettyprint">void stopRecord();
+ </pre></div>
+<p><span class="version">
+ Since: </span>
+ 3.0
+ </p>
+<p><span class="privilegelevel">
+ Privilege level: </span>
+ public
+ </p>
+<p><span class="privilege">
+ Privilege: </span>
+ http://tizen.org/privilege/mediacapture
+ </p>
+<div class="example">
+<span class="example"><p>Code example:</p></span><pre name="code" class="examplecode prettyprint"> successCallback = function() {
+ console.log('Started recording an audio file.');
+ }
+
+ errorCallback = function(err) {
+ console.log('Error occurred ' + err.message);
+ }
+
+ var src = 'recordAudio.mp3';
+ var myRecMedia = new Media(src, successCallback, errorCallback);
+
+ myRecMedia.startRecord();
+
+ // Stop recording after 10 seconds
+ setTimeout(function() {
+ myRecMedia.stopRecord();
+ console.log('Stopped recording an audio file.');
+ }, 10000);
+ </pre>
+</div>
+<div class="output">
+<span class="title"><p>Output example:</p></span><pre>Started recording an audio file.
+Stopped recording an audio file.
+</pre>
+</div>
+</dd>
+<dt class="method" id="Media::stop">
+<a class="backward-compatibility-anchor" name="::Media::Media::stop"></a><code><b><span class="methodName">stop</span></b></code>
+</dt>
+<dd>
+<div class="brief">
+ Stops playing an audio file.
+ </div>
+<div class="synopsis"><pre class="signature prettyprint">void stop();
+ </pre></div>
+<p><span class="version">
+ Since: </span>
+ 3.0
+ </p>
+<div class="example">
+<span class="example"><p>Code example:</p></span><pre name="code" class="examplecode prettyprint"> successCallback = function() {
+ console.log('Audio file has been stopped.');
+ }
+
+ errorCallback = function(err) {
+ console.log('Error occurred ' + err.message);
+ }
+
+ var src = 'file://home/app/content/Documents/play.mp3';
+ var myMedia = new Media(src, successCallback, errorCallback);
+
+ myMedia.play();
+
+ // Stop after 10 seconds
+ setTimeout(function() {
+ myMedia.stop();
+ }, 10000);
+ </pre>
+</div>
+<div class="output">
+<span class="title"><p>Output example:</p></span><pre>Audio playback has been stopped.
+</pre>
+</div>
+</dd>
+</dl>
+</div>
+</div>
+<div class="interface" id="MediaError">
+<a class="backward-compatibility-anchor" name="::Media::MediaError"></a><h3>1.2. MediaError</h3>
+<div class="brief">
+ A <em>MediaError</em> object is returned to the <a href="media.html#MediaErrorCallback">MediaErrorCallback</a> function when an error occurs.
+ </div>
+<pre class="webidl prettyprint"> interface MediaError {
+ const short MEDIA_ERR_ABORTED = 1;
+ const short MEDIA_ERR_NETWORK = 2;
+ const short MEDIA_ERR_DECODE = 3;
+ const short MEDIA_ERR_NONE_SUPPORTED = 4;
+
+ readonly attribute short code;
+ };</pre>
+<div class="attributes">
+<h4>Attributes</h4>
+<ul><li class="attribute" id="MediaError::code">
+<span class="attrName"><span class="readonly"> readonly
+</span><span class="type">short </span><span class="name">code</span></span><div class="brief">
+ One of the predefined error codes listed above.
+ </div>
+<p><span class="version">
+ Since: </span>
+ 3.0
+ </p>
+</li></ul>
+</div>
+</div>
+<div class="interface" id="MediaErrorCallback">
+<a class="backward-compatibility-anchor" name="::Media::MediaErrorCallback"></a><h3>1.3. MediaErrorCallback</h3>
+<div class="brief">
+ Basic error callback.
+ </div>
+<pre class="webidl prettyprint"> [Callback=FunctionOnly,NoInterfaceObject] interface MediaErrorCallback {
+ void onerror(<a href="#MediaError">MediaError</a> error);
+ };</pre>
+<div class="methods">
+<h4>Methods</h4>
+<dl>
+<dt class="method" id="MediaErrorCallback::onerror">
+<a class="backward-compatibility-anchor" name="::Media::MediaErrorCallback::onerror"></a><code><b><span class="methodName">onerror</span></b></code>
+</dt>
+<dd>
+<div class="brief">
+ Success
+ </div>
+<div class="synopsis"><pre class="signature prettyprint">void onerror(<a href="#MediaError">MediaError</a> error);
+ </pre></div>
+<p><span class="version">
+ Since: </span>
+ 3.0
+ </p>
+<div class="parameters">
+<p><span class="param">Parameters:</span></p>
+<ul>
+ <li class="param">
+<span class="name">error</span>:
+ Error object containing some information about the error.
+ </li>
+ </ul>
+</div>
+</dd>
+</dl>
+</div>
+</div>
+<div class="interface" id="StatusChangeCallback">
+<a class="backward-compatibility-anchor" name="::Media::StatusChangeCallback"></a><h3>1.4. StatusChangeCallback</h3>
+<div class="brief">
+ The callback function used to return status of the Media object.
+ </div>
+<pre class="webidl prettyprint"> [Callback=FunctionOnly, NoInterfaceObject] interface StatusChangeCallback {
+ void onchanged(short status);
+ };</pre>
+<div class="methods">
+<h4>Methods</h4>
+<dl>
+<dt class="method" id="StatusChangeCallback::onchanged">
+<a class="backward-compatibility-anchor" name="::Media::StatusChangeCallback::onchanged"></a><code><b><span class="methodName">onchanged</span></b></code>
+</dt>
+<dd>
+<div class="brief">
+ Called when the status of the <em>Media</em> object has been changed.
+ </div>
+<div class="synopsis"><pre class="signature prettyprint">void onchanged(short status);
+ </pre></div>
+<p><span class="version">
+ Since: </span>
+ 3.0
+ </p>
+<div class="parameters">
+<p><span class="param">Parameters:</span></p>
+<ul>
+ <li class="param">
+<span class="name">status</span>:
+ The status of the <a href="media.html#Media">Media</a> object. It is equal to one of the Media interface constant: MEDIA_NONE, MEDIA_STARTING, MEDIA_RUNNING, MEDIA_PAUSED or MEDIA_STOPPED.
+ </li>
+ </ul>
+</div>
+</dd>
+</dl>
+</div>
+</div>
+<div class="interface" id="PositionSuccessCallback">
+<a class="backward-compatibility-anchor" name="::Media::PositionSuccessCallback"></a><h3>1.5. PositionSuccessCallback</h3>
+<div class="brief">
+ The callback function used to return current position of the Media object.
+ </div>
+<pre class="webidl prettyprint"> [Callback=FunctionOnly, NoInterfaceObject] interface PositionSuccessCallback {
+ void onsuccess(double position);
+ };</pre>
+<div class="methods">
+<h4>Methods</h4>
+<dl>
+<dt class="method" id="PositionSuccessCallback::onsuccess">
+<a class="backward-compatibility-anchor" name="::Media::PositionSuccessCallback::onsuccess"></a><code><b><span class="methodName">onsuccess</span></b></code>
+</dt>
+<dd>
+<div class="brief">
+ Called when getting current position of the media file is retrieved successfully.
+ </div>
+<div class="synopsis"><pre class="signature prettyprint">void onsuccess(double position);
+ </pre></div>
+<p><span class="version">
+ Since: </span>
+ 3.0
+ </p>
+<div class="parameters">
+<p><span class="param">Parameters:</span></p>
+<ul>
+ <li class="param">
+<span class="name">position</span>:
+ The current position of the media file.
+ </li>
+ </ul>
+</div>
+</dd>
+</dl>
+</div>
+</div>
+</div>
+<h2 id="api-features">2. Related Feature</h2>
+<div id="def-api-features" class="def-api-features">
+ You can check if this API is supported with <em>tizen.systeminfo.getCapability()</em> and decide enable/disable codes that need this API.
+ <div class="def-api-feature">
+<p><div class="description">
+ <p>
+If an application uses startRecord() or stopRecord(), declare the following feature requirements in the config file:
+ </p>
+ </div></p>
+<li class="feature">http://tizen.org/feature/microphone</li>
+</div>
+<div class="def-api-feature">
+<p></p>
+<li class="feature">http://tizen.org/feature/camera</li>
+</div>
+<div class="def-api-feature">
+<p></p>
+<li class="feature">http://tizen.org/feature/media.audio_recording</li>
+</div>
+<p></p>
+ For more information, see <a href="../../org.tizen.gettingstarted/html/tizen_overview/application_filtering.htm">Application Filtering.</a>
+</div>
+<h2 id="full-webidl">3. Full WebIDL</h2>
+<pre class="webidl prettyprint">module Media {
+ [Constructor(DOMString src, optional <a href="cordova.html#SuccessCallback">SuccessCallback</a>? successCallback, optional <a href="#MediaErrorCallback">MediaErrorCallback</a>? errorCallback, optional <a href="#StatusChangeCallback">StatusChangeCallback</a>? mediaStatus)]
+ interface Media {
+ const short MEDIA_NONE = 0;
+ const short MEDIA_STARTING = 1;
+ const short MEDIA_RUNNING = 2;
+ const short MEDIA_PAUSED = 3;
+ const short MEDIA_STOPPED = 4;
+
+ attribute DOMString src;
+
+ attribute <a href="cordova.html#SuccessCallback">SuccessCallback</a>? successCallback;
+
+ attribute <a href="#MediaErrorCallback">MediaErrorCallback</a>? errorCallback;
+
+ attribute <a href="#StatusChangeCallback">StatusChangeCallback</a>? statusCallback;
+
+ void getCurrentPosition(<a href="#PositionSuccessCallback">PositionSuccessCallback</a> positionSuccessCallback, optional <a href="#MediaErrorCallback">MediaErrorCallback</a> errorCallback);
+
+ double getDuration();
+
+ void pause();
+
+ void play();
+
+ void release();
+
+ void seekTo(double position);
+
+ void setVolume(double volume);
+
+ void startRecord();
+
+ void stopRecord();
+
+ void stop();
+ };
+
+ interface MediaError {
+ const short MEDIA_ERR_ABORTED = 1;
+ const short MEDIA_ERR_NETWORK = 2;
+ const short MEDIA_ERR_DECODE = 3;
+ const short MEDIA_ERR_NONE_SUPPORTED = 4;
+
+ readonly attribute short code;
+ };
+
+ [Callback=FunctionOnly,NoInterfaceObject] interface MediaErrorCallback {
+ void onerror(<a href="#MediaError">MediaError</a> error);
+ };
+
+ [Callback=FunctionOnly, NoInterfaceObject] interface StatusChangeCallback {
+ void onchanged(short status);
+ };
+
+ [Callback=FunctionOnly, NoInterfaceObject] interface PositionSuccessCallback {
+ void onsuccess(double position);
+ };
+};</pre>
+</div>
+<div id="page-footer">
+<div class="copyright" align="center">
+ Except as noted, this content - excluding the Code Examples - is licensed under <a href="http://creativecommons.org/licenses/by/3.0/legalcode" target="_blank">Creative Commons Attribution 3.0</a> and all of the Code Examples contained herein are licensed under <a href="https://www.tizen.org/bsd-3-clause-license" target="_blank">BSD-3-Clause</a>. <br>For details, see the <a href="https://www.tizen.org/content-license" target="_blank">Content License</a>.
+ </div>
+<script type="text/javascript">
+
+ var _gaq = _gaq || [];
+ _gaq.push(['_setAccount', 'UA-25976949-1']);
+ _gaq.push(['_setDomainName', 'tizen.org']);
+ _gaq.push(['_trackPageview']);
+
+ (function() {
+ var ga = document.createElement('script'); ga.type = 'text/javascript'; ga.async = true;
+ var s = document.getElementsByTagName('script')[0]; s.parentNode.insertBefore(ga, s);
+ })();
+
+ </script>
+</div>
+</body>
+</html>
--- /dev/null
+<!DOCTYPE html PUBLIC "html">
+<html>
+<head>
+<meta http-equiv="Content-Type" content="text/html; charset=utf-8">
+<link rel="stylesheet" type="text/css" href="../tizen.css" media="screen">
+<script type="text/javascript" src="snippet.js"></script><title>NetworkInformation API</title>
+</head>
+<body id="page-content" onload="prettyPrint()">
+<div class="api" id="::NetworkInformation">
+<div class="supported-platforms"><img class="wearable-mandatory emulator" title="Mandatory, Supported by Tizen Wearable emulator" src="../wearable_s_w.png"></div>
+<div class="title"><h1>NetworkInformation API</h1></div>
+<div class="brief">
+ This plugin provides information about the device's cellular and wifi connection, and whether the device has an internet connection.
+ </div>
+<div class="description">
+ <p>
+Original documentation: <a href="https://www.npmjs.com/package/cordova-plugin-network-information">Cordova Network Information</a>.
+ </p>
+ </div>
+<h2>Table of Contents</h2>
+<ul class="toc">
+<li>1. <a href="#interfaces-section">Interfaces</a><ul class="toc">
+<li>1.1. <a href="#NetworkInformationManagerObject">NetworkInformationManagerObject</a>
+</li>
+<li>1.2. <a href="#NetworkInformationManager">NetworkInformationManager</a>
+</li>
+<li>1.3. <a href="#Connection">Connection</a>
+</li>
+<li>1.4. <a href="#OnlineEventCallback">OnlineEventCallback</a>
+</li>
+<li>1.5. <a href="#OfflineEventCallback">OfflineEventCallback</a>
+</li>
+</ul>
+</li>
+<li>2. <a href="#api-features">Related Feature</a>
+</li>
+<li>3. <a href="#full-webidl">Full WebIDL</a>
+</li>
+</ul>
+<hr>
+<h2 id="method-summary">Summary of Interfaces and Methods</h2>
+<table class="informaltable">
+<thead><tr>
+<th>Interface</th>
+<th>Method</th>
+</tr></thead>
+<tbody>
+<tr>
+<td><a href="#NetworkInformationManagerObject">NetworkInformationManagerObject</a></td>
+<td></td>
+</tr>
+<tr>
+<td><a href="#NetworkInformationManager">NetworkInformationManager</a></td>
+<td></td>
+</tr>
+<tr>
+<td><a href="#Connection">Connection</a></td>
+<td></td>
+</tr>
+<tr>
+<td><a href="#OnlineEventCallback">OnlineEventCallback</a></td>
+<td><div>void <a href="#OnlineEventCallback::online">online</a> ()</div></td>
+</tr>
+<tr>
+<td><a href="#OfflineEventCallback">OfflineEventCallback</a></td>
+<td><div>void <a href="#OfflineEventCallback::offline">offline</a> ()</div></td>
+</tr>
+</tbody>
+</table>
+<div class="interfaces" id="interfaces-section">
+<h2>1. Interfaces</h2>
+<div class="interface" id="NetworkInformationManagerObject">
+<a class="backward-compatibility-anchor" name="::NetworkInformation::NetworkInformationManagerObject"></a><h3>1.1. NetworkInformationManagerObject</h3>
+<div class="brief">
+ The <em>NetworkInformationManagerObject</em> interface defines what is instantiated in the <em>Navigator</em> object.
+ </div>
+<pre class="webidl prettyprint"> [NoInterfaceObject] interface NetworkInformationManagerObject {
+ readonly attribute <a href="#NetworkInformationManager">NetworkInformationManager</a> connection;
+ };</pre>
+<pre class="webidl prettyprint"> implements <a href="#NetworkInformationManagerObject">NetworkInformationManagerObject</a>;</pre>
+<div class="description">
+ <p>
+The <em>navigator.connection</em> object allows access to the NetworkInformation API.
+ </p>
+ </div>
+</div>
+<div class="interface" id="NetworkInformationManager">
+<a class="backward-compatibility-anchor" name="::NetworkInformation::NetworkInformationManager"></a><h3>1.2. NetworkInformationManager</h3>
+<div class="brief">
+ The <em>NetworkInformationManager</em> interface provides methods for global operations related to notifications to the user.
+ </div>
+<pre class="webidl prettyprint"> [NoInterfaceObject] interface NetworkInformationManager {
+ readonly attribute DOMString type;
+ };</pre>
+<div class="attributes">
+<h4>Attributes</h4>
+<ul><li class="attribute" id="NetworkInformationManager::type">
+<span class="attrName"><span class="readonly"> readonly
+</span><span class="type">DOMString </span><span class="name">type</span></span><div class="brief">
+ Returns the current connection type. The value returned is one of the following strings, case-sensitively: unknown, ethernet, wifi, 2g, 3g, 4g, none.
+ </div>
+<p><span class="version">
+ Since: </span>
+ 3.0
+ </p>
+<p><span class="privilegelevel">
+ Privilege level: </span>
+ public
+ </p>
+<p><span class="privilege">
+ Privilege: </span>
+ http://tizen.org/privilege/telephony
+ </p>
+<div class="example">
+<span class="example"><p>Code example:</p></span><pre name="code" class="examplecode prettyprint"> function checkConnection() {
+ var networkState = navigator.connection.type;
+
+ var states = {};
+ states[Connection.UNKNOWN] = 'Unknown connection';
+ states[Connection.ETHERNET] = 'Ethernet connection';
+ states[Connection.WIFI] = 'WiFi connection';
+ states[Connection.CELL_2G] = 'Cell 2G connection';
+ states[Connection.CELL_3G] = 'Cell 3G connection';
+ states[Connection.CELL_4G] = 'Cell 4G connection';
+ states[Connection.CELL] = 'Cell generic connection';
+ states[Connection.NONE] = 'No network connection';
+ alert('Connection type: ' + states[networkState]);
+ }
+
+ checkConnection();
+ </pre>
+</div>
+<div class="output">
+<span class="title"><p>Output example:</p></span><pre>Connection type: Cell 3G connection
+</pre>
+</div>
+</li></ul>
+</div>
+</div>
+<div class="interface" id="Connection">
+<a class="backward-compatibility-anchor" name="::NetworkInformation::Connection"></a><h3>1.3. Connection</h3>
+<div class="brief">
+ The <em>Connection</em> is available as window attribute.
+ </div>
+<pre class="webidl prettyprint"> interface Connection {
+ readonly attribute DOMString UNKNOWN;
+ readonly attribute DOMString ETHERNET;
+ readonly attribute DOMString WIFI;
+ readonly attribute DOMString CELL_2G;
+ readonly attribute DOMString CELL_3G;
+ readonly attribute DOMString CELL_4G;
+ readonly attribute DOMString CELL;
+ readonly attribute DOMString NONE;
+ };</pre>
+<div class="attributes">
+<h4>Attributes</h4>
+<ul>
+<li class="attribute" id="Connection::UNKNOWN">
+<span class="attrName"><span class="readonly"> readonly
+</span><span class="type">DOMString </span><span class="name">UNKNOWN</span></span><div class="brief">
+ The value returned is 'unknown'.
+ </div>
+<p><span class="version">
+ Since: </span>
+ 3.0
+ </p>
+<div class="example">
+<span class="example"><p>Code example:</p></span><pre name="code" class="examplecode prettyprint"> console.log(Connection.UNKNOWN);
+ </pre>
+</div>
+<div class="output">
+<span class="title"><p>Output example:</p></span><pre>unknown
+</pre>
+</div>
+</li>
+<li class="attribute" id="Connection::ETHERNET">
+<span class="attrName"><span class="readonly"> readonly
+</span><span class="type">DOMString </span><span class="name">ETHERNET</span></span><div class="brief">
+ The value returned is 'ethernet'.
+ </div>
+<p><span class="version">
+ Since: </span>
+ 3.0
+ </p>
+<div class="example">
+<span class="example"><p>Code example:</p></span><pre name="code" class="examplecode prettyprint"> console.log(Connection.ETHERNET);
+ </pre>
+</div>
+<div class="output">
+<span class="title"><p>Output example:</p></span><pre>ethernet
+</pre>
+</div>
+</li>
+<li class="attribute" id="Connection::WIFI">
+<span class="attrName"><span class="readonly"> readonly
+</span><span class="type">DOMString </span><span class="name">WIFI</span></span><div class="brief">
+ The value returned is 'wifi'.
+ </div>
+<p><span class="version">
+ Since: </span>
+ 3.0
+ </p>
+<div class="example">
+<span class="example"><p>Code example:</p></span><pre name="code" class="examplecode prettyprint"> console.log(Connection.WIFI);
+ </pre>
+</div>
+<div class="output">
+<span class="title"><p>Output example:</p></span><pre>wifi
+</pre>
+</div>
+</li>
+<li class="attribute" id="Connection::CELL_2G">
+<span class="attrName"><span class="readonly"> readonly
+</span><span class="type">DOMString </span><span class="name">CELL_2G</span></span><div class="brief">
+ The value returned is '2g'.
+ </div>
+<p><span class="version">
+ Since: </span>
+ 3.0
+ </p>
+<div class="example">
+<span class="example"><p>Code example:</p></span><pre name="code" class="examplecode prettyprint"> console.log(Connection.CELL_2G);
+ </pre>
+</div>
+<div class="output">
+<span class="title"><p>Output example:</p></span><pre>2g
+</pre>
+</div>
+</li>
+<li class="attribute" id="Connection::CELL_3G">
+<span class="attrName"><span class="readonly"> readonly
+</span><span class="type">DOMString </span><span class="name">CELL_3G</span></span><div class="brief">
+ The value returned is '3g'.
+ </div>
+<p><span class="version">
+ Since: </span>
+ 3.0
+ </p>
+<div class="example">
+<span class="example"><p>Code example:</p></span><pre name="code" class="examplecode prettyprint"> console.log(Connection.CELL_3G);
+ </pre>
+</div>
+<div class="output">
+<span class="title"><p>Output example:</p></span><pre>3g
+</pre>
+</div>
+</li>
+<li class="attribute" id="Connection::CELL_4G">
+<span class="attrName"><span class="readonly"> readonly
+</span><span class="type">DOMString </span><span class="name">CELL_4G</span></span><div class="brief">
+ The value returned is '4g'.
+ </div>
+<p><span class="version">
+ Since: </span>
+ 3.0
+ </p>
+<div class="example">
+<span class="example"><p>Code example:</p></span><pre name="code" class="examplecode prettyprint"> console.log(Connection.CELL_4G);
+ </pre>
+</div>
+<div class="output">
+<span class="title"><p>Output example:</p></span><pre>4g
+</pre>
+</div>
+</li>
+<li class="attribute" id="Connection::CELL">
+<span class="attrName"><span class="readonly"> readonly
+</span><span class="type">DOMString </span><span class="name">CELL</span></span><div class="brief">
+ The value returned is 'cellular'.
+ </div>
+<p><span class="version">
+ Since: </span>
+ 3.0
+ </p>
+<div class="example">
+<span class="example"><p>Code example:</p></span><pre name="code" class="examplecode prettyprint"> console.log(Connection.CELL);
+ </pre>
+</div>
+<div class="output">
+<span class="title"><p>Output example:</p></span><pre>cellular
+</pre>
+</div>
+</li>
+<li class="attribute" id="Connection::NONE">
+<span class="attrName"><span class="readonly"> readonly
+</span><span class="type">DOMString </span><span class="name">NONE</span></span><div class="brief">
+ The value returned is 'none'.
+ </div>
+<p><span class="version">
+ Since: </span>
+ 3.0
+ </p>
+<div class="example">
+<span class="example"><p>Code example:</p></span><pre name="code" class="examplecode prettyprint"> console.log(Connection.NONE);
+ </pre>
+</div>
+<div class="output">
+<span class="title"><p>Output example:</p></span><pre>none
+</pre>
+</div>
+</li>
+</ul>
+</div>
+</div>
+<div class="interface" id="OnlineEventCallback">
+<a class="backward-compatibility-anchor" name="::NetworkInformation::OnlineEventCallback"></a><h3>1.4. OnlineEventCallback</h3>
+<div class="brief">
+ Callback for the event when an application goes online, and the device becomes connected to the Internet.
+ </div>
+<pre class="webidl prettyprint"> [NoInterfaceObject, Callback=FunctionOnly]
+ interface OnlineEventCallback {
+ void online();
+ };</pre>
+<p><span class="version">
+ Since: </span>
+ 3.0
+ </p>
+<div class="description">
+ <p>
+The <var>online</var> event fires when an application goes online, and the device becomes connected to the Internet.
+ </p>
+ <p>
+Applications typically should use document.addEventListener() to attach an event listener once the <a href="events.html#DeviceReadyEventCallback">deviceready</a> event fires.
+ </p>
+ <p>
+Original documentation: <a href="https://www.npmjs.com/package/cordova-plugin-network-information#online">Cordova online event</a> </p>
+ </div>
+<div class="example">
+<span class="example"><p>Code example:</p></span><pre name="code" class="examplecode prettyprint"> document.addEventListener('deviceready', onDeviceReady, false);
+
+ function onDeviceReady() {
+ document.addEventListener('online', onOnline, false);
+ }
+
+ function onOnline() {
+ // Handle the online event
+ }
+ </pre>
+</div>
+</div>
+<div class="interface" id="OfflineEventCallback">
+<a class="backward-compatibility-anchor" name="::NetworkInformation::OfflineEventCallback"></a><h3>1.5. OfflineEventCallback</h3>
+<div class="brief">
+ Callback for the event when an application goes offline, and the device is not connected to the Internet.
+ </div>
+<pre class="webidl prettyprint"> [NoInterfaceObject, Callback=FunctionOnly]
+ interface OfflineEventCallback {
+ void offline();
+ };</pre>
+<p><span class="version">
+ Since: </span>
+ 3.0
+ </p>
+<div class="description">
+ <p>
+The <var>online</var> event fires when an application goes online, and the device becomes connected to the Internet.
+ </p>
+ <p>
+Applications typically should use document.addEventListener() to attach an event listener once the <a href="events.html#DeviceReadyEventCallback">deviceready</a> event fires.
+ </p>
+ <p>
+Original documentation: <a href="https://www.npmjs.com/package/cordova-plugin-network-information#offline">Cordova offline event</a> </p>
+ </div>
+<div class="example">
+<span class="example"><p>Code example:</p></span><pre name="code" class="examplecode prettyprint"> document.addEventListener('deviceready', onDeviceReady, false);
+
+ function onDeviceReady() {
+ document.addEventListener('offline', onOffline, false);
+ }
+
+ function onOffline() {
+ // Handle the offline event
+ }
+ </pre>
+</div>
+</div>
+</div>
+<h2 id="api-features">2. Related Feature</h2>
+<div id="def-api-features" class="def-api-features">
+ You can check if this API is supported with <em>tizen.systeminfo.getCapability()</em> and decide enable/disable codes that need this API.
+ <div class="def-api-feature">
+<p><div class="description">
+ <p>
+To guarantee that the NetworkInformation application runs on a device with the NetworkInformation feature declare the following feature requirements in the config file:
+ </p>
+ </div></p>
+<li class="feature">http://tizen.org/feature/network.telephony</li>
+</div>
+<p></p>
+ For more information, see <a href="../../org.tizen.gettingstarted/html/tizen_overview/application_filtering.htm">Application Filtering.</a>
+</div>
+<h2 id="full-webidl">3. Full WebIDL</h2>
+<pre class="webidl prettyprint">module NetworkInformation {
+ [NoInterfaceObject] interface NetworkInformationManagerObject {
+ readonly attribute <a href="#NetworkInformationManager">NetworkInformationManager</a> connection;
+ };
+ implements <a href="#NetworkInformationManagerObject">NetworkInformationManagerObject</a>;
+ [NoInterfaceObject] interface NetworkInformationManager {
+ readonly attribute DOMString type;
+ };
+ interface Connection {
+ readonly attribute DOMString UNKNOWN;
+ readonly attribute DOMString ETHERNET;
+ readonly attribute DOMString WIFI;
+ readonly attribute DOMString CELL_2G;
+ readonly attribute DOMString CELL_3G;
+ readonly attribute DOMString CELL_4G;
+ readonly attribute DOMString CELL;
+ readonly attribute DOMString NONE;
+ };
+
+ [NoInterfaceObject, Callback=FunctionOnly]
+ interface OnlineEventCallback {
+ void online();
+ };
+ [NoInterfaceObject, Callback=FunctionOnly]
+ interface OfflineEventCallback {
+ void offline();
+ };
+};</pre>
+</div>
+<div id="page-footer">
+<div class="copyright" align="center">
+ Except as noted, this content - excluding the Code Examples - is licensed under <a href="http://creativecommons.org/licenses/by/3.0/legalcode" target="_blank">Creative Commons Attribution 3.0</a> and all of the Code Examples contained herein are licensed under <a href="https://www.tizen.org/bsd-3-clause-license" target="_blank">BSD-3-Clause</a>. <br>For details, see the <a href="https://www.tizen.org/content-license" target="_blank">Content License</a>.
+ </div>
+<script type="text/javascript">
+
+ var _gaq = _gaq || [];
+ _gaq.push(['_setAccount', 'UA-25976949-1']);
+ _gaq.push(['_setDomainName', 'tizen.org']);
+ _gaq.push(['_trackPageview']);
+
+ (function() {
+ var ga = document.createElement('script'); ga.type = 'text/javascript'; ga.async = true;
+ var s = document.getElementsByTagName('script')[0]; s.parentNode.insertBefore(ga, s);
+ })();
+
+ </script>
+</div>
+</body>
+</html>
<li><a href="device_api/mobile/tizen/websetting.html">Web Setting</a></li>
</ul>
</li>
+ <li><a href="device_api/mobile/index.html#Cordova">Cordova</a>
+ <ul>
+ <li><a href="device_api/mobile/tizen/cordova/console.html">Console</a></li>
+ <li><a href="device_api/mobile/tizen/cordova/cordova.html">Cordova</a></li>
+ <li><a href="device_api/mobile/tizen/cordova/device.html">Device</a></li>
+ <li><a href="device_api/mobile/tizen/cordova/device-motion.html">Device Motion</a></li>
+ <li><a href="device_api/mobile/tizen/cordova/dialogs.html">Dialogs</a></li>
+ <li><a href="device_api/mobile/tizen/cordova/events.html">Events</a></li>
+ <li><a href="device_api/mobile/tizen/cordova/file.html">File</a></li>
+ <li><a href="device_api/mobile/tizen/cordova/filetransfer.html">File Transfer</a></li>
+ <li><a href="device_api/mobile/tizen/cordova/globalization.html">Globalization</a></li>
+ <li><a href="device_api/mobile/tizen/cordova/media.html">Media</a></li>
+ <li><a href="device_api/mobile/tizen/cordova/networkInformation.html">Network Information</a></li>
+ </ul>
+ </li>
</ul>
</li>
<li><a href="device_api/wearable/index.html">Wearable Web</a>
<li><a href="device_api/wearable/tizen/time.html">Time</a></li>
</ul>
</li>
+ <li><a href="device_api/wearable/index.html#Cordova">Cordova</a>
+ <ul>
+ <li><a href="device_api/wearable/tizen/cordova/console.html">Console</a></li>
+ <li><a href="device_api/wearable/tizen/cordova/cordova.html">Cordova</a></li>
+ <li><a href="device_api/wearable/tizen/cordova/device.html">Device</a></li>
+ <li><a href="device_api/wearable/tizen/cordova/device-motion.html">Device Motion</a></li>
+ <li><a href="device_api/wearable/tizen/cordova/dialogs.html">Dialogs</a></li>
+ <li><a href="device_api/wearable/tizen/cordova/events.html">Events</a></li>
+ <li><a href="device_api/wearable/tizen/cordova/file.html">File</a></li>
+ <li><a href="device_api/wearable/tizen/cordova/filetransfer.html">File Transfer</a></li>
+ <li><a href="device_api/wearable/tizen/cordova/globalization.html">Globalization</a></li>
+ <li><a href="device_api/wearable/tizen/cordova/media.html">Media</a></li>
+ <li><a href="device_api/wearable/tizen/cordova/networkInformation.html">Network Information</a></li>
+ </ul>
+ </li>
</ul>
</li>
<li><a href="device_api/tv/index.html">TV Web</a>
<li><a href="device_api/tv/tizen/tvinfo.html">TV Information</a></li>
</ul>
</li>
+ <li><a href="device_api/tv/index.html#Cordova">Cordova</a>
+ <ul>
+ <li><a href="device_api/tv/tizen/cordova/console.html">Console</a></li>
+ <li><a href="device_api/tv/tizen/cordova/cordova.html">Cordova</a></li>
+ <li><a href="device_api/tv/tizen/cordova/device.html">Device</a></li>
+ <li><a href="device_api/tv/tizen/cordova/device-motion.html">Device Motion</a></li>
+ <li><a href="device_api/tv/tizen/cordova/dialogs.html">Dialogs</a></li>
+ <li><a href="device_api/tv/tizen/cordova/events.html">Events</a></li>
+ <li><a href="device_api/tv/tizen/cordova/file.html">File</a></li>
+ <li><a href="device_api/tv/tizen/cordova/filetransfer.html">File Transfer</a></li>
+ <li><a href="device_api/tv/tizen/cordova/globalization.html">Globalization</a></li>
+ <li><a href="device_api/tv/tizen/cordova/media.html">Media</a></li>
+ <li><a href="device_api/tv/tizen/cordova/networkInformation.html">Network Information</a></li>
+ </ul>
+ </li>
</ul>
</li>
</ul>
<topic href="html/device_api/mobile/tizen/time.html" label="Time" ></topic>
<topic href="html/device_api/mobile/tizen/websetting.html" label="Web Setting" ></topic>
</topic>
+
+ <topic href="html/device_api/mobile/index.html#Cordova" label="Cordova">
+ <topic href="html/device_api/mobile/tizen/cordova/console.html" label="Console" ></topic>
+ <topic href="html/device_api/mobile/tizen/cordova/cordova.html" label="Cordova" ></topic>
+ <topic href="html/device_api/mobile/tizen/cordova/device.html" label="Device" ></topic>
+ <topic href="html/device_api/mobile/tizen/cordova/device-motion.html" label="Device Motion" ></topic>
+ <topic href="html/device_api/mobile/tizen/cordova/dialogs.html" label="Dialogs" ></topic>
+ <topic href="html/device_api/mobile/tizen/cordova/events.html" label="Events" ></topic>
+ <topic href="html/device_api/mobile/tizen/cordova/file.html" label="File" ></topic>
+ <topic href="html/device_api/mobile/tizen/cordova/filetransfer.html" label="File Transfer" ></topic>
+ <topic href="html/device_api/mobile/tizen/cordova/globalization.html" label="Globalization" ></topic>
+ <topic href="html/device_api/mobile/tizen/cordova/media.html" label="Media" ></topic>
+ <topic href="html/device_api/mobile/tizen/cordova/networkInformation.html" label="Network Information" ></topic>
+ </topic>
</topic>
<topic label="Wearable Web" href="html/device_api/wearable/index.html">
<topic href="html/device_api/wearable/tizen/time.html" label="Time" ></topic>
</topic>
-
+ <topic href="html/device_api/wearable/index.html#Cordova" label="Cordova">
+ <topic href="html/device_api/wearable/tizen/cordova/console.html" label="Console" ></topic>
+ <topic href="html/device_api/wearable/tizen/cordova/cordova.html" label="Cordova" ></topic>
+ <topic href="html/device_api/wearable/tizen/cordova/device.html" label="Device" ></topic>
+ <topic href="html/device_api/wearable/tizen/cordova/device-motion.html" label="Device Motion" ></topic>
+ <topic href="html/device_api/wearable/tizen/cordova/dialogs.html" label="Dialogs" ></topic>
+ <topic href="html/device_api/wearable/tizen/cordova/events.html" label="Events" ></topic>
+ <topic href="html/device_api/wearable/tizen/cordova/file.html" label="File" ></topic>
+ <topic href="html/device_api/wearable/tizen/cordova/filetransfer.html" label="File Transfer" ></topic>
+ <topic href="html/device_api/wearable/tizen/cordova/globalization.html" label="Globalization" ></topic>
+ <topic href="html/device_api/wearable/tizen/cordova/media.html" label="Media" ></topic>
+ <topic href="html/device_api/wearable/tizen/cordova/networkInformation.html" label="Network Information" ></topic>
+ </topic>
</topic>
+
<topic label="TV Web" href="html/device_api/tv/index.html">
<topic href="html/device_api/tv/index.html#Base" label="Base">
<topic href="html/device_api/tv/tizen/archive.html" label="Archive"></topic>
<topic href="html/device_api/tv/tizen/tvwindow.html" label="TV Window" ></topic>
<topic href="html/device_api/tv/tizen/tvinfo.html" label="TV Information" ></topic>
</topic>
+ <topic href="html/device_api/tv/index.html#Cordova" label="Cordova">
+ <topic href="html/device_api/tv/tizen/cordova/console.html" label="Console" ></topic>
+ <topic href="html/device_api/tv/tizen/cordova/cordova.html" label="Cordova" ></topic>
+ <topic href="html/device_api/tv/tizen/cordova/device.html" label="Device" ></topic>
+ <topic href="html/device_api/tv/tizen/cordova/device-motion.html" label="Device Motion" ></topic>
+ <topic href="html/device_api/tv/tizen/cordova/dialogs.html" label="Dialogs" ></topic>
+ <topic href="html/device_api/tv/tizen/cordova/events.html" label="Events" ></topic>
+ <topic href="html/device_api/tv/tizen/cordova/file.html" label="File" ></topic>
+ <topic href="html/device_api/tv/tizen/cordova/filetransfer.html" label="File Transfer" ></topic>
+ <topic href="html/device_api/tv/tizen/cordova/globalization.html" label="Globalization" ></topic>
+ <topic href="html/device_api/tv/tizen/cordova/media.html" label="Media" ></topic>
+ <topic href="html/device_api/tv/tizen/cordova/networkInformation.html" label="Network Information" ></topic>
+ </topic>
</topic>
</topic>
<topic label="Tizen Advanced UI framework (TAU)" href="html/ui_fw_api/ui_fw_api_cover.htm">
projects / sdk / online-doc.git / commitdiff