diff options
Diffstat (limited to 'chrome/common/extensions/docs')
51 files changed, 732 insertions, 2 deletions
diff --git a/chrome/common/extensions/docs/api_index.html b/chrome/common/extensions/docs/api_index.html index 9b2a5f8..e002a98 100644 --- a/chrome/common/extensions/docs/api_index.html +++ b/chrome/common/extensions/docs/api_index.html @@ -135,6 +135,7 @@ <li>Browser UI <ul> <li><a href="browserAction.html">Browser Actions</a></li> + <li><a href="notifications.html">Desktop Notifications</a></li> <li><a href="options.html">Options Pages</a></li> <li><a href="override.html">Override Pages</a></li> <li><a href="pageAction.html">Page Actions</a></li> diff --git a/chrome/common/extensions/docs/api_other.html b/chrome/common/extensions/docs/api_other.html index 55cf6ca..08e2aa8 100644 --- a/chrome/common/extensions/docs/api_other.html +++ b/chrome/common/extensions/docs/api_other.html @@ -135,6 +135,7 @@ <li>Browser UI <ul> <li><a href="browserAction.html">Browser Actions</a></li> + <li><a href="notifications.html">Desktop Notifications</a></li> <li><a href="options.html">Options Pages</a></li> <li><a href="override.html">Override Pages</a></li> <li><a href="pageAction.html">Page Actions</a></li> diff --git a/chrome/common/extensions/docs/autoupdate.html b/chrome/common/extensions/docs/autoupdate.html index cee4da5..b9e4fc9 100644 --- a/chrome/common/extensions/docs/autoupdate.html +++ b/chrome/common/extensions/docs/autoupdate.html @@ -135,6 +135,7 @@ <li>Browser UI <ul> <li><a href="browserAction.html">Browser Actions</a></li> + <li><a href="notifications.html">Desktop Notifications</a></li> <li><a href="options.html">Options Pages</a></li> <li><a href="override.html">Override Pages</a></li> <li><a href="pageAction.html">Page Actions</a></li> diff --git a/chrome/common/extensions/docs/background_pages.html b/chrome/common/extensions/docs/background_pages.html index 1522f26..269105f 100644 --- a/chrome/common/extensions/docs/background_pages.html +++ b/chrome/common/extensions/docs/background_pages.html @@ -135,6 +135,7 @@ <li>Browser UI <ul> <li><a href="browserAction.html">Browser Actions</a></li> + <li><a href="notifications.html">Desktop Notifications</a></li> <li><a href="options.html">Options Pages</a></li> <li><a href="override.html">Override Pages</a></li> <li><a href="pageAction.html">Page Actions</a></li> diff --git a/chrome/common/extensions/docs/bookmarks.html b/chrome/common/extensions/docs/bookmarks.html index cb12c07..65b0b93 100644 --- a/chrome/common/extensions/docs/bookmarks.html +++ b/chrome/common/extensions/docs/bookmarks.html @@ -135,6 +135,7 @@ <li>Browser UI <ul> <li><a href="browserAction.html">Browser Actions</a></li> + <li><a href="notifications.html">Desktop Notifications</a></li> <li><a href="options.html">Options Pages</a></li> <li><a href="override.html">Override Pages</a></li> <li><a href="pageAction.html">Page Actions</a></li> diff --git a/chrome/common/extensions/docs/browserAction.html b/chrome/common/extensions/docs/browserAction.html index f73c836..221e268 100644 --- a/chrome/common/extensions/docs/browserAction.html +++ b/chrome/common/extensions/docs/browserAction.html @@ -135,6 +135,7 @@ <li>Browser UI <ul> <li class="leftNavSelected">Browser Actions</li> + <li><a href="notifications.html">Desktop Notifications</a></li> <li><a href="options.html">Options Pages</a></li> <li><a href="override.html">Override Pages</a></li> <li><a href="pageAction.html">Page Actions</a></li> diff --git a/chrome/common/extensions/docs/content_scripts.html b/chrome/common/extensions/docs/content_scripts.html index 8796370..723a7d1 100644 --- a/chrome/common/extensions/docs/content_scripts.html +++ b/chrome/common/extensions/docs/content_scripts.html @@ -135,6 +135,7 @@ <li>Browser UI <ul> <li><a href="browserAction.html">Browser Actions</a></li> + <li><a href="notifications.html">Desktop Notifications</a></li> <li><a href="options.html">Options Pages</a></li> <li><a href="override.html">Override Pages</a></li> <li><a href="pageAction.html">Page Actions</a></li> diff --git a/chrome/common/extensions/docs/devguide.html b/chrome/common/extensions/docs/devguide.html index 0376183..2484550 100644 --- a/chrome/common/extensions/docs/devguide.html +++ b/chrome/common/extensions/docs/devguide.html @@ -135,6 +135,7 @@ <li>Browser UI <ul> <li><a href="browserAction.html">Browser Actions</a></li> + <li><a href="notifications.html">Desktop Notifications</a></li> <li><a href="options.html">Options Pages</a></li> <li><a href="override.html">Override Pages</a></li> <li><a href="pageAction.html">Page Actions</a></li> @@ -271,6 +272,10 @@ and <a href="overview.html">Overview</a>. <td> Add icons to the toolbar </td> </tr> <tr> + <td> <a href="notifications.html">Desktop Notifications</a> </td> + <td> Notify users of important events </td> + </tr> + <tr> <td> <a href="options.html">Options Pages</a> </td> <td> Let users customize your extension </td> </tr> diff --git a/chrome/common/extensions/docs/docs.html b/chrome/common/extensions/docs/docs.html index 9ee0686..64c4370 100644 --- a/chrome/common/extensions/docs/docs.html +++ b/chrome/common/extensions/docs/docs.html @@ -135,6 +135,7 @@ <li>Browser UI <ul> <li><a href="browserAction.html">Browser Actions</a></li> + <li><a href="notifications.html">Desktop Notifications</a></li> <li><a href="options.html">Options Pages</a></li> <li><a href="override.html">Override Pages</a></li> <li><a href="pageAction.html">Page Actions</a></li> diff --git a/chrome/common/extensions/docs/events.html b/chrome/common/extensions/docs/events.html index 0d9df92..15ad822 100644 --- a/chrome/common/extensions/docs/events.html +++ b/chrome/common/extensions/docs/events.html @@ -135,6 +135,7 @@ <li>Browser UI <ul> <li><a href="browserAction.html">Browser Actions</a></li> + <li><a href="notifications.html">Desktop Notifications</a></li> <li><a href="options.html">Options Pages</a></li> <li><a href="override.html">Override Pages</a></li> <li><a href="pageAction.html">Page Actions</a></li> diff --git a/chrome/common/extensions/docs/experimental.clipboard.html b/chrome/common/extensions/docs/experimental.clipboard.html index cca046e..85c85b8 100644 --- a/chrome/common/extensions/docs/experimental.clipboard.html +++ b/chrome/common/extensions/docs/experimental.clipboard.html @@ -135,6 +135,7 @@ <li>Browser UI <ul> <li><a href="browserAction.html">Browser Actions</a></li> + <li><a href="notifications.html">Desktop Notifications</a></li> <li><a href="options.html">Options Pages</a></li> <li><a href="override.html">Override Pages</a></li> <li><a href="pageAction.html">Page Actions</a></li> diff --git a/chrome/common/extensions/docs/experimental.contextMenu.html b/chrome/common/extensions/docs/experimental.contextMenu.html index f416d0d..5566903 100644 --- a/chrome/common/extensions/docs/experimental.contextMenu.html +++ b/chrome/common/extensions/docs/experimental.contextMenu.html @@ -135,6 +135,7 @@ <li>Browser UI <ul> <li><a href="browserAction.html">Browser Actions</a></li> + <li><a href="notifications.html">Desktop Notifications</a></li> <li><a href="options.html">Options Pages</a></li> <li><a href="override.html">Override Pages</a></li> <li><a href="pageAction.html">Page Actions</a></li> diff --git a/chrome/common/extensions/docs/experimental.cookies.html b/chrome/common/extensions/docs/experimental.cookies.html index 8a1208e..860e348 100644 --- a/chrome/common/extensions/docs/experimental.cookies.html +++ b/chrome/common/extensions/docs/experimental.cookies.html @@ -135,6 +135,7 @@ <li>Browser UI <ul> <li><a href="browserAction.html">Browser Actions</a></li> + <li><a href="notifications.html">Desktop Notifications</a></li> <li><a href="options.html">Options Pages</a></li> <li><a href="override.html">Override Pages</a></li> <li><a href="pageAction.html">Page Actions</a></li> diff --git a/chrome/common/extensions/docs/experimental.html b/chrome/common/extensions/docs/experimental.html index c21d70b..8dd43e7 100644 --- a/chrome/common/extensions/docs/experimental.html +++ b/chrome/common/extensions/docs/experimental.html @@ -135,6 +135,7 @@ <li>Browser UI <ul> <li><a href="browserAction.html">Browser Actions</a></li> + <li><a href="notifications.html">Desktop Notifications</a></li> <li><a href="options.html">Options Pages</a></li> <li><a href="override.html">Override Pages</a></li> <li><a href="pageAction.html">Page Actions</a></li> diff --git a/chrome/common/extensions/docs/experimental.infobars.html b/chrome/common/extensions/docs/experimental.infobars.html index 964d0ea..bf2df8c 100644 --- a/chrome/common/extensions/docs/experimental.infobars.html +++ b/chrome/common/extensions/docs/experimental.infobars.html @@ -135,6 +135,7 @@ <li>Browser UI <ul> <li><a href="browserAction.html">Browser Actions</a></li> + <li><a href="notifications.html">Desktop Notifications</a></li> <li><a href="options.html">Options Pages</a></li> <li><a href="override.html">Override Pages</a></li> <li><a href="pageAction.html">Page Actions</a></li> diff --git a/chrome/common/extensions/docs/experimental.processes.html b/chrome/common/extensions/docs/experimental.processes.html index 226ea0d..2668f8f 100644 --- a/chrome/common/extensions/docs/experimental.processes.html +++ b/chrome/common/extensions/docs/experimental.processes.html @@ -135,6 +135,7 @@ <li>Browser UI <ul> <li><a href="browserAction.html">Browser Actions</a></li> + <li><a href="notifications.html">Desktop Notifications</a></li> <li><a href="options.html">Options Pages</a></li> <li><a href="override.html">Override Pages</a></li> <li><a href="pageAction.html">Page Actions</a></li> diff --git a/chrome/common/extensions/docs/extension.html b/chrome/common/extensions/docs/extension.html index 4a1f223..c85abc3 100644 --- a/chrome/common/extensions/docs/extension.html +++ b/chrome/common/extensions/docs/extension.html @@ -135,6 +135,7 @@ <li>Browser UI <ul> <li><a href="browserAction.html">Browser Actions</a></li> + <li><a href="notifications.html">Desktop Notifications</a></li> <li><a href="options.html">Options Pages</a></li> <li><a href="override.html">Override Pages</a></li> <li><a href="pageAction.html">Page Actions</a></li> diff --git a/chrome/common/extensions/docs/external_extensions.html b/chrome/common/extensions/docs/external_extensions.html index ce832c3..4e489ad 100644 --- a/chrome/common/extensions/docs/external_extensions.html +++ b/chrome/common/extensions/docs/external_extensions.html @@ -135,6 +135,7 @@ <li>Browser UI <ul> <li><a href="browserAction.html">Browser Actions</a></li> + <li><a href="notifications.html">Desktop Notifications</a></li> <li><a href="options.html">Options Pages</a></li> <li><a href="override.html">Override Pages</a></li> <li><a href="pageAction.html">Page Actions</a></li> diff --git a/chrome/common/extensions/docs/faq.html b/chrome/common/extensions/docs/faq.html index a76fd86..a0a62f9 100644 --- a/chrome/common/extensions/docs/faq.html +++ b/chrome/common/extensions/docs/faq.html @@ -135,6 +135,7 @@ <li>Browser UI <ul> <li><a href="browserAction.html">Browser Actions</a></li> + <li><a href="notifications.html">Desktop Notifications</a></li> <li><a href="options.html">Options Pages</a></li> <li><a href="override.html">Override Pages</a></li> <li><a href="pageAction.html">Page Actions</a></li> diff --git a/chrome/common/extensions/docs/getstarted.html b/chrome/common/extensions/docs/getstarted.html index f04de6f..9d65b03 100644 --- a/chrome/common/extensions/docs/getstarted.html +++ b/chrome/common/extensions/docs/getstarted.html @@ -135,6 +135,7 @@ <li>Browser UI <ul> <li><a href="browserAction.html">Browser Actions</a></li> + <li><a href="notifications.html">Desktop Notifications</a></li> <li><a href="options.html">Options Pages</a></li> <li><a href="override.html">Override Pages</a></li> <li><a href="pageAction.html">Page Actions</a></li> diff --git a/chrome/common/extensions/docs/history.html b/chrome/common/extensions/docs/history.html index a6bf9b1..752ce0f 100644 --- a/chrome/common/extensions/docs/history.html +++ b/chrome/common/extensions/docs/history.html @@ -135,6 +135,7 @@ <li>Browser UI <ul> <li><a href="browserAction.html">Browser Actions</a></li> + <li><a href="notifications.html">Desktop Notifications</a></li> <li><a href="options.html">Options Pages</a></li> <li><a href="override.html">Override Pages</a></li> <li><a href="pageAction.html">Page Actions</a></li> diff --git a/chrome/common/extensions/docs/hosting.html b/chrome/common/extensions/docs/hosting.html index 1095b26..46eea86 100644 --- a/chrome/common/extensions/docs/hosting.html +++ b/chrome/common/extensions/docs/hosting.html @@ -135,6 +135,7 @@ <li>Browser UI <ul> <li><a href="browserAction.html">Browser Actions</a></li> + <li><a href="notifications.html">Desktop Notifications</a></li> <li><a href="options.html">Options Pages</a></li> <li><a href="override.html">Override Pages</a></li> <li><a href="pageAction.html">Page Actions</a></li> diff --git a/chrome/common/extensions/docs/i18n-messages.html b/chrome/common/extensions/docs/i18n-messages.html index 4b2ce47..32027a4 100644 --- a/chrome/common/extensions/docs/i18n-messages.html +++ b/chrome/common/extensions/docs/i18n-messages.html @@ -135,6 +135,7 @@ <li>Browser UI <ul> <li><a href="browserAction.html">Browser Actions</a></li> + <li><a href="notifications.html">Desktop Notifications</a></li> <li><a href="options.html">Options Pages</a></li> <li><a href="override.html">Override Pages</a></li> <li><a href="pageAction.html">Page Actions</a></li> diff --git a/chrome/common/extensions/docs/i18n.html b/chrome/common/extensions/docs/i18n.html index 7d91741..70183f9 100644 --- a/chrome/common/extensions/docs/i18n.html +++ b/chrome/common/extensions/docs/i18n.html @@ -135,6 +135,7 @@ <li>Browser UI <ul> <li><a href="browserAction.html">Browser Actions</a></li> + <li><a href="notifications.html">Desktop Notifications</a></li> <li><a href="options.html">Options Pages</a></li> <li><a href="override.html">Override Pages</a></li> <li><a href="pageAction.html">Page Actions</a></li> diff --git a/chrome/common/extensions/docs/images/notification-linux.png b/chrome/common/extensions/docs/images/notification-linux.png Binary files differnew file mode 100644 index 0000000..5f006c4 --- /dev/null +++ b/chrome/common/extensions/docs/images/notification-linux.png diff --git a/chrome/common/extensions/docs/images/notification-mac.png b/chrome/common/extensions/docs/images/notification-mac.png Binary files differnew file mode 100644 index 0000000..34c88db --- /dev/null +++ b/chrome/common/extensions/docs/images/notification-mac.png diff --git a/chrome/common/extensions/docs/images/notification-windows.png b/chrome/common/extensions/docs/images/notification-windows.png Binary files differnew file mode 100644 index 0000000..673d917 --- /dev/null +++ b/chrome/common/extensions/docs/images/notification-windows.png diff --git a/chrome/common/extensions/docs/index.html b/chrome/common/extensions/docs/index.html index 6fbb7bc..5e83c45 100644 --- a/chrome/common/extensions/docs/index.html +++ b/chrome/common/extensions/docs/index.html @@ -135,6 +135,7 @@ <li>Browser UI <ul> <li><a href="browserAction.html">Browser Actions</a></li> + <li><a href="notifications.html">Desktop Notifications</a></li> <li><a href="options.html">Options Pages</a></li> <li><a href="override.html">Override Pages</a></li> <li><a href="pageAction.html">Page Actions</a></li> diff --git a/chrome/common/extensions/docs/manifest.html b/chrome/common/extensions/docs/manifest.html index e29ff57..ae7b46d 100644 --- a/chrome/common/extensions/docs/manifest.html +++ b/chrome/common/extensions/docs/manifest.html @@ -135,6 +135,7 @@ <li>Browser UI <ul> <li><a href="browserAction.html">Browser Actions</a></li> + <li><a href="notifications.html">Desktop Notifications</a></li> <li><a href="options.html">Options Pages</a></li> <li><a href="override.html">Override Pages</a></li> <li><a href="pageAction.html">Page Actions</a></li> @@ -509,7 +510,9 @@ The following table lists the permissions an extension can use. <td> Allows the extension to use the proposed HTML5 <a href="http://www.chromium.org/developers/design-documents/desktop-notifications/api-specification">notification API</a> without calling permission methods - (such as <code>checkPermission()</code>). </td> + (such as <code>checkPermission()</code>). + For more information see + <a href="notifications.html">Desktop Notifications</a>.</td> </tr> <tr> <td> "tabs" </td> diff --git a/chrome/common/extensions/docs/match_patterns.html b/chrome/common/extensions/docs/match_patterns.html index 05f772e..503d2dc 100644 --- a/chrome/common/extensions/docs/match_patterns.html +++ b/chrome/common/extensions/docs/match_patterns.html @@ -135,6 +135,7 @@ <li>Browser UI <ul> <li><a href="browserAction.html">Browser Actions</a></li> + <li><a href="notifications.html">Desktop Notifications</a></li> <li><a href="options.html">Options Pages</a></li> <li><a href="override.html">Override Pages</a></li> <li><a href="pageAction.html">Page Actions</a></li> diff --git a/chrome/common/extensions/docs/messaging.html b/chrome/common/extensions/docs/messaging.html index 1ae04b4..ee27119 100644 --- a/chrome/common/extensions/docs/messaging.html +++ b/chrome/common/extensions/docs/messaging.html @@ -135,6 +135,7 @@ <li>Browser UI <ul> <li><a href="browserAction.html">Browser Actions</a></li> + <li><a href="notifications.html">Desktop Notifications</a></li> <li><a href="options.html">Options Pages</a></li> <li><a href="override.html">Override Pages</a></li> <li><a href="pageAction.html">Page Actions</a></li> diff --git a/chrome/common/extensions/docs/notifications.html b/chrome/common/extensions/docs/notifications.html new file mode 100644 index 0000000..e78a56f --- /dev/null +++ b/chrome/common/extensions/docs/notifications.html @@ -0,0 +1,554 @@ +<!DOCTYPE html><!-- This page is a placeholder for generated extensions api doc. Note: + 1) The <head> information in this page is significant, should be uniform + across api docs and should be edited only with knowledge of the + templating mechanism. + 3) All <body>.innerHTML is genereated as an rendering step. If viewed in a + browser, it will be re-generated from the template, json schema and + authored overview content. + 4) The <body>.innerHTML is also generated by an offline step so that this + page may easily be indexed by search engines. +--><html xmlns="http://www.w3.org/1999/xhtml"><head> + <meta http-equiv="Content-Type" content="text/html; charset=UTF-8"> + <link href="css/ApiRefStyles.css" rel="stylesheet" type="text/css"> + <link href="css/print.css" rel="stylesheet" type="text/css" media="print"> + <script type="text/javascript" src="../../../third_party/jstemplate/jstemplate_compiled.js"> + </script> + <script type="text/javascript" src="js/api_page_generator.js"></script> + <script type="text/javascript" src="js/bootstrap.js"></script> + <title>Desktop Notifications - Google Chrome Extensions - Google Code</title></head><body> <div id="gc-container" class="labs"> + <div id="devModeWarning"> + You are viewing extension docs in chrome via the 'file:' scheme: are you expecting to see local changes when you refresh? You'll need run chrome with --allow-file-access-from-files. + </div> + <!-- SUBTEMPLATES: DO NOT MOVE FROM THIS LOCATION --> + <!-- In particular, sub-templates that recurse, must be used by allowing + jstemplate to make a copy of the template in this section which + are not operated on by way of the jsskip="true" --> + <div style="display:none"> + + <!-- VALUE --> + <div id="valueTemplate"> + <dt> + <var>paramName</var> + <em> + + <!-- TYPE --> + <div style="display:inline"> + ( + <span class="optional">optional</span> + <span id="typeTemplate"> + <span> + <a> Type</a> + </span> + <span> + <span> + array of <span><span></span></span> + </span> + <span>paramType</span> + </span> + </span> + ) + </div> + + </em> + </dt> + <dd class="todo"> + Undocumented. + </dd> + <dd> + Description of this parameter from the json schema. + </dd> + + <!-- OBJECT PROPERTIES --> + <dd> + <dl> + <div> + <div> + </div> + </div> + </dl> + </dd> + </div> <!-- /VALUE --> + + </div> <!-- /SUBTEMPLATES --> + + <a id="top"></a> + <div id="skipto"> + <a href="#gc-pagecontent">Skip to page content</a> + <a href="#gc-toc">Skip to main navigation</a> + </div> + <!-- API HEADER --> + <table id="header" width="100%" cellspacing="0" border="0"> + <tbody><tr> + <td valign="middle"><a href="http://code.google.com/"><img src="images/code_labs_logo.gif" height="43" width="161" alt="Google Code Labs" style="border:0; margin:0;"></a></td> + <td valign="middle" width="100%" style="padding-left:0.6em;"> + <form action="http://www.google.com/cse" id="cse" style="margin-top:0.5em"> + <div id="gsc-search-box"> + <input type="hidden" name="cx" value="002967670403910741006:61_cvzfqtno"> + <input type="hidden" name="ie" value="UTF-8"> + <input type="text" name="q" value="" size="55"> + <input class="gsc-search-button" type="submit" name="sa" value="Search"> + <br> + <span class="greytext">e.g. "page action" or "tabs"</span> + </div> + </form> + + <script type="text/javascript" src="http://www.google.com/jsapi"></script> + <script type="text/javascript">google.load("elements", "1", {packages: "transliteration"});</script> + <script type="text/javascript" src="http://www.google.com/coop/cse/t13n?form=cse&t13n_langs=en"></script> + <script type="text/javascript" src="http://www.google.com/coop/cse/brand?form=cse&lang=en"></script> + </td> + </tr> + </tbody></table> + + <div id="codesiteContent" class=""> + + <a id="gc-topnav-anchor"></a> + <div id="gc-topnav"> + <h1>Google Chrome Extensions (<a href="http://code.google.com/labs/">Labs</a>)</h1> + <ul id="home" class="gc-topnav-tabs"> + <li id="home_link"> + <a href="index.html" title="Google Chrome Extensions home page">Home</a> + </li> + <li id="docs_link"> + <a href="docs.html" title="Official Google Chrome Extensions documentation">Docs</a> + </li> + <li id="faq_link"> + <a href="faq.html" title="Answers to frequently asked questions about Google Chrome Extensions">FAQ</a> + </li> + <li id="samples_link"> + <a href="samples.html" title="Sample extensions (with source code)">Samples</a> + </li> + <li id="group_link"> + <a href="http://groups.google.com/a/chromium.org/group/chromium-extensions" title="Google Chrome Extensions developer forum">Group</a> + </li> + </ul> + </div> <!-- end gc-topnav --> + + <div class="g-section g-tpl-170"> + <!-- SIDENAV --> + <div class="g-unit g-first" id="gc-toc"> + <ul> + <li><a href="getstarted.html">Getting Started</a></li> + <li><a href="overview.html">Overview</a></li> + <li><h2><a href="devguide.html">Developer's Guide</a></h2> + <ul> + <li>Browser UI + <ul> + <li><a href="browserAction.html">Browser Actions</a></li> + <li class="leftNavSelected">Desktop Notifications</li> + <li><a href="options.html">Options Pages</a></li> + <li><a href="override.html">Override Pages</a></li> + <li><a href="pageAction.html">Page Actions</a></li> + <li><a href="themes.html">Themes</a></li> + </ul> + </li> + <li>Browser Interaction + <ul> + <li><a href="bookmarks.html">Bookmarks</a></li> + <li><a href="events.html">Events</a></li> + <li><a href="history.html">History</a></li> + <li><a href="tabs.html">Tabs</a></li> + <li><a href="windows.html">Windows</a></li> + </ul> + </li> + <li>Implementation + <ul> + <li><a href="background_pages.html">Background Pages</a></li> + <li><a href="content_scripts.html">Content Scripts</a></li> + <li><a href="xhr.html">Cross-Origin XHR</a></li> + <li><a href="i18n.html">Internationalization</a></li> + <li><a href="messaging.html">Message Passing</a></li> + <li><a href="npapi.html">NPAPI Plugins</a></li> + </ul> + </li> + <li>Finishing + <ul> + <li><a href="autoupdate.html">Autoupdating</a></li> + <li><a href="packaging.html">Packaging</a></li> + <li><a href="external_extensions.html">External Extensions</a></li> + </ul> + </li> + </ul> + </li> + <li><h2><a href="tutorials.html">Tutorials</a></h2> + <ul> + <li><a href="tut_debugging.html">Debugging</a></li> + <li><a href="tut_analytics.html">Google Analytics</a></li> + <li><a href="tut_oauth.html">OAuth</a></li> + </ul> + </li> + <li><h2>Reference</h2> + <ul> + <li>Formats + <ul> + <li><a href="manifest.html">Manifest Files</a></li> + <li><a href="match_patterns.html">Match Patterns</a></li> + <!-- <li>Packages (.crx)</li> --> + </ul> + </li> + <li><a href="api_index.html">chrome.* APIs</a></li> + <li><a href="api_other.html">Other APIs</a></li> + </ul> + </li> + <li><h2><a href="samples.html">Samples</a></h2></li> + </ul> + </div> + + <div class="g-unit" id="gc-pagecontent"> + <div id="pageTitle"> + <h1 class="page_title">Desktop Notifications</h1> + </div> + <!-- TABLE OF CONTENTS --> + <div id="toc" style="display: none; "> + <h2>Contents</h2> + <ol> + <li> + <a>h2Name</a> + <ol> + <li> + <a>h3Name</a> + </li> + </ol> + </li> + <li> + <a href="#apiReference">API reference</a> + <ol> + <li> + <a href="#properties">Properties</a> + <ol> + <li> + <a href="#property-anchor">propertyName</a> + </li> + </ol> + </li> + <li> + <a href="#methods">Methods</a> + <ol> + <li> + <a href="#method-anchor">methodName</a> + </li> + </ol> + </li> + <li> + <a href="#events">Events</a> + <ol> + <li> + <a href="#event-anchor">eventName</a> + </li> + </ol> + </li> + <li> + <a href="#types">Types</a> + <ol> + <li> + <a href="#id-anchor">id</a> + </li> + </ol> + </li> + </ol> + </li> + </ol> + </div> + <!-- /TABLE OF CONTENTS --> + + <!-- STATIC CONTENT PLACEHOLDER --> + <div id="static"><div id="pageData-name" class="pageData">Desktop Notifications</div> + +<!-- BEGIN AUTHORED CONTENT --> +<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="images/notification-windows.png" width="28%" style="margin:2em 0.5em 1em; border:1px solid black;" alt="Notifications on Microsoft Windows"> +<img src="images/notification-mac.png" width="28%" style="margin:2em 0.5em 1em; border:1px solid black;" alt="Notifications on Mac OS X"> +<img src="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="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>. + + +<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> + +<!-- END AUTHORED CONTENT --> +</div> + + <!-- API PAGE --> + <div class="apiPage" style="display: none; "> + <a name="apiReference"></a> + <h2>API reference: chrome.apiname </h2> + + <!-- PROPERTIES --> + <div class="apiGroup"> + <a name="properties"></a> + <h3 id="properties">Properties</h3> + + <div> + <a></a> + <h4>getLastError</h4> + <div class="summary"> + <!-- Note: intentionally longer 80 columns --> + <span>chrome.extension</span><span>lastError</span> + </div> + <div> + </div> + </div> + + </div> <!-- /apiGroup --> + + <!-- METHODS --> + <div class="apiGroup" id="methods"> + <a name="methods"></a> + <h3>Methods</h3> + + <!-- iterates over all functions --> + <div class="apiItem"> + <a></a> <!-- method-anchor --> + <h4>method name</h4> + + <div class="summary"><span>void</span> + <!-- Note: intentionally longer 80 columns --> + <span>chrome.module.methodName</span>(<span><span>, </span><span></span> + <var><span></span></var></span>)</div> + + <div class="description"> + <p class="todo">Undocumented.</p> + <p> + A description from the json schema def of the function goes here. + </p> + + <!-- PARAMETERS --> + <h4>Parameters</h4> + <dl> + <div> + <div> + </div> + </div> + </dl> + + <!-- RETURNS --> + <h4>Returns</h4> + <dl> + <div> + <div> + </div> + </div> + </dl> + + <!-- CALLBACK --> + <div> + <div> + <h4>Callback function</h4> + <p> + The callback <em>parameter</em> should specify a function + that looks like this: + </p> + <p> + If you specify the <em>callback</em> parameter, it should + specify a function that looks like this: + </p> + + <!-- Note: intentionally longer 80 columns --> + <pre>function(<span>Type param1, Type param2</span>) <span class="subdued">{...}</span>);</pre> + <dl> + <div> + <div> + </div> + </div> + </dl> + </div> + </div> + + </div> <!-- /description --> + + </div> <!-- /apiItem --> + + </div> <!-- /apiGroup --> + + <!-- EVENTS --> + <div class="apiGroup"> + <a name="events"></a> + <h3 id="events">Events</h3> + + <!-- iterates over all events --> + <div class="apiItem"> + <a></a> + <h4>event name</h4> + + <div class="summary"> + <!-- Note: intentionally longer 80 columns --> + <span class="subdued">chrome.bookmarks</span><span>onEvent</span><span class="subdued">.addListener</span>(function(<span>Type param1, Type param2</span>) <span class="subdued">{...}</span>); + </div> + + <div class="description"> + <p class="todo">Undocumented.</p> + <p> + A description from the json schema def of the event goes here. + </p> + + <!-- PARAMETERS --> + <h4>Parameters</h4> + <dl> + <div> + <div> + </div> + </div> + </dl> + + </div> <!-- /decription --> + + </div> <!-- /apiItem --> + + </div> <!-- /apiGroup --> + + <!-- TYPES --> + <div class="apiGroup"> + <a name="types.sort(sortByName)"></a> + <h3 id="types">Types</h3> + + <!-- iterates over all types --> + <div class="apiItem"> + <a></a> + <h4>type name</h4> + + <div> + </div> + + </div> <!-- /apiItem --> + + </div> <!-- /apiGroup --> + + </div> <!-- /apiPage --> + </div> <!-- /gc-pagecontent --> + </div> <!-- /g-section --> + </div> <!-- /codesiteContent --> + <div id="gc-footer" --=""> + <div class="text"> + <p> + Except as otherwise <a href="http://code.google.com/policies.html#restrictions">noted</a>, + the content of this page is licensed under the <a rel="license" href="http://creativecommons.org/licenses/by/3.0/">Creative Commons + Attribution 3.0 License</a>, and code samples are licensed under the + <a rel="license" href="http://code.google.com/google_bsd_license.html">BSD License</a>. + </p> + <p> + ©2009 Google + </p> + +<!-- begin analytics --> +<script src="http://www.google-analytics.com/urchin.js" type="text/javascript"></script> +<script src="http://www.google-analytics.com/ga.js" type="text/javascript"></script> + +<script type="text/javascript"> + // chrome doc tracking + try { + var engdocs = _gat._getTracker("YT-10763712-2"); + engdocs._trackPageview(); + } catch(err) {} + + // code.google.com site-wide tracking + try { + _uacct="UA-18071-1"; + _uanchor=1; + _uff=0; + urchinTracker(); + } + catch(e) {/* urchinTracker not available. */} +</script> +<!-- end analytics --> + </div> + </div> <!-- /gc-footer --> + </div> <!-- /gc-container --> +</body></html> diff --git a/chrome/common/extensions/docs/npapi.html b/chrome/common/extensions/docs/npapi.html index 4717629..702a80e 100644 --- a/chrome/common/extensions/docs/npapi.html +++ b/chrome/common/extensions/docs/npapi.html @@ -135,6 +135,7 @@ <li>Browser UI <ul> <li><a href="browserAction.html">Browser Actions</a></li> + <li><a href="notifications.html">Desktop Notifications</a></li> <li><a href="options.html">Options Pages</a></li> <li><a href="override.html">Override Pages</a></li> <li><a href="pageAction.html">Page Actions</a></li> diff --git a/chrome/common/extensions/docs/options.html b/chrome/common/extensions/docs/options.html index f473d4b..231f2a9 100644 --- a/chrome/common/extensions/docs/options.html +++ b/chrome/common/extensions/docs/options.html @@ -135,6 +135,7 @@ <li>Browser UI <ul> <li><a href="browserAction.html">Browser Actions</a></li> + <li><a href="notifications.html">Desktop Notifications</a></li> <li class="leftNavSelected">Options Pages</li> <li><a href="override.html">Override Pages</a></li> <li><a href="pageAction.html">Page Actions</a></li> diff --git a/chrome/common/extensions/docs/override.html b/chrome/common/extensions/docs/override.html index 07b5724..07ddb7a 100644 --- a/chrome/common/extensions/docs/override.html +++ b/chrome/common/extensions/docs/override.html @@ -135,6 +135,7 @@ <li>Browser UI <ul> <li><a href="browserAction.html">Browser Actions</a></li> + <li><a href="notifications.html">Desktop Notifications</a></li> <li><a href="options.html">Options Pages</a></li> <li class="leftNavSelected">Override Pages</li> <li><a href="pageAction.html">Page Actions</a></li> diff --git a/chrome/common/extensions/docs/overview.html b/chrome/common/extensions/docs/overview.html index d3e896b..98d9a9b 100644 --- a/chrome/common/extensions/docs/overview.html +++ b/chrome/common/extensions/docs/overview.html @@ -135,6 +135,7 @@ <li>Browser UI <ul> <li><a href="browserAction.html">Browser Actions</a></li> + <li><a href="notifications.html">Desktop Notifications</a></li> <li><a href="options.html">Options Pages</a></li> <li><a href="override.html">Override Pages</a></li> <li><a href="pageAction.html">Page Actions</a></li> diff --git a/chrome/common/extensions/docs/packaging.html b/chrome/common/extensions/docs/packaging.html index 4f4a350..4d1310d 100644 --- a/chrome/common/extensions/docs/packaging.html +++ b/chrome/common/extensions/docs/packaging.html @@ -135,6 +135,7 @@ <li>Browser UI <ul> <li><a href="browserAction.html">Browser Actions</a></li> + <li><a href="notifications.html">Desktop Notifications</a></li> <li><a href="options.html">Options Pages</a></li> <li><a href="override.html">Override Pages</a></li> <li><a href="pageAction.html">Page Actions</a></li> diff --git a/chrome/common/extensions/docs/pageAction.html b/chrome/common/extensions/docs/pageAction.html index 269b299..e12c65c 100644 --- a/chrome/common/extensions/docs/pageAction.html +++ b/chrome/common/extensions/docs/pageAction.html @@ -135,6 +135,7 @@ <li>Browser UI <ul> <li><a href="browserAction.html">Browser Actions</a></li> + <li><a href="notifications.html">Desktop Notifications</a></li> <li><a href="options.html">Options Pages</a></li> <li><a href="override.html">Override Pages</a></li> <li class="leftNavSelected">Page Actions</li> diff --git a/chrome/common/extensions/docs/samples.html b/chrome/common/extensions/docs/samples.html index 65edd5d..40b2262 100644 --- a/chrome/common/extensions/docs/samples.html +++ b/chrome/common/extensions/docs/samples.html @@ -135,6 +135,7 @@ <li>Browser UI <ul> <li><a href="browserAction.html">Browser Actions</a></li> + <li><a href="notifications.html">Desktop Notifications</a></li> <li><a href="options.html">Options Pages</a></li> <li><a href="override.html">Override Pages</a></li> <li><a href="pageAction.html">Page Actions</a></li> diff --git a/chrome/common/extensions/docs/static/devguide.html b/chrome/common/extensions/docs/static/devguide.html index 1881de2f..2a2d092 100644 --- a/chrome/common/extensions/docs/static/devguide.html +++ b/chrome/common/extensions/docs/static/devguide.html @@ -18,6 +18,10 @@ and <a href="overview.html">Overview</a>. <td> Add icons to the toolbar </td> </tr> <tr> + <td> <a href="notifications.html">Desktop Notifications</a> </td> + <td> Notify users of important events </td> + </tr> + <tr> <td> <a href="options.html">Options Pages</a> </td> <td> Let users customize your extension </td> </tr> diff --git a/chrome/common/extensions/docs/static/manifest.html b/chrome/common/extensions/docs/static/manifest.html index eb66c81..5f74b5b 100644 --- a/chrome/common/extensions/docs/static/manifest.html +++ b/chrome/common/extensions/docs/static/manifest.html @@ -240,7 +240,9 @@ The following table lists the permissions an extension can use. <td> Allows the extension to use the proposed HTML5 <a href="http://www.chromium.org/developers/design-documents/desktop-notifications/api-specification">notification API</a> without calling permission methods - (such as <code>checkPermission()</code>). </td> + (such as <code>checkPermission()</code>). + For more information see + <a href="notifications.html">Desktop Notifications</a>.</td> </tr> <tr> <td> "tabs" </td> diff --git a/chrome/common/extensions/docs/static/notifications.html b/chrome/common/extensions/docs/static/notifications.html new file mode 100644 index 0000000..5359bfd --- /dev/null +++ b/chrome/common/extensions/docs/static/notifications.html @@ -0,0 +1,120 @@ +<div id="pageData-name" class="pageData">Desktop Notifications</div> + +<!-- BEGIN AUTHORED CONTENT --> +<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="images/notification-windows.png" + width="28%" style="margin:2em 0.5em 1em; border:1px solid black;" + alt="Notifications on Microsoft Windows"/> +<img src="images/notification-mac.png" + width="28%" style="margin:2em 0.5em 1em; border:1px solid black;" + alt="Notifications on Mac OS X"/> +<img src="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="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>. + + +<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> + +<!-- END AUTHORED CONTENT --> diff --git a/chrome/common/extensions/docs/tabs.html b/chrome/common/extensions/docs/tabs.html index 86a5b33..919ae09 100644 --- a/chrome/common/extensions/docs/tabs.html +++ b/chrome/common/extensions/docs/tabs.html @@ -135,6 +135,7 @@ <li>Browser UI <ul> <li><a href="browserAction.html">Browser Actions</a></li> + <li><a href="notifications.html">Desktop Notifications</a></li> <li><a href="options.html">Options Pages</a></li> <li><a href="override.html">Override Pages</a></li> <li><a href="pageAction.html">Page Actions</a></li> diff --git a/chrome/common/extensions/docs/template/api_template.html b/chrome/common/extensions/docs/template/api_template.html index a00ab02..5fd8424 100644 --- a/chrome/common/extensions/docs/template/api_template.html +++ b/chrome/common/extensions/docs/template/api_template.html @@ -122,6 +122,7 @@ <li>Browser UI <ul> <li><a href="browserAction.html">Browser Actions</a></li> + <li><a href="notifications.html">Desktop Notifications</a></li> <li><a href="options.html">Options Pages</a></li> <li><a href="override.html">Override Pages</a></li> <li><a href="pageAction.html">Page Actions</a></li> diff --git a/chrome/common/extensions/docs/themes.html b/chrome/common/extensions/docs/themes.html index 0c90700..9b5b525 100644 --- a/chrome/common/extensions/docs/themes.html +++ b/chrome/common/extensions/docs/themes.html @@ -135,6 +135,7 @@ <li>Browser UI <ul> <li><a href="browserAction.html">Browser Actions</a></li> + <li><a href="notifications.html">Desktop Notifications</a></li> <li><a href="options.html">Options Pages</a></li> <li><a href="override.html">Override Pages</a></li> <li><a href="pageAction.html">Page Actions</a></li> diff --git a/chrome/common/extensions/docs/tut_analytics.html b/chrome/common/extensions/docs/tut_analytics.html index e1d56b5..3a33485 100644 --- a/chrome/common/extensions/docs/tut_analytics.html +++ b/chrome/common/extensions/docs/tut_analytics.html @@ -135,6 +135,7 @@ <li>Browser UI <ul> <li><a href="browserAction.html">Browser Actions</a></li> + <li><a href="notifications.html">Desktop Notifications</a></li> <li><a href="options.html">Options Pages</a></li> <li><a href="override.html">Override Pages</a></li> <li><a href="pageAction.html">Page Actions</a></li> diff --git a/chrome/common/extensions/docs/tut_debugging.html b/chrome/common/extensions/docs/tut_debugging.html index cf8f0d4..9c4a51d 100644 --- a/chrome/common/extensions/docs/tut_debugging.html +++ b/chrome/common/extensions/docs/tut_debugging.html @@ -135,6 +135,7 @@ <li>Browser UI <ul> <li><a href="browserAction.html">Browser Actions</a></li> + <li><a href="notifications.html">Desktop Notifications</a></li> <li><a href="options.html">Options Pages</a></li> <li><a href="override.html">Override Pages</a></li> <li><a href="pageAction.html">Page Actions</a></li> diff --git a/chrome/common/extensions/docs/tut_oauth.html b/chrome/common/extensions/docs/tut_oauth.html index 53e0c12..597e613 100644 --- a/chrome/common/extensions/docs/tut_oauth.html +++ b/chrome/common/extensions/docs/tut_oauth.html @@ -135,6 +135,7 @@ <li>Browser UI <ul> <li><a href="browserAction.html">Browser Actions</a></li> + <li><a href="notifications.html">Desktop Notifications</a></li> <li><a href="options.html">Options Pages</a></li> <li><a href="override.html">Override Pages</a></li> <li><a href="pageAction.html">Page Actions</a></li> diff --git a/chrome/common/extensions/docs/tutorials.html b/chrome/common/extensions/docs/tutorials.html index c1d1e6c..7f079e6 100644 --- a/chrome/common/extensions/docs/tutorials.html +++ b/chrome/common/extensions/docs/tutorials.html @@ -135,6 +135,7 @@ <li>Browser UI <ul> <li><a href="browserAction.html">Browser Actions</a></li> + <li><a href="notifications.html">Desktop Notifications</a></li> <li><a href="options.html">Options Pages</a></li> <li><a href="override.html">Override Pages</a></li> <li><a href="pageAction.html">Page Actions</a></li> diff --git a/chrome/common/extensions/docs/windows.html b/chrome/common/extensions/docs/windows.html index 60f1284..2427996f 100644 --- a/chrome/common/extensions/docs/windows.html +++ b/chrome/common/extensions/docs/windows.html @@ -135,6 +135,7 @@ <li>Browser UI <ul> <li><a href="browserAction.html">Browser Actions</a></li> + <li><a href="notifications.html">Desktop Notifications</a></li> <li><a href="options.html">Options Pages</a></li> <li><a href="override.html">Override Pages</a></li> <li><a href="pageAction.html">Page Actions</a></li> diff --git a/chrome/common/extensions/docs/xhr.html b/chrome/common/extensions/docs/xhr.html index 0cbe660..5d36443 100644 --- a/chrome/common/extensions/docs/xhr.html +++ b/chrome/common/extensions/docs/xhr.html @@ -135,6 +135,7 @@ <li>Browser UI <ul> <li><a href="browserAction.html">Browser Actions</a></li> + <li><a href="notifications.html">Desktop Notifications</a></li> <li><a href="options.html">Options Pages</a></li> <li><a href="override.html">Override Pages</a></li> <li><a href="pageAction.html">Page Actions</a></li> |
