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

Issues Search
    My Issues | Starred     Open | Closed | All

Side by Side Diff: chrome/common/extensions/docs/idle.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 unified diff | Download patch | Annotate | Revision Log
« no previous file with comments | « chrome/common/extensions/docs/i18n-messages.html ('k') | chrome/common/extensions/docs/index.html » ('j') | no next file with comments »
Toggle Intra-line Diffs ('i') | Expand Comments ('e') | Collapse Comments ('c') | Show Comments Hide Comments ('s')
OLDNEW
(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.idle module, wh ich is part of the Google Chrome extension APIs."><title>Idle - Google Chrome E xtensions - 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&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>
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">Idle</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>
199 <li>
200 <a href="#apiReference">API reference: chrome.idle</a>
201 <ol>
202 <li>
203 <a href="#global-methods">Methods</a>
204 <ol>
205 <li>
206 <a href="#method-queryState">queryState</a>
207 </li>
208 </ol>
209 </li>
210 <li>
211 <a href="#global-events">Events</a>
212 <ol>
213 <li>
214 <a href="#event-onStateChanged">onStateChanged</a>
215 </li>
216 </ol>
217 </li>
218 </ol>
219 </li>
220 </ol>
221 </div>
222 <!-- /TABLE OF CONTENTS -->
223 <!-- Standard content lead-in for experimental API pages -->
224 <!-- STATIC CONTENT PLACEHOLDER -->
225 <div id="static"><div id="pageData-name" class="pageData">Idle</div>
226 <!-- BEGIN AUTHORED CONTENT -->
227 <h2 id="manifest">Manifest</h2>
228 <p>You must declare the "idle" permission in your extension's manifest to use th e idle API.
229 For example:
230 </p>
231 <pre>{
232 "name": "My extension",
233 ...
234 <b>"permissions": [
235 "idle"
236 ]</b>,
237 ...
238 }</pre>
239 <!-- END AUTHORED CONTENT -->
240 </div>
241 <!-- API PAGE -->
242 <div class="apiPage">
243 <a name="apiReference"></a>
244 <h2>API reference: chrome.idle</h2>
245 <!-- PROPERTIES -->
246 <!-- /apiGroup -->
247 <!-- METHODS -->
248 <div id="methodsTemplate" class="apiGroup">
249 <a name="global-methods"></a>
250 <h3>Methods</h3>
251 <!-- iterates over all functions -->
252 <div class="apiItem">
253 <a name="method-queryState"></a> <!-- method-anchor -->
254 <h4>queryState</h4>
255 <div class="summary">
256 <!-- Note: intentionally longer 80 columns -->
257 <span>chrome.idle.queryState</span>(<span class="null"><span>i nteger</span>
258 <var><span>thresholdSeconds</span></var></span><span class ="null"><span>, </span><span>function</span>
259 <var><span>callback</span></var></span>)</div>
260 <div class="description">
261 <p>Returns the current state of the browser.</p>
262 <!-- PARAMETERS -->
263 <h4>Parameters</h4>
264 <dl>
265 <div>
266 <div>
267 <dt>
268 <var>thresholdSeconds</var>
269 <em>
270 <!-- TYPE -->
271 <div style="display:inline">
272 (
273 <span id="typeTemplate">
274 <span>
275 <span>integer</span>
276 </span>
277 </span>
278 )
279 </div>
280 </em>
281 </dt>
282 <dd>Threshold, in seconds, used to determine when a machine is in the idle state.</dd>
283 <!-- OBJECT PROPERTIES -->
284 <!-- OBJECT METHODS -->
285 <!-- OBJECT EVENT FIELDS -->
286 <!-- FUNCTION PARAMETERS -->
287 </div>
288 </div><div>
289 <div>
290 <dt>
291 <var>callback</var>
292 <em>
293 <!-- TYPE -->
294 <div style="display:inline">
295 (
296 <span id="typeTemplate">
297 <span>
298 <span>function</span>
299 </span>
300 </span>
301 )
302 </div>
303 </em>
304 </dt>
305 <dd class="todo">
306 Undocumented.
307 </dd>
308 <!-- OBJECT PROPERTIES -->
309 <!-- OBJECT METHODS -->
310 <!-- OBJECT EVENT FIELDS -->
311 <!-- FUNCTION PARAMETERS -->
312 </div>
313 </div>
314 </dl>
315 <!-- RETURNS -->
316 <dl>
317 </dl>
318 <!-- CALLBACK -->
319 <div>
320 <div>
321 <h4>Callback function</h4>
322 <p>
323 The <em>callback</em> parameter should specify a function
324 that looks like this:
325 </p>
326 <!-- Note: intentionally longer 80 columns -->
327 <pre>function(<span>string newState</span>) <span class="subdu ed">{...}</span>;</pre>
328 <dl>
329 <div>
330 <div>
331 <dt>
332 <var>newState</var>
333 <em>
334 <!-- TYPE -->
335 <div style="display:inline">
336 (
337 <span class="enum">enumerated</span>
338 <span id="typeTemplate">
339 <span>
340 <span>string</span>
341 <span>["active", "idle", "locked"]</span>
342 </span>
343 </span>
344 )
345 </div>
346 </em>
347 </dt>
348 <dd class="todo">
349 Undocumented.
350 </dd>
351 <!-- OBJECT PROPERTIES -->
352 <!-- OBJECT METHODS -->
353 <!-- OBJECT EVENT FIELDS -->
354 <!-- FUNCTION PARAMETERS -->
355 </div>
356 </div>
357 </dl>
358 </div>
359 </div>
360 <!-- MIN_VERSION -->
361 </div> <!-- /description -->
362 </div> <!-- /apiItem -->
363 </div> <!-- /apiGroup -->
364 <!-- EVENTS -->
365 <div id="eventsTemplate" class="apiGroup">
366 <a name="global-events"></a>
367 <h3>Events</h3>
368 <!-- iterates over all events -->
369 <div class="apiItem">
370 <a name="event-onStateChanged"></a>
371 <h4>onStateChanged</h4>
372 <div class="summary">
373 <!-- Note: intentionally longer 80 columns -->
374 <span class="subdued">chrome.idle.</span><span>onStateChanged</s pan><span class="subdued">.addListener</span>(function(<span>string newState</sp an>) <span class="subdued">{...}</span><span></span>);
375 </div>
376 <div class="description">
377 <p>Fired when the browser changes to an active state. Currently only reports the transition from idle to active.</p>
378 <!-- LISTENER PARAMETERS -->
379 <div>
380 <h4>Listener parameters</h4>
381 <dl>
382 <div>
383 <div>
384 <dt>
385 <var>newState</var>
386 <em>
387 <!-- TYPE -->
388 <div style="display:inline">
389 (
390 <span class="enum">enumerated</span>
391 <span id="typeTemplate">
392 <span>
393 <span>string</span>
394 <span>["active"]</span>
395 </span>
396 </span>
397 )
398 </div>
399 </em>
400 </dt>
401 <dd class="todo">
402 Undocumented.
403 </dd>
404 <!-- OBJECT PROPERTIES -->
405 <!-- OBJECT METHODS -->
406 <!-- OBJECT EVENT FIELDS -->
407 <!-- FUNCTION PARAMETERS -->
408 </div>
409 </div>
410 </dl>
411 </div>
412 <!-- EXTRA PARAMETERS -->
413 <!-- LISTENER RETURN VALUE -->
414 <dl>
415 </dl>
416 </div> <!-- /description -->
417 <!-- /description -->
418 </div> <!-- /apiItem -->
419 </div> <!-- /apiGroup -->
420 <!-- TYPES -->
421 <!-- /apiGroup -->
422 </div> <!-- /apiPage -->
423 </div> <!-- /gc-pagecontent -->
424 </div> <!-- /g-section -->
425 </div> <!-- /codesiteContent -->
426 <div id="gc-footer" --="">
427 <div class="text">
428 <p>
429 Except as otherwise <a href="http://code.google.com/policies.html#restrictions ">noted</a>,
430 the content of this page is licensed under the <a rel="license" href="http://c reativecommons.org/licenses/by/3.0/">Creative Commons
431 Attribution 3.0 License</a>, and code samples are licensed under the
432 <a rel="license" href="http://code.google.com/google_bsd_license.html">BSD Lic ense</a>.
433 </p>
434 <p>
435 ©2011 Google
436 </p>
437 <!-- begin analytics -->
438 <script src="https://www.google-analytics.com/urchin.js" type="text/javascript"> </script>
439 <script src="https://www.google-analytics.com/ga.js" type="text/javascript"></sc ript>
440 <script type="text/javascript">
441 // chrome doc tracking
442 try {
443 var engdocs = _gat._getTracker("YT-10763712-2");
444 engdocs._trackPageview();
445 } catch(err) {}
446 // code.google.com site-wide tracking
447 try {
448 _uacct="UA-18071-1";
449 _uanchor=1;
450 _uff=0;
451 urchinTracker();
452 }
453 catch(e) {/* urchinTracker not available. */}
454 </script>
455 <!-- end analytics -->
456 </div>
457 </div> <!-- /gc-footer -->
458 </div> <!-- /gc-container -->
459 </body></html>
OLDNEW
« no previous file with comments | « chrome/common/extensions/docs/i18n-messages.html ('k') | chrome/common/extensions/docs/index.html » ('j') | no next file with comments »

Powered by Google App Engine
This is Rietveld 408576698