OLD | NEW |
1 // Copyright 2013 The Chromium Authors. All rights reserved. | 1 // Copyright 2013 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": "types.private", | 7 "namespace": "types.private", |
8 "description": "The <code>chrome.types.private</code> API contains private t
ype declarations for Chrome.", | 8 "description": "The <code>chrome.types.private</code> API contains private t
ype declarations for Chrome.", |
9 "types": [ | 9 "types": [ |
10 { | 10 { |
| 11 "id": "Scope", |
| 12 "type": "string", |
| 13 "enum": ["regular", "regular_only", "incognito_persistent", "incognito_s
ession_only"] |
| 14 }, |
| 15 { |
11 "id": "ChromeDirectSetting", | 16 "id": "ChromeDirectSetting", |
12 "type": "object", | 17 "type": "object", |
13 "js_module": "ChromeDirectSetting", | 18 "js_module": "ChromeDirectSetting", |
14 "customBindings": "ChromeDirectSetting", | 19 "customBindings": "ChromeDirectSetting", |
15 "description": "An interface that allows component extensions direct acc
ess to a Chrome browser setting.", | 20 "description": "An interface that allows component extensions direct acc
ess to a Chrome browser setting.", |
16 "functions": [ | 21 "functions": [ |
17 { | 22 { |
18 "name": "get", | 23 "name": "get", |
19 "type": "function", | 24 "type": "function", |
20 "description": "Gets the value of a setting.", | 25 "description": "Gets the value of a setting.", |
(...skipping 42 matching lines...) Expand 10 before | Expand all | Expand 10 after Loading... |
63 { | 68 { |
64 "name": "details", | 69 "name": "details", |
65 "type": "object", | 70 "type": "object", |
66 "description": "Which setting to change.", | 71 "description": "Which setting to change.", |
67 "properties": { | 72 "properties": { |
68 "value": { | 73 "value": { |
69 "description": "The value of the setting. <br/>Note that eve
ry setting has a specific value type, which is described together with the setti
ng. An extension should <em>not</em> set a value of a different type.", | 74 "description": "The value of the setting. <br/>Note that eve
ry setting has a specific value type, which is described together with the setti
ng. An extension should <em>not</em> set a value of a different type.", |
70 "type": "any" | 75 "type": "any" |
71 }, | 76 }, |
72 "scope": { | 77 "scope": { |
73 "type": "string", | 78 "$ref": "Scope", |
74 "enum": ["regular", "regular_only", "incognito_persistent",
"incognito_session_only"], | |
75 "optional": true, | 79 "optional": true, |
76 "description": "Where to set the setting (default: regular).
One of<ul><li><var>regular</var>: setting for the regular profile (which is inh
erited by the incognito profile if not overridden elsewhere),</li><li><var>regul
ar_only</var>: setting for the regular profile only (not inherited by the incogn
ito profile),</li><li><var>incognito_persistent</var>: setting for the incognito
profile that survives browser restarts (overrides regular preferences),</li><li
><var>incognito_session_only</var>: setting for the incognito profile that can o
nly be set during an incognito session and is deleted when the incognito session
ends (overrides regular and incognito_persistent preferences).</li></ul>" | 80 "description": "Where to set the setting (default: regular).
One of<ul><li><var>regular</var>: setting for the regular profile (which is inh
erited by the incognito profile if not overridden elsewhere),</li><li><var>regul
ar_only</var>: setting for the regular profile only (not inherited by the incogn
ito profile),</li><li><var>incognito_persistent</var>: setting for the incognito
profile that survives browser restarts (overrides regular preferences),</li><li
><var>incognito_session_only</var>: setting for the incognito profile that can o
nly be set during an incognito session and is deleted when the incognito session
ends (overrides regular and incognito_persistent preferences).</li></ul>" |
77 } | 81 } |
78 } | 82 } |
79 }, | 83 }, |
80 { | 84 { |
81 "name": "callback", | 85 "name": "callback", |
82 "type": "function", | 86 "type": "function", |
83 "description": "Called at the completion of the set operation.", | 87 "description": "Called at the completion of the set operation.", |
84 "optional": true, | 88 "optional": true, |
85 "parameters": [] | 89 "parameters": [] |
86 } | 90 } |
87 ] | 91 ] |
88 }, | 92 }, |
89 { | 93 { |
90 "name": "clear", | 94 "name": "clear", |
91 "type": "function", | 95 "type": "function", |
92 "description": "Clears the setting, restoring any default value.", | 96 "description": "Clears the setting, restoring any default value.", |
93 "parameters": [ | 97 "parameters": [ |
94 { | 98 { |
95 "name": "details", | 99 "name": "details", |
96 "type": "object", | 100 "type": "object", |
97 "description": "Which setting to clear.", | 101 "description": "Which setting to clear.", |
98 "properties": { | 102 "properties": { |
99 "scope": { | 103 "scope": { |
100 "type": "string", | 104 "$ref": "Scope", |
101 "enum": ["regular", "regular_only", "incognito_persistent",
"incognito_session_only"], | |
102 "optional": true, | 105 "optional": true, |
103 "description": "Where to clear the setting (default: regular
). One of<ul><li><var>regular</var>: setting for the regular profile (which is i
nherited by the incognito profile if not overridden elsewhere),</li><li><var>reg
ular_only</var>: setting for the regular profile only (not inherited by the inco
gnito profile),</li><li><var>incognito_persistent</var>: setting for the incogni
to profile that survives browser restarts (overrides regular preferences),</li><
li><var>incognito_session_only</var>: setting for the incognito profile that can
only be set during an incognito session and is deleted when the incognito sessi
on ends (overrides regular and incognito_persistent preferences).</li></ul>" | 106 "description": "Where to clear the setting (default: regular
). One of<ul><li><var>regular</var>: setting for the regular profile (which is i
nherited by the incognito profile if not overridden elsewhere),</li><li><var>reg
ular_only</var>: setting for the regular profile only (not inherited by the inco
gnito profile),</li><li><var>incognito_persistent</var>: setting for the incogni
to profile that survives browser restarts (overrides regular preferences),</li><
li><var>incognito_session_only</var>: setting for the incognito profile that can
only be set during an incognito session and is deleted when the incognito sessi
on ends (overrides regular and incognito_persistent preferences).</li></ul>" |
104 } | 107 } |
105 } | 108 } |
106 }, | 109 }, |
107 { | 110 { |
108 "name": "callback", | 111 "name": "callback", |
109 "type": "function", | 112 "type": "function", |
110 "description": "Called at the completion of the clear operation.
", | 113 "description": "Called at the completion of the clear operation.
", |
111 "optional": true, | 114 "optional": true, |
(...skipping 22 matching lines...) Expand all Loading... |
134 } | 137 } |
135 } | 138 } |
136 } | 139 } |
137 ] | 140 ] |
138 } | 141 } |
139 ] | 142 ] |
140 } | 143 } |
141 ] | 144 ] |
142 } | 145 } |
143 ] | 146 ] |
OLD | NEW |