cookies.set()

set() 方法在 Cookie 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 在您的 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

An 对象 containing the details of the cookie you wish to set. It can have the following properties:

domain 可选

A string representing the domain of the cookie. If omitted, the cookie becomes a host-only cookie.

expirationDate 可选

A 编号 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 可选

A 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 可选

A boolean that specifies whether the cookie should be marked as HttpOnly ( true ), or not (false). If omitted, it defaults to false.

名称 可选

A string representing the name of the cookie. If omitted, this is empty by default.

partitionKey 可选

An 对象 表示 storage partition to set the cookie in. Include this object to set a cookie in partitioned storage. This object contains:

topLevelSite 可选

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

path 可选

A string representing the path of the cookie. If omitted, this defaults to the path portion of the URL parameter.

sameSiteOptional

A cookies.SameSiteStatus value that indicates the SameSite state of the cookie. If omitted, it defaults to 0, 'no_restriction'.

secure 可选

A boolean that specifies whether the cookie should be marked as secure ( true ), or not (false). If omitted, it defaults to false.

storeId 可选

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.

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.

value 可选

A 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.

浏览器兼容性

BCD tables only load in the browser

范例

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"
  });
}

						

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