Robin is a notification interface for iOS and macOS that handles UserNotifications behind the scenes.

• iOS 10.0+
• macOS 10.14+
• Xcode 10.0+
• Swift 4.2+

• If you need help or have a question, use 'robin' tag on Stack Overflow.
• If you found a bug or have a feature request, please open an issue.

Please do not open a pull request until a contribution guide is published.

Robin is available through both Swift Package Manager and CocoaPods.

To install using SPM:

.package(url: "https://github.com/ahmdx/Robin", from: "0.92.0"),

CocoaPods:

pod 'Robin', '~> 0.92.0'

And if you want to include the test suite in your project:

pod 'Robin', '~> 0.92.0', :testspecs => ['Tests']

import Robin

Before using Robin, you need to request permission to send notifications to users. The following requests badge, sound, and alert permissions.

Robin.scheduler.requestAuthorization(forOptions: [.badge, .sound, .alert]) { grant, error in
  // Handle authorization or error
}

Scheduling iOS notifications via Robin is carried over by manipulating RobinNotification objects. To create a RobinNotification object, simply call its initializer.

init(identifier: String = default, body: String, date: Date = default)

Example notification, with a unique identifier, to be fired an hour from now.

let notification = RobinNotification(body: "A notification", date: Date().next(hours: 1))

next(minutes:), next(hours:), and next(days:) are part of a Date extension.

The following table summarizes all RobinNotification properties.

[1] identifier is read-only after RobinNotification is initialized.

[2] To add and remove keys in userInfo, use setUserInfo(value: Any, forKey: AnyHashable) and removeUserInfoValue(forKey: AnyHashable) respectively.

After creating a RobinNotification object, it can be scheduled using schedule(notification:).

let scheduledNotification = Robin.scheduler.schedule(notification: notification)

Now scheduledNotification is a valid RobinNotification object if it is successfully scheduled or nil otherwise.

Simply retrieve a scheduled notification by calling notification(withIdentifier: String) -> RobinNotification?.

let scheduledNotification = Robin.scheduler.notification(withIdentifier: "identifier")

To cancel a notification, either call cancel(notification: RobinNotification) or cancel(withIdentifier: String)

Robin.scheduler.cancel(notification: scheduledNotification)

Robin.scheduler.cancel(withIdentifier: scheduledNotification.identifier)

Robin allows you to cancel all scheduled notifications by calling cancelAll()

Robin.scheduler.cancelAll()

To retrieve all delivered notifications that are displayed in the notification center, call allDelivered(completionHandler: @escaping ([RobinNotification]) -> Void).

Robin.manager.allDelivered { deliveredNotifications in
  // Access delivered notifications
}

To remove a delivered notification from the notification center, either call removeDelivered(notification: RobinNotification) or removeDelivered(withIdentifier identifier: String).

Robin.manager.removeDelivered(notification: deliveredNotification)

Robin.manager.removeDelivered(withIdentifier: deliveredNotification.identifier)

Robin allows you to remove all delivered notifications by calling removeAllDelivered()

Robin.manager.removeAllDelivered()

Robin is preset to allow 60 notifications to be scheduled by iOS. The remaining four slots are kept for the app-defined notifications. These free slots are currently not handled by Robin; if you use Robin to utilize these slots, the notifications will be discarded. To change the maximum allowed, just update Robin.maximumAllowedNotifications.

Robin currently can't handle multiple notifications with the same identifier. Support for grouping notifications under the same identifier is coming soon.

Ahmed Mohamed, [email protected]

Robin is available under the MIT license. See the LICENSE file for more info.