ContentIndexEvent

Draft
This page is not complete.

The ContentIndexEvent interface of the Content Index API defines the object used to represent the contentdelete event.

This event is sent to the global scope of a ServiceWorker. It contains the id of the indexed content to be removed.

The contentdelete event is only fired when the deletion happens due to interaction with the browser's built-in user interface. It is not fired when the ContentIndex.delete method is called.

Constructor

ContentIndexEvent(): Creates and returns a new ContentIndexEvent object whose type and other options are configured as specified.

Properties

In addition to the properties listed below, this interface inherits the properties of its parent interface, ExtendableEvent.

id Read only: A String which identifies the deleted content index via it's id.

Methods

While ContentIndexEvent offers no methods of its own, it inherits any specified by its parent interface, ExtendableEvent.

Examples

This example shows the sevice worker script listening for the contentdelete event and logs the removed content index id.

self.addEventListener('contentdelete', (event) => {
  console.log(event.id);

  // logs content index id, which can then be used to determine what content to delete from your cache

});

Specifications

Specification	Status	Comment
Unknown The definition of 'ContentIndexEvent' in that specification.	Unknown	Initial definition.

Browser compatibility

No compatibility data found. Please contribute data for "api.ContentIndexEvent" (depth: 1) to the MDN compatibility data repository.