Modified: cordova/site/public/docs/en/3.0.0/cordova_contacts_contacts.md.html URL: http://svn.apache.org/viewvc/cordova/site/public/docs/en/3.0.0/cordova_contacts_contacts.md.html?rev=1509456&r1=1509455&r2=1509456&view=diff ============================================================================== --- cordova/site/public/docs/en/3.0.0/cordova_contacts_contacts.md.html (original) +++ cordova/site/public/docs/en/3.0.0/cordova_contacts_contacts.md.html Thu Aug 1 22:17:43 2013 @@ -85,7 +85,7 @@ <option value="Contacts_methods">Â Â Â Â Â Â - Methods</option> <option value="Contacts_arguments">Â Â Â Â Â Â - Arguments</option> <option value="Contacts_objects">Â Â Â Â Â Â - Objects</option> -<option value="Contacts_permissions">Â Â Â Â Â Â - Permissions</option> +<option value="Contacts_accessing_the_feature">Â Â Â Â Â Â - Accessing the Feature</option> <option value="contacts.create">contacts.create</option> <option value="contacts.create_description">Â Â Â Â Â Â - Description</option> <option value="contacts.create_supported_platforms">Â Â Â Â Â Â - Supported Platforms</option> @@ -171,7 +171,6 @@ <li><a href="guide_overview_index.md.html#Overview">Overview</a></li> <li><a href="guide_cli_index.md.html#The%20Command-line%20Interface">The Command-line Interface</a></li> <li><a href="guide_platforms_index.md.html#Platform%20Guides">Platform Guides</a></li> -<li><a href="index.md.html#Guides">Guides</a></li> <li><a href="config_ref_index.md.html#Configuration%20Reference">Configuration Reference</a></li> <li><a href="guide_hybrid_webviews_index.md.html#Embedding%20WebViews">Embedding WebViews</a></li> <li><a href="guide_hybrid_plugins_index.md.html#Plugin%20Development%20Guide">Plugin Development Guide</a></li> @@ -242,55 +241,74 @@ <li><a href="cordova_contacts_contacts.md.html#ContactError">ContactError</a></li> </ul> <h2> -<a name="Contacts_permissions">Permissions</a> +<a name="Contacts_accessing_the_feature">Accessing the Feature</a> </h2> -<h3>Android</h3> +<p>As of version 3.0, Cordova implements device-level APIs as <em>plugins</em>. +Use the CLI's <code>plugin</code> command, described in <a href="#The%20Command-line%0AInterface">The Command-line +Interface</a>, to add or remove this feature for a project:</p> -<h4>app/res/xml/config.xml</h4> - -<pre class="prettyprint"><code><plugin name="<a href="cordova_contacts_contacts.md.html#Contacts">Contacts</a>" value="org.apache.cordova.ContactManager" /> +<pre class="prettyprint"><code> $ cordova plugin add https://git-wip-us.apache.org/repos/asf/cordova-plugin-contacts.git + $ cordova plugin rm org.apache.cordova.core.contacts </code></pre> -<h4>app/AndroidManifest.xml</h4> +<p>These commands apply to all targeted platforms, but modify the +platform-specific configuration settings described below:</p> -<pre class="prettyprint"><code><uses-permission android:name="android.permission.GET_ACCOUNTS" /> -<uses-permission android:name="android.permission.READ_CONTACTS" /> -<uses-permission android:name="android.permission.WRITE_CONTACTS" /> -</code></pre> +<ul> +<li> +<p>Android</p> -<h3>BlackBerry WebWorks</h3> +<pre class="prettyprint"><code>(in app/res/xml/config.xml) +<feature name="<a href="cordova_contacts_contacts.md.html#Contacts">Contacts</a>"> + <param name="android-package" value="org.apache.cordova.ContactManager" /> +</feature> -<h4>www/plugins.xml</h4> -<pre class="prettyprint"><code><plugin name="<a href="cordova_contacts_contacts.md.html#Contact">Contact</a>" value="org.apache.cordova.pim.<a href="cordova_contacts_contacts.md.html#Contact">Contact</a>" /> +(in app/AndroidManifest.xml) +<uses-permission android:name="android.permission.GET_ACCOUNTS" /> +<uses-permission android:name="android.permission.READ_CONTACTS" /> +<uses-permission android:name="android.permission.WRITE_CONTACTS" /> </code></pre> +</li> +<li> +<p>BlackBerry WebWorks</p> -<h4>www/config.xml</h4> +<pre class="prettyprint"><code>(in www/plugins.xml) +<feature name="<a href="cordova_contacts_contacts.md.html#Contact">Contact</a>"> + <param name="blackberry-package" value="org.apache.cordova.pim.<a href="cordova_contacts_contacts.md.html#Contact">Contact</a>" /> +</feature> -<pre class="prettyprint"><code><feature id="blackberry.find" required="true" version="1.0.0.0" /> + +(in www/config.xml) +<feature id="blackberry.find" required="true" version="1.0.0.0" /> <feature id="blackberry.identity" required="true" version="1.0.0.0" /> <feature id="blackberry.pim.Address" required="true" version="1.0.0.0" /> <feature id="blackberry.pim.<a href="cordova_contacts_contacts.md.html#Contact">Contact</a>" required="true" version="1.0.0.0" /> </code></pre> +</li> +<li> +<p>iOS (in <code>config.xml</code>)</p> -<h3>iOS</h3> - -<h4>config.xml</h4> - -<pre class="prettyprint"><code><plugin name="<a href="cordova_contacts_contacts.md.html#Contacts">Contacts</a>" value="CDVContacts" /> +<pre class="prettyprint"><code><feature name="<a href="cordova_contacts_contacts.md.html#Contacts">Contacts</a>"> + <param name="ios-package" value="CDVContacts" /> +</feature> </code></pre> +</li> +<li> +<p>Windows Phone</p> -<h3>Windows Phone</h3> - -<h4>Properties/WPAppManifest.xml</h4> - -<pre class="prettyprint"><code><Capabilities> +<pre class="prettyprint"><code>(in Properties/WPAppManifest.xml) +<Capabilities> <Capability Name="ID_CAP_CONTACTS" /> </Capabilities> </code></pre> <p>Reference: <a class="external" href="http://msdn.microsoft.com/en-us/library/ff769509%28v=vs.92%29.aspx";>Application Manifest for Windows Phone</a></p> +</li> +</ul> +<p>Some platforms may support this feature without requiring any special +configuration. See Platform Support for an overview.</p> <hr> <h1><a name="contacts.create">contacts.create</a></h1> @@ -350,7 +368,6 @@ database, for which you need to invoke t console.log("The contact, " + myContact.displayName + ", note: " + myContact.note); } - </script> </head> <body> @@ -396,14 +413,10 @@ specified in the <strong><a href="cordov </h2> <ul> -<li> -<strong><a href="cordova_contacts_contacts.md.html#contactFields">contactFields</a></strong>: <a href="cordova_contacts_contacts.md.html#Contact">Contact</a> fields to use as a search qualifier. The resulting <code><a href="cordova_contacts_contacts.md.html#Contact">Contact</a></code> object only features values for these fields. <em>(DOMString[])</em> [Required]</li> -<li> -<strong><a href="cordova_contacts_contacts.md.html#contactSuccess">contactSuccess</a></strong>: Success callback function invoked with the contacts returned from the database. [Required]</li> -<li> -<strong><a href="cordova_contacts_contacts.md.html#contactError">contactError</a></strong>: Error callback function, invoked when an error occurs. [Optional]</li> -<li> -<strong><a href="cordova_contacts_contacts.md.html#contactFindOptions">contactFindOptions</a></strong>: Search options to filter contacts. [Optional]</li> +<li><p><strong><a href="cordova_contacts_contacts.md.html#contactFields">contactFields</a></strong>: <a href="cordova_contacts_contacts.md.html#Contact">Contact</a> fields to use as a search qualifier. The resulting <code><a href="cordova_contacts_contacts.md.html#Contact">Contact</a></code> object only features values for these fields. <em>(DOMString[])</em> [Required]</p></li> +<li><p><strong><a href="cordova_contacts_contacts.md.html#contactSuccess">contactSuccess</a></strong>: Success callback function invoked with the contacts returned from the database. [Required]</p></li> +<li><p><strong><a href="cordova_contacts_contacts.md.html#contactError">contactError</a></strong>: Error callback function, invoked when an error occurs. [Optional]</p></li> +<li><p><strong><a href="cordova_contacts_contacts.md.html#contactFindOptions">contactFindOptions</a></strong>: Search options to filter contacts. [Optional]</p></li> </ul> <h2> <a name="contacts.find_supported_platforms">Supported Platforms</a> @@ -493,60 +506,29 @@ navigator.<a href="cordova_contacts_cont </h2> <ul> -<li> -<strong>id</strong>: A globally unique identifier. <em>(DOMString)</em> -</li> -<li> -<strong>displayName</strong>: The name of this <a href="cordova_contacts_contacts.md.html#Contact">Contact</a>, suitable for display to end-users. <em>(DOMString)</em> -</li> -<li> -<strong>name</strong>: An object containing all components of a persons name. <em>(<a href="cordova_contacts_contacts.md.html#ContactName">ContactName</a>)</em> -</li> -<li> -<strong>nickname</strong>: A casual name by which to address the contact. <em>(DOMString)</em> -</li> -<li> -<strong>phoneNumbers</strong>: An array of all the contact's phone numbers. <em>(<a href="cordova_contacts_contacts.md.html#ContactField">ContactField</a>[])</em> -</li> -<li> -<strong>emails</strong>: An array of all the contact's email addresses. <em>(<a href="cordova_contacts_contacts.md.html#ContactField">ContactField</a>[])</em> -</li> -<li> -<strong>addresses</strong>: An array of all the contact's addresses. <em>(<a href="cordova_contacts_contacts.md.html#ContactAddress">ContactAddress</a>[])</em> -</li> -<li> -<strong>ims</strong>: An array of all the contact's IM addresses. <em>(<a href="cordova_contacts_contacts.md.html#ContactField">ContactField</a>[])</em> -</li> -<li> -<strong>organizations</strong>: An array of all the contact's organizations. <em>(<a href="cordova_contacts_contacts.md.html#ContactOrganization">ContactOrganization</a>[])</em> -</li> -<li> -<strong>birthday</strong>: The birthday of the contact. <em>(Date)</em> -</li> -<li> -<strong>note</strong>: A note about the contact. <em>(DOMString)</em> -</li> -<li> -<strong>photos</strong>: An array of the contact's photos. <em>(<a href="cordova_contacts_contacts.md.html#ContactField">ContactField</a>[])</em> -</li> -<li> -<strong>categories</strong>: An array of all the user-defined categories associated with the contact. <em>(<a href="cordova_contacts_contacts.md.html#ContactField">ContactField</a>[])</em> -</li> -<li> -<strong>urls</strong>: An array of web pages associated with the contact. <em>(<a href="cordova_contacts_contacts.md.html#ContactField">ContactField</a>[])</em> -</li> +<li><p><strong>id</strong>: A globally unique identifier. <em>(DOMString)</em></p></li> +<li><p><strong>displayName</strong>: The name of this <a href="cordova_contacts_contacts.md.html#Contact">Contact</a>, 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>(<a href="cordova_contacts_contacts.md.html#ContactName">ContactName</a>)</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>(<a href="cordova_contacts_contacts.md.html#ContactField">ContactField</a>[])</em></p></li> +<li><p><strong>emails</strong>: An array of all the contact's email addresses. <em>(<a href="cordova_contacts_contacts.md.html#ContactField">ContactField</a>[])</em></p></li> +<li><p><strong>addresses</strong>: An array of all the contact's addresses. <em>(<a href="cordova_contacts_contacts.md.html#ContactAddress">ContactAddress</a>[])</em></p></li> +<li><p><strong>ims</strong>: An array of all the contact's IM addresses. <em>(<a href="cordova_contacts_contacts.md.html#ContactField">ContactField</a>[])</em></p></li> +<li><p><strong>organizations</strong>: An array of all the contact's organizations. <em>(<a href="cordova_contacts_contacts.md.html#ContactOrganization">ContactOrganization</a>[])</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>(<a href="cordova_contacts_contacts.md.html#ContactField">ContactField</a>[])</em></p></li> +<li><p><strong>categories</strong>: An array of all the user-defined categories associated with the contact. <em>(<a href="cordova_contacts_contacts.md.html#ContactField">ContactField</a>[])</em></p></li> +<li><p><strong>urls</strong>: An array of web pages associated with the contact. <em>(<a href="cordova_contacts_contacts.md.html#ContactField">ContactField</a>[])</em></p></li> </ul> <h2> <a name="Contact_methods">Methods</a> </h2> <ul> -<li> -<strong>clone</strong>: Returns a new <code><a href="cordova_contacts_contacts.md.html#Contact">Contact</a></code> object that is a deep copy of the calling object, with the <code>id</code> property set to <code>null</code>.</li> -<li> -<strong>remove</strong>: Removes the contact from the device contacts database, otherwise executes an error callback with a <code><a href="cordova_contacts_contacts.md.html#ContactError">ContactError</a></code> object.</li> -<li> -<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.</li> +<li><p><strong>clone</strong>: Returns a new <code><a href="cordova_contacts_contacts.md.html#Contact">Contact</a></code> object that is a deep copy of the calling object, with the <code>id</code> property set to <code>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><a href="cordova_contacts_contacts.md.html#ContactError">ContactError</a></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> <h2> <a name="Contact_details">Details</a> @@ -713,68 +695,43 @@ function onError(<a href="cordova_contac </h2> <ul> -<li> -<strong>id</strong>: Supported. Assigned by the device when saving the contact.</li> -<li> -<strong>displayName</strong>: Supported. Stored in BlackBerry <strong>user1</strong> field.</li> -<li> -<strong>nickname</strong>: Not supported, returning <code>null</code>.</li> -<li> -<strong>phoneNumbers</strong>: Partially supported. Phone numbers are stored in BlackBerry fields <strong>homePhone1</strong> and <strong>homePhone2</strong> if <em>type</em> is 'home', <strong>workPhone1</strong> and <strong>workPhone2</strong> if <em>type</em> is 'work', <strong>mobilePhone</strong> if <em>type</em> is 'mobile', <strong>faxPhone</strong> if <em>type</em> is 'fax', <strong>pagerPhone</strong> if <em>type</em> is 'pager', and <strong>otherPhone</strong> if <em>type</em> is none of the above.</li> -<li> -<strong>emails</strong>: Partially supported. The first three email addresses are stored in the BlackBerry <strong>email1</strong>, <strong>email2</strong>, and <strong>email3</strong> fields, respectively.</li> -<li> -<strong>addresses</strong>: Partially supported. The first and second addresses are stored in the BlackBerry <strong>homeAddress</strong> and <strong>workAddress</strong> fields, respectively.</li> -<li> -<strong>ims</strong>: Not supported, returning <code>null</code>.</li> -<li> -<strong>organizations</strong>: Partially supported. The <strong>name</strong> and <strong>title</strong> of the first organization are stored in the BlackBerry <strong>company</strong> and <strong>title</strong> fields, respectively.</li> -<li> -<strong>photos</strong>: Partially supported. A single thumbnail-sized photo is supported. To set a contact's photo, pass in a either a base64-encoded image, or a URL pointing to the image. The image is scaled down before saving to the BlackBerry contacts database. The contact photo is returned as a base64-encoded image.</li> -<li> -<strong>categories</strong>: Partially supported. Only <em>Business</em> and <em>Personal</em> categories are supported.</li> -<li> -<strong>urls</strong>: Partially supported. The first URL is stored in BlackBerry <strong>webpage</strong> field.</li> +<li><p><strong>id</strong>: Supported. Assigned by the device when saving the contact.</p></li> +<li><p><strong>displayName</strong>: Supported. Stored in BlackBerry <strong>user1</strong> field.</p></li> +<li><p><strong>nickname</strong>: Not supported, returning <code>null</code>.</p></li> +<li><p><strong>phoneNumbers</strong>: Partially supported. Phone numbers are stored in BlackBerry fields <strong>homePhone1</strong> and <strong>homePhone2</strong> if <em>type</em> is 'home', <strong>workPhone1</strong> and <strong>workPhone2</strong> if <em>type</em> is 'work', <strong>mobilePhone</strong> if <em>type</em> is 'mobile', <strong>faxPhone</strong> if <em>type</em> is 'fax', <strong>pagerPhone</strong> if <em>type</em> is 'pager', and <strong>otherPhone</strong> if <em>type</em> is none of the above.</p></li> +<li><p><strong>emails</strong>: Partially supported. The first three email addresses are stored in the BlackBerry <strong>email1</strong>, <strong>email2</strong>, and <strong>email3</strong> fields, respectively.</p></li> +<li><p><strong>addresses</strong>: Partially supported. The first and second addresses are stored in the BlackBerry <strong>homeAddress</strong> and <strong>workAddress</strong> fields, respectively.</p></li> +<li><p><strong>ims</strong>: Not supported, returning <code>null</code>.</p></li> +<li><p><strong>organizations</strong>: Partially supported. The <strong>name</strong> and <strong>title</strong> of the first organization are stored in the BlackBerry <strong>company</strong> and <strong>title</strong> fields, respectively.</p></li> +<li><p><strong>photos</strong>: Partially supported. A single thumbnail-sized photo is supported. To set a contact's photo, pass in a either a base64-encoded image, or a URL pointing to the image. The image is scaled down before saving to the BlackBerry contacts database. The contact photo is returned as a base64-encoded image.</p></li> +<li><p><strong>categories</strong>: Partially supported. Only <em>Business</em> and <em>Personal</em> categories are supported.</p></li> +<li><p><strong>urls</strong>: Partially supported. The first URL is stored in BlackBerry <strong>webpage</strong> field.</p></li> </ul> <h2> <a name="Contact_ios_quirks">iOS Quirks</a> </h2> <ul> -<li> -<strong>displayName</strong>: Not supported on iOS, returning <code>null</code> unless there is no <code><a href="cordova_contacts_contacts.md.html#ContactName">ContactName</a></code> specified, in which case it returns the composite name, <strong>nickname</strong> or <code>""</code>, respectively.</li> -<li> -<strong>birthday</strong>: Must be input as a JavaScript <code>Date</code> object, the same way it is returned.</li> -<li> -<strong>photos</strong>: Returns a <a href="cordova_file_file.md.html#File">File</a> URL to the image, which is stored in the application's temporary directory. Contents of the temporary directory are removed when the application exits.</li> -<li> -<strong>categories</strong>: This property is currently not supported, returning <code>null</code>.</li> +<li><p><strong>displayName</strong>: Not supported on iOS, returning <code>null</code> unless there is no <code><a href="cordova_contacts_contacts.md.html#ContactName">ContactName</a></code> specified, in which case it returns the composite name, <strong>nickname</strong> or <code>""</code>, respectively.</p></li> +<li><p><strong>birthday</strong>: Must be input as a JavaScript <code>Date</code> object, the same way it is returned.</p></li> +<li><p><strong>photos</strong>: Returns a <a href="cordova_file_file.md.html#File">File</a> 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>null</code>.</p></li> </ul> <h2> <a name="Contact_windows_phone_7_and_8_quirks">Windows Phone 7 and 8 Quirks</a> </h2> <ul> -<li> -<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.</li> -<li> -<strong>urls</strong>: When creating a contact, users can input and save more than one web address, but only one is available is available when searching the contact.</li> -<li> -<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>phoneNumber</code> is allowed for each <em>type</em>.</li> -<li> -<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>.</li> -<li> -<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>.</li> -<li> -<strong>organizations</strong>: Only one is allowed, and does not support the <em>pref</em>, <em>type</em>, and <em>department</em> attributes.</li> -<li> -<strong>note</strong>: Not supported, returning <code>null</code>.</li> -<li> -<strong>ims</strong>: Not supported, returning <code>null</code>.</li> -<li> -<strong>birthdays</strong>: Not supported, returning <code>null</code>.</li> -<li> -<strong>categories</strong>: Not supported, returning <code>null</code>.</li> +<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 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>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>null</code>.</p></li> +<li><p><strong>ims</strong>: Not supported, returning <code>null</code>.</p></li> +<li><p><strong>birthdays</strong>: Not supported, returning <code>null</code>.</p></li> +<li><p><strong>categories</strong>: Not supported, returning <code>null</code>.</p></li> </ul> <hr> <h1><a name="ContactAddress">ContactAddress</a></h1> @@ -786,30 +743,14 @@ function onError(<a href="cordova_contac </h2> <ul> -<li> -<strong>pref</strong>: Set to <code>true</code> if this <code><a href="cordova_contacts_contacts.md.html#ContactAddress">ContactAddress</a></code> contains the user's preferred value. <em>(boolean)</em> -</li> -<li> -<strong>type</strong>: A string indicating what type of field this is, <em>home</em> for example. <em>(DOMString)</em> -</li> -<li> -<strong>formatted</strong>: The full address formatted for display. <em>(DOMString)</em> -</li> -<li> -<strong>streetAddress</strong>: The full street address. <em>(DOMString)</em> -</li> -<li> -<strong>locality</strong>: The city or locality. <em>(DOMString)</em> -</li> -<li> -<strong>region</strong>: The state or region. <em>(DOMString)</em> -</li> -<li> -<strong>postalCode</strong>: The zip code or postal code. <em>(DOMString)</em> -</li> -<li> -<strong>country</strong>: The country name. <em>(DOMString)</em> -</li> +<li><p><strong>pref</strong>: Set to <code>true</code> if this <code><a href="cordova_contacts_contacts.md.html#ContactAddress">ContactAddress</a></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> <h2> <a name="ContactAddress_details">Details</a> @@ -934,32 +875,22 @@ navigator.<a href="cordova_contacts_cont </h2> <ul> -<li> -<strong>pref</strong>: Not supported on BlackBerry devices, returning <code>false</code>.</li> -<li> -<strong>type</strong>: Partially supported. Only one each of <em>Work</em> and <em>Home</em> type addresses can be stored per contact.</li> -<li> -<strong>formatted</strong>: Partially supported. Returns a concatenation of all BlackBerry address fields.</li> -<li> -<strong>streetAddress</strong>: Supported. Returns a concatenation of BlackBerry <strong>address1</strong> and <strong>address2</strong> address fields.</li> -<li> -<strong>locality</strong>: Supported. Stored in BlackBerry <strong>city</strong> address field.</li> -<li> -<strong>region</strong>: Supported. Stored in BlackBerry <strong>stateProvince</strong> address field.</li> -<li> -<strong>postalCode</strong>: Supported. Stored in BlackBerry <strong>zipPostal</strong> address field.</li> -<li> -<strong>country</strong>: Supported.</li> +<li><p><strong>pref</strong>: Not supported on BlackBerry devices, returning <code>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> <h2> <a name="ContactAddress_ios_quirks">iOS Quirks</a> </h2> <ul> -<li> -<strong>pref</strong>: Not supported on iOS devices, returning <code>false</code>.</li> -<li> -<strong>formatted</strong>: Currently not supported.</li> +<li><p><strong>pref</strong>: Not supported on iOS devices, returning <code>false</code>.</p></li> +<li><p><strong>formatted</strong>: Currently not supported.</p></li> </ul> <hr> <h1><a name="ContactField">ContactField</a></h1> @@ -973,15 +904,9 @@ URLs.</p> </h2> <ul> -<li> -<strong>type</strong>: A string that indicates what type of field this is, <em>home</em> for example. <em>(DOMString)</em> -</li> -<li> -<strong>value</strong>: The value of the field, such as a phone number or email address. <em>(DOMString)</em> -</li> -<li> -<strong>pref</strong>: Set to <code>true</code> if this <code><a href="cordova_contacts_contacts.md.html#ContactField">ContactField</a></code> contains the user's preferred value. <em>(boolean)</em> -</li> +<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>true</code> if this <code><a href="cordova_contacts_contacts.md.html#ContactField">ContactField</a></code> contains the user's preferred value. <em>(boolean)</em></p></li> </ul> <h2> <a name="ContactField_details">Details</a> @@ -1113,12 +1038,9 @@ string.</p> </h2> <ul> -<li> -<strong>type</strong>: Partially supported. Used for phone numbers.</li> -<li> -<strong>value</strong>: Supported.</li> -<li> -<strong>pref</strong>: Not supported, returning <code>false</code>.</li> +<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>false</code>.</p></li> </ul> <h2> <a name="ContactField_ios_quirks">iOS Quirks</a> @@ -1138,10 +1060,8 @@ string.</p> </h2> <ul> -<li> -<strong>filter</strong>: The search string used to find contacts. <em>(DOMString)</em> (Default: <code>""</code>)</li> -<li> -<strong>multiple</strong>: Determines if the find operation returns multiple contacts. <em>(Boolean)</em> (Default: false)</li> +<li><p><strong>filter</strong>: The search string used to find contacts. <em>(DOMString)</em> (Default: <code>""</code>)</p></li> +<li><p><strong>multiple</strong>: Determines if the find operation returns multiple contacts. <em>(Boolean)</em> (Default: false)</p></li> </ul> <h2> <a name="ContactFindOptions_supported_platforms">Supported Platforms</a> @@ -1242,24 +1162,12 @@ navigator.<a href="cordova_contacts_cont </h2> <ul> -<li> -<strong>formatted</strong>: The complete name of the contact. <em>(DOMString)</em> -</li> -<li> -<strong>familyName</strong>: The contact's family name. <em>(DOMString)</em> -</li> -<li> -<strong>givenName</strong>: The contact's given name. <em>(DOMString)</em> -</li> -<li> -<strong>middleName</strong>: The contact's middle name. <em>(DOMString)</em> -</li> -<li> -<strong>honorificPrefix</strong>: The contact's prefix (example <em>Mr.</em> or <em>Dr.</em>) <em>(DOMString)</em> -</li> -<li> -<strong>honorificSuffix</strong>: The contact's suffix (example <em>Esq.</em>). <em>(DOMString)</em> -</li> +<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> <h2> <a name="ContactName_details">Details</a> @@ -1369,18 +1277,12 @@ navigator.<a href="cordova_contacts_cont </h2> <ul> -<li> -<strong>formatted</strong>: Partially supported. Returns a concatenation of BlackBerry <strong>firstName</strong> and <strong>lastName</strong> fields.</li> -<li> -<strong>familyName</strong>: Supported. Stored in BlackBerry <strong>lastName</strong> field.</li> -<li> -<strong>givenName</strong>: Supported. Stored in BlackBerry <strong>firstName</strong> field.</li> -<li> -<strong>middleName</strong>: Not supported, returning <code>null</code>.</li> -<li> -<strong>honorificPrefix</strong>: Not supported, returning <code>null</code>.</li> -<li> -<strong>honorificSuffix</strong>: Not supported, returning <code>null</code>.</li> +<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>null</code>.</p></li> +<li><p><strong>honorificPrefix</strong>: Not supported, returning <code>null</code>.</p></li> +<li><p><strong>honorificSuffix</strong>: Not supported, returning <code>null</code>.</p></li> </ul> <h2> <a name="ContactName_ios_quirks">iOS Quirks</a> @@ -1400,20 +1302,11 @@ navigator.<a href="cordova_contacts_cont </h2> <ul> -<li> -<strong>pref</strong>: Set to <code>true</code> if this <code><a href="cordova_contacts_contacts.md.html#ContactOrganization">ContactOrganization</a></code> contains the user's preferred value. <em>(boolean)</em> -</li> -<li> -<strong>type</strong>: A string that indicates what type of field this is, <em>home</em> for example. _(DOMString)</li> -<li> -<strong>name</strong>: The name of the organization. <em>(DOMString)</em> -</li> -<li> -<strong>department</strong>: The department the contract works for. <em>(DOMString)</em> -</li> -<li> -<strong>title</strong>: The contact's title at the organization. <em>(DOMString)</em> -</li> +<li><p><strong>pref</strong>: Set to <code>true</code> if this <code><a href="cordova_contacts_contacts.md.html#ContactOrganization">ContactOrganization</a></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> <h2> <a name="ContactOrganization_details">Details</a> @@ -1527,32 +1420,22 @@ navigator.<a href="cordova_contacts_cont </h2> <ul> -<li> -<strong>pref</strong>: Not supported by BlackBerry devices, returning <code>false</code>.</li> -<li> -<strong>type</strong>: Not supported by BlackBerry devices, returning <code>null</code>.</li> -<li> -<strong>name</strong>: Partially supported. The first organization name is stored in the BlackBerry <strong>company</strong> field.</li> -<li> -<strong>department</strong>: Not supported, returning <code>null</code>.</li> -<li> -<strong>title</strong>: Partially supported. The first organization title is stored in the BlackBerry <strong>jobTitle</strong> field.</li> +<li><p><strong>pref</strong>: Not supported by BlackBerry devices, returning <code>false</code>.</p></li> +<li><p><strong>type</strong>: Not supported by BlackBerry devices, returning <code>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>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> <h2> <a name="ContactOrganization_ios_quirks">iOS Quirks</a> </h2> <ul> -<li> -<strong>pref</strong>: Not supported on iOS devices, returning <code>false</code>.</li> -<li> -<strong>type</strong>: Not supported on iOS devices, returning <code>null</code>.</li> -<li> -<strong>name</strong>: Partially supported. The first organization name is stored in the iOS <strong>kABPersonOrganizationProperty</strong> field.</li> -<li> -<strong>department</strong>: Partially supported. The first department name is stored in the iOS <strong>kABPersonDepartmentProperty</strong> field.</li> -<li> -<strong>title</strong>: Partially supported. The first title is stored in the iOS <strong>kABPersonJobTitleProperty</strong> field.</li> +<li><p><strong>pref</strong>: Not supported on iOS devices, returning <code>false</code>.</p></li> +<li><p><strong>type</strong>: Not supported on iOS devices, returning <code>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> <hr> <h1><a name="ContactError">ContactError</a></h1> @@ -1652,10 +1535,8 @@ contacts returned from the contacts data </h2> <ul> -<li> -<strong>filter</strong>: The search string used to filter contacts. <em>(DOMString)</em> (Default: <code>""</code>)</li> -<li> -<strong>multiple</strong>: Determines if the find operation returns multiple contacts. <em>(Boolean)</em> (Default: <code>false</code>)</li> +<li><p><strong>filter</strong>: The search string used to filter contacts. <em>(DOMString)</em> (Default: <code>""</code>)</p></li> +<li><p><strong>multiple</strong>: Determines if the find operation returns multiple contacts. <em>(Boolean)</em> (Default: <code>false</code>)</p></li> </ul> </div> </div>
Modified: cordova/site/public/docs/en/3.0.0/cordova_device_device.md.html URL: http://svn.apache.org/viewvc/cordova/site/public/docs/en/3.0.0/cordova_device_device.md.html?rev=1509456&r1=1509455&r2=1509456&view=diff ============================================================================== --- cordova/site/public/docs/en/3.0.0/cordova_device_device.md.html (original) +++ cordova/site/public/docs/en/3.0.0/cordova_device_device.md.html Thu Aug 1 22:17:43 2013 @@ -84,7 +84,7 @@ <small><select><option value="Device">Device</option> <option value="Device_properties">Â Â Â Â Â Â - Properties</option> <option value="Device_variable_scope">Â Â Â Â Â Â - Variable Scope</option> -<option value="Device_permissions">Â Â Â Â Â Â - Permissions</option> +<option value="Device_accessing_the_feature">Â Â Â Â Â Â - Accessing the Feature</option> <option value="device.name">device.name</option> <option value="device.name_description">Â Â Â Â Â Â - Description</option> <option value="device.name_supported_platforms">Â Â Â Â Â Â - Supported Platforms</option> @@ -125,7 +125,6 @@ <li><a href="guide_overview_index.md.html#Overview">Overview</a></li> <li><a href="guide_cli_index.md.html#The%20Command-line%20Interface">The Command-line Interface</a></li> <li><a href="guide_platforms_index.md.html#Platform%20Guides">Platform Guides</a></li> -<li><a href="index.md.html#Guides">Guides</a></li> <li><a href="config_ref_index.md.html#Configuration%20Reference">Configuration Reference</a></li> <li><a href="guide_hybrid_webviews_index.md.html#Embedding%20WebViews">Embedding WebViews</a></li> <li><a href="guide_hybrid_plugins_index.md.html#Plugin%20Development%20Guide">Plugin Development Guide</a></li> @@ -186,44 +185,52 @@ var phoneName = <a href="cordova_device_ </code></pre> <h2> -<a name="Device_permissions">Permissions</a> +<a name="Device_accessing_the_feature">Accessing the Feature</a> </h2> -<h3>Android</h3> +<p>As of version 3.0, Cordova implements device-level APIs as <em>plugins</em>. +Use the CLI's <code>plugin</code> command, described in <a href="#The%20Command-line%0AInterface">The Command-line +Interface</a>, to add or remove this feature for a project:</p> -<h4>app/res/xml/config.xml</h4> - -<pre class="prettyprint"><code><plugin name="<a href="cordova_device_device.md.html#Device">Device</a>" value="org.apache.cordova.<a href="cordova_device_device.md.html#Device">Device</a>" /> +<pre class="prettyprint"><code> $ cordova plugin add https://git-wip-us.apache.org/repos/asf/cordova-plugin-device.git + $ cordova plugin rm org.apache.cordova.core.device </code></pre> -<h4>app/AndroidManifest.xml</h4> +<p>These commands apply to all targeted platforms, but modify the +platform-specific configuration settings described below:</p> -<pre class="prettyprint"><code><uses-permission android:name="android.permission.READ_PHONE_STATE" /> -</code></pre> +<ul> +<li> +<p>Android</p> -<h3>BlackBerry WebWorks</h3> +<pre class="prettyprint"><code>(in app/res/xml/config.xml) +<feature name="<a href="cordova_device_device.md.html#Device">Device</a>"> + <param name="android-package" value="org.apache.cordova.<a href="cordova_device_device.md.html#Device">Device</a>" /> +</feature> -<h4>www/plugins.xml</h4> -<pre class="prettyprint"><code><plugin name="<a href="cordova_device_device.md.html#Device">Device</a>" value="org.apache.cordova.device.<a href="cordova_device_device.md.html#Device">Device</a>" /> +(in app/AndroidManifest.xml) +<uses-permission android:name="android.permission.READ_PHONE_STATE" /> </code></pre> +</li> +<li> +<p>BlackBerry WebWorks</p> -<h4>www/config.xml</h4> +<pre class="prettyprint"><code>(in www/plugins.xml) +<feature name="<a href="cordova_device_device.md.html#Device">Device</a>"> + <param name="blackberry-package" value="org.apache.cordova.device.<a href="cordova_device_device.md.html#Device">Device</a>" /> +</feature> -<pre class="prettyprint"><code><feature id="blackberry.app" required="true" version="1.0.0.0" /> + +(in www/config.xml) +<feature id="blackberry.app" required="true" version="1.0.0.0" /> <rim:permissions> <rim:permit>read_device_identifying_information</rim:permit> </rim:permissions> </code></pre> - -<h3>iOS</h3> - -<pre class="prettyprint"><code>No permissions are required. -</code></pre> - -<h3>Windows Phone</h3> - -<h4>Properties/WPAppManifest.xml</h4> +</li> +<li> +<p>Windows Phone (in <code>Properties/WPAppManifest.xml</code>)</p> <pre class="prettyprint"><code><Capabilities> <Capability Name="ID_CAP_WEBBROWSERCOMPONENT" /> @@ -233,15 +240,18 @@ var phoneName = <a href="cordova_device_ </code></pre> <p>Reference: <a class="external" href="http://msdn.microsoft.com/en-us/library/ff769509%28v=vs.92%29.aspx";>Application Manifest for Windows Phone</a></p> - -<h3>Tizen</h3> - -<h4>config.xml</h4> +</li> +<li> +<p>Tizen (in <code>config.xml</code>)</p> <pre class="prettyprint"><code><feature name="http://tizen.org/api/systeminfo"; required="true"/> </code></pre> <p>Reference: <a class="external" href="https://developer.tizen.org/help/topic/org.tizen.help.gs/Creating%20a%20Project.html?path=0_1_1_3#8814682_CreatingaProject-EditingconfigxmlFeatures";>Application Manifest for Tizen Web Application</a></p> +</li> +</ul> +<p>Some platforms may support this feature without requiring any special +configuration. See Platform Support for an overview.</p> <hr> <h1><a name="device.name">device.name</a></h1> Modified: cordova/site/public/docs/en/3.0.0/cordova_device_device.model.md.html URL: http://svn.apache.org/viewvc/cordova/site/public/docs/en/3.0.0/cordova_device_device.model.md.html?rev=1509456&r1=1509455&r2=1509456&view=diff ============================================================================== --- cordova/site/public/docs/en/3.0.0/cordova_device_device.model.md.html (original) +++ cordova/site/public/docs/en/3.0.0/cordova_device_device.model.md.html Thu Aug 1 22:17:43 2013 @@ -98,7 +98,6 @@ <li><a href="guide_overview_index.md.html#Overview">Overview</a></li> <li><a href="guide_cli_index.md.html#The%20Command-line%20Interface">The Command-line Interface</a></li> <li><a href="guide_platforms_index.md.html#Platform%20Guides">Platform Guides</a></li> -<li><a href="index.md.html#Guides">Guides</a></li> <li><a href="config_ref_index.md.html#Configuration%20Reference">Configuration Reference</a></li> <li><a href="guide_hybrid_webviews_index.md.html#Embedding%20WebViews">Embedding WebViews</a></li> <li><a href="guide_hybrid_plugins_index.md.html#Plugin%20Development%20Guide">Plugin Development Guide</a></li> Modified: cordova/site/public/docs/en/3.0.0/cordova_events_events.md.html URL: http://svn.apache.org/viewvc/cordova/site/public/docs/en/3.0.0/cordova_events_events.md.html?rev=1509456&r1=1509455&r2=1509456&view=diff ============================================================================== --- cordova/site/public/docs/en/3.0.0/cordova_events_events.md.html (original) +++ cordova/site/public/docs/en/3.0.0/cordova_events_events.md.html Thu Aug 1 22:17:43 2013 @@ -83,7 +83,7 @@ <h1>Events</h1> <small><select><option value="Events">Events</option> <option value="Events_event_types">Â Â Â Â Â Â - Event Types</option> -<option value="Events_permissions">Â Â Â Â Â Â - Permissions</option> +<option value="Events_accessing_the_feature">Â Â Â Â Â Â - Accessing the Feature</option> <option value="deviceready">deviceready</option> <option value="deviceready_details">Â Â Â Â Â Â - Details</option> <option value="deviceready_supported_platforms">Â Â Â Â Â Â - Supported Platforms</option> @@ -177,7 +177,6 @@ <li><a href="guide_overview_index.md.html#Overview">Overview</a></li> <li><a href="guide_cli_index.md.html#The%20Command-line%20Interface">The Command-line Interface</a></li> <li><a href="guide_platforms_index.md.html#Platform%20Guides">Platform Guides</a></li> -<li><a href="index.md.html#Guides">Guides</a></li> <li><a href="config_ref_index.md.html#Configuration%20Reference">Configuration Reference</a></li> <li><a href="guide_hybrid_webviews_index.md.html#Embedding%20WebViews">Embedding WebViews</a></li> <li><a href="guide_hybrid_plugins_index.md.html#Plugin%20Development%20Guide">Plugin Development Guide</a></li> @@ -236,55 +235,70 @@ <li><a href="cordova_events_events.md.html#volumeupbutton">volumeupbutton</a></li> </ul> <h2> -<a name="Events_permissions">Permissions</a> +<a name="Events_accessing_the_feature">Accessing the Feature</a> </h2> -<h3>Android</h3> +<p>As of version 3.0, Cordova implements battery status and other +device-level APIs as <em>plugins</em>. Access to all other events not related +to battery status are enabled by default. Use the CLI's <code>plugin</code> +command, described in <a href="guide_cli_index.md.html#The%20Command-line%20Interface">The Command-line Interface</a>, to enable or disable +battery events:</p> -<h4>app/res/xml/config.xml</h4> - -<pre class="prettyprint"><code><plugin name="Battery" value="org.apache.cordova.BatteryListener" /> +<pre class="prettyprint"><code> $ cordova plugin add https://git-wip-us.apache.org/repos/asf/cordova-plugin-battery-status.git + $ cordova plugin rm org.apache.cordova.core.battery-status </code></pre> -<h4>app/AndroidManifest.xml</h4> +<p>These commands apply to all targeted platforms, but modify the +platform-specific configuration settings described below:</p> -<pre class="prettyprint"><code><uses-permission android:name="android.permission.BROADCAST_STICKY" /> -</code></pre> +<ul> +<li> +<p>Android</p> -<h3>BlackBerry WebWorks</h3> +<pre class="prettyprint"><code>(in app/res/xml/config.xml) +<feature name="Battery"> + <param name="android-package" value="org.apache.cordova.BatteryListener" /> +</feature> -<h4>www/plugins.xml</h4> -<pre class="prettyprint"><code><plugin name="Battery" value="org.apache.cordova.battery.Battery" /> +(in app/AndroidManifest.xml) +<uses-permission android:name="android.permission.BROADCAST_STICKY" /> </code></pre> +</li> +<li> +<p>BlackBerry WebWorks</p> + +<pre class="prettyprint"><code>(in www/plugins.xml) +<feature name="Battery"> + <param name="blackberry-package" value="org.apache.cordova.battery.Battery" /> +</feature> -<h4>www/config.xml</h4> -<pre class="prettyprint"><code><feature id="blackberry.app" required="true" version="1.0.0.0" /> +(in www/config.xml) +<feature id="blackberry.app" required="true" version="1.0.0.0" /> <feature id="blackberry.app.event" required="true" version="1.0.0.0" /> <feature id="blackberry.system.event" required="true" version="1.0.0.0" /> </code></pre> +</li> +<li> +<p>iOS (in <code>config.xml</code>)</p> -<h3>iOS</h3> - -<h4>config.xml</h4> - -<pre class="prettyprint"><code><plugin name="Battery" value="CDVBattery" /> -</code></pre> - -<h3>Windows Phone</h3> - -<pre class="prettyprint"><code>No permissions are required. +<pre class="prettyprint"><code><feature name="Battery"> + <param name="ios-package" value="CDVBattery" /> +</feature> </code></pre> - -<h3>Tizen</h3> - -<h4>config.xml</h4> +</li> +<li> +<p>Tizen (in <code>config.xml</code>)</p> <pre class="prettyprint"><code><feature name="http://tizen.org/api/systeminfo"; required="true"/> </code></pre> <p>Reference: <a class="external" href="https://developer.tizen.org/help/topic/org.tizen.help.gs/Creating%20a%20Project.html?path=0_1_1_3#8814682_CreatingaProject-EditingconfigxmlFeatures";>Application Manifest for Tizen Web Application</a></p> +</li> +</ul> +<p>Some platforms may support this feature without requiring any special +configuration. See Platform Support for an overview.</p> <hr> <h1><a name="deviceready">deviceready</a></h1> @@ -452,7 +466,7 @@ function onPause() { </h2> <p>In the <code><a href="cordova_events_events.md.html#pause">pause</a></code> handler, any calls to the Cordova API or to native -plug-ins that go through Objective-C do not work, along with any +plugins that go through Objective-C do not work, along with any interactive calls, such as alerts or <code>console.log()</code>. They are only processed when the app resumes, on the next run loop.</p> @@ -831,7 +845,6 @@ function onBackKeyDown() { <script type="text/javascript" charset="utf-8" src="cordova.js"></script> <script type="text/javascript" charset="utf-8"> - // Wait for device API libraries to load // function onLoad() { @@ -877,12 +890,8 @@ critical battery threshold. The value is properties:</p> <ul> -<li> -<strong>level</strong>: The percentage of battery charge (0-100). <em>(Number)</em> -</li> -<li> -<strong>isPlugged</strong>: A boolean that indicates whether the device is plugged in. <em>(Boolean)</em> -</li> +<li><p><strong>level</strong>: The percentage of battery charge (0-100). <em>(Number)</em></p></li> +<li><p><strong>isPlugged</strong>: A boolean that indicates whether the device is plugged in. <em>(Boolean)</em></p></li> </ul> <p>Applications typically should use <code>window.<a href="cordova_inappbrowser_inappbrowser.md.html#addEventListener">addEventListener</a></code> to attach an event listener once the <code><a href="cordova_events_events.md.html#deviceready">deviceready</a></code> event fires.</p> @@ -965,12 +974,8 @@ low battery threshold, device-specific v properties:</p> <ul> -<li> -<strong>level</strong>: The percentage of battery charge (0-100). <em>(Number)</em> -</li> -<li> -<strong>isPlugged</strong>: A boolean that indicates whether the device is plugged in. <em>(Boolean)</em> -</li> +<li><p><strong>level</strong>: The percentage of battery charge (0-100). <em>(Number)</em></p></li> +<li><p><strong>isPlugged</strong>: A boolean that indicates whether the device is plugged in. <em>(Boolean)</em></p></li> </ul> <p>Applications typically should use <code>document.<a href="cordova_inappbrowser_inappbrowser.md.html#addEventListener">addEventListener</a></code> to attach an event listener once the <code><a href="cordova_events_events.md.html#deviceready">deviceready</a></code> event fires.</p> @@ -1053,12 +1058,8 @@ least 1 percent, or if the device is plu properties:</p> <ul> -<li> -<strong>level</strong>: The percentage of battery charge (0-100). <em>(Number)</em> -</li> -<li> -<strong>isPlugged</strong>: A boolean that indicates whether the device is plugged in. <em>(Boolean)</em> -</li> +<li><p><strong>level</strong>: The percentage of battery charge (0-100). <em>(Number)</em></p></li> +<li><p><strong>isPlugged</strong>: A boolean that indicates whether the device is plugged in. <em>(Boolean)</em></p></li> </ul> <p>Applications typically should use <code>window.<a href="cordova_inappbrowser_inappbrowser.md.html#addEventListener">addEventListener</a></code> to attach an event listener once the <code><a href="cordova_events_events.md.html#deviceready">deviceready</a></code> event fires.</p>
