chrome/common/extensions/docs/privacy.html - Issue 10642015: Basic setup for generating app docs

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

Issue 10642015: Basic setup for generating app docs (Closed) Base URL: svn://svn.chromium.org/chrome/trunk/src

Patch Set: fix 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

OLD	NEW
	(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.privacy module, which is part of the Google Chrome extension APIs."><title>Privacy - Google Ch rome 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&t13n_langs=en"></script>

70 <script type="text/javascript" src="https://www.google.com/coop/cse/br and?form=cse&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">Privacy</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="#examples">Examples</a>

204 <ol>

205 </ol>

206 </li><li>

207 <a href="#manifest">Manifest</a>

208 <ol>

209 </ol>

210 </li><li>

211 <a href="#usage">Usage</a>

212 <ol>

213 </ol>

214 </li><li>

215 <a href="#examples">Examples</a>

216 <ol>

217 </ol>

218 </li>

219 <li>

220 <a href="#apiReference">API reference: chrome.privacy</a>

221 <ol>

222 <li>

223 <a href="#properties">Properties</a>

224 <ol>

225 <li>

226 <a href="#property-network">network</a>

227 </li><li>

228 <a href="#property-services">services</a>

229 </li><li>

230 <a href="#property-websites">websites</a>

231 </li>

232 </ol>

233 </li>

234 </ol>

235 </li>

236 </ol>

237 </div>

238 <!-- /TABLE OF CONTENTS -->

239 <!-- Standard content lead-in for experimental API pages -->

240 <!-- STATIC CONTENT PLACEHOLDER -->

241 <div id="static"><div id="pageData-name" class="pageData">Privacy</div>

242 <!-- BEGIN AUTHORED CONTENT -->

243 <p id="classSummary">

244 Use the <code>chrome.privacy</code> module to control usage of the features in

245 Chrome that can affect a user's privacy. This module relies on the

246 <a href="types.html#ChromeSetting">ChromeSetting prototype of the type API</a>

247 for getting and setting Chrome's configuration.

248 </p>

249 <p class="note">

250 The <a href="http://www.google.com/intl/en/landing/chrome/google-chrome-privac y-whitepaper.pdf">Chrome Privacy Whitepaper</a>

251 gives background detail regarding the features which this API can control.

252 </p>

253 <h2 id="manifest">Manifest</h2>

254 <p>

255 You must declare the "privacy" permission in your extension's

256 <a href="manifest.html">manifest</a> to use the API. For example:

257 </p>

258 <pre>{

259 "name": "My extension",

260 ...

261 <b>"permissions": [

262 "privacy"

263 ]</b>,

264 ...

265 }</pre>

266 <h2 id="usage">Usage</h2>

267 <p>

268 Reading the current value of a Chrome setting is straightforward. You'll first

269 need to find the property you're interested in, then you'll call

270 <code>get()</code> on that object in order to retrieve its current value and

271 your extension's level of control. For example, to determine if Chrome's

272 Autofill feature is enabled, you'd write:

273 </p>

274 <pre>chrome.privacy.services.autofillEnabled.get({}, function(details) {

275 if (details.value)

276 console.log('Autofill is on!');

277 else

278 console.log('Autofill is off!');

279 });</pre>

280 <p>

281 Changing the value of a setting is a little bit more complex, simply because

282 you first must verify that your extension can control the setting. The user

283 won't see any change to her settings if your extension toggles a setting that

284 is either locked to a specific value by enterprise policies

285 (<code>levelOfControl</code> will be set to "not_controllable"), or if another

286 extension is controlling the value (<code>levelOfControl</code> will be set to

287 "controlled_by_other_extensions"). The <code>set()</code> call will succeed,

288 but the setting will be immediately overridden. As this might be confusing, it

289 is advisable to warn the user when the settings they've chosen aren't

290 practically applied.

291 </p>

292 <p class="note">

293 Full details about extensions' ability to control <code>ChromeSetting</code>s

294 can be found under

295 <a href="types.html#ChromeSetting">

296 <code>chrome.types.ChromeSetting</code></a>.

297 </p>

298 <p>

299 This means that you ought to use the <code>get()</code> method to determine

300 your level of access, and then only call <code>set()</code> if your extension

301 can grab control over the setting (in fact if your extension can't control the

302 setting it's probably a good idea to visually disable the functionality to

303 reduce user confusion):

304 </p>

305 <pre>chrome.privacy.services.autofillEnabled.get({}, function(details) {

306 if (details.levelOfControl === 'controllable_by_this_extension') {

307 chrome.privacy.services.autofillEnabled.set({ value: true }, function() {

308 if (chrome.extension.lastError === undefined)

309 console.log("Hooray, it worked!");

310 else

311 console.log("Sadness!", chrome.extension.lastError);

312 }

313 }

314 });</pre>

315 <p>

316 If you're interested in changes to a setting's value, add a listener to its

317 <code>onChange</code> event. Among other uses, this will allow you to warn the

318 user if a more recently installed extension grabs control of a setting, or if

319 enterprise policy overrides your control. To listen for changes to Autofill's

320 status, for example, the following code would suffice:

321 </p>

322 <pre>chrome.privacy.services.autofillEnabled.onChange.addListener(

323 function (details) {

324 // The new value is stored in `details.value`, the new level of control

325 // in `details.levelOfControl`, and `details.incognitoSpecific` will be

326 // `true` if the value is specific to Incognito mode.

327 });</pre>

328 <h2 id="examples">Examples</h2>

329 <p>

330 For example code, see the

331 <a href="samples.html#privacy">Privacy API samples</a>.

332 </p>

333 <!-- END AUTHORED CONTENT --><div id="pageData-name" class="pageData">Privacy</d iv>

334 <!-- BEGIN AUTHORED CONTENT -->

335 <p id="classSummary">

336 Use the <code>chrome.privacy</code> module to control usage of the features in

337 Chrome that can affect a user's privacy. This module relies on the

338 <a href="types.html#ChromeSetting">ChromeSetting prototype of the type API</a>

339 for getting and setting Chrome's configuration.

340 </p>

341 <p class="note">

342 The <a href="http://www.google.com/intl/en/landing/chrome/google-chrome-privac y-whitepaper.pdf">Chrome Privacy Whitepaper</a>

343 gives background detail regarding the features which this API can control.

344 </p>

345 <h2 id="manifest">Manifest</h2>

346 <p>

347 You must declare the "privacy" permission in your extension's

348 <a href="manifest.html">manifest</a> to use the API. For example:

349 </p>

350 <pre>{

351 "name": "My extension",

352 ...

353 <b>"permissions": [

354 "privacy"

355 ]</b>,

356 ...

357 }</pre>

358 <h2 id="usage">Usage</h2>

359 <p>

360 Reading the current value of a Chrome setting is straightforward. You'll first

361 need to find the property you're interested in, then you'll call

362 <code>get()</code> on that object in order to retrieve its current value and

363 your extension's level of control. For example, to determine if Chrome's

364 Autofill feature is enabled, you'd write:

365 </p>

366 <pre>chrome.privacy.services.autofillEnabled.get({}, function(details) {

367 if (details.value)

368 console.log('Autofill is on!');

369 else

370 console.log('Autofill is off!');

371 });</pre>

372 <p>

373 Changing the value of a setting is a little bit more complex, simply because

374 you first must verify that your extension can control the setting. The user

375 won't see any change to her settings if you extension toggles a setting that

376 is either locked to a specific value by enterprise policies

377 (<code>levelOfControl</code> will be set to "not_controllable"), or if another

378 extension is controlling the value (<code>levelOfControl</code> will be set to

379 "controlled_by_other_extensions"). The <code>set()</code> call will succeed,

380 but the setting will be immediately overridden. As this might be confusing, it

381 is advisable to warn the user when the settings they've chosen aren't

382 practically applied.

383 </p>

384 <p class="note">

385 Full details about extensions' ability to control <code>ChromeSetting</code>s

386 can be found under

387 <a href="types.html#ChromeSetting">

388 <code>chrome.types.ChromeSetting</code></a>.

389 </p>

390 <p>

391 This means that you ought to use the <code>get()</code> method to determine

392 your level of access, and then only call <code>set()</code> if your extension

393 can grab control over the setting (in fact if your extension can't control the

394 setting it's probably a good idea to visibly disable the functionality to

395 reduce user confusion):

396 </p>

397 <pre>chrome.privacy.services.autofillEnabled.get({}, function(details) {

398 if (details.levelOfControl === 'controllable_by_this_extension') {

399 chrome.privacy.services.autofillEnabled.set({ value: true }, function() {

400 if (chrome.extension.lastError === undefined)

401 console.log("Hooray, it worked!");

402 else

403 console.log("Sadness!", chrome.extension.lastError);

404 }

405 }

406 });</pre>

407 <p>

408 If you're interested in changes to a setting's value, add a listener to its

409 <code>onChange</code> event. Among other uses, this will allow you to warn the

410 user if a more recently installed extension grabs control of a setting, or if

411 enterprise policy overrides your control. To listen for changes to Autofill's

412 status, for example, the following code would suffice:

413 </p>

414 <pre>chrome.privacy.services.autofillEnabled.onChange.addListener(

415 function (details) {

416 // The new value is stored in `details.value`, the new level of control

417 // in `details.levelOfControl`, and `details.incognitoSpecific` will be

418 // `true` if the value is specific to Incognito mode.

419 });</pre>

420 <h2 id="examples">Examples</h2>

421 <p>

422 For example code, see the

423 <a href="samples.html#privacy">Privacy API samples</a>.

424 </p>

425 <!-- END AUTHORED CONTENT -->

426 </div>

427 <!-- API PAGE -->

428 <div class="apiPage">

429 <a name="apiReference"></a>

430 <h2>API reference: chrome.privacy</h2>

431 <!-- PROPERTIES -->

432 <div class="apiGroup">

433 <a name="properties"></a>

434 <h3 id="properties">Properties</h3>

435 <div>

436 <a name="property-network"></a>

437 <h4>network</h4>

438 <div class="summary">

439 <!-- Note: intentionally longer 80 columns -->

440 <span>chrome.privacy.</span><span>network</span>

441 </div>

442 <div>

443 <dt>

444 <var>network</var>

445 <em>

446 <!-- TYPE -->

447 <div style="display:inline">

448 (

449 <span id="typeTemplate">

450 <span>

451 <span>object</span>

452 </span>

453 </span>

454 )

455 </div>

456 </em>

457 </dt>

458 <dd>Settings that influence Chrome's handling of network connections i n general.</dd>

459 <!-- OBJECT PROPERTIES -->

460 <dd>

461 <dl>

462 <div>

463 <div>

464 <dt>

465 <var>networkPredictionEnabled</var>

466 <em>

467 <!-- TYPE -->

468 <div style="display:inline">

469 (

470 <span id="typeTemplate">

471 <span>

472 <a>types.ChromeSetting</a>

473 </span>

474 </span>

475 )

476 </div>

477 </em>

478 </dt>

479 <dd>If enabled, Chrome attempts to speed up your web browsing experien ce by pre-resolving DNS entries, prerendering sites (<code><link rel='prefetc h' ...></code>), and preemptively opening TCP and SSL connections to servers. This preference's value is a boolean, defaulting to <code>true</code>.</dd>

480 <!-- OBJECT PROPERTIES -->

481 <!-- OBJECT METHODS -->

482 <!-- OBJECT EVENT FIELDS -->

483 <!-- FUNCTION PARAMETERS -->

484 </div>

485 </div>

486 </dl>

487 </dd>

488 <!-- OBJECT METHODS -->

489 <!-- OBJECT EVENT FIELDS -->

490 <!-- FUNCTION PARAMETERS -->

491 </div>

492 </div><div>

493 <a name="property-services"></a>

494 <h4>services</h4>

495 <div class="summary">

496 <!-- Note: intentionally longer 80 columns -->

497 <span>chrome.privacy.</span><span>services</span>

498 </div>

499 <div>

500 <dt>

501 <var>services</var>

502 <em>

503 <!-- TYPE -->

504 <div style="display:inline">

505 (

506 <span id="typeTemplate">

507 <span>

508 <span>object</span>

509 </span>

510 </span>

511 )

512 </div>

513 </em>

514 </dt>

515 <dd>Settings that enable or disable features that require third-party network services provided by Google and your default search provider.</dd>

516 <!-- OBJECT PROPERTIES -->

517 <dd>

518 <dl>

519 <div>

520 <div>

521 <dt>

522 <var>alternateErrorPagesEnabled</var>

523 <em>

524 <!-- TYPE -->

525 <div style="display:inline">

526 (

527 <span id="typeTemplate">

528 <span>

529 <a>types.ChromeSetting</a>

530 </span>

531 </span>

532 )

533 </div>

534 </em>

535 </dt>

536 <dd>If enabled, Chrome uses a web service to help resolve navigation e rrors. This preference's value is a boolean, defaulting to <code>true</code>.</d d>

537 <!-- OBJECT PROPERTIES -->

538 <!-- OBJECT METHODS -->

539 <!-- OBJECT EVENT FIELDS -->

540 <!-- FUNCTION PARAMETERS -->

541 </div>

542 </div><div>

543 <div>

544 <dt>

545 <var>autofillEnabled</var>

546 <em>

547 <!-- TYPE -->

548 <div style="display:inline">

549 (

550 <span id="typeTemplate">

551 <span>

552 <a>types.ChromeSetting</a>

553 </span>

554 </span>

555 )

556 </div>

557 </em>

558 </dt>

559 <dd>If enabled, Chrome offers to automatically fill in forms. This pre ference's value is a boolean, defaulting to <code>true</code>.</dd>

560 <!-- OBJECT PROPERTIES -->

561 <!-- OBJECT METHODS -->

562 <!-- OBJECT EVENT FIELDS -->

563 <!-- FUNCTION PARAMETERS -->

564 </div>

565 </div><div>

566 <div>

567 <dt>

568 <var>instantEnabled</var>

569 <em>

570 <!-- TYPE -->

571 <div style="display:inline">

572 (

573 <span id="typeTemplate">

574 <span>

575 <a>types.ChromeSetting</a>

576 </span>

577 </span>

578 )

579 </div>

580 </em>

581 </dt>

582 <dd>If enabled, Chrome automatically performs and displays search requ ests for text you type into the Omnibox as you type it. This preference's value is a boolean, defaulting to <code>true</code>.</dd>

583 <!-- OBJECT PROPERTIES -->

584 <!-- OBJECT METHODS -->

585 <!-- OBJECT EVENT FIELDS -->

586 <!-- FUNCTION PARAMETERS -->

587 </div>

588 </div><div>

589 <div>

590 <dt>

591 <var>safeBrowsingEnabled</var>

592 <em>

593 <!-- TYPE -->

594 <div style="display:inline">

595 (

596 <span id="typeTemplate">

597 <span>

598 <a>types.ChromeSetting</a>

599 </span>

600 </span>

601 )

602 </div>

603 </em>

604 </dt>

605 <dd>If enabled, Chrome does its best to protect you from phishing and malware. This preference's value is a boolean, defaulting to <code>true</code>.< /dd>

606 <!-- OBJECT PROPERTIES -->

607 <!-- OBJECT METHODS -->

608 <!-- OBJECT EVENT FIELDS -->

609 <!-- FUNCTION PARAMETERS -->

610 </div>

611 </div><div>

612 <div>

613 <dt>

614 <var>searchSuggestEnabled</var>

615 <em>

616 <!-- TYPE -->

617 <div style="display:inline">

618 (

619 <span id="typeTemplate">

620 <span>

621 <a>types.ChromeSetting</a>

622 </span>

623 </span>

624 )

625 </div>

626 </em>

627 </dt>

628 <dd>If enabled, Chrome sends the text you type into the Omnibox to you r default search engine, which provides predictions of websites and searches tha t are likely completions of what you've typed so far. This preference's value is a boolean, defaulting to <code>true</code>.</dd>

629 <!-- OBJECT PROPERTIES -->

630 <!-- OBJECT METHODS -->

631 <!-- OBJECT EVENT FIELDS -->

632 <!-- FUNCTION PARAMETERS -->

633 </div>

634 </div><div>

635 <div>

636 <dt>

637 <var>spellingServiceEnabled</var>

638 <em>

639 <!-- TYPE -->

640 <div style="display:inline">

641 (

642 <span id="typeTemplate">

643 <span>

644 <a>types.ChromeSetting</a>

645 </span>

646 </span>

647 )

648 </div>

649 </em>

650 </dt>

651 <dd>If enabled, Chrome uses a web service to help correct spelling err ors. This preference's value is a boolean, defaulting to <code>false</code>.</dd >

652 <!-- OBJECT PROPERTIES -->

653 <!-- OBJECT METHODS -->

654 <!-- OBJECT EVENT FIELDS -->

655 <!-- FUNCTION PARAMETERS -->

656 </div>

657 </div><div>

658 <div>

659 <dt>

660 <var>translationServiceEnabled</var>

661 <em>

662 <!-- TYPE -->

663 <div style="display:inline">

664 (

665 <span id="typeTemplate">

666 <span>

667 <a>types.ChromeSetting</a>

668 </span>

669 </span>

670 )

671 </div>

672 </em>

673 </dt>

674 <dd>If enabled, Chrome offers to translate pages that aren't in a lang uage you read. This preference's value is a boolean, defaulting to <code>true</c ode>.</dd>

675 <!-- OBJECT PROPERTIES -->

676 <!-- OBJECT METHODS -->

677 <!-- OBJECT EVENT FIELDS -->

678 <!-- FUNCTION PARAMETERS -->

679 </div>

680 </div>

681 </dl>

682 </dd>

683 <!-- OBJECT METHODS -->

684 <!-- OBJECT EVENT FIELDS -->

685 <!-- FUNCTION PARAMETERS -->

686 </div>

687 </div><div>

688 <a name="property-websites"></a>

689 <h4>websites</h4>

690 <div class="summary">

691 <!-- Note: intentionally longer 80 columns -->

692 <span>chrome.privacy.</span><span>websites</span>

693 </div>

694 <div>

695 <dt>

696 <var>websites</var>

697 <em>

698 <!-- TYPE -->

699 <div style="display:inline">

700 (

701 <span id="typeTemplate">

702 <span>

703 <span>object</span>

704 </span>

705 </span>

706 )

707 </div>

708 </em>

709 </dt>

710 <dd>Settings that determine what information Chrome makes available to websites.</dd>

711 <!-- OBJECT PROPERTIES -->

712 <dd>

713 <dl>

714 <div>

715 <div>

716 <dt>

717 <var>thirdPartyCookiesAllowed</var>

718 <em>

719 <!-- TYPE -->

720 <div style="display:inline">

721 (

722 <span id="typeTemplate">

723 <span>

724 <a>types.ChromeSetting</a>

725 </span>

726 </span>

727 )

728 </div>

729 </em>

730 </dt>

731 <dd>If disabled, Chrome blocks third-party sites from setting cookies. The value of this preference is of type boolean, and the default value is <code >true</code>.</dd>

732 <!-- OBJECT PROPERTIES -->

733 <!-- OBJECT METHODS -->

734 <!-- OBJECT EVENT FIELDS -->

735 <!-- FUNCTION PARAMETERS -->

736 </div>

737 </div><div>

738 <div>

739 <dt>

740 <var>hyperlinkAuditingEnabled</var>

741 <em>

742 <!-- TYPE -->

743 <div style="display:inline">

744 (

745 <span id="typeTemplate">

746 <span>

747 <a>types.ChromeSetting</a>

748 </span>

749 </span>

750 )

751 </div>

752 </em>

753 </dt>

754 <dd>If enabled, Chrome sends auditing pings when requested by a websit e (<code><a ping></code>). The value of this preference is of type boolean , and the default value is <code>true</code>.</dd>

755 <!-- OBJECT PROPERTIES -->

756 <!-- OBJECT METHODS -->

757 <!-- OBJECT EVENT FIELDS -->

758 <!-- FUNCTION PARAMETERS -->

759 </div>

760 </div><div>

761 <div>

762 <dt>

763 <var>referrersEnabled</var>

764 <em>

765 <!-- TYPE -->

766 <div style="display:inline">

767 (

768 <span id="typeTemplate">

769 <span>

770 <a>types.ChromeSetting</a>

771 </span>

772 </span>

773 )

774 </div>

775 </em>

776 </dt>

777 <dd>If enabled, Chrome sends <code>referer</code> headers with your re quests. Yes, the name of this preference doesn't match the misspelled header. No , we're not going to change it. The value of this preference is of type boolean, and the default value is <code>true</code>.</dd>

778 <!-- OBJECT PROPERTIES -->

779 <!-- OBJECT METHODS -->

780 <!-- OBJECT EVENT FIELDS -->

781 <!-- FUNCTION PARAMETERS -->

782 </div>

783 </div><div>

784 <div>

785 <dt>

786 <var>protectedContentEnabled</var>

787 <em>

788 <!-- TYPE -->

789 <div style="display:inline">

790 (

791 <span id="typeTemplate">

792 <span>

793 <a href="types.html#type-ChromeSetting">ChromeSetting</a >

794 </span>

795 </span>

796 )

797 </div>

798 </em>

799 </dt>

800 <dd><strong>Available on ChromeOS only</strong>: If enabled, Chrome pr ovides a unique ID to plugins in order to run protected content. The value of th is preference is of type boolean, and the default value is <code>true</code>.</d d>

801 <!-- OBJECT PROPERTIES -->

802 <!-- OBJECT METHODS -->

803 <!-- OBJECT EVENT FIELDS -->

804 <!-- FUNCTION PARAMETERS -->

805 </div>

806 </div>

807 </dl>

808 </dd>

809 <!-- OBJECT METHODS -->

810 <!-- OBJECT EVENT FIELDS -->

811 <!-- FUNCTION PARAMETERS -->

812 </div>

813 </div>

814 </div> <!-- /apiGroup -->

815 <!-- METHODS -->

816 <!-- /apiGroup -->

817 <!-- EVENTS -->

818 <!-- /apiGroup -->

819 <!-- TYPES -->

820 <!-- /apiGroup -->

821 </div> <!-- /apiPage -->

822 </div> <!-- /gc-pagecontent -->

823 </div> <!-- /g-section -->

824 </div> <!-- /codesiteContent -->

825 <div id="gc-footer" --="">

826 <div class="text">

827 <p>

828 Except as otherwise <a href="http://code.google.com/policies.html#restrictions ">noted</a>,

829 the content of this page is licensed under the <a rel="license" href="http://c reativecommons.org/licenses/by/3.0/">Creative Commons

830 Attribution 3.0 License</a>, and code samples are licensed under the

831 <a rel="license" href="http://code.google.com/google_bsd_license.html">BSD Lic ense</a>.

832 </p>

833 <p>

834 ©2011 Google

835 </p>

836 <!-- begin analytics -->

837 <script src="https://www.google-analytics.com/urchin.js" type="text/javascript"> </script>

838 <script src="https://www.google-analytics.com/ga.js" type="text/javascript"></sc ript>

839 <script type="text/javascript">

840 // chrome doc tracking

841 try {

842 var engdocs = _gat._getTracker("YT-10763712-2");

843 engdocs._trackPageview();

844 } catch(err) {}

845 // code.google.com site-wide tracking

846 try {

847 _uacct="UA-18071-1";

848 _uanchor=1;

849 _uff=0;

850 urchinTracker();

851 }

852 catch(e) {/* urchinTracker not available. */}

853 </script>

854 <!-- end analytics -->

855 </div>

856 </div> <!-- /gc-footer -->

857 </div> <!-- /gc-container -->

858 </body></html>

OLD	NEW