Swift Using Contacts Framework, search using phone number to get Name and User Image
In order to get this example up-and-running quickly I used the following sources of info:
Filter non-digits from string
https://stackoverflow.com/a/32700339/558933
http://www.appcoda.com/ios-contacts-framework/
The code block below includes the authorisation check because I had to get it working in order to test in the simulator. The code is just the Single-View Apps view controller and you can connect up a UIButton in the Storyboard to the findContactInfoForPhoneNumber: method to get if to run. Output is to the console - you will need to replace these print statements with something else.
If you are not interested in the full view controller code then just look at the searchForContactUsingPhoneNumber(phoneNumber: String) method. I've followed Apple's advice in the docs to run the CNContact framework asynchronously.
The code strips all the +, - and ( symbols that could be in a phone number and just matches the digits so the phone number you pass in to match MUST be exactly the same.
//
// ViewController.swift
// ContactsTest
//
// Created by Robotic Cat on 13/04/2016.
//
import UIKit
import Contacts
class ViewController: UIViewController {
// MARK: - App Logic
func showMessage(message: String) {
// Create an Alert
let alertController = UIAlertController(title: "Alert", message: message, preferredStyle: UIAlertControllerStyle.Alert)
// Add an OK button to dismiss
let dismissAction = UIAlertAction(title: "OK", style: UIAlertActionStyle.Default) { (action) -> Void in
}
alertController.addAction(dismissAction)
// Show the Alert
self.presentViewController(alertController, animated: true, completion: nil)
}
func requestForAccess(completionHandler: (accessGranted: Bool) -> Void) {
// Get authorization
let authorizationStatus = CNContactStore.authorizationStatusForEntityType(CNEntityType.Contacts)
// Find out what access level we have currently
switch authorizationStatus {
case .Authorized:
completionHandler(accessGranted: true)
case .Denied, .NotDetermined:
CNContactStore().requestAccessForEntityType(CNEntityType.Contacts, completionHandler: { (access, accessError) -> Void in
if access {
completionHandler(accessGranted: access)
}
else {
if authorizationStatus == CNAuthorizationStatus.Denied {
dispatch_async(dispatch_get_main_queue(), { () -> Void in
let message = "\(accessError!.localizedDescription)\n\nPlease allow the app to access your contacts through the Settings."
self.showMessage(message)
})
}
}
})
default:
completionHandler(accessGranted: false)
}
}
@IBAction func findContactInfoForPhoneNumber(sender: UIButton) {
self.searchForContactUsingPhoneNumber("(888)555-1212)")
}
func searchForContactUsingPhoneNumber(phoneNumber: String) {
dispatch_async(dispatch_get_global_queue(QOS_CLASS_USER_INTERACTIVE, 0), { () -> Void in
self.requestForAccess { (accessGranted) -> Void in
if accessGranted {
let keys = [CNContactGivenNameKey, CNContactFamilyNameKey, CNContactImageDataKey, CNContactPhoneNumbersKey]
var contacts = [CNContact]()
var message: String!
let contactsStore = CNContactStore()
do {
try contactsStore.enumerateContactsWithFetchRequest(CNContactFetchRequest(keysToFetch: keys)) {
(contact, cursor) -> Void in
if (!contact.phoneNumbers.isEmpty) {
let phoneNumberToCompareAgainst = phoneNumber.componentsSeparatedByCharactersInSet(NSCharacterSet.decimalDigitCharacterSet().invertedSet).joinWithSeparator("")
for phoneNumber in contact.phoneNumbers {
if let phoneNumberStruct = phoneNumber.value as? CNPhoneNumber {
let phoneNumberString = phoneNumberStruct.stringValue
let phoneNumberToCompare = phoneNumberString.componentsSeparatedByCharactersInSet(NSCharacterSet.decimalDigitCharacterSet().invertedSet).joinWithSeparator("")
if phoneNumberToCompare == phoneNumberToCompareAgainst {
contacts.append(contact)
}
}
}
}
}
if contacts.count == 0 {
message = "No contacts were found matching the given phone number."
}
}
catch {
message = "Unable to fetch contacts."
}
if message != nil {
dispatch_async(dispatch_get_main_queue(), { () -> Void in
self.showMessage(message)
})
}
else {
// Success
dispatch_async(dispatch_get_main_queue(), { () -> Void in
// Do someting with the contacts in the main queue, for example
/*
self.delegate.didFetchContacts(contacts) <= which extracts the required info and puts it in a tableview
*/
print(contacts) // Will print all contact info for each contact (multiple line is, for example, there are multiple phone numbers or email addresses)
let contact = contacts[0] // For just the first contact (if two contacts had the same phone number)
print(contact.givenName) // Print the "first" name
print(contact.familyName) // Print the "last" name
if contact.isKeyAvailable(CNContactImageDataKey) {
if let contactImageData = contact.imageData {
print(UIImage(data: contactImageData)) // Print the image set on the contact
}
} else {
// No Image available
}
})
}
}
}
})
}
}
ContactList with ContactUI Framework with Custom Tableview
import UIKit
class ContactCell: UITableViewCell {
@IBOutlet weak var PersonNameLabel: UILabel!
@IBOutlet weak var PersonMobileNOLabel: UILabel!
@IBOutlet weak var PersonImage: UIImageView!
@IBOutlet weak var PersonEmailLabel: UILabel!
}
ContactViewController
import ContactsUI
class ContactViewController: UIViewController,CNContactPickerDelegate,UITableViewDelegate,UITableViewDataSource{
var objects = [CNContact]()
@IBOutlet weak var tableView: UITableView!
override func viewDidLoad() {
super.viewDidLoad()
self.getContacts()
}
func getContacts() {
let store = CNContactStore()
switch CNContactStore.authorizationStatus(for: .contacts){
case .authorized:
self.retrieveContactsWithStore(store: store)
// This is the method we will create
case .notDetermined:
store.requestAccess(for: .contacts){succeeded, err in
guard err == nil && succeeded else{
return
}
self.retrieveContactsWithStore(store: store)
}
default:
print("Not handled")
}
}
func retrieveContactsWithStore(store: CNContactStore)
{
let keysToFetch = [CNContactFormatter.descriptorForRequiredKeys(for: .fullName), CNContactPhoneNumbersKey,CNContactImageDataKey, CNContactEmailAddressesKey] as [Any]
let request = CNContactFetchRequest(keysToFetch: keysToFetch as! [CNKeyDescriptor])
var cnContacts = [CNContact]()
do {
try store.enumerateContacts(with: request){
(contact, cursor) -> Void in
if (!contact.phoneNumbers.isEmpty) {
}
if contact.isKeyAvailable(CNContactImageDataKey) {
if let contactImageData = contact.imageData {
print(UIImage(data: contactImageData)) // Print the image set on the contact
}
} else {
// No Image available
}
if (!contact.emailAddresses.isEmpty) {
}
cnContacts.append(contact)
self.objects = cnContacts
}
} catch let error {
NSLog("Fetch contact error: \(error)")
}
NSLog(">>>> Contact list:")
for contact in cnContacts {
let fullName = CNContactFormatter.string(from: contact, style: .fullName) ?? "No Name"
NSLog("\(fullName): \(contact.phoneNumbers.description)")
}
self.tableView.reloadData()
}
func tableView(_ tableView: UITableView, numberOfRowsInSection section: Int) -> Int {
return self.objects.count
}
func tableView(_ tableView: UITableView, cellForRowAt indexPath: IndexPath) -> UITableViewCell {
let cell = tableView.dequeueReusableCell(withIdentifier: "Cell", for: indexPath as IndexPath) as! ContactCell
let contact = self.objects[indexPath.row]
print("theis my contact arrau \(self.objects.count)")
let formatter = CNContactFormatter()
cell.PersonNameLabel.text = formatter.string(from: contact )
if let actualNumber = contact.phoneNumbers.first?.value as? CNPhoneNumber {
//Get the label of the phone number
//Strip out the stuff you don't need
print(actualNumber.stringValue)
cell.PersonMobileNOLabel.text = actualNumber.stringValue
}
else{
cell.PersonMobileNOLabel.text = "N.A "
}
if let actualEmail = (contact as AnyObject).emailAddresses?.first?.value as String? {
print(actualEmail)
cell.PersonEmailLabel.text = actualEmail
}
else{
cell.PersonEmailLabel.text = "N.A "
}
if let imageData = contact.imageData {
//If so create the image
let userImage = UIImage(data: imageData)
cell.PersonImage.image = userImage;
}
else{
cell.PersonImage.image = UIImage (named: "N.A")
}
return cell
}
}