From 8b1d765ba965eee30319fa2615f96ba34a220bae Mon Sep 17 00:00:00 2001 From: "aa@chromium.org" Date: Fri, 16 Jul 2010 20:33:21 +0000 Subject: This little guy got left behind. TBR=kathyw@chromium.org BUG=41663 git-svn-id: svn://svn.chromium.org/chrome/trunk/src@52733 0039d316-1c4b-4281-b951-d872f2087c98 --- chrome/common/extensions/docs/cookies.html | 3289 ++++++++++++++++++++++++++++ 1 file changed, 3289 insertions(+) create mode 100644 chrome/common/extensions/docs/cookies.html diff --git a/chrome/common/extensions/docs/cookies.html b/chrome/common/extensions/docs/cookies.html new file mode 100644 index 0000000..e4cf300 --- /dev/null +++ b/chrome/common/extensions/docs/cookies.html @@ -0,0 +1,3289 @@ + + + + + + + + chrome.cookies - Google Chrome Extensions - Google Code
+
+ You are viewing extension docs in chrome via the 'file:' scheme: are you expecting to see local changes when you refresh? You'll need run chrome with --allow-file-access-from-files. +
+ + +
+ + +
+
+ paramName + + + +
+ ( + optional + enumerated + + + Type + + + + array of + + paramType + + + + ) +
+ + +
+
+ Undocumented. +
+
+ Description of this parameter from the json schema. +
+
+ This parameter was added in version + . + You must omit this parameter in earlier versions, + and you may omit it in any version. If you require this + parameter, the manifest key + minimum_chrome_version + can ensure that your extension won't be run in an earlier browser version. +
+ + +
+
+
+
+
+
+
+
+
+ +
+ + + + + + + + + + + +
+ + +
+

Google Chrome Extensions (Labs)

+ +
+ +
+ + + +
+
+

chrome.cookies

+
+ +
+

Contents

+
    +
  1. + Manifest +
      +
    1. + h3Name +
      2. +
    +
    2. +
  2. + API reference: chrome.cookies +
      +
    1. + Properties +
        +
      1. + propertyName +
        2. +
      +
      2. +
    2. + Methods +
        +
      1. + get +
      2. + getAll +
      3. + getAllCookieStores +
      4. + remove +
      5. + set +
        6. +
      +
      3. +
    3. + Events +
        +
      1. + onChanged +
        2. +
      +
      4. +
    4. + Types +
        +
      1. + Cookie +
      2. + CookieStore +
        3. +
      +
      5. +
    +
    3. +
+
+ + + +
+

Manifest

+ +

To use the cookies API, +you must declare the "cookies" permission in your manifest, +along with host permissions +for any hosts whose cookies +you want to access. +For example:

+ +
{
+  "name": "My extension",
+  ...
+  "permissions": [
+    "cookies",
+    "*://*.google.com"
+  ],
+  ...
+}
+ + +
+ + +
+ +

API reference: chrome.cookies

+ + + + + +
+ +

Methods

+ + +
+ +

get

+ +
void + + chrome.cookies.get(, object + details, function + callback)
+ +
+ +

Retrieves information about a single cookie. If more than one cookie of the same name exists for the given URL, the one with the longest domain property will be returned. For cookies with the same domain property length, the one with the longest path length will be returned. If domains and paths are equal, then the cookie with the earliest creation time will be returned.

+ + +

Parameters

