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

Issues Search
    My Issues | Starred     Open | Closed | All

Side by Side Diff: chrome/common/extensions/docs/experimental.identity.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/experimental.history.html ('k') | chrome/common/extensions/docs/experimental.idltest.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.experimental.id entity module, which is part of the Google Chrome extension APIs."><title>chrom e.experimental.identity - Google Chrome Extensions - 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">chrome.experimental.identity</h1>
189 </div>
190 <!-- TABLE OF CONTENTS -->
191 <div id="toc">
192 <h2>Contents</h2>
193 <ol>
194 <li>
195 <a href="#apiReference">API reference: chrome.experimental.ident ity</a>
196 <ol>
197 <li>
198 <a href="#global-methods">Methods</a>
199 <ol>
200 <li>
201 <a href="#method-getAuthToken">getAuthToken</a>
202 </li><li>
203 <a href="#method-launchWebAuthFlow">launchWebAuthFlow</a>
204 </li>
205 </ol>
206 </li>
207 </ol>
208 </li>
209 </ol>
210 </div>
211 <!-- /TABLE OF CONTENTS -->
212 <!-- Standard content lead-in for experimental API pages -->
213 <p id="classSummary">
214 For information on how to use experimental APIs, see the <a href="expe rimental.html">chrome.experimental.* APIs</a> page.
215 </p>
216 <!-- STATIC CONTENT PLACEHOLDER -->
217 <div id="static"></div>
218 <!-- API PAGE -->
219 <div class="apiPage">
220 <a name="apiReference"></a>
221 <h2>API reference: chrome.experimental.identity</h2>
222 <!-- PROPERTIES -->
223 <!-- /apiGroup -->
224 <!-- METHODS -->
225 <div id="methodsTemplate" class="apiGroup">
226 <a name="global-methods"></a>
227 <h3>Methods</h3>
228 <!-- iterates over all functions -->
229 <div class="apiItem">
230 <a name="method-getAuthToken"></a> <!-- method-anchor -->
231 <h4>getAuthToken</h4>
232 <div class="summary">
233 <!-- Note: intentionally longer 80 columns -->
234 <span>chrome.experimental.identity.getAuthToken</span>(<span c lass="null"><span>function</span>
235 <var><span>callback</span></var></span>)</div>
236 <div class="description">
237 <p>Gets an OAuth2 access token as specified by the manifest.</p>
238 <!-- PARAMETERS -->
239 <h4>Parameters</h4>
240 <dl>
241 <div>
242 <div>
243 <dt>
244 <var>callback</var>
245 <em>
246 <!-- TYPE -->
247 <div style="display:inline">
248 (
249 <span id="typeTemplate">
250 <span>
251 <span>function</span>
252 </span>
253 </span>
254 )
255 </div>
256 </em>
257 </dt>
258 <dd class="todo">
259 Undocumented.
260 </dd>
261 <!-- OBJECT PROPERTIES -->
262 <!-- OBJECT METHODS -->
263 <!-- OBJECT EVENT FIELDS -->
264 <!-- FUNCTION PARAMETERS -->
265 </div>
266 </div>
267 </dl>
268 <!-- RETURNS -->
269 <dl>
270 </dl>
271 <!-- CALLBACK -->
272 <div>
273 <div>
274 <h4>Callback function</h4>
275 <p>
276 The <em>callback</em> parameter should specify a function
277 that looks like this:
278 </p>
279 <!-- Note: intentionally longer 80 columns -->
280 <pre>function(<span>string token</span>) <span class="subdued" >{...}</span>;</pre>
281 <dl>
282 <div>
283 <div>
284 <dt>
285 <var>token</var>
286 <em>
287 <!-- TYPE -->
288 <div style="display:inline">
289 (
290 <span id="typeTemplate">
291 <span>
292 <span>string</span>
293 </span>
294 </span>
295 )
296 </div>
297 </em>
298 </dt>
299 <dd>OAuth2 access token as specified by the manifest.</dd>
300 <!-- OBJECT PROPERTIES -->
301 <!-- OBJECT METHODS -->
302 <!-- OBJECT EVENT FIELDS -->
303 <!-- FUNCTION PARAMETERS -->
304 </div>
305 </div>
306 </dl>
307 </div>
308 </div>
309 <!-- MIN_VERSION -->
310 </div> <!-- /description -->
311 </div><div class="apiItem">
312 <a name="method-launchWebAuthFlow"></a> <!-- method-anchor -->
313 <h4>launchWebAuthFlow</h4>
314 <div class="summary">
315 <!-- Note: intentionally longer 80 columns -->
316 <span>chrome.experimental.identity.launchWebAuthFlow</span>(<s pan class="null"><span>object</span>
317 <var><span>launchInfo</span></var></span><span class="null "><span>, </span><span>function</span>
318 <var><span>callback</span></var></span>)</div>
319 <div class="description">
320 <p>Starts an auth flow at the specified URL.</p>
321 <!-- PARAMETERS -->
322 <h4>Parameters</h4>
323 <dl>
324 <div>
325 <div>
326 <dt>
327 <var>launchInfo</var>
328 <em>
329 <!-- TYPE -->
330 <div style="display:inline">
331 (
332 <span id="typeTemplate">
333 <span>
334 <span>object</span>
335 </span>
336 </span>
337 )
338 </div>
339 </em>
340 </dt>
341 <dd class="todo">
342 Undocumented.
343 </dd>
344 <!-- OBJECT PROPERTIES -->
345 <dd>
346 <dl>
347 <div>
348 <div>
349 <dt>
350 <var>url</var>
351 <em>
352 <!-- TYPE -->
353 <div style="display:inline">
354 (
355 <span id="typeTemplate">
356 <span>
357 <span>string</span>
358 </span>
359 </span>
360 )
361 </div>
362 </em>
363 </dt>
364 <dd>The URL that initiates the auth flow</dd>
365 <!-- OBJECT PROPERTIES -->
366 <!-- OBJECT METHODS -->
367 <!-- OBJECT EVENT FIELDS -->
368 <!-- FUNCTION PARAMETERS -->
369 </div>
370 </div><div>
371 <div>
372 <dt>
373 <var>interactive</var>
374 <em>
375 <!-- TYPE -->
376 <div style="display:inline">
377 (
378 <span class="optional">optional</span>
379 <span id="typeTemplate">
380 <span>
381 <span>boolean</span>
382 </span>
383 </span>
384 )
385 </div>
386 </em>
387 </dt>
388 <dd>Whether to launch auth flow in interactive mode. Default is false. </dd>
389 <!-- OBJECT PROPERTIES -->
390 <!-- OBJECT METHODS -->
391 <!-- OBJECT EVENT FIELDS -->
392 <!-- FUNCTION PARAMETERS -->
393 </div>
394 </div>
395 </dl>
396 </dd>
397 <!-- OBJECT METHODS -->
398 <!-- OBJECT EVENT FIELDS -->
399 <!-- FUNCTION PARAMETERS -->
400 </div>
401 </div><div>
402 <div>
403 <dt>
404 <var>callback</var>
405 <em>
406 <!-- TYPE -->
407 <div style="display:inline">
408 (
409 <span id="typeTemplate">
410 <span>
411 <span>function</span>
412 </span>
413 </span>
414 )
415 </div>
416 </em>
417 </dt>
418 <dd class="todo">
419 Undocumented.
420 </dd>
421 <!-- OBJECT PROPERTIES -->
422 <!-- OBJECT METHODS -->
423 <!-- OBJECT EVENT FIELDS -->
424 <!-- FUNCTION PARAMETERS -->
425 </div>
426 </div>
427 </dl>
428 <!-- RETURNS -->
429 <dl>
430 </dl>
431 <!-- CALLBACK -->
432 <div>
433 <div>
434 <h4>Callback function</h4>
435 <p>
436 The <em>callback</em> parameter should specify a function
437 that looks like this:
438 </p>
439 <!-- Note: intentionally longer 80 columns -->
440 <pre>function(<span>string reponseUrl</span>) <span class="sub dued">{...}</span>;</pre>
441 <dl>
442 <div>
443 <div>
444 <dt>
445 <var>reponseUrl</var>
446 <em>
447 <!-- TYPE -->
448 <div style="display:inline">
449 (
450 <span id="typeTemplate">
451 <span>
452 <span>string</span>
453 </span>
454 </span>
455 )
456 </div>
457 </em>
458 </dt>
459 <dd>The URL redirected back to your application</dd>
460 <!-- OBJECT PROPERTIES -->
461 <!-- OBJECT METHODS -->
462 <!-- OBJECT EVENT FIELDS -->
463 <!-- FUNCTION PARAMETERS -->
464 </div>
465 </div>
466 </dl>
467 </div>
468 </div>
469 <!-- MIN_VERSION -->
470 </div> <!-- /description -->
471 </div> <!-- /apiItem -->
472 </div> <!-- /apiGroup -->
473 <!-- EVENTS -->
474 <!-- /apiGroup -->
475 <!-- TYPES -->
476 <!-- /apiGroup -->
477 </div> <!-- /apiPage -->
478 </div> <!-- /gc-pagecontent -->
479 </div> <!-- /g-section -->
480 </div> <!-- /codesiteContent -->
481 <div id="gc-footer" --="">
482 <div class="text">
483 <p>
484 Except as otherwise <a href="http://code.google.com/policies.html#restrictions ">noted</a>,
485 the content of this page is licensed under the <a rel="license" href="http://c reativecommons.org/licenses/by/3.0/">Creative Commons
486 Attribution 3.0 License</a>, and code samples are licensed under the
487 <a rel="license" href="http://code.google.com/google_bsd_license.html">BSD Lic ense</a>.
488 </p>
489 <p>
490 ©2011 Google
491 </p>
492 <!-- begin analytics -->
493 <script src="https://www.google-analytics.com/urchin.js" type="text/javascript"> </script>
494 <script src="https://www.google-analytics.com/ga.js" type="text/javascript"></sc ript>
495 <script type="text/javascript">
496 // chrome doc tracking
497 try {
498 var engdocs = _gat._getTracker("YT-10763712-2");
499 engdocs._trackPageview();
500 } catch(err) {}
501 // code.google.com site-wide tracking
502 try {
503 _uacct="UA-18071-1";
504 _uanchor=1;
505 _uff=0;
506 urchinTracker();
507 }
508 catch(e) {/* urchinTracker not available. */}
509 </script>
510 <!-- end analytics -->
511 </div>
512 </div> <!-- /gc-footer -->
513 </div> <!-- /gc-container -->
514 </body></html>
OLDNEW
« no previous file with comments | « chrome/common/extensions/docs/experimental.history.html ('k') | chrome/common/extensions/docs/experimental.idltest.html » ('j') | no next file with comments »

Powered by Google App Engine
This is Rietveld 408576698