cookies.set()

Sets a cookie with the given 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 the extension has permissions for the given URL specified in its manifest, and a page with that URL would have permissions to create a cookie with the given parameters.

Syntax

browser.cookies.set(
  details,               // object
  function(cookie) {...} // optional function
)

Parameters

details

object. Details about the cookie being set.

url

string. The request-URI to associate with the setting of 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 API call will fail.

nameOptional

string. The name of the cookie. Empty by default if omitted.

valueOptional

string. The value of the cookie. Empty by default if omitted.

domainOptional

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

pathOptional

string. The path of the cookie. Defaults to the path portion of the url parameter.

secureOptional

boolean. Whether the cookie should be marked as Secure. Defaults to false.

httpOnlyOptional

boolean. Whether the cookie should be marked as HttpOnly. Defaults to false.

expirationDateOptional

number. The expiration date of the cookie as the number of seconds since the UNIX epoch. If omitted, the cookie becomes a session cookie.

storeIdOptional

string. The ID of the cookie store in which to set the cookie. By default, the cookie is set in the current execution context's cookie store.

callbackOptional

function. The function is passed the following arguments:

cookieOptional

cookies.Cookie. Contains details about the cookie that's been set. If setting failed for any reason, this will be "null", and runtime.lastError will be set.

Browser compatibility

Examples

var cookieData = {
    domain: "example.com",
    name: "foo",
    value: "bar",
    httpOnly: false,
    url: "https://example.com/",
    expirationDate: 1833062400
};

function onSet(cookie) {
  if (chrome.runtime.LastError) {
    console.error(chrome.runtime.LastError);
  } else {
    console.log(cookie);
  }
}

chrome.cookies.set(cookieData, onSet);

// Copyright 2015 The Chromium Authors. All rights reserved.
//
// Redistribution and use in source and binary forms, with or without
// modification, are permitted provided that the following conditions are
// met:
//
//    * Redistributions of source code must retain the above copyright
// notice, this list of conditions and the following disclaimer.
//    * Redistributions in binary form must reproduce the above
// copyright notice, this list of conditions and the following disclaimer
// in the documentation and/or other materials provided with the
// distribution.
//    * Neither the name of Google Inc. nor the names of its
// contributors may be used to endorse or promote products derived from
// this software without specific prior written permission.
//
// THIS SOFTWARE IS PROVIDED BY THE COPYRIGHT HOLDERS AND CONTRIBUTORS
// "AS IS" AND ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT
// LIMITED TO, THE IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR
// A PARTICULAR PURPOSE ARE DISCLAIMED. IN NO EVENT SHALL THE COPYRIGHT
// OWNER OR CONTRIBUTORS BE LIABLE FOR ANY DIRECT, INDIRECT, INCIDENTAL,
// SPECIAL, EXEMPLARY, OR CONSEQUENTIAL DAMAGES (INCLUDING, BUT NOT
// LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS OR SERVICES; LOSS OF USE,
// DATA, OR PROFITS; OR BUSINESS INTERRUPTION) HOWEVER CAUSED AND ON ANY
// THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT LIABILITY, OR TORT
// (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY OUT OF THE USE
// OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF SUCH DAMAGE.