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

Issues Search
    My Issues | Starred     Open | Closed | All

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

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

Powered by Google App Engine
This is Rietveld 408576698