+
+
+
+
+ details + + + +
+ ( + + + + + Type + + + + array of + + object + + + + ) +
+ + +
+ +
Details to identify the cookie being retrieved.
+
+ This parameter was added in version + . + You must omit this parameter in earlier versions, + and you may omit it in any version. If you require this + parameter, the manifest key + minimum_chrome_version + can ensure that your extension won't be run in an earlier browser version. +
+ + +
+
+
+
+
+ url + + + +
+ ( + + + + + Type + + + + array of + + string + + + + ) +
+ + +
+ +
The URL with which the cookie to retrieve is associated. This argument may be a full URL, in which case any data following the URL path (e.g. the query string) is simply ignored. If host permissions for this URL are not specified in the manifest file, the API call will fail.
+
+ This parameter was added in version + . + You must omit this parameter in earlier versions, + and you may omit it in any version. If you require this + parameter, the manifest key + minimum_chrome_version + can ensure that your extension won't be run in an earlier browser version. +
+ + +
+
+
+
+
+
+
+
+
+
+
+
+ name + + + +
+ ( + + + + + Type + + + + array of + + string + + + + ) +
+ + +
+ +
The name of the cookie to retrieve.
+
+ This parameter was added in version + . + You must omit this parameter in earlier versions, + and you may omit it in any version. If you require this + parameter, the manifest key + minimum_chrome_version + can ensure that your extension won't be run in an earlier browser version. +
+ + +
+
+
+
+
+
+
+
+
+
+
+
+ storeId + + + +
+ ( + optional + + + + Type + + + + array of + + string + + + + ) +
+ + +
+ +
The ID of the cookie store in which to look for the cookie. By default, the current execution context's cookie store will be used.
+
+ This parameter was added in version + . + You must omit this parameter in earlier versions, + and you may omit it in any version. If you require this + parameter, the manifest key + minimum_chrome_version + can ensure that your extension won't be run in an earlier browser version. +
+ + +
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+ callback + + + +
+ ( + + + + + Type + + + + array of + + function + + + + ) +
+ + +
+
+ Undocumented. +
+
+ Description of this parameter from the json schema. +
+
+ This parameter was added in version + . + You must omit this parameter in earlier versions, + and you may omit it in any version. If you require this + parameter, the manifest key + minimum_chrome_version + can ensure that your extension won't be run in an earlier browser version. +
+ + +
+
+
+
+
+
+
+
+
+
+
+ + +

Returns

+
+
+
+
+
+
+ + +
+
+

Callback function

+

+ The callback parameter should specify a function + that looks like this: +

+

+ If you specify the callback parameter, it should + specify a function that looks like this: +

+ + + 
function(Cookie cookie) {...});
+
+
+
+
+ cookie + + + +
+ ( + optional + + + + Cookie + + + + array of + + paramType + + + + ) +
+ + +
+ +
Contains details about the cookie. This parameter is null if no such cookie was found.
+
+ This parameter was added in version + . + You must omit this parameter in earlier versions, + and you may omit it in any version. If you require this + parameter, the manifest key + minimum_chrome_version + can ensure that your extension won't be run in an earlier browser version. +
+ + +
+
+
+
+
+
+
+
+
+
+
+
+
+ + +

+ This function was added in version . + If you require this function, the manifest key + minimum_chrome_version + can ensure that your extension won't be run in an earlier browser version. +

+
+ +
+ +

getAll

+ +
void + + chrome.cookies.getAll(, object + details, function + callback)
+ +
+ +

Retrieves all cookies from a single cookie store that match the given information.

+ + +

Parameters

