The get()
method of the cookies
API retrieves information about a single cookie, given its name and URL.
If more than one cookie with the same name exists for a given URL, the one with the longest path will be returned. For cookies with the same path length, the cookie with the earliest creation time will be returned. If no matching cookie could be found, null
is returned.
This is an asynchronous function that returns a Promise
.
var getting = browser.cookies.get( details // object )
details
object
containing details that can be used to match a cookie to be retrieved. It can include the following properties:firstPartyDomain
Optional
string
representing the first-party domain with which the cookie to retrieve is associated. This property must be supplied if the browser has first-party isolation enabled. See First-party isolation.name
string
representing the name of the cookie to retrieve.storeId
Optional
string
representing the ID of the cookie store
in which to look for the cookie (as returned by cookies.getAllCookieStores()
). By default, the current execution context's cookie store will be used.url
string
representing the URL with which the cookie to retrieve is associated. This argument may be a full URL, in which case any data following the URL path (e.g. the query string) is ignored. If host permissions for this URL are not specified in the extension's manifest file, the API call will fail.A Promise
that will be fulfilled with a Cookie
object containing details about the cookie, or null
if the cookie was not found.
Desktop | Mobile | |||||||||||
---|---|---|---|---|---|---|---|---|---|---|---|---|
Chrome | Edge | Firefox | Internet Explorer | Opera | Safari | WebView Android | Chrome Android | Firefox for Android | Opera Android | Safari on IOS | Samsung Internet | |
get |
Yes |
14 |
45
Provides access to cookies from private browsing mode and container tabs since version 52.
|
? |
Yes |
14
HTTPOnly cookies are not retrieved.
|
? |
? |
48 |
? |
? |
? |
firstPartyDomain |
No |
No |
59 |
? |
No |
No |
? |
? |
59 |
? |
? |
? |
partitionKey |
No |
No |
94 |
? |
No |
No |
? |
? |
94 |
? |
? |
? |
This example tries to get the cookie named "favorite-color", associated with the URL for the currently active tab:
function logCookie(cookie) { if (cookie) { console.log(cookie.value); } } function getCookie(tabs) { var getting = browser.cookies.get({ url: tabs[0].url, name: "favorite-color" }); getting.then(logCookie); } var getActive = browser.tabs.query({ active: true, currentWindow: true }); getActive.then(getCookie);
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/get