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

Issues Search
    My Issues | Starred     Open | Closed | All

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

Issue 6480033: Implement experimental.contentSettings.misc.blockThirdPartyCookies. (Closed) Base URL: svn://svn.chromium.org/chrome/trunk/src
Patch Set: comments Created 9 years, 10 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/extension.h » ('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>);
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 <!-- PARAMETERS -->
437 <div>
438 <h4>Parameters</h4>
439 <dl>
440 <div>
441 <div>
442 </div>
443 </div>
444 </dl>
445 </div>
446 </div> <!-- /decription -->
447
448 </div> <!-- /apiItem -->
449
450 </div> <!-- /apiGroup -->
451
452 <!-- TYPES -->
453 <div class="apiGroup">
454 <a name="types"></a>
455 <h3 id="types">Types</h3>
456
457 <!-- iterates over all types -->
458 <div class="apiItem">
459 <a name="type-Preference"></a>
460 <h4>Preference</h4>
461
462 <div>
463 <dt>
464 <var style="display: none; ">paramName</var>
465 <em>
466
467 <!-- TYPE -->
468 <div style="display:inline">
469 (
470 <span class="optional" style="display: none; ">optional</spa n>
471 <span class="enum" style="display: none; ">enumerated</span>
472 <span id="typeTemplate">
473 <span style="display: none; ">
474 <a> Type</a>
475 </span>
476 <span>
477 <span style="display: none; ">
478 array of <span><span></span></span>
479 </span>
480 <span>object</span>
481 <span style="display: none; "></span>
482 </span>
483 </span>
484 )
485 </div>
486
487 </em>
488 </dt>
489 <dd class="todo" style="display: none; ">
490 Undocumented.
491 </dd>
492 <dd>An object which allows access to a preference.</dd>
493 <dd style="display: none; ">
494 This parameter was added in version
495 <b><span></span></b>.
496 You must omit this parameter in earlier versions,
497 and you may omit it in any version. If you require this
498 parameter, the manifest key
499 <a href="manifest.html#minimum_chrome_version">minimum_chrome_versio n</a>
500 can ensure that your extension won't be run in an earlier browser ve rsion.
501 </dd>
502
503 <!-- OBJECT PROPERTIES -->
504 <dd style="display: none; ">
505 <dl>
506 <div>
507 <div>
508 </div>
509 </div>
510 </dl>
511 </dd>
512
513 <!-- OBJECT METHODS -->
514 <dd>
515 <div class="apiGroup" style="">
516 <a name="global-Preference-methods"></a>
517 <h3>Methods of Preference</h3>
518
519 <!-- iterates over all functions -->
520 <div class="apiItem">
521 <a name="method-Preference-get"></a> <!-- method-anchor -->
522 <h4>get</h4>
523
524 <div class="summary"><span style="display: none; ">void</span>
525 <!-- Note: intentionally longer 80 columns -->
526 <span>preference.get</span>(<span class="null"><span style="di splay: none; ">, </span><span>object</span>
527 <var><span>details</span></var></span><span class="null">< span>, </span><span>function</span>
528 <var><span>callback</span></var></span>)</div>
529
530 <div class="description">
531 <p class="todo" style="display: none; ">Undocumented.</p>
532 <p>Get the setting from the user preferences.</p>
533
534 <!-- PARAMETERS -->
535 <h4>Parameters</h4>
536 <dl>
537 <div>
538 <div>
539 <dt>
540 <var>details</var>
541 <em>
542
543 <!-- TYPE -->
544 <div style="display:inline">
545 (
546 <span class="optional" style="display: none; ">optional</spa n>
547 <span class="enum" style="display: none; ">enumerated</span>
548 <span id="typeTemplate">
549 <span style="display: none; ">
550 <a> Type</a>
551 </span>
552 <span>
553 <span style="display: none; ">
554 array of <span><span></span></span>
555 </span>
556 <span>object</span>
557 <span style="display: none; "></span>
558 </span>
559 </span>
560 )
561 </div>
562
563 </em>
564 </dt>
565 <dd class="todo" style="display: none; ">
566 Undocumented.
567 </dd>
568 <dd>What setting to return.</dd>
569 <dd style="display: none; ">
570 This parameter was added in version
571 <b><span></span></b>.
572 You must omit this parameter in earlier versions,
573 and you may omit it in any version. If you require this
574 parameter, the manifest key
575 <a href="manifest.html#minimum_chrome_version">minimum_chrome_versio n</a>
576 can ensure that your extension won't be run in an earlier browser ve rsion.
577 </dd>
578
579 <!-- OBJECT PROPERTIES -->
580 <dd>
581 <dl>
582 <div>
583 <div>
584 <dt>
585 <var>incognito</var>
586 <em>
587
588 <!-- TYPE -->
589 <div style="display:inline">
590 (
591 <span class="optional">optional</span>
592 <span class="enum" style="display: none; ">enumerated</span>
593 <span id="typeTemplate">
594 <span style="display: none; ">
595 <a> Type</a>
596 </span>
597 <span>
598 <span style="display: none; ">
599 array of <span><span></span></span>
600 </span>
601 <span>boolean</span>
602 <span style="display: none; "></span>
603 </span>
604 </span>
605 )
606 </div>
607
608 </em>
609 </dt>
610 <dd class="todo" style="display: none; ">
611 Undocumented.
612 </dd>
613 <dd>Whether to return the setting that applies to the incognito sessio n only (default false).</dd>
614 <dd style="display: none; ">
615 This parameter was added in version
616 <b><span></span></b>.
617 You must omit this parameter in earlier versions,
618 and you may omit it in any version. If you require this
619 parameter, the manifest key
620 <a href="manifest.html#minimum_chrome_version">minimum_chrome_versio n</a>
621 can ensure that your extension won't be run in an earlier browser ve rsion.
622 </dd>
623
624 <!-- OBJECT PROPERTIES -->
625 <dd style="display: none; ">
626 <dl>
627 <div>
628 <div>
629 </div>
630 </div>
631 </dl>
632 </dd>
633
634 <!-- OBJECT METHODS -->
635 <dd style="display: none; ">
636 <div></div>
637 </dd>
638
639 <!-- OBJECT EVENT FIELDS -->
640 <dd style="display: none; ">
641 <div></div>
642 </dd>
643
644 <!-- FUNCTION PARAMETERS -->
645 <dd style="display: none; ">
646 <div></div>
647 </dd>
648
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><div>
671 <div>
672 <dt>
673 <var>callback</var>
674 <em>
675
676 <!-- TYPE -->
677 <div style="display:inline">
678 (
679 <span class="optional" style="display: none; ">optional</spa n>
680 <span class="enum" style="display: none; ">enumerated</span>
681 <span id="typeTemplate">
682 <span style="display: none; ">
683 <a> Type</a>
684 </span>
685 <span>
686 <span style="display: none; ">
687 array of <span><span></span></span>
688 </span>
689 <span>function</span>
690 <span style="display: none; "></span>
691 </span>
692 </span>
693 )
694 </div>
695
696 </em>
697 </dt>
698 <dd class="todo">
699 Undocumented.
700 </dd>
701 <dd style="display: none; ">
702 Description of this parameter from the json schema.
703 </dd>
704 <dd style="display: none; ">
705 This parameter was added in version
706 <b><span></span></b>.
707 You must omit this parameter in earlier versions,
708 and you may omit it in any version. If you require this
709 parameter, the manifest key
710 <a href="manifest.html#minimum_chrome_version">minimum_chrome_versio n</a>
711 can ensure that your extension won't be run in an earlier browser ve rsion.
712 </dd>
713
714 <!-- OBJECT PROPERTIES -->
715 <dd style="display: none; ">
716 <dl>
717 <div>
718 <div>
719 </div>
720 </div>
721 </dl>
722 </dd>
723
724 <!-- OBJECT METHODS -->
725 <dd style="display: none; ">
726 <div></div>
727 </dd>
728
729 <!-- OBJECT EVENT FIELDS -->
730 <dd style="display: none; ">
731 <div></div>
732 </dd>
733
734 <!-- FUNCTION PARAMETERS -->
735 <dd style="display: none; ">
736 <div></div>
737 </dd>
738
739 </div>
740 </div>
741 </dl>
742
743 <!-- RETURNS -->
744 <h4 style="display: none; ">Returns</h4>
745 <dl>
746 <div style="display: none; ">
747 <div>
748 </div>
749 </div>
750 </dl>
751
752 <!-- CALLBACK -->
753 <div>
754 <div>
755 <h4>Callback function</h4>
756 <p>
757 The callback <em>parameter</em> should specify a function
758 that looks like this:
759 </p>
760 <p style="display: none; ">
761 If you specify the <em>callback</em> parameter, it should
762 specify a function that looks like this:
763 </p>
764
765 <!-- Note: intentionally longer 80 columns -->
766 <pre>function(<span>any value</span>) <span class="subdued">{. ..}</span>;</pre>
767 <dl>
768 <div>
769 <div>
770 <dt>
771 <var>value</var>
772 <em>
773
774 <!-- TYPE -->
775 <div style="display:inline">
776 (
777 <span class="optional" style="display: none; ">optional</spa n>
778 <span class="enum" style="display: none; ">enumerated</span>
779 <span id="typeTemplate">
780 <span style="display: none; ">
781 <a> Type</a>
782 </span>
783 <span>
784 <span style="display: none; ">
785 array of <span><span></span></span>
786 </span>
787 <span>any</span>
788 <span style="display: none; "></span>
789 </span>
790 </span>
791 )
792 </div>
793
794 </em>
795 </dt>
796 <dd class="todo" style="display: none; ">
797 Undocumented.
798 </dd>
799 <dd>The value of the preference.</dd>
800 <dd style="display: none; ">
801 This parameter was added in version
802 <b><span></span></b>.
803 You must omit this parameter in earlier versions,
804 and you may omit it in any version. If you require this
805 parameter, the manifest key
806 <a href="manifest.html#minimum_chrome_version">minimum_chrome_versio n</a>
807 can ensure that your extension won't be run in an earlier browser ve rsion.
808 </dd>
809
810 <!-- OBJECT PROPERTIES -->
811 <dd style="display: none; ">
812 <dl>
813 <div>
814 <div>
815 </div>
816 </div>
817 </dl>
818 </dd>
819
820 <!-- OBJECT METHODS -->
821 <dd style="display: none; ">
822 <div></div>
823 </dd>
824
825 <!-- OBJECT EVENT FIELDS -->
826 <dd style="display: none; ">
827 <div></div>
828 </dd>
829
830 <!-- FUNCTION PARAMETERS -->
831 <dd style="display: none; ">
832 <div></div>
833 </dd>
834
835 </div>
836 </div>
837 </dl>
838 </div>
839 </div>
840
841 <!-- MIN_VERSION -->
842 <p style="display: none; ">
843 This function was added in version <b><span></span></b>.
844 If you require this function, the manifest key
845 <a href="manifest.html#minimum_chrome_version">minimum_chrome_ version</a>
846 can ensure that your extension won't be run in an earlier brow ser version.
847 </p>
848 </div> <!-- /description -->
849
850 </div><div class="apiItem">
851 <a name="method-Preference-set"></a> <!-- method-anchor -->
852 <h4>set</h4>
853
854 <div class="summary"><span style="display: none; ">void</span>
855 <!-- Note: intentionally longer 80 columns -->
856 <span>preference.set</span>(<span class="null"><span style="di splay: none; ">, </span><span>object</span>
857 <var><span>details</span></var></span><span class="optiona l"><span>, </span><span>function</span>
858 <var><span>callback</span></var></span>)</div>
859
860 <div class="description">
861 <p class="todo" style="display: none; ">Undocumented.</p>
862 <p>Set the setting in the user preferences</p>
863
864 <!-- PARAMETERS -->
865 <h4>Parameters</h4>
866 <dl>
867 <div>
868 <div>
869 <dt>
870 <var>details</var>
871 <em>
872
873 <!-- TYPE -->
874 <div style="display:inline">
875 (
876 <span class="optional" style="display: none; ">optional</spa n>
877 <span class="enum" style="display: none; ">enumerated</span>
878 <span id="typeTemplate">
879 <span style="display: none; ">
880 <a> Type</a>
881 </span>
882 <span>
883 <span style="display: none; ">
884 array of <span><span></span></span>
885 </span>
886 <span>object</span>
887 <span style="display: none; "></span>
888 </span>
889 </span>
890 )
891 </div>
892
893 </em>
894 </dt>
895 <dd class="todo" style="display: none; ">
896 Undocumented.
897 </dd>
898 <dd>What setting to change.</dd>
899 <dd style="display: none; ">
900 This parameter was added in version
901 <b><span></span></b>.
902 You must omit this parameter in earlier versions,
903 and you may omit it in any version. If you require this
904 parameter, the manifest key
905 <a href="manifest.html#minimum_chrome_version">minimum_chrome_versio n</a>
906 can ensure that your extension won't be run in an earlier browser ve rsion.
907 </dd>
908
909 <!-- OBJECT PROPERTIES -->
910 <dd>
911 <dl>
912 <div>
913 <div>
914 <dt>
915 <var>value</var>
916 <em>
917
918 <!-- TYPE -->
919 <div style="display:inline">
920 (
921 <span class="optional" style="display: none; ">optional</spa n>
922 <span class="enum" style="display: none; ">enumerated</span>
923 <span id="typeTemplate">
924 <span style="display: none; ">
925 <a> Type</a>
926 </span>
927 <span>
928 <span style="display: none; ">
929 array of <span><span></span></span>
930 </span>
931 <span>any</span>
932 <span style="display: none; "></span>
933 </span>
934 </span>
935 )
936 </div>
937
938 </em>
939 </dt>
940 <dd class="todo" style="display: none; ">
941 Undocumented.
942 </dd>
943 <dd>The value of the preference.</dd>
944 <dd style="display: none; ">
945 This parameter was added in version
946 <b><span></span></b>.
947 You must omit this parameter in earlier versions,
948 and you may omit it in any version. If you require this
949 parameter, the manifest key
950 <a href="manifest.html#minimum_chrome_version">minimum_chrome_versio n</a>
951 can ensure that your extension won't be run in an earlier browser ve rsion.
952 </dd>
953
954 <!-- OBJECT PROPERTIES -->
955 <dd style="display: none; ">
956 <dl>
957 <div>
958 <div>
959 </div>
960 </div>
961 </dl>
962 </dd>
963
964 <!-- OBJECT METHODS -->
965 <dd style="display: none; ">
966 <div></div>
967 </dd>
968
969 <!-- OBJECT EVENT FIELDS -->
970 <dd style="display: none; ">
971 <div></div>
972 </dd>
973
974 <!-- FUNCTION PARAMETERS -->
975 <dd style="display: none; ">
976 <div></div>
977 </dd>
978
979 </div>
980 </div><div>
981 <div>
982 <dt>
983 <var>incognito</var>
984 <em>
985
986 <!-- TYPE -->
987 <div style="display:inline">
988 (
989 <span class="optional">optional</span>
990 <span class="enum" style="display: none; ">enumerated</span>
991 <span id="typeTemplate">
992 <span style="display: none; ">
993 <a> Type</a>
994 </span>
995 <span>
996 <span style="display: none; ">
997 array of <span><span></span></span>
998 </span>
999 <span>boolean</span>
1000 <span style="display: none; "></span>
1001 </span>
1002 </span>
1003 )
1004 </div>
1005
1006 </em>
1007 </dt>
1008 <dd class="todo" style="display: none; ">
1009 Undocumented.
1010 </dd>
1011 <dd>Whether to modify the setting for the incognito session only (defa ult false).</dd>
1012 <dd style="display: none; ">
1013 This parameter was added in version
1014 <b><span></span></b>.
1015 You must omit this parameter in earlier versions,
1016 and you may omit it in any version. If you require this
1017 parameter, the manifest key
1018 <a href="manifest.html#minimum_chrome_version">minimum_chrome_versio n</a>
1019 can ensure that your extension won't be run in an earlier browser ve rsion.
1020 </dd>
1021
1022 <!-- OBJECT PROPERTIES -->
1023 <dd style="display: none; ">
1024 <dl>
1025 <div>
1026 <div>
1027 </div>
1028 </div>
1029 </dl>
1030 </dd>
1031
1032 <!-- OBJECT METHODS -->
1033 <dd style="display: none; ">
1034 <div></div>
1035 </dd>
1036
1037 <!-- OBJECT EVENT FIELDS -->
1038 <dd style="display: none; ">
1039 <div></div>
1040 </dd>
1041
1042 <!-- FUNCTION PARAMETERS -->
1043 <dd style="display: none; ">
1044 <div></div>
1045 </dd>
1046
1047 </div>
1048 </div>
1049 </dl>
1050 </dd>
1051
1052 <!-- OBJECT METHODS -->
1053 <dd style="display: none; ">
1054 <div></div>
1055 </dd>
1056
1057 <!-- OBJECT EVENT FIELDS -->
1058 <dd style="display: none; ">
1059 <div></div>
1060 </dd>
1061
1062 <!-- FUNCTION PARAMETERS -->
1063 <dd style="display: none; ">
1064 <div></div>
1065 </dd>
1066
1067 </div>
1068 </div><div>
1069 <div>
1070 <dt>
1071 <var>callback</var>
1072 <em>
1073
1074 <!-- TYPE -->
1075 <div style="display:inline">
1076 (
1077 <span class="optional">optional</span>
1078 <span class="enum" style="display: none; ">enumerated</span>
1079 <span id="typeTemplate">
1080 <span style="display: none; ">
1081 <a> Type</a>
1082 </span>
1083 <span>
1084 <span style="display: none; ">
1085 array of <span><span></span></span>
1086 </span>
1087 <span>function</span>
1088 <span style="display: none; "></span>
1089 </span>
1090 </span>
1091 )
1092 </div>
1093
1094 </em>
1095 </dt>
1096 <dd class="todo" style="display: none; ">
1097 Undocumented.
1098 </dd>
1099 <dd>Called after the preference has been set.</dd>
1100 <dd style="display: none; ">
1101 This parameter was added in version
1102 <b><span></span></b>.
1103 You must omit this parameter in earlier versions,
1104 and you may omit it in any version. If you require this
1105 parameter, the manifest key
1106 <a href="manifest.html#minimum_chrome_version">minimum_chrome_versio n</a>
1107 can ensure that your extension won't be run in an earlier browser ve rsion.
1108 </dd>
1109
1110 <!-- OBJECT PROPERTIES -->
1111 <dd style="display: none; ">
1112 <dl>
1113 <div>
1114 <div>
1115 </div>
1116 </div>
1117 </dl>
1118 </dd>
1119
1120 <!-- OBJECT METHODS -->
1121 <dd style="display: none; ">
1122 <div></div>
1123 </dd>
1124
1125 <!-- OBJECT EVENT FIELDS -->
1126 <dd style="display: none; ">
1127 <div></div>
1128 </dd>
1129
1130 <!-- FUNCTION PARAMETERS -->
1131 <dd style="display: none; ">
1132 <div></div>
1133 </dd>
1134
1135 </div>
1136 </div>
1137 </dl>
1138
1139 <!-- RETURNS -->
1140 <h4 style="display: none; ">Returns</h4>
1141 <dl>
1142 <div style="display: none; ">
1143 <div>
1144 </div>
1145 </div>
1146 </dl>
1147
1148 <!-- CALLBACK -->
1149 <div>
1150 <div>
1151 <h4>Callback function</h4>
1152 <p style="display: none; ">
1153 The callback <em>parameter</em> should specify a function
1154 that looks like this:
1155 </p>
1156 <p>
1157 If you specify the <em>callback</em> parameter, it should
1158 specify a function that looks like this:
1159 </p>
1160
1161 <!-- Note: intentionally longer 80 columns -->
1162 <pre>function(<span></span>) <span class="subdued">{...}</span >;</pre>
1163 <dl>
1164 <div style="display: none; ">
1165 <div>
1166 </div>
1167 </div>
1168 </dl>
1169 </div>
1170 </div>
1171
1172 <!-- MIN_VERSION -->
1173 <p style="display: none; ">
1174 This function was added in version <b><span></span></b>.
1175 If you require this function, the manifest key
1176 <a href="manifest.html#minimum_chrome_version">minimum_chrome_ version</a>
1177 can ensure that your extension won't be run in an earlier brow ser version.
1178 </p>
1179 </div> <!-- /description -->
1180
1181 </div> <!-- /apiItem -->
1182
1183 </div>
1184 </dd>
1185
1186 <!-- OBJECT EVENT FIELDS -->
1187 <dd style="display: none; ">
1188 <div></div>
1189 </dd>
1190
1191 <!-- FUNCTION PARAMETERS -->
1192 <dd style="display: none; ">
1193 <div></div>
1194 </dd>
1195
1196 </div>
1197
1198 </div> <!-- /apiItem -->
1199
1200 </div> <!-- /apiGroup -->
1201
1202 </div> <!-- /apiPage -->
1203 </div> <!-- /gc-pagecontent -->
1204 </div> <!-- /g-section -->
1205 </div> <!-- /codesiteContent -->
1206 <div id="gc-footer" --="">
1207 <div class="text">
1208 <p>
1209 Except as otherwise <a href="http://code.google.com/policies.html#restrictions ">noted</a>,
1210 the content of this page is licensed under the <a rel="license" href="http://c reativecommons.org/licenses/by/3.0/">Creative Commons
1211 Attribution 3.0 License</a>, and code samples are licensed under the
1212 <a rel="license" href="http://code.google.com/google_bsd_license.html">BSD Lic ense</a>.
1213 </p>
1214 <p>
1215 ©2011 Google
1216 </p>
1217
1218 <!-- begin analytics -->
1219 <script src="http://www.google-analytics.com/urchin.js" type="text/javascript">< /script>
1220 <script src="http://www.google-analytics.com/ga.js" type="text/javascript"></scr ipt>
1221
1222 <script type="text/javascript">
1223 // chrome doc tracking
1224 try {
1225 var engdocs = _gat._getTracker("YT-10763712-2");
1226 engdocs._trackPageview();
1227 } catch(err) {}
1228
1229 // code.google.com site-wide tracking
1230 try {
1231 _uacct="UA-18071-1";
1232 _uanchor=1;
1233 _uff=0;
1234 urchinTracker();
1235 }
1236 catch(e) {/* urchinTracker not available. */}
1237 </script>
1238 <!-- end analytics -->
1239 </div>
1240 </div> <!-- /gc-footer -->
1241 </div> <!-- /gc-container -->
1242 </body></html>
OLDNEW
« no previous file with comments | « chrome/common/extensions/docs/experimental.contentSettings.misc.html ('k') | chrome/common/extensions/extension.h » ('j') | no next file with comments »

Powered by Google App Engine
This is Rietveld 408576698