declarativeNetRequest.updateSessionRules

Modifies the set of scoped rules for the extension. The rules with IDs listed in options.removeRuleIds are first removed, and then the rules given in options.addRules are added. Note that:

  • This update happens as an atomic operation: either all specified rules are added and removed, or an error is returned.
  • These rules are not persisted across browser sessions.
  • MAX_NUMBER_OF_DYNAMIC_AND_SESSION_RULES is the maximum number of dynamic and session rules an extension can add.

Syntax

let updatedRuleset = browser.declarativeNetRequest.updateSessionRules(
    options                // object
);

Parameters

options

An object containing details of the rules to add or delete from the dynamic rules.

addRules Optional

An array of declarativeNetRequest.Rule. Details of the rules to add.

removeRuleIds Optional

An array of number. IDs of the rules to remove. Any invalid IDs are ignored.

Return value

A Promise If the request was successful, the promise is fulfilled with no arguments. If the request fails, the promise is rejected with an error message.

Examples

Browser compatibility

Desktop Mobile
Chrome Edge Firefox Internet Explorer Opera Safari WebView Android Chrome Android Firefox for Android Opera Android Safari on IOS Samsung Internet
updateSessionRules 90 90 No ? 76 15.4 ? ? No ? 15.4 ?

© 2005–2023 MDN contributors.
Licensed under the Creative Commons Attribution-ShareAlike License v2.5 or later.
https://developer.mozilla.org/en-US/docs/Mozilla/Add-ons/WebExtensions/API/declarativeNetRequest/updateSessionRules