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

Issues Search
    My Issues | Starred     Open | Closed | All

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: dgrogan comments #2, mihai comments #1 Created 9 years, 6 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
« chrome/common/extensions/api/extension_api.json ('K') | « chrome/common/extensions/docs/experimental.html ('k') | chrome/common/extensions/docs/samples.json » ('j') | chrome/test/data/extensions/api_test/settings/test.html » ('J')
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.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 with an empty settings object, or on failure (in which ca se lastError will be 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>object settings</span>) <span class="subdu ed">{...}</span>;</pre>
463 <dl>
464 <div>
465 <div>
466 <dt>
467 <var>settings</var>
468 <em>
469
470 <!-- TYPE -->
471 <div style="display:inline">
472 (
473 <span class="optional" style="display: none; ">optional</spa n>
474 <span class="enum" style="display: none; ">enumerated</span>
475 <span id="typeTemplate">
476 <span style="display: none; ">
477 <a> Type</a>
478 </span>
479 <span>
480 <span style="display: none; ">
481 array of <span><span></span></span>
482 </span>
483 <span>object</span>
484 <span style="display: none; "></span>
485 </span>
486 </span>
487 )
488 </div>
489
490 </em>
491 </dt>
492 <dd class="todo" style="display: none; ">
493 Undocumented.
494 </dd>
495 <dd>An empty object.</dd>
496 <dd style="display: none; ">
497 This parameter was added in version
498 <b><span></span></b>.
499 You must omit this parameter in earlier versions,
500 and you may omit it in any version. If you require this
501 parameter, the manifest key
502 <a href="manifest.html#minimum_chrome_version">minimum_chrome_versio n</a>
503 can ensure that your extension won't be run in an earlier browser ve rsion.
504 </dd>
505
506 <!-- OBJECT PROPERTIES -->
507 <dd style="display: none; ">
508 <dl>
509 <div>
510 <div>
511 </div>
512 </div>
513 </dl>
514 </dd>
515
516 <!-- OBJECT METHODS -->
517 <dd style="display: none; ">
518 <div></div>
519 </dd>
520
521 <!-- OBJECT EVENT FIELDS -->
522 <dd style="display: none; ">
523 <div></div>
524 </dd>
525
526 <!-- FUNCTION PARAMETERS -->
527 <dd style="display: none; ">
528 <div></div>
529 </dd>
530
531 </div>
532 </div>
533 </dl>
534 </div>
535 </div>
536
537 <!-- MIN_VERSION -->
538 <p style="display: none; ">
539 This function was added in version <b><span></span></b>.
540 If you require this function, the manifest key
541 <a href="manifest.html#minimum_chrome_version">minimum_chrome_ version</a>
542 can ensure that your extension won't be run in an earlier brow ser version.
543 </p>
544 </div> <!-- /description -->
545
546 </div><div class="apiItem">
547 <a name="method-get"></a> <!-- method-anchor -->
548 <h4>get</h4>
549
550 <div class="summary"><span style="display: none; ">void</span>
551 <!-- Note: intentionally longer 80 columns -->
552 <span>chrome.experimental.settings.get</span>(<span class="opt ional"><span style="display: none; ">, </span><span>undefined</span>
553 <var><span>keys</span></var></span><span class="null"><spa n>, </span><span>function</span>
554 <var><span>callback</span></var></span>)</div>
555
556 <div class="description">
557 <p class="todo" style="display: none; ">Undocumented.</p>
558 <p>Gets one or more values from settings.</p>
559
560 <!-- PARAMETERS -->
561 <h4>Parameters</h4>
562 <dl>
563 <div>
564 <div>
565 <dt>
566 <var>keys</var>
567 <em>
568
569 <!-- TYPE -->
570 <div style="display:inline">
571 (
572 <span class="optional">optional</span>
573 <span class="enum" style="display: none; ">enumerated</span>
574 <span id="typeTemplate">
575 <span style="display: none; ">
576 <a> Type</a>
577 </span>
578 <span>
579 <span style="display: none; ">
580 array of <span><span></span></span>
581 </span>
582 <span>undefined</span>
583 <span style="display: none; "></span>
584 </span>
585 </span>
586 )
587 </div>
588
589 </em>
590 </dt>
591 <dd class="todo" style="display: none; ">
592 Undocumented.
593 </dd>
594 <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>
595 <dd style="display: none; ">
596 This parameter was added in version
597 <b><span></span></b>.
598 You must omit this parameter in earlier versions,
599 and you may omit it in any version. If you require this
600 parameter, the manifest key
601 <a href="manifest.html#minimum_chrome_version">minimum_chrome_versio n</a>
602 can ensure that your extension won't be run in an earlier browser ve rsion.
603 </dd>
604
605 <!-- OBJECT PROPERTIES -->
606 <dd style="display: none; ">
607 <dl>
608 <div>
609 <div>
610 </div>
611 </div>
612 </dl>
613 </dd>
614
615 <!-- OBJECT METHODS -->
616 <dd style="display: none; ">
617 <div></div>
618 </dd>
619
620 <!-- OBJECT EVENT FIELDS -->
621 <dd style="display: none; ">
622 <div></div>
623 </dd>
624
625 <!-- FUNCTION PARAMETERS -->
626 <dd style="display: none; ">
627 <div></div>
628 </dd>
629
630 </div>
631 </div><div>
632 <div>
633 <dt>
634 <var>callback</var>
635 <em>
636
637 <!-- TYPE -->
638 <div style="display:inline">
639 (
640 <span class="optional" style="display: none; ">optional</spa n>
641 <span class="enum" style="display: none; ">enumerated</span>
642 <span id="typeTemplate">
643 <span style="display: none; ">
644 <a> Type</a>
645 </span>
646 <span>
647 <span style="display: none; ">
648 array of <span><span></span></span>
649 </span>
650 <span>function</span>
651 <span style="display: none; "></span>
652 </span>
653 </span>
654 )
655 </div>
656
657 </em>
658 </dt>
659 <dd class="todo" style="display: none; ">
660 Undocumented.
661 </dd>
662 <dd>Callback with settings values, or on failure (in which case lastEr ror will be set).</dd>
663 <dd style="display: none; ">
664 This parameter was added in version
665 <b><span></span></b>.
666 You must omit this parameter in earlier versions,
667 and you may omit it in any version. If you require this
668 parameter, the manifest key
669 <a href="manifest.html#minimum_chrome_version">minimum_chrome_versio n</a>
670 can ensure that your extension won't be run in an earlier browser ve rsion.
671 </dd>
672
673 <!-- OBJECT PROPERTIES -->
674 <dd style="display: none; ">
675 <dl>
676 <div>
677 <div>
678 </div>
679 </div>
680 </dl>
681 </dd>
682
683 <!-- OBJECT METHODS -->
684 <dd style="display: none; ">
685 <div></div>
686 </dd>
687
688 <!-- OBJECT EVENT FIELDS -->
689 <dd style="display: none; ">
690 <div></div>
691 </dd>
692
693 <!-- FUNCTION PARAMETERS -->
694 <dd style="display: none; ">
695 <div></div>
696 </dd>
697
698 </div>
699 </div>
700 </dl>
701
702 <!-- RETURNS -->
703 <h4 style="display: none; ">Returns</h4>
704 <dl>
705 <div style="display: none; ">
706 <div>
707 </div>
708 </div>
709 </dl>
710
711 <!-- CALLBACK -->
712 <div>
713 <div>
714 <h4>Callback function</h4>
715 <p>
716 The callback <em>parameter</em> should specify a function
717 that looks like this:
718 </p>
719 <p style="display: none; ">
720 If you specify the <em>callback</em> parameter, it should
721 specify a function that looks like this:
722 </p>
723
724 <!-- Note: intentionally longer 80 columns -->
725 <pre>function(<span>object settings</span>) <span class="subdu ed">{...}</span>;</pre>
726 <dl>
727 <div>
728 <div>
729 <dt>
730 <var>settings</var>
731 <em>
732
733 <!-- TYPE -->
734 <div style="display:inline">
735 (
736 <span class="optional" style="display: none; ">optional</spa n>
737 <span class="enum" style="display: none; ">enumerated</span>
738 <span id="typeTemplate">
739 <span style="display: none; ">
740 <a> Type</a>
741 </span>
742 <span>
743 <span style="display: none; ">
744 array of <span><span></span></span>
745 </span>
746 <span>object</span>
747 <span style="display: none; "></span>
748 </span>
749 </span>
750 )
751 </div>
752
753 </em>
754 </dt>
755 <dd class="todo" style="display: none; ">
756 Undocumented.
757 </dd>
758 <dd>Object with given keys set to settings values.</dd>
759 <dd style="display: none; ">
760 This parameter was added in version
761 <b><span></span></b>.
762 You must omit this parameter in earlier versions,
763 and you may omit it in any version. If you require this
764 parameter, the manifest key
765 <a href="manifest.html#minimum_chrome_version">minimum_chrome_versio n</a>
766 can ensure that your extension won't be run in an earlier browser ve rsion.
767 </dd>
768
769 <!-- OBJECT PROPERTIES -->
770 <dd style="display: none; ">
771 <dl>
772 <div>
773 <div>
774 </div>
775 </div>
776 </dl>
777 </dd>
778
779 <!-- OBJECT METHODS -->
780 <dd style="display: none; ">
781 <div></div>
782 </dd>
783
784 <!-- OBJECT EVENT FIELDS -->
785 <dd style="display: none; ">
786 <div></div>
787 </dd>
788
789 <!-- FUNCTION PARAMETERS -->
790 <dd style="display: none; ">
791 <div></div>
792 </dd>
793
794 </div>
795 </div>
796 </dl>
797 </div>
798 </div>
799
800 <!-- MIN_VERSION -->
801 <p style="display: none; ">
802 This function was added in version <b><span></span></b>.
803 If you require this function, the manifest key
804 <a href="manifest.html#minimum_chrome_version">minimum_chrome_ version</a>
805 can ensure that your extension won't be run in an earlier brow ser version.
806 </p>
807 </div> <!-- /description -->
808
809 </div><div class="apiItem">
810 <a name="method-remove"></a> <!-- method-anchor -->
811 <h4>remove</h4>
812
813 <div class="summary"><span style="display: none; ">void</span>
814 <!-- Note: intentionally longer 80 columns -->
815 <span>chrome.experimental.settings.remove</span>(<span class=" null"><span style="display: none; ">, </span><span>undefined</span>
816 <var><span>keys</span></var></span><span class="optional"> <span>, </span><span>function</span>
817 <var><span>callback</span></var></span>)</div>
818
819 <div class="description">
820 <p class="todo" style="display: none; ">Undocumented.</p>
821 <p>Removes one or more values from settings.</p>
822
823 <!-- PARAMETERS -->
824 <h4>Parameters</h4>
825 <dl>
826 <div>
827 <div>
828 <dt>
829 <var>keys</var>
830 <em>
831
832 <!-- TYPE -->
833 <div style="display:inline">
834 (
835 <span class="optional" style="display: none; ">optional</spa n>
836 <span class="enum" style="display: none; ">enumerated</span>
837 <span id="typeTemplate">
838 <span style="display: none; ">
839 <a> Type</a>
840 </span>
841 <span>
842 <span style="display: none; ">
843 array of <span><span></span></span>
844 </span>
845 <span>undefined</span>
846 <span style="display: none; "></span>
847 </span>
848 </span>
849 )
850 </div>
851
852 </em>
853 </dt>
854 <dd class="todo" style="display: none; ">
855 Undocumented.
856 </dd>
857 <dd>A single key or a list of keys to remove from settings.</dd>
858 <dd style="display: none; ">
859 This parameter was added in version
860 <b><span></span></b>.
861 You must omit this parameter in earlier versions,
862 and you may omit it in any version. If you require this
863 parameter, the manifest key
864 <a href="manifest.html#minimum_chrome_version">minimum_chrome_versio n</a>
865 can ensure that your extension won't be run in an earlier browser ve rsion.
866 </dd>
867
868 <!-- OBJECT PROPERTIES -->
869 <dd style="display: none; ">
870 <dl>
871 <div>
872 <div>
873 </div>
874 </div>
875 </dl>
876 </dd>
877
878 <!-- OBJECT METHODS -->
879 <dd style="display: none; ">
880 <div></div>
881 </dd>
882
883 <!-- OBJECT EVENT FIELDS -->
884 <dd style="display: none; ">
885 <div></div>
886 </dd>
887
888 <!-- FUNCTION PARAMETERS -->
889 <dd style="display: none; ">
890 <div></div>
891 </dd>
892
893 </div>
894 </div><div>
895 <div>
896 <dt>
897 <var>callback</var>
898 <em>
899
900 <!-- TYPE -->
901 <div style="display:inline">
902 (
903 <span class="optional">optional</span>
904 <span class="enum" style="display: none; ">enumerated</span>
905 <span id="typeTemplate">
906 <span style="display: none; ">
907 <a> Type</a>
908 </span>
909 <span>
910 <span style="display: none; ">
911 array of <span><span></span></span>
912 </span>
913 <span>function</span>
914 <span style="display: none; "></span>
915 </span>
916 </span>
917 )
918 </div>
919
920 </em>
921 </dt>
922 <dd class="todo" style="display: none; ">
923 Undocumented.
924 </dd>
925 <dd>Callback with an empty settings object, or on failure (in which ca se lastError will be set).</dd>
926 <dd style="display: none; ">
927 This parameter was added in version
928 <b><span></span></b>.
929 You must omit this parameter in earlier versions,
930 and you may omit it in any version. If you require this
931 parameter, the manifest key
932 <a href="manifest.html#minimum_chrome_version">minimum_chrome_versio n</a>
933 can ensure that your extension won't be run in an earlier browser ve rsion.
934 </dd>
935
936 <!-- OBJECT PROPERTIES -->
937 <dd style="display: none; ">
938 <dl>
939 <div>
940 <div>
941 </div>
942 </div>
943 </dl>
944 </dd>
945
946 <!-- OBJECT METHODS -->
947 <dd style="display: none; ">
948 <div></div>
949 </dd>
950
951 <!-- OBJECT EVENT FIELDS -->
952 <dd style="display: none; ">
953 <div></div>
954 </dd>
955
956 <!-- FUNCTION PARAMETERS -->
957 <dd style="display: none; ">
958 <div></div>
959 </dd>
960
961 </div>
962 </div>
963 </dl>
964
965 <!-- RETURNS -->
966 <h4 style="display: none; ">Returns</h4>
967 <dl>
968 <div style="display: none; ">
969 <div>
970 </div>
971 </div>
972 </dl>
973
974 <!-- CALLBACK -->
975 <div>
976 <div>
977 <h4>Callback function</h4>
978 <p style="display: none; ">
979 The callback <em>parameter</em> should specify a function
980 that looks like this:
981 </p>
982 <p>
983 If you specify the <em>callback</em> parameter, it should
984 specify a function that looks like this:
985 </p>
986
987 <!-- Note: intentionally longer 80 columns -->
988 <pre>function(<span>object settings</span>) <span class="subdu ed">{...}</span>;</pre>
989 <dl>
990 <div>
991 <div>
992 <dt>
993 <var>settings</var>
994 <em>
995
996 <!-- TYPE -->
997 <div style="display:inline">
998 (
999 <span class="optional" style="display: none; ">optional</spa n>
1000 <span class="enum" style="display: none; ">enumerated</span>
1001 <span id="typeTemplate">
1002 <span style="display: none; ">
1003 <a> Type</a>
1004 </span>
1005 <span>
1006 <span style="display: none; ">
1007 array of <span><span></span></span>
1008 </span>
1009 <span>object</span>
1010 <span style="display: none; "></span>
1011 </span>
1012 </span>
1013 )
1014 </div>
1015
1016 </em>
1017 </dt>
1018 <dd class="todo" style="display: none; ">
1019 Undocumented.
1020 </dd>
1021 <dd>An empty object.</dd>
1022 <dd style="display: none; ">
1023 This parameter was added in version
1024 <b><span></span></b>.
1025 You must omit this parameter in earlier versions,
1026 and you may omit it in any version. If you require this
1027 parameter, the manifest key
1028 <a href="manifest.html#minimum_chrome_version">minimum_chrome_versio n</a>
1029 can ensure that your extension won't be run in an earlier browser ve rsion.
1030 </dd>
1031
1032 <!-- OBJECT PROPERTIES -->
1033 <dd style="display: none; ">
1034 <dl>
1035 <div>
1036 <div>
1037 </div>
1038 </div>
1039 </dl>
1040 </dd>
1041
1042 <!-- OBJECT METHODS -->
1043 <dd style="display: none; ">
1044 <div></div>
1045 </dd>
1046
1047 <!-- OBJECT EVENT FIELDS -->
1048 <dd style="display: none; ">
1049 <div></div>
1050 </dd>
1051
1052 <!-- FUNCTION PARAMETERS -->
1053 <dd style="display: none; ">
1054 <div></div>
1055 </dd>
1056
1057 </div>
1058 </div>
1059 </dl>
1060 </div>
1061 </div>
1062
1063 <!-- MIN_VERSION -->
1064 <p style="display: none; ">
1065 This function was added in version <b><span></span></b>.
1066 If you require this function, the manifest key
1067 <a href="manifest.html#minimum_chrome_version">minimum_chrome_ version</a>
1068 can ensure that your extension won't be run in an earlier brow ser version.
1069 </p>
1070 </div> <!-- /description -->
1071
1072 </div><div class="apiItem">
1073 <a name="method-set"></a> <!-- method-anchor -->
1074 <h4>set</h4>
1075
1076 <div class="summary"><span style="display: none; ">void</span>
1077 <!-- Note: intentionally longer 80 columns -->
1078 <span>chrome.experimental.settings.set</span>(<span class="nul l"><span style="display: none; ">, </span><span>undefined</span>
1079 <var><span>settings</span></var></span><span class="option al"><span>, </span><span>function</span>
1080 <var><span>callback</span></var></span>)</div>
1081
1082 <div class="description">
1083 <p class="todo" style="display: none; ">Undocumented.</p>
1084 <p>Sets multiple settings values.</p>
1085
1086 <!-- PARAMETERS -->
1087 <h4>Parameters</h4>
1088 <dl>
1089 <div>
1090 <div>
1091 <dt>
1092 <var>settings</var>
1093 <em>
1094
1095 <!-- TYPE -->
1096 <div style="display:inline">
1097 (
1098 <span class="optional" style="display: none; ">optional</spa n>
1099 <span class="enum" style="display: none; ">enumerated</span>
1100 <span id="typeTemplate">
1101 <span style="display: none; ">
1102 <a> Type</a>
1103 </span>
1104 <span>
1105 <span style="display: none; ">
1106 array of <span><span></span></span>
1107 </span>
1108 <span>undefined</span>
1109 <span style="display: none; "></span>
1110 </span>
1111 </span>
1112 )
1113 </div>
1114
1115 </em>
1116 </dt>
1117 <dd class="todo" style="display: none; ">
1118 Undocumented.
1119 </dd>
1120 <dd>Object to augment settings with. Values that cannot be serialized (functions, etc) will be ignored.</dd>
1121 <dd style="display: none; ">
1122 This parameter was added in version
1123 <b><span></span></b>.
1124 You must omit this parameter in earlier versions,
1125 and you may omit it in any version. If you require this
1126 parameter, the manifest key
1127 <a href="manifest.html#minimum_chrome_version">minimum_chrome_versio n</a>
1128 can ensure that your extension won't be run in an earlier browser ve rsion.
1129 </dd>
1130
1131 <!-- OBJECT PROPERTIES -->
1132 <dd style="display: none; ">
1133 <dl>
1134 <div>
1135 <div>
1136 </div>
1137 </div>
1138 </dl>
1139 </dd>
1140
1141 <!-- OBJECT METHODS -->
1142 <dd style="display: none; ">
1143 <div></div>
1144 </dd>
1145
1146 <!-- OBJECT EVENT FIELDS -->
1147 <dd style="display: none; ">
1148 <div></div>
1149 </dd>
1150
1151 <!-- FUNCTION PARAMETERS -->
1152 <dd style="display: none; ">
1153 <div></div>
1154 </dd>
1155
1156 </div>
1157 </div><div>
1158 <div>
1159 <dt>
1160 <var>callback</var>
1161 <em>
1162
1163 <!-- TYPE -->
1164 <div style="display:inline">
1165 (
1166 <span class="optional">optional</span>
1167 <span class="enum" style="display: none; ">enumerated</span>
1168 <span id="typeTemplate">
1169 <span style="display: none; ">
1170 <a> Type</a>
1171 </span>
1172 <span>
1173 <span style="display: none; ">
1174 array of <span><span></span></span>
1175 </span>
1176 <span>function</span>
1177 <span style="display: none; "></span>
1178 </span>
1179 </span>
1180 )
1181 </div>
1182
1183 </em>
1184 </dt>
1185 <dd class="todo" style="display: none; ">
1186 Undocumented.
1187 </dd>
1188 <dd>Callback with settings values, or on failure (in which case lastEr ror will be set).</dd>
1189 <dd style="display: none; ">
1190 This parameter was added in version
1191 <b><span></span></b>.
1192 You must omit this parameter in earlier versions,
1193 and you may omit it in any version. If you require this
1194 parameter, the manifest key
1195 <a href="manifest.html#minimum_chrome_version">minimum_chrome_versio n</a>
1196 can ensure that your extension won't be run in an earlier browser ve rsion.
1197 </dd>
1198
1199 <!-- OBJECT PROPERTIES -->
1200 <dd style="display: none; ">
1201 <dl>
1202 <div>
1203 <div>
1204 </div>
1205 </div>
1206 </dl>
1207 </dd>
1208
1209 <!-- OBJECT METHODS -->
1210 <dd style="display: none; ">
1211 <div></div>
1212 </dd>
1213
1214 <!-- OBJECT EVENT FIELDS -->
1215 <dd style="display: none; ">
1216 <div></div>
1217 </dd>
1218
1219 <!-- FUNCTION PARAMETERS -->
1220 <dd style="display: none; ">
1221 <div></div>
1222 </dd>
1223
1224 </div>
1225 </div>
1226 </dl>
1227
1228 <!-- RETURNS -->
1229 <h4 style="display: none; ">Returns</h4>
1230 <dl>
1231 <div style="display: none; ">
1232 <div>
1233 </div>
1234 </div>
1235 </dl>
1236
1237 <!-- CALLBACK -->
1238 <div>
1239 <div>
1240 <h4>Callback function</h4>
1241 <p style="display: none; ">
1242 The callback <em>parameter</em> should specify a function
1243 that looks like this:
1244 </p>
1245 <p>
1246 If you specify the <em>callback</em> parameter, it should
1247 specify a function that looks like this:
1248 </p>
1249
1250 <!-- Note: intentionally longer 80 columns -->
1251 <pre>function(<span>object settings</span>) <span class="subdu ed">{...}</span>;</pre>
1252 <dl>
1253 <div>
1254 <div>
1255 <dt>
1256 <var>settings</var>
1257 <em>
1258
1259 <!-- TYPE -->
1260 <div style="display:inline">
1261 (
1262 <span class="optional" style="display: none; ">optional</spa n>
1263 <span class="enum" style="display: none; ">enumerated</span>
1264 <span id="typeTemplate">
1265 <span style="display: none; ">
1266 <a> Type</a>
1267 </span>
1268 <span>
1269 <span style="display: none; ">
1270 array of <span><span></span></span>
1271 </span>
1272 <span>object</span>
1273 <span style="display: none; "></span>
1274 </span>
1275 </span>
1276 )
1277 </div>
1278
1279 </em>
1280 </dt>
1281 <dd class="todo" style="display: none; ">
1282 Undocumented.
1283 </dd>
1284 <dd>Object with given keys set to settings values.</dd>
1285 <dd style="display: none; ">
1286 This parameter was added in version
1287 <b><span></span></b>.
1288 You must omit this parameter in earlier versions,
1289 and you may omit it in any version. If you require this
1290 parameter, the manifest key
1291 <a href="manifest.html#minimum_chrome_version">minimum_chrome_versio n</a>
1292 can ensure that your extension won't be run in an earlier browser ve rsion.
1293 </dd>
1294
1295 <!-- OBJECT PROPERTIES -->
1296 <dd style="display: none; ">
1297 <dl>
1298 <div>
1299 <div>
1300 </div>
1301 </div>
1302 </dl>
1303 </dd>
1304
1305 <!-- OBJECT METHODS -->
1306 <dd style="display: none; ">
1307 <div></div>
1308 </dd>
1309
1310 <!-- OBJECT EVENT FIELDS -->
1311 <dd style="display: none; ">
1312 <div></div>
1313 </dd>
1314
1315 <!-- FUNCTION PARAMETERS -->
1316 <dd style="display: none; ">
1317 <div></div>
1318 </dd>
1319
1320 </div>
1321 </div>
1322 </dl>
1323 </div>
1324 </div>
1325
1326 <!-- MIN_VERSION -->
1327 <p style="display: none; ">
1328 This function was added in version <b><span></span></b>.
1329 If you require this function, the manifest key
1330 <a href="manifest.html#minimum_chrome_version">minimum_chrome_ version</a>
1331 can ensure that your extension won't be run in an earlier brow ser version.
1332 </p>
1333 </div> <!-- /description -->
1334
1335 </div> <!-- /apiItem -->
1336
1337 </div> <!-- /apiGroup -->
1338
1339 <!-- EVENTS -->
1340 <div id="eventsTemplate" class="apiGroup" style="display: none; ">
1341 <a></a>
1342 <h3>Events</h3>
1343 <!-- iterates over all events -->
1344 <div class="apiItem">
1345 <a></a>
1346 <h4>event name</h4>
1347
1348 <div class="summary">
1349 <!-- Note: intentionally longer 80 columns -->
1350 <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>));
1351 </div>
1352
1353 <div class="description">
1354 <p class="todo">Undocumented.</p>
1355 <p>
1356 A description from the json schema def of the event goes here.
1357 </p>
1358
1359 <!-- LISTENER PARAMETERS -->
1360 <div>
1361 <h4>Listener parameters</h4>
1362 <dl>
1363 <div>
1364 <div>
1365 </div>
1366 </div>
1367 </dl>
1368 </div>
1369
1370 <!-- EXTRA PARAMETERS -->
1371 <div>
1372 <h4>Extra parameters to addListener</h4>
1373 <dl>
1374 <div>
1375 <div>
1376 </div>
1377 </div>
1378 </dl>
1379 </div>
1380
1381 <!-- LISTENER RETURN VALUE -->
1382 <h4>Listener returns</h4>
1383 <dl>
1384 <div>
1385 <div>
1386 </div>
1387 </div>
1388 </dl>
1389
1390 </div> <!-- /description -->
1391 </div> <!-- /apiItem -->
1392
1393 </div> <!-- /apiGroup -->
1394
1395 <!-- TYPES -->
1396 <div class="apiGroup" style="display: none; ">
1397 <a name="types"></a>
1398 <h3 id="types">Types</h3>
1399
1400 <!-- iterates over all types -->
1401 <div class="apiItem">
1402 <a></a>
1403 <h4>type name</h4>
1404
1405 <div>
1406 </div>
1407
1408 </div> <!-- /apiItem -->
1409
1410 </div> <!-- /apiGroup -->
1411
1412 </div> <!-- /apiPage -->
1413 </div> <!-- /gc-pagecontent -->
1414 </div> <!-- /g-section -->
1415 </div> <!-- /codesiteContent -->
1416 <div id="gc-footer" --="">
1417 <div class="text">
1418 <p>
1419 Except as otherwise <a href="http://code.google.com/policies.html#restrictions ">noted</a>,
1420 the content of this page is licensed under the <a rel="license" href="http://c reativecommons.org/licenses/by/3.0/">Creative Commons
1421 Attribution 3.0 License</a>, and code samples are licensed under the
1422 <a rel="license" href="http://code.google.com/google_bsd_license.html">BSD Lic ense</a>.
1423 </p>
1424 <p>
1425 ©2011 Google
1426 </p>
1427
1428 <!-- begin analytics -->
1429 <script src="http://www.google-analytics.com/urchin.js" type="text/javascript">< /script>
1430 <script src="http://www.google-analytics.com/ga.js" type="text/javascript"></scr ipt>
1431
1432 <script type="text/javascript">
1433 // chrome doc tracking
1434 try {
1435 var engdocs = _gat._getTracker("YT-10763712-2");
1436 engdocs._trackPageview();
1437 } catch(err) {}
1438
1439 // code.google.com site-wide tracking
1440 try {
1441 _uacct="UA-18071-1";
1442 _uanchor=1;
1443 _uff=0;
1444 urchinTracker();
1445 }
1446 catch(e) {/* urchinTracker not available. */}
1447 </script>
1448 <!-- end analytics -->
1449 </div>
1450 </div> <!-- /gc-footer -->
1451 </div> <!-- /gc-container -->
1452 </body></html>
OLDNEW
« chrome/common/extensions/api/extension_api.json ('K') | « chrome/common/extensions/docs/experimental.html ('k') | chrome/common/extensions/docs/samples.json » ('j') | chrome/test/data/extensions/api_test/settings/test.html » ('J')

Powered by Google App Engine
This is Rietveld 408576698