Notification

La interface Notification de la Notifications API se usa para configurar y mostrar notificaciones de escritorio al usuario.

Constructor

Notification()

Crea una nueva instancia del objecto Notification.

Propriedades

Propiedades Estáticas

Estas propiedades solo estan disponibles en el objecto Notification en sí mismo.

Notification.permission Read only

Una cadena que representa el permiso actual para mostrar notificaciones. Los valores posibles son: denied (El usuario rechaza que las notificaciones sean mostradas), granted ( El usuario acepta que las notificaciones sean mostradas ), o default (La elección del usuario es desconocida por lo tanto el navegador actuará como si el valor fuese denied).

Propiedades de Instancia

Estas propiedades solo estan disponibles en instancias del objecto Notification.

Notification.title Read only

El título de la notificación como está especificado en el parámetro options del constructor.

Notification.dir Read only

La dirección del texto de la notificación como está especificado en el parámetro options del constructor.

Notification.lang Read only

El código del lenguaje de la notificación como está especificado en el parámetro options del constructor.

Notification.body Read only

The body string de la notificación como está especificado en el parámetro options del constructor.

Notification.tag Read only

El ID de la notificación (si hay) como está especificado en el parámetro options del constructor.

Notification.icon Read only

La URL de la imagen usada como ícono de la notificación como está especificado en el parámetro options del constructor.

Notification.data Read only

Retorna un clon estructurado de los datos de la notificación.

Notification.requireInteraction Read only

Un Boolean indicando en dispositivos pantallas lo suficientemente grandes, una notificación debería permanecer activa hasta que el usuario haga click o la descarte.

Notification.silent Read only

Especifica si la notificación debería ser silenciada, por ejemplo sin generar sonidos o vibraciones, independientemente de la configuración del dispositivo.

Notification.timestamp Read only

Especifica el tiempo en la cual una notificación fué creada o aplicable (pasado, presente o futuro).

Propiedades no soportadas

The following properties are listed in the most up-to-date spec, but are not supported in any browsers yet. It is advisable to keep checking back regularly to see if the status of these has updated, and let us know if you find any out of date information.

Notification.noscreen Read only

Specifies whether the notification firing should enable the device's screen or not.

Notification.renotify Read only

Specifies whether the user should be notified after a new notification replaces an old one.

Notification.sound Read only

Specifies a sound resource to play when the notification fires, in place of the default system notification sound.

Notification.sticky Read only

Specifies whether the notification should be 'sticky', i.e. not easily clearable by the user.

Notification.vibrate Read only

Specifies a vibration pattern for devices with vibration hardware to emit.

Event handlers

Notification.onclick

A handler for the click event. It is triggered each time the user clicks on the notification.

Notification.onerror

A handler for the error event. It is triggered each time the notification encounters an error.

Obsolete handlers

The following event handlers are still supported as listed in the browser compatibility section below, but are no longer listed in the current spec. It is safe therefore to assume they are obsolete, and may stop working in future browser versions.

Notification.onclose

A handler for the close event. It is triggered when the user closes the notification.

Notification.onshow

A handler for the show event. It is triggered when the notification is displayed.

Methods

Static methods

These methods are available only on the Notification object itself.

Notification.requestPermission()

Requests permission from the user to display notifications.

Instance methods

These properties are available only on an instance of the Notification object or through its prototype. The Notification object also inherits from the EventTarget interface.

Notification.close()

Programmatically closes a notification.

Example

Assume this basic HTML:

<button onclick="notifyMe()">Notify me!</button>

It's possible to send a notification as follows — here we present a fairly verbose and complete set of code you could use if you wanted to first check whether notifications are supported, then check if permission has been granted for the current origin to send notifications, then request permission if required, before then sending a notification.

function notifyMe() {
  // Let's check if the browser supports notifications
  if (!("Notification" in window)) {
    alert("This browser does not support desktop notification");
  }

  // Let's check whether notification permissions have already been granted
  else if (Notification.permission === "granted") {
    // If it's okay let's create a notification
    var notification = new Notification("Hi there!");
  }

  // Otherwise, we need to ask the user for permission
  else if (Notification.permission !== 'denied') {
    Notification.requestPermission(function (permission) {
      // If the user accepts, let's create a notification
      if (permission === "granted") {
        var notification = new Notification("Hi there!");
      }
    });
  }

  // At last, if the user has denied notifications, and you 
  // want to be respectful there is no need to bother them any more.
}

