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(notification) |
Function to be called after the notification is added. |
notification |
The Notification that was added. |
| Return values |
|---|
Returns a Disposable on which |
Adding Notifications
::addSuccess(message, [options])
Add a success notification.
| Argument | Description |
|---|---|
message |
A String message |
options |
optional
An options Object with the following keys: |
.buttons |
optional
An Array of Object where each Object has the following options: |
className |
optional
String a class name to add to the button's default class name ( |
onDidClick() |
optional
Function callback to call when the button has been clicked. The context will be set to the |
text |
String inner text for the button |
.description |
optional
A Markdown String containing a longer description about the notification. By default, this will not preserve newlines and whitespace when it is rendered. |
.detail |
optional
A plain-text String containing additional details about the notification. By default, this will preserve newlines and whitespace when it is rendered. |
.dismissable |
optional
A Boolean indicating whether this notification can be dismissed by the user. Defaults to |
.icon |
optional
A String name of an icon from Octicons to display in the notification header. Defaults to |
| Return values |
|---|
Returns the Notification that was added. |
::addInfo(message, [options])
Add an informational notification.
| Argument | Description |
|---|---|
message |
A String message |
options |
optional
An options Object with the following keys: |
.buttons |
optional
An Array of Object where each Object has the following options: |
className |
optional
String a class name to add to the button's default class name ( |
onDidClick() |
optional
Function callback to call when the button has been clicked. The context will be set to the |
text |
String inner text for the button |
.description |
optional
A Markdown String containing a longer description about the notification. By default, this will not preserve newlines and whitespace when it is rendered. |
.detail |
optional
A plain-text String containing additional details about the notification. By default, this will preserve newlines and whitespace when it is rendered. |
.dismissable |
optional
A Boolean indicating whether this notification can be dismissed by the user. Defaults to |
.icon |
optional
A String name of an icon from Octicons to display in the notification header. Defaults to |
| Return values |
|---|
Returns the Notification that was added. |
::addWarning(message, [options])
Add a warning notification.
| Argument | Description |
|---|---|
message |
A String message |
options |
optional
An options Object with the following keys: |
.buttons |
optional
An Array of Object where each Object has the following options: |
className |
optional
String a class name to add to the button's default class name ( |
onDidClick() |
optional
Function callback to call when the button has been clicked. The context will be set to the |
text |
String inner text for the button |
.description |
optional
A Markdown String containing a longer description about the notification. By default, this will not preserve newlines and whitespace when it is rendered. |
.detail |
optional
A plain-text String containing additional details about the notification. By default, this will preserve newlines and whitespace when it is rendered. |
.dismissable |
optional
A Boolean indicating whether this notification can be dismissed by the user. Defaults to |
.icon |
optional
A String name of an icon from Octicons to display in the notification header. Defaults to |
| Return values |
|---|
Returns the Notification that was added. |
::addError(message, [options])
Add an error notification.
| Argument | Description |
|---|---|
message |
A String message |
options |
optional
An options Object with the following keys: |
.buttons |
optional
An Array of Object where each Object has the following options: |
className |
optional
String a class name to add to the button's default class name ( |
onDidClick() |
optional
Function callback to call when the button has been clicked. The context will be set to the |
text |
String inner text for the button |
.description |
optional
A Markdown String containing a longer description about the notification. By default, this will not preserve newlines and whitespace when it is rendered. |
.detail |
optional
A plain-text String containing additional details about the notification. By default, this will preserve newlines and whitespace when it is rendered. |
.dismissable |
optional
A Boolean indicating whether this notification can be dismissed by the user. Defaults to |
.icon |
optional
A String name of an icon from Octicons to display in the notification header. Defaults to |
.stack |
optional
A preformatted String with stack trace information describing the location of the error. |
| Return values |
|---|
Returns the Notification that was added. |
::addFatalError(message, [options])
Add a fatal error notification.
| Argument | Description |
|---|---|
message |
A String message |
options |
optional
An options Object with the following keys: |
.buttons |
optional
An Array of Object where each Object has the following options: |
className |
optional
String a class name to add to the button's default class name ( |
onDidClick() |
optional
Function callback to call when the button has been clicked. The context will be set to the |
text |
String inner text for the button |
.description |
optional
A Markdown String containing a longer description about the notification. By default, this will not preserve newlines and whitespace when it is rendered. |
.detail |
optional
A plain-text String containing additional details about the notification. By default, this will preserve newlines and whitespace when it is rendered. |
.dismissable |
optional
A Boolean indicating whether this notification can be dismissed by the user. Defaults to |
.icon |
optional
A String name of an icon from Octicons to display in the notification header. Defaults to |
.stack |
optional
A preformatted String with stack trace information describing the location of the error. |
| Return values |
|---|
Returns the Notification that was added. |