Notification (fable-electron-docs-api)

Notification Type

Namespace: Fable.Electron
Assembly: Fable.Electron.dll
Parent Module: Main
Base Type: obj
All Interfaces: EventEmitter

⚠ Process Availability: Main ✔ | Renderer ❌ | Utility ❌ | Exported ✔

Create OS desktop notificationsProcess: Main> [!NOTE] If you want to show notifications from a renderer process you should use the web Notifications API### Class: Notification> Create OS desktop notificationsProcess: MainNotification is an EventEmitter.It creates a new Notification with native properties as set by the options.> [!WARNING] Electron's built-in classes cannot be subclassed in user code. For more information, see the FAQ.### Static MethodsThe Notification class has the following static methods:### Notification.isSupported()Returns boolean - Whether or not desktop notifications are supported on the current system

Constructors

Constructor Description

Constructor	Description
`Notification(?title, ?subtitle, ?body, ?silent, ?icon, ?hasReply, ?timeoutType, ?replyPlaceholder, ?sound, ?urgency, ?actions, ?closeButtonText, ?toastXml)` Full Usage: `Notification(?title, ?subtitle, ?body, ?silent, ?icon, ?hasReply, ?timeoutType, ?replyPlaceholder, ?sound, ?urgency, ?actions, ?closeButtonText, ?toastXml)` Parameters: ?title : `string` - A title for the notification, which will be displayed at the top of the notification window when it is shown. ?subtitle : `string` - ⚠ OS Compatibility: WIN ❌ \| MAC ✔ \| LIN ❌ \| MAS ❌ \|\| A subtitle for the notification, which will be displayed below the title. ?body : `string` - The body text of the notification, which will be displayed below the title or subtitle. ?silent : `bool` - Whether or not to suppress the OS notification noise when showing the notification. ?icon : `U2<string, NativeImage>` - An icon to use in the notification. If a string is passed, it must be a valid path to a local icon file. ?hasReply : `bool` - ⚠ OS Compatibility: WIN ❌ \| MAC ✔ \| LIN ❌ \| MAS ❌ \|\| Whether or not to add an inline reply option to the notification. ?timeoutType : `TimeoutType` - ⚠ OS Compatibility: WIN ✔ \| MAC ❌ \| LIN ✔ \| MAS ❌ \|\| The timeout duration of the notification. Can be 'default' or 'never'. ?replyPlaceholder : `string` - ⚠ OS Compatibility: WIN ❌ \| MAC ✔ \| LIN ❌ \| MAS ❌ \|\| The placeholder to write in the inline reply input field. ?sound : `string` - ⚠ OS Compatibility: WIN ❌ \| MAC ✔ \| LIN ❌ \| MAS ❌ \|\| The name of the sound file to play when the notification is shown. ?urgency : `Urgency` - ⚠ OS Compatibility: WIN ❌ \| MAC ❌ \| LIN ✔ \| MAS ❌ \|\| The urgency level of the notification. Can be 'normal', 'critical', or 'low'. ?actions : `NotificationAction[]` - ⚠ OS Compatibility: WIN ❌ \| MAC ✔ \| LIN ❌ \| MAS ❌ \|\| Actions to add to the notification. Please read the available actions and limitations in the `NotificationAction` documentation. ?closeButtonText : `string` - ⚠ OS Compatibility: WIN ❌ \| MAC ✔ \| LIN ❌ \| MAS ❌ \|\| A custom title for the close button of an alert. An empty string will cause the default localized text to be used. ?toastXml : `string` - ⚠ OS Compatibility: WIN ✔ \| MAC ❌ \| LIN ❌ \| MAS ❌ \|\| A custom description of the Notification on Windows superseding all properties above. Provides full customization of design and behavior of the notification. Returns: `Notification`	?title : `string` A title for the notification, which will be displayed at the top of the notification window when it is shown. ?subtitle : `string` ⚠ OS Compatibility: WIN ❌ \| MAC ✔ \| LIN ❌ \| MAS ❌ \|\| A subtitle for the notification, which will be displayed below the title. ?body : `string` The body text of the notification, which will be displayed below the title or subtitle. ?silent : `bool` Whether or not to suppress the OS notification noise when showing the notification. ?icon : `U2<string, NativeImage>` An icon to use in the notification. If a string is passed, it must be a valid path to a local icon file. ?hasReply : `bool` ⚠ OS Compatibility: WIN ❌ \| MAC ✔ \| LIN ❌ \| MAS ❌ \|\| Whether or not to add an inline reply option to the notification. ?timeoutType : `TimeoutType` ⚠ OS Compatibility: WIN ✔ \| MAC ❌ \| LIN ✔ \| MAS ❌ \|\| The timeout duration of the notification. Can be 'default' or 'never'. ?replyPlaceholder : `string` ⚠ OS Compatibility: WIN ❌ \| MAC ✔ \| LIN ❌ \| MAS ❌ \|\| The placeholder to write in the inline reply input field. ?sound : `string` ⚠ OS Compatibility: WIN ❌ \| MAC ✔ \| LIN ❌ \| MAS ❌ \|\| The name of the sound file to play when the notification is shown. ?urgency : `Urgency` ⚠ OS Compatibility: WIN ❌ \| MAC ❌ \| LIN ✔ \| MAS ❌ \|\| The urgency level of the notification. Can be 'normal', 'critical', or 'low'. ?actions : `NotificationAction[]` ⚠ OS Compatibility: WIN ❌ \| MAC ✔ \| LIN ❌ \| MAS ❌ \|\| Actions to add to the notification. Please read the available actions and limitations in the `NotificationAction` documentation. ?closeButtonText : `string` ⚠ OS Compatibility: WIN ❌ \| MAC ✔ \| LIN ❌ \| MAS ❌ \|\| A custom title for the close button of an alert. An empty string will cause the default localized text to be used. ?toastXml : `string` ⚠ OS Compatibility: WIN ✔ \| MAC ❌ \| LIN ❌ \| MAS ❌ \|\| A custom description of the Notification on Windows superseding all properties above. Provides full customization of design and behavior of the notification. Returns: `Notification`


                
                  
                    
                      Notification(?title, ?subtitle, ?body, ?silent, ?icon, ?hasReply, ?timeoutType, ?replyPlaceholder, ?sound, ?urgency, ?actions, ?closeButtonText, ?toastXml)

