Modified: cordova/site/public/docs/en/dev/cordova-plugin-file/index.html URL: http://svn.apache.org/viewvc/cordova/site/public/docs/en/dev/cordova-plugin-file/index.html?rev=1736375&r1=1736374&r2=1736375&view=diff ============================================================================== --- cordova/site/public/docs/en/dev/cordova-plugin-file/index.html (original) +++ cordova/site/public/docs/en/dev/cordova-plugin-file/index.html Wed Mar 23 19:14:10 2016 @@ -19,10 +19,8 @@ <!-- CSS --> <link rel="stylesheet" type="text/css" href="/static/css/main.css"> + <link rel="stylesheet" type="text/css" href="/static/css/lib/syntax.css"> - - <link rel="stylesheet" type="text/css" href="/static/js/lib/prettify/prettify.css"> - <!-- HTML5 shim and Respond.js for IE8 support of HTML5 elements and media queries --> <!--[if lt IE 9]> @@ -135,7 +133,7 @@ <li> - <a class="" href="../guide/overview/index.html"> + <a class="" href="../../../../../guide/overview/index.html"> Overview </a> @@ -176,7 +174,7 @@ <li> - <a class="" href="../guide/cli/index.html"> + <a class="" href="../../../../../guide/cli/index.html"> Create your first app </a> @@ -193,7 +191,7 @@ <li> - <a class="" href="../guide/support/index.html"> + <a class="" href="../../../../../guide/support/index.html"> Platform support </a> @@ -229,7 +227,7 @@ <li> - <a class="" href="../guide/platforms/android/index.html"> + <a class="" href="../../../../../guide/platforms/android/index.html"> Android </a> @@ -246,7 +244,7 @@ <li> - <a class="" href="../guide/platforms/blackberry10/home.html"> + <a class="" href="../../../../../guide/platforms/blackberry10/home.html"> Blackberry 10 </a> @@ -263,7 +261,7 @@ <li> - <a class="" href="../guide/platforms/ios/index.html"> + <a class="" href="../../../../../guide/platforms/ios/index.html"> iOS </a> @@ -280,7 +278,7 @@ <li> - <a class="" href="../guide/platforms/osx/index.html"> + <a class="" href="../../../../../guide/platforms/osx/index.html"> OS X </a> @@ -297,7 +295,7 @@ <li> - <a class="" href="../guide/platforms/ubuntu/index.html"> + <a class="" href="../../../../../guide/platforms/ubuntu/index.html"> Ubuntu </a> @@ -314,7 +312,7 @@ <li> - <a class="" href="../guide/platforms/win8/index.html"> + <a class="" href="../../../../../guide/platforms/win8/index.html"> Windows </a> @@ -331,7 +329,7 @@ <li> - <a class="" href="../guide/platforms/wp8/home.html"> + <a class="" href="../../../../../guide/platforms/wp8/home.html"> WP8 </a> @@ -353,7 +351,7 @@ <li> - <a class="" href="../platform_plugin_versioning_ref/index.html"> + <a class="" href="../../../../../platform_plugin_versioning_ref/index.html"> Manage versions and platforms </a> @@ -375,7 +373,7 @@ <li> - <a class="" href="../config_ref/images.html"> + <a class="" href="../../../../../config_ref/images.html"> Customize icons </a> @@ -397,7 +395,7 @@ <li> - <a class="" href="../cordova/storage/storage.html"> + <a class="" href="../../../../../cordova/storage/storage.html"> Store data </a> @@ -414,7 +412,7 @@ <li> - <a class="" href="../guide/appdev/privacy/index.html"> + <a class="" href="../../../../../guide/appdev/privacy/index.html"> Manage privacy </a> @@ -431,7 +429,7 @@ <li> - <a class="" href="../guide/appdev/security/index.html"> + <a class="" href="../../../../../guide/appdev/security/index.html"> Manage security </a> @@ -448,7 +446,7 @@ <li> - <a class="" href="../guide/appdev/whitelist/index.html"> + <a class="" href="../../../../../guide/appdev/whitelist/index.html"> Whitelisting </a> @@ -494,7 +492,7 @@ <li> - <a class="" href="../guide/hybrid/plugins/index.html"> + <a class="" href="../../../../../guide/hybrid/plugins/index.html"> Create a plugin </a> @@ -535,7 +533,7 @@ <li> - <a class="" href="../guide/platforms/android/plugin.html"> + <a class="" href="../../../../../guide/platforms/android/plugin.html"> Android </a> @@ -552,7 +550,7 @@ <li> - <a class="" href="../guide/platforms/blackberry10/plugin.html"> + <a class="" href="../../../../../guide/platforms/blackberry10/plugin.html"> Blackberry 10 </a> @@ -569,7 +567,7 @@ <li> - <a class="" href="../guide/platforms/ios/plugin.html"> + <a class="" href="../../../../../guide/platforms/ios/plugin.html"> iOS </a> @@ -586,7 +584,7 @@ <li> - <a class="" href="../guide/platforms/win8/plugin.html"> + <a class="" href="../../../../../guide/platforms/win8/plugin.html"> Windows </a> @@ -603,7 +601,7 @@ <li> - <a class="" href="../guide/platforms/wp8/plugin.html"> + <a class="" href="../../../../../guide/platforms/wp8/plugin.html"> WP8 </a> @@ -625,7 +623,7 @@ <li> - <a class="" href="../plugin_ref/plugman.html"> + <a class="" href="../../../../../plugin_ref/plugman.html"> Use Plugman </a> @@ -671,7 +669,7 @@ <li> - <a class="" href="../guide/hybrid/webviews/index.html"> + <a class="" href="../../../../../guide/hybrid/webviews/index.html"> Embed Cordova in native apps </a> @@ -693,7 +691,7 @@ <li> - <a class="" href="../guide/next/index.html"> + <a class="" href="../../../../../guide/next/index.html"> Next Steps </a> @@ -734,7 +732,7 @@ <li> - <a class="" href="../config_ref/index.html"> + <a class="" href="../../../../../config_ref/index.html"> Config.xml </a> @@ -751,7 +749,7 @@ <li> - <a class="" href="../cordova/events/events.html"> + <a class="" href="../../../../../cordova/events/events.html"> Events </a> @@ -768,7 +766,7 @@ <li> - <a class="" href="../cordova-cli/index.html"> + <a class="" href="../../../../../reference/cordova-cli/index.html"> CLI </a> @@ -785,7 +783,7 @@ <li> - <a class="" href="../guide/appdev/hooks/index.html"> + <a class="" href="../../../../../guide/appdev/hooks/index.html"> Hooks </a> @@ -802,7 +800,7 @@ <li> - <a class="" href="../plugin_ref/spec.html"> + <a class="" href="../../../../../plugin_ref/spec.html"> Plugin.xml </a> @@ -838,7 +836,7 @@ <li> - <a class="" href="../cordova-plugin-battery-status/index.html"> + <a class="" href="../../../../../reference/cordova-plugin-battery-status/index.html"> Battery Status </a> @@ -855,7 +853,7 @@ <li> - <a class="" href="../cordova-plugin-camera/index.html"> + <a class="" href="../../../../../reference/cordova-plugin-camera/index.html"> Camera </a> @@ -872,7 +870,7 @@ <li> - <a class="" href="../cordova-plugin-console/index.html"> + <a class="" href="../../../../../reference/cordova-plugin-console/index.html"> Console </a> @@ -889,7 +887,7 @@ <li> - <a class="" href="../cordova-plugin-contacts/index.html"> + <a class="" href="../../../../../reference/cordova-plugin-contacts/index.html"> Contacts </a> @@ -906,7 +904,7 @@ <li> - <a class="" href="../cordova-plugin-device/index.html"> + <a class="" href="../../../../../reference/cordova-plugin-device/index.html"> Device </a> @@ -923,7 +921,7 @@ <li> - <a class="" href="../cordova-plugin-device-motion/index.html"> + <a class="" href="../../../../../reference/cordova-plugin-device-motion/index.html"> Device Motion </a> @@ -940,7 +938,7 @@ <li> - <a class="" href="../cordova-plugin-device-orientation/index.html"> + <a class="" href="../../../../../reference/cordova-plugin-device-orientation/index.html"> Device Orientation </a> @@ -957,7 +955,7 @@ <li> - <a class="" href="../cordova-plugin-dialogs/index.html"> + <a class="" href="../../../../../reference/cordova-plugin-dialogs/index.html"> Dialogs </a> @@ -974,13 +972,13 @@ <li> - <a class="this-page" href="../cordova-plugin-file/index.html"> + <a class="" href="../../../../../reference/cordova-plugin-file/index.html"> File </a> - <div id="page-toc" class="page-toc"></div> + </li> @@ -991,7 +989,7 @@ <li> - <a class="" href="../cordova-plugin-file-transfer/index.html"> + <a class="" href="../../../../../reference/cordova-plugin-file-transfer/index.html"> File Transfer </a> @@ -1008,7 +1006,7 @@ <li> - <a class="" href="../cordova-plugin-geolocation/index.html"> + <a class="" href="../../../../../reference/cordova-plugin-geolocation/index.html"> Geolocation </a> @@ -1025,7 +1023,7 @@ <li> - <a class="" href="../cordova-plugin-globalization/index.html"> + <a class="" href="../../../../../reference/cordova-plugin-globalization/index.html"> Globalization </a> @@ -1042,7 +1040,7 @@ <li> - <a class="" href="../cordova-plugin-inappbrowser/index.html"> + <a class="" href="../../../../../reference/cordova-plugin-inappbrowser/index.html"> Inappbrowser </a> @@ -1059,7 +1057,7 @@ <li> - <a class="" href="../cordova-plugin-media/index.html"> + <a class="" href="../../../../../reference/cordova-plugin-media/index.html"> Media </a> @@ -1076,7 +1074,7 @@ <li> - <a class="" href="../cordova-plugin-media-capture/index.html"> + <a class="" href="../../../../../reference/cordova-plugin-media-capture/index.html"> Media Capture </a> @@ -1093,7 +1091,7 @@ <li> - <a class="" href="../cordova-plugin-network-information/index.html"> + <a class="" href="../../../../../reference/cordova-plugin-network-information/index.html"> Network Information </a> @@ -1110,7 +1108,7 @@ <li> - <a class="" href="../cordova-plugin-splashscreen/index.html"> + <a class="" href="../../../../../reference/cordova-plugin-splashscreen/index.html"> Splashscreen </a> @@ -1127,7 +1125,7 @@ <li> - <a class="" href="../cordova-plugin-vibration/index.html"> + <a class="" href="../../../../../reference/cordova-plugin-vibration/index.html"> Vibration </a> @@ -1144,7 +1142,7 @@ <li> - <a class="" href="../cordova-plugin-statusbar/index.html"> + <a class="" href="../../../../../reference/cordova-plugin-statusbar/index.html"> Statusbar </a> @@ -1161,7 +1159,7 @@ <li> - <a class="" href="../cordova-plugin-whitelist/index.html"> + <a class="" href="../../../../../reference/cordova-plugin-whitelist/index.html"> Whitelist </a> @@ -1178,7 +1176,7 @@ <li> - <a class="" href="../cordova-plugin-legacy-whitelist/index.html"> + <a class="" href="../../../../../reference/cordova-plugin-legacy-whitelist/index.html"> Legacy Whitelist </a> @@ -1210,10 +1208,10 @@ <!-- Page content --> <div class="col-md-8 col-md-offset-1"> + <div class=" content-header"> - <!-- ToC Dropdown (for XS and SM sizes only) --> - <div class="toc-dropdown content-header visible-xs-block visible-sm-block"> - <div class="dropdown"> + <!-- ToC Dropdown (for XS and SM sizes only) --> + <div class="toc-dropdown dropdown visible-xs-block visible-sm-block"> <button class="btn btn-default dropdown-toggle" type="button" id="tocDropdown" data-toggle="dropdown" aria-haspopup="true" aria-expanded="true"> Table of Contents <span class="caret"></span> @@ -1225,7 +1223,7 @@ <li> - <a class="" href="../guide/overview/index.html"> + <a class="" href="../../../../../guide/overview/index.html"> Overview </a> </li> @@ -1240,7 +1238,7 @@ <li> - <a class="" href="../guide/cli/index.html"> + <a class="" href="../../../../../guide/cli/index.html"> Create your first app </a> </li> @@ -1249,7 +1247,7 @@ <li> - <a class="" href="../guide/support/index.html"> + <a class="" href="../../../../../guide/support/index.html"> Platform support </a> </li> @@ -1261,7 +1259,7 @@ <li> - <a class="" href="../guide/platforms/android/index.html"> + <a class="" href="../../../../../guide/platforms/android/index.html"> Android </a> </li> @@ -1270,7 +1268,7 @@ <li> - <a class="" href="../guide/platforms/blackberry10/home.html"> + <a class="" href="../../../../../guide/platforms/blackberry10/home.html"> Blackberry 10 </a> </li> @@ -1279,7 +1277,7 @@ <li> - <a class="" href="../guide/platforms/ios/index.html"> + <a class="" href="../../../../../guide/platforms/ios/index.html"> iOS </a> </li> @@ -1288,7 +1286,7 @@ <li> - <a class="" href="../guide/platforms/osx/index.html"> + <a class="" href="../../../../../guide/platforms/osx/index.html"> OS X </a> </li> @@ -1297,7 +1295,7 @@ <li> - <a class="" href="../guide/platforms/ubuntu/index.html"> + <a class="" href="../../../../../guide/platforms/ubuntu/index.html"> Ubuntu </a> </li> @@ -1306,7 +1304,7 @@ <li> - <a class="" href="../guide/platforms/win8/index.html"> + <a class="" href="../../../../../guide/platforms/win8/index.html"> Windows </a> </li> @@ -1315,7 +1313,7 @@ <li> - <a class="" href="../guide/platforms/wp8/home.html"> + <a class="" href="../../../../../guide/platforms/wp8/home.html"> WP8 </a> </li> @@ -1327,7 +1325,7 @@ <li> - <a class="" href="../platform_plugin_versioning_ref/index.html"> + <a class="" href="../../../../../platform_plugin_versioning_ref/index.html"> Manage versions and platforms </a> </li> @@ -1339,7 +1337,7 @@ <li> - <a class="" href="../config_ref/images.html"> + <a class="" href="../../../../../config_ref/images.html"> Customize icons </a> </li> @@ -1351,7 +1349,7 @@ <li> - <a class="" href="../cordova/storage/storage.html"> + <a class="" href="../../../../../cordova/storage/storage.html"> Store data </a> </li> @@ -1360,7 +1358,7 @@ <li> - <a class="" href="../guide/appdev/privacy/index.html"> + <a class="" href="../../../../../guide/appdev/privacy/index.html"> Manage privacy </a> </li> @@ -1369,7 +1367,7 @@ <li> - <a class="" href="../guide/appdev/security/index.html"> + <a class="" href="../../../../../guide/appdev/security/index.html"> Manage security </a> </li> @@ -1378,7 +1376,7 @@ <li> - <a class="" href="../guide/appdev/whitelist/index.html"> + <a class="" href="../../../../../guide/appdev/whitelist/index.html"> Whitelisting </a> </li> @@ -1396,7 +1394,7 @@ <li> - <a class="" href="../guide/hybrid/plugins/index.html"> + <a class="" href="../../../../../guide/hybrid/plugins/index.html"> Create a plugin </a> </li> @@ -1411,7 +1409,7 @@ <li> - <a class="" href="../guide/platforms/android/plugin.html"> + <a class="" href="../../../../../guide/platforms/android/plugin.html"> Android </a> </li> @@ -1420,7 +1418,7 @@ <li> - <a class="" href="../guide/platforms/blackberry10/plugin.html"> + <a class="" href="../../../../../guide/platforms/blackberry10/plugin.html"> Blackberry 10 </a> </li> @@ -1429,7 +1427,7 @@ <li> - <a class="" href="../guide/platforms/ios/plugin.html"> + <a class="" href="../../../../../guide/platforms/ios/plugin.html"> iOS </a> </li> @@ -1438,7 +1436,7 @@ <li> - <a class="" href="../guide/platforms/win8/plugin.html"> + <a class="" href="../../../../../guide/platforms/win8/plugin.html"> Windows </a> </li> @@ -1447,7 +1445,7 @@ <li> - <a class="" href="../guide/platforms/wp8/plugin.html"> + <a class="" href="../../../../../guide/platforms/wp8/plugin.html"> WP8 </a> </li> @@ -1459,7 +1457,7 @@ <li> - <a class="" href="../plugin_ref/plugman.html"> + <a class="" href="../../../../../plugin_ref/plugman.html"> Use Plugman </a> </li> @@ -1477,7 +1475,7 @@ <li> - <a class="" href="../guide/hybrid/webviews/index.html"> + <a class="" href="../../../../../guide/hybrid/webviews/index.html"> Embed Cordova in native apps </a> </li> @@ -1489,7 +1487,7 @@ <li> - <a class="" href="../guide/next/index.html"> + <a class="" href="../../../../../guide/next/index.html"> Next Steps </a> </li> @@ -1504,7 +1502,7 @@ <li> - <a class="" href="../config_ref/index.html"> + <a class="" href="../../../../../config_ref/index.html"> Config.xml </a> </li> @@ -1513,7 +1511,7 @@ <li> - <a class="" href="../cordova/events/events.html"> + <a class="" href="../../../../../cordova/events/events.html"> Events </a> </li> @@ -1522,7 +1520,7 @@ <li> - <a class="" href="../cordova-cli/index.html"> + <a class="" href="../../../../../reference/cordova-cli/index.html"> CLI </a> </li> @@ -1531,7 +1529,7 @@ <li> - <a class="" href="../guide/appdev/hooks/index.html"> + <a class="" href="../../../../../guide/appdev/hooks/index.html"> Hooks </a> </li> @@ -1540,7 +1538,7 @@ <li> - <a class="" href="../plugin_ref/spec.html"> + <a class="" href="../../../../../plugin_ref/spec.html"> Plugin.xml </a> </li> @@ -1552,7 +1550,7 @@ <li> - <a class="" href="../cordova-plugin-battery-status/index.html"> + <a class="" href="../../../../../reference/cordova-plugin-battery-status/index.html"> Battery Status </a> </li> @@ -1561,7 +1559,7 @@ <li> - <a class="" href="../cordova-plugin-camera/index.html"> + <a class="" href="../../../../../reference/cordova-plugin-camera/index.html"> Camera </a> </li> @@ -1570,7 +1568,7 @@ <li> - <a class="" href="../cordova-plugin-console/index.html"> + <a class="" href="../../../../../reference/cordova-plugin-console/index.html"> Console </a> </li> @@ -1579,7 +1577,7 @@ <li> - <a class="" href="../cordova-plugin-contacts/index.html"> + <a class="" href="../../../../../reference/cordova-plugin-contacts/index.html"> Contacts </a> </li> @@ -1588,7 +1586,7 @@ <li> - <a class="" href="../cordova-plugin-device/index.html"> + <a class="" href="../../../../../reference/cordova-plugin-device/index.html"> Device </a> </li> @@ -1597,7 +1595,7 @@ <li> - <a class="" href="../cordova-plugin-device-motion/index.html"> + <a class="" href="../../../../../reference/cordova-plugin-device-motion/index.html"> Device Motion </a> </li> @@ -1606,7 +1604,7 @@ <li> - <a class="" href="../cordova-plugin-device-orientation/index.html"> + <a class="" href="../../../../../reference/cordova-plugin-device-orientation/index.html"> Device Orientation </a> </li> @@ -1615,7 +1613,7 @@ <li> - <a class="" href="../cordova-plugin-dialogs/index.html"> + <a class="" href="../../../../../reference/cordova-plugin-dialogs/index.html"> Dialogs </a> </li> @@ -1624,7 +1622,7 @@ <li> - <a class="this-page" href="../cordova-plugin-file/index.html"> + <a class="" href="../../../../../reference/cordova-plugin-file/index.html"> File </a> </li> @@ -1633,7 +1631,7 @@ <li> - <a class="" href="../cordova-plugin-file-transfer/index.html"> + <a class="" href="../../../../../reference/cordova-plugin-file-transfer/index.html"> File Transfer </a> </li> @@ -1642,7 +1640,7 @@ <li> - <a class="" href="../cordova-plugin-geolocation/index.html"> + <a class="" href="../../../../../reference/cordova-plugin-geolocation/index.html"> Geolocation </a> </li> @@ -1651,7 +1649,7 @@ <li> - <a class="" href="../cordova-plugin-globalization/index.html"> + <a class="" href="../../../../../reference/cordova-plugin-globalization/index.html"> Globalization </a> </li> @@ -1660,7 +1658,7 @@ <li> - <a class="" href="../cordova-plugin-inappbrowser/index.html"> + <a class="" href="../../../../../reference/cordova-plugin-inappbrowser/index.html"> Inappbrowser </a> </li> @@ -1669,7 +1667,7 @@ <li> - <a class="" href="../cordova-plugin-media/index.html"> + <a class="" href="../../../../../reference/cordova-plugin-media/index.html"> Media </a> </li> @@ -1678,7 +1676,7 @@ <li> - <a class="" href="../cordova-plugin-media-capture/index.html"> + <a class="" href="../../../../../reference/cordova-plugin-media-capture/index.html"> Media Capture </a> </li> @@ -1687,7 +1685,7 @@ <li> - <a class="" href="../cordova-plugin-network-information/index.html"> + <a class="" href="../../../../../reference/cordova-plugin-network-information/index.html"> Network Information </a> </li> @@ -1696,7 +1694,7 @@ <li> - <a class="" href="../cordova-plugin-splashscreen/index.html"> + <a class="" href="../../../../../reference/cordova-plugin-splashscreen/index.html"> Splashscreen </a> </li> @@ -1705,7 +1703,7 @@ <li> - <a class="" href="../cordova-plugin-vibration/index.html"> + <a class="" href="../../../../../reference/cordova-plugin-vibration/index.html"> Vibration </a> </li> @@ -1714,7 +1712,7 @@ <li> - <a class="" href="../cordova-plugin-statusbar/index.html"> + <a class="" href="../../../../../reference/cordova-plugin-statusbar/index.html"> Statusbar </a> </li> @@ -1723,7 +1721,7 @@ <li> - <a class="" href="../cordova-plugin-whitelist/index.html"> + <a class="" href="../../../../../reference/cordova-plugin-whitelist/index.html"> Whitelist </a> </li> @@ -1732,7 +1730,7 @@ <li> - <a class="" href="../cordova-plugin-legacy-whitelist/index.html"> + <a class="" href="../../../../../reference/cordova-plugin-legacy-whitelist/index.html"> Legacy Whitelist </a> </li> @@ -1751,13 +1749,13 @@ </ul> </div> - </div> - <div class="content-header"> + + + <a class="edit" href="https://github.com/apache/cordova-plugin-file/blob/4.1.1/README.md";><span class="glyphicon glyphicon-pencil" aria-hidden="true"></span> Edit</a> - <a class="edit" href="https://github.com/apache/cordova-plugin-file/blob/4.1.1/README.md";> - <span class="glyphicon glyphicon-pencil" aria-hidden="true"></span> Edit - </a> + + <!-- Language dropdown --> <div class="dropdown"> @@ -2041,7 +2039,9 @@ <!-- Version dropdown --> <div class="dropdown"> <button class="btn btn-default dropdown-toggle" type="button" id="versionDropdown" data-toggle="dropdown" aria-haspopup="true" aria-expanded="true"> - dev + 6.x + + (Latest) <span class="caret"></span> </button> @@ -2052,6 +2052,11 @@ <li> + + + + + @@ -2060,12 +2065,10 @@ <a href="/docs/en/dev/cordova-plugin-file/index.html"> - <span class="selected"> - + dev - </span> </a> </li> @@ -2073,20 +2076,27 @@ <li> + + + + + - <a href="/docs/en/6.x/cordova-plugin-file/index.html"> + <a href="/docs/en/dev/cordova-plugin-file/index.html"> - + <span class="selected"> + 6.x (Latest) + </span> </a> </li> @@ -2094,13 +2104,18 @@ <li> + + + + + - <a href="/docs/en/5.4.0/cordova-plugin-file/index.html"> + <a href="/docs/en/dev/cordova-plugin-file/index.html"> 5.4.0 @@ -2113,13 +2128,18 @@ <li> + + + + + - <a href="/docs/en/5.1.1/cordova-plugin-file/index.html"> + <a href="/docs/en/dev/cordova-plugin-file/index.html"> 5.1.1 @@ -2132,13 +2152,18 @@ <li> + + + + + - <a href="/docs/en/5.0.0/cordova-plugin-file/index.html"> + <a href="/docs/en/dev/cordova-plugin-file/index.html"> 5.0.0 @@ -2151,13 +2176,18 @@ <li> + + + + + - <a href="/docs/en/4.0.0/cordova-plugin-file/index.html"> + <a href="/docs/en/dev/cordova-plugin-file/index.html"> 4.0.0 @@ -2170,13 +2200,18 @@ <li> + + + + + - <a href="/docs/en/3.6.0/cordova-plugin-file/index.html"> + <a href="/docs/en/dev/cordova-plugin-file/index.html"> 3.6.0 @@ -2189,13 +2224,18 @@ <li> + + + + + - <a href="/docs/en/3.5.0/cordova-plugin-file/index.html"> + <a href="/docs/en/dev/cordova-plugin-file/index.html"> 3.5.0 @@ -2208,13 +2248,18 @@ <li> + + + + + - <a href="/docs/en/3.4.0/cordova-plugin-file/index.html"> + <a href="/docs/en/dev/cordova-plugin-file/index.html"> 3.4.0 @@ -2227,13 +2272,18 @@ <li> + + + + + - <a href="/docs/en/3.3.0/cordova-plugin-file/index.html"> + <a href="/docs/en/dev/cordova-plugin-file/index.html"> 3.3.0 @@ -2246,13 +2296,18 @@ <li> + + + + + - <a href="/docs/en/3.2.0/cordova-plugin-file/index.html"> + <a href="/docs/en/dev/cordova-plugin-file/index.html"> 3.2.0 @@ -2265,13 +2320,18 @@ <li> + + + + + - <a href="/docs/en/3.1.0/cordova-plugin-file/index.html"> + <a href="/docs/en/dev/cordova-plugin-file/index.html"> 3.1.0 @@ -2284,13 +2344,18 @@ <li> + + + + + - <a href="/docs/en/3.0.0/cordova-plugin-file/index.html"> + <a href="/docs/en/dev/cordova-plugin-file/index.html"> 3.0.0 @@ -2303,13 +2368,18 @@ <li> + + + + + - <a href="/docs/en/2.9.0/cordova-plugin-file/index.html"> + <a href="/docs/en/dev/cordova-plugin-file/index.html"> 2.9.0 @@ -2322,13 +2392,18 @@ <li> + + + + + - <a href="/docs/en/2.8.0/cordova-plugin-file/index.html"> + <a href="/docs/en/dev/cordova-plugin-file/index.html"> 2.8.0 @@ -2341,13 +2416,18 @@ <li> + + + + + - <a href="/docs/en/2.7.0/cordova-plugin-file/index.html"> + <a href="/docs/en/dev/cordova-plugin-file/index.html"> 2.7.0 @@ -2360,13 +2440,18 @@ <li> + + + + + - <a href="/docs/en/2.6.0/cordova-plugin-file/index.html"> + <a href="/docs/en/dev/cordova-plugin-file/index.html"> 2.6.0 @@ -2379,13 +2464,18 @@ <li> + + + + + - <a href="/docs/en/2.5.0/cordova-plugin-file/index.html"> + <a href="/docs/en/dev/cordova-plugin-file/index.html"> 2.5.0 @@ -2398,13 +2488,18 @@ <li> + + + + + - <a href="/docs/en/2.4.0/cordova-plugin-file/index.html"> + <a href="/docs/en/dev/cordova-plugin-file/index.html"> 2.4.0 @@ -2417,13 +2512,18 @@ <li> + + + + + - <a href="/docs/en/2.3.0/cordova-plugin-file/index.html"> + <a href="/docs/en/dev/cordova-plugin-file/index.html"> 2.3.0 @@ -2436,13 +2536,18 @@ <li> + + + + + - <a href="/docs/en/2.2.0/cordova-plugin-file/index.html"> + <a href="/docs/en/dev/cordova-plugin-file/index.html"> 2.2.0 @@ -2455,13 +2560,18 @@ <li> + + + + + - <a href="/docs/en/2.1.0/cordova-plugin-file/index.html"> + <a href="/docs/en/dev/cordova-plugin-file/index.html"> 2.1.0 @@ -2474,13 +2584,18 @@ <li> + + + + + - <a href="/docs/en/2.0.0/cordova-plugin-file/index.html"> + <a href="/docs/en/dev/cordova-plugin-file/index.html"> 2.0.0 @@ -2493,13 +2608,18 @@ <li> + + + + + - <a href="/docs/en/1.9.0/cordova-plugin-file/index.html"> + <a href="/docs/en/dev/cordova-plugin-file/index.html"> 1.9.0 @@ -2512,13 +2632,18 @@ <li> + + + + + - <a href="/docs/en/1.8.1/cordova-plugin-file/index.html"> + <a href="/docs/en/dev/cordova-plugin-file/index.html"> 1.8.1 @@ -2531,13 +2656,18 @@ <li> + + + + + - <a href="/docs/en/1.8.0/cordova-plugin-file/index.html"> + <a href="/docs/en/dev/cordova-plugin-file/index.html"> 1.8.0 @@ -2550,13 +2680,18 @@ <li> + + + + + - <a href="/docs/en/1.7.0/cordova-plugin-file/index.html"> + <a href="/docs/en/dev/cordova-plugin-file/index.html"> 1.7.0 @@ -2569,13 +2704,18 @@ <li> + + + + + - <a href="/docs/en/1.6.1/cordova-plugin-file/index.html"> + <a href="/docs/en/dev/cordova-plugin-file/index.html"> 1.6.1 @@ -2588,13 +2728,18 @@ <li> + + + + + - <a href="/docs/en/1.6.0/cordova-plugin-file/index.html"> + <a href="/docs/en/dev/cordova-plugin-file/index.html"> 1.6.0 @@ -2607,13 +2752,18 @@ <li> + + + + + - <a href="/docs/en/1.5.0/cordova-plugin-file/index.html"> + <a href="/docs/en/dev/cordova-plugin-file/index.html"> 1.5.0 @@ -2635,23 +2785,6 @@ <!-- Show warnings for special versions (i.e. non-latest, and dev) --> - - - - - - <div class="alert alert-info docs-alert" role="alert"> - <button type="button" class="close" data-dismiss="alert" aria-label="Close"> - <span aria-hidden="true">×</span> - </button> - This version of the documentation is under development! - <a href="/docs/en/latest/cordova-plugin-file/index.html"> - Click here for the latest released version. - </a> - </div> - - - <div class="alert alert-warning docs-alert" role="alert"> <button type="button" class="close" data-dismiss="alert" aria-label="Close"> @@ -2707,10 +2840,10 @@ Although most of the plugin code was wri <p>For an overview of other storage options, refer to Cordova's <a href="http://cordova.apache.org/docs/en/edge/cordova_storage_storage.md.html";>storage guide</a>.</p> -<p>This plugin defines global <code class="prettyprint">cordova.file</code> object.</p> +<p>This plugin defines global <code>cordova.file</code> object.</p> -<p>Although in the global scope, it is not available until after the <code class="prettyprint">deviceready</code> event.</p> -<div class="highlight"><pre><code class="language-text" data-lang="text">document.addEventListener("deviceready", onDeviceReady, false); +<p>Although in the global scope, it is not available until after the <code>deviceready</code> event.</p> +<div class="highlight"><pre><code class="language-" data-lang="">document.addEventListener("deviceready", onDeviceReady, false); function onDeviceReady() { console.log(cordova.file); } @@ -2718,7 +2851,7 @@ function onDeviceReady() { <p>:warning: Report issues on the <a href="https://issues.apache.org/jira/issues/?jql=project%20%3D%20CB%20AND%20status%20in%20%28Open%2C%20%22In%20Progress%22%2C%20Reopened%29%20AND%20resolution%20%3D%20Unresolved%20AND%20component%20%3D%20%22Plugin%20File%22%20ORDER%20BY%20priority%20DESC%2C%20summary%20ASC%2C%20updatedDate%20DESC";>Apache Cordova issue tracker</a></p> <h2>Installation</h2> -<div class="highlight"><pre><code class="language-text" data-lang="text">cordova plugin add cordova-plugin-file +<div class="highlight"><pre><code class="language-" data-lang="">cordova plugin add cordova-plugin-file </code></pre></div> <h2>Supported Platforms</h2> @@ -2735,58 +2868,58 @@ function onDeviceReady() { <li>Browser</li> </ul> -<p>* <em>These platforms do not support <code class="prettyprint">FileReader.readAsArrayBuffer</code> nor <code class="prettyprint">FileWriter.write(blob)</code>.</em></p> +<p>* <em>These platforms do not support <code>FileReader.readAsArrayBuffer</code> nor <code>FileWriter.write(blob)</code>.</em></p> <h2>Where to Store Files</h2> <p>As of v1.2.0, URLs to important file-system directories are provided. Each URL is in the form <em>file:///path/to/spot/</em>, and can be converted to a -<code class="prettyprint">DirectoryEntry</code> using <code class="prettyprint">window.resolveLocalFileSystemURL()</code>.</p> +<code>DirectoryEntry</code> using <code>window.resolveLocalFileSystemURL()</code>.</p> <ul> -<li><p><code class="prettyprint">cordova.file.applicationDirectory</code> - Read-only directory where the application +<li><p><code>cordova.file.applicationDirectory</code> - Read-only directory where the application is installed. (<em>iOS</em>, <em>Android</em>, <em>BlackBerry 10</em>, <em>OSX</em>, <em>windows</em>)</p></li> -<li><p><code class="prettyprint">cordova.file.applicationStorageDirectory</code> - Root directory of the application's +<li><p><code>cordova.file.applicationStorageDirectory</code> - Root directory of the application's sandbox; on iOS & windows this location is read-only (but specific subdirectories [like -<code class="prettyprint">/Documents</code> on iOS or <code class="prettyprint">/localState</code> on windows] are read-write). All data contained within +<code>/Documents</code> on iOS or <code>/localState</code> on windows] are read-write). All data contained within is private to the app. (<em>iOS</em>, <em>Android</em>, <em>BlackBerry 10</em>, <em>OSX</em>)</p></li> -<li><p><code class="prettyprint">cordova.file.dataDirectory</code> - Persistent and private data storage within the +<li><p><code>cordova.file.dataDirectory</code> - Persistent and private data storage within the application's sandbox using internal memory (on Android, if you need to use -external memory, use <code class="prettyprint">.externalDataDirectory</code>). On iOS, this directory is not -synced with iCloud (use <code class="prettyprint">.syncedDataDirectory</code>). (<em>iOS</em>, <em>Android</em>, <em>BlackBerry 10</em>, <em>windows</em>)</p></li> -<li><p><code class="prettyprint">cordova.file.cacheDirectory</code> - Directory for cached data files or any files +external memory, use <code>.externalDataDirectory</code>). On iOS, this directory is not +synced with iCloud (use <code>.syncedDataDirectory</code>). (<em>iOS</em>, <em>Android</em>, <em>BlackBerry 10</em>, <em>windows</em>)</p></li> +<li><p><code>cordova.file.cacheDirectory</code> - 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. (<em>iOS</em>, <em>Android</em>, <em>BlackBerry 10</em>, <em>OSX</em>, <em>windows</em>)</p></li> -<li><p><code class="prettyprint">cordova.file.externalApplicationStorageDirectory</code> - Application space on +<li><p><code>cordova.file.externalApplicationStorageDirectory</code> - Application space on external storage. (<em>Android</em>)</p></li> -<li><p><code class="prettyprint">cordova.file.externalDataDirectory</code> - Where to put app-specific data files on +<li><p><code>cordova.file.externalDataDirectory</code> - Where to put app-specific data files on external storage. (<em>Android</em>)</p></li> -<li><p><code class="prettyprint">cordova.file.externalCacheDirectory</code> - Application cache on external storage. +<li><p><code>cordova.file.externalCacheDirectory</code> - Application cache on external storage. (<em>Android</em>)</p></li> -<li><p><code class="prettyprint">cordova.file.externalRootDirectory</code> - External storage (SD card) root. (<em>Android</em>, <em>BlackBerry 10</em>)</p></li> -<li><p><code class="prettyprint">cordova.file.tempDirectory</code> - Temp directory that the OS can clear at will. Do not +<li><p><code>cordova.file.externalRootDirectory</code> - External storage (SD card) root. (<em>Android</em>, <em>BlackBerry 10</em>)</p></li> +<li><p><code>cordova.file.tempDirectory</code> - 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. (<em>iOS</em>, <em>OSX</em>, <em>windows</em>)</p></li> -<li><p><code class="prettyprint">cordova.file.syncedDataDirectory</code> - Holds app-specific files that should be synced +<li><p><code>cordova.file.syncedDataDirectory</code> - Holds app-specific files that should be synced (e.g. to iCloud). (<em>iOS</em>, <em>windows</em>)</p></li> -<li><p><code class="prettyprint">cordova.file.documentsDirectory</code> - Files private to the app, but that are meaningful -to other application (e.g. Office files). Note that for <em>OSX</em> this is the user's <code class="prettyprint">~/Documents</code> directory. (<em>iOS</em>, <em>OSX</em>)</p></li> -<li><p><code class="prettyprint">cordova.file.sharedDirectory</code> - Files globally available to all applications (<em>BlackBerry 10</em>)</p></li> +<li><p><code>cordova.file.documentsDirectory</code> - Files private to the app, but that are meaningful +to other application (e.g. Office files). Note that for <em>OSX</em> this is the user's <code>~/Documents</code> directory. (<em>iOS</em>, <em>OSX</em>)</p></li> +<li><p><code>cordova.file.sharedDirectory</code> - Files globally available to all applications (<em>BlackBerry 10</em>)</p></li> </ul> <h2>File System Layouts</h2> <p>Although technically an implementation detail, it can be very useful to know how -the <code class="prettyprint">cordova.file.*</code> properties map to physical paths on a real device.</p> +the <code>cordova.file.*</code> properties map to physical paths on a real device.</p> <h3>iOS File System Layout</h3> <table><thead> <tr> <th style="text-align: left">Device Path</th> -<th style="text-align: left"><code class="prettyprint">cordova.file.*</code></th> -<th style="text-align: left"><code class="prettyprint">iosExtraFileSystems</code></th> +<th style="text-align: left"><code>cordova.file.*</code></th> +<th style="text-align: left"><code>iosExtraFileSystems</code></th> <th style="text-align: center">r/w?</th> <th style="text-align: center">persistent?</th> <th style="text-align: center">OS clears</th> @@ -2795,7 +2928,7 @@ the <code class="prettyprint">cordova.fi </tr> </thead><tbody> <tr> -<td style="text-align: left"><code class="prettyprint">/var/mobile/Applications/<UUID>/</code></td> +<td style="text-align: left"><code>/var/mobile/Applications/<UUID>/</code></td> <td style="text-align: left">applicationStorageDirectory</td> <td style="text-align: left">-</td> <td style="text-align: center">r</td> @@ -2805,7 +2938,7 @@ the <code class="prettyprint">cordova.fi <td style="text-align: center">Yes</td> </tr> <tr> -<td style="text-align: left"> <code class="prettyprint">appname.app/</code></td> +<td style="text-align: left"> <code>appname.app/</code></td> <td style="text-align: left">applicationDirectory</td> <td style="text-align: left">bundle</td> <td style="text-align: center">r</td> @@ -2815,7 +2948,7 @@ the <code class="prettyprint">cordova.fi <td style="text-align: center">Yes</td> </tr> <tr> -<td style="text-align: left"> <code class="prettyprint">www/</code></td> +<td style="text-align: left"> <code>www/</code></td> <td style="text-align: left">-</td> <td style="text-align: left">-</td> <td style="text-align: center">r</td> @@ -2825,7 +2958,7 @@ the <code class="prettyprint">cordova.fi <td style="text-align: center">Yes</td> </tr> <tr> -<td style="text-align: left"> <code class="prettyprint">Documents/</code></td> +<td style="text-align: left"> <code>Documents/</code></td> <td style="text-align: left">documentsDirectory</td> <td style="text-align: left">documents</td> <td style="text-align: center">r/w</td> @@ -2835,7 +2968,7 @@ the <code class="prettyprint">cordova.fi <td style="text-align: center">Yes</td> </tr> <tr> -<td style="text-align: left"> <code class="prettyprint">NoCloud/</code></td> +<td style="text-align: left"> <code>NoCloud/</code></td> <td style="text-align: left">-</td> <td style="text-align: left">documents-nosync</td> <td style="text-align: center">r/w</td> @@ -2845,7 +2978,7 @@ the <code class="prettyprint">cordova.fi <td style="text-align: center">Yes</td> </tr> <tr> -<td style="text-align: left"> <code class="prettyprint">Library</code></td> +<td style="text-align: left"> <code>Library</code></td> <td style="text-align: left">-</td> <td style="text-align: left">library</td> <td style="text-align: center">r/w</td> @@ -2855,7 +2988,7 @@ the <code class="prettyprint">cordova.fi <td style="text-align: center">Yes</td> </tr> <tr> -<td style="text-align: left"> <code class="prettyprint">NoCloud/</code></td> +<td style="text-align: left"> <code>NoCloud/</code></td> <td style="text-align: left">dataDirectory</td> <td style="text-align: left">library-nosync</td> <td style="text-align: center">r/w</td> @@ -2865,7 +2998,7 @@ the <code class="prettyprint">cordova.fi <td style="text-align: center">Yes</td> </tr> <tr> -<td style="text-align: left"> <code class="prettyprint">Cloud/</code></td> +<td style="text-align: left"> <code>Cloud/</code></td> <td style="text-align: left">syncedDataDirectory</td> <td style="text-align: left">-</td> <td style="text-align: center">r/w</td> @@ -2875,7 +3008,7 @@ the <code class="prettyprint">cordova.fi <td style="text-align: center">Yes</td> </tr> <tr> -<td style="text-align: left"> <code class="prettyprint">Caches/</code></td> +<td style="text-align: left"> <code>Caches/</code></td> <td style="text-align: left">cacheDirectory</td> <td style="text-align: left">cache</td> <td style="text-align: center">r/w</td> @@ -2885,7 +3018,7 @@ the <code class="prettyprint">cordova.fi <td style="text-align: center">Yes</td> </tr> <tr> -<td style="text-align: left"> <code class="prettyprint">tmp/</code></td> +<td style="text-align: left"> <code>tmp/</code></td> <td style="text-align: left">tempDirectory</td> <td style="text-align: left">-</td> <td style="text-align: center">r/w</td> @@ -2914,8 +3047,8 @@ the <code class="prettyprint">cordova.fi <table><thead> <tr> <th style="text-align: left">Device Path</th> -<th style="text-align: left"><code class="prettyprint">cordova.file.*</code></th> -<th style="text-align: left"><code class="prettyprint">AndroidExtraFileSystems</code></th> +<th style="text-align: left"><code>cordova.file.*</code></th> +<th style="text-align: left"><code>AndroidExtraFileSystems</code></th> <th style="text-align: center">r/w?</th> <th style="text-align: center">persistent?</th> <th style="text-align: center">OS clears</th> @@ -2923,7 +3056,7 @@ the <code class="prettyprint">cordova.fi </tr> </thead><tbody> <tr> -<td style="text-align: left"><code class="prettyprint">file:///android_asset/</code></td> +<td style="text-align: left"><code>file:///android_asset/</code></td> <td style="text-align: left">applicationDirectory</td> <td style="text-align: left"></td> <td style="text-align: center">r</td> @@ -2932,7 +3065,7 @@ the <code class="prettyprint">cordova.fi <td style="text-align: center">Yes</td> </tr> <tr> -<td style="text-align: left"><code class="prettyprint">/data/data/<app-id>/</code></td> +<td style="text-align: left"><code>/data/data/<app-id>/</code></td> <td style="text-align: left">applicationStorageDirectory</td> <td style="text-align: left">-</td> <td style="text-align: center">r/w</td> @@ -2941,7 +3074,7 @@ the <code class="prettyprint">cordova.fi <td style="text-align: center">Yes</td> </tr> <tr> -<td style="text-align: left"> <code class="prettyprint">cache</code></td> +<td style="text-align: left"> <code>cache</code></td> <td style="text-align: left">cacheDirectory</td> <td style="text-align: left">cache</td> <td style="text-align: center">r/w</td> @@ -2950,7 +3083,7 @@ the <code class="prettyprint">cordova.fi <td style="text-align: center">Yes</td> </tr> <tr> -<td style="text-align: left"> <code class="prettyprint">files</code></td> +<td style="text-align: left"> <code>files</code></td> <td style="text-align: left">dataDirectory</td> <td style="text-align: left">files</td> <td style="text-align: center">r/w</td> @@ -2959,7 +3092,7 @@ the <code class="prettyprint">cordova.fi <td style="text-align: center">Yes</td> </tr> <tr> -<td style="text-align: left"> <code class="prettyprint">Documents</code></td> +<td style="text-align: left"> <code>Documents</code></td> <td style="text-align: left"></td> <td style="text-align: left">documents</td> <td style="text-align: center">r/w</td> @@ -2968,7 +3101,7 @@ the <code class="prettyprint">cordova.fi <td style="text-align: center">Yes</td> </tr> <tr> -<td style="text-align: left"><code class="prettyprint"><sdcard>/</code></td> +<td style="text-align: left"><code><sdcard>/</code></td> <td style="text-align: left">externalRootDirectory</td> <td style="text-align: left">sdcard</td> <td style="text-align: center">r/w</td> @@ -2977,7 +3110,7 @@ the <code class="prettyprint">cordova.fi <td style="text-align: center">No</td> </tr> <tr> -<td style="text-align: left"> <code class="prettyprint">Android/data/<app-id>/</code></td> +<td style="text-align: left"> <code>Android/data/<app-id>/</code></td> <td style="text-align: left">externalApplicationStorageDirectory</td> <td style="text-align: left">-</td> <td style="text-align: center">r/w</td> @@ -2986,7 +3119,7 @@ the <code class="prettyprint">cordova.fi <td style="text-align: center">No</td> </tr> <tr> -<td style="text-align: left"> <code class="prettyprint">cache</code></td> +<td style="text-align: left"> <code>cache</code></td> <td style="text-align: left">externalCacheDirectry</td> <td style="text-align: left">cache-external</td> <td style="text-align: center">r/w</td> @@ -2995,7 +3128,7 @@ the <code class="prettyprint">cordova.fi <td style="text-align: center">No</td> </tr> <tr> -<td style="text-align: left"> <code class="prettyprint">files</code></td> +<td style="text-align: left"> <code>files</code></td> <td style="text-align: left">externalDataDirectory</td> <td style="text-align: left">files-external</td> <td style="text-align: center">r/w</td> @@ -3013,15 +3146,15 @@ the <code class="prettyprint">cordova.fi the contents yourself. Should the user purge the cache manually, the contents of the directory are removed.</p> -<p><strong>Note</strong>: If external storage can't be mounted, the <code class="prettyprint">cordova.file.external*</code> -properties are <code class="prettyprint">null</code>.</p> +<p><strong>Note</strong>: If external storage can't be mounted, the <code>cordova.file.external*</code> +properties are <code>null</code>.</p> <h3>BlackBerry 10 File System Layout</h3> <table><thead> <tr> <th style="text-align: left">Device Path</th> -<th style="text-align: left"><code class="prettyprint">cordova.file.*</code></th> +<th style="text-align: left"><code>cordova.file.*</code></th> <th style="text-align: center">r/w?</th> <th style="text-align: center">persistent?</th> <th style="text-align: center">OS clears</th> @@ -3029,7 +3162,7 @@ properties are <code class="prettyprint" </tr> </thead><tbody> <tr> -<td style="text-align: left"><code class="prettyprint">file:///accounts/1000/appdata/<app id>/</code></td> +<td style="text-align: left"><code>file:///accounts/1000/appdata/<app id>/</code></td> <td style="text-align: left">applicationStorageDirectory</td> <td style="text-align: center">r</td> <td style="text-align: center">N/A</td> @@ -3037,7 +3170,7 @@ properties are <code class="prettyprint" <td style="text-align: center">Yes</td> </tr> <tr> -<td style="text-align: left"> <code class="prettyprint">app/native</code></td> +<td style="text-align: left"> <code>app/native</code></td> <td style="text-align: left">applicationDirectory</td> <td style="text-align: center">r</td> <td style="text-align: center">N/A</td> @@ -3045,7 +3178,7 @@ properties are <code class="prettyprint" <td style="text-align: center">Yes</td> </tr> <tr> -<td style="text-align: left"> <code class="prettyprint">data/webviews/webfs/temporary/local__0</code></td> +<td style="text-align: left"> <code>data/webviews/webfs/temporary/local__0</code></td> <td style="text-align: left">cacheDirectory</td> <td style="text-align: center">r/w</td> <td style="text-align: center">No</td> @@ -3053,7 +3186,7 @@ properties are <code class="prettyprint" <td style="text-align: center">Yes</td> </tr> <tr> -<td style="text-align: left"> <code class="prettyprint">data/webviews/webfs/persistent/local__0</code></td> +<td style="text-align: left"> <code>data/webviews/webfs/persistent/local__0</code></td> <td style="text-align: left">dataDirectory</td> <td style="text-align: center">r/w</td> <td style="text-align: center">Yes</td> @@ -3061,7 +3194,7 @@ properties are <code class="prettyprint" <td style="text-align: center">Yes</td> </tr> <tr> -<td style="text-align: left"><code class="prettyprint">file:///accounts/1000/removable/sdcard</code></td> +<td style="text-align: left"><code>file:///accounts/1000/removable/sdcard</code></td> <td style="text-align: left">externalRemovableDirectory</td> <td style="text-align: center">r/w</td> <td style="text-align: center">Yes</td> @@ -3069,7 +3202,7 @@ properties are <code class="prettyprint" <td style="text-align: center">No</td> </tr> <tr> -<td style="text-align: left"><code class="prettyprint">file:///accounts/1000/shared</code></td> +<td style="text-align: left"><code>file:///accounts/1000/shared</code></td> <td style="text-align: left">sharedDirectory</td> <td style="text-align: center">r/w</td> <td style="text-align: center">Yes</td> @@ -3085,15 +3218,15 @@ properties are <code class="prettyprint" <table><thead> <tr> <th style="text-align: left">Device Path</th> -<th style="text-align: left"><code class="prettyprint">cordova.file.*</code></th> -<th style="text-align: left"><code class="prettyprint">iosExtraFileSystems</code></th> +<th style="text-align: left"><code>cordova.file.*</code></th> +<th style="text-align: left"><code>iosExtraFileSystems</code></th> <th style="text-align: center">r/w?</th> <th style="text-align: center">OS clears</th> <th style="text-align: center">private</th> </tr> </thead><tbody> <tr> -<td style="text-align: left"><code class="prettyprint">/Applications/<appname>.app/</code></td> +<td style="text-align: left"><code>/Applications/<appname>.app/</code></td> <td style="text-align: left">-</td> <td style="text-align: left">bundle</td> <td style="text-align: center">r</td> @@ -3101,7 +3234,7 @@ properties are <code class="prettyprint" <td style="text-align: center">Yes</td> </tr> <tr> -<td style="text-align: left"> <code class="prettyprint">Content/Resources/</code></td> +<td style="text-align: left"> <code>Content/Resources/</code></td> <td style="text-align: left">applicationDirectory</td> <td style="text-align: left">-</td> <td style="text-align: center">r</td> @@ -3109,7 +3242,7 @@ properties are <code class="prettyprint" <td style="text-align: center">Yes</td> </tr> <tr> -<td style="text-align: left"><code class="prettyprint">~/Library/Application Support/<bundle-id>/</code></td> +<td style="text-align: left"><code>~/Library/Application Support/<bundle-id>/</code></td> <td style="text-align: left">applicationStorageDirectory</td> <td style="text-align: left">-</td> <td style="text-align: center">r/w</td> @@ -3117,7 +3250,7 @@ properties are <code class="prettyprint" <td style="text-align: center">Yes</td> </tr> <tr> -<td style="text-align: left"> <code class="prettyprint">files/</code></td> +<td style="text-align: left"> <code>files/</code></td> <td style="text-align: left">dataDirectory</td> <td style="text-align: left">-</td> <td style="text-align: center">r/w</td> @@ -3125,7 +3258,7 @@ properties are <code class="prettyprint" <td style="text-align: center">Yes</td> </tr> <tr> -<td style="text-align: left"><code class="prettyprint">~/Documents/</code></td> +<td style="text-align: left"><code>~/Documents/</code></td> <td style="text-align: left">documentsDirectory</td> <td style="text-align: left">documents</td> <td style="text-align: center">r/w</td> @@ -3133,7 +3266,7 @@ properties are <code class="prettyprint" <td style="text-align: center">No</td> </tr> <tr> -<td style="text-align: left"><code class="prettyprint">~/Library/Caches/<bundle-id>/</code></td> +<td style="text-align: left"><code>~/Library/Caches/<bundle-id>/</code></td> <td style="text-align: left">cacheDirectory</td> <td style="text-align: left">cache</td> <td style="text-align: center">r/w</td> @@ -3141,7 +3274,7 @@ properties are <code class="prettyprint" <td style="text-align: center">Yes</td> </tr> <tr> -<td style="text-align: left"><code class="prettyprint">/tmp/</code></td> +<td style="text-align: left"><code>/tmp/</code></td> <td style="text-align: left">tempDirectory</td> <td style="text-align: left">-</td> <td style="text-align: center">r/w</td> @@ -3149,7 +3282,7 @@ properties are <code class="prettyprint" <td style="text-align: center">Yes</td> </tr> <tr> -<td style="text-align: left"><code class="prettyprint">/</code></td> +<td style="text-align: left"><code>/</code></td> <td style="text-align: left">rootDirectory</td> <td style="text-align: left">root</td> <td style="text-align: center">r/w</td> @@ -3158,7 +3291,7 @@ properties are <code class="prettyprint" </tr> </tbody></table> -<p><strong>Note</strong>: This is the layout for non sandboxed applications. I you enable sandboxing, the <code class="prettyprint">applicationStorageDirectory</code> will be below <code class="prettyprint">~/Library/Containers/<bundle-id>/Data/Library/Application Support</code>.</p> +<p><strong>Note</strong>: This is the layout for non sandboxed applications. I you enable sandboxing, the <code>applicationStorageDirectory</code> will be below <code>~/Library/Containers/<bundle-id>/Data/Library/Application Support</code>.</p> <p>* Files persist across app restarts and upgrades, but this directory can be cleared whenever the OS desires. Your app should be able to recreate any @@ -3172,7 +3305,7 @@ properties are <code class="prettyprint" <table><thead> <tr> <th style="text-align: left">Device Path</th> -<th style="text-align: left"><code class="prettyprint">cordova.file.*</code></th> +<th style="text-align: left"><code>cordova.file.*</code></th> <th style="text-align: center">r/w?</th> <th style="text-align: center">persistent?</th> <th style="text-align: center">OS clears</th> @@ -3180,7 +3313,7 @@ properties are <code class="prettyprint" </tr> </thead><tbody> <tr> -<td style="text-align: left"><code class="prettyprint">ms-appdata:///</code></td> +<td style="text-align: left"><code>ms-appdata:///</code></td> <td style="text-align: left">applicationDirectory</td> <td style="text-align: center">r</td> <td style="text-align: center">N/A</td> @@ -3188,7 +3321,7 @@ properties are <code class="prettyprint" <td style="text-align: center">Yes</td> </tr> <tr> -<td style="text-align: left"> <code class="prettyprint">local/</code></td> +<td style="text-align: left"> <code>local/</code></td> <td style="text-align: left">dataDirectory</td> <td style="text-align: center">r/w</td> <td style="text-align: center">Yes</td> @@ -3196,7 +3329,7 @@ properties are <code class="prettyprint" <td style="text-align: center">Yes</td> </tr> <tr> -<td style="text-align: left"> <code class="prettyprint">temp/</code></td> +<td style="text-align: left"> <code>temp/</code></td> <td style="text-align: left">cacheDirectory</td> <td style="text-align: center">r/w</td> <td style="text-align: center">No</td> @@ -3204,7 +3337,7 @@ properties are <code class="prettyprint" <td style="text-align: center">Yes</td> </tr> <tr> -<td style="text-align: left"> <code class="prettyprint">temp/</code></td> +<td style="text-align: left"> <code>temp/</code></td> <td style="text-align: left">tempDirectory</td> <td style="text-align: center">r/w</td> <td style="text-align: center">No</td> @@ -3212,7 +3345,7 @@ properties are <code class="prettyprint" <td style="text-align: center">Yes</td> </tr> <tr> -<td style="text-align: left"> <code class="prettyprint">roaming/</code></td> +<td style="text-align: left"> <code>roaming/</code></td> <td style="text-align: left">syncedDataDirectory</td> <td style="text-align: center">r/w</td> <td style="text-align: center">Yes</td> @@ -3240,47 +3373,47 @@ This meant that all Cordova apps could s card.</p> <p>If the SD card was not available, then previous versions would store data under -<code class="prettyprint">/data/data/<packageId></code>, which isolates apps from each other, but may still +<code>/data/data/<packageId></code>, which isolates apps from each other, but may still cause data to be shared between users.</p> <p>It is now possible to choose whether to store files in the internal file storage location, or using the previous logic, with a preference in your -application's <code class="prettyprint">config.xml</code> file. To do this, add one of these two lines to -<code class="prettyprint">config.xml</code>:</p> -<div class="highlight"><pre><code class="language-text" data-lang="text"><preference name="AndroidPersistentFileLocation" value="Internal" /> +application's <code>config.xml</code> file. To do this, add one of these two lines to +<code>config.xml</code>:</p> +<div class="highlight"><pre><code class="language-" data-lang=""><preference name="AndroidPersistentFileLocation" value="Internal" /> -<preference name="AndroidPersistentFileLocation" value="Compatibility" /> +<preference name="AndroidPersistentFileLocation" value="Compatibility" /> </code></pre></div> -<p>Without this line, the File plugin will use <code class="prettyprint">Internal</code> as the default. If +<p>Without this line, the File plugin will use <code>Internal</code> as the default. If a preference tag is present, and is not one of these values, the application will not start.</p> <p>If your application has previously been shipped to users, using an older (pre- 3.0.0) version of this plugin, and has stored files in the persistent filesystem, -then you should set the preference to <code class="prettyprint">Compatibility</code> if your config.xml does not specify a location for the persistent filesystem. Switching the location to +then you should set the preference to <code>Compatibility</code> if your config.xml does not specify a location for the persistent filesystem. Switching the location to "Internal" would mean that existing users who upgrade their application may be unable to access their previously-stored files, depending on their device.</p> <p>If your application is new, or has never previously stored files in the -persistent filesystem, then the <code class="prettyprint">Internal</code> setting is generally recommended.</p> +persistent filesystem, then the <code>Internal</code> setting is generally recommended.</p> <h3>Slow recursive operations for /android_asset</h3> <p>Listing asset directories is really slow on Android. You can speed it up though, by -adding <code class="prettyprint">src/android/build-extras.gradle</code> to the root of your android project (also +adding <code>src/android/build-extras.gradle</code> to the root of your android project (also requires cordova-android@4.0.0 or greater).</p> <h2>iOS Quirks</h2> <ul> -<li><code class="prettyprint">cordova.file.applicationStorageDirectory</code> is read-only; attempting to store -files within the root directory will fail. Use one of the other <code class="prettyprint">cordova.file.*</code> -properties defined for iOS (only <code class="prettyprint">applicationDirectory</code> and <code class="prettyprint">applicationStorageDirectory</code> are +<li><code>cordova.file.applicationStorageDirectory</code> is read-only; attempting to store +files within the root directory will fail. Use one of the other <code>cordova.file.*</code> +properties defined for iOS (only <code>applicationDirectory</code> and <code>applicationStorageDirectory</code> are read-only).</li> -<li><code class="prettyprint">FileReader.readAsText(blob, encoding)</code> +<li><code>FileReader.readAsText(blob, encoding)</code> <ul> -<li>The <code class="prettyprint">encoding</code> parameter is not supported, and UTF-8 encoding is always in effect.</li> +<li>The <code>encoding</code> parameter is not supported, and UTF-8 encoding is always in effect.</li> </ul></li> </ul> @@ -3295,24 +3428,24 @@ files, rather than producing complete do intended purpose of the directory.</p> <p>It is now possible to choose whether to store files in the documents or library -directory, with a preference in your application's <code class="prettyprint">config.xml</code> file. To do this, -add one of these two lines to <code class="prettyprint">config.xml</code>:</p> -<div class="highlight"><pre><code class="language-text" data-lang="text"><preference name="iosPersistentFileLocation" value="Library" /> +directory, with a preference in your application's <code>config.xml</code> file. To do this, +add one of these two lines to <code>config.xml</code>:</p> +<div class="highlight"><pre><code class="language-" data-lang=""><preference name="iosPersistentFileLocation" value="Library" /> -<preference name="iosPersistentFileLocation" value="Compatibility" /> +<preference name="iosPersistentFileLocation" value="Compatibility" /> </code></pre></div> -<p>Without this line, the File plugin will use <code class="prettyprint">Compatibility</code> as the default. If +<p>Without this line, the File plugin will use <code>Compatibility</code> as the default. If a preference tag is present, and is not one of these values, the application will not start.</p> <p>If your application has previously been shipped to users, using an older (pre- 1.0) version of this plugin, and has stored files in the persistent filesystem, -then you should set the preference to <code class="prettyprint">Compatibility</code>. Switching the location to -<code class="prettyprint">Library</code> would mean that existing users who upgrade their application would be +then you should set the preference to <code>Compatibility</code>. Switching the location to +<code>Library</code> would mean that existing users who upgrade their application would be unable to access their previously-stored files.</p> <p>If your application is new, or has never previously stored files in the -persistent filesystem, then the <code class="prettyprint">Library</code> setting is generally recommended.</p> +persistent filesystem, then the <code>Library</code> setting is generally recommended.</p> <h2>Firefox OS Quirks</h2> @@ -3322,15 +3455,15 @@ as a shim on top of indexedDB.</p> <ul> <li>Does not fail when removing non-empty directories</li> <li>Does not support metadata for directories</li> -<li>Methods <code class="prettyprint">copyTo</code> and <code class="prettyprint">moveTo</code> do not support directories</li> +<li>Methods <code>copyTo</code> and <code>moveTo</code> do not support directories</li> </ul> <p>The following data paths are supported:</p> <ul> -<li><code class="prettyprint">applicationDirectory</code> - Uses <code class="prettyprint">xhr</code> to get local files that are packaged with the app.</li> -<li><code class="prettyprint">dataDirectory</code> - For persistent app-specific data files.</li> -<li><code class="prettyprint">cacheDirectory</code> - Cached files that should survive app restarts (Apps should not rely +<li><code>applicationDirectory</code> - Uses <code>xhr</code> to get local files that are packaged with the app.</li> +<li><code>dataDirectory</code> - For persistent app-specific data files.</li> +<li><code>cacheDirectory</code> - Cached files that should survive app restarts (Apps should not rely on the OS to delete files in here).</li> </ul> @@ -3342,48 +3475,48 @@ on the OS to delete files in here).</li> <li>Each browser uses its own sandboxed filesystem. IE and Firefox use IndexedDB as a base. All browsers use forward slash as directory separator in a path.</li> <li>Directory entries have to be created successively. -For example, the call <code class="prettyprint">fs.root.getDirectory('dir1/dir2', {create:true}, successCallback, errorCallback)</code> +For example, the call <code>fs.root.getDirectory('dir1/dir2', {create:true}, successCallback, errorCallback)</code> will fail if dir1 did not exist.</li> <li>The plugin requests user permission to use persistent storage at the application first start.</li> -<li>Plugin supports <code class="prettyprint">cdvfile://localhost</code> (local resources) only. I.e. external resources are not supported via <code class="prettyprint">cdvfile</code>.</li> +<li>Plugin supports <code>cdvfile://localhost</code> (local resources) only. I.e. external resources are not supported via <code>cdvfile</code>.</li> <li>The plugin does not follow <a href="http://www.w3.org/TR/2011/WD-file-system-api-20110419/#naming-restrictions";>"File System API 8.3 Naming restrictions"</a>.</li> -<li>Blob and File' <code class="prettyprint">close</code> function is not supported.</li> -<li><code class="prettyprint">FileSaver</code> and <code class="prettyprint">BlobBuilder</code> are not supported by this plugin and don't have stubs.</li> -<li>The plugin does not support <code class="prettyprint">requestAllFileSystems</code>. This function is also missing in the specifications.</li> -<li>Entries in directory will not be removed if you use <code class="prettyprint">create: true</code> flag for existing directory.</li> +<li>Blob and File' <code>close</code> function is not supported.</li> +<li><code>FileSaver</code> and <code>BlobBuilder</code> are not supported by this plugin and don't have stubs.</li> +<li>The plugin does not support <code>requestAllFileSystems</code>. This function is also missing in the specifications.</li> +<li>Entries in directory will not be removed if you use <code>create: true</code> flag for existing directory.</li> <li>Files created via constructor are not supported. You should use entry.file method instead.</li> <li>Each browser uses its own form for blob URL references.</li> -<li><code class="prettyprint">readAsDataURL</code> function is supported, but the mediatype in Chrome depends on entry name extension, -mediatype in IE is always empty (which is the same as <code class="prettyprint">text-plain</code> according the specification), -the mediatype in Firefox is always <code class="prettyprint">application/octet-stream</code>. -For example, if the content is <code class="prettyprint">abcdefg</code> then Firefox returns <code class="prettyprint">data:application/octet-stream;base64,YWJjZGVmZw==</code>, -IE returns <code class="prettyprint">data:;base64,YWJjZGVmZw==</code>, Chrome returns <code class="prettyprint">data:<mediatype depending on extension of entry name>;base64,YWJjZGVmZw==</code>.</li> -<li><code class="prettyprint">toInternalURL</code> returns the path in the form <code class="prettyprint">file:///persistent/path/to/entry</code> (Firefox, IE). -Chrome returns the path in the form <code class="prettyprint">cdvfile://localhost/persistent/file</code>.</li> +<li><code>readAsDataURL</code> function is supported, but the mediatype in Chrome depends on entry name extension, +mediatype in IE is always empty (which is the same as <code>text-plain</code> according the specification), +the mediatype in Firefox is always <code>application/octet-stream</code>. +For example, if the content is <code>abcdefg</code> then Firefox returns <code>data:application/octet-stream;base64,YWJjZGVmZw==</code>, +IE returns <code>data:;base64,YWJjZGVmZw==</code>, Chrome returns <code>data:<mediatype depending on extension of entry name>;base64,YWJjZGVmZw==</code>.</li> +<li><code>toInternalURL</code> returns the path in the form <code>file:///persistent/path/to/entry</code> (Firefox, IE). +Chrome returns the path in the form <code>cdvfile://localhost/persistent/file</code>.</li> </ul> <h3>Chrome quirks</h3> <ul> -<li>Chrome filesystem is not immediately ready after device ready event. As a workaround you can subscribe to <code class="prettyprint">filePluginIsReady</code> event. +<li>Chrome filesystem is not immediately ready after device ready event. As a workaround you can subscribe to <code>filePluginIsReady</code> event. Example: -<code class="prettyprint">javascript +<code>javascript window.addEventListener('filePluginIsReady', function(){ console.log('File plugin is ready');}, false); </code> -You can use <code class="prettyprint">window.isFilePluginReadyRaised</code> function to check whether event was already raised.</li> +You can use <code>window.isFilePluginReadyRaised</code> function to check whether event was already raised.</li> <li>window.requestFileSystem TEMPORARY and PERSISTENT filesystem quotas are not limited in Chrome.</li> -<li>To increase persistent storage in Chrome you need to call <code class="prettyprint">window.initPersistentFileSystem</code> method. Persistent storage quota is 5 MB by default.</li> -<li>Chrome requires <code class="prettyprint">--allow-file-access-from-files</code> run argument to support API via <code class="prettyprint">file:///</code> protocol.</li> -<li><code class="prettyprint">File</code> object will be not changed if you use flag <code class="prettyprint">{create:true}</code> when getting an existing <code class="prettyprint">Entry</code>.</li> -<li>events <code class="prettyprint">cancelable</code> property is set to true in Chrome. This is contrary to the <a href="http://dev.w3.org/2009/dap/file-system/file-writer.html";>specification</a>.</li> -<li><code class="prettyprint">toURL</code> function in Chrome returns <code class="prettyprint">filesystem:</code>-prefixed path depending on application host. -For example, <code class="prettyprint">filesystem:file:///persistent/somefile.txt</code>, <code class="prettyprint">filesystem:http://localhost:8080/persistent/somefile.txt</code>.</li> -<li><code class="prettyprint">toURL</code> function result does not contain trailing slash in case of directory entry. +<li>To increase persistent storage in Chrome you need to call <code>window.initPersistentFileSystem</code> method. Persistent storage quota is 5 MB by default.</li> +<li>Chrome requires <code>--allow-file-access-from-files</code> run argument to support API via <code>file:///</code> protocol.</li> +<li><code>File</code> object will be not changed if you use flag <code>{create:true}</code> when getting an existing <code>Entry</code>.</li> +<li>events <code>cancelable</code> property is set to true in Chrome. This is contrary to the <a href="http://dev.w3.org/2009/dap/file-system/file-writer.html";>specification</a>.</li> +<li><code>toURL</code> function in Chrome returns <code>filesystem:</code>-prefixed path depending on application host. +For example, <code>filesystem:file:///persistent/somefile.txt</code>, <code>filesystem:http://localhost:8080/persistent/somefile.txt</code>.</li> +<li><code>toURL</code> function result does not contain trailing slash in case of directory entry. Chrome resolves directories with slash-trailed urls correctly though.</li> -<li><code class="prettyprint">resolveLocalFileSystemURL</code> method requires the inbound <code class="prettyprint">url</code> to have <code class="prettyprint">filesystem</code> prefix. For example, <code class="prettyprint">url</code> parameter for <code class="prettyprint">resolveLocalFileSystemURL</code> -should be in the form <code class="prettyprint">filesystem:file:///persistent/somefile.txt</code> as opposed to the form <code class="prettyprint">file:///persistent/somefile.txt</code> in Android.</li> -<li>Deprecated <code class="prettyprint">toNativeURL</code> function is not supported and does not have a stub.</li> -<li><code class="prettyprint">setMetadata</code> function is not stated in the specifications and not supported.</li> +<li><code>resolveLocalFileSystemURL</code> method requires the inbound <code>url</code> to have <code>filesystem</code> prefix. For example, <code>url</code> parameter for <code>resolveLocalFileSystemURL</code> +should be in the form <code>filesystem:file:///persistent/somefile.txt</code> as opposed to the form <code>file:///persistent/somefile.txt</code> in Android.</li> +<li>Deprecated <code>toNativeURL</code> function is not supported and does not have a stub.</li> +<li><code>setMetadata</code> function is not stated in the specifications and not supported.</li> <li>INVALID<em>MODIFICATION</em>ERR (code: 9) is thrown instead of SYNTAX_ERR(code: 8) on requesting of a non-existant filesystem.</li> <li>INVALID<em>MODIFICATION</em>ERR (code: 9) is thrown instead of PATH<em>EXISTS</em>ERR(code: 12) on trying to exclusively create a file or directory, which already exists.</li> <li>INVALID<em>MODIFICATION</em>ERR (code: 9) is thrown instead of NO<em>MODIFICATION</em>ALLOWED_ERR(code: 6) on trying to call removeRecursively on the root file system.</li> @@ -3393,63 +3526,63 @@ should be in the form <code class="prett <h3>IndexedDB-based impl quirks (Firefox and IE)</h3> <ul> -<li><code class="prettyprint">.</code> and <code class="prettyprint">..</code> are not supported.</li> -<li>IE does not support <code class="prettyprint">file:///</code>-mode; only hosted mode is supported (http://localhost:xxxx).</li> +<li><code>.</code> and <code>..</code> are not supported.</li> +<li>IE does not support <code>file:///</code>-mode; only hosted mode is supported (http://localhost:xxxx).</li> <li>Firefox filesystem size is not limited but each 50MB extension will request a user permission. IE10 allows up to 10mb of combined AppCache and IndexedDB used in implementation of filesystem without prompting, once you hit that level you will be asked if you want to allow it to be increased up to a max of 250mb per site. -So <code class="prettyprint">size</code> parameter for <code class="prettyprint">requestFileSystem</code> function does not affect filesystem in Firefox and IE.</li> -<li><code class="prettyprint">readAsBinaryString</code> function is not stated in the Specs and not supported in IE and does not have a stub.</li> -<li><code class="prettyprint">file.type</code> is always null.</li> +So <code>size</code> parameter for <code>requestFileSystem</code> function does not affect filesystem in Firefox and IE.</li> +<li><code>readAsBinaryString</code> function is not stated in the Specs and not supported in IE and does not have a stub.</li> +<li><code>file.type</code> is always null.</li>
[... 258 lines stripped ...] --------------------------------------------------------------------- To unsubscribe, e-mail: commits-unsubscr...@cordova.apache.org For additional commands, e-mail: commits-h...@cordova.apache.org
