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.
This is an asynchronous function that returns a Promise
.
var setting = browser.cookies.set( details // object )
details
object
containing the details of the cookie you wish to set. It can have the following properties:domain
Optional
string
representing the domain of the cookie. If omitted, the cookie becomes a host-only cookie.expirationDate
Optional
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.firstPartyDomain
Optional
string
representing the first-party domain with which the cookie to will be associated. This property must be supplied if the browser has first-party isolation enabled. See First-party isolation.httpOnly
Optional
boolean
that specifies whether the cookie should be marked as HttpOnly (true
), or not (false). If omitted, it defaults to false.name
Optional
string
representing the name of the cookie. If omitted, this is empty by default.path
Optional
string
representing the path of the cookie. If omitted, this defaults to the path portion of the URL parameter.sameSiteOptional
cookies.SameSiteStatus
value that indicates the SameSite state of the cookie. If omitted, it defaults to 0, 'no_restriction'.secure
Optional
boolean
that specifies whether the cookie should be marked as secure (true
), or not (false). If omitted, it defaults to false.storeId
Optional
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.url
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.value
Optional
string
representing the value of the cookie. If omitted, this is empty by default.A Promise
that will be fulfilled with a cookies.Cookie
object containing details about the cookie that's been set. If the call fails for any reason, the promise will be rejected with an error message.
Desktop | Mobile | |||||||||||
---|---|---|---|---|---|---|---|---|---|---|---|---|
Chrome | Edge | Firefox | Internet Explorer | Opera | Safari | WebView Android | Chrome Android | Firefox for Android | Opera Android | Safari on IOS | Samsung Internet | |
set |
Yes |
14 |
45
Before version 56, this function did not modify cookies in private browsing mode. From version 56 onwards this is fixed.
|
? |
Yes |
14 |
? |
? |
48
Before version 56, this function did not modify cookies in private browsing mode. From version 56 onwards this is fixed.
|
? |
? |
? |
firstPartyDomain |
No |
No |
59 |
? |
No |
No |
? |
? |
59 |
? |
? |
? |
partitionKey |
No |
No |
94 |
? |
No |
No |
? |
? |
94 |
? |
? |
? |
sameSite |
Yes |
79 |
63 |
? |
No |
14
Only supports explicit.
|
? |
? |
63 |
? |
? |
? |
This example sets a cookie for the document hosted by the currently active tab:
var getActive = browser.tabs.query({active: true, currentWindow: true}); getActive.then(setCookie); function setCookie(tabs) { browser.cookies.set({ url: tabs[0].url, name: "favorite-color", value: "red" }); }
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.
© 2005–2021 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/cookies/set