Notification

Créer des notifications bureau spécifique à l'OS

Processus : Main

Utilisation dans le processus de rendu

SI vous voulez afficher des notifications depuis un processus de rendu, vous devez utiliser l'API HTML5 de notification

Classe : Notification

Créer des notifications bureau spécifique à l'OS

Processus : Main

Notification est un EventEmitter.

Cela crée une nouvelle Notification avec les propriétés natives définies par les options.

Méthodes statiques

La classe Notification dispose des méthodes statiques suivantes :

Notification.isSupported()

Retourne boolean - Si le système actuel prend en charge les notification bureau ou non

new Notification([options])

• options Object (facultatif)
  • title string (optional) - A title for the notification, which will be shown at the top of the notification window when it is shown.
  • subtitle string (facultatif) macOS - Un sous-titre pour la notification, qui sera affiché sous le titre.
  • body string (optional) - The body text of the notification, which will be displayed below the title or subtitle.
  • silent boolean (facultatif) - Émet ou non un bruit de notification lors de l'affichage de la notification.
  • icon (string | NativeImage) (facultatif) - Une icône à utiliser dans la notification.
  • hasReply boolean (facultatif) macOS - Ajout ou non d'une option de réponse en ligne à la notification.
  • timeoutType string (optional) Linux Windows - The timeout duration of the notification. Can be 'default' or 'never'.
  • replyPlaceholder string (facultatif) macOS - L'espace réservé à écrire dans le champ de saisie de réponse en ligne.
  • sound string (facultatif) macOS - Le nom du fichier audio à jouer lorsque la notification est affichée.
  • urgency string (optional) Linux - The urgency level of the notification. Can be 'normal', 'critical', or 'low'.
  • actions NotificationAction[] (optional) macOS - Actions to add to the notification. Please read the available actions and limitations in the NotificationAction documentation.
  • closeButtonText string (optional) macOS - A custom title for the close button of an alert. An empty string will cause the default localized text to be used.
  • toastXml string (optional) Windows - A custom description of the Notification on Windows superseding all properties above. Provides full customization of design and behavior of the notification.

Événements d’instance

Les objets créés avec new Notification émettent les événements suivants :

Remarque : Certains événements sont seulement disponibles sur des systèmes d'exploitation spécifiques et sont étiquetés comme tels.

Événement : 'show'

Retourne :

• event Event

Émis lorsque la notification est affiché à l'utilisateur, notez que cet événement peut être émis plusieurs fois du fait qu'une notification peut être affichée plusieurs fois par le biais de la méthode show().

Événement : 'click'

Retourne :

• event Event

Émis lorsque l'utilisateur clique sur la notification.

Événement : 'close'

Retourne :

• event Event

Émis lorsque la notification est fermée manuellement par l'utilisateur.

Cet événement ne garantit pas d'être émis dans tous les cas de fermeture de la notification.

Événement : 'reply' macOS

Retourne :

• event Event
• reply string - La chaîne de caractères que l'utilisateur a écrite dans le champ de réponse.

Émis lorsque l'utilisateur clique sur le bouton "Reply" sur une notification avec hasReply: true.

Événement : 'action' macOS

Retourne :

• event Event
• index number - L'indice de l'action qui a été activée.

Event: 'failed' Windows

Retourne :

• event Event
• error string - The error encountered during execution of the show() method.

Emitted when an error is encountered while creating and showing the native notification.

Méthodes d’instance

Les objets créés avec new Notification ont les méthodes d'instance suivantes :

notification.show()

Montre immédiatement la notification à l'utilisateur, veuillez noter que cela signifie que contrairement à la Mise en œuvre de la notification HTML5, instanciation d'une nouvelle notification fait ne pas le montrer immédiatement à l'utilisateur, vous devez appeler cette méthode avant le système d'exploitation l'affichera.

Si la notification a déjà été affichée auparavant, cette méthode rejettera la notification précédemment affichée et en créera une nouvelle avec des propriétés identiques.

notification.close()

Rejette la notification.

Propriétés d'instance

notification.title

Une propriété string représentant le titre de la notification.

notification.subtitle

Une propriété string représentant le sous-titre de la notification.

notification.body

Une propriété string représentant le corps de la notification.

notification.replyPlaceholder

Une propriété string représentant le placeholder de la réponse de la notification.

notification.sound

Une propriété string représentant le son de la notification.

notification.closeButtonText

Une propriété string représentant le texte du bouton de fermeture de la notification.

notification.silent

Une propriété boolean qui indique si la notification est silencieuse.

notification.hasReply

A boolean property representing whether the notification has a reply action.

notification.urgency Linux

A string property representing the urgency level of the notification. Can be 'normal', 'critical', or 'low'.

Default is 'low' - see NotifyUrgency for more information.

notification.timeoutType Linux Windows

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.

notification.actions

Une propriété NotificationAction[] représentant les actions de la notification.

notification.toastXml Windows

A string property representing the custom Toast XML of the notification.

Lire un son

Sur macOS, vous pouvez spécifier le nom du son que vous voulez jouer lors de l'affichage de la notification. Any of the default sounds (under System Preferences > Sound) can be used, in addition to custom sound files. Assurez-vous que le fichier audio soit copié dans l'"app bundle" (par exemple, VotreApp.app/Contents/Resources), ou l'un des emplacements suivants :

• ~/Library/Sounds
• /Library/Sounds
• /Network/Library/Sounds
• /System/Library/Sounds

Consultez la documentation de NSSound pour plus d'informations.