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

Unified Diff: chrome/common/extensions/docs/static/privacy.html

Issue 9244005: Move the `privacy` extension API out of experimental. (Closed) Base URL: http://git.chromium.org/git/chromium.git@trunk
Patch Set: The other permissions warning page. Created 8 years, 11 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 side-by-side diff with in-line comments
Download patch
Index: chrome/common/extensions/docs/static/privacy.html
diff --git a/chrome/common/extensions/docs/static/privacy.html b/chrome/common/extensions/docs/static/privacy.html
new file mode 100644
index 0000000000000000000000000000000000000000..4d2e481e2d3635e4071d28cd78c3f5990b759692
--- /dev/null
+++ b/chrome/common/extensions/docs/static/privacy.html
@@ -0,0 +1,101 @@
+<div id="pageData-name" class="pageData">Privacy</div>
+
+<!-- BEGIN AUTHORED CONTENT -->
+<p id="classSummary">
+ Use the <code>chrome.privacy</code> module to control usage of the features in
+ Chrome that can affect a user's privacy. This module relies on the
+ <a href="types.html#ChromeSetting">ChromeSetting prototype of the type API</a>
+ for getting and setting Chrome's configuration.
+</p>
+
+<p class="note">
+ The <a href="http://www.google.com/intl/en/landing/chrome/google-chrome-privacy-whitepaper.pdf">Chrome Privacy Whitepaper</a>
+ gives background detail regarding the features which this API can control.
+</p>
+
+<h2 id="manifest">Manifest</h2>
+<p>
+ You must declare the "privacy" permission in your extension's
+ <a href="manifest.html"> manifest</a> to use the API. For example:
battre 2012/01/24 12:29:18 nit: remove space before manifest
Mike West 2012/01/24 13:49:33 Done.
+</p>
+
+<pre>{
+ "name": "My extension",
+ ...
+ <b>"permissions": [
+ "privacy"
+ ]</b>,
+ ...
+}</pre>
+
+<h2 id="usage">Usage</h2>
+
+<p>
+ Reading the current value of a Chrome setting is straightforward. You'll first
+ need to find the property you're interested in, then you'll call
+ <code>get()</code> on that object in order to retrieve it's current value and
+ your extension's level of control. For example, to determine if Chrome's
+ Autofill feature is enabled, you'd write:
+</p>
+
+<pre>chrome.privacy.services.autofillEnabled.get({}, function(details) {
+ if (details.value)
+ console.log('Autofill is on!');
+ else
+ console.log('Autofill is off!');
+});</pre>
+
+<p>
+ Changing the value of a setting is a little bit more complex, simply because
+ you first must verify that your extension can control the setting. Chrome will
+ deny access to a setting if the setting is either locked to a specific value
battre 2012/01/24 12:29:18 technically, it won't deny access but only ignore
Mike West 2012/01/24 13:49:33 Gah. Complexity. Done.
+ by enterprise policies (<code>levelOfControl</code> will be set to
+ "not_controllable"), or if another extension is controlling the value
+ (<code>levelOfControl</code> will be set to "controlled_by_other_extensions").
+</p>
+
+<p class="note">
+ Full details about extension's ability to control <code>ChromeSetting</code>s
battre 2012/01/24 12:29:18 nit: "about *an* extension's" or "about extensions
Mike West 2012/01/24 13:49:33 The latter. Done. :)
+ can be found under
+ <a href="types.html#ChromeSetting">
+ <code>chrome.types.ChromeSetting</code></a>.
+</p>
+
+<p>
+ This means that you'll need to use the <code>get()</code> method to determine
+ your level of access, and then only call <code>set()</code> if your extension
+ can grab control over the setting:
battre 2012/01/24 12:29:18 not necessary, see above. It is still good practic
Mike West 2012/01/24 13:49:33 Done.
+</p>
+
+<pre>chrome.privacy.services.autofillEnabled.get({}, function(details) {
+ if (details.levelOfControl === 'controllable_by_this_extension') {
+ chrome.privacy.services.autofillEnabled.set({ value: true }, function() {
+ if (chrome.extension.lastError === undefined)
+ console.log("Hooray, it worked!");
+ else
+ console.log("Sadness!", chrome.extension.lastError);
+ }
+ }
+});</pre>
+
+<p>
+ If you're interested in changes to a setting's value, add a listener to its
+ <code>onChange</code> event. Among other uses, this will allow you to warn the
+ user if a more recently installed extension grabs control of a setting, or if
+ enterprise policy overrides your control. To listen for changes to Autofill's
+ status, for example, the following code would suffice:
+</p>
+
+<pre>chrome.privacy.services.autofillEnabled.onChange.addListener(
+ function (details) {
+ // The new value is stored in `details.value`, the new level of control
+ // in `details.levelOfControl`, and `details.incognitoSpecific` will be
+ // `true` if the value is specific to Incognito mode.
+ });</pre>
+
+<h2 id="examples">Examples</h2>
+<p>
+ For example code, see the
+ <a href="samples.html#privacy">Privacy API samples</a>.
+</p>
+<!-- END AUTHORED CONTENT -->

Powered by Google App Engine
This is Rietveld 408576698