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

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

Issue 7189029: Implement an initial extension settings API. (Closed) Base URL: http://git.chromium.org/git/chromium.git@trunk
Patch Set: Make clang happy Created 9 years, 4 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
(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.settings - 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.settings</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.setti ngs</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>
280 <a href="#global-methods">Methods</a>
281 <ol>
282 <li>
283 <a href="#method-clear">clear</a>
284 </li><li>
285 <a href="#method-get">get</a>
286 </li><li>
287 <a href="#method-remove">remove</a>
288 </li><li>
289 <a href="#method-set">set</a>
290 </li>
291 </ol>
292 </li>
293 <li style="display: none; ">
294 <a>Events</a>
295 <ol>
296 <li>
297 <a href="#event-anchor">eventName</a>
298 </li>
299 </ol>
300 </li>
301 <li style="display: none; ">
302 <a href="#types">Types</a>
303 <ol>
304 <li>
305 <a href="#id-anchor">id</a>
306 </li>
307 </ol>
308 </li>
309 </ol>
310 </li>
311 </ol>
312 </div>
313 <!-- /TABLE OF CONTENTS -->
314
315 <!-- Standard content lead-in for experimental API pages -->
316 <p id="classSummary">
317 For information on how to use experimental APIs, see the <a href="expe rimental.html">chrome.experimental.* APIs</a> page.
318 </p>
319
320 <!-- STATIC CONTENT PLACEHOLDER -->
321 <div id="static"></div>
322
323 <!-- API PAGE -->
324 <div class="apiPage">
325 <a name="apiReference"></a>
326 <h2>API reference: chrome.experimental.settings</h2>
327
328 <!-- PROPERTIES -->
329 <div class="apiGroup" style="display: none; ">
330 <a name="properties"></a>
331 <h3 id="properties">Properties</h3>
332
333 <div>
334 <a></a>
335 <h4>getLastError</h4>
336 <div class="summary">
337 <!-- Note: intentionally longer 80 columns -->
338 <span>chrome.extension</span><span>lastError</span>
339 </div>
340 <div>
341 </div>
342 </div>
343
344 </div> <!-- /apiGroup -->
345
346 <!-- METHODS -->
347 <div id="methodsTemplate" class="apiGroup">
348 <a name="global-methods"></a>
349 <h3>Methods</h3>
350
351 <!-- iterates over all functions -->
352 <div class="apiItem">
353 <a name="method-clear"></a> <!-- method-anchor -->
354 <h4>clear</h4>
355
356 <div class="summary"><span style="display: none; ">void</span>
357 <!-- Note: intentionally longer 80 columns -->
358 <span>chrome.experimental.settings.clear</span>(<span class="o ptional"><span style="display: none; ">, </span><span>function</span>
359 <var><span>callback</span></var></span>)</div>
360
361 <div class="description">
362 <p class="todo" style="display: none; ">Undocumented.</p>
363 <p>Removes all values from settings.</p>
364
365 <!-- PARAMETERS -->
366 <h4>Parameters</h4>
367 <dl>
368 <div>
369 <div>
370 <dt>
371 <var>callback</var>
372 <em>
373
374 <!-- TYPE -->
375 <div style="display:inline">
376 (
377 <span class="optional">optional</span>
378 <span class="enum" style="display: none; ">enumerated</span>
379 <span id="typeTemplate">
380 <span style="display: none; ">
381 <a> Type</a>
382 </span>
383 <span>
384 <span style="display: none; ">
385 array of <span><span></span></span>
386 </span>
387 <span>function</span>
388 <span style="display: none; "></span>
389 </span>
390 </span>
391 )
392 </div>
393
394 </em>
395 </dt>
396 <dd class="todo" style="display: none; ">
397 Undocumented.
398 </dd>
399 <dd>Callback on success, or on failure (in which case lastError will b e set).</dd>
400 <dd style="display: none; ">
401 This parameter was added in version
402 <b><span></span></b>.
403 You must omit this parameter in earlier versions,
404 and you may omit it in any version. If you require this
405 parameter, the manifest key
406 <a href="manifest.html#minimum_chrome_version">minimum_chrome_versio n</a>
407 can ensure that your extension won't be run in an earlier browser ve rsion.
408 </dd>
409
410 <!-- OBJECT PROPERTIES -->
411 <dd style="display: none; ">
412 <dl>
413 <div>
414 <div>
415 </div>
416 </div>
417 </dl>
418 </dd>
419
420 <!-- OBJECT METHODS -->
421 <dd style="display: none; ">
422 <div></div>
423 </dd>
424
425 <!-- OBJECT EVENT FIELDS -->
426 <dd style="display: none; ">
427 <div></div>
428 </dd>
429
430 <!-- FUNCTION PARAMETERS -->
431 <dd style="display: none; ">
432 <div></div>
433 </dd>
434
435 </div>
436 </div>
437 </dl>
438
439 <!-- RETURNS -->
440 <h4 style="display: none; ">Returns</h4>
441 <dl>
442 <div style="display: none; ">
443 <div>
444 </div>
445 </div>
446 </dl>
447
448 <!-- CALLBACK -->
449 <div>
450 <div>
451 <h4>Callback function</h4>
452 <p style="display: none; ">
453 The callback <em>parameter</em> should specify a function
454 that looks like this:
455 </p>
456 <p>
457 If you specify the <em>callback</em> parameter, it should
458 specify a function that looks like this:
459 </p>
460
461 <!-- Note: intentionally longer 80 columns -->
462 <pre>function(<span></span>) <span class="subdued">{...}</span >;</pre>
463 <dl>
464 <div style="display: none; ">
465 <div>
466 </div>
467 </div>
468 </dl>
469 </div>
470 </div>
471
472 <!-- MIN_VERSION -->
473 <p style="display: none; ">
474 This function was added in version <b><span></span></b>.
475 If you require this function, the manifest key
476 <a href="manifest.html#minimum_chrome_version">minimum_chrome_ version</a>
477 can ensure that your extension won't be run in an earlier brow ser version.
478 </p>
479 </div> <!-- /description -->
480
481 </div><div class="apiItem">
482 <a name="method-get"></a> <!-- method-anchor -->
483 <h4>get</h4>
484
485 <div class="summary"><span style="display: none; ">void</span>
486 <!-- Note: intentionally longer 80 columns -->
487 <span>chrome.experimental.settings.get</span>(<span class="opt ional"><span style="display: none; ">, </span><span>string or array of string</s pan>
488 <var><span>keys</span></var></span><span class="null"><spa n>, </span><span>function</span>
489 <var><span>callback</span></var></span>)</div>
490
491 <div class="description">
492 <p class="todo" style="display: none; ">Undocumented.</p>
493 <p>Gets one or more values from settings.</p>
494
495 <!-- PARAMETERS -->
496 <h4>Parameters</h4>
497 <dl>
498 <div>
499 <div>
500 <dt>
501 <var>keys</var>
502 <em>
503
504 <!-- TYPE -->
505 <div style="display:inline">
506 (
507 <span class="optional">optional</span>
508 <span class="enum" style="display: none; ">enumerated</span>
509 <span id="typeTemplate">
510 <span style="display: none; ">
511 <a> Type</a>
512 </span>
513 <span>
514 <span style="display: none; ">
515 array of <span><span></span></span>
516 </span>
517 <span>string or array of string</span>
518 <span style="display: none; "></span>
519 </span>
520 </span>
521 )
522 </div>
523
524 </em>
525 </dt>
526 <dd class="todo" style="display: none; ">
527 Undocumented.
528 </dd>
529 <dd>A single key or a list of keys to get from settings. Leave empty t o get the entire contents of settings; this should only be used for debugging.</ dd>
530 <dd style="display: none; ">
531 This parameter was added in version
532 <b><span></span></b>.
533 You must omit this parameter in earlier versions,
534 and you may omit it in any version. If you require this
535 parameter, the manifest key
536 <a href="manifest.html#minimum_chrome_version">minimum_chrome_versio n</a>
537 can ensure that your extension won't be run in an earlier browser ve rsion.
538 </dd>
539
540 <!-- OBJECT PROPERTIES -->
541 <dd style="display: none; ">
542 <dl>
543 <div>
544 <div>
545 </div>
546 </div>
547 </dl>
548 </dd>
549
550 <!-- OBJECT METHODS -->
551 <dd style="display: none; ">
552 <div></div>
553 </dd>
554
555 <!-- OBJECT EVENT FIELDS -->
556 <dd style="display: none; ">
557 <div></div>
558 </dd>
559
560 <!-- FUNCTION PARAMETERS -->
561 <dd style="display: none; ">
562 <div></div>
563 </dd>
564
565 </div>
566 </div><div>
567 <div>
568 <dt>
569 <var>callback</var>
570 <em>
571
572 <!-- TYPE -->
573 <div style="display:inline">
574 (
575 <span class="optional" style="display: none; ">optional</spa n>
576 <span class="enum" style="display: none; ">enumerated</span>
577 <span id="typeTemplate">
578 <span style="display: none; ">
579 <a> Type</a>
580 </span>
581 <span>
582 <span style="display: none; ">
583 array of <span><span></span></span>
584 </span>
585 <span>function</span>
586 <span style="display: none; "></span>
587 </span>
588 </span>
589 )
590 </div>
591
592 </em>
593 </dt>
594 <dd class="todo" style="display: none; ">
595 Undocumented.
596 </dd>
597 <dd>Callback with settings values, or on failure (in which case lastEr ror will be set).</dd>
598 <dd style="display: none; ">
599 This parameter was added in version
600 <b><span></span></b>.
601 You must omit this parameter in earlier versions,
602 and you may omit it in any version. If you require this
603 parameter, the manifest key
604 <a href="manifest.html#minimum_chrome_version">minimum_chrome_versio n</a>
605 can ensure that your extension won't be run in an earlier browser ve rsion.
606 </dd>
607
608 <!-- OBJECT PROPERTIES -->
609 <dd style="display: none; ">
610 <dl>
611 <div>
612 <div>
613 </div>
614 </div>
615 </dl>
616 </dd>
617
618 <!-- OBJECT METHODS -->
619 <dd style="display: none; ">
620 <div></div>
621 </dd>
622
623 <!-- OBJECT EVENT FIELDS -->
624 <dd style="display: none; ">
625 <div></div>
626 </dd>
627
628 <!-- FUNCTION PARAMETERS -->
629 <dd style="display: none; ">
630 <div></div>
631 </dd>
632
633 </div>
634 </div>
635 </dl>
636
637 <!-- RETURNS -->
638 <h4 style="display: none; ">Returns</h4>
639 <dl>
640 <div style="display: none; ">
641 <div>
642 </div>
643 </div>
644 </dl>
645
646 <!-- CALLBACK -->
647 <div>
648 <div>
649 <h4>Callback function</h4>
650 <p>
651 The callback <em>parameter</em> should specify a function
652 that looks like this:
653 </p>
654 <p style="display: none; ">
655 If you specify the <em>callback</em> parameter, it should
656 specify a function that looks like this:
657 </p>
658
659 <!-- Note: intentionally longer 80 columns -->
660 <pre>function(<span>object settings</span>) <span class="subdu ed">{...}</span>;</pre>
661 <dl>
662 <div>
663 <div>
664 <dt>
665 <var>settings</var>
666 <em>
667
668 <!-- TYPE -->
669 <div style="display:inline">
670 (
671 <span class="optional" style="display: none; ">optional</spa n>
672 <span class="enum" style="display: none; ">enumerated</span>
673 <span id="typeTemplate">
674 <span style="display: none; ">
675 <a> Type</a>
676 </span>
677 <span>
678 <span style="display: none; ">
679 array of <span><span></span></span>
680 </span>
681 <span>object</span>
682 <span style="display: none; "></span>
683 </span>
684 </span>
685 )
686 </div>
687
688 </em>
689 </dt>
690 <dd class="todo" style="display: none; ">
691 Undocumented.
692 </dd>
693 <dd>Object with given keys set to settings values.</dd>
694 <dd style="display: none; ">
695 This parameter was added in version
696 <b><span></span></b>.
697 You must omit this parameter in earlier versions,
698 and you may omit it in any version. If you require this
699 parameter, the manifest key
700 <a href="manifest.html#minimum_chrome_version">minimum_chrome_versio n</a>
701 can ensure that your extension won't be run in an earlier browser ve rsion.
702 </dd>
703
704 <!-- OBJECT PROPERTIES -->
705 <dd>
706 <dl>
707 <div style="display: none; ">
708 <div>
709 </div>
710 </div>
711 </dl>
712 </dd>
713
714 <!-- OBJECT METHODS -->
715 <dd style="display: none; ">
716 <div></div>
717 </dd>
718
719 <!-- OBJECT EVENT FIELDS -->
720 <dd style="display: none; ">
721 <div></div>
722 </dd>
723
724 <!-- FUNCTION PARAMETERS -->
725 <dd style="display: none; ">
726 <div></div>
727 </dd>
728
729 </div>
730 </div>
731 </dl>
732 </div>
733 </div>
734
735 <!-- MIN_VERSION -->
736 <p style="display: none; ">
737 This function was added in version <b><span></span></b>.
738 If you require this function, the manifest key
739 <a href="manifest.html#minimum_chrome_version">minimum_chrome_ version</a>
740 can ensure that your extension won't be run in an earlier brow ser version.
741 </p>
742 </div> <!-- /description -->
743
744 </div><div class="apiItem">
745 <a name="method-remove"></a> <!-- method-anchor -->
746 <h4>remove</h4>
747
748 <div class="summary"><span style="display: none; ">void</span>
749 <!-- Note: intentionally longer 80 columns -->
750 <span>chrome.experimental.settings.remove</span>(<span class=" null"><span style="display: none; ">, </span><span>string or array of string</sp an>
751 <var><span>keys</span></var></span><span class="optional"> <span>, </span><span>function</span>
752 <var><span>callback</span></var></span>)</div>
753
754 <div class="description">
755 <p class="todo" style="display: none; ">Undocumented.</p>
756 <p>Removes one or more values from settings.</p>
757
758 <!-- PARAMETERS -->
759 <h4>Parameters</h4>
760 <dl>
761 <div>
762 <div>
763 <dt>
764 <var>keys</var>
765 <em>
766
767 <!-- TYPE -->
768 <div style="display:inline">
769 (
770 <span class="optional" style="display: none; ">optional</spa n>
771 <span class="enum" style="display: none; ">enumerated</span>
772 <span id="typeTemplate">
773 <span style="display: none; ">
774 <a> Type</a>
775 </span>
776 <span>
777 <span style="display: none; ">
778 array of <span><span></span></span>
779 </span>
780 <span>string or array of string</span>
781 <span style="display: none; "></span>
782 </span>
783 </span>
784 )
785 </div>
786
787 </em>
788 </dt>
789 <dd class="todo" style="display: none; ">
790 Undocumented.
791 </dd>
792 <dd>A single key or a list of keys to remove from settings.</dd>
793 <dd style="display: none; ">
794 This parameter was added in version
795 <b><span></span></b>.
796 You must omit this parameter in earlier versions,
797 and you may omit it in any version. If you require this
798 parameter, the manifest key
799 <a href="manifest.html#minimum_chrome_version">minimum_chrome_versio n</a>
800 can ensure that your extension won't be run in an earlier browser ve rsion.
801 </dd>
802
803 <!-- OBJECT PROPERTIES -->
804 <dd style="display: none; ">
805 <dl>
806 <div>
807 <div>
808 </div>
809 </div>
810 </dl>
811 </dd>
812
813 <!-- OBJECT METHODS -->
814 <dd style="display: none; ">
815 <div></div>
816 </dd>
817
818 <!-- OBJECT EVENT FIELDS -->
819 <dd style="display: none; ">
820 <div></div>
821 </dd>
822
823 <!-- FUNCTION PARAMETERS -->
824 <dd style="display: none; ">
825 <div></div>
826 </dd>
827
828 </div>
829 </div><div>
830 <div>
831 <dt>
832 <var>callback</var>
833 <em>
834
835 <!-- TYPE -->
836 <div style="display:inline">
837 (
838 <span class="optional">optional</span>
839 <span class="enum" style="display: none; ">enumerated</span>
840 <span id="typeTemplate">
841 <span style="display: none; ">
842 <a> Type</a>
843 </span>
844 <span>
845 <span style="display: none; ">
846 array of <span><span></span></span>
847 </span>
848 <span>function</span>
849 <span style="display: none; "></span>
850 </span>
851 </span>
852 )
853 </div>
854
855 </em>
856 </dt>
857 <dd class="todo" style="display: none; ">
858 Undocumented.
859 </dd>
860 <dd>Callback on success, or on failure (in which case lastError will b e set).</dd>
861 <dd style="display: none; ">
862 This parameter was added in version
863 <b><span></span></b>.
864 You must omit this parameter in earlier versions,
865 and you may omit it in any version. If you require this
866 parameter, the manifest key
867 <a href="manifest.html#minimum_chrome_version">minimum_chrome_versio n</a>
868 can ensure that your extension won't be run in an earlier browser ve rsion.
869 </dd>
870
871 <!-- OBJECT PROPERTIES -->
872 <dd style="display: none; ">
873 <dl>
874 <div>
875 <div>
876 </div>
877 </div>
878 </dl>
879 </dd>
880
881 <!-- OBJECT METHODS -->
882 <dd style="display: none; ">
883 <div></div>
884 </dd>
885
886 <!-- OBJECT EVENT FIELDS -->
887 <dd style="display: none; ">
888 <div></div>
889 </dd>
890
891 <!-- FUNCTION PARAMETERS -->
892 <dd style="display: none; ">
893 <div></div>
894 </dd>
895
896 </div>
897 </div>
898 </dl>
899
900 <!-- RETURNS -->
901 <h4 style="display: none; ">Returns</h4>
902 <dl>
903 <div style="display: none; ">
904 <div>
905 </div>
906 </div>
907 </dl>
908
909 <!-- CALLBACK -->
910 <div>
911 <div>
912 <h4>Callback function</h4>
913 <p style="display: none; ">
914 The callback <em>parameter</em> should specify a function
915 that looks like this:
916 </p>
917 <p>
918 If you specify the <em>callback</em> parameter, it should
919 specify a function that looks like this:
920 </p>
921
922 <!-- Note: intentionally longer 80 columns -->
923 <pre>function(<span></span>) <span class="subdued">{...}</span >;</pre>
924 <dl>
925 <div style="display: none; ">
926 <div>
927 </div>
928 </div>
929 </dl>
930 </div>
931 </div>
932
933 <!-- MIN_VERSION -->
934 <p style="display: none; ">
935 This function was added in version <b><span></span></b>.
936 If you require this function, the manifest key
937 <a href="manifest.html#minimum_chrome_version">minimum_chrome_ version</a>
938 can ensure that your extension won't be run in an earlier brow ser version.
939 </p>
940 </div> <!-- /description -->
941
942 </div><div class="apiItem">
943 <a name="method-set"></a> <!-- method-anchor -->
944 <h4>set</h4>
945
946 <div class="summary"><span style="display: none; ">void</span>
947 <!-- Note: intentionally longer 80 columns -->
948 <span>chrome.experimental.settings.set</span>(<span class="nul l"><span style="display: none; ">, </span><span>object</span>
949 <var><span>settings</span></var></span><span class="option al"><span>, </span><span>function</span>
950 <var><span>callback</span></var></span>)</div>
951
952 <div class="description">
953 <p class="todo" style="display: none; ">Undocumented.</p>
954 <p>Sets multiple settings values.</p>
955
956 <!-- PARAMETERS -->
957 <h4>Parameters</h4>
958 <dl>
959 <div>
960 <div>
961 <dt>
962 <var>settings</var>
963 <em>
964
965 <!-- TYPE -->
966 <div style="display:inline">
967 (
968 <span class="optional" style="display: none; ">optional</spa n>
969 <span class="enum" style="display: none; ">enumerated</span>
970 <span id="typeTemplate">
971 <span style="display: none; ">
972 <a> Type</a>
973 </span>
974 <span>
975 <span style="display: none; ">
976 array of <span><span></span></span>
977 </span>
978 <span>object</span>
979 <span style="display: none; "></span>
980 </span>
981 </span>
982 )
983 </div>
984
985 </em>
986 </dt>
987 <dd class="todo" style="display: none; ">
988 Undocumented.
989 </dd>
990 <dd>Object to augment settings with. Values that cannot be serialized (functions, etc) will be ignored.</dd>
991 <dd style="display: none; ">
992 This parameter was added in version
993 <b><span></span></b>.
994 You must omit this parameter in earlier versions,
995 and you may omit it in any version. If you require this
996 parameter, the manifest key
997 <a href="manifest.html#minimum_chrome_version">minimum_chrome_versio n</a>
998 can ensure that your extension won't be run in an earlier browser ve rsion.
999 </dd>
1000
1001 <!-- OBJECT PROPERTIES -->
1002 <dd>
1003 <dl>
1004 <div style="display: none; ">
1005 <div>
1006 </div>
1007 </div>
1008 </dl>
1009 </dd>
1010
1011 <!-- OBJECT METHODS -->
1012 <dd style="display: none; ">
1013 <div></div>
1014 </dd>
1015
1016 <!-- OBJECT EVENT FIELDS -->
1017 <dd style="display: none; ">
1018 <div></div>
1019 </dd>
1020
1021 <!-- FUNCTION PARAMETERS -->
1022 <dd style="display: none; ">
1023 <div></div>
1024 </dd>
1025
1026 </div>
1027 </div><div>
1028 <div>
1029 <dt>
1030 <var>callback</var>
1031 <em>
1032
1033 <!-- TYPE -->
1034 <div style="display:inline">
1035 (
1036 <span class="optional">optional</span>
1037 <span class="enum" style="display: none; ">enumerated</span>
1038 <span id="typeTemplate">
1039 <span style="display: none; ">
1040 <a> Type</a>
1041 </span>
1042 <span>
1043 <span style="display: none; ">
1044 array of <span><span></span></span>
1045 </span>
1046 <span>function</span>
1047 <span style="display: none; "></span>
1048 </span>
1049 </span>
1050 )
1051 </div>
1052
1053 </em>
1054 </dt>
1055 <dd class="todo" style="display: none; ">
1056 Undocumented.
1057 </dd>
1058 <dd>Callback with settings values, or on failure (in which case lastEr ror will be set).</dd>
1059 <dd style="display: none; ">
1060 This parameter was added in version
1061 <b><span></span></b>.
1062 You must omit this parameter in earlier versions,
1063 and you may omit it in any version. If you require this
1064 parameter, the manifest key
1065 <a href="manifest.html#minimum_chrome_version">minimum_chrome_versio n</a>
1066 can ensure that your extension won't be run in an earlier browser ve rsion.
1067 </dd>
1068
1069 <!-- OBJECT PROPERTIES -->
1070 <dd style="display: none; ">
1071 <dl>
1072 <div>
1073 <div>
1074 </div>
1075 </div>
1076 </dl>
1077 </dd>
1078
1079 <!-- OBJECT METHODS -->
1080 <dd style="display: none; ">
1081 <div></div>
1082 </dd>
1083
1084 <!-- OBJECT EVENT FIELDS -->
1085 <dd style="display: none; ">
1086 <div></div>
1087 </dd>
1088
1089 <!-- FUNCTION PARAMETERS -->
1090 <dd style="display: none; ">
1091 <div></div>
1092 </dd>
1093
1094 </div>
1095 </div>
1096 </dl>
1097
1098 <!-- RETURNS -->
1099 <h4 style="display: none; ">Returns</h4>
1100 <dl>
1101 <div style="display: none; ">
1102 <div>
1103 </div>
1104 </div>
1105 </dl>
1106
1107 <!-- CALLBACK -->
1108 <div>
1109 <div>
1110 <h4>Callback function</h4>
1111 <p style="display: none; ">
1112 The callback <em>parameter</em> should specify a function
1113 that looks like this:
1114 </p>
1115 <p>
1116 If you specify the <em>callback</em> parameter, it should
1117 specify a function that looks like this:
1118 </p>
1119
1120 <!-- Note: intentionally longer 80 columns -->
1121 <pre>function(<span>object settings</span>) <span class="subdu ed">{...}</span>;</pre>
1122 <dl>
1123 <div>
1124 <div>
1125 <dt>
1126 <var>settings</var>
1127 <em>
1128
1129 <!-- TYPE -->
1130 <div style="display:inline">
1131 (
1132 <span class="optional" style="display: none; ">optional</spa n>
1133 <span class="enum" style="display: none; ">enumerated</span>
1134 <span id="typeTemplate">
1135 <span style="display: none; ">
1136 <a> Type</a>
1137 </span>
1138 <span>
1139 <span style="display: none; ">
1140 array of <span><span></span></span>
1141 </span>
1142 <span>object</span>
1143 <span style="display: none; "></span>
1144 </span>
1145 </span>
1146 )
1147 </div>
1148
1149 </em>
1150 </dt>
1151 <dd class="todo" style="display: none; ">
1152 Undocumented.
1153 </dd>
1154 <dd>Object with given keys set to settings values.</dd>
1155 <dd style="display: none; ">
1156 This parameter was added in version
1157 <b><span></span></b>.
1158 You must omit this parameter in earlier versions,
1159 and you may omit it in any version. If you require this
1160 parameter, the manifest key
1161 <a href="manifest.html#minimum_chrome_version">minimum_chrome_versio n</a>
1162 can ensure that your extension won't be run in an earlier browser ve rsion.
1163 </dd>
1164
1165 <!-- OBJECT PROPERTIES -->
1166 <dd>
1167 <dl>
1168 <div style="display: none; ">
1169 <div>
1170 </div>
1171 </div>
1172 </dl>
1173 </dd>
1174
1175 <!-- OBJECT METHODS -->
1176 <dd style="display: none; ">
1177 <div></div>
1178 </dd>
1179
1180 <!-- OBJECT EVENT FIELDS -->
1181 <dd style="display: none; ">
1182 <div></div>
1183 </dd>
1184
1185 <!-- FUNCTION PARAMETERS -->
1186 <dd style="display: none; ">
1187 <div></div>
1188 </dd>
1189
1190 </div>
1191 </div>
1192 </dl>
1193 </div>
1194 </div>
1195
1196 <!-- MIN_VERSION -->
1197 <p style="display: none; ">
1198 This function was added in version <b><span></span></b>.
1199 If you require this function, the manifest key
1200 <a href="manifest.html#minimum_chrome_version">minimum_chrome_ version</a>
1201 can ensure that your extension won't be run in an earlier brow ser version.
1202 </p>
1203 </div> <!-- /description -->
1204
1205 </div> <!-- /apiItem -->
1206
1207 </div> <!-- /apiGroup -->
1208
1209 <!-- EVENTS -->
1210 <div id="eventsTemplate" class="apiGroup" style="display: none; ">
1211 <a></a>
1212 <h3>Events</h3>
1213 <!-- iterates over all events -->
1214 <div class="apiItem">
1215 <a></a>
1216 <h4>event name</h4>
1217
1218 <div class="summary">
1219 <!-- Note: intentionally longer 80 columns -->
1220 <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>));
1221 </div>
1222
1223 <div class="description">
1224 <p class="todo">Undocumented.</p>
1225 <p>
1226 A description from the json schema def of the event goes here.
1227 </p>
1228
1229 <!-- LISTENER PARAMETERS -->
1230 <div>
1231 <h4>Listener parameters</h4>
1232 <dl>
1233 <div>
1234 <div>
1235 </div>
1236 </div>
1237 </dl>
1238 </div>
1239
1240 <!-- EXTRA PARAMETERS -->
1241 <div>
1242 <h4>Extra parameters to addListener</h4>
1243 <dl>
1244 <div>
1245 <div>
1246 </div>
1247 </div>
1248 </dl>
1249 </div>
1250
1251 <!-- LISTENER RETURN VALUE -->
1252 <h4>Listener returns</h4>
1253 <dl>
1254 <div>
1255 <div>
1256 </div>
1257 </div>
1258 </dl>
1259
1260 </div> <!-- /description -->
1261 </div> <!-- /apiItem -->
1262
1263 </div> <!-- /apiGroup -->
1264
1265 <!-- TYPES -->
1266 <div class="apiGroup" style="display: none; ">
1267 <a name="types"></a>
1268 <h3 id="types">Types</h3>
1269
1270 <!-- iterates over all types -->
1271 <div class="apiItem">
1272 <a></a>
1273 <h4>type name</h4>
1274
1275 <div>
1276 </div>
1277
1278 </div> <!-- /apiItem -->
1279
1280 </div> <!-- /apiGroup -->
1281
1282 </div> <!-- /apiPage -->
1283 </div> <!-- /gc-pagecontent -->
1284 </div> <!-- /g-section -->
1285 </div> <!-- /codesiteContent -->
1286 <div id="gc-footer" --="">
1287 <div class="text">
1288 <p>
1289 Except as otherwise <a href="http://code.google.com/policies.html#restrictions ">noted</a>,
1290 the content of this page is licensed under the <a rel="license" href="http://c reativecommons.org/licenses/by/3.0/">Creative Commons
1291 Attribution 3.0 License</a>, and code samples are licensed under the
1292 <a rel="license" href="http://code.google.com/google_bsd_license.html">BSD Lic ense</a>.
1293 </p>
1294 <p>
1295 ©2011 Google
1296 </p>
1297
1298 <!-- begin analytics -->
1299 <script src="http://www.google-analytics.com/urchin.js" type="text/javascript">< /script>
1300 <script src="http://www.google-analytics.com/ga.js" type="text/javascript"></scr ipt>
1301
1302 <script type="text/javascript">
1303 // chrome doc tracking
1304 try {
1305 var engdocs = _gat._getTracker("YT-10763712-2");
1306 engdocs._trackPageview();
1307 } catch(err) {}
1308
1309 // code.google.com site-wide tracking
1310 try {
1311 _uacct="UA-18071-1";
1312 _uanchor=1;
1313 _uff=0;
1314 urchinTracker();
1315 }
1316 catch(e) {/* urchinTracker not available. */}
1317 </script>
1318 <!-- end analytics -->
1319 </div>
1320 </div> <!-- /gc-footer -->
1321 </div> <!-- /gc-container -->
1322 </body></html>
OLDNEW
« no previous file with comments | « chrome/common/extensions/docs/experimental.html ('k') | chrome/common/extensions/docs/samples.json » ('j') | no next file with comments »

Powered by Google App Engine
This is Rietveld 408576698