BackgroundFetchUpdateUIEvent.updateUI()

The updateUI() method of the BackgroundFetchUpdateUIEvent interface updates the title and icon in the user interface to show the status of a background fetch.

This method may only be run once, to notify the user on a failed or a successful fetch.

Syntax

let updateUI = BackgroundFetchUpdateUIEvent.updateUI(options);

Parameters

optionsOptional

An object containing any of the following:

iconsOptional

A list of one or more image resources, containing icons for use in the user interface. An image resource is an object containing:

src

A string which is a URL of an image.

sizesOptional

A string which is equivalent to a <link> sizes attribute.

typeOptional

A string containing an image MIME type.

labelOptional

A string providing a name for the associated image.

titleOptional

A string containing text to update the title of the user interface.

Return value

A Promise.

Exceptions

A DOMException InvalidStateError

Thrown if any of the following are true:

• The isTrusted property is false.
• The BackgroundFetchUpdateUIEvent UI updated flag is already set, indicating that the updateUI() method has already been called.
• The BackgroundFetchUpdateUIEvent is not active.

Examples

The following example demonstrates updating the UI with a title and image icon on a successful fetch.

addEventListener('backgroundfetchsuccess', (event) => {
    event.updateUI({ title: 'Episode 5 ready to listen!', 'icon: {
      src: "path/to/success.ico",
      sizes: "16x16 32x32 64x64",
    }' });
  }());
});

Specifications

Browser compatibility