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

Unified Diff: chrome/common/extensions/docs/permissions.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 side-by-side diff with in-line comments
Download patch
« no previous file with comments | « chrome/common/extensions/docs/permission_warnings.html ('k') | chrome/common/extensions/docs/privacy.html » ('j') | no next file with comments »
Expand Comments ('e') | Collapse Comments ('c') | Show Comments Hide Comments ('s')
Index: chrome/common/extensions/docs/permissions.html
diff --git a/chrome/common/extensions/docs/permissions.html b/chrome/common/extensions/docs/permissions.html
deleted file mode 100644
index 1cf42f1732a6f817bbe8a301a9294aad606a3632..0000000000000000000000000000000000000000
--- a/chrome/common/extensions/docs/permissions.html
+++ /dev/null
@@ -1,1069 +0,0 @@
-<!DOCTYPE html><!-- This page is a placeholder for generated extensions api doc. Note:
- 1) The <head> information in this page is significant, should be uniform
- across api docs and should be edited only with knowledge of the
- templating mechanism.
- 3) All <body>.innerHTML is genereated as an rendering step. If viewed in a
- browser, it will be re-generated from the template, json schema and
- authored overview content.
- 4) The <body>.innerHTML is also generated by an offline step so that this
- page may easily be indexed by search engines.
---><html xmlns="http://www.w3.org/1999/xhtml"><head>
- <meta http-equiv="Content-Type" content="text/html; charset=UTF-8">
- <link href="css/ApiRefStyles.css" rel="stylesheet" type="text/css">
- <link href="css/print.css" rel="stylesheet" type="text/css" media="print">
- <script type="text/javascript" src="../../../third_party/jstemplate/jstemplate_compiled.js">
- </script>
- <script type="text/javascript" src="../../../../third_party/json_minify/minify-sans-regexp.js">
- </script>
- <script type="text/javascript" src="js/api_page_generator.js"></script>
- <script type="text/javascript" src="js/bootstrap.js"></script>
- <script type="text/javascript" src="js/sidebar.js"></script>
- <meta name="description" content="Documentation for the chrome.permissions module, which is part of the Google Chrome extension APIs."><title>Optional Permissions - Google Chrome Extensions - Google Code</title></head>
- <body> <div id="devModeWarning" class="displayModeWarning">
- You are viewing extension docs in chrome via the 'file:' scheme: are you expecting to see local changes when you refresh? You'll need run chrome with --allow-file-access-from-files.
- </div>
- <div id="branchWarning" class="displayModeWarning">
- <span>WARNING: This is the <span id="branchName">BETA</span> documentation.
- It may not work with the stable release of Chrome.</span>
- <select id="branchChooser">
- <option>Choose a different version...
- </option><option value="">Stable
- </option><option value="beta">Beta
- </option><option value="dev">Dev
- </option><option value="trunk">Trunk
- </option></select>
- </div>
- <div id="unofficialWarning" class="displayModeWarning">
- <span>WARNING: This is unofficial documentation. It may not work with the
- current release of Chrome.</span>
- <button id="goToOfficialDocs">Go to the official docs</button>
- </div>
- <div id="gc-container" class="labs">
- <!-- SUBTEMPLATES: DO NOT MOVE FROM THIS LOCATION -->
- <!-- In particular, sub-templates that recurse, must be used by allowing
- jstemplate to make a copy of the template in this section which
- are not operated on by way of the jsskip="true" -->
- <!-- /SUBTEMPLATES -->
- <a id="top"></a>
- <div id="skipto">
- <a href="#gc-pagecontent">Skip to page content</a>
- <a href="#gc-toc">Skip to main navigation</a>
- </div>
- <!-- API HEADER -->
- <table id="header" width="100%" cellspacing="0" border="0">
- <tbody><tr>
- <td valign="middle"><a href="http://code.google.com/"><img src="images/code_labs_logo.gif" height="43" width="161" alt="Google Code Labs" style="border:0; margin:0;"></a></td>
- <td valign="middle" width="100%" style="padding-left:0.6em;">
- <form action="http://www.google.com/cse" id="cse" style="margin-top:0.5em">
- <div id="gsc-search-box">
- <input type="hidden" name="cx" value="002967670403910741006:61_cvzfqtno">
- <input type="hidden" name="ie" value="UTF-8">
- <input type="text" name="q" value="" size="55">
- <input class="gsc-search-button" type="submit" name="sa" value="Search">
- <br>
- <span class="greytext">e.g. "page action" or "tabs"</span>
- </div>
- </form>
- <script type="text/javascript" src="https://www.google.com/jsapi"></script>
- <script type="text/javascript">google.load("elements", "1", {packages: "transliteration"});</script>
- <script type="text/javascript" src="https://www.google.com/coop/cse/t13n?form=cse&amp;t13n_langs=en"></script>
- <script type="text/javascript" src="https://www.google.com/coop/cse/brand?form=cse&amp;lang=en"></script>
- </td>
- </tr>
- </tbody></table>
- <div id="codesiteContent" class="">
- <a id="gc-topnav-anchor"></a>
- <div id="gc-topnav">
- <h1>Google Chrome Extensions (<a href="http://code.google.com/labs/">Labs</a>)</h1>
- <ul id="home" class="gc-topnav-tabs">
- <li id="home_link">
- <a href="index.html" title="Google Chrome Extensions home page">Home</a>
- </li>
- <li id="docs_link">
- <a href="docs.html" title="Official Google Chrome Extensions documentation">Docs</a>
- </li>
- <li id="faq_link">
- <a href="faq.html" title="Answers to frequently asked questions about Google Chrome Extensions">FAQ</a>
- </li>
- <li id="samples_link">
- <a href="samples.html" title="Sample extensions (with source code)">Samples</a>
- </li>
- <li id="group_link">
- <a href="http://groups.google.com/a/chromium.org/group/chromium-extensions" title="Google Chrome Extensions developer forum">Group</a>
- </li>
- <li id="so_link">
- <a href="http://stackoverflow.com/questions/tagged/google-chrome-extension" title="[google-chrome-extension] tag on Stack Overflow">Questions?</a>
- </li>
- </ul>
- </div> <!-- end gc-topnav -->
- <div class="g-section g-tpl-170">
- <!-- SIDENAV -->
- <div class="g-unit g-first" id="gc-toc">
- <ul>
- <li><a href="getstarted.html">Getting Started</a></li>
- <li><a href="overview.html">Overview</a></li>
- <li><a href="whats_new.html">What's New?</a></li>
- <li><h2><a href="devguide.html">Developer's Guide</a></h2>
- <ul>
- <li>Browser UI
- <ul>
- <li><a href="browserAction.html">Browser Actions</a></li>
- <li><a href="contextMenus.html">Context Menus</a></li>
- <li><a href="notifications.html">Desktop Notifications</a></li>
- <li><a href="omnibox.html">Omnibox</a></li>
- <li><a href="options.html">Options Pages</a></li>
- <li><a href="override.html">Override Pages</a></li>
- <li><a href="pageAction.html">Page Actions</a></li>
- </ul>
- </li>
- <li>Browser Interaction
- <ul>
- <li><a href="bookmarks.html">Bookmarks</a></li>
- <li><a href="cookies.html">Cookies</a></li>
- <li><a href="devtools.html">Developer Tools</a></li>
- <li><a href="events.html">Events</a></li>
- <li><a href="history.html">History</a></li>
- <li><a href="management.html">Management</a></li>
- <li><a href="tabs.html">Tabs</a></li>
- <li><a href="windows.html">Windows</a></li>
- </ul>
- </li>
- <li>Implementation
- <ul>
- <li><a href="a11y.html">Accessibility</a></li>
- <li><a href="background_pages.html">Background Pages</a></li>
- <li><a href="content_scripts.html">Content Scripts</a></li>
- <li><a href="xhr.html">Cross-Origin XHR</a></li>
- <li><a href="i18n.html">Internationalization</a></li>
- <li><a href="messaging.html">Message Passing</a></li>
- <li class="leftNavSelected">Optional Permissions</li>
- <li><a href="npapi.html">NPAPI Plugins</a></li>
- </ul>
- </li>
- <li>Finishing
- <ul>
- <li><a href="hosting.html">Hosting</a></li>
- <li><a href="external_extensions.html">Other Deployment Options</a></li>
- </ul>
- </li>
- </ul>
- </li>
- <li><h2><a href="apps.html">Packaged Apps</a></h2></li>
- <li><h2><a href="tutorials.html">Tutorials</a></h2>
- <ul>
- <li><a href="tut_debugging.html">Debugging</a></li>
- <li><a href="tut_analytics.html">Google Analytics</a></li>
- <li><a href="tut_oauth.html">OAuth</a></li>
- </ul>
- </li>
- <li><h2>Reference</h2>
- <ul>
- <li>Formats
- <ul>
- <li><a href="manifest.html">Manifest Files</a></li>
- <li><a href="match_patterns.html">Match Patterns</a></li>
- </ul>
- </li>
- <li><a href="permission_warnings.html">Permission Warnings</a></li>
- <li><a href="api_index.html">chrome.* APIs</a></li>
- <li><a href="api_other.html">Other APIs</a></li>
- </ul>
- </li>
- <li><h2><a href="samples.html">Samples</a></h2></li>
- <div class="line"> </div>
- <li><h2>More</h2>
- <ul>
- <li><a href="http://code.google.com/chrome/webstore/docs/index.html">Chrome Web Store</a></li>
- <li><a href="http://code.google.com/chrome/apps/docs/developers_guide.html">Hosted Apps</a></li>
- <li><a href="themes.html">Themes</a></li>
- </ul>
- </li>
- </ul>
- </div>
- <script>
- initToggles();
- </script>
- <div class="g-unit" id="gc-pagecontent">
- <div id="pageTitle">
- <h1 class="page_title">Optional Permissions</h1>
- </div>
- <!-- TABLE OF CONTENTS -->
- <div id="toc">
- <h2>Contents</h2>
- <ol>
- <li>
- <a href="#howto"> Implementing optional permissions </a>
- <ol>
- <li>
- <a href="#types">
- Step 1: Decide which permissions are optional and required
-</a>
- </li><li>
- <a href="#manifest"> Step 2: Declare optional permissions in the manifest </a>
- </li><li>
- <a href="#request"> Step 3: Request optional permissions </a>
- </li><li>
- <a href="#contains"> Step 4: Check the extension's current permissions </a>
- </li><li>
- <a href="#remove"> Step 5: Remove the permissions </a>
- </li>
- </ol>
- </li>
- <li>
- <a href="#apiReference">API reference: chrome.permissions</a>
- <ol>
- <li>
- <a href="#global-methods">Methods</a>
- <ol>
- <li>
- <a href="#method-contains">contains</a>
- </li><li>
- <a href="#method-getAll">getAll</a>
- </li><li>
- <a href="#method-remove">remove</a>
- </li><li>
- <a href="#method-request">request</a>
- </li>
- </ol>
- </li>
- <li>
- <a href="#global-events">Events</a>
- <ol>
- <li>
- <a href="#event-onAdded">onAdded</a>
- </li><li>
- <a href="#event-onRemoved">onRemoved</a>
- </li>
- </ol>
- </li>
- <li>
- <a href="#types">Types</a>
- <ol>
- <li>
- <a href="#type-Permissions">Permissions</a>
- <ol>
- </ol>
- </li>
- </ol>
- </li>
- </ol>
- </li>
- </ol>
- </div>
- <!-- /TABLE OF CONTENTS -->
- <!-- Standard content lead-in for experimental API pages -->
- <!-- STATIC CONTENT PLACEHOLDER -->
- <div id="static"><div id="pageData-name" class="pageData">Optional Permissions</div>
-<!-- BEGIN AUTHORED CONTENT -->
-<p id="classSummary">
- Use the <code>chrome.permissions</code> module to implement
- optional permissions. You can request optional permissions during your
- extension's regular application flow rather than at install time, so users
- understand why the permissions are needed and use only those that are
- necessary.
-</p>
-<p>
- For general information about permissions and details about each permission,
- see the <a href="manifest.html#permissions">permissions</a> section of the
- manifest documentation.
-</p>
-<h2 id="howto"> Implementing optional permissions </h2>
-<h3 id="types">
- Step 1: Decide which permissions are optional and required
-</h3>
-<p>
- Extensions should generally require permissions when they are needed for the
- extension's basic functionality and employ optional permissions for optional
- features.
-</p>
-<p>
- Advantages of optional permissions:
- </p><ul>
- <li>
- Users run with less permissions since they enable only what is needed.
- </li>
- <li>
- The extension can help explain why it needs particular permissions by
- requesting them when the user enables the relevant feature.
- </li>
- <li>
- Chrome can avoid disabling extensions that upgrade if they add permissions
- as optional rather than required.
- </li>
- </ul>
-<p></p>
-<p>
- Advantages of required permissions:
- </p><ul>
- <li>
- The extension can prompt the user once to accept all permissions.
- </li>
- <li>
- They simplify extension development by guaranteeing which permissions are
- present.
- </li>
- </ul>
-<p></p>
-<h3 id="manifest"> Step 2: Declare optional permissions in the manifest </h3>
-<p>
- Declare optional permissions in your <a href="manifest.html">extension
- manifest</a> with the <code>optional_permissions</code> key, using the
- same format as the <a href="manifest.html#permissions">permissions</a>
- field:
-</p><pre>{
- "name": "My extension",
- ...
- <b>"optional_permissions": [ "tabs", "http://www.google.com/" ],</b>
- ...
-}</pre>
-<p></p>
-<p>
-You can specify any of the following as optional permissions:
-</p><ul>
- <li><i>host permissions</i></li>
- <li>appNotifications</li>
- <li>background</li>
- <li>bookmarks</li>
- <li>clipboardRead</li>
- <li>clipboardWrite</li>
- <li>contentSettings</li>
- <li>contextMenus</li>
- <li>cookies</li>
- <li>debugger</li>
- <li>history</li>
- <li>idle</li>
- <li>management</li>
- <li>notifications</li>
- <li>pageCapture</li>
- <li>tabs</li>
- <li>topSites</li>
- <li>webNavigation</li>
- <li>webRequest</li>
- <li>webRequestBlocking</li>
-</ul>
-<p></p>
-<p class="note">
- <b>Version note:</b> This list is correct as of Chrome 17.
- More optional permissions might be allowed in future releases.
-</p>
-<h3 id="request"> Step 3: Request optional permissions </h3>
-<p>
- Request the permissions from within a user gesture using
- <code>permissions.request()</code>:
-</p><pre>document.querySelector('#my-button').addEventListener('click', function(event) {
- // Permissions must be requested from inside a user gesture, like a button's
- // click handler.
- chrome.permissions.request({
- permissions: ['tabs'],
- origins: ['http://www.google.com/']
- }, function(granted) {
- // The callback argument will be true if the user granted the permissions.
- if (granted) {
- doSomething();
- } else {
- doSomethingElse();
- }
- });
-});
-</pre>
-<p></p>
-<p>
- Chrome prompts the user if adding the permissions results in different
- <a href="permission_warnings.html">warning messages</a> than the user has
- already seen and accepted. For example, the previous code might result in
- a prompt like this:
-</p>
-<p style="text-align: center">
- <img src="images/perms-optional.png" alt="example permission confirmation prompt" width="416" height="234">
-</p>
-<h3 id="contains"> Step 4: Check the extension's current permissions </h3>
-<p>
- To check whether your extension has a specific permission or set of
- permissions, use <code>permission.contains()</code>:
-</p>
-<pre>chrome.permissions.contains({
- permissions: ['tabs'],
- origins: ['http://www.google.com/']
-}, function(result) {
- if (result) {
- // The extension has the permissions.
- } else {
- // The extension doesn't have the permissions.
- }
-});
-</pre>
-<h3 id="remove"> Step 5: Remove the permissions </h3>
-<p>
- You should remove permissions when you no longer need them.
- After a permission has been removed, calling
- <code>permissions.request()</code> usually adds the permission back without
- prompting the user.
-</p>
-<pre>chrome.permissions.remove({
- permissions: ['tabs'],
- origins: ['http://www.google.com/']
-}, function(removed) {
- if (removed) {
- // The permissions have been removed.
- } else {
- // The permissions have not been removed (e.g., you tried to remove
- // required permissions).
- }
-});
-</pre>
-<!-- END AUTHORED CONTENT -->
-</div>
- <!-- API PAGE -->
- <div class="apiPage">
- <a name="apiReference"></a>
- <h2>API reference: chrome.permissions</h2>
- <!-- PROPERTIES -->
- <!-- /apiGroup -->
- <!-- METHODS -->
- <div id="methodsTemplate" class="apiGroup">
- <a name="global-methods"></a>
- <h3>Methods</h3>
- <!-- iterates over all functions -->
- <div class="apiItem">
- <a name="method-contains"></a> <!-- method-anchor -->
- <h4>contains</h4>
- <div class="summary">
- <!-- Note: intentionally longer 80 columns -->
- <span>chrome.permissions.contains</span>(<span class="null"><span>Permissions</span>
- <var><span>permissions</span></var></span><span class="null"><span>, </span><span>function</span>
- <var><span>callback</span></var></span>)</div>
- <div class="description">
- <p>Checks if the extension has the specified permissions.</p>
- <!-- PARAMETERS -->
- <h4>Parameters</h4>
- <dl>
- <div>
- <div>
- <dt>
- <var>permissions</var>
- <em>
- <!-- TYPE -->
- <div style="display:inline">
- (
- <span id="typeTemplate">
- <span>
- <a href="permissions.html#type-Permissions">Permissions</a>
- </span>
- </span>
- )
- </div>
- </em>
- </dt>
- <dd class="todo">
- Undocumented.
- </dd>
- <!-- OBJECT PROPERTIES -->
- <!-- OBJECT METHODS -->
- <!-- OBJECT EVENT FIELDS -->
- <!-- FUNCTION PARAMETERS -->
- </div>
- </div><div>
- <div>
- <dt>
- <var>callback</var>
- <em>
- <!-- TYPE -->
- <div style="display:inline">
- (
- <span id="typeTemplate">
- <span>
- <span>function</span>
- </span>
- </span>
- )
- </div>
- </em>
- </dt>
- <dd class="todo">
- Undocumented.
- </dd>
- <!-- OBJECT PROPERTIES -->
- <!-- OBJECT METHODS -->
- <!-- OBJECT EVENT FIELDS -->
- <!-- FUNCTION PARAMETERS -->
- </div>
- </div>
- </dl>
- <!-- RETURNS -->
- <dl>
- </dl>
- <!-- CALLBACK -->
- <div>
- <div>
- <h4>Callback function</h4>
- <p>
- The <em>callback</em> parameter should specify a function
- that looks like this:
- </p>
- <!-- Note: intentionally longer 80 columns -->
- <pre>function(<span>boolean result</span>) <span class="subdued">{...}</span>;</pre>
- <dl>
- <div>
- <div>
- <dt>
- <var>result</var>
- <em>
- <!-- TYPE -->
- <div style="display:inline">
- (
- <span id="typeTemplate">
- <span>
- <span>boolean</span>
- </span>
- </span>
- )
- </div>
- </em>
- </dt>
- <dd>True if the extension has the specified permissions.</dd>
- <!-- OBJECT PROPERTIES -->
- <!-- OBJECT METHODS -->
- <!-- OBJECT EVENT FIELDS -->
- <!-- FUNCTION PARAMETERS -->
- </div>
- </div>
- </dl>
- </div>
- </div>
- <!-- MIN_VERSION -->
- </div> <!-- /description -->
- </div><div class="apiItem">
- <a name="method-getAll"></a> <!-- method-anchor -->
- <h4>getAll</h4>
- <div class="summary">
- <!-- Note: intentionally longer 80 columns -->
- <span>chrome.permissions.getAll</span>(<span class="null"><span>function</span>
- <var><span>callback</span></var></span>)</div>
- <div class="description">
- <p>Gets the extension's current set of permissions.</p>
- <!-- PARAMETERS -->
- <h4>Parameters</h4>
- <dl>
- <div>
- <div>
- <dt>
- <var>callback</var>
- <em>
- <!-- TYPE -->
- <div style="display:inline">
- (
- <span id="typeTemplate">
- <span>
- <span>function</span>
- </span>
- </span>
- )
- </div>
- </em>
- </dt>
- <dd class="todo">
- Undocumented.
- </dd>
- <!-- OBJECT PROPERTIES -->
- <!-- OBJECT METHODS -->
- <!-- OBJECT EVENT FIELDS -->
- <!-- FUNCTION PARAMETERS -->
- </div>
- </div>
- </dl>
- <!-- RETURNS -->
- <dl>
- </dl>
- <!-- CALLBACK -->
- <div>
- <div>
- <h4>Callback function</h4>
- <p>
- The <em>callback</em> parameter should specify a function
- that looks like this:
- </p>
- <!-- Note: intentionally longer 80 columns -->
- <pre>function(<span>Permissions permissions</span>) <span class="subdued">{...}</span>;</pre>
- <dl>
- <div>
- <div>
- <dt>
- <var>permissions</var>
- <em>
- <!-- TYPE -->
- <div style="display:inline">
- (
- <span id="typeTemplate">
- <span>
- <a href="permissions.html#type-Permissions">Permissions</a>
- </span>
- </span>
- )
- </div>
- </em>
- </dt>
- <dd>The extension's active permissions.</dd>
- <!-- OBJECT PROPERTIES -->
- <!-- OBJECT METHODS -->
- <!-- OBJECT EVENT FIELDS -->
- <!-- FUNCTION PARAMETERS -->
- </div>
- </div>
- </dl>
- </div>
- </div>
- <!-- MIN_VERSION -->
- </div> <!-- /description -->
- </div><div class="apiItem">
- <a name="method-remove"></a> <!-- method-anchor -->
- <h4>remove</h4>
- <div class="summary">
- <!-- Note: intentionally longer 80 columns -->
- <span>chrome.permissions.remove</span>(<span class="null"><span>Permissions</span>
- <var><span>permissions</span></var></span><span class="optional"><span>, </span><span>function</span>
- <var><span>callback</span></var></span>)</div>
- <div class="description">
- <p>Removes access to the specified permissions. If there are any problems removing the permissions, <a href="extension.html#property-lastError">chrome.extension.lastError</a> will be set.</p>
- <!-- PARAMETERS -->
- <h4>Parameters</h4>
- <dl>
- <div>
- <div>
- <dt>
- <var>permissions</var>
- <em>
- <!-- TYPE -->
- <div style="display:inline">
- (
- <span id="typeTemplate">
- <span>
- <a href="permissions.html#type-Permissions">Permissions</a>
- </span>
- </span>
- )
- </div>
- </em>
- </dt>
- <dd class="todo">
- Undocumented.
- </dd>
- <!-- OBJECT PROPERTIES -->
- <!-- OBJECT METHODS -->
- <!-- OBJECT EVENT FIELDS -->
- <!-- FUNCTION PARAMETERS -->
- </div>
- </div><div>
- <div>
- <dt>
- <var>callback</var>
- <em>
- <!-- TYPE -->
- <div style="display:inline">
- (
- <span class="optional">optional</span>
- <span id="typeTemplate">
- <span>
- <span>function</span>
- </span>
- </span>
- )
- </div>
- </em>
- </dt>
- <dd class="todo">
- Undocumented.
- </dd>
- <!-- OBJECT PROPERTIES -->
- <!-- OBJECT METHODS -->
- <!-- OBJECT EVENT FIELDS -->
- <!-- FUNCTION PARAMETERS -->
- </div>
- </div>
- </dl>
- <!-- RETURNS -->
- <dl>
- </dl>
- <!-- CALLBACK -->
- <div>
- <div>
- <h4>Callback function</h4>
- <p>
- If you specify the <em>callback</em> parameter, it should
- specify a function that looks like this:
- </p>
- <!-- Note: intentionally longer 80 columns -->
- <pre>function(<span>boolean removed</span>) <span class="subdued">{...}</span>;</pre>
- <dl>
- <div>
- <div>
- <dt>
- <var>removed</var>
- <em>
- <!-- TYPE -->
- <div style="display:inline">
- (
- <span id="typeTemplate">
- <span>
- <span>boolean</span>
- </span>
- </span>
- )
- </div>
- </em>
- </dt>
- <dd>True if the permissions were removed.</dd>
- <!-- OBJECT PROPERTIES -->
- <!-- OBJECT METHODS -->
- <!-- OBJECT EVENT FIELDS -->
- <!-- FUNCTION PARAMETERS -->
- </div>
- </div>
- </dl>
- </div>
- </div>
- <!-- MIN_VERSION -->
- </div> <!-- /description -->
- </div><div class="apiItem">
- <a name="method-request"></a> <!-- method-anchor -->
- <h4>request</h4>
- <div class="summary">
- <!-- Note: intentionally longer 80 columns -->
- <span>chrome.permissions.request</span>(<span class="null"><span>Permissions</span>
- <var><span>permissions</span></var></span><span class="optional"><span>, </span><span>function</span>
- <var><span>callback</span></var></span>)</div>
- <div class="description">
- <p>Requests access to the specified permissions. These permissions must be defined in the optional_permissions field of the manifest. If there are any problems requesting the permissions, <a href="extension.html#property-lastError">chrome.extension.lastError</a> will be set.</p>
- <!-- PARAMETERS -->
- <h4>Parameters</h4>
- <dl>
- <div>
- <div>
- <dt>
- <var>permissions</var>
- <em>
- <!-- TYPE -->
- <div style="display:inline">
- (
- <span id="typeTemplate">
- <span>
- <a href="permissions.html#type-Permissions">Permissions</a>
- </span>
- </span>
- )
- </div>
- </em>
- </dt>
- <dd class="todo">
- Undocumented.
- </dd>
- <!-- OBJECT PROPERTIES -->
- <!-- OBJECT METHODS -->
- <!-- OBJECT EVENT FIELDS -->
- <!-- FUNCTION PARAMETERS -->
- </div>
- </div><div>
- <div>
- <dt>
- <var>callback</var>
- <em>
- <!-- TYPE -->
- <div style="display:inline">
- (
- <span class="optional">optional</span>
- <span id="typeTemplate">
- <span>
- <span>function</span>
- </span>
- </span>
- )
- </div>
- </em>
- </dt>
- <dd class="todo">
- Undocumented.
- </dd>
- <!-- OBJECT PROPERTIES -->
- <!-- OBJECT METHODS -->
- <!-- OBJECT EVENT FIELDS -->
- <!-- FUNCTION PARAMETERS -->
- </div>
- </div>
- </dl>
- <!-- RETURNS -->
- <dl>
- </dl>
- <!-- CALLBACK -->
- <div>
- <div>
- <h4>Callback function</h4>
- <p>
- If you specify the <em>callback</em> parameter, it should
- specify a function that looks like this:
- </p>
- <!-- Note: intentionally longer 80 columns -->
- <pre>function(<span>boolean granted</span>) <span class="subdued">{...}</span>;</pre>
- <dl>
- <div>
- <div>
- <dt>
- <var>granted</var>
- <em>
- <!-- TYPE -->
- <div style="display:inline">
- (
- <span id="typeTemplate">
- <span>
- <span>boolean</span>
- </span>
- </span>
- )
- </div>
- </em>
- </dt>
- <dd>True if the user granted the specified permissions.</dd>
- <!-- OBJECT PROPERTIES -->
- <!-- OBJECT METHODS -->
- <!-- OBJECT EVENT FIELDS -->
- <!-- FUNCTION PARAMETERS -->
- </div>
- </div>
- </dl>
- </div>
- </div>
- <!-- MIN_VERSION -->
- </div> <!-- /description -->
- </div> <!-- /apiItem -->
- </div> <!-- /apiGroup -->
- <!-- EVENTS -->
- <div id="eventsTemplate" class="apiGroup">
- <a name="global-events"></a>
- <h3>Events</h3>
- <!-- iterates over all events -->
- <div class="apiItem">
- <a name="event-onAdded"></a>
- <h4>onAdded</h4>
- <div class="summary">
- <!-- Note: intentionally longer 80 columns -->
- <span class="subdued">chrome.permissions.</span><span>onAdded</span><span class="subdued">.addListener</span>(function(<span>Permissions permissions</span>) <span class="subdued">{...}</span><span></span>);
- </div>
- <div class="description">
- <p>Fired when the extension acquires new permissions.</p>
- <!-- LISTENER PARAMETERS -->
- <div>
- <h4>Listener parameters</h4>
- <dl>
- <div>
- <div>
- <dt>
- <var>permissions</var>
- <em>
- <!-- TYPE -->
- <div style="display:inline">
- (
- <span id="typeTemplate">
- <span>
- <a href="permissions.html#type-Permissions">Permissions</a>
- </span>
- </span>
- )
- </div>
- </em>
- </dt>
- <dd>The newly acquired permissions.</dd>
- <!-- OBJECT PROPERTIES -->
- <!-- OBJECT METHODS -->
- <!-- OBJECT EVENT FIELDS -->
- <!-- FUNCTION PARAMETERS -->
- </div>
- </div>
- </dl>
- </div>
- <!-- EXTRA PARAMETERS -->
- <!-- LISTENER RETURN VALUE -->
- <dl>
- </dl>
- </div> <!-- /description -->
- <!-- /description -->
- </div><div class="apiItem">
- <a name="event-onRemoved"></a>
- <h4>onRemoved</h4>
- <div class="summary">
- <!-- Note: intentionally longer 80 columns -->
- <span class="subdued">chrome.permissions.</span><span>onRemoved</span><span class="subdued">.addListener</span>(function(<span>Permissions permissions</span>) <span class="subdued">{...}</span><span></span>);
- </div>
- <div class="description">
- <p>Fired when access to permissions has been removed from the extension.</p>
- <!-- LISTENER PARAMETERS -->
- <div>
- <h4>Listener parameters</h4>
- <dl>
- <div>
- <div>
- <dt>
- <var>permissions</var>
- <em>
- <!-- TYPE -->
- <div style="display:inline">
- (
- <span id="typeTemplate">
- <span>
- <a href="permissions.html#type-Permissions">Permissions</a>
- </span>
- </span>
- )
- </div>
- </em>
- </dt>
- <dd>The permissions that have been removed.</dd>
- <!-- OBJECT PROPERTIES -->
- <!-- OBJECT METHODS -->
- <!-- OBJECT EVENT FIELDS -->
- <!-- FUNCTION PARAMETERS -->
- </div>
- </div>
- </dl>
- </div>
- <!-- EXTRA PARAMETERS -->
- <!-- LISTENER RETURN VALUE -->
- <dl>
- </dl>
- </div> <!-- /description -->
- <!-- /description -->
- </div> <!-- /apiItem -->
- </div> <!-- /apiGroup -->
- <!-- TYPES -->
- <div class="apiGroup">
- <a name="types"></a>
- <h3 id="types">Types</h3>
- <!-- iterates over all types -->
- <div class="apiItem">
- <a name="type-Permissions"></a>
- <h4>Permissions</h4>
- <div>
- <dt>
- <em>
- <!-- TYPE -->
- <div style="display:inline">
- (
- <span id="typeTemplate">
- <span>
- <span>object</span>
- </span>
- </span>
- )
- </div>
- </em>
- </dt>
- <dd class="todo">
- Undocumented.
- </dd>
- <!-- OBJECT PROPERTIES -->
- <dd>
- <dl>
- <div>
- <div>
- <dt>
- <var>permissions</var>
- <em>
- <!-- TYPE -->
- <div style="display:inline">
- (
- <span class="optional">optional</span>
- <span id="typeTemplate">
- <span>
- <span>
- array of <span><span>
- <span>
- <span>string</span>
- </span>
- </span></span>
- </span>
- </span>
- </span>
- )
- </div>
- </em>
- </dt>
- <dd>List of named permissions (does not include hosts or origins).</dd>
- <!-- OBJECT PROPERTIES -->
- <!-- OBJECT METHODS -->
- <!-- OBJECT EVENT FIELDS -->
- <!-- FUNCTION PARAMETERS -->
- </div>
- </div><div>
- <div>
- <dt>
- <var>origins</var>
- <em>
- <!-- TYPE -->
- <div style="display:inline">
- (
- <span class="optional">optional</span>
- <span id="typeTemplate">
- <span>
- <span>
- array of <span><span>
- <span>
- <span>string</span>
- </span>
- </span></span>
- </span>
- </span>
- </span>
- )
- </div>
- </em>
- </dt>
- <dd>List of origin permissions.</dd>
- <!-- OBJECT PROPERTIES -->
- <!-- OBJECT METHODS -->
- <!-- OBJECT EVENT FIELDS -->
- <!-- FUNCTION PARAMETERS -->
- </div>
- </div>
- </dl>
- </dd>
- <!-- OBJECT METHODS -->
- <!-- OBJECT EVENT FIELDS -->
- <!-- FUNCTION PARAMETERS -->
- </div>
- </div> <!-- /apiItem -->
- </div> <!-- /apiGroup -->
- </div> <!-- /apiPage -->
- </div> <!-- /gc-pagecontent -->
- </div> <!-- /g-section -->
- </div> <!-- /codesiteContent -->
- <div id="gc-footer" --="">
- <div class="text">
- <p>
- Except as otherwise <a href="http://code.google.com/policies.html#restrictions">noted</a>,
- the content of this page is licensed under the <a rel="license" href="http://creativecommons.org/licenses/by/3.0/">Creative Commons
- Attribution 3.0 License</a>, and code samples are licensed under the
- <a rel="license" href="http://code.google.com/google_bsd_license.html">BSD License</a>.
- </p>
- <p>
- ©2011 Google
- </p>
-<!-- begin analytics -->
-<script src="https://www.google-analytics.com/urchin.js" type="text/javascript"></script>
-<script src="https://www.google-analytics.com/ga.js" type="text/javascript"></script>
-<script type="text/javascript">
- // chrome doc tracking
- try {
- var engdocs = _gat._getTracker("YT-10763712-2");
- engdocs._trackPageview();
- } catch(err) {}
- // code.google.com site-wide tracking
- try {
- _uacct="UA-18071-1";
- _uanchor=1;
- _uff=0;
- urchinTracker();
- }
- catch(e) {/* urchinTracker not available. */}
-</script>
-<!-- end analytics -->
- </div>
- </div> <!-- /gc-footer -->
- </div> <!-- /gc-container -->
-</body></html>
« no previous file with comments | « chrome/common/extensions/docs/permission_warnings.html ('k') | chrome/common/extensions/docs/privacy.html » ('j') | no next file with comments »

Powered by Google App Engine
This is Rietveld 408576698