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

Issues Search
    My Issues | Starred     Open | Closed | All

Side by Side Diff: chrome/common/extensions/docs/apps/apps_api_index.html

Issue 10657018: Implement the API index doc for platform apps. (Closed) Base URL: svn://svn.chromium.org/chrome/trunk/src
Patch Set: f Created 8 years, 6 months ago
Use n/p to move between diff chunks; N/P to move between comments. Draft comments are only viewable by you.
Jump to:
View unified diff | Download patch | Annotate | Revision Log
« no previous file with comments | « no previous file | chrome/common/extensions/docs/js/api_page_generator.js » ('j') | no next file with comments »
Toggle Intra-line Diffs ('i') | Expand Comments ('e') | Collapse Comments ('c') | Show Comments Hide Comments ('s')
OLDNEW
1 <!DOCTYPE html><!-- This page is a placeholder for generated extensions api doc. Note: 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 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 3 across api docs and should be edited only with knowledge of the
4 templating mechanism. 4 templating mechanism.
5 3) All <body>.innerHTML is genereated as an rendering step. If viewed in a 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 6 browser, it will be re-generated from the template, json schema and
7 authored overview content. 7 authored overview content.
8 4) The <body>.innerHTML is also generated by an offline step so that this 8 4) The <body>.innerHTML is also generated by an offline step so that this
9 page may easily be indexed by search engines. 9 page may easily be indexed by search engines.
10 --><html xmlns="http://www.w3.org/1999/xhtml"><head> 10 --><html xmlns="http://www.w3.org/1999/xhtml"><head>
(...skipping 34 matching lines...) Expand 10 before | Expand all | Expand 10 after
45 are not operated on by way of the jsskip="true" --> 45 are not operated on by way of the jsskip="true" -->
46 <!-- /SUBTEMPLATES --> 46 <!-- /SUBTEMPLATES -->
47 <a id="top"></a> 47 <a id="top"></a>
48 <div id="skipto"> 48 <div id="skipto">
49 <a href="#gc-pagecontent">Skip to page content</a> 49 <a href="#gc-pagecontent">Skip to page content</a>
50 <a href="#gc-toc">Skip to main navigation</a> 50 <a href="#gc-toc">Skip to main navigation</a>
51 </div> 51 </div>
52 <!-- API HEADER --> 52 <!-- API HEADER -->
53 <table id="header" width="100%" cellspacing="0" border="0"> 53 <table id="header" width="100%" cellspacing="0" border="0">
54 <tbody><tr> 54 <tbody><tr>
55 <td valign="middle"><a href="http://code.google.com/"><img src="../image s/code_labs_logo.gif" height="43" width="161" alt="Google Code Labs" style="bord er:0; margin:0;"></a></td> 55 <td valign="middle"><a href="http://code.google.com/"><img src="images/c hrome_logo.gif" alt="Google Code" style="border:0; margin:0;"></a></td>
56 <td valign="middle" width="100%" style="padding-left:0.6em;"> 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"> 57 <form action="http://www.google.com/cse" id="cse" style="margin-top:0. 5em">
58 <div id="gsc-search-box"> 58 <div id="gsc-search-box">
59 <input type="hidden" name="cx" value="002967670403910741006:61_cvz fqtno"> 59 <input type="hidden" name="cx" value="002967670403910741006:61_cvz fqtno">
60 <input type="hidden" name="ie" value="UTF-8"> 60 <input type="hidden" name="ie" value="UTF-8">
61 <input type="text" name="q" value="" size="55"> 61 <input id="gsc-search-input" type="text" name="q" value="" size="5 5">
62 <input class="gsc-search-button" type="submit" name="sa" value="Se arch"> 62 <button class="gsc-search-button" type="submit" name="sa">
63 <img class="gsc-search-button-lens" src="images/search.png" alt= "Search">
64 </button>
63 <br> 65 <br>
64 <span class="greytext">e.g. "page action" or "tabs"</span> 66 <span class="greytext">e.g. "page action" or "tabs"</span>
65 </div> 67 </div>
66 </form> 68 </form>
67 <script type="text/javascript" src="https://www.google.com/jsapi"></sc ript> 69 <script type="text/javascript" src="https://www.google.com/jsapi"></sc ript>
68 <script type="text/javascript">google.load("elements", "1", {packages: "transliteration"});</script> 70 <script type="text/javascript">google.load("elements", "1", {packages: "transliteration"});</script>
69 <script type="text/javascript" src="https://www.google.com/coop/cse/t1 3n?form=cse&amp;t13n_langs=en"></script> 71 <script type="text/javascript" src="https://www.google.com/coop/cse/t1 3n?form=cse&amp;t13n_langs=en"></script>
70 <script type="text/javascript" src="https://www.google.com/coop/cse/br and?form=cse&amp;lang=en"></script> 72 <script type="text/javascript" src="https://www.google.com/coop/cse/br and?form=cse&amp;lang=en"></script>
71 </td> 73 </td>
72 </tr> 74 </tr>
73 </tbody></table> 75 </tbody></table>
74 <div id="codesiteContent" class=""> 76 <div id="codesiteContent" class="">
75 <a id="gc-topnav-anchor"></a> 77 <a id="gc-topnav-anchor"></a>
76 <div id="gc-topnav"> 78 <div id="gc-topnav">
77 <h1>Google Chrome Extensions (<a href="http://code.google.com/labs/">Lab s</a>)</h1> 79 <h1>Packaged Apps</h1>
78 <ul id="home" class="gc-topnav-tabs"> 80 <ul id="home" class="gc-topnav-tabs">
79 <li id="home_link"> 81 <li id="home_link">
80 <a href="index.html" title="Google Chrome Extensions home page">Home </a> 82 <a href="app_landing.html" title="Packaged Apps home page">Home</a>
81 </li> 83 </li>
82 <li id="docs_link"> 84 <li id="docs_link">
83 <a href="docs.html" title="Official Google Chrome Extensions documen tation">Docs</a> 85 <a href="about_apps.html" title="Official Packaged apps documentatio n">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> 86 </li>
88 <li id="samples_link"> 87 <li id="samples_link">
89 <a href="samples.html" title="Sample extensions (with source code)"> Samples</a> 88 <a href="app_samples.html" title="Sample apps (with source code)">Sa mples</a>
90 </li> 89 </li>
91 <li id="group_link"> 90 <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> 91 <a href="http://groups.google.com/a/chromium.org/group/chromium-exte nsions" title="Google Chrome Extensions developer forum">Group</a>
93 </li> 92 </li>
94 <li id="so_link"> 93 <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> 94 <a href="http://stackoverflow.com/questions/tagged/google-chrome-ext ension" title="[google-chrome-extension] tag on Stack Overflow">Questions?</a>
96 </li> 95 </li>
97 </ul> 96 </ul>
98 </div> <!-- end gc-topnav --> 97 </div> <!-- end gc-topnav -->
99 <div class="g-section g-tpl-170"> 98 <div class="g-section g-tpl-170">
100 <!-- SIDENAV --> 99 <!-- SIDENAV -->
101 <div class="g-unit g-first" id="gc-toc"> 100 <div class="g-unit g-first" id="gc-toc">
102 <ul> 101 <ul>
103 <li><a href="getstarted.html">Getting Started</a></li> 102 <li><h2>Getting Started</h2>
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> 103 <ul>
108 <li>Browser UI 104 <li><a href="about_apps.html">What Are Packaged Apps?</a></li>
105 <li><a href="app_architecture.html">Understand the Architecture</a ></li>
106 <li><a href="first_app.html">Create Your First App</a></li>
107 </ul>
108 </li>
109 <li><h2>Developing</h2>
110 <ul>
111 <li><a href="develop_apps.html">Before You Start</a></li>
112 <li>The Fundamentals
109 <ul> 113 <ul>
110 <li><a href="browserAction.html">Browser Actions</a></li> 114 <li><a href="app_lifecycle.html">Manage App Lifecycle</a></li>
111 <li><a href="contextMenus.html">Context Menus</a></li> 115 <li><a href="app_storage.html">Manage Data</a></li>
112 <li><a href="notifications.html">Desktop Notifications</a></li > 116 <li><a href="offline_apps.html">Offline First</a></li>
113 <li><a href="omnibox.html">Omnibox</a></li> 117 <li><a href="app_external.html">Embed Content</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 </ul>
118 </li> 119 </li>
119 <li>Browser Interaction 120 <li>Security &amp; Privacy
120 <ul> 121 <ul>
121 <li><a href="bookmarks.html">Bookmarks</a></li> 122 <li><a href="app_security.html">About Security &amp; Privacy</ a></li>
122 <li><a href="cookies.html">Cookies</a></li> 123 <li><a href="app_identity.html">Identify User</a></li>
123 <li><a href="devtools.html">Developer Tools</a></li> 124 <li><a href="app_permissions.html">Manage User Permissions</a> </li>
124 <li><a href="events.html">Events</a></li> 125 <li><a href="app_csp">Comply with CSP</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> 126 </ul>
130 </li> 127 </li>
131 <li>Implementation 128 <li>Advanced Technologies
132 <ul> 129 <ul>
133 <li><a href="a11y.html">Accessibility</a></li> 130 <li><a href="app_network.html">Communicate across Network</a>< /li>
134 <li><a href="background_pages.html">Background Pages</a></li> 131 <li><a href="app_hardware.html">Access Hardware Devices</a></l i>
135 <li><a href="content_scripts.html">Content Scripts</a></li> 132 <li><a href="app_intents.html">Connect Apps with Web Intents</ 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> 133 </ul>
142 </li> 134 </li>
143 <li>Finishing 135 <li><a href="app_frameworks.html">Recommended Frameworks</a></li>
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> 136 </ul>
150 </li> 137 </li>
151 <li><h2><a href="apps.html">Packaged Apps</a></h2></li> 138 <li><h2>Deploying</h2>
152 <li><h2><a href="tutorials.html">Tutorials</a></h2>
153 <ul> 139 <ul>
154 <li><a href="tut_debugging.html">Debugging</a></li> 140 <li><a href="publish_app.html">Publish</a></li>
155 <li><a href="tut_analytics.html">Google Analytics</a></li> 141 <li><a href="sell_app.html">Sell</a></li>
156 <li><a href="tut_oauth.html">OAuth</a></li>
157 </ul> 142 </ul>
158 </li> 143 </li>
159 <li><h2>Reference</h2> 144 <li><h2>Reference</h2>
160 <ul> 145 <ul>
161 <li>Formats 146 <li><a href="manifest.html">Manifest Files</a></li>
162 <ul> 147 <li><a href="api_index.html">Chrome JavaScript APIs</a></li>
163 <li><a href="manifest.html">Manifest Files</a></li> 148 <li><a href="experimental.html">Experimental APIs</a></li>
164 <li><a href="match_patterns.html">Match Patterns</a></li> 149 <li><a href="api_other.html">Supported Libraries</a></li>
165 </ul> 150 <li><a href="app_deprecated.html">Disabled Web Features</a></li>
166 </li>
167 <li><a href="permission_warnings.html">Permission Warnings</a></li >
168 <li class="leftNavSelected">chrome.* APIs</li>
169 <li><a href="api_other.html">Other APIs</a></li>
170 </ul> 151 </ul>
171 </li> 152 </li>
172 <li><h2><a href="samples.html">Samples</a></h2></li> 153 <li><h2><a href="app_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> 154 </ul>
182 </div> 155 </div>
183 <script> 156 <script>
184 initToggles(); 157 initToggles();
185 </script> 158 </script>
186 <div class="g-unit" id="gc-pagecontent"> 159 <div class="g-unit" id="gc-pagecontent">
187 <div id="pageTitle"> 160 <div id="pageTitle">
188 <h1 class="page_title">chrome.* APIs</h1> 161 <h1 class="page_title">chrome.* APIs</h1>
189 </div> 162 </div>
190 <!-- TABLE OF CONTENTS --> 163 <!-- TABLE OF CONTENTS -->
(...skipping 13 matching lines...) Expand all
204 <ol> 177 <ol>
205 </ol> 178 </ol>
206 </li> 179 </li>
207 </ol> 180 </ol>
208 </div> 181 </div>
209 <!-- /TABLE OF CONTENTS --> 182 <!-- /TABLE OF CONTENTS -->
210 <!-- Standard content lead-in for experimental API pages --> 183 <!-- Standard content lead-in for experimental API pages -->
211 <!-- STATIC CONTENT PLACEHOLDER --> 184 <!-- STATIC CONTENT PLACEHOLDER -->
212 <div id="static"><div id="pageData-name" class="pageData">chrome.* APIs< /div> 185 <div id="static"><div id="pageData-name" class="pageData">chrome.* APIs< /div>
213 <div id="pageData-showTOC" class="pageData">true</div> 186 <div id="pageData-showTOC" class="pageData">true</div>
214 <p>
215 Google Chrome provides APIs such as
216 <code>chrome.bookmarks</code> and <code>chrome.tab</code>
217 so that extensions can interact with the browser.
218 </p>
219 <h2 id="supported">Supported APIs</h2> 187 <h2 id="supported">Supported APIs</h2>
220 <p> 188 <p>
221 Here are the supported chrome.* APIs: 189 Packaged apps can call some of the stable APIs from the extension system.
222 </p> 190 </p>
223 <ul> 191 <ul>
224 <li><a href="alarms.html" js="">alarms</a> 192 <li><a href="alarms.html" js="">alarms</a>
225 </li><li><a href="bookmarks.html" js="">bookmarks</a> 193 </li><li><a href="bookmarks.html" js="">bookmarks</a>
226 </li><li><a href="browserAction.html" js="">browserAction</a> 194 </li><li><a href="browserAction.html" js="">browserAction</a>
227 </li><li><a href="browsingData.html" js="">browsingData</a> 195 </li><li><a href="browsingData.html" js="">browsingData</a>
228 </li><li><a href="contentSettings.html" js="">contentSettings</a> 196 </li><li><a href="contentSettings.html" js="">contentSettings</a>
229 </li><li><a href="contextMenus.html" js="">contextMenus</a> 197 </li><li><a href="contextMenus.html" js="">contextMenus</a>
230 </li><li><a href="cookies.html" js="">cookies</a>
231 </li><li><a href="debugger.html" js="">debugger</a> 198 </li><li><a href="debugger.html" js="">debugger</a>
232 </li><li><a href="declarativeWebRequest.html" js="">declarativeWebRequest</a>
233 </li><li><a href="downloads.html" js="">downloads</a>
234 </li><li><a href="events.html" js="">events</a> 199 </li><li><a href="events.html" js="">events</a>
235 </li><li><a href="extension.html" js="">extension</a> 200 </li><li><a href="extension.html" js="">extension</a>
236 </li><li><a href="fileBrowserHandler.html" js="">fileBrowserHandler</a> 201 </li><li><a href="fileBrowserHandler.html" js="">fileBrowserHandler</a>
237 </li><li><a href="history.html" js="">history</a> 202 </li><li><a href="history.html" js="">history</a>
238 </li><li><a href="i18n.html" js="">i18n</a> 203 </li><li><a href="i18n.html" js="">i18n</a>
239 </li><li><a href="idle.html" js="">idle</a> 204 </li><li><a href="idle.html" js="">idle</a>
240 </li><li><a href="input.ime.html" js="">input.ime</a> 205 </li><li><a href="input.ime.html" js="">input.ime</a>
241 </li><li><a href="management.html" js="">management</a> 206 </li><li><a href="management.html" js="">management</a>
242 </li><li><a href="omnibox.html" js="">omnibox</a> 207 </li><li><a href="omnibox.html" js="">omnibox</a>
243 </li><li><a href="pageAction.html" js="">pageAction</a> 208 </li><li><a href="pageAction.html" js="">pageAction</a>
244 </li><li><a href="pageCapture.html" js="">pageCapture</a> 209 </li><li><a href="pageCapture.html" js="">pageCapture</a>
245 </li><li><a href="permissions.html" js="">permissions</a> 210 </li><li><a href="permissions.html" js="">permissions</a>
246 </li><li><a href="privacy.html" js="">privacy</a> 211 </li><li><a href="privacy.html" js="">privacy</a>
247 </li><li><a href="proxy.html" js="">proxy</a> 212 </li><li><a href="proxy.html" js="">proxy</a>
248 </li><li><a href="runtime.html" js="">runtime</a> 213 </li><li><a href="runtime.html" js="">runtime</a>
249 </li><li><a href="storage.html" js="">storage</a> 214 </li><li><a href="storage.html" js="">storage</a>
250 </li><li><a href="tabs.html" js="">tabs</a>
251 </li><li><a href="topSites.html" js="">topSites</a>
252 </li><li><a href="tts.html" js="">tts</a> 215 </li><li><a href="tts.html" js="">tts</a>
253 </li><li><a href="ttsEngine.html" js="">ttsEngine</a> 216 </li><li><a href="ttsEngine.html" js="">ttsEngine</a>
254 </li><li><a href="types.html" js="">types</a> 217 </li><li><a href="types.html" js="">types</a>
255 </li><li><a href="webNavigation.html" js="">webNavigation</a>
256 </li><li><a href="webRequest.html" js="">webRequest</a>
257 </li><li><a href="webstore.html" js="">webstore</a> 218 </li><li><a href="webstore.html" js="">webstore</a>
258 </li><li><a href="windows.html" js="">windows</a> 219 </li><li><a href="windows.html" js="">windows</a>
259 </li> 220 </li>
260 </ul> 221 </ul>
261 <h2 id="experimental">Experimental APIs</h2> 222 <h2 id="experimental">Experimental APIs</h2>
262 <p> 223 <p>
263 Google Chrome also has 224 Packaged apps can also use any experimental extension API.
264 <a href="experimental.html">experimental APIs</a>,
265 some of which will become supported APIs
266 in future releases of Chrome.
267 </p> 225 </p>
226 <ul>
227 <li><a href="experimental.app.html" js="">experimental.app</a>
228 </li><li><a href="experimental.discovery.html" js="">experimental.discovery</a >
229 </li><li><a href="experimental.fontSettings.html" js="">experimental.fontSetti ngs</a>
230 </li><li><a href="experimental.identity.html" js="">experimental.identity</a>
231 </li><li><a href="experimental.infobars.html" js="">experimental.infobars</a>
232 </li><li><a href="experimental.keybinding.html" js="">experimental.keybinding< /a>
233 </li><li><a href="experimental.mediaGalleries.html" js="">experimental.mediaGa lleries</a>
234 </li><li><a href="experimental.offscreenTabs.html" js="">experimental.offscree nTabs</a>
235 </li><li><a href="experimental.processes.html" js="">experimental.processes</a >
236 </li><li><a href="experimental.speechInput.html" js="">experimental.speechInpu t</a>
237 </li>
238 </ul>
268 <h2 id="conventions">API conventions</h2> 239 <h2 id="conventions">API conventions</h2>
269 <p> 240 <p>
270 Unless the doc says otherwise, 241 Unless the doc says otherwise,
271 methods in the chrome.* APIs are <b>asynchronous</b>: 242 methods in the chrome.* APIs are <b>asynchronous</b>:
272 they return immediately, 243 they return immediately,
273 without waiting for the operation to finish. 244 without waiting for the operation to finish.
274 If you need to know the outcome of an operation, 245 If you need to know the outcome of an operation,
275 then you pass a callback function into the method. 246 then you pass a callback function into the method.
276 For more information, watch this video: 247 For more information, watch this video:
277 </p> 248 </p>
278 <p>
279 <iframe title="YouTube video player" width="640" height="390" src="http://www.yo utube.com/embed/bmxr75CV36A?rel=0" frameborder="0" allowfullscreen=""></iframe>
280 </p>
281 </div> 249 </div>
282 <!-- API PAGE --> 250 <!-- API PAGE -->
283 <!-- /apiPage --> 251 <!-- /apiPage -->
284 </div> <!-- /gc-pagecontent --> 252 </div> <!-- /gc-pagecontent -->
285 </div> <!-- /g-section --> 253 </div> <!-- /g-section -->
286 </div> <!-- /codesiteContent --> 254 </div> <!-- /codesiteContent -->
287 <div id="gc-footer" --=""> 255 <div id="gc-footer" --="">
288 <div class="text"> 256 <div class="text">
289 <p> 257 <p>
290 Except as otherwise <a href="http://code.google.com/policies.html#restrictions ">noted</a>, 258 Except as otherwise <a href="http://code.google.com/policies.html#restrictions ">noted</a>,
(...skipping 20 matching lines...) Expand all
311 _uff=0; 279 _uff=0;
312 urchinTracker(); 280 urchinTracker();
313 } 281 }
314 catch(e) {/* urchinTracker not available. */} 282 catch(e) {/* urchinTracker not available. */}
315 </script> 283 </script>
316 <!-- end analytics --> 284 <!-- end analytics -->
317 </div> 285 </div>
318 </div> <!-- /gc-footer --> 286 </div> <!-- /gc-footer -->
319 </div> <!-- /gc-container --> 287 </div> <!-- /gc-container -->
320 </body></html> 288 </body></html>
OLDNEW
« no previous file with comments | « no previous file | chrome/common/extensions/docs/js/api_page_generator.js » ('j') | no next file with comments »

Powered by Google App Engine
This is Rietveld 408576698