APAddressBook is a wrapper on AddressBook.framework that gives easy access to native address book without pain in a head.

Features

• Load contacts from iOS address book asynchronously
• Decide what contact data fields you need to load (for example, only first name and phone number)
• Filter contacts to get only necessary records (for example, you need only contacts with email)
• Sort contacts with array of any NSSortDescriptor

Objective-c

Installation

Add APAddressBook pod to Podfile

pod 'APAddressBook'

Load contacts

APAddressBook *addressBook = [[APAddressBook alloc] init];
// don't forget to show some activity
[addressBook loadContacts:^(NSArray *contacts, NSError *error)
{
    // hide activity
    if (!error)
    {
        // do something with contacts array
    }
    else
    {
        // show error
    }
}];

Callback block will be run on main queue! If you need to run callback block on custom queue use loadContactsOnQueue:completion: method

Select contact fields bit-mask

Available fields:

• APContactFieldFirstName - contact first name
• APContactFieldMiddleName - contact middle name
• APContactFieldLastName - contact last name
• APContactFieldCompany - contact company (organization)
• APContactFieldPhones - contact phones array
• APContactFieldEmails - contact emails array
• APContactFieldPhoto - contact photo
• APContactFieldThumbnail - contact thumbnail
• APContactFieldCreationDate - contact creation date
• APContactFieldModificationDate - contact modification date
• APContactFieldPhonesWithLabels - contact phones with labels
• APContactFieldCompositeName - the concatenated value of prefix, suffix, organization, first name, and last name
• APContactFieldAddresses - array of user addresses
• APContactFieldRecordID - ID of record in iOS address book
• APContactFieldSocialProfiles - array of social profiles
• APContactFieldNote - contact notes
• APContactFieldDefault - contact first name, last name and phones array
• APContactFieldAll - all contact fields described above

You should use APContactFieldPhoto very carefully, because it takes a lot of memory and may crash the application. Using APContactFieldThumbnail is much safer.

Example of loading contact with first name and photo:

APAddressBook *addressBook = [[APAddressBook alloc] init];
addressBook.fieldsMask = APContactFieldFirstName | APContactFieldPhoto;

Filter contacts

The most common use of this option is to filter contacts without phone number. Example:

addressBook.filterBlock = ^BOOL(APContact *contact)
{
    return contact.phones.count > 0;
};

Sort contacts

APAddressBook returns unsorted contacts. So, most of users would like to sort contacts by first name and last name.

addressBook.sortDescriptors = @[
    [NSSortDescriptor sortDescriptorWithKey:@"firstName" ascending:YES],
    [NSSortDescriptor sortDescriptorWithKey:@"lastName" ascending:YES]
];

Check address book access

switch([APAddressBook access])
{
    case APAddressBookAccessUnknown:
        // Application didn't request address book access yet
        break;

    case APAddressBookAccessGranted:
        // Access granted
        break;

    case APAddressBookAccessDenied:
        // Access denied or restricted by privacy settings
        break;
}

Observe address book external changes

// start observing
[addressBook startObserveChangesWithCallback:^
{
    NSLog(@"Address book changed!");
}];
// stop observing
[addressBook stopObserveChanges];

Swift

Installation

pod 'APAddressBook/Swift'

Import APAddressBook-Bridging.h to application's objective-c bridging file.

#import "APAddressBook-Bridging.h"

Example

See exmaple application in Example/Swift directory.

self.addressBook.loadContacts(
    { (contacts: [AnyObject]!, error: NSError!) in
        if contacts {
            // do something with contacts
        }
        else if error {
            // show error
        }
    })

History

Releases

Contributor guide

Contributor Guide

Contacts

If you have improvements or concerns, feel free to post an issue and write details.

Check out all Alterplay's GitHub projects. Email us with other ideas and projects.