Which keys do I need for CNContactFormatter?

Question

I'm trying to format a contact's name using the new CNContactFormatter. It looks like, I didn't fetch all needed name properties of the contact.

Terminating app due to uncaught exception 'CNPropertyNotFetchedException', reason: 'A property was not requested when contact was fetched.'

Does anyone know which ones are required? I tried fetching the following amongst a few others with no luck:

        CNContactNamePrefixKey,
        CNContactGivenNameKey,
        CNContactFamilyNameKey,
        CNContactMiddleNameKey, 
        CNContactPreviousFamilyNameKey,
        CNContactNameSuffixKey,
        CNContactNicknameKey,
        CNContactPhoneticGivenNameKey,
        CNContactPhoneticMiddleNameKey,
        CNContactPhoneticFamilyNameKey,
        CNContactOrganizationNameKey,
        CNContactDepartmentNameKey,
        CNContactJobTitleKey,

Neither the CNContactFomatter Class Reference nor the fetching method's documentation give any clue.

Thanks!

score 23 · Accepted Answer · answered Nov 01 '15 at 04:08

23

I found this in the WWDC Session 223 (starting at slide 74) and this worked for me when I was having the same problem. Use CNContactFormatter.descriptorForRequiredKeysForStyle... in the contact selection call. Example:

let contactStore = CNContactStore()
let predicate = CNContact.predicateForContactsMatchingName("John")
let foundContacts = try contactStore.unifiedContactsMatchingPredicate(predicate, keysToFetch: [CNContactFormatter.descriptorForRequiredKeysForStyle(.FullName)]
for contact in foundContacts {
            print(CNContactFormatter.stringFromContact(contact, style: .FullName))
}

answered Nov 01 '15 at 04:08

Eric Schramm

288
2
8

Oh man, thank you! That works like a charm, even combined with some additional fields. – flohei Nov 01 '15 at 05:20
WOW. Deep cut. Thank you so much for sharing this solution! – sambecker Apr 25 '20 at 20:15

score 2 · Answer 2 · answered Sep 15 '16 at 13:58

2

class func descriptorForRequiredKeys()

Use to fetch all contact keys required to create vCard data from a contact.

https://developer.apple.com/reference/contacts/cncontactvcardserialization

Example:

let containerResults =  try contactStore.unifiedContacts(matching: fetchPredicate, keysToFetch:[CNContactVCardSerialization.descriptorForRequiredKeys()])

answered Sep 15 '16 at 13:58

ddiego

3,247
1
28
18

Isn't that different from https://developer.apple.com/documentation/contacts/cncontactformatter/1397746-descriptorforrequiredkeys ? – benc Apr 21 '18 at 07:46

Which keys do I need for CNContactFormatter?

2 Answers2