Retrieves all cookies from a single cookie store that match the given information. The cookies returned will be sorted, with those with the longest path first. If multiple cookies have the same path length, those with the earliest creation time will be first.
Syntax
browser.cookies.getAll( details, // object function(cookies) {...} // function )
Parameters
details
object
. Information to filter the cookies being retrieved.url
Optionalstring
. Restricts the retrieved cookies to those that would match the given URL.name
Optionalstring
. Filters the cookies by name.domain
Optionalstring
. Restricts the retrieved cookies to those whose domains match or are subdomains of this one.path
Optionalstring
. Restricts the retrieved cookies to those whose path exactly matches this string.secure
Optionalboolean
. Filters the cookies by their Secure property.session
Optionalboolean
. Filters out session vs. persistent cookies.storeId
Optionalstring
. The cookie store to retrieve cookies from. If omitted, the current execution context's cookie store will be used.
callback
function
. The function is passed the following arguments:cookies
array
of
. All the existing, unexpired cookies that match the given cookie info.cookies.Cookie
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.