Full Usage:

Notification(?title, ?subtitle, ?body, ?silent, ?icon, ?hasReply, ?timeoutType, ?replyPlaceholder, ?sound, ?urgency, ?actions, ?closeButtonText, ?toastXml)

Parameters:

?title : string - A title for the notification, which will be displayed at the top of the notification window when it is shown.

?subtitle : string - ⚠ OS Compatibility: WIN ❌ | MAC ✔ | LIN ❌ | MAS ❌ || A subtitle for the notification, which will be displayed below the title.

?body : string - The body text of the notification, which will be displayed below the title or subtitle.

?silent : bool - Whether or not to suppress the OS notification noise when showing the notification.

?icon : U2<string, NativeImage> - An icon to use in the notification. If a string is passed, it must be a valid path to a local icon file.

?hasReply : bool - ⚠ OS Compatibility: WIN ❌ | MAC ✔ | LIN ❌ | MAS ❌ || Whether or not to add an inline reply option to the notification.

?timeoutType : TimeoutType - ⚠ OS Compatibility: WIN ✔ | MAC ❌ | LIN ✔ | MAS ❌ || The timeout duration of the notification. Can be 'default' or 'never'.

?replyPlaceholder : string - ⚠ OS Compatibility: WIN ❌ | MAC ✔ | LIN ❌ | MAS ❌ || The placeholder to write in the inline reply input field.

?sound : string - ⚠ OS Compatibility: WIN ❌ | MAC ✔ | LIN ❌ | MAS ❌ || The name of the sound file to play when the notification is shown.

?urgency : Urgency - ⚠ OS Compatibility: WIN ❌ | MAC ❌ | LIN ✔ | MAS ❌ || The urgency level of the notification. Can be 'normal', 'critical', or 'low'.

?actions : NotificationAction[] - ⚠ OS Compatibility: WIN ❌ | MAC ✔ | LIN ❌ | MAS ❌ || Actions to add to the notification. Please read the available actions and limitations in the NotificationAction documentation.

?closeButtonText : string - ⚠ OS Compatibility: WIN ❌ | MAC ✔ | LIN ❌ | MAS ❌ || A custom title for the close button of an alert. An empty string will cause the default localized text to be used.

?toastXml : string - ⚠ OS Compatibility: WIN ✔ | MAC ❌ | LIN ❌ | MAS ❌ || A custom description of the Notification on Windows superseding all properties above. Provides full customization of design and behavior of the notification.

Returns: Notification

