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

Issues Search
    My Issues | Starred     Open | Closed | All

Side by Side Diff: chrome/common/extensions/docs/experimental.extension.html

Issue 6992022: Move Proxy Settings API out of experimental (Closed) Base URL: svn://svn.chromium.org/chrome/trunk/src
Patch Set: Removed remainder of merge conflict. Fixes 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
« no previous file with comments | « chrome/common/extensions/docs/experimental.contentSettings.misc.html ('k') | chrome/common/extensions/docs/experimental.proxy.html » ('j') | no next file with comments »
Toggle Intra-line Diffs ('i') | Expand Comments ('e') | Collapse Comments ('c') | Show Comments Hide Comments ('s')
OLDNEW
(Empty)
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
3 across api docs and should be edited only with knowledge of the
4 templating mechanism.
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
7 authored overview content.
8 4) The <body>.innerHTML is also generated by an offline step so that this
9 page may easily be indexed by search engines.
10 --><html xmlns="http://www.w3.org/1999/xhtml"><head>
11 <meta http-equiv="Content-Type" content="text/html; charset=UTF-8">
12 <link href="css/ApiRefStyles.css" rel="stylesheet" type="text/css">
13 <link href="css/print.css" rel="stylesheet" type="text/css" media="print">
14 <script type="text/javascript" src="../../../third_party/jstemplate/jstempla te_compiled.js">
15 </script>
16 <script type="text/javascript" src="js/api_page_generator.js"></script>
17 <script type="text/javascript" src="js/bootstrap.js"></script>
18 <script type="text/javascript" src="js/sidebar.js"></script>
19 <title>chrome.experimental.extension - Google Chrome Extensions - Google Code< /title></head>
20 <body> <div id="gc-container" class="labs">
21 <div id="devModeWarning">
22 You are viewing extension docs in chrome via the 'file:' scheme: are you expecting to see local changes when you refresh? You'll need run chrome with -- allow-file-access-from-files.
23 </div>
24 <!-- SUBTEMPLATES: DO NOT MOVE FROM THIS LOCATION -->
25 <!-- In particular, sub-templates that recurse, must be used by allowing
26 jstemplate to make a copy of the template in this section which
27 are not operated on by way of the jsskip="true" -->
28 <div style="display:none">
29
30 <!-- VALUE -->
31 <div id="valueTemplate">
32 <dt>
33 <var>paramName</var>
34 <em>
35
36 <!-- TYPE -->
37 <div style="display:inline">
38 (
39 <span class="optional">optional</span>
40 <span class="enum">enumerated</span>
41 <span id="typeTemplate">
42 <span>
43 <a> Type</a>
44 </span>
45 <span>
46 <span>
47 array of <span><span></span></span>
48 </span>
49 <span>paramType</span>
50 <span></span>
51 </span>
52 </span>
53 )
54 </div>
55
56 </em>
57 </dt>
58 <dd class="todo">
59 Undocumented.
60 </dd>
61 <dd>
62 Description of this parameter from the json schema.
63 </dd>
64 <dd>
65 This parameter was added in version
66 <b><span></span></b>.
67 You must omit this parameter in earlier versions,
68 and you may omit it in any version. If you require this
69 parameter, the manifest key
70 <a href="manifest.html#minimum_chrome_version">minimum_chrome_versio n</a>
71 can ensure that your extension won't be run in an earlier browser ve rsion.
72 </dd>
73
74 <!-- OBJECT PROPERTIES -->
75 <dd>
76 <dl>
77 <div>
78 <div>
79 </div>
80 </div>
81 </dl>
82 </dd>
83
84 <!-- OBJECT METHODS -->
85 <dd>
86 <div></div>
87 </dd>
88
89 <!-- OBJECT EVENT FIELDS -->
90 <dd>
91 <div></div>
92 </dd>
93
94 <!-- FUNCTION PARAMETERS -->
95 <dd>
96 <div></div>
97 </dd>
98
99 </div> <!-- /VALUE -->
100
101 <div id="functionParametersTemplate">
102 <h5>Parameters</h5>
103 <dl>
104 <div>
105 <div>
106 </div>
107 </div>
108 </dl>
109 </div>
110 </div> <!-- /SUBTEMPLATES -->
111
112 <a id="top"></a>
113 <div id="skipto">
114 <a href="#gc-pagecontent">Skip to page content</a>
115 <a href="#gc-toc">Skip to main navigation</a>
116 </div>
117 <!-- API HEADER -->
118 <table id="header" width="100%" cellspacing="0" border="0">
119 <tbody><tr>
120 <td valign="middle"><a href="http://code.google.com/"><img src="images/c ode_labs_logo.gif" height="43" width="161" alt="Google Code Labs" style="border: 0; margin:0;"></a></td>
121 <td valign="middle" width="100%" style="padding-left:0.6em;">
122 <form action="http://www.google.com/cse" id="cse" style="margin-top:0. 5em">
123 <div id="gsc-search-box">
124 <input type="hidden" name="cx" value="002967670403910741006:61_cvz fqtno">
125 <input type="hidden" name="ie" value="UTF-8">
126 <input type="text" name="q" value="" size="55">
127 <input class="gsc-search-button" type="submit" name="sa" value="Se arch">
128 <br>
129 <span class="greytext">e.g. "page action" or "tabs"</span>
130 </div>
131 </form>
132
133 <script type="text/javascript" src="http://www.google.com/jsapi"></scr ipt>
134 <script type="text/javascript">google.load("elements", "1", {packages: "transliteration"});</script>
135 <script type="text/javascript" src="http://www.google.com/coop/cse/t13 n?form=cse&amp;t13n_langs=en"></script>
136 <script type="text/javascript" src="http://www.google.com/coop/cse/bra nd?form=cse&amp;lang=en"></script>
137 </td>
138 </tr>
139 </tbody></table>
140
141 <div id="codesiteContent" class="">
142
143 <a id="gc-topnav-anchor"></a>
144 <div id="gc-topnav">
145 <h1>Google Chrome Extensions (<a href="http://code.google.com/labs/">Lab s</a>)</h1>
146 <ul id="home" class="gc-topnav-tabs">
147 <li id="home_link">
148 <a href="index.html" title="Google Chrome Extensions home page">Home </a>
149 </li>
150 <li id="docs_link">
151 <a href="docs.html" title="Official Google Chrome Extensions documen tation">Docs</a>
152 </li>
153 <li id="faq_link">
154 <a href="faq.html" title="Answers to frequently asked questions abou t Google Chrome Extensions">FAQ</a>
155 </li>
156 <li id="samples_link">
157 <a href="samples.html" title="Sample extensions (with source code)"> Samples</a>
158 </li>
159 <li id="group_link">
160 <a href="http://groups.google.com/a/chromium.org/group/chromium-exte nsions" title="Google Chrome Extensions developer forum">Group</a>
161 </li>
162 </ul>
163 </div> <!-- end gc-topnav -->
164
165 <div class="g-section g-tpl-170">
166 <!-- SIDENAV -->
167 <div class="g-unit g-first" id="gc-toc">
168 <ul>
169 <li><a href="getstarted.html">Getting Started</a></li>
170 <li><a href="overview.html">Overview</a></li>
171 <li><a href="whats_new.html">What's New?</a></li>
172 <li><h2><a href="devguide.html">Developer's Guide</a></h2>
173 <ul>
174 <li>Browser UI
175 <ul>
176 <li><a href="browserAction.html">Browser Actions</a></li>
177 <li><a href="contextMenus.html">Context Menus</a></li>
178 <li><a href="notifications.html">Desktop Notifications</a></li >
179 <li><a href="omnibox.html">Omnibox</a></li>
180 <li><a href="options.html">Options Pages</a></li>
181 <li><a href="override.html">Override Pages</a></li>
182 <li><a href="pageAction.html">Page Actions</a></li>
183 </ul>
184 </li>
185 <li>Browser Interaction
186 <ul>
187 <li><a href="bookmarks.html">Bookmarks</a></li>
188 <li><a href="cookies.html">Cookies</a></li>
189 <li><a href="events.html">Events</a></li>
190 <li><a href="history.html">History</a></li>
191 <li><a href="management.html">Management</a></li>
192 <li><a href="tabs.html">Tabs</a></li>
193 <li><a href="windows.html">Windows</a></li>
194 </ul>
195 </li>
196 <li>Implementation
197 <ul>
198 <li><a href="a11y.html">Accessibility</a></li>
199 <li><a href="background_pages.html">Background Pages</a></li>
200 <li><a href="content_scripts.html">Content Scripts</a></li>
201 <li><a href="xhr.html">Cross-Origin XHR</a></li>
202 <li><a href="idle.html">Idle</a></li>
203 <li><a href="i18n.html">Internationalization</a></li>
204 <li><a href="messaging.html">Message Passing</a></li>
205 <li><a href="npapi.html">NPAPI Plugins</a></li>
206 </ul>
207 </li>
208 <li>Finishing
209 <ul>
210 <li><a href="hosting.html">Hosting</a></li>
211 <li><a href="external_extensions.html">Other Deployment Option s</a></li>
212 </ul>
213 </li>
214 </ul>
215 </li>
216 <li><h2><a href="apps.html">Packaged Apps</a></h2></li>
217 <li><h2><a href="tutorials.html">Tutorials</a></h2>
218 <ul>
219 <li><a href="tut_debugging.html">Debugging</a></li>
220 <li><a href="tut_analytics.html">Google Analytics</a></li>
221 <li><a href="tut_oauth.html">OAuth</a></li>
222 </ul>
223 </li>
224 <li><h2>Reference</h2>
225 <ul>
226 <li>Formats
227 <ul>
228 <li><a href="manifest.html">Manifest Files</a></li>
229 <li><a href="match_patterns.html">Match Patterns</a></li>
230 </ul>
231 </li>
232 <li><a href="permission_warnings.html">Permission Warnings</a></li >
233 <li><a href="api_index.html">chrome.* APIs</a></li>
234 <li><a href="api_other.html">Other APIs</a></li>
235 </ul>
236 </li>
237 <li><h2><a href="samples.html">Samples</a></h2></li>
238 <div class="line"> </div>
239 <li><h2>More</h2>
240 <ul>
241 <li><a href="http://code.google.com/chrome/webstore/docs/index.htm l">Chrome Web Store</a></li>
242 <li><a href="http://code.google.com/chrome/apps/docs/developers_gu ide.html">Hosted Apps</a></li>
243 <li><a href="themes.html">Themes</a></li>
244 </ul>
245 </li>
246 </ul>
247 </div>
248 <script>
249 initToggles();
250 </script>
251
252 <div class="g-unit" id="gc-pagecontent">
253 <div id="pageTitle">
254 <h1 class="page_title">chrome.experimental.extension</h1>
255 </div>
256 <!-- TABLE OF CONTENTS -->
257 <div id="toc">
258 <h2>Contents</h2>
259 <ol>
260 <li style="display: none; ">
261 <a>h2Name</a>
262 <ol>
263 <li>
264 <a>h3Name</a>
265 </li>
266 </ol>
267 </li>
268 <li>
269 <a href="#apiReference">API reference: chrome.experimental.exten sion</a>
270 <ol>
271 <li style="display: none; ">
272 <a href="#properties">Properties</a>
273 <ol>
274 <li>
275 <a href="#property-anchor">propertyName</a>
276 </li>
277 </ol>
278 </li>
279 <li style="display: none; ">
280 <a>Methods</a>
281 <ol>
282 <li>
283 <a href="#method-anchor">methodName</a>
284 </li>
285 </ol>
286 </li>
287 <li style="display: none; ">
288 <a>Events</a>
289 <ol>
290 <li>
291 <a href="#event-anchor">eventName</a>
292 </li>
293 </ol>
294 </li>
295 <li>
296 <a href="#types">Types</a>
297 <ol>
298 <li>
299 <a href="#type-Preference">Preference</a>
300 </li>
301 </ol>
302 </li>
303 </ol>
304 </li>
305 </ol>
306 </div>
307 <!-- /TABLE OF CONTENTS -->
308
309 <!-- Standard content lead-in for experimental API pages -->
310 <p id="classSummary">
311 For information on how to use experimental APIs, see the <a href="expe rimental.html">chrome.experimental.* APIs</a> page.
312 </p>
313
314 <!-- STATIC CONTENT PLACEHOLDER -->
315 <div id="static"></div>
316
317 <!-- API PAGE -->
318 <div class="apiPage">
319 <a name="apiReference"></a>
320 <h2>API reference: chrome.experimental.extension</h2>
321
322 <!-- PROPERTIES -->
323 <div class="apiGroup" style="display: none; ">
324 <a name="properties"></a>
325 <h3 id="properties">Properties</h3>
326
327 <div>
328 <a></a>
329 <h4>getLastError</h4>
330 <div class="summary">
331 <!-- Note: intentionally longer 80 columns -->
332 <span>chrome.extension</span><span>lastError</span>
333 </div>
334 <div>
335 </div>
336 </div>
337
338 </div> <!-- /apiGroup -->
339
340 <!-- METHODS -->
341 <div id="methodsTemplate" class="apiGroup" style="display: none; ">
342 <a></a>
343 <h3>Methods</h3>
344
345 <!-- iterates over all functions -->
346 <div class="apiItem">
347 <a></a> <!-- method-anchor -->
348 <h4>method name</h4>
349
350 <div class="summary"><span>void</span>
351 <!-- Note: intentionally longer 80 columns -->
352 <span>chrome.module.methodName</span>(<span><span>, </span><sp an></span>
353 <var><span></span></var></span>)</div>
354
355 <div class="description">
356 <p class="todo">Undocumented.</p>
357 <p>
358 A description from the json schema def of the function goes he re.
359 </p>
360
361 <!-- PARAMETERS -->
362 <h4>Parameters</h4>
363 <dl>
364 <div>
365 <div>
366 </div>
367 </div>
368 </dl>
369
370 <!-- RETURNS -->
371 <h4>Returns</h4>
372 <dl>
373 <div>
374 <div>
375 </div>
376 </div>
377 </dl>
378
379 <!-- CALLBACK -->
380 <div>
381 <div>
382 <h4>Callback function</h4>
383 <p>
384 The callback <em>parameter</em> should specify a function
385 that looks like this:
386 </p>
387 <p>
388 If you specify the <em>callback</em> parameter, it should
389 specify a function that looks like this:
390 </p>
391
392 <!-- Note: intentionally longer 80 columns -->
393 <pre>function(<span>Type param1, Type param2</span>) <span cla ss="subdued">{...}</span>;</pre>
394 <dl>
395 <div>
396 <div>
397 </div>
398 </div>
399 </dl>
400 </div>
401 </div>
402
403 <!-- MIN_VERSION -->
404 <p>
405 This function was added in version <b><span></span></b>.
406 If you require this function, the manifest key
407 <a href="manifest.html#minimum_chrome_version">minimum_chrome_ version</a>
408 can ensure that your extension won't be run in an earlier brow ser version.
409 </p>
410 </div> <!-- /description -->
411
412 </div> <!-- /apiItem -->
413
414 </div> <!-- /apiGroup -->
415
416 <!-- EVENTS -->
417 <div id="eventsTemplate" class="apiGroup" style="display: none; ">
418 <a></a>
419 <h3>Events</h3>
420 <!-- iterates over all events -->
421 <div class="apiItem">
422 <a></a>
423 <h4>event name</h4>
424
425 <div class="summary">
426 <!-- Note: intentionally longer 80 columns -->
427 <span class="subdued">chrome.bookmarks</span><span>onEvent</span ><span class="subdued">.addListener</span>(function(<span>Type param1, Type para m2</span>) <span class="subdued">{...}</span><span>, Type opt_param1, Type opt_p aram2</span>));
428 </div>
429
430 <div class="description">
431 <p class="todo">Undocumented.</p>
432 <p>
433 A description from the json schema def of the event goes here.
434 </p>
435
436 <!-- LISTENER PARAMETERS -->
437 <div>
438 <h4>Listener parameters</h4>
439 <dl>
440 <div>
441 <div>
442 </div>
443 </div>
444 </dl>
445 </div>
446
447 <!-- EXTRA PARAMETERS -->
448 <div>
449 <h4>Extra parameters to addListener</h4>
450 <dl>
451 <div>
452 <div>
453 </div>
454 </div>
455 </dl>
456 </div>
457
458 <!-- LISTENER RETURN VALUE -->
459 <h4>Listener returns</h4>
460 <dl>
461 <div>
462 <div>
463 </div>
464 </div>
465 </dl>
466
467 </div> <!-- /description -->
468 </div> <!-- /apiItem -->
469
470 </div> <!-- /apiGroup -->
471
472 <!-- TYPES -->
473 <div class="apiGroup">
474 <a name="types"></a>
475 <h3 id="types">Types</h3>
476
477 <!-- iterates over all types -->
478 <div class="apiItem">
479 <a name="type-Preference"></a>
480 <h4>Preference</h4>
481
482 <div>
483 <dt>
484 <var style="display: none; ">paramName</var>
485 <em>
486
487 <!-- TYPE -->
488 <div style="display:inline">
489 (
490 <span class="optional" style="display: none; ">optional</spa n>
491 <span class="enum" style="display: none; ">enumerated</span>
492 <span id="typeTemplate">
493 <span style="display: none; ">
494 <a> Type</a>
495 </span>
496 <span>
497 <span style="display: none; ">
498 array of <span><span></span></span>
499 </span>
500 <span>object</span>
501 <span style="display: none; "></span>
502 </span>
503 </span>
504 )
505 </div>
506
507 </em>
508 </dt>
509 <dd class="todo" style="display: none; ">
510 Undocumented.
511 </dd>
512 <dd>An object which allows access to a preference.</dd>
513 <dd style="display: none; ">
514 This parameter was added in version
515 <b><span></span></b>.
516 You must omit this parameter in earlier versions,
517 and you may omit it in any version. If you require this
518 parameter, the manifest key
519 <a href="manifest.html#minimum_chrome_version">minimum_chrome_versio n</a>
520 can ensure that your extension won't be run in an earlier browser ve rsion.
521 </dd>
522
523 <!-- OBJECT PROPERTIES -->
524 <dd style="display: none; ">
525 <dl>
526 <div>
527 <div>
528 </div>
529 </div>
530 </dl>
531 </dd>
532
533 <!-- OBJECT METHODS -->
534 <dd>
535 <div class="apiGroup" style="">
536 <a name="global-Preference-methods"></a>
537 <h3>Methods of Preference</h3>
538
539 <!-- iterates over all functions -->
540 <div class="apiItem">
541 <a name="method-Preference-clear"></a> <!-- method-anchor -->
542 <h4>clear</h4>
543
544 <div class="summary"><span style="display: none; ">void</span>
545 <!-- Note: intentionally longer 80 columns -->
546 <span>preference.clear</span>(<span class="null"><span style=" display: none; ">, </span><span>object</span>
547 <var><span>details</span></var></span><span class="optiona l"><span>, </span><span>function</span>
548 <var><span>callback</span></var></span>)</div>
549
550 <div class="description">
551 <p class="todo" style="display: none; ">Undocumented.</p>
552 <p>Clears the setting in the user preferences. This way default settings can become effective again.</p>
553
554 <!-- PARAMETERS -->
555 <h4>Parameters</h4>
556 <dl>
557 <div>
558 <div>
559 <dt>
560 <var>details</var>
561 <em>
562
563 <!-- TYPE -->
564 <div style="display:inline">
565 (
566 <span class="optional" style="display: none; ">optional</spa n>
567 <span class="enum" style="display: none; ">enumerated</span>
568 <span id="typeTemplate">
569 <span style="display: none; ">
570 <a> Type</a>
571 </span>
572 <span>
573 <span style="display: none; ">
574 array of <span><span></span></span>
575 </span>
576 <span>object</span>
577 <span style="display: none; "></span>
578 </span>
579 </span>
580 )
581 </div>
582
583 </em>
584 </dt>
585 <dd class="todo" style="display: none; ">
586 Undocumented.
587 </dd>
588 <dd>What preference to clear.</dd>
589 <dd style="display: none; ">
590 This parameter was added in version
591 <b><span></span></b>.
592 You must omit this parameter in earlier versions,
593 and you may omit it in any version. If you require this
594 parameter, the manifest key
595 <a href="manifest.html#minimum_chrome_version">minimum_chrome_versio n</a>
596 can ensure that your extension won't be run in an earlier browser ve rsion.
597 </dd>
598
599 <!-- OBJECT PROPERTIES -->
600 <dd>
601 <dl>
602 <div>
603 <div>
604 <dt>
605 <var>scope</var>
606 <em>
607
608 <!-- TYPE -->
609 <div style="display:inline">
610 (
611 <span class="optional">optional</span>
612 <span class="enum">enumerated</span>
613 <span id="typeTemplate">
614 <span style="display: none; ">
615 <a> Type</a>
616 </span>
617 <span>
618 <span style="display: none; ">
619 array of <span><span></span></span>
620 </span>
621 <span>string</span>
622 <span>["regular"]</span>
623 </span>
624 </span>
625 )
626 </div>
627
628 </em>
629 </dt>
630 <dd class="todo" style="display: none; ">
631 Undocumented.
632 </dd>
633 <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>
634 <dd style="display: none; ">
635 This parameter was added in version
636 <b><span></span></b>.
637 You must omit this parameter in earlier versions,
638 and you may omit it in any version. If you require this
639 parameter, the manifest key
640 <a href="manifest.html#minimum_chrome_version">minimum_chrome_versio n</a>
641 can ensure that your extension won't be run in an earlier browser ve rsion.
642 </dd>
643
644 <!-- OBJECT PROPERTIES -->
645 <dd style="display: none; ">
646 <dl>
647 <div>
648 <div>
649 </div>
650 </div>
651 </dl>
652 </dd>
653
654 <!-- OBJECT METHODS -->
655 <dd style="display: none; ">
656 <div></div>
657 </dd>
658
659 <!-- OBJECT EVENT FIELDS -->
660 <dd style="display: none; ">
661 <div></div>
662 </dd>
663
664 <!-- FUNCTION PARAMETERS -->
665 <dd style="display: none; ">
666 <div></div>
667 </dd>
668
669 </div>
670 </div>
671 </dl>
672 </dd>
673
674 <!-- OBJECT METHODS -->
675 <dd style="display: none; ">
676 <div></div>
677 </dd>
678
679 <!-- OBJECT EVENT FIELDS -->
680 <dd style="display: none; ">
681 <div></div>
682 </dd>
683
684 <!-- FUNCTION PARAMETERS -->
685 <dd style="display: none; ">
686 <div></div>
687 </dd>
688
689 </div>
690 </div><div>
691 <div>
692 <dt>
693 <var>callback</var>
694 <em>
695
696 <!-- TYPE -->
697 <div style="display:inline">
698 (
699 <span class="optional">optional</span>
700 <span class="enum" style="display: none; ">enumerated</span>
701 <span id="typeTemplate">
702 <span style="display: none; ">
703 <a> Type</a>
704 </span>
705 <span>
706 <span style="display: none; ">
707 array of <span><span></span></span>
708 </span>
709 <span>function</span>
710 <span style="display: none; "></span>
711 </span>
712 </span>
713 )
714 </div>
715
716 </em>
717 </dt>
718 <dd class="todo" style="display: none; ">
719 Undocumented.
720 </dd>
721 <dd>Called after the preference has been cleared.</dd>
722 <dd style="display: none; ">
723 This parameter was added in version
724 <b><span></span></b>.
725 You must omit this parameter in earlier versions,
726 and you may omit it in any version. If you require this
727 parameter, the manifest key
728 <a href="manifest.html#minimum_chrome_version">minimum_chrome_versio n</a>
729 can ensure that your extension won't be run in an earlier browser ve rsion.
730 </dd>
731
732 <!-- OBJECT PROPERTIES -->
733 <dd style="display: none; ">
734 <dl>
735 <div>
736 <div>
737 </div>
738 </div>
739 </dl>
740 </dd>
741
742 <!-- OBJECT METHODS -->
743 <dd style="display: none; ">
744 <div></div>
745 </dd>
746
747 <!-- OBJECT EVENT FIELDS -->
748 <dd style="display: none; ">
749 <div></div>
750 </dd>
751
752 <!-- FUNCTION PARAMETERS -->
753 <dd style="display: none; ">
754 <div></div>
755 </dd>
756
757 </div>
758 </div>
759 </dl>
760
761 <!-- RETURNS -->
762 <h4 style="display: none; ">Returns</h4>
763 <dl>
764 <div style="display: none; ">
765 <div>
766 </div>
767 </div>
768 </dl>
769
770 <!-- CALLBACK -->
771 <div>
772 <div>
773 <h4>Callback function</h4>
774 <p style="display: none; ">
775 The callback <em>parameter</em> should specify a function
776 that looks like this:
777 </p>
778 <p>
779 If you specify the <em>callback</em> parameter, it should
780 specify a function that looks like this:
781 </p>
782
783 <!-- Note: intentionally longer 80 columns -->
784 <pre>function(<span></span>) <span class="subdued">{...}</span >;</pre>
785 <dl>
786 <div style="display: none; ">
787 <div>
788 </div>
789 </div>
790 </dl>
791 </div>
792 </div>
793
794 <!-- MIN_VERSION -->
795 <p style="display: none; ">
796 This function was added in version <b><span></span></b>.
797 If you require this function, the manifest key
798 <a href="manifest.html#minimum_chrome_version">minimum_chrome_ version</a>
799 can ensure that your extension won't be run in an earlier brow ser version.
800 </p>
801 </div> <!-- /description -->
802
803 </div><div class="apiItem">
804 <a name="method-Preference-get"></a> <!-- method-anchor -->
805 <h4>get</h4>
806
807 <div class="summary"><span style="display: none; ">void</span>
808 <!-- Note: intentionally longer 80 columns -->
809 <span>preference.get</span>(<span class="null"><span style="di splay: none; ">, </span><span>object</span>
810 <var><span>details</span></var></span><span class="null">< span>, </span><span>function</span>
811 <var><span>callback</span></var></span>)</div>
812
813 <div class="description">
814 <p class="todo" style="display: none; ">Undocumented.</p>
815 <p>Get the setting from the user preferences.</p>
816
817 <!-- PARAMETERS -->
818 <h4>Parameters</h4>
819 <dl>
820 <div>
821 <div>
822 <dt>
823 <var>details</var>
824 <em>
825
826 <!-- TYPE -->
827 <div style="display:inline">
828 (
829 <span class="optional" style="display: none; ">optional</spa n>
830 <span class="enum" style="display: none; ">enumerated</span>
831 <span id="typeTemplate">
832 <span style="display: none; ">
833 <a> Type</a>
834 </span>
835 <span>
836 <span style="display: none; ">
837 array of <span><span></span></span>
838 </span>
839 <span>object</span>
840 <span style="display: none; "></span>
841 </span>
842 </span>
843 )
844 </div>
845
846 </em>
847 </dt>
848 <dd class="todo" style="display: none; ">
849 Undocumented.
850 </dd>
851 <dd>What setting to return.</dd>
852 <dd style="display: none; ">
853 This parameter was added in version
854 <b><span></span></b>.
855 You must omit this parameter in earlier versions,
856 and you may omit it in any version. If you require this
857 parameter, the manifest key
858 <a href="manifest.html#minimum_chrome_version">minimum_chrome_versio n</a>
859 can ensure that your extension won't be run in an earlier browser ve rsion.
860 </dd>
861
862 <!-- OBJECT PROPERTIES -->
863 <dd>
864 <dl>
865 <div>
866 <div>
867 <dt>
868 <var>incognito</var>
869 <em>
870
871 <!-- TYPE -->
872 <div style="display:inline">
873 (
874 <span class="optional">optional</span>
875 <span class="enum" style="display: none; ">enumerated</span>
876 <span id="typeTemplate">
877 <span style="display: none; ">
878 <a> Type</a>
879 </span>
880 <span>
881 <span style="display: none; ">
882 array of <span><span></span></span>
883 </span>
884 <span>boolean</span>
885 <span style="display: none; "></span>
886 </span>
887 </span>
888 )
889 </div>
890
891 </em>
892 </dt>
893 <dd class="todo" style="display: none; ">
894 Undocumented.
895 </dd>
896 <dd>Whether to return the setting that applies to the incognito sessio n (default false).</dd>
897 <dd style="display: none; ">
898 This parameter was added in version
899 <b><span></span></b>.
900 You must omit this parameter in earlier versions,
901 and you may omit it in any version. If you require this
902 parameter, the manifest key
903 <a href="manifest.html#minimum_chrome_version">minimum_chrome_versio n</a>
904 can ensure that your extension won't be run in an earlier browser ve rsion.
905 </dd>
906
907 <!-- OBJECT PROPERTIES -->
908 <dd style="display: none; ">
909 <dl>
910 <div>
911 <div>
912 </div>
913 </div>
914 </dl>
915 </dd>
916
917 <!-- OBJECT METHODS -->
918 <dd style="display: none; ">
919 <div></div>
920 </dd>
921
922 <!-- OBJECT EVENT FIELDS -->
923 <dd style="display: none; ">
924 <div></div>
925 </dd>
926
927 <!-- FUNCTION PARAMETERS -->
928 <dd style="display: none; ">
929 <div></div>
930 </dd>
931
932 </div>
933 </div>
934 </dl>
935 </dd>
936
937 <!-- OBJECT METHODS -->
938 <dd style="display: none; ">
939 <div></div>
940 </dd>
941
942 <!-- OBJECT EVENT FIELDS -->
943 <dd style="display: none; ">
944 <div></div>
945 </dd>
946
947 <!-- FUNCTION PARAMETERS -->
948 <dd style="display: none; ">
949 <div></div>
950 </dd>
951
952 </div>
953 </div><div>
954 <div>
955 <dt>
956 <var>callback</var>
957 <em>
958
959 <!-- TYPE -->
960 <div style="display:inline">
961 (
962 <span class="optional" style="display: none; ">optional</spa n>
963 <span class="enum" style="display: none; ">enumerated</span>
964 <span id="typeTemplate">
965 <span style="display: none; ">
966 <a> Type</a>
967 </span>
968 <span>
969 <span style="display: none; ">
970 array of <span><span></span></span>
971 </span>
972 <span>function</span>
973 <span style="display: none; "></span>
974 </span>
975 </span>
976 )
977 </div>
978
979 </em>
980 </dt>
981 <dd class="todo">
982 Undocumented.
983 </dd>
984 <dd style="display: none; ">
985 Description of this parameter from the json schema.
986 </dd>
987 <dd style="display: none; ">
988 This parameter was added in version
989 <b><span></span></b>.
990 You must omit this parameter in earlier versions,
991 and you may omit it in any version. If you require this
992 parameter, the manifest key
993 <a href="manifest.html#minimum_chrome_version">minimum_chrome_versio n</a>
994 can ensure that your extension won't be run in an earlier browser ve rsion.
995 </dd>
996
997 <!-- OBJECT PROPERTIES -->
998 <dd style="display: none; ">
999 <dl>
1000 <div>
1001 <div>
1002 </div>
1003 </div>
1004 </dl>
1005 </dd>
1006
1007 <!-- OBJECT METHODS -->
1008 <dd style="display: none; ">
1009 <div></div>
1010 </dd>
1011
1012 <!-- OBJECT EVENT FIELDS -->
1013 <dd style="display: none; ">
1014 <div></div>
1015 </dd>
1016
1017 <!-- FUNCTION PARAMETERS -->
1018 <dd style="display: none; ">
1019 <div></div>
1020 </dd>
1021
1022 </div>
1023 </div>
1024 </dl>
1025
1026 <!-- RETURNS -->
1027 <h4 style="display: none; ">Returns</h4>
1028 <dl>
1029 <div style="display: none; ">
1030 <div>
1031 </div>
1032 </div>
1033 </dl>
1034
1035 <!-- CALLBACK -->
1036 <div>
1037 <div>
1038 <h4>Callback function</h4>
1039 <p>
1040 The callback <em>parameter</em> should specify a function
1041 that looks like this:
1042 </p>
1043 <p style="display: none; ">
1044 If you specify the <em>callback</em> parameter, it should
1045 specify a function that looks like this:
1046 </p>
1047
1048 <!-- Note: intentionally longer 80 columns -->
1049 <pre>function(<span>object details</span>) <span class="subdue d">{...}</span>;</pre>
1050 <dl>
1051 <div>
1052 <div>
1053 <dt>
1054 <var>details</var>
1055 <em>
1056
1057 <!-- TYPE -->
1058 <div style="display:inline">
1059 (
1060 <span class="optional" style="display: none; ">optional</spa n>
1061 <span class="enum" style="display: none; ">enumerated</span>
1062 <span id="typeTemplate">
1063 <span style="display: none; ">
1064 <a> Type</a>
1065 </span>
1066 <span>
1067 <span style="display: none; ">
1068 array of <span><span></span></span>
1069 </span>
1070 <span>object</span>
1071 <span style="display: none; "></span>
1072 </span>
1073 </span>
1074 )
1075 </div>
1076
1077 </em>
1078 </dt>
1079 <dd class="todo" style="display: none; ">
1080 Undocumented.
1081 </dd>
1082 <dd>Details of the currently effective preference value.</dd>
1083 <dd style="display: none; ">
1084 This parameter was added in version
1085 <b><span></span></b>.
1086 You must omit this parameter in earlier versions,
1087 and you may omit it in any version. If you require this
1088 parameter, the manifest key
1089 <a href="manifest.html#minimum_chrome_version">minimum_chrome_versio n</a>
1090 can ensure that your extension won't be run in an earlier browser ve rsion.
1091 </dd>
1092
1093 <!-- OBJECT PROPERTIES -->
1094 <dd>
1095 <dl>
1096 <div>
1097 <div>
1098 <dt>
1099 <var>value</var>
1100 <em>
1101
1102 <!-- TYPE -->
1103 <div style="display:inline">
1104 (
1105 <span class="optional" style="display: none; ">optional</spa n>
1106 <span class="enum" style="display: none; ">enumerated</span>
1107 <span id="typeTemplate">
1108 <span style="display: none; ">
1109 <a> Type</a>
1110 </span>
1111 <span>
1112 <span style="display: none; ">
1113 array of <span><span></span></span>
1114 </span>
1115 <span>any</span>
1116 <span style="display: none; "></span>
1117 </span>
1118 </span>
1119 )
1120 </div>
1121
1122 </em>
1123 </dt>
1124 <dd class="todo" style="display: none; ">
1125 Undocumented.
1126 </dd>
1127 <dd>The value of the preference.</dd>
1128 <dd style="display: none; ">
1129 This parameter was added in version
1130 <b><span></span></b>.
1131 You must omit this parameter in earlier versions,
1132 and you may omit it in any version. If you require this
1133 parameter, the manifest key
1134 <a href="manifest.html#minimum_chrome_version">minimum_chrome_versio n</a>
1135 can ensure that your extension won't be run in an earlier browser ve rsion.
1136 </dd>
1137
1138 <!-- OBJECT PROPERTIES -->
1139 <dd style="display: none; ">
1140 <dl>
1141 <div>
1142 <div>
1143 </div>
1144 </div>
1145 </dl>
1146 </dd>
1147
1148 <!-- OBJECT METHODS -->
1149 <dd style="display: none; ">
1150 <div></div>
1151 </dd>
1152
1153 <!-- OBJECT EVENT FIELDS -->
1154 <dd style="display: none; ">
1155 <div></div>
1156 </dd>
1157
1158 <!-- FUNCTION PARAMETERS -->
1159 <dd style="display: none; ">
1160 <div></div>
1161 </dd>
1162
1163 </div>
1164 </div><div>
1165 <div>
1166 <dt>
1167 <var>levelOfControl</var>
1168 <em>
1169
1170 <!-- TYPE -->
1171 <div style="display:inline">
1172 (
1173 <span class="optional" style="display: none; ">optional</spa n>
1174 <span class="enum">enumerated</span>
1175 <span id="typeTemplate">
1176 <span style="display: none; ">
1177 <a> Type</a>
1178 </span>
1179 <span>
1180 <span style="display: none; ">
1181 array of <span><span></span></span>
1182 </span>
1183 <span>string</span>
1184 <span>["NotControllable", "ControlledByOtherExtensions", "ControllableByThisExtension", "ControlledByThisExtension"]</span>
1185 </span>
1186 </span>
1187 )
1188 </div>
1189
1190 </em>
1191 </dt>
1192 <dd class="todo" style="display: none; ">
1193 Undocumented.
1194 </dd>
1195 <dd>One of<br><var>NotControllable</var>: cannot be controlled by any extension<br><var>ControlledByOtherExtensions</var>: controlled by extensions wi th higher precedence<br><var>ControllableByThisExtension</var>: can be controlle d by this extension<br><var>ControlledByThisExtension</var>: controlled by this extension</dd>
1196 <dd style="display: none; ">
1197 This parameter was added in version
1198 <b><span></span></b>.
1199 You must omit this parameter in earlier versions,
1200 and you may omit it in any version. If you require this
1201 parameter, the manifest key
1202 <a href="manifest.html#minimum_chrome_version">minimum_chrome_versio n</a>
1203 can ensure that your extension won't be run in an earlier browser ve rsion.
1204 </dd>
1205
1206 <!-- OBJECT PROPERTIES -->
1207 <dd style="display: none; ">
1208 <dl>
1209 <div>
1210 <div>
1211 </div>
1212 </div>
1213 </dl>
1214 </dd>
1215
1216 <!-- OBJECT METHODS -->
1217 <dd style="display: none; ">
1218 <div></div>
1219 </dd>
1220
1221 <!-- OBJECT EVENT FIELDS -->
1222 <dd style="display: none; ">
1223 <div></div>
1224 </dd>
1225
1226 <!-- FUNCTION PARAMETERS -->
1227 <dd style="display: none; ">
1228 <div></div>
1229 </dd>
1230
1231 </div>
1232 </div><div>
1233 <div>
1234 <dt>
1235 <var>incognitoSpecific</var>
1236 <em>
1237
1238 <!-- TYPE -->
1239 <div style="display:inline">
1240 (
1241 <span class="optional">optional</span>
1242 <span class="enum" style="display: none; ">enumerated</span>
1243 <span id="typeTemplate">
1244 <span style="display: none; ">
1245 <a> Type</a>
1246 </span>
1247 <span>
1248 <span style="display: none; ">
1249 array of <span><span></span></span>
1250 </span>
1251 <span>boolean</span>
1252 <span style="display: none; "></span>
1253 </span>
1254 </span>
1255 )
1256 </div>
1257
1258 </em>
1259 </dt>
1260 <dd class="todo" style="display: none; ">
1261 Undocumented.
1262 </dd>
1263 <dd>Whether the effective value is specific to the incognito session.< br>This property will <em>only</em> be present if the <var>incognito</var> prope rty in the <var>details</var> parameter of <code>get()</code> was true.</dd>
1264 <dd style="display: none; ">
1265 This parameter was added in version
1266 <b><span></span></b>.
1267 You must omit this parameter in earlier versions,
1268 and you may omit it in any version. If you require this
1269 parameter, the manifest key
1270 <a href="manifest.html#minimum_chrome_version">minimum_chrome_versio n</a>
1271 can ensure that your extension won't be run in an earlier browser ve rsion.
1272 </dd>
1273
1274 <!-- OBJECT PROPERTIES -->
1275 <dd style="display: none; ">
1276 <dl>
1277 <div>
1278 <div>
1279 </div>
1280 </div>
1281 </dl>
1282 </dd>
1283
1284 <!-- OBJECT METHODS -->
1285 <dd style="display: none; ">
1286 <div></div>
1287 </dd>
1288
1289 <!-- OBJECT EVENT FIELDS -->
1290 <dd style="display: none; ">
1291 <div></div>
1292 </dd>
1293
1294 <!-- FUNCTION PARAMETERS -->
1295 <dd style="display: none; ">
1296 <div></div>
1297 </dd>
1298
1299 </div>
1300 </div>
1301 </dl>
1302 </dd>
1303
1304 <!-- OBJECT METHODS -->
1305 <dd style="display: none; ">
1306 <div></div>
1307 </dd>
1308
1309 <!-- OBJECT EVENT FIELDS -->
1310 <dd style="display: none; ">
1311 <div></div>
1312 </dd>
1313
1314 <!-- FUNCTION PARAMETERS -->
1315 <dd style="display: none; ">
1316 <div></div>
1317 </dd>
1318
1319 </div>
1320 </div>
1321 </dl>
1322 </div>
1323 </div>
1324
1325 <!-- MIN_VERSION -->
1326 <p style="display: none; ">
1327 This function was added in version <b><span></span></b>.
1328 If you require this function, the manifest key
1329 <a href="manifest.html#minimum_chrome_version">minimum_chrome_ version</a>
1330 can ensure that your extension won't be run in an earlier brow ser version.
1331 </p>
1332 </div> <!-- /description -->
1333
1334 </div><div class="apiItem">
1335 <a name="method-Preference-set"></a> <!-- method-anchor -->
1336 <h4>set</h4>
1337
1338 <div class="summary"><span style="display: none; ">void</span>
1339 <!-- Note: intentionally longer 80 columns -->
1340 <span>preference.set</span>(<span class="null"><span style="di splay: none; ">, </span><span>object</span>
1341 <var><span>details</span></var></span><span class="optiona l"><span>, </span><span>function</span>
1342 <var><span>callback</span></var></span>)</div>
1343
1344 <div class="description">
1345 <p class="todo" style="display: none; ">Undocumented.</p>
1346 <p>Set the setting in the user preferences</p>
1347
1348 <!-- PARAMETERS -->
1349 <h4>Parameters</h4>
1350 <dl>
1351 <div>
1352 <div>
1353 <dt>
1354 <var>details</var>
1355 <em>
1356
1357 <!-- TYPE -->
1358 <div style="display:inline">
1359 (
1360 <span class="optional" style="display: none; ">optional</spa n>
1361 <span class="enum" style="display: none; ">enumerated</span>
1362 <span id="typeTemplate">
1363 <span style="display: none; ">
1364 <a> Type</a>
1365 </span>
1366 <span>
1367 <span style="display: none; ">
1368 array of <span><span></span></span>
1369 </span>
1370 <span>object</span>
1371 <span style="display: none; "></span>
1372 </span>
1373 </span>
1374 )
1375 </div>
1376
1377 </em>
1378 </dt>
1379 <dd class="todo" style="display: none; ">
1380 Undocumented.
1381 </dd>
1382 <dd>What setting to change.</dd>
1383 <dd style="display: none; ">
1384 This parameter was added in version
1385 <b><span></span></b>.
1386 You must omit this parameter in earlier versions,
1387 and you may omit it in any version. If you require this
1388 parameter, the manifest key
1389 <a href="manifest.html#minimum_chrome_version">minimum_chrome_versio n</a>
1390 can ensure that your extension won't be run in an earlier browser ve rsion.
1391 </dd>
1392
1393 <!-- OBJECT PROPERTIES -->
1394 <dd>
1395 <dl>
1396 <div>
1397 <div>
1398 <dt>
1399 <var>value</var>
1400 <em>
1401
1402 <!-- TYPE -->
1403 <div style="display:inline">
1404 (
1405 <span class="optional" style="display: none; ">optional</spa n>
1406 <span class="enum" style="display: none; ">enumerated</span>
1407 <span id="typeTemplate">
1408 <span style="display: none; ">
1409 <a> Type</a>
1410 </span>
1411 <span>
1412 <span style="display: none; ">
1413 array of <span><span></span></span>
1414 </span>
1415 <span>any</span>
1416 <span style="display: none; "></span>
1417 </span>
1418 </span>
1419 )
1420 </div>
1421
1422 </em>
1423 </dt>
1424 <dd class="todo" style="display: none; ">
1425 Undocumented.
1426 </dd>
1427 <dd>The value of the preference. <br>Note that every preference has a specific value type, which is described together with the preference. An extensi on should <em>not</em> set a preference value of a different type.</dd>
1428 <dd style="display: none; ">
1429 This parameter was added in version
1430 <b><span></span></b>.
1431 You must omit this parameter in earlier versions,
1432 and you may omit it in any version. If you require this
1433 parameter, the manifest key
1434 <a href="manifest.html#minimum_chrome_version">minimum_chrome_versio n</a>
1435 can ensure that your extension won't be run in an earlier browser ve rsion.
1436 </dd>
1437
1438 <!-- OBJECT PROPERTIES -->
1439 <dd style="display: none; ">
1440 <dl>
1441 <div>
1442 <div>
1443 </div>
1444 </div>
1445 </dl>
1446 </dd>
1447
1448 <!-- OBJECT METHODS -->
1449 <dd style="display: none; ">
1450 <div></div>
1451 </dd>
1452
1453 <!-- OBJECT EVENT FIELDS -->
1454 <dd style="display: none; ">
1455 <div></div>
1456 </dd>
1457
1458 <!-- FUNCTION PARAMETERS -->
1459 <dd style="display: none; ">
1460 <div></div>
1461 </dd>
1462
1463 </div>
1464 </div><div>
1465 <div>
1466 <dt>
1467 <var>scope</var>
1468 <em>
1469
1470 <!-- TYPE -->
1471 <div style="display:inline">
1472 (
1473 <span class="optional">optional</span>
1474 <span class="enum">enumerated</span>
1475 <span id="typeTemplate">
1476 <span style="display: none; ">
1477 <a> Type</a>
1478 </span>
1479 <span>
1480 <span style="display: none; ">
1481 array of <span><span></span></span>
1482 </span>
1483 <span>string</span>
1484 <span>["regular"]</span>
1485 </span>
1486 </span>
1487 )
1488 </div>
1489
1490 </em>
1491 </dt>
1492 <dd class="todo" style="display: none; ">
1493 Undocumented.
1494 </dd>
1495 <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>
1496 <dd style="display: none; ">
1497 This parameter was added in version
1498 <b><span></span></b>.
1499 You must omit this parameter in earlier versions,
1500 and you may omit it in any version. If you require this
1501 parameter, the manifest key
1502 <a href="manifest.html#minimum_chrome_version">minimum_chrome_versio n</a>
1503 can ensure that your extension won't be run in an earlier browser ve rsion.
1504 </dd>
1505
1506 <!-- OBJECT PROPERTIES -->
1507 <dd style="display: none; ">
1508 <dl>
1509 <div>
1510 <div>
1511 </div>
1512 </div>
1513 </dl>
1514 </dd>
1515
1516 <!-- OBJECT METHODS -->
1517 <dd style="display: none; ">
1518 <div></div>
1519 </dd>
1520
1521 <!-- OBJECT EVENT FIELDS -->
1522 <dd style="display: none; ">
1523 <div></div>
1524 </dd>
1525
1526 <!-- FUNCTION PARAMETERS -->
1527 <dd style="display: none; ">
1528 <div></div>
1529 </dd>
1530
1531 </div>
1532 </div>
1533 </dl>
1534 </dd>
1535
1536 <!-- OBJECT METHODS -->
1537 <dd style="display: none; ">
1538 <div></div>
1539 </dd>
1540
1541 <!-- OBJECT EVENT FIELDS -->
1542 <dd style="display: none; ">
1543 <div></div>
1544 </dd>
1545
1546 <!-- FUNCTION PARAMETERS -->
1547 <dd style="display: none; ">
1548 <div></div>
1549 </dd>
1550
1551 </div>
1552 </div><div>
1553 <div>
1554 <dt>
1555 <var>callback</var>
1556 <em>
1557
1558 <!-- TYPE -->
1559 <div style="display:inline">
1560 (
1561 <span class="optional">optional</span>
1562 <span class="enum" style="display: none; ">enumerated</span>
1563 <span id="typeTemplate">
1564 <span style="display: none; ">
1565 <a> Type</a>
1566 </span>
1567 <span>
1568 <span style="display: none; ">
1569 array of <span><span></span></span>
1570 </span>
1571 <span>function</span>
1572 <span style="display: none; "></span>
1573 </span>
1574 </span>
1575 )
1576 </div>
1577
1578 </em>
1579 </dt>
1580 <dd class="todo" style="display: none; ">
1581 Undocumented.
1582 </dd>
1583 <dd>Called after the preference has been set.</dd>
1584 <dd style="display: none; ">
1585 This parameter was added in version
1586 <b><span></span></b>.
1587 You must omit this parameter in earlier versions,
1588 and you may omit it in any version. If you require this
1589 parameter, the manifest key
1590 <a href="manifest.html#minimum_chrome_version">minimum_chrome_versio n</a>
1591 can ensure that your extension won't be run in an earlier browser ve rsion.
1592 </dd>
1593
1594 <!-- OBJECT PROPERTIES -->
1595 <dd style="display: none; ">
1596 <dl>
1597 <div>
1598 <div>
1599 </div>
1600 </div>
1601 </dl>
1602 </dd>
1603
1604 <!-- OBJECT METHODS -->
1605 <dd style="display: none; ">
1606 <div></div>
1607 </dd>
1608
1609 <!-- OBJECT EVENT FIELDS -->
1610 <dd style="display: none; ">
1611 <div></div>
1612 </dd>
1613
1614 <!-- FUNCTION PARAMETERS -->
1615 <dd style="display: none; ">
1616 <div></div>
1617 </dd>
1618
1619 </div>
1620 </div>
1621 </dl>
1622
1623 <!-- RETURNS -->
1624 <h4 style="display: none; ">Returns</h4>
1625 <dl>
1626 <div style="display: none; ">
1627 <div>
1628 </div>
1629 </div>
1630 </dl>
1631
1632 <!-- CALLBACK -->
1633 <div>
1634 <div>
1635 <h4>Callback function</h4>
1636 <p style="display: none; ">
1637 The callback <em>parameter</em> should specify a function
1638 that looks like this:
1639 </p>
1640 <p>
1641 If you specify the <em>callback</em> parameter, it should
1642 specify a function that looks like this:
1643 </p>
1644
1645 <!-- Note: intentionally longer 80 columns -->
1646 <pre>function(<span></span>) <span class="subdued">{...}</span >;</pre>
1647 <dl>
1648 <div style="display: none; ">
1649 <div>
1650 </div>
1651 </div>
1652 </dl>
1653 </div>
1654 </div>
1655
1656 <!-- MIN_VERSION -->
1657 <p style="display: none; ">
1658 This function was added in version <b><span></span></b>.
1659 If you require this function, the manifest key
1660 <a href="manifest.html#minimum_chrome_version">minimum_chrome_ version</a>
1661 can ensure that your extension won't be run in an earlier brow ser version.
1662 </p>
1663 </div> <!-- /description -->
1664
1665 </div> <!-- /apiItem -->
1666
1667 </div>
1668 </dd>
1669
1670 <!-- OBJECT EVENT FIELDS -->
1671 <dd>
1672 <div class="apiGroup" style="">
1673 <a name="global-Preference-events"></a>
1674 <h3>Events of Preference</h3>
1675 <!-- iterates over all events -->
1676 <div class="apiItem">
1677 <a name="event-Preference-onChange"></a>
1678 <h4>onChange</h4>
1679
1680 <div class="summary">
1681 <!-- Note: intentionally longer 80 columns -->
1682 <span class="subdued">preference.</span><span>onChange</span><sp an class="subdued">.addListener</span>(function(<span>object details</span>) <sp an class="subdued">{...}</span><span></span>));
1683 </div>
1684
1685 <div class="description">
1686 <p class="todo" style="display: none; ">Undocumented.</p>
1687 <p>Fired when the value of the preference changes.</p>
1688
1689 <!-- LISTENER PARAMETERS -->
1690 <div>
1691 <h4>Listener parameters</h4>
1692 <dl>
1693 <div>
1694 <div>
1695 <dt>
1696 <var>details</var>
1697 <em>
1698
1699 <!-- TYPE -->
1700 <div style="display:inline">
1701 (
1702 <span class="optional" style="display: none; ">optional</spa n>
1703 <span class="enum" style="display: none; ">enumerated</span>
1704 <span id="typeTemplate">
1705 <span style="display: none; ">
1706 <a> Type</a>
1707 </span>
1708 <span>
1709 <span style="display: none; ">
1710 array of <span><span></span></span>
1711 </span>
1712 <span>object</span>
1713 <span style="display: none; "></span>
1714 </span>
1715 </span>
1716 )
1717 </div>
1718
1719 </em>
1720 </dt>
1721 <dd class="todo">
1722 Undocumented.
1723 </dd>
1724 <dd style="display: none; ">
1725 Description of this parameter from the json schema.
1726 </dd>
1727 <dd style="display: none; ">
1728 This parameter was added in version
1729 <b><span></span></b>.
1730 You must omit this parameter in earlier versions,
1731 and you may omit it in any version. If you require this
1732 parameter, the manifest key
1733 <a href="manifest.html#minimum_chrome_version">minimum_chrome_versio n</a>
1734 can ensure that your extension won't be run in an earlier browser ve rsion.
1735 </dd>
1736
1737 <!-- OBJECT PROPERTIES -->
1738 <dd>
1739 <dl>
1740 <div>
1741 <div>
1742 <dt>
1743 <var>value</var>
1744 <em>
1745
1746 <!-- TYPE -->
1747 <div style="display:inline">
1748 (
1749 <span class="optional" style="display: none; ">optional</spa n>
1750 <span class="enum" style="display: none; ">enumerated</span>
1751 <span id="typeTemplate">
1752 <span style="display: none; ">
1753 <a> Type</a>
1754 </span>
1755 <span>
1756 <span style="display: none; ">
1757 array of <span><span></span></span>
1758 </span>
1759 <span>any</span>
1760 <span style="display: none; "></span>
1761 </span>
1762 </span>
1763 )
1764 </div>
1765
1766 </em>
1767 </dt>
1768 <dd class="todo" style="display: none; ">
1769 Undocumented.
1770 </dd>
1771 <dd>The value of the preference.</dd>
1772 <dd style="display: none; ">
1773 This parameter was added in version
1774 <b><span></span></b>.
1775 You must omit this parameter in earlier versions,
1776 and you may omit it in any version. If you require this
1777 parameter, the manifest key
1778 <a href="manifest.html#minimum_chrome_version">minimum_chrome_versio n</a>
1779 can ensure that your extension won't be run in an earlier browser ve rsion.
1780 </dd>
1781
1782 <!-- OBJECT PROPERTIES -->
1783 <dd style="display: none; ">
1784 <dl>
1785 <div>
1786 <div>
1787 </div>
1788 </div>
1789 </dl>
1790 </dd>
1791
1792 <!-- OBJECT METHODS -->
1793 <dd style="display: none; ">
1794 <div></div>
1795 </dd>
1796
1797 <!-- OBJECT EVENT FIELDS -->
1798 <dd style="display: none; ">
1799 <div></div>
1800 </dd>
1801
1802 <!-- FUNCTION PARAMETERS -->
1803 <dd style="display: none; ">
1804 <div></div>
1805 </dd>
1806
1807 </div>
1808 </div><div>
1809 <div>
1810 <dt>
1811 <var>levelOfControl</var>
1812 <em>
1813
1814 <!-- TYPE -->
1815 <div style="display:inline">
1816 (
1817 <span class="optional" style="display: none; ">optional</spa n>
1818 <span class="enum">enumerated</span>
1819 <span id="typeTemplate">
1820 <span style="display: none; ">
1821 <a> Type</a>
1822 </span>
1823 <span>
1824 <span style="display: none; ">
1825 array of <span><span></span></span>
1826 </span>
1827 <span>string</span>
1828 <span>["NotControllable", "ControlledByOtherExtensions", "ControllableByThisExtension", "ControlledByThisExtension"]</span>
1829 </span>
1830 </span>
1831 )
1832 </div>
1833
1834 </em>
1835 </dt>
1836 <dd class="todo" style="display: none; ">
1837 Undocumented.
1838 </dd>
1839 <dd>One of<br><var>NotControllable</var>: cannot be controlled by any extension<br><var>ControlledByOtherExtensions</var>: controlled by extensions wi th higher precedence<br><var>ControllableByThisExtension</var>: can be controlle d by this extension<br><var>ControlledByThisExtension</var>: controlled by this extension</dd>
1840 <dd style="display: none; ">
1841 This parameter was added in version
1842 <b><span></span></b>.
1843 You must omit this parameter in earlier versions,
1844 and you may omit it in any version. If you require this
1845 parameter, the manifest key
1846 <a href="manifest.html#minimum_chrome_version">minimum_chrome_versio n</a>
1847 can ensure that your extension won't be run in an earlier browser ve rsion.
1848 </dd>
1849
1850 <!-- OBJECT PROPERTIES -->
1851 <dd style="display: none; ">
1852 <dl>
1853 <div>
1854 <div>
1855 </div>
1856 </div>
1857 </dl>
1858 </dd>
1859
1860 <!-- OBJECT METHODS -->
1861 <dd style="display: none; ">
1862 <div></div>
1863 </dd>
1864
1865 <!-- OBJECT EVENT FIELDS -->
1866 <dd style="display: none; ">
1867 <div></div>
1868 </dd>
1869
1870 <!-- FUNCTION PARAMETERS -->
1871 <dd style="display: none; ">
1872 <div></div>
1873 </dd>
1874
1875 </div>
1876 </div><div>
1877 <div>
1878 <dt>
1879 <var>incognitoSpecific</var>
1880 <em>
1881
1882 <!-- TYPE -->
1883 <div style="display:inline">
1884 (
1885 <span class="optional">optional</span>
1886 <span class="enum" style="display: none; ">enumerated</span>
1887 <span id="typeTemplate">
1888 <span style="display: none; ">
1889 <a> Type</a>
1890 </span>
1891 <span>
1892 <span style="display: none; ">
1893 array of <span><span></span></span>
1894 </span>
1895 <span>boolean</span>
1896 <span style="display: none; "></span>
1897 </span>
1898 </span>
1899 )
1900 </div>
1901
1902 </em>
1903 </dt>
1904 <dd class="todo" style="display: none; ">
1905 Undocumented.
1906 </dd>
1907 <dd>Whether the value that has changed is specific to the incognito se ssion.<br>This property will <em>only</em> be present if the user has enabled th e extension in incognito mode.</dd>
1908 <dd style="display: none; ">
1909 This parameter was added in version
1910 <b><span></span></b>.
1911 You must omit this parameter in earlier versions,
1912 and you may omit it in any version. If you require this
1913 parameter, the manifest key
1914 <a href="manifest.html#minimum_chrome_version">minimum_chrome_versio n</a>
1915 can ensure that your extension won't be run in an earlier browser ve rsion.
1916 </dd>
1917
1918 <!-- OBJECT PROPERTIES -->
1919 <dd style="display: none; ">
1920 <dl>
1921 <div>
1922 <div>
1923 </div>
1924 </div>
1925 </dl>
1926 </dd>
1927
1928 <!-- OBJECT METHODS -->
1929 <dd style="display: none; ">
1930 <div></div>
1931 </dd>
1932
1933 <!-- OBJECT EVENT FIELDS -->
1934 <dd style="display: none; ">
1935 <div></div>
1936 </dd>
1937
1938 <!-- FUNCTION PARAMETERS -->
1939 <dd style="display: none; ">
1940 <div></div>
1941 </dd>
1942
1943 </div>
1944 </div>
1945 </dl>
1946 </dd>
1947
1948 <!-- OBJECT METHODS -->
1949 <dd style="display: none; ">
1950 <div></div>
1951 </dd>
1952
1953 <!-- OBJECT EVENT FIELDS -->
1954 <dd style="display: none; ">
1955 <div></div>
1956 </dd>
1957
1958 <!-- FUNCTION PARAMETERS -->
1959 <dd style="display: none; ">
1960 <div></div>
1961 </dd>
1962
1963 </div>
1964 </div>
1965 </dl>
1966 </div>
1967
1968 <!-- EXTRA PARAMETERS -->
1969 <div style="display: none; ">
1970 <h4>Extra parameters to addListener</h4>
1971 <dl>
1972 <div>
1973 <div>
1974 </div>
1975 </div>
1976 </dl>
1977 </div>
1978
1979 <!-- LISTENER RETURN VALUE -->
1980 <h4 style="display: none; ">Listener returns</h4>
1981 <dl>
1982 <div style="display: none; ">
1983 <div>
1984 </div>
1985 </div>
1986 </dl>
1987
1988 </div> <!-- /description -->
1989 </div> <!-- /apiItem -->
1990
1991 </div>
1992 </dd>
1993
1994 <!-- FUNCTION PARAMETERS -->
1995 <dd style="display: none; ">
1996 <div></div>
1997 </dd>
1998
1999 </div>
2000
2001 </div> <!-- /apiItem -->
2002
2003 </div> <!-- /apiGroup -->
2004
2005 </div> <!-- /apiPage -->
2006 </div> <!-- /gc-pagecontent -->
2007 </div> <!-- /g-section -->
2008 </div> <!-- /codesiteContent -->
2009 <div id="gc-footer" --="">
2010 <div class="text">
2011 <p>
2012 Except as otherwise <a href="http://code.google.com/policies.html#restrictions ">noted</a>,
2013 the content of this page is licensed under the <a rel="license" href="http://c reativecommons.org/licenses/by/3.0/">Creative Commons
2014 Attribution 3.0 License</a>, and code samples are licensed under the
2015 <a rel="license" href="http://code.google.com/google_bsd_license.html">BSD Lic ense</a>.
2016 </p>
2017 <p>
2018 ©2011 Google
2019 </p>
2020
2021 <!-- begin analytics -->
2022 <script src="http://www.google-analytics.com/urchin.js" type="text/javascript">< /script>
2023 <script src="http://www.google-analytics.com/ga.js" type="text/javascript"></scr ipt>
2024
2025 <script type="text/javascript">
2026 // chrome doc tracking
2027 try {
2028 var engdocs = _gat._getTracker("YT-10763712-2");
2029 engdocs._trackPageview();
2030 } catch(err) {}
2031
2032 // code.google.com site-wide tracking
2033 try {
2034 _uacct="UA-18071-1";
2035 _uanchor=1;
2036 _uff=0;
2037 urchinTracker();
2038 }
2039 catch(e) {/* urchinTracker not available. */}
2040 </script>
2041 <!-- end analytics -->
2042 </div>
2043 </div> <!-- /gc-footer -->
2044 </div> <!-- /gc-container -->
2045 </body></html>
OLDNEW
« no previous file with comments | « chrome/common/extensions/docs/experimental.contentSettings.misc.html ('k') | chrome/common/extensions/docs/experimental.proxy.html » ('j') | no next file with comments »

Powered by Google App Engine
This is Rietveld 408576698