The Notification
interface of the Notifications API
is used to configure and display desktop notifications to the user.
Criador
Notification.Notification()
- Cria uma nova instância do objeto de
Notificação
.
Propriedades
Propriedades estáticas
These properties are available only on the Notification
object itself.
Notification.permission
Read only- A string representing the current permission to display notifications. Possible value are:
denied
(the user refuses to have notifications displayed),granted
(the user accepts having notifications displayed), ordefault
(the user choice is unknown and therefore the browser will act as if the value were denied).
Propriedades de instância
These properties are available only on instances of the Notification
object.
Notification.title
Read only- The title of the notification as specified in the options parameter of the constructor.
Notification.dir
Read only- The text direction of the notification as specified in the options parameter of the constructor.
Notification.lang
Read only- The language code of the notification as specified in the options parameter of the constructor.
Notification.body
Read only- The body string of the notification as specified in the options parameter of the constructor.
Notification.tag
Read only- The ID of the notification (if any) as specified in the options parameter of the constructor.
Notification.icon
Read only- The URL of the image used as an icon of the notification as specified in the options parameter of the constructor.
Notification.data
Read only- Returns a structured clone of the notification’s data.
Unsupported properties
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.silent
Read only- Specifies whether the notification should be silent, i.e. no sounds or vibrations should be issued, regardless of the device settings.
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. I 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.
Métodos
Métodos estáticos
These methods are available only on the Notification
object itself.
Notification.requestPermission()
- Requests permission from the user to display notifications.
Métodos de instância
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.
Exemplo
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 alredy 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:
Notification.requestPermission();
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);
}
Especificações
Specification | Status | Comment |
---|---|---|
Notifications API | Living Standard | Living standard |
Compatibilidade do navegador
Feature | Chrome | Firefox (Gecko) | Internet Explorer | Opera | Safari |
---|---|---|---|---|---|
Basic support | 5 webkit (see notes) 22 |
4.0 moz (see notes) 22 |
No support | 25 | 6 (see notes) |
icon |
5 webkit (see notes) 22 |
4.0 moz (see notes) 22 |
No support | 25 | No support |
silent |
43.0 | No support | No support | No support | No support |
noscreen , renotify , sound , sticky |
No support | No support | No support | No support | No support |
Feature | Android | Android Webview | Firefox Mobile (Gecko) | Firefox OS | IE Mobile | Opera Mobile | Safari Mobile | Chrome for Android |
---|---|---|---|---|---|---|---|---|
Basic support | ? |
(Yes) |
4.0 moz (see notes) 22 |
1.0.1 moz (see notes) 1.2 |
No support | ? | No support |
(Yes) |
icon |
? | (Yes) | 4.0 moz (see notes) 22 |
1.0.1 moz (see notes) 1.2 |
No support | ? | No support | (Yes) |
silent |
No support | 43.0 | No support | No support | No support | No support | No support | 43.0 |
noscreen , renotify , sound , sticky |
No support | No support | No support | No support | No support | No support | No support | No support |
Notas do Firefox OS
{{Page("/en-US/docs/Web/API/Notifications_API", "Firefox OS notes")}}
Notas do Chrome
{{Page("/en-US/docs/Web/API/Notifications_API", "Chrome notes")}}
Notas do Safari
{{Page("/en-US/docs/Web/API/Notifications_API", "Safari notes")}}