+
+
+
+
+ details + + + +
+ ( + + + + + Type + + + + array of + + object + + + + ) +
+ + +
+ +
Information to filter the cookies being retrieved.
+
+ This parameter was added in version + . + You must omit this parameter in earlier versions, + and you may omit it in any version. If you require this + parameter, the manifest key + minimum_chrome_version + can ensure that your extension won't be run in an earlier browser version. +
+ + +
+
+
+
+
+ url + + + +
+ ( + optional + + + + Type + + + + array of + + string + + + + ) +
+ + +
+ +
Restricts the retrieved cookies to those that would match the given URL.
+
+ This parameter was added in version + . + You must omit this parameter in earlier versions, + and you may omit it in any version. If you require this + parameter, the manifest key + minimum_chrome_version + can ensure that your extension won't be run in an earlier browser version. +
+ + +
+
+
+
+
+
+
+
+
+
+
+
+ name + + + +
+ ( + optional + + + + Type + + + + array of + + string + + + + ) +
+ + +
+ +
Filters the cookies by name.
+
+ This parameter was added in version + . + You must omit this parameter in earlier versions, + and you may omit it in any version. If you require this + parameter, the manifest key + minimum_chrome_version + can ensure that your extension won't be run in an earlier browser version. +
+ + +
+
+
+
+
+
+
+
+
+
+
+
+ domain + + + +
+ ( + optional + + + + Type + + + + array of + + string + + + + ) +
+ + +
+ +
Restricts the retrieved cookies to those whose domains match or are subdomains of this one.
+
+ This parameter was added in version + . + You must omit this parameter in earlier versions, + and you may omit it in any version. If you require this + parameter, the manifest key + minimum_chrome_version + can ensure that your extension won't be run in an earlier browser version. +
+ + +
+
+
+
+
+
+
+
+
+
+
+
+ path + + + +
+ ( + optional + + + + Type + + + + array of + + string + + + + ) +
+ + +
+ +
Restricts the retrieved cookies to those whose path exactly matches this string.
+
+ This parameter was added in version + . + You must omit this parameter in earlier versions, + and you may omit it in any version. If you require this + parameter, the manifest key + minimum_chrome_version + can ensure that your extension won't be run in an earlier browser version. +
+ + +
+
+
+
+
+
+
+
+
+
+
+
+ secure + + + +
+ ( + optional + + + + Type + + + + array of + + boolean + + + + ) +
+ + +
+ +
Filters the cookies by their Secure property.
+
+ This parameter was added in version + . + You must omit this parameter in earlier versions, + and you may omit it in any version. If you require this + parameter, the manifest key + minimum_chrome_version + can ensure that your extension won't be run in an earlier browser version. +
+ + +
+
+
+
+
+
+
+
+
+
+
+
+ session + + + +
+ ( + optional + + + + Type + + + + array of + + boolean + + + + ) +
+ + +
+ +
Filters out session vs. persistent cookies.
+
+ This parameter was added in version + . + You must omit this parameter in earlier versions, + and you may omit it in any version. If you require this + parameter, the manifest key + minimum_chrome_version + can ensure that your extension won't be run in an earlier browser version. +
+ + +
+
+
+
+
+
+
+
+
+
+
+
+ storeId + + + +
+ ( + optional + + + + Type + + + + array of + + string + + + + ) +
+ + +
+ +
The cookie store to retrieve cookies from. If omitted, the current execution context's cookie store will be used.
+
+ This parameter was added in version + . + You must omit this parameter in earlier versions, + and you may omit it in any version. If you require this + parameter, the manifest key + minimum_chrome_version + can ensure that your extension won't be run in an earlier browser version. +
+ + +
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+ callback + + + +
+ ( + + + + + Type + + + + array of + + function + + + + ) +
+ + +
+
+ Undocumented. +
+
+ Description of this parameter from the json schema. +
+
+ This parameter was added in version + . + You must omit this parameter in earlier versions, + and you may omit it in any version. If you require this + parameter, the manifest key + minimum_chrome_version + can ensure that your extension won't be run in an earlier browser version. +
+ + +
+
+
+
+
+
+
+
+
+
+
+ + +

Returns

+
+
+
+
+
+
+ + +
+
+

Callback function

+

+ The callback parameter should specify a function + that looks like this: +

+

+ If you specify the callback parameter, it should + specify a function that looks like this: +

+ + + 
function(array of Cookie cookies) {...});
+
+
+
+
+ cookies + + + +
+ ( + + + + + Type + + + + array of + + Cookie + + + + array of + + paramType + + + + + paramType + + + + ) +
+ + +
+ +
All the existing, unexpired cookies that match the given cookie info.
+
+ This parameter was added in version + . + You must omit this parameter in earlier versions, + and you may omit it in any version. If you require this + parameter, the manifest key + minimum_chrome_version + can ensure that your extension won't be run in an earlier browser version. +
+ + +
+
+
+
+
+
+
+
+
+
+
+
+
+ + +

+ This function was added in version . + If you require this function, the manifest key + minimum_chrome_version + can ensure that your extension won't be run in an earlier browser version. +

+
+ +
+ +

getAllCookieStores

+ +
void + + chrome.cookies.getAllCookieStores(, function + callback)
+ +
+ +

Lists all existing cookie stores.

+ + +

Parameters

+
+
+
+
+ callback + + + +
+ ( + + + + + Type + + + + array of + + function + + + + ) +
+ + +
+
+ Undocumented. +
+
+ Description of this parameter from the json schema. +
+
+ This parameter was added in version + . + You must omit this parameter in earlier versions, + and you may omit it in any version. If you require this + parameter, the manifest key + minimum_chrome_version + can ensure that your extension won't be run in an earlier browser version. +
+ + +
+
+
+
+
+
+
+
+
+
+
+ + +