?title : string: A title for the notification, which will be displayed at the top of the notification window when it is shown.
?subtitle : string: ⚠ OS Compatibility: WIN ❌ | MAC ✔ | LIN ❌ | MAS ❌ || A subtitle for the notification, which will be displayed below the title.
?body : string: The body text of the notification, which will be displayed below the title or subtitle.
?silent : bool: Whether or not to suppress the OS notification noise when showing the notification.
?icon : U2<string, NativeImage>: An icon to use in the notification. If a string is passed, it must be a valid path to a local icon file.
?hasReply : bool: ⚠ OS Compatibility: WIN ❌ | MAC ✔ | LIN ❌ | MAS ❌ || Whether or not to add an inline reply option to the notification.
?timeoutType : TimeoutType: ⚠ OS Compatibility: WIN ✔ | MAC ❌ | LIN ✔ | MAS ❌ || The timeout duration of the notification. Can be 'default' or 'never'.
?replyPlaceholder : string: ⚠ OS Compatibility: WIN ❌ | MAC ✔ | LIN ❌ | MAS ❌ || The placeholder to write in the inline reply input field.
?sound : string: ⚠ OS Compatibility: WIN ❌ | MAC ✔ | LIN ❌ | MAS ❌ || The name of the sound file to play when the notification is shown.
?urgency : Urgency: ⚠ OS Compatibility: WIN ❌ | MAC ❌ | LIN ✔ | MAS ❌ || The urgency level of the notification. Can be 'normal', 'critical', or 'low'.
?actions : NotificationAction[]: ⚠ OS Compatibility: WIN ❌ | MAC ✔ | LIN ❌ | MAS ❌ || Actions to add to the notification. Please read the available actions and limitations in the NotificationAction documentation.
?closeButtonText : string: ⚠ OS Compatibility: WIN ❌ | MAC ✔ | LIN ❌ | MAS ❌ || A custom title for the close button of an alert. An empty string will cause the default localized text to be used.
?toastXml : string: ⚠ OS Compatibility: WIN ✔ | MAC ❌ | LIN ❌ | MAS ❌ || A custom description of the Notification on Windows superseding all properties above. Provides full customization of design and behavior of the notification.

Returns: Notification

Instance members

