Local Push Notifications for iOS (incl. convenience methods and async support)

LocalNotifications.swift

import Foundation
import UIKit
import UserNotifications
import CoreLocation

enum NotificationTriggerOption {
    case date(date: Date, repeats: Bool)
    case time(timeInterval: TimeInterval, repeats: Bool)
    case location(coordinates: CLLocationCoordinate2D, radius: CLLocationDistance, notifyOnEntry: Bool, notifyOnExit: Bool, repeats: Bool)
}

struct AnyNotificationContent {
    let id: String
    let title: String
    let body: String?
    let sound: Bool
    let badge: Int?
    
    init(id: String = UUID().uuidString, title: String, body: String? = nil, sound: Bool = true, badge: Int? = nil) {
        self.id = id
        self.title = title
        self.body = body
        self.sound = sound
        self.badge = badge
    }
}

@MainActor
final class LocalNotifications {
    
    static let shared = LocalNotifications()
    private init() {}
    
    private let instance = UNUserNotificationCenter.current()
    
    /// Requests the user’s authorization to allow local and remote notifications for your app.
    @discardableResult func requestAuthorization(options: UNAuthorizationOptions = [.alert, .sound, .badge]) async throws -> Bool {
        try await instance.requestAuthorization(options: options)
    }
    
    /// Retrieves the notification authorization settings for your app.
    ///
    /// - .authorized = User previously granted permission for notifications
    /// - .denied = User previously denied permission for notifications
    /// - .notDetermined = Notification permission hasn't been asked yet.
    /// - .provisional = The application is authorized to post non-interruptive user notifications (iOS 12.0+)
    /// - .ephemeral = The application is temporarily authorized to post notifications - available to App Clips only (iOS 14.0+)
    ///
    /// - Returns: User's authorization status
    func getNotificationStatus() async throws -> UNAuthorizationStatus {
        return await withCheckedContinuation({ continutation in
            instance.getNotificationSettings { settings in
                continutation.resume(returning: settings.authorizationStatus)
                return
            }
        })
    }
    
    /// The number currently set as the badge of the app icon on the Home screen.
    var applicationIconBadgeNumber: Int {
        UIApplication.shared.applicationIconBadgeNumber
    }
    
    /// Set the number as the badge of the app icon on the Home screen.
    ///
    /// Set to 0 (zero) to hide the badge number. The default value of this property is 0.
    func setApplcationIconBadgeNumber(to int: Int) {
        UIApplication.shared.applicationIconBadgeNumber = int
    }
    
    /// Open the Settings App on user's device.
    ///
    /// If user has previously denied notification authorization, the OS prompt will not appear again. The user will need to manually turn notifications in Settings.
    func openAppSettings() throws {
        guard let url = URL(string: UIApplication.openSettingsURLString), UIApplication.shared.canOpenURL(url) else {
            throw URLError(.badURL)
        }
        UIApplication.shared.open(url)
    }
        
    /// Schedule a local notification
    func scheduleNotification(content: AnyNotificationContent, trigger: NotificationTriggerOption) async throws {
        try await scheduleNotification(
            id: content.id,
            title: content.title,
            body: content.body,
            sound: content.sound,
            badge: content.badge,
            trigger: trigger)
    }
    
    /// Schedule a local notification
    func scheduleNotification(id: String = UUID().uuidString, title: String, body: String? = nil, sound: Bool = true, badge: Int? = nil, trigger: NotificationTriggerOption) async throws {
        let notificationContent = getNotificationContent(title: title, body: body, sound: sound, badge: badge)
        let notificationTrigger = getNotificationTrigger(option: trigger)
        try await addNotification(identifier: id, content: notificationContent, trigger: notificationTrigger)
    }
    
    /// Cancel all pending notifications (notifications that are in the queue and have not yet triggered)
    func removeAllPendingNotifications() {
        instance.removeAllPendingNotificationRequests()
    }
    
    /// Remove all delivered notifications (notifications that have previously triggered)
    func removeAllDeliveredNotifications() {
        instance.removeAllDeliveredNotifications()
    }
    
    /// Remove notifications by ID
    ///
    /// - Parameters:
    ///   - ids: ID associated with scheduled notification.
    ///   - pending: Cancel pending notifications (notifications that are in the queue and have not yet triggered)
    ///   - delivered: Remove delivered notifications (notifications that have previously triggered)
    func removeNotifications(ids: [String], pending: Bool = true, delivered: Bool = true) {
        if pending {
            instance.removePendingNotificationRequests(withIdentifiers: ids)
        }
        if delivered {
            instance.removeDeliveredNotifications(withIdentifiers: ids)
        }
    }
    
}

// MARK: PRIVATE

private extension LocalNotifications {
    
    private func getNotificationContent(title: String, body: String?, sound: Bool, badge: Int?) -> UNNotificationContent {
        let content = UNMutableNotificationContent()
        content.title = title
        if let body {
            content.body = body
        }
        if sound {
            content.sound = .default
        }
        if let badge {
            content.badge = NSNumber(integerLiteral: badge)
        }
        return content
    }
    
    private func getNotificationTrigger(option: NotificationTriggerOption) -> UNNotificationTrigger {
        switch option {
        case .date(date: let date, repeats: let repeats):
            let components = Calendar.current.dateComponents([.second, .minute, .hour, .day, .month, .year], from: date)
            return UNCalendarNotificationTrigger(dateMatching: components, repeats: repeats)
        case .time(timeInterval: let timeInterval, repeats: let repeats):
            return UNTimeIntervalNotificationTrigger(timeInterval: timeInterval, repeats: repeats)
        case .location(coordinates: let coordinates, radius: let radius, notifyOnEntry: let notifyOnEntry, notifyOnExit: let notifyOnExit, repeats: let repeats):
            let region = CLCircularRegion(center: coordinates, radius: radius, identifier: UUID().uuidString)
            region.notifyOnEntry = notifyOnEntry
            region.notifyOnExit = notifyOnExit
            return UNLocationNotificationTrigger(region: region, repeats: repeats)
        }
    }
    
    private func addNotification(identifier: String?, content: UNNotificationContent, trigger: UNNotificationTrigger) async throws {
        let request = UNNotificationRequest(
            identifier: identifier ?? UUID().uuidString,
            content: content,
            trigger: trigger)
        
        try await instance.add(request)
    }
    
}