Added: cordova/site/public/docs/en/6.x/reference/cordova-plugin-device/index.html URL: http://svn.apache.org/viewvc/cordova/site/public/docs/en/6.x/reference/cordova-plugin-device/index.html?rev=1735746&view=auto ============================================================================== --- cordova/site/public/docs/en/6.x/reference/cordova-plugin-device/index.html (added) +++ cordova/site/public/docs/en/6.x/reference/cordova-plugin-device/index.html Sat Mar 19 09:25:08 2016 @@ -0,0 +1,3194 @@ +<!DOCTYPE html> +<html lang="en"> +<head> + <meta charset="utf-8"> + <meta http-equiv="X-UA-Compatible" content="IE=edge,chrome=1"> + <meta http-equiv="Content-Type" content="text/html; charset=UTF-8" /> + <meta name="format-detection" content="telephone=no"> + <meta name="viewport" content="user-scalable=no, initial-scale=1, maximum-scale=1, minimum-scale=1, width=device-width" /> + <meta name="description" content=" "> + + <title> + + + cordova-plugin-device - Apache Cordova + + + </title> + + <link rel="SHORTCUT ICON" href="/favicon.ico"/> + <link rel="canonical" href="https://cordova.apache.org/docs/en/6.x/reference/cordova-plugin-device/"> + + <!-- CSS --> + <link rel="stylesheet" type="text/css" href="/static/css/main.css"> + <link rel="stylesheet" type="text/css" href="/static/css/lib/syntax.css"> + + + <!-- HTML5 shim and Respond.js for IE8 support of HTML5 elements and media queries --> + <!--[if lt IE 9]> + <script src="https://oss.maxcdn.com/html5shiv/3.7.2/html5shiv.min.js"></script> + <script src="https://oss.maxcdn.com/respond/1.4.2/respond.min.js"></script> + <![endif]--> + <script type="text/javascript"> + var disqus_developer = 1; // this would set it to developer mode + </script> + + <!-- JS --> + <script defer type="text/javascript" src="/static/js/lib/jquery-2.1.1.min.js"></script> + <script defer type="text/javascript" src="/static/js/lib/bootstrap.min.js"></script> + <script defer type="text/javascript" src="/static/js/lib/ZeroClipboard.js"></script> +</head> + +<body> + <header> + <a class="scroll-point pt-top" name="top"></a> + <nav class="navbar navbar-inverse navbar-fixed-top"> + <div class="container-fluid"> + <div class="navbar-header"> + <button type="button" class="navbar-toggle collapsed" data-toggle="collapse" data-target="#navbar" aria-expanded="false" aria-controls="navbar"> + <span class="sr-only">Toggle navigation</span> + <span class="icon-bar"></span> + <span class="icon-bar"></span> + <span class="icon-bar"></span> + </button> + <a class="navbar-brand" href="/"><img id="logo_top" src="/static/img/cordova-logo-newbrand.svg"/></a> + </div> + <div id="navbar" class="navbar-collapse collapse"> + <div class="nav_bar_center"> + <ul class="nav navbar-nav"> + <li class="active"> + <a href="/docs/en/latest/guide/overview/">Documentation</a> + </li> + <li > + <a href="/plugins">Plugins</a> + </li> + <li > + <a href="/blog" id="blog_button">Blog<span class="badge" id="new_blog_count"></span></a> + </li> + <li > + <a href="/contribute">Contribute</a> + </li> + <li> + <a href="/#getstarted">Get Started</a> + </li> + </ul> + <form action="https://www.google.com/search" method="GET" class="navbar-form navbar-right" id="header-search-form" role="search"> + <div class="input-group"> + <input type="text" name="q" class="form-control hidden-sm" placeholder="Site-wide Search"> + <span class="input-group-btn"> + <button type="submit" class="btn search-button"> + <span class="glyphicon glyphicon-search" aria-hidden="true"></span> + </button> + </span> + </div> + <input type="hidden" name="q" value="site:cordova.apache.org"> + </form> + </div> + </div><!--/.navbar-collapse --> + </div> + </nav> + <div id="_fixed_navbar_spacer" style="padding-top:50px"></div> +</header> + + <!-- Use the manual ToC, and if it doesn't exist, use the generated one --> + + + + + + + + + + + + +<div class="docs container"> + + <!-- Table of Contents --> + <div class="hidden-xs hidden-sm col-md-3 site-toc-container"> + <h2 class="site-toc-title">Table of Contents</h2> + <ul class="site-toc"> + + + + + + + + <li> + + <span class="toc-section-heading"> + Introduction + </span> + + + + + + + <ul class="site-toc"> + + + + + + <li> + + <a class="" href="../../guide/overview/index.html"> + Overview + </a> + + + + + + + </li> + +</ul> + + + </li> + + + + + + + + <li> + + <span class="toc-section-heading"> + Create apps + </span> + + + + + + + <ul class="site-toc"> + + + + + + <li> + + <a class="" href="../../guide/cli/index.html"> + Create your first app + </a> + + + + + + + </li> + + + + + + <li> + + <a class="" href="../../guide/support/index.html"> + Platform support + </a> + + + + + + + </li> + + + + + + + + <li> + + <span class="toc-section-heading"> + Develop for platforms + </span> + + + + + + + <ul class="site-toc"> + + + + + + <li> + + <a class="" href="../../guide/platforms/android/index.html"> + Android + </a> + + + + + + + </li> + + + + + + <li> + + <a class="" href="../../guide/platforms/blackberry10/home.html"> + Blackberry 10 + </a> + + + + + + + </li> + + + + + + <li> + + <a class="" href="../../guide/platforms/ios/index.html"> + iOS + </a> + + + + + + + </li> + + + + + + <li> + + <a class="" href="../../guide/platforms/osx/index.html"> + OS X + </a> + + + + + + + </li> + + + + + + <li> + + <a class="" href="../../guide/platforms/ubuntu/index.html"> + Ubuntu + </a> + + + + + + + </li> + + + + + + <li> + + <a class="" href="../../guide/platforms/win8/index.html"> + Windows + </a> + + + + + + + </li> + + + + + + <li> + + <a class="" href="../../guide/platforms/wp8/home.html"> + WP8 + </a> + + + + + + + </li> + +</ul> + + + </li> + + + + + + <li> + + <a class="" href="../../platform_plugin_versioning_ref/index.html"> + Manage versions and platforms + </a> + + + + + + + </li> + + + + + + + + + + + <li> + + <a class="" href="../../config_ref/images.html"> + Customize icons + </a> + + + + + + + </li> + + + + + + + + + + + <li> + + <a class="" href="../../cordova/storage/storage.html"> + Store data + </a> + + + + + + + </li> + + + + + + <li> + + <a class="" href="../../guide/appdev/privacy/index.html"> + Manage privacy + </a> + + + + + + + </li> + + + + + + <li> + + <a class="" href="../../guide/appdev/security/index.html"> + Manage security + </a> + + + + + + + </li> + + + + + + <li> + + <a class="" href="../../guide/appdev/whitelist/index.html"> + Whitelisting + </a> + + + + + + + </li> + + + + + + +</ul> + + + </li> + + + + + + + + <li> + + <span class="toc-section-heading"> + Create plugins + </span> + + + + + + + <ul class="site-toc"> + + + + + + <li> + + <a class="" href="../../guide/hybrid/plugins/index.html"> + Create a plugin + </a> + + + + + + + </li> + + + + + + + + + + + + + <li> + + <span class="toc-section-heading"> + Develop for platforms + </span> + + + + + + + <ul class="site-toc"> + + + + + + <li> + + <a class="" href="../../guide/platforms/android/plugin.html"> + Android + </a> + + + + + + + </li> + + + + + + <li> + + <a class="" href="../../guide/platforms/blackberry10/plugin.html"> + Blackberry 10 + </a> + + + + + + + </li> + + + + + + <li> + + <a class="" href="../../guide/platforms/ios/plugin.html"> + iOS + </a> + + + + + + + </li> + + + + + + <li> + + <a class="" href="../../guide/platforms/win8/plugin.html"> + Windows + </a> + + + + + + + </li> + + + + + + <li> + + <a class="" href="../../guide/platforms/wp8/plugin.html"> + WP8 + </a> + + + + + + + </li> + +</ul> + + + </li> + + + + + + <li> + + <a class="" href="../../plugin_ref/plugman.html"> + Use Plugman + </a> + + + + + + + </li> + + + + + + +</ul> + + + </li> + + + + + + + + <li> + + <span class="toc-section-heading"> + Advanced Topics + </span> + + + + + + + <ul class="site-toc"> + + + + + + <li> + + <a class="" href="../../guide/hybrid/webviews/index.html"> + Embed Cordova in native apps + </a> + + + + + + + </li> + + + + + + + + + + + <li> + + <a class="" href="../../guide/next/index.html"> + Next Steps + </a> + + + + + + + </li> + +</ul> + + + </li> + + + + + + + + <li> + + <span class="toc-section-heading"> + Reference + </span> + + + + + + + <ul class="site-toc"> + + + + + + <li> + + <a class="" href="../../config_ref/index.html"> + Config.xml + </a> + + + + + + + </li> + + + + + + <li> + + <a class="" href="../../cordova/events/events.html"> + Events + </a> + + + + + + + </li> + + + + + + <li> + + <a class="" href="../../reference/cordova-cli/index.html"> + CLI + </a> + + + + + + + </li> + + + + + + <li> + + <a class="" href="../../guide/appdev/hooks/index.html"> + Hooks + </a> + + + + + + + </li> + + + + + + <li> + + <a class="" href="../../plugin_ref/spec.html"> + Plugin.xml + </a> + + + + + + + </li> + + + + + + + + <li> + + <span class="toc-section-heading"> + Plugin APIs + </span> + + + + + + + <ul class="site-toc"> + + + + + + <li> + + <a class="" href="../../reference/cordova-plugin-battery-status/index.html"> + Battery Status + </a> + + + + + + + </li> + + + + + + <li> + + <a class="" href="../../reference/cordova-plugin-camera/index.html"> + Camera + </a> + + + + + + + </li> + + + + + + <li> + + <a class="" href="../../reference/cordova-plugin-console/index.html"> + Console + </a> + + + + + + + </li> + + + + + + <li> + + <a class="" href="../../reference/cordova-plugin-contacts/index.html"> + Contacts + </a> + + + + + + + </li> + + + + + + <li> + + <a class="this-page" href="../../reference/cordova-plugin-device/index.html"> + Device + </a> + + + + <div id="page-toc" class="page-toc"></div> + + + </li> + + + + + + <li> + + <a class="" href="../../reference/cordova-plugin-device-motion/index.html"> + Device Motion + </a> + + + + + + + </li> + + + + + + <li> + + <a class="" href="../../reference/cordova-plugin-device-orientation/index.html"> + Device Orientation + </a> + + + + + + + </li> + + + + + + <li> + + <a class="" href="../../reference/cordova-plugin-dialogs/index.html"> + Dialogs + </a> + + + + + + + </li> + + + + + + <li> + + <a class="" href="../../reference/cordova-plugin-file/index.html"> + File + </a> + + + + + + + </li> + + + + + + <li> + + <a class="" href="../../reference/cordova-plugin-file-transfer/index.html"> + File Transfer + </a> + + + + + + + </li> + + + + + + <li> + + <a class="" href="../../reference/cordova-plugin-geolocation/index.html"> + Geolocation + </a> + + + + + + + </li> + + + + + + <li> + + <a class="" href="../../reference/cordova-plugin-globalization/index.html"> + Globalization + </a> + + + + + + + </li> + + + + + + <li> + + <a class="" href="../../reference/cordova-plugin-inappbrowser/index.html"> + Inappbrowser + </a> + + + + + + + </li> + + + + + + <li> + + <a class="" href="../../reference/cordova-plugin-media/index.html"> + Media + </a> + + + + + + + </li> + + + + + + <li> + + <a class="" href="../../reference/cordova-plugin-media-capture/index.html"> + Media Capture + </a> + + + + + + + </li> + + + + + + <li> + + <a class="" href="../../reference/cordova-plugin-network-information/index.html"> + Network Information + </a> + + + + + + + </li> + + + + + + <li> + + <a class="" href="../../reference/cordova-plugin-splashscreen/index.html"> + Splashscreen + </a> + + + + + + + </li> + + + + + + <li> + + <a class="" href="../../reference/cordova-plugin-vibration/index.html"> + Vibration + </a> + + + + + + + </li> + + + + + + <li> + + <a class="" href="../../reference/cordova-plugin-statusbar/index.html"> + Statusbar + </a> + + + + + + + </li> + + + + + + <li> + + <a class="" href="../../reference/cordova-plugin-whitelist/index.html"> + Whitelist + </a> + + + + + + + </li> + + + + + + <li> + + <a class="" href="../../reference/cordova-plugin-legacy-whitelist/index.html"> + Legacy Whitelist + </a> + + + + + + + </li> + +</ul> + + + </li> + +</ul> + + + </li> + + + + + + +</ul> + + </div> + + <!-- 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 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> + </button> + <ul class="dropdown-menu"> + + + + + +<li> + <a class="" href="../../guide/overview/index.html"> + Overview + </a> +</li> + + + + + + + + + + +<li> + <a class="" href="../../guide/cli/index.html"> + Create your first app + </a> +</li> + + + + +<li> + <a class="" href="../../guide/support/index.html"> + Platform support + </a> +</li> + + + + + + + +<li> + <a class="" href="../../guide/platforms/android/index.html"> + Android + </a> +</li> + + + + +<li> + <a class="" href="../../guide/platforms/blackberry10/home.html"> + Blackberry 10 + </a> +</li> + + + + +<li> + <a class="" href="../../guide/platforms/ios/index.html"> + iOS + </a> +</li> + + + + +<li> + <a class="" href="../../guide/platforms/osx/index.html"> + OS X + </a> +</li> + + + + +<li> + <a class="" href="../../guide/platforms/ubuntu/index.html"> + Ubuntu + </a> +</li> + + + + +<li> + <a class="" href="../../guide/platforms/win8/index.html"> + Windows + </a> +</li> + + + + +<li> + <a class="" href="../../guide/platforms/wp8/home.html"> + WP8 + </a> +</li> + + + + + + + +<li> + <a class="" href="../../platform_plugin_versioning_ref/index.html"> + Manage versions and platforms + </a> +</li> + + + + + + + +<li> + <a class="" href="../../config_ref/images.html"> + Customize icons + </a> +</li> + + + + + + + +<li> + <a class="" href="../../cordova/storage/storage.html"> + Store data + </a> +</li> + + + + +<li> + <a class="" href="../../guide/appdev/privacy/index.html"> + Manage privacy + </a> +</li> + + + + +<li> + <a class="" href="../../guide/appdev/security/index.html"> + Manage security + </a> +</li> + + + + +<li> + <a class="" href="../../guide/appdev/whitelist/index.html"> + Whitelisting + </a> +</li> + + + + + + + + + + + + + +<li> + <a class="" href="../../guide/hybrid/plugins/index.html"> + Create a plugin + </a> +</li> + + + + + + + + + + +<li> + <a class="" href="../../guide/platforms/android/plugin.html"> + Android + </a> +</li> + + + + +<li> + <a class="" href="../../guide/platforms/blackberry10/plugin.html"> + Blackberry 10 + </a> +</li> + + + + +<li> + <a class="" href="../../guide/platforms/ios/plugin.html"> + iOS + </a> +</li> + + + + +<li> + <a class="" href="../../guide/platforms/win8/plugin.html"> + Windows + </a> +</li> + + + + +<li> + <a class="" href="../../guide/platforms/wp8/plugin.html"> + WP8 + </a> +</li> + + + + + + + +<li> + <a class="" href="../../plugin_ref/plugman.html"> + Use Plugman + </a> +</li> + + + + + + + + + + + + + +<li> + <a class="" href="../../guide/hybrid/webviews/index.html"> + Embed Cordova in native apps + </a> +</li> + + + + + + + +<li> + <a class="" href="../../guide/next/index.html"> + Next Steps + </a> +</li> + + + + + + + + + + +<li> + <a class="" href="../../config_ref/index.html"> + Config.xml + </a> +</li> + + + + +<li> + <a class="" href="../../cordova/events/events.html"> + Events + </a> +</li> + + + + +<li> + <a class="" href="../../reference/cordova-cli/index.html"> + CLI + </a> +</li> + + + + +<li> + <a class="" href="../../guide/appdev/hooks/index.html"> + Hooks + </a> +</li> + + + + +<li> + <a class="" href="../../plugin_ref/spec.html"> + Plugin.xml + </a> +</li> + + + + + + + +<li> + <a class="" href="../../reference/cordova-plugin-battery-status/index.html"> + Battery Status + </a> +</li> + + + + +<li> + <a class="" href="../../reference/cordova-plugin-camera/index.html"> + Camera + </a> +</li> + + + + +<li> + <a class="" href="../../reference/cordova-plugin-console/index.html"> + Console + </a> +</li> + + + + +<li> + <a class="" href="../../reference/cordova-plugin-contacts/index.html"> + Contacts + </a> +</li> + + + + +<li> + <a class="this-page" href="../../reference/cordova-plugin-device/index.html"> + Device + </a> +</li> + + + + +<li> + <a class="" href="../../reference/cordova-plugin-device-motion/index.html"> + Device Motion + </a> +</li> + + + + +<li> + <a class="" href="../../reference/cordova-plugin-device-orientation/index.html"> + Device Orientation + </a> +</li> + + + + +<li> + <a class="" href="../../reference/cordova-plugin-dialogs/index.html"> + Dialogs + </a> +</li> + + + + +<li> + <a class="" href="../../reference/cordova-plugin-file/index.html"> + File + </a> +</li> + + + + +<li> + <a class="" href="../../reference/cordova-plugin-file-transfer/index.html"> + File Transfer + </a> +</li> + + + + +<li> + <a class="" href="../../reference/cordova-plugin-geolocation/index.html"> + Geolocation + </a> +</li> + + + + +<li> + <a class="" href="../../reference/cordova-plugin-globalization/index.html"> + Globalization + </a> +</li> + + + + +<li> + <a class="" href="../../reference/cordova-plugin-inappbrowser/index.html"> + Inappbrowser + </a> +</li> + + + + +<li> + <a class="" href="../../reference/cordova-plugin-media/index.html"> + Media + </a> +</li> + + + + +<li> + <a class="" href="../../reference/cordova-plugin-media-capture/index.html"> + Media Capture + </a> +</li> + + + + +<li> + <a class="" href="../../reference/cordova-plugin-network-information/index.html"> + Network Information + </a> +</li> + + + + +<li> + <a class="" href="../../reference/cordova-plugin-splashscreen/index.html"> + Splashscreen + </a> +</li> + + + + +<li> + <a class="" href="../../reference/cordova-plugin-vibration/index.html"> + Vibration + </a> +</li> + + + + +<li> + <a class="" href="../../reference/cordova-plugin-statusbar/index.html"> + Statusbar + </a> +</li> + + + + +<li> + <a class="" href="../../reference/cordova-plugin-whitelist/index.html"> + Whitelist + </a> +</li> + + + + +<li> + <a class="" href="../../reference/cordova-plugin-legacy-whitelist/index.html"> + Legacy Whitelist + </a> +</li> + + + + + + + + + + + + + + </ul> + </div> + + + + <a class="edit" href="https://github.com/apache/cordova-plugin-device/blob/master/README.md"><span class="glyphicon glyphicon-pencil" aria-hidden="true"></span> Edit</a> + + + + + <!-- Language dropdown --> + <div class="dropdown"> + <button class="btn btn-default dropdown-toggle" type="button" id="languageDropdown" data-toggle="dropdown" aria-haspopup="true" aria-expanded="true"> + English + <span class="caret"></span> + </button> + + <!-- List all languages --> + <ul class="dropdown-menu" aria-labelledby="languageDropdown"> + + + + + + + + + + + + + + <li> + <a href="/docs/de/6.x/reference/cordova-plugin-device/index.html" class=" + + + " + > + + Deutsch + + </a> + </li> + + + + + + + + + + + + + + <li> + <a href="/docs/en/6.x/reference/cordova-plugin-device/index.html" class=" + + + " + > + + <span class="selected"> + English + </span> + + </a> + </li> + + + + + + + + + + + + + + <li> + <a href="/docs/es/6.x/reference/cordova-plugin-device/index.html" class=" + + + " + > + + Español + + </a> + </li> + + + + + + + + + + + + + + <li> + <a href="/docs/fr/6.x/reference/cordova-plugin-device/index.html" class=" + + + " + > + + Français + + </a> + </li> + + + + + + + + + + + + + + <li> + <a href="/docs/it/6.x/reference/cordova-plugin-device/index.html" class=" + + + " + > + + Italiano + + </a> + </li> + + + + + + + + + + + + + + <li> + <a href="/docs/ja/6.x/reference/cordova-plugin-device/index.html" class=" + + + " + > + + æ¥æ¬èª + + </a> + </li> + + + + + + + + + + + + + + <li> + <a href="/docs/ko/6.x/reference/cordova-plugin-device/index.html" class=" + + + " + > + + íêµì´ + + </a> + </li> + + + + + + + + + + + + + + <li> + <a href="/docs/pl/6.x/reference/cordova-plugin-device/index.html" class=" + + + " + > + + Polski + + </a> + </li> + + + + + + + + + + + + + + <li> + <a href="/docs/ru/6.x/reference/cordova-plugin-device/index.html" class=" + + + " + > + + Ð ÑÑÑкий + + </a> + </li> + + + + + + + + + + + + + + <li> + <a href="/docs/sl/6.x/reference/cordova-plugin-device/index.html" class=" + + + " + > + + Slovene + + </a> + </li> + + + + + + + + + + + + + + <li> + <a href="/docs/zh/6.x/reference/cordova-plugin-device/index.html" class=" + + + " + > + + æ±è¯ + + </a> + </li> + + </ul> + </div> + + <!-- 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"> + 6.x + + (Latest) + + <span class="caret"></span> + </button> + <ul class="dropdown-menu" aria-labelledby="versionDropdown"> + + <!-- List versions available in this language --> + + <li> + + + + + + + + + + + + + + <a href="/docs/en/dev/reference/cordova-plugin-device/index.html"> + + + dev + + + + </a> + </li> + + <li> + + + + + + + + + + + + + + <a href="/docs/en/latest/reference/cordova-plugin-device/index.html"> + + <span class="selected"> + + 6.x + + (Latest) + + + </span> + + </a> + </li> + + <li> + + + + + + + + + + + + + + <a href="/docs/en/5.4.0/reference/cordova-plugin-device/index.html"> + + + 5.4.0 + + + + </a> + </li> + + <li> + + + + + + + + + + + + + + <a href="/docs/en/5.1.1/reference/cordova-plugin-device/index.html"> + + + 5.1.1 + + + + </a> + </li> + + <li> + + + + + + + + + + + + + + <a href="/docs/en/5.0.0/reference/cordova-plugin-device/index.html"> + + + 5.0.0 + + + + </a> + </li> + + <li> + + + + + + + + + + + + + + <a href="/docs/en/4.0.0/reference/cordova-plugin-device/index.html"> + + + 4.0.0 + + + + </a> + </li> + + <li> + + + + + + + + + + + + + + <a href="/docs/en/3.6.0/reference/cordova-plugin-device/index.html"> + + + 3.6.0 + + + + </a> + </li> + + <li> + + + + + + + + + + + + + + <a href="/docs/en/3.5.0/reference/cordova-plugin-device/index.html"> + + + 3.5.0 + + + + </a> + </li> + + <li> + + + + + + + + + + + + + + <a href="/docs/en/3.4.0/reference/cordova-plugin-device/index.html"> + + + 3.4.0 + + + + </a> + </li> + + <li> + + + + + + + + + + + + + + <a href="/docs/en/3.3.0/reference/cordova-plugin-device/index.html"> + + + 3.3.0 + + + + </a> + </li> + + <li> + + + + + + + + + + + + + + <a href="/docs/en/3.2.0/reference/cordova-plugin-device/index.html"> + + + 3.2.0 + + + + </a> + </li> + + <li> + + + + + + + + + + + + + + <a href="/docs/en/3.1.0/reference/cordova-plugin-device/index.html"> + + + 3.1.0 + + + + </a> + </li> + + <li> + + + + + + + + + + + + + + <a href="/docs/en/3.0.0/reference/cordova-plugin-device/index.html"> + + + 3.0.0 + + + + </a> + </li> + + <li> + + + + + + + + + + + + + + <a href="/docs/en/2.9.0/reference/cordova-plugin-device/index.html"> + + + 2.9.0 + + + + </a> + </li> + + <li> + + + + + + + + + + + + + + <a href="/docs/en/2.8.0/reference/cordova-plugin-device/index.html"> + + + 2.8.0 + + + + </a> + </li> + + <li> + + + + + + + + + + + + + + <a href="/docs/en/2.7.0/reference/cordova-plugin-device/index.html"> + + + 2.7.0 + + + + </a> + </li> + + <li> + + + + + + + + + + + + + + <a href="/docs/en/2.6.0/reference/cordova-plugin-device/index.html"> + + + 2.6.0 + + + + </a> + </li> + + <li> + + + + + + + + + + + + + + <a href="/docs/en/2.5.0/reference/cordova-plugin-device/index.html"> + + + 2.5.0 + + + + </a> + </li> + + <li> + + + + + + + + + + + + + + <a href="/docs/en/2.4.0/reference/cordova-plugin-device/index.html"> + + + 2.4.0 + + + + </a> + </li> + + <li> + + + + + + + + + + + + + + <a href="/docs/en/2.3.0/reference/cordova-plugin-device/index.html"> + + + 2.3.0 + + + + </a> + </li> + + <li> + + + + + + + + + + + + + + <a href="/docs/en/2.2.0/reference/cordova-plugin-device/index.html"> + + + 2.2.0 + + + + </a> + </li> + + <li> + + + + + + + + + + + + + + <a href="/docs/en/2.1.0/reference/cordova-plugin-device/index.html"> + + + 2.1.0 + + + + </a> + </li> + + <li> + + + + + + + + + + + + + + <a href="/docs/en/2.0.0/reference/cordova-plugin-device/index.html"> + + + 2.0.0 + + + + </a> + </li> + + <li> + + + + + + + + + + + + + + <a href="/docs/en/1.9.0/reference/cordova-plugin-device/index.html"> + + + 1.9.0 + + + + </a> + </li> + + <li> + + + + + + + + + + + + + + <a href="/docs/en/1.8.1/reference/cordova-plugin-device/index.html"> + + + 1.8.1 + + + + </a> + </li> + + <li> + + + + + + + + + + + + + + <a href="/docs/en/1.8.0/reference/cordova-plugin-device/index.html"> + + + 1.8.0 + + + + </a> + </li> + + <li> + + + + + + + + + + + + + + <a href="/docs/en/1.7.0/reference/cordova-plugin-device/index.html"> + + + 1.7.0 + + + + </a> + </li> + + <li> + + + + + + + + + + + + + + <a href="/docs/en/1.6.1/reference/cordova-plugin-device/index.html"> + + + 1.6.1 + + + + </a> + </li> + + <li> + + + + + + + + + + + + + + <a href="/docs/en/1.6.0/reference/cordova-plugin-device/index.html"> + + + 1.6.0 + + + + </a> + </li> + + <li> + + + + + + + + + + + + + + <a href="/docs/en/1.5.0/reference/cordova-plugin-device/index.html"> + + + 1.5.0 + + + + </a> + </li> + + </ul> + </div> + </div> + + <!-- Get URL for this page in the latest version --> + + + + + <!-- Show warnings for special versions (i.e. non-latest, and dev) --> + + + + <div class="alert alert-warning docs-alert" role="alert"> + <button type="button" class="close" data-dismiss="alert" aria-label="Close"> + <span aria-hidden="true">×</span> + </button> + This documentation describes this plugin at version master. + <a href="https://github.com/apache/cordova-plugin-device/releases"> + Other versions are on GitHub. + </a> + </div> + + + + <div id="page-toc-source"> + <!-- WARNING: This file is generated. See fetch_docs.js. --> + +<!-- +# license: Licensed to the Apache Software Foundation (ASF) under one +# or more contributor license agreements. See the NOTICE file +# distributed with this work for additional information +# regarding copyright ownership. The ASF licenses this file +# to you under the Apache License, Version 2.0 (the +# "License"); you may not use this file except in compliance +# with the License. You may obtain a copy of the License at +# +# http://www.apache.org/licenses/LICENSE-2.0 +# +# Unless required by applicable law or agreed to in writing, +# software distributed under the License is distributed on an +# "AS IS" BASIS, WITHOUT WARRANTIES OR CONDITIONS OF ANY +# KIND, either express or implied. See the License for the +# specific language governing permissions and limitations +# under the License. +--> + +<p><a href="https://travis-ci.org/apache/cordova-plugin-device"><img src="https://travis-ci.org/apache/cordova-plugin-device.svg?branch=master" alt="Build Status"></a></p> + +<h1>cordova-plugin-device</h1> + +<p>This plugin defines a global <code>device</code> object, which describes the device's hardware and software. +Although the object is 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(device.cordova); +} +</code></pre></div> +<p>Report issues with this plugin 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%20Device%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-" data-lang="">cordova plugin add cordova-plugin-device +</code></pre></div> +<h2>Properties</h2> + +<ul> +<li>device.cordova</li> +<li>device.model</li> +<li>device.platform</li> +<li>device.uuid</li> +<li>device.version</li> +<li>device.manufacturer</li> +<li>device.isVirtual</li> +<li>device.serial</li> +</ul> + +<h2>device.cordova</h2> + +<p>Get the version of Cordova running on the device.</p> + +<h3>Supported Platforms</h3> + +<ul> +<li>Amazon Fire OS</li> +<li>Android</li> +<li>BlackBerry 10</li> +<li>Browser</li> +<li>Firefox OS</li> +<li>iOS</li> +<li>Tizen</li> +<li>Windows Phone 7 and 8</li> +<li>Windows</li> +<li>OSX</li> +</ul> + +<h2>device.model</h2> + +<p>The <code>device.model</code> returns 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.</p> + +<h3>Supported Platforms</h3> + +<ul> +<li>Android</li> +<li>BlackBerry 10</li> +<li>Browser</li> +<li>iOS</li> +<li>Tizen</li> +<li>Windows Phone 7 and 8</li> +<li>Windows</li> +<li>OSX</li> +</ul> + +<h3>Quick Example</h3> +<div class="highlight"><pre><code class="language-" data-lang="">// Android: Nexus One returns "Passion" (Nexus One code name) +// Motorola Droid returns "voles" +// BlackBerry: Torch 9800 returns "9800" +// Browser: Google Chrome returns "Chrome" +// Safari returns "Safari" +// iOS: for the iPad Mini, returns iPad2,5; iPhone 5 is iPhone 5,1. See http://theiphonewiki.com/wiki/index.php?title=Models +// OSX: returns "x86_64" +// +var model = device.model; +</code></pre></div> +<h3>Android Quirks</h3> + +<ul> +<li>Gets the <a href="http://developer.android.com/reference/android/os/Build.html#PRODUCT">product name</a> instead of the <a href="http://developer.android.com/reference/android/os/Build.html#MODEL">model name</a>, which is often the production code name. For example, the Nexus One returns <code>Passion</code>, and Motorola Droid returns <code>voles</code>.</li> +</ul> + +<h3>Tizen Quirks</h3> + +<ul> +<li>Returns the device model assigned by the vendor, for example, <code>TIZEN</code></li> +</ul> + +<h3>Windows Phone 7 and 8 Quirks</h3> + +<ul> +<li>Returns the device model specified by the manufacturer. For example, the Samsung Focus returns <code>SGH-i917</code>.</li> +</ul> + +<h2>device.platform</h2> + +<p>Get the device's operating system name.</p> +<div class="highlight"><pre><code class="language-" data-lang="">var string = device.platform; +</code></pre></div> +<h3>Supported Platforms</h3> + +<ul> +<li>Android</li> +<li>BlackBerry 10</li> +<li>Browser</li> +<li>Firefox OS</li> +<li>iOS</li> +<li>Tizen</li> +<li>Windows Phone 7 and 8</li> +<li>Windows</li> +<li>OSX</li> +</ul> + +<h3>Quick Example</h3> +<div class="highlight"><pre><code class="language-" data-lang="">// Depending on the device, a few examples are: +// - "Android" +// - "BlackBerry 10" +// - "browser" +// - "iOS" +// - "WinCE" +// - "Tizen" +// - "Mac OS X" +var devicePlatform = device.platform; +</code></pre></div> +<h3>Windows Phone 7 Quirks</h3> + +<p>Windows Phone 7 devices report the platform as <code>WinCE</code>.</p> + +<h3>Windows Phone 8 Quirks</h3> + +<p>Windows Phone 8 devices report the platform as <code>Win32NT</code>.</p> + +<h2>device.uuid</h2> + +<p>Get the device's Universally Unique Identifier (<a href="http://en.wikipedia.org/wiki/Universally_Unique_Identifier">UUID</a>).</p> +<div class="highlight"><pre><code class="language-" data-lang="">var string = device.uuid; +</code></pre></div> +<h3>Description</h3> + +<p>The details of how a UUID is generated are determined by the device manufacturer and are specific to the device's platform or model.</p> + +<h3>Supported Platforms</h3> + +<ul> +<li>Android</li> +<li>BlackBerry 10</li> +<li>iOS</li> +<li>Tizen</li> +<li>Windows Phone 7 and 8</li> +<li>Windows</li> +<li>OSX</li> +</ul> + +<h3>Quick Example</h3> +<div class="highlight"><pre><code class="language-" data-lang="">// Android: Returns a random 64-bit integer (as a string, again!) +// The integer is generated on the device's first boot +// +// BlackBerry: Returns the PIN number of the device +// This is a nine-digit unique integer (as a string, though!) +// +// iPhone: (Paraphrased from the UIDevice Class documentation) +// Returns the [UIDevice identifierForVendor] UUID which is unique and the same for all apps installed by the same vendor. However the UUID can be different if the user deletes all apps from the vendor and then reinstalls it. +// Windows Phone 7 : Returns a hash of device+current user, +// if the user is not defined, a guid is generated and will persist until the app is uninstalled +// Tizen: returns the device IMEI (International Mobile Equipment Identity or IMEI is a number +// unique to every GSM and UMTS mobile phone. +var deviceID = device.uuid; +</code></pre></div> +<h3>iOS Quirk</h3> + +<p>The <code>uuid</code> on iOS uses the identifierForVendor property. It is unique to the device across the same vendor, but will be different for different vendors and will change if all apps from the vendor are deleted and then reinstalled. +Refer <a href="https://developer.apple.com/library/ios/documentation/UIKit/Reference/UIDevice_Class/#//apple_ref/occ/instp/UIDevice/identifierForVendor">here</a> for details. +The UUID will be the same if app is restored from a backup or iCloud as it is saved in preferences. Users using older versions of this plugin will still receive the same previous UUID generated by another means as it will be retrieved from preferences.</p> + +<h3>OSX Quirk</h3> + +<p>The <code>uuid</code> on OSX is generated automatically if it does not exist yet and is stored in the <code>standardUserDefaults</code> in the <code>CDVUUID</code> property. </p> + +<h3>Windows Phone 7 and 8 Quirks</h3> + +<p>The <code>uuid</code> for Windows Phone 7 requires the permission +<code>ID_CAP_IDENTITY_DEVICE</code>. Microsoft will likely deprecate this +property soon. If the capability is not available, the application +generates a persistent guid that is maintained for the duration of the +application's installation on the device.</p> + +<h2>device.version</h2> + +<p>Get the operating system version.</p> +<div class="highlight"><pre><code class="language-" data-lang="">var string = device.version; +</code></pre></div> +<h3>Supported Platforms</h3> + +<ul> +<li>Android 2.1+</li> +<li>BlackBerry 10</li> +<li>Browser</li> +<li>iOS</li> +<li>Tizen</li> +<li>Windows Phone 7 and 8</li> +<li>Windows</li> +<li>OSX</li> +</ul> + +<h3>Quick Example</h3> +<div class="highlight"><pre><code class="language-" data-lang="">// Android: Froyo OS would return "2.2" +// Eclair OS would return "2.1", "2.0.1", or "2.0" +// Version can also return update level "2.1-update1" +// +// BlackBerry: Torch 9800 using OS 6.0 would return "6.0.0.600" +// +// Browser: Returns version number for the browser +// +// iPhone: iOS 3.2 returns "3.2" +// +// Windows Phone 7: returns current OS version number, ex. on Mango returns 7.10.7720 +// Windows 8: return the current OS version, ex on Windows 8.1 returns 6.3.9600.16384 +// Tizen: returns "TIZEN_20120425_2" +// OSX: El Capitan would return "10.11.2" +// +var deviceVersion = device.version; +</code></pre></div> +<h2>device.manufacturer</h2> + +<p>Get the device's manufacturer.</p> +<div class="highlight"><pre><code class="language-" data-lang="">var string = device.manufacturer; +</code></pre></div> +<h3>Supported Platforms</h3> + +<ul> +<li>Android </li> +<li>BlackBerry 10</li> +<li>iOS</li> +<li>Windows Phone 7 and 8</li> +<li>Windows</li> +</ul> + +<h3>Quick Example</h3> +<div class="highlight"><pre><code class="language-" data-lang="">// Android: Motorola XT1032 would return "motorola" +// BlackBerry: returns "BlackBerry" +// iPhone: returns "Apple" +// +var deviceManufacturer = device.manufacturer; +</code></pre></div> +<h2>device.isVirtual</h2> + +<p>whether the device is running on a simulator.</p> +<div class="highlight"><pre><code class="language-" data-lang="">var isSim = device.isVirtual; +</code></pre></div> +<h3>Supported Platforms</h3> + +<ul> +<li>Android 2.1+</li> +<li>iOS</li> +<li>Windows Phone 8</li> +<li>Windows</li> +<li>OSX </li> +</ul> + +<h3>OSX Quirk</h3> + +<p>The <code>isVirtual</code> property on OS X always returns false.</p> + +<h2>device.serial</h2> + +<p>Get the device hardware serial number (<a href="http://developer.android.com/reference/android/os/Build.html#SERIAL">SERIAL</a>).</p> +<div class="highlight"><pre><code class="language-" data-lang="">var string = device.serial; +</code></pre></div> +<h3>Supported Platforms</h3> + +<ul> +<li>Android</li> +<li>OSX</li> +</ul> + + + </div> + </div> +</div> + +<script defer type="text/javascript" src="/static/js/lib/toc.min.js"></script> +<script defer type="text/javascript" src="/static/js/docs.js"></script> + + <div class="blue-divider"></div> +<footer> + <div class="container" id="footer"> + <div class="row"> + <div class="col-sm-9"> + <h1>More Resources</h1> + <div class="row"> + <div class="col-sm-4"> + <h2>General</h2> + <ul class="nav"> + <li> + <a target="_blank" href="https://projects.apache.org/project.html?cordova">Apache Project Page</a> + </li> + <li> + <a href="https://dist.apache.org/repos/dist/release/cordova/">Source Distribution</a> + </li> + <li> + <a target="_blank" href="http://www.apache.org/licenses/LICENSE-2.0">License</a> + </li> + <li> + <a href="/artwork">Artwork</a> + </li> + </ul> + </div> + <div class="col-sm-4"> + <h2>Development</h2> + <ul class="nav"> + <li><a target="_blank" href="https://github.com/apache?utf8=%E2%9C%93&query=cordova-">Source Code</a></li> + <li><a target="_blank" href="https://issues.apache.org/jira/browse/CB/">Issue Tracker</a></li> + <li><a target="_blank" href="http://stackoverflow.com/questions/tagged/cordova">Stack Overflow</a></li> + <li><a href="/contact">Mailing List</a></li> + </ul> + </div> + <div class="col-sm-4"> + <h2>Apache Software Foundation</h2> + <ul class="nav"> + <li> + <a target="_blank" href="http://www.apache.org/">About ASF</a> + </li> + <li> + <a target="_blank" href="http://www.apache.org/foundation/sponsorship.html">Become a Sponsor</a> + </li> + <li> + <a target="_blank" href="http://www.apache.org/foundation/thanks.html">Thanks</a> + </li> + <li> + <a target="_blank" href="http://www.apache.org/security/">Security</a> + </li> + </ul> + </div> + </div> + </div> + <div class="col-sm-3"> + <h1>Contribute</h1> + <p style="padding-top:20px"><strong>Help Cordova move forward!</strong></p> + <p>Report bugs, improve the docs, or contribute to the code.</p> + <a href="/contribute" class="btn btn-lg btn-primary"> + Learn More + </a> + <p style="padding-top:20px"> <a href="https://twitter.com/apachecordova" class="twitter-follow-button" data-show-count="false">Follow @apachecordova</a></p> + <script async defer src="https://slack.cordova.io/slackin.js"></script> + </div> + </div> + <p class="copyright_text"> + Copyright © 2012, 2013, 2015 The Apache Software Foundation, Licensed under the <a target="_blank" href="http://www.apache.org/licenses/LICENSE-2.0">Apache License, Version 2.0</a>.<br/> + Apache and the Apache feather logos are <a target="_blank" href="http://www.apache.org/foundation/marks/list/">trademarks</a> of The Apache Software Foundation. + </p> + <a class="closing" href="#top"></a> + </div> +</footer> + +<script defer type="text/javascript" src="/static/js/index.js"></script> +<script defer type="text/javascript" src="/static/js/twitter.js"></script> + + <script> + (function(i,s,o,g,r,a,m){i['GoogleAnalyticsObject']=r;i[r]=i[r]||function(){ + (i[r].q=i[r].q||[]).push(arguments)},i[r].l=1*new Date();a=s.createElement(o), + m=s.getElementsByTagName(o)[0];a.async=1;a.src=g;m.parentNode.insertBefore(a,m) + })(window,document,'script','//www.google-analytics.com/analytics.js','ga'); + ga('create', 'UA-64283057-3', 'auto'); + ga('send', 'pageview'); +</script> + +</body> +</html>
--------------------------------------------------------------------- To unsubscribe, e-mail: commits-unsubscr...@cordova.apache.org For additional commands, e-mail: commits-h...@cordova.apache.org