OLD | NEW |
1 // Copyright (c) 2012 The Chromium Authors. All rights reserved. | 1 // Copyright (c) 2012 The Chromium Authors. All rights reserved. |
2 // Use of this source code is governed by a BSD-style license that can be | 2 // Use of this source code is governed by a BSD-style license that can be |
3 // found in the LICENSE file. | 3 // found in the LICENSE file. |
4 | 4 |
5 [ | 5 [ |
6 { | 6 { |
7 "namespace": "cookies", | 7 "namespace": "cookies", |
8 "description": "Use the <code>chrome.cookies</code> API to query and modify
cookies, and to be notified when they change.", | 8 "description": "Use the <code>chrome.cookies</code> API to query and modify
cookies, and to be notified when they change.", |
9 "types": [ | 9 "types": [ |
10 { | 10 { |
(...skipping 14 matching lines...) Expand all Loading... |
25 } | 25 } |
26 }, | 26 }, |
27 { | 27 { |
28 "id": "CookieStore", | 28 "id": "CookieStore", |
29 "type": "object", | 29 "type": "object", |
30 "description": "Represents a cookie store in the browser. An incognito m
ode window, for instance, uses a separate cookie store from a non-incognito wind
ow.", | 30 "description": "Represents a cookie store in the browser. An incognito m
ode window, for instance, uses a separate cookie store from a non-incognito wind
ow.", |
31 "properties": { | 31 "properties": { |
32 "id": {"type": "string", "description": "The unique identifier for the
cookie store."}, | 32 "id": {"type": "string", "description": "The unique identifier for the
cookie store."}, |
33 "tabIds": {"type": "array", "items": {"type": "integer"}, "description
": "Identifiers of all the browser tabs that share this cookie store."} | 33 "tabIds": {"type": "array", "items": {"type": "integer"}, "description
": "Identifiers of all the browser tabs that share this cookie store."} |
34 } | 34 } |
| 35 }, |
| 36 { |
| 37 "id": "OnChangedCause", |
| 38 "type": "string", |
| 39 "enum": ["evicted", "expired", "explicit", "expired_overwrite", "overwri
te"], |
| 40 "description": "The underlying reason behind the cookie's change. If a c
ookie was inserted, or removed via an explicit call to \"chrome.cookies.remove\"
, \"cause\" will be \"explicit\". If a cookie was automatically removed due to e
xpiry, \"cause\" will be \"expired\". If a cookie was removed due to being overw
ritten with an already-expired expiration date, \"cause\" will be set to \"expir
ed_overwrite\". If a cookie was automatically removed due to garbage collection
, \"cause\" will be \"evicted\". If a cookie was automatically removed due to a
\"set\" call that overwrote it, \"cause\" will be \"overwrite\". Plan your resp
onse accordingly." |
35 } | 41 } |
36 ], | 42 ], |
37 "functions": [ | 43 "functions": [ |
38 { | 44 { |
39 "name": "get", | 45 "name": "get", |
40 "type": "function", | 46 "type": "function", |
41 "description": "Retrieves information about a single cookie. If more tha
n one cookie of the same name exists for the given URL, the one with the longest
path will be returned. For cookies with the same path length, the cookie with t
he earliest creation time will be returned.", | 47 "description": "Retrieves information about a single cookie. If more tha
n one cookie of the same name exists for the given URL, the one with the longest
path will be returned. For cookies with the same path length, the cookie with t
he earliest creation time will be returned.", |
42 "parameters": [ | 48 "parameters": [ |
43 { | 49 { |
44 "type": "object", | 50 "type": "object", |
(...skipping 138 matching lines...) Expand 10 before | Expand all | Expand 10 after Loading... |
183 "name": "onChanged", | 189 "name": "onChanged", |
184 "type": "function", | 190 "type": "function", |
185 "description": "Fired when a cookie is set or removed. As a special case
, note that updating a cookie's properties is implemented as a two step process:
the cookie to be updated is first removed entirely, generating a notification w
ith \"cause\" of \"overwrite\" . Afterwards, a new cookie is written with the u
pdated values, generating a second notification with \"cause\" \"explicit\".", | 191 "description": "Fired when a cookie is set or removed. As a special case
, note that updating a cookie's properties is implemented as a two step process:
the cookie to be updated is first removed entirely, generating a notification w
ith \"cause\" of \"overwrite\" . Afterwards, a new cookie is written with the u
pdated values, generating a second notification with \"cause\" \"explicit\".", |
186 "parameters": [ | 192 "parameters": [ |
187 { | 193 { |
188 "type": "object", | 194 "type": "object", |
189 "name": "changeInfo", | 195 "name": "changeInfo", |
190 "properties": { | 196 "properties": { |
191 "removed": {"type": "boolean", "description": "True if a cookie wa
s removed."}, | 197 "removed": {"type": "boolean", "description": "True if a cookie wa
s removed."}, |
192 "cookie": {"$ref": "Cookie", "description": "Information about the
cookie that was set or removed."}, | 198 "cookie": {"$ref": "Cookie", "description": "Information about the
cookie that was set or removed."}, |
193 "cause": {"min_version": "12.0.707.0", "type": "string", "enum": [
"evicted", "expired", "explicit", "expired_overwrite", "overwrite"], "descriptio
n": "The underlying reason behind the cookie's change. If a cookie was inserted,
or removed via an explicit call to \"chrome.cookies.remove\", \"cause\" will be
\"explicit\". If a cookie was automatically removed due to expiry, \"cause\" wi
ll be \"expired\". If a cookie was removed due to being overwritten with an alre
ady-expired expiration date, \"cause\" will be set to \"expired_overwrite\". If
a cookie was automatically removed due to garbage collection, \"cause\" will be
\"evicted\". If a cookie was automatically removed due to a \"set\" call that
overwrote it, \"cause\" will be \"overwrite\". Plan your response accordingly."} | 199 "cause": {"min_version": "12.0.707.0", "$ref": "OnChangedCause", "
description": "The underlying reason behind the cookie's change."} |
194 } | 200 } |
195 } | 201 } |
196 ] | 202 ] |
197 } | 203 } |
198 ] | 204 ] |
199 } | 205 } |
200 ] | 206 ] |
OLD | NEW |