Class

NSUserNotificationCenter

An object that delivers notifications from apps to the user.

Declaration

@interface NSUserNotificationCenter : NSObject

Overview

When a user notification’s delivery date has been reached, or it is manually delivered, the notification center may display the notification to the user. The user notification center reserves the right to decide if a delivered user notification is presented to the user. For example, it may suppress the notification if the application is already frontmost (the delegate can override this action). The application can check the result of this decision by examining the presented property of a delivered user notification.

NSUserNotification instances the NSUserNotificationCenter are tracking will be in one of two states: scheduled or delivered. A scheduled user notification has a deliveryDate. On that delivery date, the notification will move from being scheduled to being delivered. Note that the user notification may be displayed later than the delivery date depending on a number of factors.

A delivered user notification has an actualDeliveryDate. That is the date when it moved from being scheduled to delivered, or when it was manually delivered using the deliverNotification: method.

The application and the user notification center are both ultimately subject to the user’s preferences. If the user decides to hide all alerts from your application, the presented property will still behave as above, but the user will not see any animation or hear any sound.

The NSUserNotificationCenterDelegate provides more information about the delivered user notification and allows forcing the display of a user notification even if the application is frontmost.

Threading Information

The NSUserNotificationCenter class and the NSUserNotification class are both thread safe.

Topics

Creating the Default User Notification Center

defaultUserNotificationCenter

Returns the default user notification center.

Managing the Scheduled Notification Queue

scheduleNotification:

Schedules the specified user notification.

scheduledNotifications

Specifies an array of scheduled user notifications that have not yet been delivered.

removeScheduledNotification:

Removes the specified user notification for the scheduled notifications.

Managing the Delivered Notifications

deliverNotification:

Deliver the specified user notification.

deliveredNotifications

An array of all user notifications delivered to the notification center.

removeDeliveredNotification:

Remove a delivered user notification from the user notification center.

removeAllDeliveredNotifications

Remove all delivered user notifications from the user notification center.

Getting and Setting the Delegate

delegate

Specifies the notification center delegate.

Relationships

Inherits From

See Also

User Notifications

NSUserNotification

A notification that can be scheduled for display in the notification center.

Deprecated
NSUserNotificationAction

An action that the user can take in response to receiving a notification.

Deprecated
NSUserNotificationCenterDelegate

An interface that enables customizing the behavior of the default notification center.