runtime.setUninstallURL()

Sets the URL to be visited when the extension is uninstalled. This may be used to clean up server-side data, do analytics, or implement surveys. The URL can be a maximum 255 characters.

This is an asynchronous function that returns a Promise.

Syntax

let settingUrl = browser.runtime.setUninstallURL(
  url             // string
)

Parameters

url: string. URL to be opened after the extension is uninstalled. This URL must have an http or https scheme. Set it to an empty string to not open a new tab upon uninstallation.

Return value

A Promise that will be fulfilled with no arguments when the URL has been set, or rejected with an error message if the operation failed.

Browser compatibility

BCD tables only load in the browser

Examples

function onSetURL() {
  console.log("set uninstall URL");
}

function onError(error) {
  console.log(`Error: ${error}`);
}

let settingUrl = browser.runtime.setUninstallURL("https://example.org");
settingUrl.then(onSetURL, onError);

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