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

Unified Diff: chrome/common/extensions/docs/server2/templates/articles/notifications.html

Issue 10832042: Extensions Docs Server: Doc conversion script (Closed) Base URL: svn://svn.chromium.org/chrome/trunk/src
Patch Set: everything but svn stuff Created 8 years, 5 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 side-by-side diff with in-line comments
Download patch
Index: chrome/common/extensions/docs/server2/templates/articles/notifications.html
diff --git a/chrome/common/extensions/docs/server2/templates/articles/notifications.html b/chrome/common/extensions/docs/server2/templates/articles/notifications.html
new file mode 100644
index 0000000000000000000000000000000000000000..6bb64aae2d88ceb8f78ff4e729222d88fdda8477
--- /dev/null
+++ b/chrome/common/extensions/docs/server2/templates/articles/notifications.html
@@ -0,0 +1,125 @@
+<h1>Desktop Notifications</h1>
+
+
+
+<p>
+Use desktop notifications to notify users that something
+important has happened.
+Notifications appear outside the browser window.
+As the following snapshots show,
+the details of how notifications look
+and where they're shown depend on the platform.
+</p>
+
+<img src="{{static}}/images/notification-windows.png"
+ width="28%" style="margin:2em 0.5em 1em; border:1px solid black;"
+ alt="Notifications on Microsoft Windows"/>
+<img src="{{static}}/images/notification-mac.png"
+ width="28%" style="margin:2em 0.5em 1em; border:1px solid black;"
+ alt="Notifications on Mac OS X"/>
+<img src="{{static}}/images/notification-linux.png"
+ width="28%" style="margin:2em 0.5em 1em; border:1px solid black;"
+ alt="Notifications on Ubuntu Linux"/>
+
+<p>
+You create the notification window
+using a bit of JavaScript and, optionally,
+an HTML page packaged inside your extension.
+</p>
+
+
+<h2 id="manifest">Manifest</h2>
+
+<p>
+You can request the notification permission
+in the <a href="manifest.html">extension manifest</a>,
+like this:
+</p>
+
+<pre>{
+ "name": "My extension",
+ ...
+<b> "permissions": [
+ "notifications"
+ ]</b>,
+ ...
+}</pre>
+
+<p class="note">
+<b>Note:</b> Extensions that declare
+the <code>notifications</code> permission
+are always allowed to create notifications.
+There is no need to call
+<code>webkitNotifications.checkPermission()</code>.
+</p>
+
+<h2 id="communication">Communicating with other views</h2>
+
+<p>
+You can communicate between a notification
+and other views in your extension using
+<a href="extension.html#method-getBackgroundPage">getBackgroundPage()</a> and
+<a href="extension.html#method-getViews">getViews()</a>. For example:
+</p>
+
+<pre>
+// Inside a notification...
+chrome.extension.getBackgroundPage().doThing();
+
+// From the background page...
+chrome.extension.getViews({type:"notification"}).forEach(function(win) {
+ win.doOtherThing();
+});
+</pre>
+
+
+<h2 id="examples"> Examples </h2>
+
+<p>
+You can find a simple example
+of using notifications in the
+<a href="http://src.chromium.org/viewvc/chrome/trunk/src/chrome/common/extensions/docs/examples/api/notifications/">examples/api/notifications</a>
+directory.
+For other examples
+and for help in viewing the source code,
+see <a href="samples.html">Samples</a>.
+</p>
+
+<p>
+Also see html5rocks.com's
+<a href="http://www.html5rocks.com/tutorials/notifications/quick/">notifications tutorial</a>.
+Ignore the permission-related code;
+it's unnecessary if you declare the "notifications" permission.
+</p>
+
+<h2 id="api">API</h2>
+
+<p>
+The desktop notification API for extensions
+is the same one that
+is available to normal web pages.
+As the following code shows,
+you first create either a simple text notification
+or an HTML notification,
+and then you show the notification.
+</p>
+
+<pre>
+// Create a simple text notification:
+var notification = webkitNotifications.createNotification(
+ '48.png', // icon url - can be relative
+ 'Hello!', // notification title
+ 'Lorem ipsum...' // notification body text
+);
+
+// Or create an HTML notification:
+var notification = webkitNotifications.createHTMLNotification(
+ 'notification.html' // html url - can be relative
+);
+
+// Then show the notification.
+notification.show();
+</pre>
+
+<p>For complete API details,
+see the <a href="http://dev.chromium.org/developers/design-documents/desktop-notifications/api-specification">Desktop notifications draft specification</a>.</p>

Powered by Google App Engine
This is Rietveld 408576698