chrome/common/extensions/docs/notifications.html - Issue 10642015: Basic setup for generating app docs

Side by Side Diff: chrome/common/extensions/docs/notifications.html

Issue 10642015: Basic setup for generating app docs (Closed) Base URL: svn://svn.chromium.org/chrome/trunk/src

Patch Set: fix 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

OLD	NEW
	(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 <title>Desktop Notifications - 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&t13n_langs=en"></script>

70 <script type="text/javascript" src="https://www.google.com/coop/cse/br and?form=cse&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 class="leftNavSelected">Desktop Notifications</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">Desktop Notifications</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><li>

199 <a href="#communication">Communicating with other views</a>

200 <ol>

201 </ol>

202 </li><li>

203 <a href="#examples"> Examples </a>

204 <ol>

205 </ol>

206 </li><li>

207 <a href="#api">API</a>

208 <ol>

209 </ol>

210 </li>

211 </ol>

212 </div>

213 <!-- /TABLE OF CONTENTS -->

214 <!-- Standard content lead-in for experimental API pages -->

215 <!-- STATIC CONTENT PLACEHOLDER -->

216 <div id="static"><div id="pageData-name" class="pageData">Desktop Notifi cations</div>

217 <div id="pageData-showTOC" class="pageData">true</div>

218 <!-- BEGIN AUTHORED CONTENT -->

219 <p>

220 Use desktop notifications to notify users that something

221 important has happened.

222 Notifications appear outside the browser window.

223 As the following snapshots show,

224 the details of how notifications look

225 and where they're shown depend on the platform.

226 </p>

227 <img src="images/notification-windows.png" width="28%" style="margin:2em 0.5em 1 em; border:1px solid black;" alt="Notifications on Microsoft Windows">

228 <img src="images/notification-mac.png" width="28%" style="margin:2em 0.5em 1em; border:1px solid black;" alt="Notifications on Mac OS X">

229 <img src="images/notification-linux.png" width="28%" style="margin:2em 0.5em 1em ; border:1px solid black;" alt="Notifications on Ubuntu Linux">

230 <p>

231 You create the notification window

232 using a bit of JavaScript and, optionally,

233 an HTML page packaged inside your extension.

234 </p>

235 <h2 id="manifest">Manifest</h2>

236 <p>

237 You can request the notification permission

238 in the <a href="manifest.html">extension manifest</a>,

239 like this:

240 </p>

241 <pre>{

242 "name": "My extension",

243 ...

244 <b> "permissions": [

245 "notifications"

246 ]</b>,

247 ...

248 }</pre>

249 <p class="note">

250 <b>Note:</b> Extensions that declare

251 the <code>notifications</code> permission

252 are always allowed to create notifications.

253 There is no need to call

254 <code>webkitNotifications.checkPermission()</code>.

255 </p>

256 <h2 id="communication">Communicating with other views</h2>

257 <p>

258 You can communicate between a notification

259 and other views in your extension using

260 <a href="extension.html#method-getBackgroundPage">getBackgroundPage()</a> and

261 <a href="extension.html#method-getViews">getViews()</a>. For example:

262 </p>

263 <pre>// Inside a notification...

264 chrome.extension.getBackgroundPage().doThing();

265 // From the background page...

266 chrome.extension.getViews({type:"notification"}).forEach(function(win) {

267 win.doOtherThing();

268 });

269 </pre>

270 <h2 id="examples"> Examples </h2>

271 <p>

272 You can find a simple example

273 of using notifications in the

274 <a href="http://src.chromium.org/viewvc/chrome/trunk/src/chrome/common/extension s/docs/examples/api/notifications/">examples/api/notifications</a>

275 directory.

276 For other examples

277 and for help in viewing the source code,

278 see <a href="samples.html">Samples</a>.

279 </p>

280 <p>

281 Also see html5rocks.com's

282 <a href="http://www.html5rocks.com/tutorials/notifications/quick/">notifications tutorial</a>.

283 Ignore the permission-related code;

284 it's unnecessary if you declare the "notifications" permission.

285 </p>

286 <h2 id="api">API</h2>

287 <p>

288 The desktop notification API for extensions

289 is the same one that

290 is available to normal web pages.

291 As the following code shows,

292 you first create either a simple text notification

293 or an HTML notification,

294 and then you show the notification.

295 </p>

296 <pre>// Create a simple text notification:

297 var notification = webkitNotifications.createNotification(

298 '48.png', // icon url - can be relative

299 'Hello!', // notification title

300 'Lorem ipsum...' // notification body text

301 );

302 // Or create an HTML notification:

303 var notification = webkitNotifications.createHTMLNotification(

304 'notification.html' // html url - can be relative

305 );

306 // Then show the notification.

307 notification.show();

308 </pre>

309 <p>For complete API details,

310 see the <a href="http://dev.chromium.org/developers/design-documents/desktop-not ifications/api-specification">Desktop notifications draft specification</a>.</p>

311 <!-- END AUTHORED CONTENT -->

312 </div>

313 <!-- API PAGE -->

314 <!-- /apiPage -->

315 </div> <!-- /gc-pagecontent -->

316 </div> <!-- /g-section -->

317 </div> <!-- /codesiteContent -->

318 <div id="gc-footer" --="">

319 <div class="text">

320 <p>

321 Except as otherwise <a href="http://code.google.com/policies.html#restrictions ">noted</a>,

322 the content of this page is licensed under the <a rel="license" href="http://c reativecommons.org/licenses/by/3.0/">Creative Commons

323 Attribution 3.0 License</a>, and code samples are licensed under the

324 <a rel="license" href="http://code.google.com/google_bsd_license.html">BSD Lic ense</a>.

325 </p>

326 <p>

327 ©2011 Google

328 </p>

329 <!-- begin analytics -->

330 <script src="https://www.google-analytics.com/urchin.js" type="text/javascript"> </script>

331 <script src="https://www.google-analytics.com/ga.js" type="text/javascript"></sc ript>

332 <script type="text/javascript">

333 // chrome doc tracking

334 try {

335 var engdocs = _gat._getTracker("YT-10763712-2");

336 engdocs._trackPageview();

337 } catch(err) {}

338 // code.google.com site-wide tracking

339 try {

340 _uacct="UA-18071-1";

341 _uanchor=1;

342 _uff=0;

343 urchinTracker();

344 }

345 catch(e) {/* urchinTracker not available. */}

346 </script>

347 <!-- end analytics -->

348 </div>

349 </div> <!-- /gc-footer -->

350 </div> <!-- /gc-container -->

351 </body></html>

OLD	NEW