contactschangenotifier's Introduction

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 CNContactStoreDidChange notification is received for changes your own code did, not just outside your app. 🤷
It contains undocumented userInfo fields. 🙈
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 ContactsChangeNotifier instance - it will observe all Contacts changes but post only those that from outside your app.
Observe ContactsChangeNotifier.didChangeNotification notification.
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.8")
]

contactschangenotifier's People

Contributors

Stargazers

Watchers

contactschangenotifier's Issues

Unusable from extensions

While the change notification will not be sent to extensions, it would still be beneficial if the code could build when targeting extensions. This allows including it as a dependency with other code that is shared between an app and its extension(s).

The problematic code is accessing UIApplication.shared in ContactsChangeNotifier.swift:140.

CNContactStore.currentHistoryToken is alway nil on iOS 13 and iOS 14

Everything is good til I test on my iPhone iOS 13.2.
CNContactStore.currentHistoryToken always empty.
Can you add supporting iOS list into your doc.
Thanks for reading

Phone number can't be fetched

Hello, the demo is working fine I tried to make in swift by installing pod and swift also works fine but the issue is how can I get the contact number? if anyone have idea about it let me know

Recommend Projects