In many cases, you don't need to be this verbose. For example, in our Emogotchi demo (see source code), we simply run Notification.requestPermission regardless to make sure we can get permission to send notifications (this uses the newer promise-based method syntax):

Notification.requestPermission().then(function(result) {
  console.log(result);
});

Then we run a simple spawnNotification() function when we want to fire a notification — this is passed arguments to specify the body, icon and title we want, then it creates the necessary options object and fires the notification using the Notification() constructor.

function spawnNotification(theBody,theIcon,theTitle) {
  var options = {
      body: theBody,
      icon: theIcon
  }
  var n = new Notification(theTitle,options);
}

Specifications

Specification	Status	Comment
Notifications API	Recommendation	Living standard

Browser compatibility

• Desktop
• Mobile

Feature	Chrome	Firefox (Gecko)	Internet Explorer	Opera	Safari
Basic support	5webkit[1] 22	4.0 moz[2] 22	No support	25	6[3]
icon	5webkit[1] 22	4.0 moz[2] 22	No support	25	No support
Available in workers	(Yes)	41.0 (41.0)	?	?	?
silent	43.0	No support	No support	No support	No support
noscreen, sticky	No support	No support	No support	No support	No support
sound	(Yes)	No support	No support	No support	No support
renotify	50.0	No support	No support	No support	No support
Promise-based Notification.requestPermission()	?	47.0 (47.0)	?	?	?

Feature	Android	Android Webview	Firefox Mobile (Gecko)	Firefox OS	IE Mobile	Opera Mobile	Safari Mobile	Chrome for Android
Basic support	?	(Yes)	4.0moz[2] 22	1.0.1moz[2] 1.2	No support	?	No support	(Yes)
icon	?	(Yes)	4.0moz[2] 22	1.0.1moz[2] 1.2	No support	?	No support	(Yes)
Available in workers	?	(Yes)	41.0 (41.0)	?	?	?	?	(Yes)
silent	No support	43.0	No support	No support	No support	No support	No support	43.0
noscreen, sticky	No support	No support	No support	No support	No support	No support	No support	No support
sound	No support	(Yes)	No support	No support	No support	No support	No support	(Yes)
renotify	No support	50.0	No support	No support	No support	No support	No support	No support
Promise-based Notification.requestPermission()	?	?	47.0 (47.0)	?	?	?	?	?

[1] Before Chrome 22, the support for notification followed an old prefixed version of the specification and used the navigator.webkitNotifications object to instantiate a new notification.

Before Chrome 32, Notification.permission was not supported.

Before Chrome 42, service worker additions were not supported.

Starting in Chrome 49, notifications do not work in incognito mode.

[2] Prior to Firefox 22 (Firefox OS <1.2), the instantiation of a new notification must be done with the navigator.mozNotification object through its createNotification method.

Prior to Firefox 22 (Firefox OS <1.2), the Notification was displayed when calling the show method and supported only the click and close events.

Nick Desaulniers wrote a Notification shim to cover both newer and older implementations.

One particular Firefox OS issue is that you can pass a path to an icon to use in the notification, but if the app is packaged you cannot use a relative path like /my_icon.png. You also can't use window.location.origin + "/my_icon.png" because window.location.origin is null in packaged apps. The manifest origin field fixes this, but it is only available in Firefox OS 1.1+. A potential solution for supporting Firefox OS <1.1 is to pass an absolute URL to an externally hosted version of the icon. This is less than ideal as the notification is displayed immediately without the icon, then the icon is fetched, but it works on all versions of Firefox OS.

When using notifications  in a Firefox OS app, be sure to add the desktop-notification permission in your manifest file. Notifications can be used at any permission level, hosted or above: "permissions": { "desktop-notification": {} }

[3] Safari started to support notification with Safari 6, but only on Mac OSX 10.8+ (Mountain Lion).

See also

Using the Notifications API