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.
Invoke the given callback after a notification has been added.
Argument | Description |
---|---|
|
Function to be called after the notification is added. |
|
The Notification that was added. |
Return values |
---|
Returns a Disposable on which |
Add a success notification.
Argument | Description |
---|---|
|
A String message |
|
optional
An options Object with the following keys: |
|
optional
A String with additional details about the notification. |
|
optional
A Boolean indicating whether this notification can be dismissed by the user. Defaults to |
|
optional
A String name of an icon from Octicons to display in the notification header. Defaults to |
Add an informational notification.
Argument | Description |
---|---|
|
A String message |
|
optional
An options Object with the following keys: |
|
optional
A String with additional details about the notification. |
|
optional
A Boolean indicating whether this notification can be dismissed by the user. Defaults to |
|
optional
A String name of an icon from Octicons to display in the notification header. Defaults to |
Add a warning notification.
Argument | Description |
---|---|
|
A String message |
|
optional
An options Object with the following keys: |
|
optional
A String with additional details about the notification. |
|
optional
A Boolean indicating whether this notification can be dismissed by the user. Defaults to |
|
optional
A String name of an icon from Octicons to display in the notification header. Defaults to |
Add an error notification.
Argument | Description |
---|---|
|
A String message |
|
optional
An options Object with the following keys: |
|
optional
A String with additional details about the notification. |
|
optional
A Boolean indicating whether this notification can be dismissed by the user. Defaults to |
|
optional
A String name of an icon from Octicons to display in the notification header. Defaults to |
Add a fatal error notification.
Argument | Description |
---|---|
|
A String message |
|
optional
An options Object with the following keys: |
|
optional
A String with additional details about the notification. |
|
optional
A Boolean indicating whether this notification can be dismissed by the user. Defaults to |
|
optional
A String name of an icon from Octicons to display in the notification header. Defaults to |