cookies.getAll()

getAll() 方法在 Cookie API retrieves all cookies from a single cookie store that match the given information.

This is an asynchronous function that returns a Promise .

句法

var getting = browser.cookies.getAll(
details

// object


)


					

参数

details

An 对象 containing details that can be used to match cookies to be retrieved. Included properties are as follows (see Cookie type for more information on these):

domain 可选

A string representing a domain that cookies must be associated with (they can be associated either with this exact domain or one of its subdomains).

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. You can however pass null in this situation. If you do this, then cookies with any value for firstPartyDomain , as well as cookies which do not have firstPartyDomain set at all, will be included in the results. See First-party isolation .

名称 可选

A string representing a name that the cookies should have.

partitionKey 可选

An 对象 defining which storage partitions to return cookies from:

  • if omitted, returns only cookies from unpartitioned storage.
  • if included without topLevelSite , returns all cookies from partitioned and unpartitioned storage.
  • if included with topLevelSite specified, returns cookies from the specified partition storage.

This object contains:

topLevelSite 可选

A string representing the first-party URL of the top-level site storage partition containing the cookies.

path 可选

A string representing a path — the cookies' path must be identical to this one.

secure 可选

A boolean — filters cookies by their secure property, allowing you to filter secure cookies vs. non-secure cookies..

session 可选

A boolean — filters the cookies by their session property, allowing you to filter session cookies vs. persistent cookies.

storeId 可选

A string representing the cookie store to retrieve cookies from. If omitted, the current execution context's cookie store will be used.

url 可选

A string representing a URL that the retrieved cookies must be associated with.

返回值

A Promise that will be fulfilled with an array of  cookies.Cookie objects that match the properties given in the details parameter. Only unexpired cookies are returned. The cookies returned will be sorted by path length, longest to shortest. If multiple cookies have the same path length, those with the earliest creation time will be first.

浏览器兼容性

BCD tables only load in the browser

范例

In the following snippet, we are making a call to get all of the cookies the browser currently has stored that have a name of "favorite-color". When the result is returned, we are printing the value of each result to the console.

function logCookies(cookies) {
  for (let cookie of cookies) {
    console.log(cookie.value);
  }
}
var gettingAll = browser.cookies.getAll({
  name: "favorite-color"
});
gettingAll.then(logCookies);

						

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.

Found a problem with this page?

最后修改: , 由 MDN 贡献者

  1. 浏览器扩展名
  2. 快速入门
    1. What are extensions?
    2. Your first extension
    3. Your second extension
    4. Anatomy of an extension
    5. Example extensions
    6. What next?
  3. 概念
    1. Using the JavaScript APIs
    2. Content scripts
    3. Match patterns
    4. Working with files
    5. 国际化
    6. Content Security Policy
    7. Native messaging
    8. Differences between API implementations
    9. Chrome incompatibilities
  4. 用户界面
    1. 用户界面
    2. Toolbar button
    3. Address bar button
    4. Sidebars
    5. Context menu items
    6. Options page
    7. Extension pages
    8. Notifications
    9. Address bar suggestions
    10. Developer tools panels
  5. 如何
    1. Intercept HTTP requests
    2. Modify a web page
    3. Insert external content
    4. Share objects with page scripts
    5. Add a button to the toolbar
    6. Implement a settings page
    7. Work with the Tabs API
    8. Work with the Bookmarks API
    9. Work with the Cookies API
    10. Work with contextual identities
    11. Interact with the clipboard
    12. Build a cross-browser extension
  6. Firefox differentiators
  7. JavaScript API
    1. Browser support for JavaScript APIs
    2. alarms
    3. bookmarks
    4. browserAction
    5. browserSettings
    6. browsingData
    7. captivePortal
    8. clipboard
    9. 命令
    10. contentScripts
    11. contextualIdentities
    12. Cookie
      1. 方法
        1. get()
        2. getAll()
        3. getAllCookieStores()
        4. remove()
        5. set()
      2. 类型
        1. Cookie
        2. CookieStore
        3. OnChangedCause
        4. SameSiteStatus
      3. 事件
        1. onChanged
    13. devtools
    14. dns
    15. downloads
    16. events
    17. extension
    18. extensionTypes
    19. find
    20. history
    21. i18n
    22. identity
    23. idle
    24. management
    25. menus
    26. notifications
    27. omnibox
    28. pageAction
    29. permissions
    30. pkcs11
    31. privacy
    32. proxy
    33. runtime
    34. search
    35. sessions
    36. sidebarAction
    37. storage
    38. tabs
    39. theme
    40. topSites
    41. 类型
    42. userScripts
    43. webNavigation
    44. webRequest
    45. windows
  8. Manifest keys
    1. 介绍
    1. 作者
    2. background
    3. browser_action
    4. browser_specific_settings
    5. chrome_settings_overrides
    6. chrome_url_overrides
    7. 命令
    8. content_scripts
    9. content_security_policy
    10. default_locale
    11. description
    12. developer
    13. devtools_page
    14. dictionaries
    15. externally_connectable
    16. homepage_url
    17. icons
    18. incognito
    19. manifest_version
    20. name
    21. offline_enabled
    22. omnibox
    23. optional_permissions
    24. options_page
    25. options_ui
    26. page_action
    27. permissions
    28. protocol_handlers
    29. short_name
    30. sidebar_action
    31. storage
    32. theme
    33. theme_experiment
    34. user_scripts
    35. version
    36. version_name
    37. web_accessible_resources
  9. Extension Workshop
    1. Develop
    2. Publish
    3. Manage
    4. Enterprise
  10. Contact us
  11. Channels
    1. Add-ons blog
    2. Add-ons forum
    3. Add-ons chat