ContactOrganization

Contains a [Contact](../Contact/contact.html) object's organization properties.

Properties

  • pref: Set to true if this ContactOrganization contains the user's preferred value. (boolean)
  • type: A string that indicates what type of field this is, home for example. _(DOMString)
  • name: The name of the organization. (DOMString)
  • department: The department the contract works for. (DOMString)
  • title: The contact's title at the organization. (DOMString)

Details

The ContactOrganization object stores a contact's organization properties. A [Contact](../Contact/contact.html) object stores one or more ContactOrganization objects in an array.

Supported Platforms

  • Android
  • BlackBerry WebWorks (OS 5.0 and higher)
  • iOS
  • Windows Phone 7 and 8
  • Windows 8

Quick Example

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 = "";
filter = ["displayName", "organizations"];
navigator.contacts.find(filter, onSuccess, onError, options);

Full Example

<!DOCTYPE html>
<html>
  <head>
    <title>Contact Example</title>

    <script type="text/javascript" charset="utf-8" src="cordova-x.x.x.js"></script>
    <script type="text/javascript" charset="utf-8">

    // Wait for device API libraries to load
    //
    document.addEventListener("deviceready", onDeviceReady, false);

    // device APIs are available
    //
    function onDeviceReady() {
        var options = new ContactFindOptions();
        options.filter="";
        filter = ["displayName","organizations"];
        navigator.contacts.find(filter, onSuccess, onError, options);
    }

    // onSuccess: Get a snapshot of the current contacts
    //
    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);
            }
        }
    };

    // onError: Failed to get the contacts
    //
    function onError(contactError) {
        alert('onError!');
    }

    </script>
  </head>
  <body>
    <h1>Example</h1>
    <p>Find Contacts</p>
  </body>
</html>

Android 2.X Quirks

  • pref: Not supported by Android 2.X devices, returning false.

BlackBerry WebWorks (OS 5.0 and higher) Quirks

  • pref: Not supported by BlackBerry devices, returning false.
  • type: Not supported by BlackBerry devices, returning null.
  • name: Partially supported. The first organization name is stored in the BlackBerry company field.
  • department: Not supported, returning null.
  • title: Partially supported. The first organization title is stored in the BlackBerry jobTitle field.

iOS Quirks

  • pref: Not supported on iOS devices, returning false.
  • type: Not supported on iOS devices, returning null.
  • name: Partially supported. The first organization name is stored in the iOS kABPersonOrganizationProperty field.
  • department: Partially supported. The first department name is stored in the iOS kABPersonDepartmentProperty field.
  • title: Partially supported. The first title is stored in the iOS kABPersonJobTitleProperty field.