atljeremy / NotificationQueue

An iOS library used to handle queuing and scheduling of notifications for presentation by registered notification handlers

NotificationQueue

NotificationQueue is a swift library that can be used to handle creating and scheduling notifications. it allows for registering multiple notification handlers and each have the ability to determine if they can / should handle a specific notification. NotificationQueue is very light weight and starts a background processing thread for checking if notificaitons are ready to be displayed.

Notification

Here's an example of creating a notification that should be displayed immediately, notice their is no scheduledForDate parameter.

let notification = Notification("Title", "Sub-title", .Success)

Here's an example of creating a notification that should be displayed in 5 seconds.

let delayedNotificaiton = Notification(scheduledForDate: 5.seconds.fromNow, "Title", "Sub-title", .Success)

Scheduling Notification's

Scheduling notification's is super easy, just pass them in to the "enqueueNotification:" function of the NotificationQueue.

NotificationQueue.sharedQueue().enqueueNotification(notification)
NotificationQueue.sharedQueue().enqueueNotification(delayedNotificaiton)

NotificationHandler

All Notification's must be handled by a NotificationHandler. NotificationHandler is simply a protocol that you will have your objects conform to if they should be responsible for handling Notifiation's. Here's a simple example of how to conform to the NotificationHandler protocol.

extension SomeViewController: NotificationHandler {
    
    func canHandle(notification: Notification) -> Bool {
        
        // Code to determine if the "notification" can be handled by this class instance
        // true = this class instance can and should handle the "notification"
        // false = this class instance can't and shouldn't handle the "notification"
        
        return true
    }
    
    func handle(notification: Notification) {
        
        // Code to handle showing the "notificaiton"
        
        var alert = UIAlertController(title: notification.title, message: notification.message, preferredStyle: .Alert)
        alert.addAction(UIAlertAction(title: "OK", style: .Default, handler: nil))
        presentViewController(alert, animated: true, completion: nil)
    }
    
    func isEqualToHandler(handler: NotificationHandler) -> Bool {
        
        // Code to determine if "handler" is equal to "self" (which should be a class instace which conforms to NotificationHandler)
        
        return (handler as? SomeViewController) == self
        
    }

}