ContactName

Contains different kinds of information about a [Contact](../Contact/contact.html) object's name.

Properties

  • formatted: The complete name of the contact. (DOMString)

  • familyName: The contact's family name. (DOMString)

  • givenName: The contact's given name. (DOMString)

  • middleName: The contact's middle name. (DOMString)

  • honorificPrefix: The contact's prefix (example Mr. or Dr.) (DOMString)

  • honorificSuffix: The contact's suffix (example Esq.). (DOMString)

Details

The ContactName object stores a contact's name properties.

Supported Platforms

  • Amazon Fire OS
  • Android 2.X
  • BlackBerry WebWorks 5.0+
  • iOS
  • Windows Phone 7 and 8
  • Windows 8

Quick Example

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 = "";
filter = ["displayName", "name"];
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.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","name"];
        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 ++) {
            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.honorificPrefix);
        }
    };

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

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

Android Quirks

  • formatted: Partially supported, and read-only. Returns a concatenation of honorificPrefix, givenName, middleName, familyName, and honorificSuffix.

BlackBerry WebWorks 5.0+ Quirks

  • formatted: Partially supported. Returns a concatenation of BlackBerry firstName and lastName fields.

  • familyName: Supported. Stored in BlackBerry lastName field.

  • givenName: Supported. Stored in BlackBerry firstName field.

  • middleName: Not supported, returning null.

  • honorificPrefix: Not supported, returning null.

  • honorificSuffix: Not supported, returning null.

iOS Quirks

  • formatted: Partially supported. Returns iOS Composite Name, but is read-only.