Added: cordova/site/public/docs/en/6.x/cordova-plugin-contacts/index.html URL: http://svn.apache.org/viewvc/cordova/site/public/docs/en/6.x/cordova-plugin-contacts/index.html?rev=1734016&view=auto ============================================================================== --- cordova/site/public/docs/en/6.x/cordova-plugin-contacts/index.html (added) +++ cordova/site/public/docs/en/6.x/cordova-plugin-contacts/index.html Tue Mar 8 01:36:30 2016 @@ -0,0 +1,3560 @@ +<!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> + + Apache Cordova + + </title> + + <link rel="SHORTCUT ICON" href="/favicon.ico"/> + <link rel="canonical" href="https://cordova.apache.org/docs/en/6.x/cordova-plugin-contacts/";> + + <!-- CSS --> + <link rel="stylesheet" type="text/css" href="/static/css/main.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]> + <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="../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="../cordova-plugin-battery-status/index.html"> + Battery Status + </a> + + + + + + + </li> + + + + + + <li> + + <a class="" href="../cordova-plugin-camera/index.html"> + Camera + </a> + + + + + + + </li> + + + + + + <li> + + <a class="" href="../cordova-plugin-console/index.html"> + Console + </a> + + + + + + + </li> + + + + + + <li> + + <a class="this-page" href="../cordova-plugin-contacts/index.html"> + Contacts + </a> + + + + <div id="page-toc" class="page-toc"></div> + + + </li> + + + + + + <li> + + <a class="" href="../cordova-plugin-device/index.html"> + Device + </a> + + + + + + + </li> + + + + + + <li> + + <a class="" href="../cordova-plugin-device-motion/index.html"> + Device Motion + </a> + + + + + + + </li> + + + + + + <li> + + <a class="" href="../cordova-plugin-device-orientation/index.html"> + Device Orientation + </a> + + + + + + + </li> + + + + + + <li> + + <a class="" href="../cordova-plugin-dialogs/index.html"> + Dialogs + </a> + + + + + + + </li> + + + + + + <li> + + <a class="" href="../cordova-plugin-file/index.html"> + File + </a> + + + + + + + </li> + + + + + + <li> + + <a class="" href="../cordova-plugin-file-transfer/index.html"> + File Transfer + </a> + + + + + + + </li> + + + + + + <li> + + <a class="" href="../cordova-plugin-geolocation/index.html"> + Geolocation + </a> + + + + + + + </li> + + + + + + <li> + + <a class="" href="../cordova-plugin-globalization/index.html"> + Globalization + </a> + + + + + + + </li> + + + + + + <li> + + <a class="" href="../cordova-plugin-inappbrowser/index.html"> + Inappbrowser + </a> + + + + + + + </li> + + + + + + <li> + + <a class="" href="../cordova-plugin-media/index.html"> + Media + </a> + + + + + + + </li> + + + + + + <li> + + <a class="" href="../cordova-plugin-media-capture/index.html"> + Media Capture + </a> + + + + + + + </li> + + + + + + <li> + + <a class="" href="../cordova-plugin-network-information/index.html"> + Network Information + </a> + + + + + + + </li> + + + + + + <li> + + <a class="" href="../cordova-plugin-splashscreen/index.html"> + Splashscreen + </a> + + + + + + + </li> + + + + + + <li> + + <a class="" href="../cordova-plugin-vibration/index.html"> + Vibration + </a> + + + + + + + </li> + + + + + + <li> + + <a class="" href="../cordova-plugin-statusbar/index.html"> + Statusbar + </a> + + + + + + + </li> + + + + + + <li> + + <a class="" href="../cordova-plugin-whitelist/index.html"> + Whitelist + </a> + + + + + + + </li> + + + + + + <li> + + <a class="" href="../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"> + + <!-- ToC Dropdown (for XS and SM sizes only) --> + <div class="toc-dropdown content-header visible-xs-block visible-sm-block"> + <div class="dropdown"> + <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="../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="../cordova-plugin-battery-status/index.html"> + Battery Status + </a> +</li> + + + + +<li> + <a class="" href="../cordova-plugin-camera/index.html"> + Camera + </a> +</li> + + + + +<li> + <a class="" href="../cordova-plugin-console/index.html"> + Console + </a> +</li> + + + + +<li> + <a class="this-page" href="../cordova-plugin-contacts/index.html"> + Contacts + </a> +</li> + + + + +<li> + <a class="" href="../cordova-plugin-device/index.html"> + Device + </a> +</li> + + + + +<li> + <a class="" href="../cordova-plugin-device-motion/index.html"> + Device Motion + </a> +</li> + + + + +<li> + <a class="" href="../cordova-plugin-device-orientation/index.html"> + Device Orientation + </a> +</li> + + + + +<li> + <a class="" href="../cordova-plugin-dialogs/index.html"> + Dialogs + </a> +</li> + + + + +<li> + <a class="" href="../cordova-plugin-file/index.html"> + File + </a> +</li> + + + + +<li> + <a class="" href="../cordova-plugin-file-transfer/index.html"> + File Transfer + </a> +</li> + + + + +<li> + <a class="" href="../cordova-plugin-geolocation/index.html"> + Geolocation + </a> +</li> + + + + +<li> + <a class="" href="../cordova-plugin-globalization/index.html"> + Globalization + </a> +</li> + + + + +<li> + <a class="" href="../cordova-plugin-inappbrowser/index.html"> + Inappbrowser + </a> +</li> + + + + +<li> + <a class="" href="../cordova-plugin-media/index.html"> + Media + </a> +</li> + + + + +<li> + <a class="" href="../cordova-plugin-media-capture/index.html"> + Media Capture + </a> +</li> + + + + +<li> + <a class="" href="../cordova-plugin-network-information/index.html"> + Network Information + </a> +</li> + + + + +<li> + <a class="" href="../cordova-plugin-splashscreen/index.html"> + Splashscreen + </a> +</li> + + + + +<li> + <a class="" href="../cordova-plugin-vibration/index.html"> + Vibration + </a> +</li> + + + + +<li> + <a class="" href="../cordova-plugin-statusbar/index.html"> + Statusbar + </a> +</li> + + + + +<li> + <a class="" href="../cordova-plugin-whitelist/index.html"> + Whitelist + </a> +</li> + + + + +<li> + <a class="" href="../cordova-plugin-legacy-whitelist/index.html"> + Legacy Whitelist + </a> +</li> + + + + + + + + + + + + + + </ul> + </div> + </div> + + <div class="content-header"> + + <a class="edit" href="https://github.com/apache/cordova-plugin-contacts/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/cordova-plugin-contacts/index.html" class=" + + + " + > + + Deutsch + + </a> + </li> + + + + + + + + + + + + + + <li> + <a href="/docs/en/6.x/cordova-plugin-contacts/index.html" class=" + + + " + > + + <span class="selected"> + English + </span> + + </a> + </li> + + + + + + + + + + + + + + <li> + <a href="/docs/es/6.x/cordova-plugin-contacts/index.html" class=" + + + " + > + + Español + + </a> + </li> + + + + + + + + + + + + + + <li> + <a href="/docs/fr/6.x/cordova-plugin-contacts/index.html" class=" + + + " + > + + Français + + </a> + </li> + + + + + + + + + + + + + + <li> + <a href="/docs/it/6.x/cordova-plugin-contacts/index.html" class=" + + + " + > + + Italiano + + </a> + </li> + + + + + + + + + + + + + + <li> + <a href="/docs/ja/6.x/cordova-plugin-contacts/index.html" class=" + + + " + > + + æ¥æ¬èª + + </a> + </li> + + + + + + + + + + + + + + <li> + <a href="/docs/ko/6.x/cordova-plugin-contacts/index.html" class=" + + + " + > + + íêµì´ + + </a> + </li> + + + + + + + + + + + + + + <li> + <a href="/docs/pl/6.x/cordova-plugin-contacts/index.html" class=" + + + " + > + + Polski + + </a> + </li> + + + + + + + + + + + + + + <li> + <a href="/docs/ru/6.x/cordova-plugin-contacts/index.html" class=" + + + " + > + + Ð ÑÑÑкий + + </a> + </li> + + + + + + + + + + + + + + <li> + <a href="/docs/sl/6.x/cordova-plugin-contacts/index.html" class=" + + + " + > + + Slovene + + </a> + </li> + + + + + + + + + + + + + + <li> + <a href="/docs/zh/6.x/cordova-plugin-contacts/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/cordova-plugin-contacts/index.html"> + + + dev + + + + </a> + </li> + + <li> + + + + + + + + + <a href="/docs/en/6.x/cordova-plugin-contacts/index.html"> + + <span class="selected"> + + 6.x + + (Latest) + + + </span> + + </a> + </li> + + <li> + + + + + + + + + <a href="/docs/en/5.4.0/cordova-plugin-contacts/index.html"> + + + 5.4.0 + + + + </a> + </li> + + <li> + + + + + + + + + <a href="/docs/en/5.1.1/cordova-plugin-contacts/index.html"> + + + 5.1.1 + + + + </a> + </li> + + <li> + + + + + + + + + <a href="/docs/en/5.0.0/cordova-plugin-contacts/index.html"> + + + 5.0.0 + + + + </a> + </li> + + <li> + + + + + + + + + <a href="/docs/en/4.0.0/cordova-plugin-contacts/index.html"> + + + 4.0.0 + + + + </a> + </li> + + <li> + + + + + + + + + <a href="/docs/en/3.6.0/cordova-plugin-contacts/index.html"> + + + 3.6.0 + + + + </a> + </li> + + <li> + + + + + + + + + <a href="/docs/en/3.5.0/cordova-plugin-contacts/index.html"> + + + 3.5.0 + + + + </a> + </li> + + <li> + + + + + + + + + <a href="/docs/en/3.4.0/cordova-plugin-contacts/index.html"> + + + 3.4.0 + + + + </a> + </li> + + <li> + + + + + + + + + <a href="/docs/en/3.3.0/cordova-plugin-contacts/index.html"> + + + 3.3.0 + + + + </a> + </li> + + <li> + + + + + + + + + <a href="/docs/en/3.2.0/cordova-plugin-contacts/index.html"> + + + 3.2.0 + + + + </a> + </li> + + <li> + + + + + + + + + <a href="/docs/en/3.1.0/cordova-plugin-contacts/index.html"> + + + 3.1.0 + + + + </a> + </li> + + <li> + + + + + + + + + <a href="/docs/en/3.0.0/cordova-plugin-contacts/index.html"> + + + 3.0.0 + + + + </a> + </li> + + <li> + + + + + + + + + <a href="/docs/en/2.9.0/cordova-plugin-contacts/index.html"> + + + 2.9.0 + + + + </a> + </li> + + <li> + + + + + + + + + <a href="/docs/en/2.8.0/cordova-plugin-contacts/index.html"> + + + 2.8.0 + + + + </a> + </li> + + <li> + + + + + + + + + <a href="/docs/en/2.7.0/cordova-plugin-contacts/index.html"> + + + 2.7.0 + + + + </a> + </li> + + <li> + + + + + + + + + <a href="/docs/en/2.6.0/cordova-plugin-contacts/index.html"> + + + 2.6.0 + + + + </a> + </li> + + <li> + + + + + + + + + <a href="/docs/en/2.5.0/cordova-plugin-contacts/index.html"> + + + 2.5.0 + + + + </a> + </li> + + <li> + + + + + + + + + <a href="/docs/en/2.4.0/cordova-plugin-contacts/index.html"> + + + 2.4.0 + + + + </a> + </li> + + <li> + + + + + + + + + <a href="/docs/en/2.3.0/cordova-plugin-contacts/index.html"> + + + 2.3.0 + + + + </a> + </li> + + <li> + + + + + + + + + <a href="/docs/en/2.2.0/cordova-plugin-contacts/index.html"> + + + 2.2.0 + + + + </a> + </li> + + <li> + + + + + + + + + <a href="/docs/en/2.1.0/cordova-plugin-contacts/index.html"> + + + 2.1.0 + + + + </a> + </li> + + <li> + + + + + + + + + <a href="/docs/en/2.0.0/cordova-plugin-contacts/index.html"> + + + 2.0.0 + + + + </a> + </li> + + <li> + + + + + + + + + <a href="/docs/en/1.9.0/cordova-plugin-contacts/index.html"> + + + 1.9.0 + + + + </a> + </li> + + <li> + + + + + + + + + <a href="/docs/en/1.8.1/cordova-plugin-contacts/index.html"> + + + 1.8.1 + + + + </a> + </li> + + <li> + + + + + + + + + <a href="/docs/en/1.8.0/cordova-plugin-contacts/index.html"> + + + 1.8.0 + + + + </a> + </li> + + <li> + + + + + + + + + <a href="/docs/en/1.7.0/cordova-plugin-contacts/index.html"> + + + 1.7.0 + + + + </a> + </li> + + <li> + + + + + + + + + <a href="/docs/en/1.6.1/cordova-plugin-contacts/index.html"> + + + 1.6.1 + + + + </a> + </li> + + <li> + + + + + + + + + <a href="/docs/en/1.6.0/cordova-plugin-contacts/index.html"> + + + 1.6.0 + + + + </a> + </li> + + <li> + + + + + + + + + <a href="/docs/en/1.5.0/cordova-plugin-contacts/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-contacts/releases";> + Other versions are on GitHub. + </a> + </div> + + + + <div id="page-toc-source"> + <!--- +# 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-contacts";><img src="https://travis-ci.org/apache/cordova-plugin-contacts.svg?branch=master"; alt="Build Status"></a></p> + +<h1>cordova-plugin-contacts</h1> + +<p>This plugin defines a global <code class="prettyprint">navigator.contacts</code> object, which provides access to the device contacts database.</p> + +<p>Although the object is attached to the global scoped <code class="prettyprint">navigator</code>, 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); +function onDeviceReady() { + console.log(navigator.contacts); +} +</code></pre></div> +<p><strong>WARNING</strong>: Collection and use of contact data raises +important privacy issues. Your app's privacy policy should discuss +how the app uses contact data and whether it is shared with any other +parties. Contact information is considered sensitive because it +reveals the people with whom a person communicates. Therefore, in +addition to the app's privacy policy, you should strongly consider +providing a just-in-time notice before the app accesses or uses +contact data, if the device operating system doesn't do so +already. That notice should provide the same information noted above, +as well as obtaining the user's permission (e.g., by presenting +choices for <strong>OK</strong> and <strong>No Thanks</strong>). Note that some app +marketplaces may require the app to provide a just-in-time notice and +obtain the user's permission before accessing contact data. A +clear and easy-to-understand user experience surrounding the use of +contact data helps avoid user confusion and perceived misuse of +contact data. For more information, please see the <a href="http://cordova.apache.org/docs/en/latest/guide/appdev/privacy/index.html";>Privacy Guide</a>.</p> + +<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%20Contacts%22%20ORDER%20BY%20priority%20DESC%2C%20summary%20ASC%2C%20updatedDate%20DESC";>Apache Cordova issue tracker</a></p> + +<h2>Installation</h2> + +<p>This requires cordova 5.0+ ( current stable v1.0.0 )</p> +<div class="highlight"><pre><code class="language-text" data-lang="text">cordova plugin add cordova-plugin-contacts +</code></pre></div> +<p>Older versions of cordova can still install via the <strong>deprecated</strong> id ( stale v0.2.16 )</p> +<div class="highlight"><pre><code class="language-text" data-lang="text">cordova plugin add org.apache.cordova.contacts +</code></pre></div> +<p>It is also possible to install via repo url directly ( unstable )</p> +<div class="highlight"><pre><code class="language-text" data-lang="text">cordova plugin add https://github.com/apache/cordova-plugin-contacts.git +</code></pre></div> +<h3>Firefox OS Quirks</h3> + +<p>Create <strong>www/manifest.webapp</strong> as described in +<a href="https://developer.mozilla.org/en-US/Apps/Developing/Manifest";>Manifest Docs</a>. +Add relevant permisions. +There is also a need to change the webapp type to "privileged" - <a href="https://developer.mozilla.org/en-US/Apps/Developing/Manifest#type";>Manifest Docs</a>. +<strong>WARNING</strong>: All privileged apps enforce <a href="https://developer.mozilla.org/en-US/Apps/CSP";>Content Security Policy</a> which forbids inline script. Initialize your application in another way.</p> +<div class="highlight"><pre><code class="language-text" data-lang="text">"type": "privileged", +"permissions": { + "contacts": { + "access": "readwrite", + "description": "Describe why there is a need for such permission" + } +} +</code></pre></div> +<h3>Windows Quirks</h3> + +<p><strong>Prior to Windows 10:</strong> Any contacts returned from <code class="prettyprint">find</code> and <code class="prettyprint">pickContact</code> methods are readonly, so your application cannot modify them. +<code class="prettyprint">find</code> method available only on Windows Phone 8.1 devices.</p> + +<p><strong>Windows 10 and above:</strong> Contacts may be saved and will be saved to app-local contacts storage. Contacts may also be deleted.</p> + +<h3>Windows 8 Quirks</h3> + +<p>Windows 8 Contacts are readonly. Via the Cordova API Contacts are not queryable/searchable, you should inform the user to pick a contact as a call to contacts.pickContact which will open the 'People' app where the user must choose a contact. +Any contacts returned are readonly, so your application cannot modify them.</p> + +<h2>navigator.contacts</h2> + +<h3>Methods</h3> + +<ul> +<li>navigator.contacts.create</li> +<li>navigator.contacts.find</li> +<li>navigator.contacts.pickContact</li> +</ul> + +<h3>Objects</h3> + +<ul> +<li>Contact</li> +<li>ContactName</li> +<li>ContactField</li> +<li>ContactAddress</li> +<li>ContactOrganization</li> +<li>ContactFindOptions</li> +<li>ContactError</li> +<li>ContactFieldType</li> +</ul> + +<h2>navigator.contacts.create</h2> + +<p>The <code class="prettyprint">navigator.contacts.create</code> method is synchronous, and returns a new <code class="prettyprint">Contact</code> object.</p> + +<p>This method does not retain the Contact object in the device contacts +database, for which you need to invoke the <code class="prettyprint">Contact.save</code> method.</p> + +<h3>Supported Platforms</h3> + +<ul> +<li>Android</li> +<li>BlackBerry 10</li> +<li>Firefox OS</li> +<li>iOS</li> +<li>Windows Phone 8</li> +</ul> + +<h3>Example</h3> +<div class="highlight"><pre><code class="language-text" data-lang="text">var myContact = navigator.contacts.create({"displayName": "Test User"}); +</code></pre></div> +<h2>navigator.contacts.find</h2> + +<p>The <code class="prettyprint">navigator.contacts.find</code> method executes asynchronously, querying the +device contacts database and returning an array of <code class="prettyprint">Contact</code> objects. +The resulting objects are passed to the <code class="prettyprint">contactSuccess</code> callback +function specified by the <strong>contactSuccess</strong> parameter.</p> + +<p>The <strong>contactFields</strong> parameter specifies the fields to be used as a +search qualifier. A zero-length <strong>contactFields</strong> parameter is invalid and results in +<code class="prettyprint">ContactError.INVALID_ARGUMENT_ERROR</code>. A <strong>contactFields</strong> value of +<code class="prettyprint">"*"</code> searches all contact fields.</p> + +<p>The <strong>contactFindOptions.filter</strong> string can be used as a search +filter when querying the contacts database. If provided, a +case-insensitive, partial value match is applied to each field +specified in the <strong>contactFields</strong> parameter. If there's a match for +<em>any</em> of the specified fields, the contact is returned. Use <strong>contactFindOptions.desiredFields</strong> +parameter to control which contact properties must be returned back.</p> + +<p>Supported values for both <strong>contactFields</strong> and <strong>contactFindOptions.desiredFields</strong> parameters are enumerated in <a href="#contactfieldtype"><code class="prettyprint">ContactFieldType</code></a> object.</p> + +<h3>Parameters</h3> + +<ul> +<li><p><strong>contactFields</strong>: Contact fields to use as a search qualifier. <em>(DOMString[])</em> [Required]</p></li> +<li><p><strong>contactSuccess</strong>: Success callback function invoked with the array of Contact objects returned from the database. [Required]</p></li> +<li><p><strong>contactError</strong>: Error callback function, invoked when an error occurs. [Optional]</p></li> +<li><p><strong>contactFindOptions</strong>: Search options to filter navigator.contacts. [Optional]</p> + +<p>Keys include:</p> + +<ul> +<li><strong>filter</strong>: The search string used to find navigator.contacts. <em>(DOMString)</em> (Default: <code class="prettyprint">""</code>)</li> +<li><strong>multiple</strong>: Determines if the find operation returns multiple navigator.contacts. <em>(Boolean)</em> (Default: <code class="prettyprint">false</code>)</li> +<li><strong>desiredFields</strong>: Contact fields to be returned back. If specified, the resulting <code class="prettyprint">Contact</code> object only features values for these fields. <em>(DOMString[])</em> [Optional]</li> +<li><strong>hasPhoneNumber</strong>(Android only): Filters the search to only return contacts with a phone number informed. <em>(Boolean)</em> (Default: <code class="prettyprint">false</code>)</li> +</ul></li> +</ul> + +<h3>Supported Platforms</h3> + +<ul> +<li>Android</li> +<li>BlackBerry 10</li> +<li>Firefox OS</li> +<li>iOS</li> +<li>Windows Phone 8</li> +<li>Windows (Windows Phone 8.1 and Windows 10)</li> +</ul> + +<h3>Example</h3> +<div class="highlight"><pre><code class="language-text" data-lang="text">function onSuccess(contacts) { + alert('Found ' + contacts.length + ' contacts.'); +}; + +function onError(contactError) { + alert('onError!'); +}; + +// find all contacts with 'Bob' in any name field +var options = new ContactFindOptions(); +options.filter = "Bob"; +options.multiple = true; +options.desiredFields = [navigator.contacts.fieldType.id]; +options.hasPhoneNumber = true; +var fields = [navigator.contacts.fieldType.displayName, navigator.contacts.fieldType.name]; +navigator.contacts.find(fields, onSuccess, onError, options); +</code></pre></div> +<h3>Windows Quirks</h3> + +<ul> +<li><code class="prettyprint">__contactFields__</code> is not supported and will be ignored. <code class="prettyprint">find</code> method will always attempt to match the name, email address, or phone number of a contact.</li> +</ul> + +<h2>navigator.contacts.pickContact</h2> + +<p>The <code class="prettyprint">navigator.contacts.pickContact</code> method launches the Contact Picker to select a single contact. +The resulting object is passed to the <code class="prettyprint">contactSuccess</code> callback +function specified by the <strong>contactSuccess</strong> parameter.</p> + +<h3>Parameters</h3> + +<ul> +<li><p><strong>contactSuccess</strong>: Success callback function invoked with the single Contact object. [Required]</p></li> +<li><p><strong>contactError</strong>: Error callback function, invoked when an error occurs. [Optional]</p></li> +</ul> + +<h3>Supported Platforms</h3> + +<ul> +<li>Android</li> +<li>iOS</li> +<li>Windows Phone 8</li> +<li>Windows</li> +</ul> + +<h3>Example</h3> +<div class="highlight"><pre><code class="language-text" data-lang="text">navigator.contacts.pickContact(function(contact){ + console.log('The following contact has been selected:' + JSON.stringify(contact)); + },function(err){ + console.log('Error: ' + err); + }); +</code></pre></div> +<h3>Android Quirks</h3> + +<p>This plugin launches an external Activity for picking contacts. See the +<a href="http://cordova.apache.org/docs/en/latest/guide/platforms/android/index.html#lifecycle-guide";>Android Lifecycle Guide</a> +for an explanation of how this affects your application. If the plugin returns +its result in the <code class="prettyprint">resume</code> event, then you must first wrap the returned object +in a <code class="prettyprint">Contact</code> object before using it. Here is an example:</p> +<div class="highlight"><pre><code class="language-javascript" data-lang="javascript"><span class="kd">function</span> <span class="nx">onResume</span><span class="p">(</span><span class="nx">resumeEvent</span><span class="p">)</span> <span class="p">{</span> + <span class="k">if</span><span class="p">(</span><span class="nx">resumeEvent</span><span class="p">.</span><span class="nx">pendingResult</span><span class="p">)</span> <span class="p">{</span> + <span class="k">if</span><span class="p">(</span><span class="nx">resumeEvent</span><span class="p">.</span><span class="nx">pendingResult</span><span class="p">.</span><span class="nx">pluginStatus</span> <span class="o">===</span> <span class="s2">"OK"</span><span class="p">)</span> <span class="p">{</span> + <span class="kd">var</span> <span class="nx">contact</span> <span class="o">=</span> <span class="nx">navigator</span><span class="p">.</span><span class="nx">contacts</span><span class="p">.</span><span class="nx">create</span><span class="p">(</span><span class="nx">resumeEvent</span><span class="p">.</span><span class="nx">pendingResult</span><span class="p">.</span><span class="nx">result</span><span class="p">);</span> + <span class="nx">successCallback</span><span class="p">(</span><span class="nx">contact</span><span class="p">);</span> + <span class="p">}</span> <span class="k">else</span> <span class="p">{</span> + <span class="nx">failCallback</span><span class="p">(</span><span class="nx">resumeEvent</span><span class="p">.</span><span class="nx">pendingResult</span><span class="p">.</span><span class="nx">result</span><span class="p">);</span> + <span class="p">}</span> + <span class="p">}</span> +<span class="p">}</span> +</code></pre></div> +<h2>Contact</h2> + +<p>The <code class="prettyprint">Contact</code> object represents a user's contact. Contacts can be +created, stored, or removed from the device contacts database. +Contacts can also be retrieved (individually or in bulk) from the +database by invoking the <code class="prettyprint">navigator.contacts.find</code> method.</p> + +<p><strong>NOTE</strong>: Not all of the contact fields listed above are supported on +every device platform. Please check each platform's <em>Quirks</em> section +for details.</p> + +<h3>Properties</h3> + +<ul> +<li><p><strong>id</strong>: A globally unique identifier. <em>(DOMString)</em></p></li> +<li><p><strong>displayName</strong>: The name of this Contact, suitable for display to end users. <em>(DOMString)</em></p></li> +<li><p><strong>name</strong>: An object containing all components of a persons name. <em>(ContactName)</em></p></li> +<li><p><strong>nickname</strong>: A casual name by which to address the contact. <em>(DOMString)</em></p></li> +<li><p><strong>phoneNumbers</strong>: An array of all the contact's phone numbers. <em>(ContactField[])</em></p></li> +<li><p><strong>emails</strong>: An array of all the contact's email addresses. <em>(ContactField[])</em></p></li> +<li><p><strong>addresses</strong>: An array of all the contact's addresses. <em>(ContactAddress[])</em></p></li> +<li><p><strong>ims</strong>: An array of all the contact's IM addresses. <em>(ContactField[])</em></p></li> +<li><p><strong>organizations</strong>: An array of all the contact's organizations. <em>(ContactOrganization[])</em></p></li> +<li><p><strong>birthday</strong>: The birthday of the contact. <em>(Date)</em></p></li> +<li><p><strong>note</strong>: A note about the contact. <em>(DOMString)</em></p></li> +<li><p><strong>photos</strong>: An array of the contact's photos. <em>(ContactField[])</em></p></li> +<li><p><strong>categories</strong>: An array of all the user-defined categories associated with the contact. <em>(ContactField[])</em></p></li> +<li><p><strong>urls</strong>: An array of web pages associated with the contact. <em>(ContactField[])</em></p></li> +</ul> + +<h3>Methods</h3> + +<ul> +<li><p><strong>clone</strong>: Returns a new <code class="prettyprint">Contact</code> object that is a deep copy of the calling object, with the <code class="prettyprint">id</code> property set to <code class="prettyprint">null</code>.</p></li> +<li><p><strong>remove</strong>: Removes the contact from the device contacts database, otherwise executes an error callback with a <code class="prettyprint">ContactError</code> object.</p></li> +<li><p><strong>save</strong>: Saves a new contact to the device contacts database, or updates an existing contact if a contact with the same <strong>id</strong> already exists.</p></li> +</ul> + +<h3>Supported Platforms</h3> + +<ul> +<li>Amazon Fire OS</li> +<li>Android</li> +<li>BlackBerry 10</li> +<li>Firefox OS</li> +<li>iOS</li> +<li>Windows Phone 8</li> +<li>Windows</li> +</ul> + +<h3>Save Example</h3> +<div class="highlight"><pre><code class="language-text" data-lang="text">function onSuccess(contact) { + alert("Save Success"); +}; + +function onError(contactError) { + alert("Error = " + contactError.code); +}; + +// create a new contact object +var contact = navigator.contacts.create(); +contact.displayName = "Plumber"; +contact.nickname = "Plumber"; // specify both to support all devices + +// populate some fields +var name = new ContactName(); +name.givenName = "Jane"; +name.familyName = "Doe"; +contact.name = name; + +// save to device +contact.save(onSuccess,onError); +</code></pre></div> +<h3>Clone Example</h3> +<div class="highlight"><pre><code class="language-text" data-lang="text"> // clone the contact object + var clone = contact.clone(); + clone.name.givenName = "John"; + console.log("Original contact name = " + contact.name.givenName); + console.log("Cloned contact name = " + clone.name.givenName); +</code></pre></div> +<h3>Remove Example</h3> +<div class="highlight"><pre><code class="language-text" data-lang="text">function onSuccess() { + alert("Removal Success"); +}; + +function onError(contactError) { + alert("Error = " + contactError.code); +}; + +// remove the contact from the device +contact.remove(onSuccess,onError); +</code></pre></div> +<h3>Android 2.X Quirks</h3> + +<ul> +<li><strong>categories</strong>: Not supported on Android 2.X devices, returning <code class="prettyprint">null</code>.</li> +</ul> + +<h3>BlackBerry 10 Quirks</h3> + +<ul> +<li><strong>id</strong>: Assigned by the device when saving the contact.</li> +</ul> + +<h3>FirefoxOS Quirks</h3> + +<ul> +<li><p><strong>categories</strong>: Partially supported. Fields <strong>pref</strong> and <strong>type</strong> are returning <code class="prettyprint">null</code></p></li> +<li><p><strong>ims</strong>: Not supported</p></li> +<li><p><strong>photos</strong>: Not supported</p></li> +</ul> + +<h3>iOS Quirks</h3> + +<ul> +<li><p><strong>displayName</strong>: Not supported on iOS, returning <code class="prettyprint">null</code> unless there is no <code class="prettyprint">ContactName</code> specified, in which case it returns the composite name, <strong>nickname</strong> or <code class="prettyprint">""</code>, respectively.</p></li> +<li><p><strong>birthday</strong>: Must be input as a JavaScript <code class="prettyprint">Date</code> object, the same way it is returned.</p></li> +<li><p><strong>photos</strong>: Returns a File URL to the image, which is stored in the application's temporary directory. Contents of the temporary directory are removed when the application exits.</p></li> +<li><p><strong>categories</strong>: This property is currently not supported, returning <code class="prettyprint">null</code>.</p></li> +</ul> + +<h3>Windows Phone 8 Quirks</h3> + +<ul> +<li><p><strong>displayName</strong>: When creating a contact, the value provided for the display name parameter differs from the display name retrieved when finding the contact.</p></li> +<li><p><strong>urls</strong>: When creating a contact, users can input and save more than one web address, but only one is available when searching the contact.</p></li> +<li><p><strong>phoneNumbers</strong>: The <em>pref</em> option is not supported. The <em>type</em> is not supported in a <em>find</em> operation. Only one <code class="prettyprint">phoneNumber</code> is allowed for each <em>type</em>.</p></li> +<li><p><strong>emails</strong>: The <em>pref</em> option is not supported. Home and personal references same email entry. Only one entry is allowed for each <em>type</em>.</p></li> +<li><p><strong>addresses</strong>: Supports only work, and home/personal <em>type</em>. The home and personal <em>type</em> reference the same address entry. Only one entry is allowed for each <em>type</em>.</p></li> +<li><p><strong>organizations</strong>: Only one is allowed, and does not support the <em>pref</em>, <em>type</em>, and <em>department</em> attributes.</p></li> +<li><p><strong>note</strong>: Not supported, returning <code class="prettyprint">null</code>.</p></li> +<li><p><strong>ims</strong>: Not supported, returning <code class="prettyprint">null</code>.</p></li> +<li><p><strong>birthdays</strong>: Not supported, returning <code class="prettyprint">null</code>.</p></li> +<li><p><strong>categories</strong>: Not supported, returning <code class="prettyprint">null</code>.</p></li> +<li><p><strong>remove</strong>: Method is not supported</p></li> +</ul> + +<h3>Windows Quirks</h3> + +<ul> +<li><p><strong>photos</strong>: Returns a File URL to the image, which is stored in the application's temporary directory.</p></li> +<li><p><strong>birthdays</strong>: Not supported, returning <code class="prettyprint">null</code>.</p></li> +<li><p><strong>categories</strong>: Not supported, returning <code class="prettyprint">null</code>.</p></li> +<li><p><strong>remove</strong>: Method is only supported in Windows 10 or above.</p></li> +</ul> + +<h2>ContactAddress</h2> + +<p>The <code class="prettyprint">ContactAddress</code> object stores the properties of a single address +of a contact. A <code class="prettyprint">Contact</code> object may include more than one address in +a <code class="prettyprint">ContactAddress[]</code> array.</p> + +<h3>Properties</h3> + +<ul> +<li><p><strong>pref</strong>: Set to <code class="prettyprint">true</code> if this <code class="prettyprint">ContactAddress</code> contains the user's preferred value. <em>(boolean)</em></p></li> +<li><p><strong>type</strong>: A string indicating what type of field this is, <em>home</em> for example. <em>(DOMString)</em></p></li> +<li><p><strong>formatted</strong>: The full address formatted for display. <em>(DOMString)</em></p></li> +<li><p><strong>streetAddress</strong>: The full street address. <em>(DOMString)</em></p></li> +<li><p><strong>locality</strong>: The city or locality. <em>(DOMString)</em></p></li> +<li><p><strong>region</strong>: The state or region. <em>(DOMString)</em></p></li> +<li><p><strong>postalCode</strong>: The zip code or postal code. <em>(DOMString)</em></p></li> +<li><p><strong>country</strong>: The country name. <em>(DOMString)</em></p></li> +</ul> + +<h3>Supported Platforms</h3> + +<ul> +<li>Amazon Fire OS</li> +<li>Android</li> +<li>BlackBerry 10</li> +<li>Firefox OS</li> +<li>iOS</li> +<li>Windows Phone 8</li> +<li>Windows</li> +</ul> + +<h3>Example</h3> +<div class="highlight"><pre><code class="language-text" data-lang="text">// display the address information for all contacts + +function onSuccess(contacts) { + for (var i = 0; i < contacts.length; i++) { + for (var j = 0; j < contacts[i].addresses.length; j++) { + alert("Pref: " + contacts[i].addresses[j].pref + "\n" + + "Type: " + contacts[i].addresses[j].type + "\n" + + "Formatted: " + contacts[i].addresses[j].formatted + "\n" + + "Street Address: " + contacts[i].addresses[j].streetAddress + "\n" + + "Locality: " + contacts[i].addresses[j].locality + "\n" + + "Region: " + contacts[i].addresses[j].region + "\n" + + "Postal Code: " + contacts[i].addresses[j].postalCode + "\n" + + "Country: " + contacts[i].addresses[j].country); + } + } +}; + +function onError(contactError) { + alert('onError!'); +}; + +// find all contacts +var options = new ContactFindOptions(); +options.filter = ""; +options.multiple = true; +var filter = ["displayName", "addresses"]; +navigator.contacts.find(filter, onSuccess, onError, options); +</code></pre></div> +<h3>Android 2.X Quirks</h3> + +<ul> +<li><strong>pref</strong>: Not supported, returning <code class="prettyprint">false</code> on Android 2.X devices.</li> +</ul> + +<h3>BlackBerry 10 Quirks</h3> + +<ul> +<li><p><strong>pref</strong>: Not supported on BlackBerry devices, returning <code class="prettyprint">false</code>.</p></li> +<li><p><strong>type</strong>: Partially supported. Only one each of <em>Work</em> and <em>Home</em> type addresses can be stored per contact.</p></li> +<li><p><strong>formatted</strong>: Partially supported. Returns a concatenation of all BlackBerry address fields.</p></li> +<li><p><strong>streetAddress</strong>: Supported. Returns a concatenation of BlackBerry <strong>address1</strong> and <strong>address2</strong> address fields.</p></li> +<li><p><strong>locality</strong>: Supported. Stored in BlackBerry <strong>city</strong> address field.</p></li> +<li><p><strong>region</strong>: Supported. Stored in BlackBerry <strong>stateProvince</strong> address field.</p></li> +<li><p><strong>postalCode</strong>: Supported. Stored in BlackBerry <strong>zipPostal</strong> address field.</p></li> +<li><p><strong>country</strong>: Supported.</p></li> +</ul> + +<h3>FirefoxOS Quirks</h3> + +<ul> +<li><strong>formatted</strong>: Currently not supported</li> +</ul> + +<h3>iOS Quirks</h3> + +<ul> +<li><p><strong>pref</strong>: Not supported on iOS devices, returning <code class="prettyprint">false</code>.</p></li> +<li><p><strong>formatted</strong>: Currently not supported.</p></li> +</ul> + +<h3>Windows Quirks</h3> + +<ul> +<li><strong>pref</strong>: Not supported</li> +</ul> + +<h2>ContactError</h2> + +<p>The <code class="prettyprint">ContactError</code> object is returned to the user through the +<code class="prettyprint">contactError</code> callback function when an error occurs.</p> + +<h3>Properties</h3> + +<ul> +<li><strong>code</strong>: One of the predefined error codes listed below.</li> +</ul> + +<h3>Constants</h3> + +<ul> +<li><code class="prettyprint">ContactError.UNKNOWN_ERROR</code> (code 0)</li> +<li><code class="prettyprint">ContactError.INVALID_ARGUMENT_ERROR</code> (code 1)</li> +<li><code class="prettyprint">ContactError.TIMEOUT_ERROR</code> (code 2)</li> +<li><code class="prettyprint">ContactError.PENDING_OPERATION_ERROR</code> (code 3)</li> +<li><code class="prettyprint">ContactError.IO_ERROR</code> (code 4)</li> +<li><code class="prettyprint">ContactError.NOT_SUPPORTED_ERROR</code> (code 5)</li> +<li><code class="prettyprint">ContactError.OPERATION_CANCELLED_ERROR</code> (code 6)</li> +<li><code class="prettyprint">ContactError.PERMISSION_DENIED_ERROR</code> (code 20)</li> +</ul> + +<h2>ContactField</h2> + +<p>The <code class="prettyprint">ContactField</code> object is a reusable component that represents +contact fields generically. Each <code class="prettyprint">ContactField</code> object contains a +<code class="prettyprint">value</code>, <code class="prettyprint">type</code>, and <code class="prettyprint">pref</code> property. A <code class="prettyprint">Contact</code> object stores +several properties in <code class="prettyprint">ContactField[]</code> arrays, such as phone numbers +and email addresses.</p> + +<p>In most instances, there are no pre-determined values for a +<code class="prettyprint">ContactField</code> object's <strong>type</strong> attribute. For example, a phone +number can specify <strong>type</strong> values of <em>home</em>, <em>work</em>, <em>mobile</em>, +<em>iPhone</em>, or any other value that is supported by a particular device +platform's contact database. However, for the <code class="prettyprint">Contact</code> <strong>photos</strong> +field, the <strong>type</strong> field indicates the format of the returned image: +<strong>url</strong> when the <strong>value</strong> attribute contains a URL to the photo +image, or <em>base64</em> when the <strong>value</strong> contains a base64-encoded image +string.</p> + +<h3>Properties</h3> + +<ul> +<li><p><strong>type</strong>: A string that indicates what type of field this is, <em>home</em> for example. <em>(DOMString)</em></p></li> +<li><p><strong>value</strong>: The value of the field, such as a phone number or email address. <em>(DOMString)</em></p></li> +<li><p><strong>pref</strong>: Set to <code class="prettyprint">true</code> if this <code class="prettyprint">ContactField</code> contains the user's preferred value. <em>(boolean)</em></p></li> +</ul> + +<h3>Supported Platforms</h3> + +<ul> +<li>Amazon Fire OS</li> +<li>Android</li> +<li>BlackBerry 10</li> +<li>Firefox OS</li> +<li>iOS</li> +<li>Windows Phone 8</li> +<li>Windows</li> +</ul> + +<h3>Example</h3> +<div class="highlight"><pre><code class="language-text" data-lang="text"> // create a new contact + var contact = navigator.contacts.create(); + + // store contact phone numbers in ContactField[] + var phoneNumbers = []; + phoneNumbers[0] = new ContactField('work', '212-555-1234', false); + phoneNumbers[1] = new ContactField('mobile', '917-555-5432', true); // preferred number + phoneNumbers[2] = new ContactField('home', '203-555-7890', false); + contact.phoneNumbers = phoneNumbers; + + // save the contact + contact.save(); +</code></pre></div> +<h3>Android Quirks</h3> + +<ul> +<li><strong>pref</strong>: Not supported, returning <code class="prettyprint">false</code>.</li> +</ul> + +<h3>BlackBerry 10 Quirks</h3> + +<ul> +<li><p><strong>type</strong>: Partially supported. Used for phone numbers.</p></li> +<li><p><strong>value</strong>: Supported.</p></li> +<li><p><strong>pref</strong>: Not supported, returning <code class="prettyprint">false</code>.</p></li> +</ul> + +<h3>iOS Quirks</h3> + +<ul> +<li><strong>pref</strong>: Not supported, returning <code class="prettyprint">false</code>.</li> +</ul> + +<h3>Windows Quirks</h3> + +<ul> +<li><strong>pref</strong>: Not supported, returning <code class="prettyprint">false</code>.</li> +</ul> + +<h2>ContactName</h2> + +<p>Contains different kinds of information about a <code class="prettyprint">Contact</code> object's name.</p> + +<h3>Properties</h3> + +<ul> +<li><p><strong>formatted</strong>: The complete name of the contact. <em>(DOMString)</em></p></li> +<li><p><strong>familyName</strong>: The contact's family name. <em>(DOMString)</em></p></li> +<li><p><strong>givenName</strong>: The contact's given name. <em>(DOMString)</em></p></li> +<li><p><strong>middleName</strong>: The contact's middle name. <em>(DOMString)</em></p></li> +<li><p><strong>honorificPrefix</strong>: The contact's prefix (example <em>Mr.</em> or <em>Dr.</em>) <em>(DOMString)</em></p></li> +<li><p><strong>honorificSuffix</strong>: The contact's suffix (example <em>Esq.</em>). <em>(DOMString)</em></p></li> +</ul> + +<h3>Supported Platforms</h3> + +<ul> +<li>Amazon Fire OS</li> +<li>Android</li> +<li>BlackBerry 10</li> +<li>Firefox OS</li> +<li>iOS</li> +<li>Windows Phone 8</li> +<li>Windows</li> +</ul> + +<h3>Example</h3> +<div class="highlight"><pre><code class="language-text" data-lang="text">function onSuccess(contacts) { + for (var i = 0; i < contacts.length; i++) { + alert("Formatted: " + contacts[i].name.formatted + "\n" + + "Family Name: " + contacts[i].name.familyName + "\n" + + "Given Name: " + contacts[i].name.givenName + "\n" + + "Middle Name: " + contacts[i].name.middleName + "\n" + + "Suffix: " + contacts[i].name.honorificSuffix + "\n" + + "Prefix: " + contacts[i].name.honorificSuffix); + } +}; + +function onError(contactError) { + alert('onError!'); +}; + +var options = new ContactFindOptions(); +options.filter = ""; +options.multiple = true; +filter = ["displayName", "name"]; +navigator.contacts.find(filter, onSuccess, onError, options); +</code></pre></div> +<h3>Android Quirks</h3> + +<ul> +<li><strong>formatted</strong>: Partially supported, and read-only. Returns a concatenation of <code class="prettyprint">honorificPrefix</code>, <code class="prettyprint">givenName</code>, <code class="prettyprint">middleName</code>, <code class="prettyprint">familyName</code>, and <code class="prettyprint">honorificSuffix</code>.</li> +</ul> + +<h3>BlackBerry 10 Quirks</h3> + +<ul> +<li><p><strong>formatted</strong>: Partially supported. Returns a concatenation of BlackBerry <strong>firstName</strong> and <strong>lastName</strong> fields.</p></li> +<li><p><strong>familyName</strong>: Supported. Stored in BlackBerry <strong>lastName</strong> field.</p></li> +<li><p><strong>givenName</strong>: Supported. Stored in BlackBerry <strong>firstName</strong> field.</p></li> +<li><p><strong>middleName</strong>: Not supported, returning <code class="prettyprint">null</code>.</p></li> +<li><p><strong>honorificPrefix</strong>: Not supported, returning <code class="prettyprint">null</code>.</p></li> +<li><p><strong>honorificSuffix</strong>: Not supported, returning <code class="prettyprint">null</code>.</p></li> +</ul> + +<h3>FirefoxOS Quirks</h3> + +<ul> +<li><strong>formatted</strong>: Partially supported, and read-only. Returns a concatenation of <code class="prettyprint">honorificPrefix</code>, <code class="prettyprint">givenName</code>, <code class="prettyprint">middleName</code>, <code class="prettyprint">familyName</code>, and <code class="prettyprint">honorificSuffix</code>.</li> +</ul> + +<h3>iOS Quirks</h3> + +<ul> +<li><strong>formatted</strong>: Partially supported. Returns iOS Composite Name, but is read-only.</li> +</ul> + +<h3>Windows Quirks</h3> + +<ul> +<li><p><strong>formatted</strong>: This is the only name property, and is identical to <code class="prettyprint">displayName</code>, and <code class="prettyprint">nickname</code></p></li> +<li><p><strong>familyName</strong>: not supported</p></li> +<li><p><strong>givenName</strong>: not supported</p></li> +<li><p><strong>middleName</strong>: not supported</p></li> +<li><p><strong>honorificPrefix</strong>: not supported</p></li> +<li><p><strong>honorificSuffix</strong>: not supported</p></li> +</ul> + +<h2>ContactOrganization</h2> + +<p>The <code class="prettyprint">ContactOrganization</code> object stores a contact's organization +properties. A <code class="prettyprint">Contact</code> object stores one or more +<code class="prettyprint">ContactOrganization</code> objects in an array.</p> + +<h3>Properties</h3> + +<ul> +<li><p><strong>pref</strong>: Set to <code class="prettyprint">true</code> if this <code class="prettyprint">ContactOrganization</code> contains the user's preferred value. <em>(boolean)</em></p></li> +<li><p><strong>type</strong>: A string that indicates what type of field this is, <em>home</em> for example. _(DOMString)</p></li> +<li><p><strong>name</strong>: The name of the organization. <em>(DOMString)</em></p></li> +<li><p><strong>department</strong>: The department the contract works for. <em>(DOMString)</em></p></li> +<li><p><strong>title</strong>: The contact's title at the organization. <em>(DOMString)</em></p></li> +</ul> + +<h3>Supported Platforms</h3> + +<ul> +<li>Android</li> +<li>BlackBerry 10</li> +<li>Firefox OS</li> +<li>iOS</li> +<li>Windows Phone 8</li> +<li>Windows (Windows 8.1 and Windows Phone 8.1 devices only)</li> +</ul> + +<h3>Example</h3> +<div class="highlight"><pre><code class="language-text" data-lang="text">function onSuccess(contacts) { + for (var i = 0; i < contacts.length; i++) { + for (var j = 0; j < contacts[i].organizations.length; j++) { + alert("Pref: " + contacts[i].organizations[j].pref + "\n" + + "Type: " + contacts[i].organizations[j].type + "\n" + + "Name: " + contacts[i].organizations[j].name + "\n" + + "Department: " + contacts[i].organizations[j].department + "\n" + + "Title: " + contacts[i].organizations[j].title); + } + } +}; + +function onError(contactError) { + alert('onError!'); +}; + +var options = new ContactFindOptions(); +options.filter = ""; +options.multiple = true; +filter = ["displayName", "organizations"]; +navigator.contacts.find(filter, onSuccess, onError, options); +</code></pre></div> +<h3>Android 2.X Quirks</h3> + +<ul> +<li><strong>pref</strong>: Not supported by Android 2.X devices, returning <code class="prettyprint">false</code>.</li> +</ul> + +<h3>BlackBerry 10 Quirks</h3> + +<ul> +<li><p><strong>pref</strong>: Not supported by BlackBerry devices, returning <code class="prettyprint">false</code>.</p></li> +<li><p><strong>type</strong>: Not supported by BlackBerry devices, returning <code class="prettyprint">null</code>.</p></li> +<li><p><strong>name</strong>: Partially supported. The first organization name is stored in the BlackBerry <strong>company</strong> field.</p></li> +<li><p><strong>department</strong>: Not supported, returning <code class="prettyprint">null</code>.</p></li> +<li><p><strong>title</strong>: Partially supported. The first organization title is stored in the BlackBerry <strong>jobTitle</strong> field.</p></li> +</ul> + +<h3>Firefox OS Quirks</h3> + +<ul> +<li><p><strong>pref</strong>: Not supported</p></li> +<li><p><strong>type</strong>: Not supported</p></li> +<li><p><strong>department</strong>: Not supported</p></li> +<li><p>Fields <strong>name</strong> and <strong>title</strong> stored in <strong>org</strong> and <strong>jobTitle</strong>.</p></li> +</ul> + +<h3>iOS Quirks</h3> + +<ul> +<li><p><strong>pref</strong>: Not supported on iOS devices, returning <code class="prettyprint">false</code>.</p></li> +<li><p><strong>type</strong>: Not supported on iOS devices, returning <code class="prettyprint">null</code>.</p></li> +<li><p><strong>name</strong>: Partially supported. The first organization name is stored in the iOS <strong>kABPersonOrganizationProperty</strong> field.</p></li> +<li><p><strong>department</strong>: Partially supported. The first department name is stored in the iOS <strong>kABPersonDepartmentProperty</strong> field.</p></li> +<li><p><strong>title</strong>: Partially supported. The first title is stored in the iOS <strong>kABPersonJobTitleProperty</strong> field.</p></li> +</ul> + +<h3>Windows Quirks</h3> + +<ul> +<li><p><strong>pref</strong>: Not supported, returning <code class="prettyprint">false</code>.</p></li> +<li><p><strong>type</strong>: Not supported, returning <code class="prettyprint">null</code>.</p></li> +</ul> + +<h2>ContactFieldType</h2> + +<p>The <code class="prettyprint">ContactFieldType</code> object is an enumeration of possible field types, such as <code class="prettyprint">'phoneNumbers'</code> or <code class="prettyprint">'emails'</code>, that could be used to control which contact properties must be returned back from <code class="prettyprint">contacts.find()</code> method (see <code class="prettyprint">contactFindOptions.desiredFields</code>), or to specify fields to search in (through <code class="prettyprint">contactFields</code> parameter). Possible values are:</p> + +<ul> +<li><code class="prettyprint">navigator.contacts.fieldType.addresses</code></li> +<li><code class="prettyprint">navigator.contacts.fieldType.birthday</code></li> +<li><code class="prettyprint">navigator.contacts.fieldType.categories</code></li> +<li><code class="prettyprint">navigator.contacts.fieldType.country</code></li> +<li><code class="prettyprint">navigator.contacts.fieldType.department</code></li> +<li><code class="prettyprint">navigator.contacts.fieldType.displayName</code></li> +<li><code class="prettyprint">navigator.contacts.fieldType.emails</code></li>
[... 117 lines stripped ...] --------------------------------------------------------------------- To unsubscribe, e-mail: commits-unsubscr...@cordova.apache.org For additional commands, e-mail: commits-h...@cordova.apache.org
![https://travis-ci.org/apache/cordova-plugin-contacts.svg?branch=master"](https://travis-ci.org/apache/cordova-plugin-contacts.svg?branch=master"){kind=link}