Chromium Code Reviews
chromiumcodereview-hr@appspot.gserviceaccount.com (chromiumcodereview-hr) | Please choose your nickname with Settings | Help | Chromium Project | Gerrit Changes | Sign out
(263)

Side by Side Diff: chrome/common/extensions/docs/preferences.html

Issue 7065033: Support persistent incognito preferences (Closed) Base URL: svn://svn.chromium.org/chrome/trunk/src
Patch Set: Fixed a unit test Created 9 years, 7 months ago
Use n/p to move between diff chunks; N/P to move between comments. Draft comments are only viewable by you.
Jump to:
View unified diff | Download patch | Annotate | Revision Log
OLDNEW
1 <!DOCTYPE html><!-- This page is a placeholder for generated extensions api doc. Note: 1 <!DOCTYPE html><!-- This page is a placeholder for generated extensions api doc. Note:
2 1) The <head> information in this page is significant, should be uniform 2 1) The <head> information in this page is significant, should be uniform
3 across api docs and should be edited only with knowledge of the 3 across api docs and should be edited only with knowledge of the
4 templating mechanism. 4 templating mechanism.
5 3) All <body>.innerHTML is genereated as an rendering step. If viewed in a 5 3) All <body>.innerHTML is genereated as an rendering step. If viewed in a
6 browser, it will be re-generated from the template, json schema and 6 browser, it will be re-generated from the template, json schema and
7 authored overview content. 7 authored overview content.
8 4) The <body>.innerHTML is also generated by an offline step so that this 8 4) The <body>.innerHTML is also generated by an offline step so that this
9 page may easily be indexed by search engines. 9 page may easily be indexed by search engines.
10 --><html xmlns="http://www.w3.org/1999/xhtml"><head> 10 --><html xmlns="http://www.w3.org/1999/xhtml"><head>
(...skipping 240 matching lines...) Expand 10 before | Expand all | Expand 10 after
251 251
252 <div class="g-unit" id="gc-pagecontent"> 252 <div class="g-unit" id="gc-pagecontent">
253 <div id="pageTitle"> 253 <div id="pageTitle">
254 <h1 class="page_title">Preferences</h1> 254 <h1 class="page_title">Preferences</h1>
255 </div> 255 </div>
256 <!-- TABLE OF CONTENTS --> 256 <!-- TABLE OF CONTENTS -->
257 <div id="toc"> 257 <div id="toc">
258 <h2>Contents</h2> 258 <h2>Contents</h2>
259 <ol> 259 <ol>
260 <li> 260 <li>
261 <a href="#description">Overview</a> 261 <a href="#description">Functions</a>
262 <ol> 262 <ol>
263 <li style="display: none; "> 263 <li style="display: none; ">
264 <a>h3Name</a> 264 <a>h3Name</a>
265 </li>
266 </ol>
267 </li><li>
268 <a href="#lifecycle">Life cycle of preferences</a>
269 <ol>
270 <li style="display: none; ">
271 <a>h3Name</a>
265 </li> 272 </li>
266 </ol> 273 </ol>
267 </li><li> 274 </li><li>
268 <a href="#precedence">Precedence</a> 275 <a href="#precedence">Precedence</a>
269 <ol> 276 <ol>
270 <li style="display: none; "> 277 <li style="display: none; ">
271 <a>h3Name</a> 278 <a>h3Name</a>
272 </li> 279 </li>
273 </ol> 280 </ol>
274 </li> 281 </li>
(...skipping 42 matching lines...) Expand 10 before | Expand all | Expand 10 after
317 <p id="classSummary" style="display: none; "> 324 <p id="classSummary" style="display: none; ">
318 For information on how to use experimental APIs, see the <a href="expe rimental.html">chrome.experimental.* APIs</a> page. 325 For information on how to use experimental APIs, see the <a href="expe rimental.html">chrome.experimental.* APIs</a> page.
319 </p> 326 </p>
320 327
321 <!-- STATIC CONTENT PLACEHOLDER --> 328 <!-- STATIC CONTENT PLACEHOLDER -->
322 <div id="static"><div id="pageData-name" class="pageData">Preferences</d iv> 329 <div id="static"><div id="pageData-name" class="pageData">Preferences</d iv>
323 330
324 <!-- BEGIN AUTHORED CONTENT --> 331 <!-- BEGIN AUTHORED CONTENT -->
325 <p id="classSummary"> 332 <p id="classSummary">
326 The <code>chrome.preferences</code> module contains a prototype for giving other 333 The <code>chrome.preferences</code> module contains a prototype for giving other
327 modules access to manage preferences stored by Chrome. This prototype is used 334 modules access to manage Chrome's preferences. This prototype is used for
328 for example for <a href="proxy.html#property-settings"><code>chrome.proxy.settin gs</code></a>. 335 example for <a href="proxy.html#property-settings"><code>chrome.proxy.settings</ code></a>.
329 </p> 336 </p>
330 337
331 <h2 id="description">Overview</h2> 338 <h2 id="description">Functions</h2>
332 339
333 <p> 340 <p>
334 The preferences API provides a common set of functions 341 The preferences API provides a commen set of functions
335 (<code>getEffective()</code>, <code>set()</code>, and <code>clear()</code>) as 342 (<code>getEffective()</code>, <code>set()</code>, and <code>clear()</code>) as
336 well as an event publisher (<code>onChangeEffective</code>) for various 343 well as an event publisher (<code>onChangeEffective</code>) for various
337 preferences in Chrome. The <a href="proxy.html#overview-examples">proxy settings 344 preferences in Chrome. The <a href="proxy.html#overview-examples">proxy settings
338 examples</a> demonstrate how these functions are intended to be used. 345 examples</a> demonstrate how these functions are intended to be used.
339 </p> 346 </p>
340 347
341 <!--
342 <h2 id="lifecycle">Life cycle of preferences</h2> 348 <h2 id="lifecycle">Life cycle of preferences</h2>
343 349
344 <p> 350 <p>
345 The life cycle of preferences depends on whether they are set for regular or 351 The life cycle of preferences depends on whether they are set for regular or
346 incognito profiles. </p> 352 incognito profiles. Currently, preferences can only be set for regular profiles.
347 --> 353 </p>
348 354
349 <p> 355 <p>
350 Currently, preferences can only be set for regular profiles. Once set, they 356 Preferences for <em>regular profiles</em> are persisted to disk. Once set, they
351 remain in place until they are cleared by the governing extension, or the 357 remain in place until they are cleared by the governing extension, or the
352 governing extension is disabled or uninstalled. 358 governing extension is disabled or uninstalled.
353 </p> 359 </p>
354 360
355 <h2 id="precedence">Precedence</h2> 361 <h2 id="precedence">Precedence</h2>
356 362
357 <p> 363 <p>
358 Chrome manages preferences on different layers. The following list describes the 364 Chrome manages preferences on different layers. The following list describes the
359 layers that may influence the effective preferences, in increasing order of 365 layers that may influence the effective preferences, in increasing order of
360 precedence. 366 precedence.
361 </p><ol> 367 </p><ol>
362 <li>System preferences provided by the operating system</li> 368 <li>System preferences provided by the operating system</li>
363 <li>Command-line parameters</li> 369 <li>Command line parameters</li>
364 <li>Preferences set by extensions</li> 370 <li>Preferences set by extensions</li>
365 <li>Policies</li> 371 <li>Policies</li>
366 </ol> 372 </ol>
367 <p></p> 373 <p></p>
368 374
369 <p> 375 <p>
370 As the list implies, policies might overrule any changes that you specify with 376 As the list implies, policies might overrule any changes that you specify with
371 your extension. 377 your extension.
372 </p> 378 </p>
373 379
(...skipping 13 matching lines...) Expand all
387 <li>If only <b>(I)</b> is set, these preferences are effective for only 393 <li>If only <b>(I)</b> is set, these preferences are effective for only
388 incognito windows. Regular windows use the preferences determined by the lower 394 incognito windows. Regular windows use the preferences determined by the lower
389 layers (command-line options and system settings).</li> 395 layers (command-line options and system settings).</li>
390 <li>If both <b>(R)</b> and <b>(I)</b> are set, the respective preferences are 396 <li>If both <b>(R)</b> and <b>(I)</b> are set, the respective preferences are
391 used for regular and incognito windows.</li> 397 used for regular and incognito windows.</li>
392 </ul> 398 </ul>
393 </p> 399 </p>
394 --> 400 -->
395 401
396 <p> 402 <p>
397 If two or more extensions want to set the same preference to different values, 403 If two extensions want to set the same preference to different values, the
398 the extension installed most recently takes precedence over the other 404 extension installed last takes precedence over the other extensions.
399 extensions.
400 <!-- If the 405 <!-- If the
401 extension installed last sets only <b>(I)</b>, the preference of regular windows 406 extension installed last sets only <b>(I)</b>, the preference of regular windows
402 can be defined by previously installed extensions. --> 407 can be defined by previously installed extensions. -->
403 </p> 408 </p>
404 409
405 <p> 410 <p>
406 The <em>effective</em> preference value is the setting that results from 411 The <em>effective</em> preference value is the setting that results from
407 considering the preference rules. It is used by Chrome. 412 considering the preference rules. It is used by Chrome.
408 </p><p> 413 </p><p>
409 414
(...skipping 298 matching lines...) Expand 10 before | Expand all | Expand 10 after
708 <span class="enum">enumerated</span> 713 <span class="enum">enumerated</span>
709 <span id="typeTemplate"> 714 <span id="typeTemplate">
710 <span style="display: none; "> 715 <span style="display: none; ">
711 <a> Type</a> 716 <a> Type</a>
712 </span> 717 </span>
713 <span> 718 <span>
714 <span style="display: none; "> 719 <span style="display: none; ">
715 array of <span><span></span></span> 720 array of <span><span></span></span>
716 </span> 721 </span>
717 <span>string</span> 722 <span>string</span>
718 <span>["regular"]</span> 723 <span>["regular", "incognito_persistent"]</span>
719 </span> 724 </span>
720 </span> 725 </span>
721 ) 726 )
722 </div> 727 </div>
723 728
724 </em> 729 </em>
725 </dt> 730 </dt>
726 <dd class="todo" style="display: none; "> 731 <dd class="todo" style="display: none; ">
727 Undocumented. 732 Undocumented.
728 </dd> 733 </dd>
729 <dd>Where to clear the preference (default: regular). 'regular' = pref erence for regular profile (which is inherited by the incognito profile if not o verridden elsewhere).</dd> 734 <dd>Where to set the preference (default: regular). 'regular' = prefer ence for regular profile (which is inherited by the incognito profile if not ove rridden elsewhere), 'incognito_persistent' = preference for incognito profile th at sustains browser restarts (overrides regular preferences).</dd>
730 <dd style="display: none; "> 735 <dd style="display: none; ">
731 This parameter was added in version 736 This parameter was added in version
732 <b><span></span></b>. 737 <b><span></span></b>.
733 You must omit this parameter in earlier versions, 738 You must omit this parameter in earlier versions,
734 and you may omit it in any version. If you require this 739 and you may omit it in any version. If you require this
735 parameter, the manifest key 740 parameter, the manifest key
736 <a href="manifest.html#minimum_chrome_version">minimum_chrome_versio n</a> 741 <a href="manifest.html#minimum_chrome_version">minimum_chrome_versio n</a>
737 can ensure that your extension won't be run in an earlier browser ve rsion. 742 can ensure that your extension won't be run in an earlier browser ve rsion.
738 </dd> 743 </dd>
739 744
(...skipping 830 matching lines...) Expand 10 before | Expand all | Expand 10 after
1570 <span class="enum">enumerated</span> 1575 <span class="enum">enumerated</span>
1571 <span id="typeTemplate"> 1576 <span id="typeTemplate">
1572 <span style="display: none; "> 1577 <span style="display: none; ">
1573 <a> Type</a> 1578 <a> Type</a>
1574 </span> 1579 </span>
1575 <span> 1580 <span>
1576 <span style="display: none; "> 1581 <span style="display: none; ">
1577 array of <span><span></span></span> 1582 array of <span><span></span></span>
1578 </span> 1583 </span>
1579 <span>string</span> 1584 <span>string</span>
1580 <span>["regular"]</span> 1585 <span>["regular", "incognito_persistent"]</span>
1581 </span> 1586 </span>
1582 </span> 1587 </span>
1583 ) 1588 )
1584 </div> 1589 </div>
1585 1590
1586 </em> 1591 </em>
1587 </dt> 1592 </dt>
1588 <dd class="todo" style="display: none; "> 1593 <dd class="todo" style="display: none; ">
1589 Undocumented. 1594 Undocumented.
1590 </dd> 1595 </dd>
1591 <dd>Where to set the preference (default: regular). 'regular' = prefer ence for regular profile (which is inherited by the incognito profile if not ove rridden elsewhere).</dd> 1596 <dd>Where to set the preference (default: regular). 'regular' = prefer ence for regular profile (which is inherited by the incognito profile if not ove rridden elsewhere), 'incognito_persistent' = preference for incognito profile th at sustains browser restarts (overrides regular preferences).</dd>
1592 <dd style="display: none; "> 1597 <dd style="display: none; ">
1593 This parameter was added in version 1598 This parameter was added in version
1594 <b><span></span></b>. 1599 <b><span></span></b>.
1595 You must omit this parameter in earlier versions, 1600 You must omit this parameter in earlier versions,
1596 and you may omit it in any version. If you require this 1601 and you may omit it in any version. If you require this
1597 parameter, the manifest key 1602 parameter, the manifest key
1598 <a href="manifest.html#minimum_chrome_version">minimum_chrome_versio n</a> 1603 <a href="manifest.html#minimum_chrome_version">minimum_chrome_versio n</a>
1599 can ensure that your extension won't be run in an earlier browser ve rsion. 1604 can ensure that your extension won't be run in an earlier browser ve rsion.
1600 </dd> 1605 </dd>
1601 1606
(...skipping 530 matching lines...) Expand 10 before | Expand all | Expand 10 after
2132 _uff=0; 2137 _uff=0;
2133 urchinTracker(); 2138 urchinTracker();
2134 } 2139 }
2135 catch(e) {/* urchinTracker not available. */} 2140 catch(e) {/* urchinTracker not available. */}
2136 </script> 2141 </script>
2137 <!-- end analytics --> 2142 <!-- end analytics -->
2138 </div> 2143 </div>
2139 </div> <!-- /gc-footer --> 2144 </div> <!-- /gc-footer -->
2140 </div> <!-- /gc-container --> 2145 </div> <!-- /gc-container -->
2141 </body></html> 2146 </body></html>
OLDNEW

Powered by Google App Engine
This is Rietveld 408576698