我们的志愿者还没有将这篇文章翻译为 中文 (简体)。加入我们帮助完成翻译!
The set()
method of the cookies
API sets a cookie containing the specified cookie data. This method is equivalent to issuing an HTTP Set-Cookie
header during a request to a given URL.
The call succeeds only if you include the "cookies" API permission in your manifest.json file, as well as host permissions for the given URL specified in its manifest. The given URL also needs the necessary permissions to create a cookie with the given parameters.
Syntax
chrome.cookies.set( details, // object function(cookie) {...} // optional function )
This API is also available as browser.cookies.set()
in a version that returns a promise.
Parameters
details
- An
object
containing the details of the cookie you wish to set. It can have the following properties: -
url
- A
string
representing the request-URI to associate with the cookie. This value can affect the default domain and path values of the created cookie. If host permissions for this URL are not specified in the manifest file, the method call will fail. name
Optional- A
string
representing the name of the cookie. If omitted, this is empty by default. value
Optional- A
string
representing the value of the cookie. If omitted, this is empty by default. domain
Optional- A
string
representing the domain of the cookie. If omitted, the cookie becomes a host-only cookie. path
Optional- A
string
representing the path of the cookie. If omitted, this defaults to the path portion of the URL parameter. secure
Optional- A
boolean
that specifies whether the cookie should be marked as secure (true
), or not (false). If omitted, it defaults to false. httpOnly
Optional- A
boolean
that specifies whether the cookie should be marked as HttpOnly (true
), or not (false). If omitted, it defaults to false. expirationDate
Optional- A
number
that represents the expiration date of the cookie as the number of seconds since the UNIX epoch. If omitted, the cookie becomes a session cookie. storeId
Optional- A
string
representing the ID of the cookie store in which to set the cookie. If omitted, the cookie is set in the current execution context's cookie store by default
function
Optional- A callback function, which is passed a
cookies.Cookie
object containing details about the cookie that's been set. If the call fails for any reason, this will be given a value ofnull
, andruntime.lastError
will be set.
Browser compatibility
The compatibility table in this page is generated from structured data. If you'd like to contribute to the data, please check out https://github.com/mdn/browser-compat-data and send us a pull request.
Chrome | Edge | Firefox | Firefox for Android | Opera | |
---|---|---|---|---|---|
Basic support | Yes | Yes | 45.0 | 48.0 | 33 |
Examples
In this code snippet, taken from our cookie-bg-picker example, a function is run when the color picker form input has a new color entered into it. The tabs.query()
method is first used to get information about the current tab, after which tabs.sendMessage()
is used to send the new color choice to the content script so it can update the background of the page with the new color, and set()
is used to save that preference in a cookie.
colorPick.onchange = function(e) { chrome.tabs.query({active: true, currentWindow: true}, function(tabs) { var currColor = e.target.value; chrome.tabs.sendMessage(tabs[0].id, {color: currColor}); cookieVal.color = currColor; chrome.cookies.set({ url: tabs[0].url, name: "bgpicker", value: JSON.stringify(cookieVal) }) }); }
Example add-ons
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.