Returns

+
+
+
+
+
+
+ + +
+
+

Callback function

+

+ The callback parameter should specify a function + that looks like this: +

+

+ If you specify the callback parameter, it should + specify a function that looks like this: +

+ + + 
function(array of CookieStore cookieStores) {...});
+
+
+
+
+ cookieStores + + + +
+ ( + + + + + Type + + + + array of + + CookieStore + + + + array of + + paramType + + + + + paramType + + + + ) +
+ + +
+ +
All the existing cookie stores.
+
+ This parameter was added in version + . + You must omit this parameter in earlier versions, + and you may omit it in any version. If you require this + parameter, the manifest key + minimum_chrome_version + can ensure that your extension won't be run in an earlier browser version. +
+ + +
+
+
+
+
+
+
+
+
+
+
+
+
+ + +

+ This function was added in version . + If you require this function, the manifest key + minimum_chrome_version + can ensure that your extension won't be run in an earlier browser version. +

+
+ +
+ +

remove

+ +
void + + chrome.cookies.remove(, object + details)
+ +
+ +

Deletes a cookie by name.

+ + +

Parameters

+
+
+
+
+ details + + + +
+ ( + + + + + Type + + + + array of + + object + + + + ) +
+ + +
+ +
Information to identify the cookie to remove.
+
+ This parameter was added in version + . + You must omit this parameter in earlier versions, + and you may omit it in any version. If you require this + parameter, the manifest key + minimum_chrome_version + can ensure that your extension won't be run in an earlier browser version. +
+ + +
+
+
+
+
+ url + + + +
+ ( + + + + + Type + + + + array of + + string + + + + ) +
+ + +
+ +
The URL associated with the cookie. If host permissions for this URL are not specified in the manifest file, the API call will fail.
+
+ This parameter was added in version + . + You must omit this parameter in earlier versions, + and you may omit it in any version. If you require this + parameter, the manifest key + minimum_chrome_version + can ensure that your extension won't be run in an earlier browser version. +
+ + +
+
+
+
+
+
+
+
+
+
+
+
+ name + + + +
+ ( + + + + + Type + + + + array of + + string + + + + ) +
+ + +
+ +
The name of the cookie to remove.
+
+ This parameter was added in version + . + You must omit this parameter in earlier versions, + and you may omit it in any version. If you require this + parameter, the manifest key + minimum_chrome_version + can ensure that your extension won't be run in an earlier browser version. +
+ + +
+
+
+
+
+
+
+
+
+
+
+
+ storeId + + + +
+ ( + optional + + + + Type + + + + array of + + string + + + + ) +
+ + +
+ +
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.
+
+ This parameter was added in version + . + You must omit this parameter in earlier versions, + and you may omit it in any version. If you require this + parameter, the manifest key + minimum_chrome_version + can ensure that your extension won't be run in an earlier browser version. +
+ + +
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+ + +

Returns

+
+
+
+
+
+
+ + +
+
+

Callback function

+

+ The callback parameter should specify a function + that looks like this: +

+

+ If you specify the callback parameter, it should + specify a function that looks like this: +

+ + + 
function(Type param1, Type param2) {...});
+
+
+
+
+
+
+
+
+ + +

+ This function was added in version . + If you require this function, the manifest key + minimum_chrome_version + can ensure that your extension won't be run in an earlier browser version. +

+
+ +
+ +

set

+ +
void + + chrome.cookies.set(, object + details)
+ +
+ +

Sets a cookie with the given cookie data; may overwrite equivalent cookies if they exist.

+ + +

Parameters

