Merge pull request #65 from jzgoda/add-get-contact-by-id

Adds `getContactById` search method

Author: jzgoda

README.md

@@ -209,6 +209,27 @@ contacts.getAllContacts(contactFields).then(
 );
 ```
 
+#### getContactById: Finds the contact with the matching identifier. Returns GetFetchResult. *(iOS Only)*
+```js
+var app = require("application");
+var contacts = require("nativescript-contacts");
+
+var contactId = '[Contact Identifier]'; // Assumes this is a valid contact identifier (Contact.id)
+
+contacts.getContactById(contactId).then(
+  function(args) {
+    console.log("getContactById Complete");
+    console.log(JSON.stringify(args));
+    /// Returns args:
+    /// args.data: Generic cross platform JSON object, null if no contacts were found.
+    /// args.reponse: "fetch"
+  },
+  function(err) {
+    console.log("Error: " + err);
+  }
+);
+```
+
 #### getGroups: Find groups. Returns an array of group data.
 
 ```js
@@ -520,6 +541,17 @@ Those are the system labels but you can also use any custom label you want.
 }
 ```
 
+### `GetFetchResult` Data Structure
+
+The object returned by contact fetch requests.
+
+```js
+{
+  data: Contact[];
+  response: string;
+}
+```
+
 ### iOS
 
 See apples docs on properties available:

index.ios.js

@@ -53,6 +53,59 @@ exports.getContact = function() {
     page.presentModalViewControllerAnimated(controller, true);
   });
 };
+
+exports.getContactById = function(id) {
+  return new Promise(function(resolve, reject) {
+    if (!id) {
+      reject('Missing Contact Identifier');
+    }
+    const store = new CNContactStore();
+    const searchPredicate = CNContact.predicateForContactsWithIdentifiers([id]);
+    const keysToFetch = [
+        "givenName", 
+        "familyName", 
+        "middleName", 
+        "namePrefix", 
+        "nameSuffix", 
+        "phoneticGivenName", 
+        "phoneticMiddleName", 
+        "phoneticFamilyName", 
+        "nickname", 
+        "jobTitle", 
+        "departmentName", 
+        "organizationName", 
+        "note", 
+        "phoneNumbers", 
+        "emailAddresses", 
+        "postalAddresses", 
+        "urlAddresses", 
+        "imageData",
+        "imageDataAvailable"
+    ]; // All Properties that we are using in the Model
+    let error;
+    const foundContacts = store.unifiedContactsMatchingPredicateKeysToFetchError(searchPredicate, keysToFetch, error);
+  
+    if (error) {
+      reject(error.localizedDescription);
+    }
+
+    if (foundContacts && foundContacts.count > 0) {
+      let contactModel = new Contact();
+      contactModel.initializeFromNative(foundContacts[0]);
+      
+      resolve({
+        data: [contactModel],
+        response: "fetch"
+      });
+    } else {
+      resolve({
+        data: null,
+        response: "fetch"
+      });
+    }
+  });
+}
+
 exports.getContactsByName = function(searchPredicate, contactFields) {
   return new Promise(function(resolve, reject) {
     var worker;

nativescript-contacts.d.ts

@@ -111,6 +111,7 @@ declare module "nativescript-contacts" {
     }
 
     export function getContact(): Promise<GetContactResult>;
+    export function getContactById(id: string): Promise<GetFetchResult>; // iOS Only
     export function getContactsByName(searchPredicate: string, contactFields: string[]): Promise<GetFetchResult>;
     export function getAllContacts(contactFields: string[]): Promise<GetFetchResult>;
     export function getContactsInGroup(group: Group): Promise<GetFetchResult>;