Instance member	Description
`this.actions` Full Usage: `this.actions`	A NotificationAction[] property representing the actions of the notification.
`this.body` Full Usage: `this.body`	A string property representing the body of the notification.
`this.close ()` Full Usage: `this.close ()` Modifiers: inline	Dismisses the notification.On Windows, calling notification.close() while the notification is visible on screen will dismiss the notification and remove it from the Action Center. If notification.close() is called after the notification is no longer visible on screen, calling notification.close() will try remove it from the Action Center.
`this.closeButtonText` Full Usage: `this.closeButtonText`	A string property representing the close button text of the notification.
`this.hasReply` Full Usage: `this.hasReply`	A boolean property representing whether the notification has a reply action.
`this.offAction handler` Full Usage: `this.offAction handler` Parameters: handler : `IOnAction -> unit` Modifiers: inline	⚠ OS Compatibility: WIN ❌ \| MAC ✔ \| LIN ❌ \| MAS ❌ handler : `IOnAction -> unit`
`this.offAction handler` Full Usage: `this.offAction handler` Parameters: handler : `Event -> float -> unit` Modifiers: inline	⚠ OS Compatibility: WIN ❌ \| MAC ✔ \| LIN ❌ \| MAS ❌ handler : `Event -> float -> unit`
`this.offClick handler` Full Usage: `this.offClick handler` Parameters: handler : `Event -> unit` Modifiers: inline	Emitted when the notification is clicked by the user. handler : `Event -> unit`
`this.offClose handler` Full Usage: `this.offClose handler` Parameters: handler : `Event -> unit` Modifiers: inline	Emitted when the notification is closed by manual intervention from the user.This event is not guaranteed to be emitted in all cases where the notification is closed.On Windows, the close event can be emitted in one of three ways: programmatic dismissal with notification.close(), by the user closing the notification, or via system timeout. If a notification is in the Action Center after the initial close event is emitted, a call to notification.close() will remove the notification from the action center but the close event will not be emitted again. handler : `Event -> unit`
`this.offFailed handler` Full Usage: `this.offFailed handler` Parameters: handler : `IOnFailed -> unit` Modifiers: inline	⚠ OS Compatibility: WIN ✔ \| MAC ❌ \| LIN ❌ \| MAS ❌ Emitted when an error is encountered while creating and showing the native notification. handler : `IOnFailed -> unit`
`this.offFailed handler` Full Usage: `this.offFailed handler` Parameters: handler : `Event -> string -> unit` Modifiers: inline	⚠ OS Compatibility: WIN ✔ \| MAC ❌ \| LIN ❌ \| MAS ❌ Emitted when an error is encountered while creating and showing the native notification. handler : `Event -> string -> unit`
`this.offReply handler` Full Usage: `this.offReply handler` Parameters: handler : `IOnReply -> unit` Modifiers: inline	⚠ OS Compatibility: WIN ❌ \| MAC ✔ \| LIN ❌ \| MAS ❌ Emitted when the user clicks the "Reply" button on a notification with hasReply: true. handler : `IOnReply -> unit`
`this.offReply handler` Full Usage: `this.offReply handler` Parameters: handler : `Event -> string -> unit` Modifiers: inline	⚠ OS Compatibility: WIN ❌ \| MAC ✔ \| LIN ❌ \| MAS ❌ Emitted when the user clicks the "Reply" button on a notification with hasReply: true. handler : `Event -> string -> unit`
`this.offShow handler` Full Usage: `this.offShow handler` Parameters: handler : `Event -> unit` Modifiers: inline	Emitted when the notification is shown to the user. Note that this event can be fired multiple times as a notification can be shown multiple times through the show() method. handler : `Event -> unit`
`this.onAction handler` Full Usage: `this.onAction handler` Parameters: handler : `IOnAction -> unit` Modifiers: inline	⚠ OS Compatibility: WIN ❌ \| MAC ✔ \| LIN ❌ \| MAS ❌ handler : `IOnAction -> unit`
`this.onAction handler` Full Usage: `this.onAction handler` Parameters: handler : `Event -> float -> unit` Modifiers: inline	⚠ OS Compatibility: WIN ❌ \| MAC ✔ \| LIN ❌ \| MAS ❌ handler : `Event -> float -> unit`
`this.onClick handler` Full Usage: `this.onClick handler` Parameters: handler : `Event -> unit` Modifiers: inline	Emitted when the notification is clicked by the user. handler : `Event -> unit`
`this.onClose handler` Full Usage: `this.onClose handler` Parameters: handler : `Event -> unit` Modifiers: inline	Emitted when the notification is closed by manual intervention from the user.This event is not guaranteed to be emitted in all cases where the notification is closed.On Windows, the close event can be emitted in one of three ways: programmatic dismissal with notification.close(), by the user closing the notification, or via system timeout. If a notification is in the Action Center after the initial close event is emitted, a call to notification.close() will remove the notification from the action center but the close event will not be emitted again. handler : `Event -> unit`
`this.onFailed handler` Full Usage: `this.onFailed handler` Parameters: handler : `IOnFailed -> unit` Modifiers: inline	⚠ OS Compatibility: WIN ✔ \| MAC ❌ \| LIN ❌ \| MAS ❌ Emitted when an error is encountered while creating and showing the native notification. handler : `IOnFailed -> unit`
`this.onFailed handler` Full Usage: `this.onFailed handler` Parameters: handler : `Event -> string -> unit` Modifiers: inline	⚠ OS Compatibility: WIN ✔ \| MAC ❌ \| LIN ❌ \| MAS ❌ Emitted when an error is encountered while creating and showing the native notification. handler : `Event -> string -> unit`
`this.onReply handler` Full Usage: `this.onReply handler` Parameters: handler : `IOnReply -> unit` Modifiers: inline	⚠ OS Compatibility: WIN ❌ \| MAC ✔ \| LIN ❌ \| MAS ❌ Emitted when the user clicks the "Reply" button on a notification with hasReply: true. handler : `IOnReply -> unit`
`this.onReply handler` Full Usage: `this.onReply handler` Parameters: handler : `Event -> string -> unit` Modifiers: inline	⚠ OS Compatibility: WIN ❌ \| MAC ✔ \| LIN ❌ \| MAS ❌ Emitted when the user clicks the "Reply" button on a notification with hasReply: true. handler : `Event -> string -> unit`
`this.onShow handler` Full Usage: `this.onShow handler` Parameters: handler : `Event -> unit` Modifiers: inline	Emitted when the notification is shown to the user. Note that this event can be fired multiple times as a notification can be shown multiple times through the show() method. handler : `Event -> unit`
`this.onceAction handler` Full Usage: `this.onceAction handler` Parameters: handler : `IOnAction -> unit` Modifiers: inline	⚠ OS Compatibility: WIN ❌ \| MAC ✔ \| LIN ❌ \| MAS ❌ handler : `IOnAction -> unit`
`this.onceAction handler` Full Usage: `this.onceAction handler` Parameters: handler : `Event -> float -> unit` Modifiers: inline	⚠ OS Compatibility: WIN ❌ \| MAC ✔ \| LIN ❌ \| MAS ❌ handler : `Event -> float -> unit`
`this.onceClick handler` Full Usage: `this.onceClick handler` Parameters: handler : `Event -> unit` Modifiers: inline	Emitted when the notification is clicked by the user. handler : `Event -> unit`
`this.onceClose handler` Full Usage: `this.onceClose handler` Parameters: handler : `Event -> unit` Modifiers: inline	Emitted when the notification is closed by manual intervention from the user.This event is not guaranteed to be emitted in all cases where the notification is closed.On Windows, the close event can be emitted in one of three ways: programmatic dismissal with notification.close(), by the user closing the notification, or via system timeout. If a notification is in the Action Center after the initial close event is emitted, a call to notification.close() will remove the notification from the action center but the close event will not be emitted again. handler : `Event -> unit`
`this.onceFailed handler` Full Usage: `this.onceFailed handler` Parameters: handler : `IOnFailed -> unit` Modifiers: inline	⚠ OS Compatibility: WIN ✔ \| MAC ❌ \| LIN ❌ \| MAS ❌ Emitted when an error is encountered while creating and showing the native notification. handler : `IOnFailed -> unit`
`this.onceFailed handler` Full Usage: `this.onceFailed handler` Parameters: handler : `Event -> string -> unit` Modifiers: inline	⚠ OS Compatibility: WIN ✔ \| MAC ❌ \| LIN ❌ \| MAS ❌ Emitted when an error is encountered while creating and showing the native notification. handler : `Event -> string -> unit`
`this.onceReply handler` Full Usage: `this.onceReply handler` Parameters: handler : `IOnReply -> unit` Modifiers: inline	⚠ OS Compatibility: WIN ❌ \| MAC ✔ \| LIN ❌ \| MAS ❌ Emitted when the user clicks the "Reply" button on a notification with hasReply: true. handler : `IOnReply -> unit`
`this.onceReply handler` Full Usage: `this.onceReply handler` Parameters: handler : `Event -> string -> unit` Modifiers: inline	⚠ OS Compatibility: WIN ❌ \| MAC ✔ \| LIN ❌ \| MAS ❌ Emitted when the user clicks the "Reply" button on a notification with hasReply: true. handler : `Event -> string -> unit`
`this.onceShow handler` Full Usage: `this.onceShow handler` Parameters: handler : `Event -> unit` Modifiers: inline	Emitted when the notification is shown to the user. Note that this event can be fired multiple times as a notification can be shown multiple times through the show() method. handler : `Event -> unit`
`this.replyPlaceholder` Full Usage: `this.replyPlaceholder`	A string property representing the reply placeholder of the notification.
`this.show ()` Full Usage: `this.show ()` Modifiers: inline	Immediately shows the notification to the user. Unlike the web notification API, instantiating a new Notification() does not immediately show it to the user. Instead, you need to call this method before the OS will display it.If the notification has been shown before, this method will dismiss the previously shown notification and create a new one with identical properties.
`this.silent` Full Usage: `this.silent`	A boolean property representing whether the notification is silent.
`this.sound` Full Usage: `this.sound`	A string property representing the sound of the notification.
`this.subtitle` Full Usage: `this.subtitle`	A string property representing the subtitle of the notification.
`this.timeoutType` Full Usage: `this.timeoutType`	⚠ OS Compatibility: WIN ✔ \| MAC ❌ \| LIN ✔ \| MAS ❌ A string property representing the type of timeout duration for the notification. Can be 'default' or 'never'.If timeoutType is set to 'never', the notification never expires. It stays open until closed by the calling API or the user.
`this.title` Full Usage: `this.title`	A string property representing the title of the notification.
`this.toastXml` Full Usage: `this.toastXml`	⚠ OS Compatibility: WIN ✔ \| MAC ❌ \| LIN ❌ \| MAS ❌ A string property representing the custom Toast XML of the notification.
`this.urgency` Full Usage: `this.urgency`	⚠ OS Compatibility: WIN ❌ \| MAC ❌ \| LIN ✔ \| MAS ❌ A string property representing the urgency level of the notification. Can be 'normal', 'critical', or 'low'.Default is 'low' - see NotifyUrgency for more information.

Static members

Static member	Description
`Notification.isSupported ()` Full Usage: `Notification.isSupported ()` Returns: `bool` Modifiers: inline	Whether or not desktop notifications are supported on the current system Returns: `bool`