runtime.onUpdateAvailable

Fired when an update to the add-on is available. This event enables an add-on to delay an update: for example, because it is in the middle of some operation which should not be interrupted.

If the add-on is not listening for this event when an update becomes available, the add-on is reloaded immediately and the update is applied. If the add-on is listening, then the update will be applied the next time the add-on is reloaded. This happens if:

  • the browser is restarted
  • the add-on is disabled and re-enabled
  • the add-on explicitly reloads itself by calling runtime.reload().

Syntax

browser.runtime.onUpdateAvailable.addListener()
browser.runtime.onUpdateAvailable.removeListener(listener)
browser.runtime.onUpdateAvailable.hasListener(listener)

Events have three functions:

addListener(callback)
Adds a listener to this event.
removeListener(listener)
Stop listening to this event. The listener argument is the listener to remove.
hasListener(listener)
Checks whether a listener is registered for this event. Returns true if it is listening, false otherwise.

addListener syntax

Parameters

callback

Function that will be called when this event occurs. The function will be passed the following arguments:

details
object. Contains a single property, a string named version, which represents the version number of the update.

Browser compatibility

Chrome Edge Firefox Firefox for Android Opera
Basic support Yes No 51.0 51.0 33

Examples

Listen for UpdateAvailable events:

function handleUpdateAvailable(details) {
  console.log(details.version);
}

browser.runtime.onUpdateAvailable.addListener(handleUpdateAvailable);

Acknowledgements

This API is based on Chromium's chrome.runtime API. This documentation is derived from runtime.json in the Chromium code.

Microsoft Edge compatibility data is supplied by Microsoft Corporation and is included here under the Creative Commons Attribution 3.0 United States License.

Document Tags and Contributors

 Contributors to this page: wbamberg, Makyen, chrisdavidmills
 Last updated by: wbamberg,