cookies.onChanged
The onChanged event of the cookies API fires when a cookie that the extension can access is set or removed.
Note: When storage partitioning is active, cookies.Cookie.partitionKey contains the description of the cookie's storage partition. When modifying cookies, it's important to pass this value to cookies.set() or cookies.remove() to ensure the extension works with the correct cookie.
Note that updating a cookie's properties is implemented as a two step process:
- First, the cookie to be updated is first removed entirely, generating a notification with a
cookies.OnChangedCauseofoverwrite. - Next, a new cookie is written with the updated values, generating a second notification with a
cookies.OnChangedCauseofexplicit.
Syntax
browser.cookies.onChanged.addListener(listener)
browser.cookies.onChanged.removeListener(listener)
browser.cookies.onChanged.hasListener(listener)
This API is also available as browser.cookies.onChanged.*.
Events have three functions:
addListener(callback)-
Adds a listener to this event.
removeListener(listener)-
Stop listening to this event. The
listenerargument is the listener to remove. hasListener(listener)-
Check whether
listeneris registered for this event. Returnstrueif it is listening,falseotherwise.
addListener syntax
Parameters
callback-
A callback function that will be called when this event occurs. The function will be passed the following arguments:
changeInfo-
An
objectcontaining details of the change that occurred. Its properties are as follows:removed-
A
booleanthat is set totrueif a cookie was removed, and false if not. -
A
cookies.Cookieobject containing information about the cookie that was set or removed. cause-
A
cookies.OnChangedCausevalue representing the underlying reason behind the cookie's change.
Browser compatibility
BCD tables only load in the browser
Examples
This example listens for onChanged events and logs details from the changeInfo argument:
browser.cookies.onChanged.addListener(function(changeInfo) {
console.log('Cookie changed: ' +
'\n * Cookie: ' + JSON.stringify(changeInfo.cookie) +
'\n * Cause: ' + changeInfo.cause +
'\n * Removed: ' + changeInfo.removed);
});
Example extensions
Note: This API is based on Chromium's chrome.cookies API. This documentation is derived from cookies.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.