| <!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="js/api_page_generator.js"></script> |
| <script type="text/javascript" src="js/bootstrap.js"></script> |
| <script type="text/javascript" src="js/sidebar.js"></script> |
| <title>Formats: Manifest Files - Google Chrome Extensions - Google Code</title></head> |
| <body> <div id="gc-container" class="labs"> |
| <div id="devModeWarning"> |
| 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> |
| <!-- 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" --> |
| <div style="display:none"> |
| |
| <!-- VALUE --> |
| <div id="valueTemplate"> |
| <dt> |
| <var>paramName</var> |
| <em> |
| |
| <!-- TYPE --> |
| <div style="display:inline"> |
| ( |
| <span class="optional">optional</span> |
| <span class="enum">enumerated</span> |
| <span id="typeTemplate"> |
| <span> |
| <a> Type</a> |
| </span> |
| <span> |
| <span> |
| array of <span><span></span></span> |
| </span> |
| <span>paramType</span> |
| <span></span> |
| </span> |
| </span> |
| ) |
| </div> |
| |
| </em> |
| </dt> |
| <dd class="todo"> |
| Undocumented. |
| </dd> |
| <dd> |
| Description of this parameter from the json schema. |
| </dd> |
| <dd> |
| This parameter was added in version |
| <b><span></span></b>. |
| You must omit this parameter in earlier versions, |
| and you may omit it in any version. If you require this |
| parameter, the manifest key |
| <a href="manifest.html#minimum_chrome_version">minimum_chrome_version</a> |
| can ensure that your extension won't be run in an earlier browser version. |
| </dd> |
| |
| <!-- OBJECT PROPERTIES --> |
| <dd> |
| <dl> |
| <div> |
| <div> |
| </div> |
| </div> |
| </dl> |
| </dd> |
| |
| <!-- FUNCTION PARAMETERS --> |
| <dd> |
| <div></div> |
| </dd> |
| |
| </div> <!-- /VALUE --> |
| |
| <div id="functionParametersTemplate"> |
| <h5>Parameters</h5> |
| <dl> |
| <div> |
| <div> |
| </div> |
| </div> |
| </dl> |
| </div> |
| </div> <!-- /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="http://www.google.com/jsapi"></script> |
| <script type="text/javascript">google.load("elements", "1", {packages: "transliteration"});</script> |
| <script type="text/javascript" src="http://www.google.com/coop/cse/t13n?form=cse&t13n_langs=en"></script> |
| <script type="text/javascript" src="http://www.google.com/coop/cse/brand?form=cse&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> |
| </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="options.html">Options Pages</a></li> |
| <li><a href="override.html">Override Pages</a></li> |
| <li><a href="pageAction.html">Page Actions</a></li> |
| <li><a href="themes.html">Themes</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="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="idle.html">Idle</a></li> |
| <li><a href="i18n.html">Internationalization</a></li> |
| <li><a href="messaging.html">Message Passing</a></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="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 class="leftNavSelected">Manifest Files</li> |
| <li><a href="match_patterns.html">Match Patterns</a></li> |
| <!-- <li>Packages (.crx)</li> --> |
| </ul> |
| </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">Installable Web 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">Formats: Manifest Files</h1> |
| </div> |
| <!-- TABLE OF CONTENTS --> |
| <div id="toc"> |
| <h2>Contents</h2> |
| <ol> |
| <li> |
| <a href="#overview"> Field summary </a> |
| <ol> |
| <li style="display: none; "> |
| <a>h3Name</a> |
| </li> |
| </ol> |
| </li><li> |
| <a href="#H2-1">Field details</a> |
| <ol> |
| <li> |
| <a href="#default_locale">default_locale</a> |
| </li><li> |
| <a href="#description">description</a> |
| </li><li> |
| <a href="#homepage_url">homepage_url</a> |
| </li><li> |
| <a href="#icons">icons</a> |
| </li><li> |
| <a href="#incognito">incognito</a> |
| </li><li> |
| <a href="#key">key</a> |
| </li><li> |
| <a href="#minimum_chrome_version">minimum_chrome_version</a> |
| </li><li> |
| <a href="#name">name</a> |
| </li><li> |
| <a href="#permissions">permissions</a> |
| </li><li> |
| <a href="#version">version</a> |
| </li> |
| </ol> |
| </li> |
| <li style="display: none; "> |
| <a href="#apiReference">API reference</a> |
| <ol> |
| <li> |
| <a href="#properties">Properties</a> |
| <ol> |
| <li> |
| <a href="#property-anchor">propertyName</a> |
| </li> |
| </ol> |
| </li> |
| <li> |
| <a href="#methods">Methods</a> |
| <ol> |
| <li> |
| <a href="#method-anchor">methodName</a> |
| </li> |
| </ol> |
| </li> |
| <li> |
| <a href="#events">Events</a> |
| <ol> |
| <li> |
| <a href="#event-anchor">eventName</a> |
| </li> |
| </ol> |
| </li> |
| <li> |
| <a href="#types">Types</a> |
| <ol> |
| <li> |
| <a href="#id-anchor">id</a> |
| </li> |
| </ol> |
| </li> |
| </ol> |
| </li> |
| </ol> |
| </div> |
| <!-- /TABLE OF CONTENTS --> |
| |
| <!-- Standard content lead-in for experimental API pages --> |
| <p id="classSummary" style="display: none; "> |
| For information on how to use experimental APIs, see the <a href="experimental.html">chrome.experimental.* APIs</a> page. |
| </p> |
| |
| <!-- STATIC CONTENT PLACEHOLDER --> |
| <div id="static"><div id="pageData-name" class="pageData">Formats: Manifest Files</div> |
| <div id="pageData-showTOC" class="pageData">true</div> |
| |
| <p> |
| Every extension has a |
| <a href="http://www.json.org">JSON</a>-formatted manifest file, |
| named <code>manifest.json</code>, |
| that provides important information about the extension. |
| </p> |
| |
| <h2 id="overview"> Field summary </h2> |
| |
| <p> |
| The following code shows the supported manifest fields, |
| with links to the page that discusses each field. |
| The only fields that are required for every extension |
| are <b>name</b> and <b>version</b>. |
| </p> |
| |
| <pre>{ |
| <em>// Required</em> |
| "<a href="#name">name</a>": "<em>My Extension</em>", |
| "<a href="#version">version</a>": "<em>versionString</em>", |
| |
| <em>// Recommended</em> |
| "<a href="#description">description</a>": "<em>A plain text description</em>", |
| "<a href="#icons">icons</a>": { ... }, |
| "<a href="#default_locale">default_locale</a>": "<em>en</em>", |
| |
| <em>// Pick one (or none)</em> |
| "<a href="browserAction.html">browser_action</a>": {...}, |
| "<a href="pageAction.html">page_action</a>": {...}, |
| "<a href="themes.html">theme</a>": {...}, |
| |
| <em>// Add any of these that you need</em> |
| "<a href="background_pages.html">background_page</a>": "<em>aFile</em>.html", |
| "<a href="override.html">chrome_url_overrides</a>": {...}, |
| "<a href="content_scripts.html">content_scripts</a>": [...], |
| "<a href="#homepage_url">homepage_url</a>": "http://<em>path/to/homepage</em>", |
| "<a href="#incognito">incognito</a>": "spanning" <em>or</em> "split", |
| "<a href="#key">key</a>": "<em>publicKey</em>", |
| "<a href="#minimum_chrome_version">minimum_chrome_version</a>": "<em>versionString</em>", |
| "<a href="options.html">options_page</a>": "<em>aFile</em>.html", |
| "<a href="#permissions">permissions</a>": [...], |
| "<a href="npapi.html">plugins</a>": [...], |
| "<a href="autoupdate.html">update_url</a>": "http://<em>path/to/updateInfo</em>.xml" |
| } |
| </pre> |
| |
| |
| <a name="H2-1"></a><h2>Field details</h2> |
| |
| <p> |
| This section covers fields that aren't described in another page. |
| For a complete list of fields, |
| with links to where they're described in detail, |
| see the <a href="#overview">Field summary</a>. |
| </p> |
| |
| <h3 id="default_locale">default_locale</h3> |
| |
| <p> |
| Specifies the subdirectory of <code>_locales</code> |
| that contains the default strings for this extension. |
| This field is <b>required</b> in extensions |
| that have a <code>_locales</code> directory; |
| it <b>must be absent</b> in extensions |
| that have no <code>_locales</code> directory. |
| For details, see |
| <a href="i18n.html">Internationalization</a>. |
| </p> |
| |
| <h3 id="description">description</h3> |
| |
| <p> |
| A plain text string |
| (no HTML or other formatting; |
| no more than 132 characters) |
| that describes the extension. |
| The description should be suitable for both |
| the browser's extension management UI |
| and the <a href="https://chrome.google.com/extensions">extension gallery</a>. |
| You can specify locale-specific strings for this field; |
| see <a href="i18n.html">Internationalization</a> for details. |
| </p> |
| |
| <h3 id="homepage_url">homepage_url</h3> |
| |
| <p> |
| The URL of the homepage for this extension. The extensions management page (chrome://extensions) |
| will contain a link to this URL. This field is particularly useful if you |
| <a href="hosting.html">host the extension on your own site</a>. If you distribute your |
| extension using the <a href="http://chrome.google.com/extensions">gallery</a>, |
| the homepage URL defaults to the extension's own gallery page. |
| </p> |
| |
| <h3 id="icons">icons</h3> |
| |
| <p> |
| One or more icons that represent the extension. |
| You should provide icons in at least two sizes — |
| 48x48 and 128x128 pixels. |
| The 48x48 icon is used in the extensions management page |
| (chrome://extensions). |
| The 128x128 icon is used when the user installs the extension. |
| You can also specify a 16x16 icon to be used as the favicon |
| for the extension's pages. |
| The 16x16 icon is also displayed in the experimental |
| <a href="experimental.infobars.html">infobar</a> |
| feature. |
| </p> |
| |
| <p> |
| Icons should generally be in PNG format, |
| because PNG has the best support for transparency. |
| They can, however, be in any format supported by WebKit, |
| including BMP, GIF, ICO, and JPEG. |
| Here's an example of specifying the icons: |
| </p> |
| |
| <pre>"icons": { "16": "icon16.png", |
| "48": "icon48.png", |
| "128": "icon128.png" }, |
| </pre> |
| |
| <p class="note"> |
| <b>Note:</b> |
| Use only the documented icon sizes. |
| <br><br> |
| You may notice that Google Chrome sometimes resizes these icons down to smaller |
| sizes. For example, as of this writing, the install dialog shrinks the 128-pixel |
| icon down to 69 pixels. |
| <br><br> |
| Nevertheless, you should use only the documented sizes. The details of Google |
| Chrome's UI may change between versions. These changes are made assuming that |
| extension developers are using the documented sizes. If you use other sizes, |
| your icon may look bad in future versions of the browser. |
| </p> |
| |
| <p> |
| If you submit your extension to the |
| <a href="https://chrome.google.com/extensions">gallery</a>, |
| you'll need to upload additional images, |
| including a 32x32-pixel logo |
| and at least one screenshot of your extension. |
| For more information on gallery requirements, |
| see the |
| <a href="http://www.google.com/support/chrome/bin/answer.py?answer=113909">gallery help</a>. |
| </p> |
| |
| <h3 id="incognito">incognito</h3> |
| |
| <p> |
| Either "spanning" or "split", to specify how this extension will |
| behave if allowed to run in incognito mode. |
| </p> |
| |
| <p> |
| The default for extensions is "spanning", which means that the extension |
| will run in a single shared process. Any events or messages from an incognito |
| tab will be sent to the shared process, with an <em>incognito</em> flag |
| indicating where it came from. |
| </p> |
| |
| <p> |
| The default for installable web apps is "split", |
| which means that all app pages in |
| an incognito window will run in their own incognito process. If the app or extension contains a background page, that will also run in the incognito process. |
| This incognito process runs along side the regular process, but has a separate |
| memory-only cookie store. Each process sees events and messages only from its |
| own context (for example, the incognito process will see only incognito tab updates). |
| The processes are unable to communicate with each other. |
| </p> |
| |
| <p> |
| As a rule of thumb, if your extension or app needs to load a tab in an incognito browser, use |
| <em>split</em> incognito behavior. If your extension or app needs to be logged |
| into a remote server or persist settings locally, use <em>spanning</em> |
| incognito behavior. |
| </p> |
| |
| <h3 id="key">key</h3> |
| |
| <p> |
| This value can be used to control |
| the unique ID of an extension when |
| it is loaded during development. |
| </p> |
| |
| <p class="note"> |
| <b>Note:</b> Most extensions should not need to |
| use this value. Instead, write your |
| code so that the key value doesn't matter |
| by using <a href="overview.html#relative-urls">relative paths</a> |
| and <a href="extension.html#method-getURL">chrome.extension.getURL()</a>. |
| </p> |
| |
| <p> |
| To get a suitable key value, first |
| install your extension from a <code>.crx</code> file |
| (you may need to |
| <a href="hosting.html#gallery">upload your extension to the gallery</a>, |
| or <a href="packaging.html">package it manually</a>). |
| Then, in your |
| <a href="http://www.chromium.org/user-experience/user-data-directory">user |
| data directory</a>, look in the file |
| <code>Default/Extensions/<em><extensionId></em>/<em><versionString></em>/manifest.json</code>. |
| You will see the key value filled in there. |
| </p> |
| |
| <h3 id="minimum_chrome_version">minimum_chrome_version</h3> |
| |
| <p> |
| The version of Google Chrome that your extension requires, if any. |
| The format for this string is the same as for the |
| <a href="#version">version</a> field. |
| |
| </p><h3 id="name">name</h3> |
| |
| <p> |
| A short, plain text string |
| (no more than 45 characters) |
| that identifies the extension. |
| The name is used in the install dialog, |
| extension management UI, |
| and the <a href="https://chrome.google.com/extensions">extension gallery</a>. |
| You can specify locale-specific strings for this field; |
| see <a href="i18n.html">Internationalization</a> for details. |
| </p> |
| |
| <h3 id="permissions">permissions</h3> |
| |
| <p> |
| An array of permissions that the extension might use. |
| Each permission can be either one of a list of known strings |
| (such as "tabs") |
| or a match pattern |
| that gives access to one or more hosts. |
| These permissions are displayed to users before installation. |
| Permissions might also help to limit damage |
| if your extension is attacked. |
| </p> |
| |
| <p> |
| If an API requires you to declare a permission in the manifest, |
| then its documentation tells you how to do so. |
| For example, |
| the <a href="tabs.html">Tabs</a> page |
| shows you how to |
| declare the "tabs" permission. |
| </p> |
| |
| <p> |
| Here's an example of the permissions part of a manifest file: |
| </p> |
| |
| <pre>"permissions": [ |
| "tabs", |
| "bookmarks", |
| "http://www.blogger.com/", |
| "http://*.google.com/", |
| "unlimitedStorage" |
| ], |
| </pre> |
| |
| <p> |
| The following table lists the permissions an extension can use. |
| </p> |
| |
| <table> |
| <tbody><tr> |
| <th> Permission </th> <th> Description </th> |
| </tr> |
| <tr> |
| <td> <em>match pattern</em> </td> |
| <td> Specifies a <em>host permission</em>. |
| Required if the extension wants to interact |
| with the code running on pages. |
| Many extension capabilities, such as |
| <a href="xhr.html">cross-origin XMLHttpRequests</a>, |
| <a href="content_scripts.html#pi">programmatically injected |
| content scripts</a>, and <a href="cookies.html">the cookies API</a> |
| require host permissions. For details on the syntax, see |
| <a href="match_patterns.html">Match Patterns</a>. |
| </td> |
| </tr> |
| <tr> |
| <td> "bookmarks" </td> |
| <td> Required if the extension uses the |
| <a href="bookmarks.html">chrome.bookmarks</a> module. </td> |
| </tr> |
| <tr> |
| <td> "chrome://favicon/" </td> |
| <td> Required if the extension uses the |
| "chrome://favicon/<em>url</em>" mechanism |
| to display the favicon of a page. |
| For example, to display the favicon of http://www.google.com/, |
| you declare the "chrome://favicon/" permission |
| and use HTML code like this: |
| <pre><img src="chrome://favicon/http://www.google.com/"></pre> |
| </td> |
| </tr> |
| <tr> |
| <td> "contextMenus" </td> |
| <td> Required if the extension uses the |
| <a href="contextMenus.html">chrome.contextMenus</a> module. </td> |
| </tr> |
| <tr> |
| <td> "cookies" </td> |
| <td> Required if the extension uses the |
| <a href="cookies.html">chrome.cookies</a> module. </td> |
| </tr> |
| <tr> |
| <td> "experimental" </td> |
| <td> Required if the extension uses any |
| <a href="http://code.google.com/chrome/extensions/dev/experimental.html">chrome.experimental.* APIs</a>.</td> |
| </tr> |
| <tr> |
| <td id="geolocation"> "geolocation" </td> |
| <td> Allows the extension to use the proposed HTML5 |
| <a href="http://dev.w3.org/geo/api/spec-source.html">geolocation API</a> |
| without prompting the user for permission. </td> |
| </tr> |
| <tr> |
| <td> "history" </td> |
| <td> Required if the extension uses the |
| <a href="history.html">chrome.history</a> module. </td> |
| </tr> |
| <tr> |
| <td> "idle" </td> |
| <td> Required if the extension uses the |
| <a href="idle.html">chrome.idle</a> module. </td> |
| </tr> |
| <tr> |
| <td> "management" </td> |
| <td> Required if the extension uses the |
| <a href="management.html">chrome.management</a> module. </td> |
| </tr> |
| <tr> |
| <td> "notifications" </td> |
| <td> Allows the extension to use the proposed HTML5 |
| <a href="http://www.chromium.org/developers/design-documents/desktop-notifications/api-specification">notification API</a> |
| without calling permission methods |
| (such as <code>checkPermission()</code>). |
| For more information see |
| <a href="notifications.html">Desktop Notifications</a>.</td> |
| </tr> |
| <tr> |
| <td> "tabs" </td> |
| <td> Required if the extension uses the |
| <a href="tabs.html">chrome.tabs</a> or |
| <a href="windows.html">chrome.windows</a> module. </td> |
| </tr> |
| <tr> |
| <td> "unlimitedStorage"</td> |
| <td> Provides an unlimited quota for storing HTML5 client-side data, |
| such as databases and local storage files. |
| Without this permission, the extension is limited to |
| 5 MB of local storage. |
| |
| <p class="note"> |
| <b>Note:</b> |
| This permission applies only to Web SQL Database and application cache |
| (see issue <a href="http://crbug.com/58985">58985</a>). |
| Also, it doesn't currently work with wildcard subdomains such as |
| <code>http://*.example.com</code>. |
| </p> |
| </td> |
| </tr> |
| </tbody></table> |
| |
| |
| <h3 id="version">version</h3> |
| |
| <p> |
| One to four dot-separated integers |
| identifying the version of this extension. |
| A couple of rules apply to the integers: |
| they must be between 0 and 65535, inclusive, |
| and non-zero integers can't start with 0. |
| For example, 99999 and 032 are both invalid. |
| </p> |
| |
| <p> |
| Here are some examples of valid versions: |
| </p> |
| |
| <ul> |
| <li> <code>"version": "1"</code> </li> |
| <li> <code>"version": "1.0"</code> </li> |
| <li> <code>"version": "2.10.2"</code> </li> |
| <li> <code>"version": "3.1.2.4567"</code> </li> |
| </ul> |
| |
| <p> |
| The autoupdate system compares versions |
| to determine whether an installed extension |
| needs to be updated. |
| If the published extension has a newer version string |
| than the installed extension, |
| then the extension is automatically updated. |
| </p> |
| |
| <p> |
| The comparison starts with the leftmost integers. |
| If those integers are equal, |
| the integers to the right are compared, |
| and so on. |
| For example, 1.2.0 is a newer version than 1.1.9.9999. |
| </p> |
| |
| <p> |
| A missing integer is equal to zero. |
| For example, 1.1.9.9999 is newer than 1.1. |
| </p> |
| |
| <p> |
| For more information, see |
| <a href="autoupdate.html">Autoupdating</a>. |
| </p> |
| |
| <!-- [PENDING: Possibly: point to the gallery and make a big deal of the fact that autoupdating is free if you use the gallery.] --> |
| </div> |
| |
| <!-- API PAGE --> |
| <div class="apiPage" style="display: none; "> |
| <a name="apiReference"></a> |
| <h2>API reference: chrome.apiname </h2> |
| |
| <!-- PROPERTIES --> |
| <div class="apiGroup"> |
| <a name="properties"></a> |
| <h3 id="properties">Properties</h3> |
| |
| <div> |
| <a></a> |
| <h4>getLastError</h4> |
| <div class="summary"> |
| <!-- Note: intentionally longer 80 columns --> |
| <span>chrome.extension</span><span>lastError</span> |
| </div> |
| <div> |
| </div> |
| </div> |
| |
| </div> <!-- /apiGroup --> |
| |
| <!-- METHODS --> |
| <div class="apiGroup" id="methods"> |
| <a name="methods"></a> |
| <h3>Methods</h3> |
| |
| <!-- iterates over all functions --> |
| <div class="apiItem"> |
| <a></a> <!-- method-anchor --> |
| <h4>method name</h4> |
| |
| <div class="summary"><span>void</span> |
| <!-- Note: intentionally longer 80 columns --> |
| <span>chrome.module.methodName</span>(<span><span>, </span><span></span> |
| <var><span></span></var></span>)</div> |
| |
| <div class="description"> |
| <p class="todo">Undocumented.</p> |
| <p> |
| A description from the json schema def of the function goes here. |
| </p> |
| |
| <!-- PARAMETERS --> |
| <h4>Parameters</h4> |
| <dl> |
| <div> |
| <div> |
| </div> |
| </div> |
| </dl> |
| |
| <!-- RETURNS --> |
| <h4>Returns</h4> |
| <dl> |
| <div> |
| <div> |
| </div> |
| </div> |
| </dl> |
| |
| <!-- CALLBACK --> |
| <div> |
| <div> |
| <h4>Callback function</h4> |
| <p> |
| The callback <em>parameter</em> should specify a function |
| that looks like this: |
| </p> |
| <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>Type param1, Type param2</span>) <span class="subdued">{...}</span>;</pre> |
| <dl> |
| <div> |
| <div> |
| </div> |
| </div> |
| </dl> |
| </div> |
| </div> |
| |
| <!-- MIN_VERSION --> |
| <p> |
| This function was added in version <b><span></span></b>. |
| If you require this function, the manifest key |
| <a href="manifest.html#minimum_chrome_version">minimum_chrome_version</a> |
| can ensure that your extension won't be run in an earlier browser version. |
| </p> |
| </div> <!-- /description --> |
| |
| </div> <!-- /apiItem --> |
| |
| </div> <!-- /apiGroup --> |
| |
| <!-- EVENTS --> |
| <div class="apiGroup"> |
| <a name="events"></a> |
| <h3 id="events">Events</h3> |
| |
| <!-- iterates over all events --> |
| <div class="apiItem"> |
| <a></a> |
| <h4>event name</h4> |
| |
| <div class="summary"> |
| <!-- Note: intentionally longer 80 columns --> |
| <span class="subdued">chrome.bookmarks</span><span>onEvent</span><span class="subdued">.addListener</span>(function(<span>Type param1, Type param2</span>) <span class="subdued">{...}</span>); |
| </div> |
| |
| <div class="description"> |
| <p class="todo">Undocumented.</p> |
| <p> |
| A description from the json schema def of the event goes here. |
| </p> |
| |
| <!-- PARAMETERS --> |
| <h4>Parameters</h4> |
| <dl> |
| <div> |
| <div> |
| </div> |
| </div> |
| </dl> |
| |
| </div> <!-- /decription --> |
| |
| </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></a> |
| <h4>type name</h4> |
| |
| <div> |
| </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> |
| ©2010 Google |
| </p> |
| |
| <!-- begin analytics --> |
| <script src="http://www.google-analytics.com/urchin.js" type="text/javascript"></script> |
| <script src="http://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> |
