NotificationManager Essential

A notification manager used to create Notifications to be shown to the user.

An instance of this class is always available as the atom.notifications global.

Events

::onDidAddNotification(callback)

Invoke the given callback after a notification has been added.

Argument	Description
`callback`	Function to be called after the notification is added.
`notification`	The Notification that was added.

Return values
Returns a Disposable on which `.dispose()` can be called to unsubscribe.

Adding Notifications

::addSuccess(message, options)

Add a success notification.

Argument	Description
`message`	A String message
`options`	optional An options Object with the following keys:
`detail`	optional A String with additional details about the notification.
`dismissable`	optional A Boolean indicating whether this notification can be dismissed by the user. Defaults to `false`.
`icon`	optional A String name of an icon from Octicons to display in the notification header. Defaults to `'check'`.

::addInfo(message, options)

Add an informational notification.

Argument	Description
`message`	A String message
`options`	optional An options Object with the following keys:
`detail`	optional A String with additional details about the notification.
`dismissable`	optional A Boolean indicating whether this notification can be dismissed by the user. Defaults to `false`.
`icon`	optional A String name of an icon from Octicons to display in the notification header. Defaults to `'info'`.

::addWarning(message, options)

Add a warning notification.

Argument	Description
`message`	A String message
`options`	optional An options Object with the following keys:
`detail`	optional A String with additional details about the notification.
`dismissable`	optional A Boolean indicating whether this notification can be dismissed by the user. Defaults to `false`.
`icon`	optional A String name of an icon from Octicons to display in the notification header. Defaults to `'alert'`.

::addError(message, options)

Add an error notification.

Argument	Description
`message`	A String message
`options`	optional An options Object with the following keys:
`detail`	optional A String with additional details about the notification.
`dismissable`	optional A Boolean indicating whether this notification can be dismissed by the user. Defaults to `false`.
`icon`	optional A String name of an icon from Octicons to display in the notification header. Defaults to `'flame'`.

::addFatalError(message, options)

Add a fatal error notification.

Argument	Description
`message`	A String message
`options`	optional An options Object with the following keys:
`detail`	optional A String with additional details about the notification.
`dismissable`	optional A Boolean indicating whether this notification can be dismissed by the user. Defaults to `false`.
`icon`	optional A String name of an icon from Octicons to display in the notification header. Defaults to `'bug'`.

Getting Notifications

::getNotifications()

Get all the notifications.

Return values
Returns an Array of Notifications.

Chapter 1: Getting Started

Chapter 2: Using Atom

Chapter 3: Hacking Atom

Chapter 4: Behind Atom

Reference: API

Appendix A: Resources

Appendix B: FAQ

Appendix C: Shadow DOM

Appendix D: Upgrading to 1.0 APIs

Appendix E: Atom server-side APIs

mac

windows

linux