| OLD | NEW |
|---|
| (Empty) | |
| 1 <div id="pageData-name" class="pageData">Preferences</div> |
| 2 |
| 3 <!-- BEGIN AUTHORED CONTENT --> |
| 4 <p id="classSummary"> |
| 5 The <code>chrome.preferences</code> module contains a prototype for giving other |
| 6 modules access to manage preferences stored by Chrome. This prototype is used, |
| 7 for example, for <a |
| 8 href="proxy.html#property-settings"><code>chrome.proxy.settings</code></a>. |
| 9 </p> |
| 10 |
| 11 <h2 id="description">Overview</h2> |
| 12 |
| 13 <p> |
| 14 The preferences API provides a common set of functions |
| 15 (<code>get()</code>, <code>set()</code>, and <code>clear()</code>) as |
| 16 well as an event publisher (<code>onChange</code>) for various |
| 17 preferences in Chrome. The <a href="proxy.html#overview-examples">proxy settings |
| 18 examples</a> demonstrate how these functions are intended to be used. |
| 19 </p> |
| 20 |
| 21 <!-- |
| 22 <h2 id="lifecycle">Life cycle of preferences</h2> |
| 23 |
| 24 <p> |
| 25 The life cycle of preferences depends on whether they are set for regular or |
| 26 incognito profiles. </p> |
| 27 --> |
| 28 |
| 29 <p> |
| 30 Currently, preferences can only be set for regular profiles. Once set, they |
| 31 remain in place until they are cleared by the governing extension, or the |
| 32 governing extension is disabled or uninstalled. |
| 33 </p> |
| 34 |
| 35 <h2 id="precedence">Precedence</h2> |
| 36 |
| 37 <p> |
| 38 Chrome manages preferences on different layers. The following list describes the |
| 39 layers that may influence the effective preferences, in increasing order of |
| 40 precedence. |
| 41 <ol> |
| 42 <li>System preferences provided by the operating system</li> |
| 43 <li>Command-line parameters</li> |
| 44 <li>Preferences set by extensions</li> |
| 45 <li>Policies</li> |
| 46 </ol> |
| 47 </p> |
| 48 |
| 49 <p> |
| 50 As the list implies, policies might overrule any changes that you specify with |
| 51 your extension. |
| 52 </p> |
| 53 |
| 54 <!-- |
| 55 <p> |
| 56 As discussed above, Chrome allows using different preferences for regular |
| 57 windows and incognito windows. The following example illustrates the behavior. |
| 58 Assume that no policy overrides the preferences and that an extension can set |
| 59 preferences for regular windows <b>(R)</b> and preferences for incognito windows |
| 60 <b>(I)</b>. |
| 61 </p> |
| 62 |
| 63 <p> |
| 64 <ul> |
| 65 <li>If only <b>(R)</b> is set, these preferences are effective for both |
| 66 regular and incognito windows.</li> |
| 67 <li>If only <b>(I)</b> is set, these preferences are effective for only |
| 68 incognito windows. Regular windows use the preferences determined by the lower |
| 69 layers (command-line options and system settings).</li> |
| 70 <li>If both <b>(R)</b> and <b>(I)</b> are set, the respective preferences are |
| 71 used for regular and incognito windows.</li> |
| 72 </ul> |
| 73 </p> |
| 74 --> |
| 75 |
| 76 <p> |
| 77 If two or more extensions want to set the same preference to different values, |
| 78 the extension installed most recently takes precedence over the other |
| 79 extensions. |
| 80 <!-- If the |
| 81 extension installed last sets only <b>(I)</b>, the preference of regular windows |
| 82 can be defined by previously installed extensions. --> |
| 83 </p> |
| 84 |
| 85 <p> |
| 86 The <em>effective</em> preference value is the setting that results from |
| 87 considering the preference rules. It is used by Chrome. |
| 88 <p> |
| 89 |
| 90 <!-- END AUTHORED CONTENT --> |
| OLD | NEW |
|---|
Chromium Code Reviews
Issue 7067024:
Updated preferences and proxy settings API documentation (Closed)
Base URL: svn://svn.chromium.org/chrome/trunk/src