| OLD | NEW |
|---|
| (Empty) | |
| 1 // Copyright (c) 2013 The Chromium Authors. All rights reserved. |
| 2 // Use of this source code is governed by a BSD-style license that can be |
| 3 // found in the LICENSE file. |
| 4 |
| 5 [ |
| 6 { |
| 7 "namespace": "types.private", |
| 8 "description": "The <code>chrome.types.private</code> API contains private t
ype declarations for Chrome.", |
| 9 "types": [ |
| 10 { |
| 11 "id": "ChromeDirectSetting", |
| 12 "type": "object", |
| 13 "js_module": "ChromeDirectSetting", |
| 14 "customBindings": "ChromeDirectSetting", |
| 15 "description": "An interface that allows component extensions direct acc
ess to a Chrome browser setting.", |
| 16 "functions": [ |
| 17 { |
| 18 "name": "get", |
| 19 "type": "function", |
| 20 "description": "Gets the value of a setting.", |
| 21 "parameters": [ |
| 22 { |
| 23 "name": "details", |
| 24 "type": "object", |
| 25 "description": "Which setting to consider.", |
| 26 "properties": { |
| 27 "incognito": { |
| 28 "type": "boolean", |
| 29 "optional": true, |
| 30 "description": "Whether to return the value that applies to
the incognito session (default false)." |
| 31 } |
| 32 } |
| 33 }, |
| 34 { |
| 35 "name": "callback", |
| 36 "type": "function", |
| 37 "parameters": [ |
| 38 { |
| 39 "name": "details", |
| 40 "type": "object", |
| 41 "description": "Details of the currently effective value.", |
| 42 "properties": { |
| 43 "value": { |
| 44 "description": "The value of the setting.", |
| 45 "type": "any" |
| 46 }, |
| 47 "incognitoSpecific": { |
| 48 "description": "Whether the effective value is specific
to the incognito session.<br/>This property will <em>only</em> be present if the
<var>incognito</var> property in the <var>details</var> parameter of <code>get(
)</code> was true.", |
| 49 "type": "boolean", |
| 50 "optional": true |
| 51 } |
| 52 } |
| 53 } |
| 54 ] |
| 55 } |
| 56 ] |
| 57 }, |
| 58 { |
| 59 "name": "set", |
| 60 "type": "function", |
| 61 "description": "Sets the value of a setting.", |
| 62 "parameters": [ |
| 63 { |
| 64 "name": "details", |
| 65 "type": "object", |
| 66 "description": "Which setting to change.", |
| 67 "properties": { |
| 68 "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.", |
| 70 "type": "any" |
| 71 }, |
| 72 "scope": { |
| 73 "type": "string", |
| 74 "enum": ["regular", "regular_only", "incognito_persistent",
"incognito_session_only"], |
| 75 "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>" |
| 77 } |
| 78 } |
| 79 }, |
| 80 { |
| 81 "name": "callback", |
| 82 "type": "function", |
| 83 "description": "Called at the completion of the set operation.", |
| 84 "optional": true, |
| 85 "parameters": [] |
| 86 } |
| 87 ] |
| 88 }, |
| 89 { |
| 90 "name": "clear", |
| 91 "type": "function", |
| 92 "description": "Clears the setting, restoring any default value.", |
| 93 "parameters": [ |
| 94 { |
| 95 "name": "details", |
| 96 "type": "object", |
| 97 "description": "Which setting to clear.", |
| 98 "properties": { |
| 99 "scope": { |
| 100 "type": "string", |
| 101 "enum": ["regular", "regular_only", "incognito_persistent",
"incognito_session_only"], |
| 102 "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>" |
| 104 } |
| 105 } |
| 106 }, |
| 107 { |
| 108 "name": "callback", |
| 109 "type": "function", |
| 110 "description": "Called at the completion of the clear operation.
", |
| 111 "optional": true, |
| 112 "parameters": [] |
| 113 } |
| 114 ] |
| 115 } |
| 116 ], |
| 117 "events": [ |
| 118 { |
| 119 "name": "onChange", |
| 120 "description": "Fired after the setting changes.", |
| 121 "parameters": [ |
| 122 { |
| 123 "type": "object", |
| 124 "name": "details", |
| 125 "properties": { |
| 126 "value": { |
| 127 "description": "The value of the setting after the change.", |
| 128 "type": "any" |
| 129 }, |
| 130 "incognitoSpecific": { |
| 131 "description": "Whether the value that has changed is specif
ic to the incognito session.<br/>This property will <em>only</em> be present if
the user has enabled the extension in incognito mode.", |
| 132 "type": "boolean", |
| 133 "optional": true |
| 134 } |
| 135 } |
| 136 } |
| 137 ] |
| 138 } |
| 139 ] |
| 140 } |
| 141 ] |
| 142 } |
| 143 ] |
| OLD | NEW |
|---|
Chromium Code Reviews
Issue 18341016:
Add types.private.ChromeDirectSetting and Connect it to preferencesPrivate.googleGeolocationAccessE… (Closed)
Base URL: https://chromium.googlesource.com/chromium/src.git@master