Deletes a cookie by name.
Syntax
browser.cookies.remove(
details, // object
function(details) {...} // optional function
)
Parameters
detailsobject. Information to identify the cookie to remove.urlstring. The URL associated with the cookie. If host permissions for this URL are not specified in the manifest file, the API call will fail.namestring. The name of the cookie to remove.storeIdOptionalstring. The ID of the cookie store to look in for the cookie. If unspecified, the cookie is looked for by default in the current execution context's cookie store.
callbackOptionalfunction. The function is passed the following arguments:detailsOptionalobject. Contains details about the cookie that's been removed. If removal failed for any reason, this will be "null", andruntime.lastErrorwill be set.
Additional objects
details
Contains details about the cookie that's been removed. If removal failed for any reason, this will be "null", and runtime.lastError will be set.
urlstring. The URL associated with the cookie that's been removed.namestring. The name of the cookie that's been removed.storeIdstring. The ID of the cookie store from which the cookie was removed.
Browser compatibility
Examples
Acknowledgements
This API is based on Chromium's chrome.cookies API. This documentation is derived from cookies.json in the Chromium code.
// 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.
