使用 WebExtensions 获取或设置 cookies, 并且在修改时能够获得通知。
你需要在 manifest.json 文件中开启“cookies”API 权限,并且需要对应站点的 主机权限 才能设置指定站点的cookie。详细信息查看 cookie 权限.
Types
cookies.Cookie
- Represents information about an HTTP cookie.
cookies.CookieStore
- Represents a cookie store in the browser.
cookies.OnChangedCause
- Represents the reason a cookie changed.
Methods
cookies.get()
- Retrieves information about a single cookie.
cookies.getAll()
- Retrieves all cookies that match a given set of filters.
cookies.set()
- Sets a cookie with the given cookie data; may overwrite equivalent cookies if they exist.
cookies.remove()
- Deletes a cookie by name.
cookies.getAllCookieStores()
- Lists all existing cookie stores.
Event handlers
cookies.onChanged
- Fired when a cookie is set or removed.
Permissions
In order to use this API, an add-on must specify the "cookies" API permission in its manifest, along with host permissions for any sites for which it wishes to access cookies. The add-on may read or write any cookies which could be read or written by a URL matching the host permissions. For example:
http://*.example.com/
-
An add-on with this host permission may:
- Read a non-secure cookie for
www.example.com
, with any path. - Write a secure or non-secure cookie for
www.example.com
, with any path.
It may not:
- Read a secure cookie for
www.example.com
.
- Read a non-secure cookie for
http://www.example.com/
-
An add-on with this host permission may:
- Read a non-secure cookie for
www.example.com
, with any path. - Read a non-secure cookie for
.example.com
, with any path. - Write a secure or non-secure cookie for
www.example.com
with any path. - Write a secure or non-secure cookie for
.example.com
with any path.
It may not:
- Read or write a cookie for
foo.example.com
. - Read or write a cookie for
foo.www.example.com
.
- Read a non-secure cookie for
*://*.example.com/
-
An add-on with this host permission may:
- Read or write a secure or non-secure cookie for
www.example.com
with any path.
- Read or write a secure or non-secure cookie for
Browser compatibility
Desktop | Mobile | ||||
---|---|---|---|---|---|
Cookie | Chrome Full support Yes | Edge Full support 14 | Firefox Full support 45 | Opera Full support Yes | Firefox Android Full support 48 |
CookieStore | Chrome Full support Yes | Edge Full support 14 | Firefox Full support 45 | Opera Full support Yes | Firefox Android Full support 48 |
OnChangedCause | Chrome Full support Yes | Edge No support No | Firefox Full support 45 | Opera Full support Yes | Firefox Android Full support 48 |
get | Chrome Full support Yes | Edge Full support 14 | Firefox
Full support
45
| Opera Full support Yes | Firefox Android Full support 48 |
getAll | Chrome Full support Yes | Edge
Full support
14
| Firefox
Full support
45
| Opera Full support Yes | Firefox Android Full support 48 |
getAllCookieStores | Chrome Full support Yes | Edge
Full support
14
| Firefox
Full support
45
| Opera Full support Yes | Firefox Android Full support 48 |
onChanged | Chrome Full support Yes | Edge No support No | Firefox Full support 45 | Opera Full support Yes | Firefox Android Full support 48 |
remove | Chrome Full support Yes | Edge Full support 14 | Firefox
Full support
45
| Opera Full support Yes | Firefox Android
Full support
48
|
sameSiteStatus | Chrome Full support Yes | Edge No support No | Firefox Full support 63 | Opera No support No | Firefox Android Full support 63 |
set | Chrome Full support Yes | Edge Full support 14 | Firefox
Full support
45
| Opera Full support Yes | Firefox Android
Full support
48
|
Legend
- Full support
- Full support
- No support
- No support
- See implementation notes.
- See implementation notes.
The "Chrome incompatibilities" section is included from https://developer.mozilla.org/en-US/Add-ons/WebExtensions/Chrome_incompatibilities using the WebExtChromeCompat macro.
If you need to update this content, edit https://developer.mozilla.org/en-US/Add-ons/WebExtensions/Chrome_incompatibilities, then shift-refresh this page to see your changes.
Edge incompatibilities
Promises are not supported in Edge. Use callbacks instead.
Example extensions
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.
// Copyright 2015 The Chromium Authors. All rights reserved. // // Redistribution and use in source and binary forms, with or without // modification, are permitted provided that the following conditions are // met: // // * Redistributions of source code must retain the above copyright // notice, this list of conditions and the following disclaimer. // * Redistributions in binary form must reproduce the above // copyright notice, this list of conditions and the following disclaimer // in the documentation and/or other materials provided with the // distribution. // * Neither the name of Google Inc. nor the names of its // contributors may be used to endorse or promote products derived from // this software without specific prior written permission. // // THIS SOFTWARE IS PROVIDED BY THE COPYRIGHT HOLDERS AND CONTRIBUTORS // "AS IS" AND ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT // LIMITED TO, THE IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR // A PARTICULAR PURPOSE ARE DISCLAIMED. IN NO EVENT SHALL THE COPYRIGHT // OWNER OR CONTRIBUTORS BE LIABLE FOR ANY DIRECT, INDIRECT, INCIDENTAL, // SPECIAL, EXEMPLARY, OR CONSEQUENTIAL DAMAGES (INCLUDING, BUT NOT // LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS OR SERVICES; LOSS OF USE, // DATA, OR PROFITS; OR BUSINESS INTERRUPTION) HOWEVER CAUSED AND ON ANY // THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT LIABILITY, OR TORT // (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY OUT OF THE USE // OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF SUCH DAMAGE.