get()
方法在
Cookie
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
被返回。
This is an asynchronous function that returns a
Promise
.
var getting = browser.cookies.get(
details
// object
)
details
An
对象
containing details that can be used to match a cookie to be retrieved. It can include the following properties:
firstPartyDomain
可选
A
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
.
名称
A
string
representing the name of the cookie to retrieve.
partitionKey
可选
An
对象
表示
storage partition
containing the cookie. Include this object with
topLevelSite
to obtain a cookie from partitioned storage. Otherwise, returns the cookie from unpartitioned storage. This object contains:
topLevelSite
可选
A
string
representing the first-party URL of the top-level site storage partition containing the cookie.
storeId
可选
A
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
A
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.
BCD tables only load in the browser
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);
注意：
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.
最后修改： , 由 MDN 贡献者