+
+
+
+
+ details + + + +
+ ( + + + + + Type + + + + array of + + object + + + + ) +
+ + +
+ +
Details about the cookie being set.
+
+ This parameter was added in version + . + You must omit this parameter in earlier versions, + and you may omit it in any version. If you require this + parameter, the manifest key + minimum_chrome_version + can ensure that your extension won't be run in an earlier browser version. +
+ + +
+
+
+
+
+ url + + + +
+ ( + + + + + Type + + + + array of + + 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.
+
+ This parameter was added in version + . + You must omit this parameter in earlier versions, + and you may omit it in any version. If you require this + parameter, the manifest key + minimum_chrome_version + can ensure that your extension won't be run in an earlier browser version. +
+ + +
+
+
+
+
+
+
+
+
+
+
+
+ name + + + +
+ ( + optional + + + + Type + + + + array of + + string + + + + ) +
+ + +
+ +
The name of the cookie. Empty by default if omitted.
+
+ This parameter was added in version + . + You must omit this parameter in earlier versions, + and you may omit it in any version. If you require this + parameter, the manifest key + minimum_chrome_version + can ensure that your extension won't be run in an earlier browser version. +
+ + +
+
+
+
+
+
+
+
+
+
+
+
+ value + + + +
+ ( + optional + + + + Type + + + + array of + + string + + + + ) +
+ + +
+ +
The value of the cookie. Empty by default if omitted.
+
+ This parameter was added in version + . + You must omit this parameter in earlier versions, + and you may omit it in any version. If you require this + parameter, the manifest key + minimum_chrome_version + can ensure that your extension won't be run in an earlier browser version. +
+ + +
+
+
+
+
+
+
+
+
+
+
+
+ domain + + + +
+ ( + optional + + + + Type + + + + array of + + string + + + + ) +
+ + +
+ +
The domain of the cookie. If omitted, the cookie becomes a host-only cookie.
+
+ This parameter was added in version + . + You must omit this parameter in earlier versions, + and you may omit it in any version. If you require this + parameter, the manifest key + minimum_chrome_version + can ensure that your extension won't be run in an earlier browser version. +
+ + +
+
+
+
+
+
+
+
+
+
+
+
+ path + + + +
+ ( + optional + + + + Type + + + + array of + + string + + + + ) +
+ + +
+ +
The path of the cookie. Defaults to the path portion of the url parameter.
+
+ This parameter was added in version + . + You must omit this parameter in earlier versions, + and you may omit it in any version. If you require this + parameter, the manifest key + minimum_chrome_version + can ensure that your extension won't be run in an earlier browser version. +
+ + +
+
+
+
+
+
+
+
+
+
+
+
+ secure + + + +
+ ( + optional + + + + Type + + + + array of + + boolean + + + + ) +
+ + +
+ +
Whether the cookie should be marked as Secure. Defaults to false.
+
+ This parameter was added in version + . + You must omit this parameter in earlier versions, + and you may omit it in any version. If you require this + parameter, the manifest key + minimum_chrome_version + can ensure that your extension won't be run in an earlier browser version. +
+ + +
+
+
+
+
+
+
+
+
+
+
+
+ httpOnly + + + +
+ ( + optional + + + + Type + + + + array of + + boolean + + + + ) +
+ + +
+ +
Whether the cookie should be marked as HttpOnly. Defaults to false.
+
+ This parameter was added in version + . + You must omit this parameter in earlier versions, + and you may omit it in any version. If you require this + parameter, the manifest key + minimum_chrome_version + can ensure that your extension won't be run in an earlier browser version. +
+ + +
+
+
+
+
+
+
+
+
+
+
+
+ expirationDate + + + +
+ ( + optional + + + + Type + + + + array of + + number + + + + ) +
+ + +
+ +
The expiration date of the cookie as the number of seconds since the UNIX epoch. If omitted, the cookie becomes a session cookie.
+
+ This parameter was added in version + . + You must omit this parameter in earlier versions, + and you may omit it in any version. If you require this + parameter, the manifest key + minimum_chrome_version + can ensure that your extension won't be run in an earlier browser version. +
+ + +
+
+
+
+
+
+
+
+
+
+
+
+ storeId + + + +
+ ( + optional + + + + Type + + + + array of + + 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.
+
+ This parameter was added in version + . + You must omit this parameter in earlier versions, + and you may omit it in any version. If you require this + parameter, the manifest key + minimum_chrome_version + can ensure that your extension won't be run in an earlier browser version. +
+ + +
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+ + +

Returns

+
+
+
+
+
+
+ + +
+
+

Callback function

+

+ The callback parameter should specify a function + that looks like this: +

+

+ If you specify the callback parameter, it should + specify a function that looks like this: +

+ + + 
function(Type param1, Type param2) {...});
+
+
+
+
+
+
+
+
+ + +

+ This function was added in version . + If you require this function, the manifest key + minimum_chrome_version + can ensure that your extension won't be run in an earlier browser version. +

+
+ +
+ +
+ + +
+ +

Events

+ + +
+ +

onChanged

+ +
+ + chrome.cookies.onChanged.addListener(function(object changeInfo) {...}); +
+ +
+ +

Fired when a cookie is set or removed.

+ + +

Parameters

+
+
+
+
+ changeInfo + + + +
+ ( + + + + + Type + + + + array of + + object + + + + ) +
+ + +
+
+ Undocumented. +
+
+ Description of this parameter from the json schema. +
+
+ This parameter was added in version + . + You must omit this parameter in earlier versions, + and you may omit it in any version. If you require this + parameter, the manifest key + minimum_chrome_version + can ensure that your extension won't be run in an earlier browser version. +
+ + +
+
+
+
+
+ removed + + + +
+ ( + + + + + Type + + + + array of + + boolean + + + + ) +
+ + +
+ +
True if a cookie was removed.
+
+ This parameter was added in version + . + You must omit this parameter in earlier versions, + and you may omit it in any version. If you require this + parameter, the manifest key + minimum_chrome_version + can ensure that your extension won't be run in an earlier browser version. +
+ + +
+
+
+
+
+
+
+
+
+
+
+
+ cookie + + + +
+ ( + + + + + Cookie + + + + array of + + paramType + + + + ) +
+ + +
+ +
Information about the cookie that was set or removed.
+
+ This parameter was added in version + . + You must omit this parameter in earlier versions, + and you may omit it in any version. If you require this + parameter, the manifest key + minimum_chrome_version + can ensure that your extension won't be run in an earlier browser version. +
+ + +
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+ +
+ +
+ +
+ + +
+ +

Types

+ + +
+ +

Cookie

+ +
+
+ paramName + + + +
+ ( + + + + + Type + + + + array of + + object + + + + ) +
+ + +
+ +
Represents information about an HTTP cookie.
+
+ This parameter was added in version + . + You must omit this parameter in earlier versions, + and you may omit it in any version. If you require this + parameter, the manifest key + minimum_chrome_version + can ensure that your extension won't be run in an earlier browser version. +
+ + +
+
+
+
+
+ name + + + +
+ ( + + + + + Type + + + + array of + + string + + + + ) +
+ + +
+ +
The name of the cookie.
+
+ This parameter was added in version + . + You must omit this parameter in earlier versions, + and you may omit it in any version. If you require this + parameter, the manifest key + minimum_chrome_version + can ensure that your extension won't be run in an earlier browser version. +
+ + +
+
+
+
+
+
+
+
+
+
+
+
+ value + + + +
+ ( + + + + + Type + + + + array of + + string + + + + ) +
+ + +
+ +
The value of the cookie.
+
+ This parameter was added in version + . + You must omit this parameter in earlier versions, + and you may omit it in any version. If you require this + parameter, the manifest key + minimum_chrome_version + can ensure that your extension won't be run in an earlier browser version. +
+ + +
+
+
+
+
+
+
+
+
+
+
+
+ domain + + + +
+ ( + + + + + Type + + + + array of + + string + + + + ) +
+ + +
+ +
The domain of the cookie (e.g. "www.google.com", "example.com").
+
+ This parameter was added in version + . + You must omit this parameter in earlier versions, + and you may omit it in any version. If you require this + parameter, the manifest key + minimum_chrome_version + can ensure that your extension won't be run in an earlier browser version. +
+ + +
+
+
+
+
+
+
+
+
+
+
+
+ hostOnly + + + +
+ ( + + + + + Type + + + + array of + + boolean + + + + ) +
+ + +
+ +
True if the cookie is a host-only cookie (i.e. a request's host must exactly match the domain of the cookie).
+
+ This parameter was added in version + . + You must omit this parameter in earlier versions, + and you may omit it in any version. If you require this + parameter, the manifest key + minimum_chrome_version + can ensure that your extension won't be run in an earlier browser version. +
+ + +
+
+
+
+
+
+
+
+
+
+
+
+ path + + + +
+ ( + + + + + Type + + + + array of + + string + + + + ) +
+ + +
+ +
The path of the cookie.
+
+ This parameter was added in version + . + You must omit this parameter in earlier versions, + and you may omit it in any version. If you require this + parameter, the manifest key + minimum_chrome_version + can ensure that your extension won't be run in an earlier browser version. +
+ + +
+
+
+
+
+
+
+
+
+
+
+
+ secure + + + +
+ ( + + + + + Type + + + + array of + + boolean + + + + ) +
+ + +
+ +
True if the cookie is marked as Secure (i.e. its scope is limited to secure channels, typically HTTPS).
+
+ This parameter was added in version + . + You must omit this parameter in earlier versions, + and you may omit it in any version. If you require this + parameter, the manifest key + minimum_chrome_version + can ensure that your extension won't be run in an earlier browser version. +
+ + +
+
+
+
+
+
+
+
+
+
+
+
+ httpOnly + + + +
+ ( + + + + + Type + + + + array of + + boolean + + + + ) +
+ + +
+ +
True if the cookie is marked as HttpOnly (i.e. the cookie is inaccessible to client-side scripts).
+
+ This parameter was added in version + . + You must omit this parameter in earlier versions, + and you may omit it in any version. If you require this + parameter, the manifest key + minimum_chrome_version + can ensure that your extension won't be run in an earlier browser version. +
+ + +
+
+
+
+
+
+
+
+
+
+
+
+ session + + + +
+ ( + + + + + Type + + + + array of + + boolean + + + + ) +
+ + +
+ +
True if the cookie is a session cookie, as opposed to a persistent cookie with an expiration date.
+
+ This parameter was added in version + . + You must omit this parameter in earlier versions, + and you may omit it in any version. If you require this + parameter, the manifest key + minimum_chrome_version + can ensure that your extension won't be run in an earlier browser version. +
+ + +
+
+
+
+
+
+
+
+
+
+
+
+ expirationDate + + + +
+ ( + optional + + + + Type + + + + array of + + number + + + + ) +
+ + +
+ +
The expiration date of the cookie as the number of seconds since the UNIX epoch. Not provided for session cookies.
+
+ This parameter was added in version + . + You must omit this parameter in earlier versions, + and you may omit it in any version. If you require this + parameter, the manifest key + minimum_chrome_version + can ensure that your extension won't be run in an earlier browser version. +
+ + +
+
+
+
+
+
+
+
+
+
+
+
+ storeId + + + +
+ ( + + + + + Type + + + + array of + + string + + + + ) +
+ + +
+ +
The ID of the cookie store containing this cookie, as provided in getAllCookieStores().
+
+ This parameter was added in version + . + You must omit this parameter in earlier versions, + and you may omit it in any version. If you require this + parameter, the manifest key + minimum_chrome_version + can ensure that your extension won't be run in an earlier browser version. +
+ + +
+
+
+
+
+
+
+
+
+
+
+
+
+ +
+ +

CookieStore

+ +
+
+ paramName + + + +
+ ( + + + + + Type + + + + array of + + object + + + + ) +
+ + +
+ +
Represents a cookie store in the browser. An incognito mode window, for instance, uses a separate cookie store from a non-incognito window.
+
+ This parameter was added in version + . + You must omit this parameter in earlier versions, + and you may omit it in any version. If you require this + parameter, the manifest key + minimum_chrome_version + can ensure that your extension won't be run in an earlier browser version. +
+ + +
+
+
+
+
+ id + + + +
+ ( + + + + + Type + + + + array of + + string + + + + ) +
+ + +
+ +
The unique identifier for the cookie store.
+
+ This parameter was added in version + . + You must omit this parameter in earlier versions, + and you may omit it in any version. If you require this + parameter, the manifest key + minimum_chrome_version + can ensure that your extension won't be run in an earlier browser version. +
+ + +
+
+
+
+
+
+
+
+
+
+
+
+ tabIds + + + +
+ ( + + + + + Type + + + + array of + + Type + + + + array of + + integer + + + + + paramType + + + + ) +
+ + +
+ +
Identifiers of all the browser tabs that share this cookie store.
+
+ This parameter was added in version + . + You must omit this parameter in earlier versions, + and you may omit it in any version. If you require this + parameter, the manifest key + minimum_chrome_version + can ensure that your extension won't be run in an earlier browser version. +
+ + +
+
+
+
+
+
+
+
+
+
+
+
+
+ +
+ +
+ +
+
+
+
+ +
+ -- cgit v1.1