navigator.unregisterProtocolHandler(scheme, url) removes a previously registered protocol handler for a URL scheme. It is the inverse of registerProtocolHandler() (MDN). Returns undefined.
Pass the required arguments shown below. Check return values and browser support before you rely on the result.
Call navigator.unregisterProtocolHandler. Start with this line.
navigator.unregisterProtocolHandler(scheme, url)| Call | What it does |
|---|---|
navigator.unregisterProtocolHandler(scheme, url) | Primary signature. |
navigator.unregisterProtocolHandler(...) | Call with the arguments your case needs. |
Built into the browser. Call unregisterProtocolHandler(...) on a Navigator — no import required.
navigator.unregisterProtocolHandler(scheme, url)| Parameter | Description |
|---|---|
| scheme | Required. Protocol to unregister (e.g. "web+burger") |
| url | Required. Handler template with %s; must match registration |
| Return Value | Description |
|---|---|
| * | Always undefined |
Check the method and secure context before calling.
const ok =
"unregisterProtocolHandler" in navigator &&
window.isSecureContext;
console.log(ok ? "ready to call" : "unavailable here");in navigator. The method may be missing (not Baseline).isSecureContext. HTTPS / localhost required (MDN).MDN shape: scheme + same-origin URL template with %s.
if (!("unregisterProtocolHandler" in navigator)) {
console.log("not supported");
} else {
try {
const url = location.origin + "/?burger=%s";
navigator.unregisterProtocolHandler("web+burger", url);
console.log("called");
} catch (err) {
console.log(err.name); // SecurityError, …
}
}location.origin + %s.SecurityError. Blocked schemes or context rules may throw.Handler URLs without the %s placeholder raise SyntaxError (MDN).
if (!("unregisterProtocolHandler" in navigator)) {
console.log("skip");
} else {
try {
navigator.unregisterProtocolHandler(
"web+burger",
location.origin + "/handler"
);
} catch (err) {
console.log(err.name); // "SyntaxError"
}
}%s. The URL is incomplete for a handler template.SyntaxError. Documented on MDN.%s. Same rule as registerProtocolHandler.Navigator.unregisterProtocolHandler() is Limited availability (not Baseline) on MDN. It requires a secure context. It is not Deprecated, Experimental, or Non-standard.
Support is strongest in some Chromium-based browsers on HTTPS. Always feature-detect and keep a no-op fallback.
Bottom line: Feature-detect, use same-origin HTTPS templates with %s, and never assume Baseline support.
Learn how to pulse the device vibrator with navigator.vibrate().
11 people found this page helpful