ServiceWorkerRegistration: showNotification() method

title

The title that must be shown within the notification.

options Optional

An object that allows configuring the notification. It can have the following properties:

actions Optional Experimental

An array of actions to display in the notification. Each element in the array is an object with the following members:

action

A string identifying a user action to be displayed on the notification.

title

A string containing action text to be shown to the user.

icon Optional

A string containing the URL of an icon to display with the action.

Appropriate responses are built using event.action within the notificationclick event.

badge Optional Experimental

A string containing the URL of an image to represent the notification when there is not enough space to display the notification itself such as for example, the Android Notification Bar. On Android devices, the badge should accommodate devices up to 4x resolution, about 96 by 96 px, and the image will be automatically masked.

body Optional

A string representing an extra content to display within the notification.

data Optional Experimental

Arbitrary data that you want to be associated with the notification. This can be of any data type.

dir Optional

The direction of the notification; it can be auto, ltr or rtl.

icon Optional

A string containing the URL of an image to be used as an icon by the notification.

image Optional Experimental

A string containing the URL of an image to be displayed in the notification.

lang Optional

Specify the lang used within the notification. This string must be a valid language tag according to RFC 5646: Tags for Identifying Languages (also known as BCP 47).

renotify Optional Experimental

A boolean that indicates whether to suppress vibrations and audible alerts when reusing a tag value. If options's renotify is true and options's tag is the empty string a TypeError will be thrown. The default is false.

requireInteraction Optional Experimental

Indicates that on devices with sufficiently large screens, a notification should remain active until the user clicks or dismisses it. If this value is absent or false, the desktop version of Chrome will auto-minimize notifications after approximately twenty seconds. The default value is false.

silent Optional

When set indicates that no sounds or vibrations should be made. If options's silent is true and options's vibrate is present a TypeError exception will be thrown. The default value is false.

tag Optional

An ID for a given notification that allows you to find, replace, or remove the notification using a script if necessary.

timestamp Optional

A timestamp, given as Unix time in milliseconds, representing the time associated with the notification. This could be in the past when a notification is used for a message that couldn't immediately be delivered because the device was offline, or in the future for a meeting that is about to start.

vibrate Optional Experimental

A vibration pattern to run with the display of the notification. A vibration pattern can be an array with as few as one member. The values are times in milliseconds where the even indices (0, 2, 4, etc.) indicate how long to vibrate and the odd indices indicate how long to pause. For example, [300, 100, 400] would vibrate 300ms, pause 100ms, then vibrate 400ms.

A Promise that resolves to undefined.

TypeError

Thrown if current service worker's state is not activating or activated, or if the user has explicitly denied the browser's permission request to use the API.

navigator.serviceWorker.register("sw.js");

function showNotification() {
  Notification.requestPermission().then((result) => {
    if (result === "granted") {
      navigator.serviceWorker.ready.then((registration) => {
        registration.showNotification("Vibration Sample", {
          body: "Buzz! Buzz!",
          icon: "../images/touch/chrome-touch-icon-192x192.png",
          vibrate: [200, 100, 200, 100, 200, 100, 200],
          tag: "vibration-sample",
        });
      });
    }
  });
}

To invoke the above function at an appropriate time, you could listen to the notificationclick event.

You can also retrieve details of the Notifications that have been fired from the current service worker using ServiceWorkerRegistration.getNotifications().