ContactsChangeNotifier
Which contacts changed outside your iOS app? Better CNContactStoreDidChange notification: Get real changes, without the noise.
Why Oh Why
Sadly, the Contacts changes API is a mess:
- The
CNContactStoreDidChangenotification is received for changes your own code did, not just outside your app.π€· - It contains undocumented
userInfofields.π - To get the actual changes, you need to use an Objective-C API that is not even callable from Swift.
π± - That API is easy to get wrong, and requires maintaining opaque state, or receiving the complete changes history.
π§¨
Itβs the API that time forgot.
ContactsChangeNotifier Features
- Only get notified for changes outside your app.
π― - Get the list of changes included in the notification.
π - Only get changes since last notification, not the full all-time history.
β¨ - No Objective-C required.
π₯
Usage
- Get the user's Contacts access permission (see docs).
- Keep a
ContactsChangeNotifierinstance - it will observe all Contacts changes but post only those that from outside your app. - Observe
ContactsChangeNotifier.didChangeNotificationnotification. - See change events in the notification's
contactsChangeEvents.
// 2. Keep a ContactsChangeNotifier instance
let contactsChangeNotifier = try! ContactsChangeNotifier(
store: myCNContactStore,
fetchRequest: .fetchRequest(additionalContactKeyDescriptors: myCNKeyDescriptors)
)
// 3. Observe ContactsChangeNotifier.didChangeNotification notification
let observation = NotificationCenter.default.addObserver(
forName: ContactsChangeNotifier.didChangeNotification,
object: nil,
queue: nil
) { notification in
// 4. See change events in the notification's contactsChangeEvents
for event in notification.contactsChangeEvents ?? [] {
switch event {
case let addEvent as CNChangeHistoryAddContactEvent:
print(addEvent.contact)
case let updateEvent as CNChangeHistoryUpdateContactEvent:
print(updateEvent.contact)
case let deleteEvent as CNChangeHistoryDeleteContactEvent:
print(deleteEvent.contactIdentifier)
default:
// group event
break
}
}
}
Installation
CocoaPods:
pod 'ContactsChangeNotifier'
Swift Package Manager:
dependencies: [
.package(url: "https://github.com/yonat/ContactsChangeNotifier", from: "1.0.1")
]
53 Dec 16, 2022
362 Jul 1, 2022
25 Nov 3, 2022
2 Aug 11, 2022
210 Dec 28, 2022
231 Dec 29, 2022
17 Sep 24, 2022
380 Dec 19, 2022
1 Dec 15, 2021
2 Sep 22, 2022
9 Dec 29, 2022
0 Feb 7, 2022
518 Dec 13, 2022
0 Nov 8, 2021
15 Dec 5, 2022
6 Nov 10, 2017
20 Dec 29, 2022
74 Dec 15, 2022