diff options
Diffstat (limited to 'chrome')
-rw-r--r-- | chrome/browser/automation/automation_provider_observers.cc | 2 | ||||
-rw-r--r-- | chrome/browser/background/background_application_list_model_unittest.cc | 6 | ||||
-rw-r--r-- | chrome/browser/extensions/extension_app_api.cc | 144 | ||||
-rw-r--r-- | chrome/browser/extensions/extension_app_api.h | 79 | ||||
-rw-r--r-- | chrome/browser/extensions/extension_function_dispatcher.cc | 5 | ||||
-rw-r--r-- | chrome/browser/extensions/extension_service.h | 8 | ||||
-rw-r--r-- | chrome/browser/resources/ntp/apps.js | 4 | ||||
-rw-r--r-- | chrome/browser/ui/webui/ntp/app_launcher_handler.cc | 48 | ||||
-rw-r--r-- | chrome/browser/ui/webui/ntp/app_launcher_handler.h | 2 | ||||
-rw-r--r-- | chrome/chrome_browser.gypi | 2 | ||||
-rw-r--r-- | chrome/common/extensions/api/extension_api.json | 105 | ||||
-rw-r--r-- | chrome/common/extensions/docs/experimental.app.html | 1537 | ||||
-rw-r--r-- | chrome/common/extensions/docs/experimental.html | 1 | ||||
-rw-r--r-- | chrome/common/extensions/docs/samples.json | 4 | ||||
-rw-r--r-- | chrome/common/extensions/docs/static/experimental.app.html | 5 | ||||
-rw-r--r-- | chrome/renderer/resources/renderer_extension_bindings.js | 1 |
16 files changed, 1945 insertions, 8 deletions
diff --git a/chrome/browser/automation/automation_provider_observers.cc b/chrome/browser/automation/automation_provider_observers.cc index 1c57b2a..06f7a16 100644 --- a/chrome/browser/automation/automation_provider_observers.cc +++ b/chrome/browser/automation/automation_provider_observers.cc @@ -1952,7 +1952,7 @@ std::vector<DictionaryValue*>* GetAppInfoFromExtensions( // Only return information about extensions that are actually apps. if ((*ext)->is_app()) { DictionaryValue* app_info = new DictionaryValue(); - AppLauncherHandler::CreateAppInfo(*ext, ext_prefs, app_info); + AppLauncherHandler::CreateAppInfo(*ext, NULL, ext_prefs, app_info); app_info->SetBoolean("is_component_extension", (*ext)->location() == Extension::COMPONENT); diff --git a/chrome/browser/background/background_application_list_model_unittest.cc b/chrome/browser/background/background_application_list_model_unittest.cc index 530c76b..594e4a73 100644 --- a/chrome/browser/background/background_application_list_model_unittest.cc +++ b/chrome/browser/background/background_application_list_model_unittest.cc @@ -134,7 +134,7 @@ TEST_F(BackgroundApplicationListModelTest, LoadExplicitExtensions) { ASSERT_EQ(0U, model->size()); } -typedef std::set<scoped_refptr<Extension> > ExtensionSet; +typedef std::set<scoped_refptr<Extension> > ExtensionCollection; namespace { std::string GenerateUniqueExtensionName() { @@ -160,7 +160,7 @@ TEST_F(BackgroundApplicationListModelTest, LoadRandomExtension) { ASSERT_EQ(0U, model->size()); static const int kIterations = 500; - ExtensionSet extensions; + ExtensionCollection extensions; size_t count = 0; size_t expected = 0; srand(RANDOM_SEED); @@ -183,7 +183,7 @@ TEST_F(BackgroundApplicationListModelTest, LoadRandomExtension) { ASSERT_EQ(count, service->extensions()->size()); ASSERT_EQ(expected, model->size()); } else { // Maybe remove an extension. - ExtensionSet::iterator cursor = extensions.begin(); + ExtensionCollection::iterator cursor = extensions.begin(); if (cursor == extensions.end()) { // Nothing to remove. Just verify accounting. ASSERT_EQ(0U, count); diff --git a/chrome/browser/extensions/extension_app_api.cc b/chrome/browser/extensions/extension_app_api.cc new file mode 100644 index 0000000..b5e8c12 --- /dev/null +++ b/chrome/browser/extensions/extension_app_api.cc @@ -0,0 +1,144 @@ +// Copyright (c) 2011 The Chromium Authors. All rights reserved. +// Use of this source code is governed by a BSD-style license that can be +// found in the LICENSE file. + +#include "chrome/browser/extensions/extension_app_api.h" + +#include "base/stl_util-inl.h" +#include "base/values.h" +#include "chrome/browser/extensions/extension_service.h" +#include "chrome/browser/profiles/profile.h" +#include "chrome/common/extensions/extension.h" +#include "chrome/common/render_messages.h" +#include "content/common/notification_service.h" +#include "content/common/notification_type.h" + + +const char kBodyTextKey[] = "bodyText"; +const char kIconDataKey[] = "iconData"; +const char kLinkTextKey[] = "linkText"; +const char kLinkUrlKey[] = "linkUrl"; +const char kTitleKey[] = "title"; + +const char kMissingLinkTextError[] = + "You must specify linkText if you use linkUrl"; + +AppNotification::AppNotification() {} + +AppNotification::~AppNotification() {} + +AppNotificationManager::AppNotificationManager() { + registrar_.Add(this, + NotificationType::EXTENSION_UNINSTALLED, + NotificationService::AllSources()); +} + +AppNotificationManager::~AppNotificationManager() {} + +void AppNotificationManager::Add(AppNotification* item) { + CHECK(!item->extension_id.empty()); + NotificationMap::iterator found = notifications_.find(item->extension_id); + if (found == notifications_.end()) { + notifications_[item->extension_id] = AppNotificationList(); + found = notifications_.find(item->extension_id); + } + CHECK(found != notifications_.end()); + AppNotificationList& list = (*found).second; + list.push_back(linked_ptr<AppNotification>(item)); +} + +const AppNotificationList* AppNotificationManager::GetAll( + const std::string& extension_id) { + if (ContainsKey(notifications_, extension_id)) + return ¬ifications_[extension_id]; + return NULL; +} + +const AppNotification* AppNotificationManager::GetLast( + const std::string& extension_id) { + NotificationMap::iterator found = notifications_.find(extension_id); + if (found == notifications_.end()) + return NULL; + const AppNotificationList& list = found->second; + return list.rbegin()->get(); +} + +void AppNotificationManager::ClearAll(const std::string& extension_id) { + NotificationMap::iterator found = notifications_.find(extension_id); + if (found != notifications_.end()) + notifications_.erase(found); +} + +void AppNotificationManager::Observe(NotificationType type, + const NotificationSource& source, + const NotificationDetails& details) { + CHECK(type == NotificationType::EXTENSION_UNINSTALLED); + const std::string& id = + Details<UninstalledExtensionInfo>(details)->extension_id; + ClearAll(id); +} + +bool AppNotifyFunction::RunImpl() { + DictionaryValue* details; + EXTENSION_FUNCTION_VALIDATE(args_->GetDictionary(0, &details)); + EXTENSION_FUNCTION_VALIDATE(details != NULL); + + scoped_ptr<AppNotification> item(new AppNotification()); + item->extension_id = extension_id(); + + if (details->HasKey(kTitleKey)) + EXTENSION_FUNCTION_VALIDATE(details->GetString(kTitleKey, &item->title)); + + if (details->HasKey(kBodyTextKey)) + EXTENSION_FUNCTION_VALIDATE(details->GetString(kBodyTextKey, &item->body)); + + if (details->HasKey(kLinkUrlKey)) { + std::string link_url; + EXTENSION_FUNCTION_VALIDATE(details->GetString(kLinkUrlKey, &link_url)); + item->linkUrl = GURL(link_url); + if (!item->linkUrl.is_valid()) { + error_ = "Invalid url: " + link_url; + return false; + } + if (!details->HasKey(kLinkTextKey)) { + error_ = kMissingLinkTextError; + return false; + } + EXTENSION_FUNCTION_VALIDATE(details->GetString(kLinkTextKey, + &item->linkText)); + } + + if (details->HasKey(kIconDataKey)) { + BinaryValue* binary = NULL; + EXTENSION_FUNCTION_VALIDATE(details->GetBinary(kIconDataKey, &binary)); + IPC::Message bitmap_pickle(binary->GetBuffer(), binary->GetSize()); + void* iter = NULL; + SkBitmap bitmap; + EXTENSION_FUNCTION_VALIDATE( + IPC::ReadParam(&bitmap_pickle, &iter, &bitmap)); + // TODO(asargent) - use the bitmap to set the NTP icon! + } + + AppNotificationManager* manager = + profile()->GetExtensionService()->app_notification_manager(); + + manager->Add(item.release()); + + NotificationService::current()->Notify( + NotificationType::APP_NOTIFICATION_STATE_CHANGED, + Source<Profile>(profile_), + Details<const std::string>(&extension_id())); + + return true; +} + +bool AppClearAllNotificationsFunction::RunImpl() { + AppNotificationManager* manager = + profile()->GetExtensionService()->app_notification_manager(); + manager->ClearAll(extension_id()); + NotificationService::current()->Notify( + NotificationType::APP_NOTIFICATION_STATE_CHANGED, + Source<Profile>(profile_), + Details<const std::string>(&extension_id())); + return true; +} diff --git a/chrome/browser/extensions/extension_app_api.h b/chrome/browser/extensions/extension_app_api.h new file mode 100644 index 0000000..3e6b22c --- /dev/null +++ b/chrome/browser/extensions/extension_app_api.h @@ -0,0 +1,79 @@ +// Copyright (c) 2011 The Chromium Authors. All rights reserved. +// Use of this source code is governed by a BSD-style license that can be +// found in the LICENSE file. + +#ifndef CHROME_BROWSER_EXTENSIONS_EXTENSION_APP_API_H__ +#define CHROME_BROWSER_EXTENSIONS_EXTENSION_APP_API_H__ +#pragma once + +#include "chrome/browser/extensions/extension_function.h" + +#include <map> +#include <vector> + +#include "base/memory/linked_ptr.h" +#include "content/common/notification_observer.h" +#include "content/common/notification_registrar.h" +#include "third_party/skia/include/core/SkBitmap.h" + +struct AppNotification { + AppNotification(); + ~AppNotification(); + + std::string extension_id; + std::string title; + std::string body; + GURL linkUrl; + std::string linkText; + SkBitmap icon; +}; + +// A list of AppNotification's. +typedef std::vector<linked_ptr<AppNotification> > AppNotificationList; + +// This class keeps track of notifications for installed apps. +class AppNotificationManager : public NotificationObserver { + public: + AppNotificationManager(); + virtual ~AppNotificationManager(); + + // Takes ownership of |notification|. + void Add(AppNotification* item); + + const AppNotificationList* GetAll(const std::string& extension_id); + + // Returns the most recently added notification for |extension_id| if there + // are any, or NULL otherwise. + const AppNotification* GetLast(const std::string& extension_id); + + // Clears all notifications for |extension_id|. + void ClearAll(const std::string& extension_id); + + // Implementing NotificationObserver interface. + virtual void Observe(NotificationType type, + const NotificationSource& source, + const NotificationDetails& details) OVERRIDE; + + private: + // Maps extension id to a list of notifications for that extension. + typedef std::map<std::string, AppNotificationList> NotificationMap; + + NotificationRegistrar registrar_; + NotificationMap notifications_; + + DISALLOW_COPY_AND_ASSIGN(AppNotificationManager); +}; + +class AppNotifyFunction : public SyncExtensionFunction { + virtual ~AppNotifyFunction() {} + virtual bool RunImpl(); + DECLARE_EXTENSION_FUNCTION_NAME("experimental.app.notify"); +}; + +class AppClearAllNotificationsFunction : public SyncExtensionFunction { + virtual ~AppClearAllNotificationsFunction() {} + virtual bool RunImpl(); + DECLARE_EXTENSION_FUNCTION_NAME("experimental.app.clearAllNotifications"); +}; + +#endif // CHROME_BROWSER_EXTENSIONS_EXTENSION_APP_API_H__ diff --git a/chrome/browser/extensions/extension_function_dispatcher.cc b/chrome/browser/extensions/extension_function_dispatcher.cc index 92aa0f7..ec7be57 100644 --- a/chrome/browser/extensions/extension_function_dispatcher.cc +++ b/chrome/browser/extensions/extension_function_dispatcher.cc @@ -13,6 +13,7 @@ #include "build/build_config.h" #include "chrome/browser/extensions/execute_code_in_tab_function.h" #include "chrome/browser/extensions/extension_accessibility_api.h" +#include "chrome/browser/extensions/extension_app_api.h" #include "chrome/browser/extensions/extension_bookmark_manager_api.h" #include "chrome/browser/extensions/extension_bookmarks_module.h" #include "chrome/browser/extensions/extension_browser_actions_api.h" @@ -370,6 +371,10 @@ void FactoryRegistry::ResetFunctions() { RegisterFunction<ClearContentSettingsFunction>(); RegisterFunction<GetContentSettingFunction>(); RegisterFunction<SetContentSettingFunction>(); + + // Experimental App API. + RegisterFunction<AppNotifyFunction>(); + RegisterFunction<AppClearAllNotificationsFunction>(); } void FactoryRegistry::GetAllNames(std::vector<std::string>* names) { diff --git a/chrome/browser/extensions/extension_service.h b/chrome/browser/extensions/extension_service.h index 7aae4ec..0c5e8e7 100644 --- a/chrome/browser/extensions/extension_service.h +++ b/chrome/browser/extensions/extension_service.h @@ -22,6 +22,7 @@ #include "base/time.h" #include "base/tuple.h" #include "chrome/browser/extensions/apps_promo.h" +#include "chrome/browser/extensions/extension_app_api.h" #include "chrome/browser/extensions/extension_icon_manager.h" #include "chrome/browser/extensions/extension_menu_manager.h" #include "chrome/browser/extensions/extension_prefs.h" @@ -452,6 +453,10 @@ class ExtensionService ExtensionMenuManager* menu_manager() { return &menu_manager_; } + AppNotificationManager* app_notification_manager() { + return &app_notification_manager_; + } + ExtensionBrowserEventRouter* browser_event_router() { return browser_event_router_.get(); } @@ -683,6 +688,9 @@ class ExtensionService // Keeps track of menu items added by extensions. ExtensionMenuManager menu_manager_; + // Keeps track of app notifications. + AppNotificationManager app_notification_manager_; + // Keeps track of favicon-sized omnibox icons for extensions. ExtensionIconManager omnibox_icon_manager_; ExtensionIconManager omnibox_popup_icon_manager_; diff --git a/chrome/browser/resources/ntp/apps.js b/chrome/browser/resources/ntp/apps.js index 39e596c..fe53705 100644 --- a/chrome/browser/resources/ntp/apps.js +++ b/chrome/browser/resources/ntp/apps.js @@ -149,6 +149,10 @@ function appsPrefChangeCallback(data) { }); } +function appNotificationChanged(id, lastNotification) { + // TODO(asargent/finnur) use this when we hook up notifications into the NTP. +} + // Launches the specified app using the APP_LAUNCH_NTP_APP_RE_ENABLE histogram. // This should only be invoked from the AppLauncherHandler. function launchAppAfterEnable(appId) { diff --git a/chrome/browser/ui/webui/ntp/app_launcher_handler.cc b/chrome/browser/ui/webui/ntp/app_launcher_handler.cc index c2e16e7..e67a24d 100644 --- a/chrome/browser/ui/webui/ntp/app_launcher_handler.cc +++ b/chrome/browser/ui/webui/ntp/app_launcher_handler.cc @@ -73,8 +73,23 @@ AppLauncherHandler::AppLauncherHandler(ExtensionService* extension_service) AppLauncherHandler::~AppLauncherHandler() {} +// Serializes |notification| into a new DictionaryValue which the caller then +// owns. +static DictionaryValue* SerializeNotification( + const AppNotification& notification) { + DictionaryValue* dictionary = new DictionaryValue(); + dictionary->SetString("title", notification.title); + dictionary->SetString("body", notification.body); + if (!notification.linkUrl.is_empty()) { + dictionary->SetString("linkUrl", notification.linkUrl.spec()); + dictionary->SetString("linkText", notification.linkText); + } + return dictionary; +} + // static void AppLauncherHandler::CreateAppInfo(const Extension* extension, + const AppNotification* notification, ExtensionPrefs* prefs, DictionaryValue* value) { bool enabled = @@ -109,6 +124,9 @@ void AppLauncherHandler::CreateAppInfo(const Extension* extension, value->SetBoolean("is_component", extension->location() == Extension::COMPONENT); + if (notification) + value->Set("notification", SerializeNotification(*notification)); + int app_launch_index = prefs->GetAppLaunchIndex(extension->id()); if (app_launch_index == -1) { // Make sure every app has a launch index (some predate the launch index). @@ -198,6 +216,17 @@ void AppLauncherHandler::Observe(NotificationType type, return; switch (type.value) { + case NotificationType::APP_NOTIFICATION_STATE_CHANGED: { + const std::string& id = *Details<const std::string>(details).ptr(); + const AppNotification* notification = + extensions_service_->app_notification_manager()->GetLast(id); + ListValue args; + args.Append(new StringValue(id)); + if (notification) + args.Append(SerializeNotification(*notification)); + web_ui_->CallJavascriptFunction("appNotificationChanged", args); + break; + } case NotificationType::EXTENSION_LOADED: case NotificationType::EXTENSION_UNLOADED: case NotificationType::EXTENSION_LAUNCHER_REORDERED: @@ -228,10 +257,16 @@ void AppLauncherHandler::FillAppDictionary(DictionaryValue* dictionary) { for (it = extensions->begin(); it != extensions->end(); ++it) { // Don't include the WebStore. // The WebStore launcher gets special treatment in ntp/apps.js. - if ((*it)->is_app() && - (*it)->id() != extension_misc::kWebStoreAppId) { + const Extension* extension = *it; + if (extension->is_app() && + extension->id() != extension_misc::kWebStoreAppId) { DictionaryValue* app_info = new DictionaryValue(); - CreateAppInfo(*it, extensions_service_->extension_prefs(), app_info); + AppNotificationManager* notification_manager = + extensions_service_->app_notification_manager(); + CreateAppInfo(extension, + notification_manager->GetLast(extension->id()), + extensions_service_->extension_prefs(), + app_info); list->Append(app_info); } } @@ -241,7 +276,10 @@ void AppLauncherHandler::FillAppDictionary(DictionaryValue* dictionary) { if ((*it)->is_app() && (*it)->id() != extension_misc::kWebStoreAppId) { DictionaryValue* app_info = new DictionaryValue(); - CreateAppInfo(*it, extensions_service_->extension_prefs(), app_info); + CreateAppInfo(*it, + NULL, + extensions_service_->extension_prefs(), + app_info); list->Append(app_info); } } @@ -316,6 +354,8 @@ void AppLauncherHandler::HandleGetApps(const ListValue* args) { // First time we get here we set up the observer so that we can tell update // the apps as they change. if (registrar_.IsEmpty()) { + registrar_.Add(this, NotificationType::APP_NOTIFICATION_STATE_CHANGED, + NotificationService::AllSources()); registrar_.Add(this, NotificationType::EXTENSION_LOADED, NotificationService::AllSources()); registrar_.Add(this, NotificationType::EXTENSION_UNLOADED, diff --git a/chrome/browser/ui/webui/ntp/app_launcher_handler.h b/chrome/browser/ui/webui/ntp/app_launcher_handler.h index 1373f7e..182de11 100644 --- a/chrome/browser/ui/webui/ntp/app_launcher_handler.h +++ b/chrome/browser/ui/webui/ntp/app_launcher_handler.h @@ -7,6 +7,7 @@ #pragma once #include "base/memory/scoped_ptr.h" +#include "chrome/browser/extensions/extension_app_api.h" #include "chrome/browser/extensions/extension_install_ui.h" #include "chrome/browser/extensions/extension_uninstall_dialog.h" #include "chrome/browser/prefs/pref_change_registrar.h" @@ -37,6 +38,7 @@ class AppLauncherHandler : public WebUIMessageHandler, // Populate a dictionary with the information from an extension. static void CreateAppInfo(const Extension* extension, + const AppNotification* notification, ExtensionPrefs* extension_prefs, DictionaryValue* value); diff --git a/chrome/chrome_browser.gypi b/chrome/chrome_browser.gypi index c4f9802..14ee604 100644 --- a/chrome/chrome_browser.gypi +++ b/chrome/chrome_browser.gypi @@ -856,6 +856,8 @@ 'browser/extensions/crx_installer.h', 'browser/extensions/execute_code_in_tab_function.cc', 'browser/extensions/execute_code_in_tab_function.h', + 'browser/extensions/extension_app_api.cc', + 'browser/extensions/extension_app_api.h', 'browser/extensions/extension_accessibility_api.cc', 'browser/extensions/extension_accessibility_api.h', 'browser/extensions/extension_accessibility_api_constants.cc', diff --git a/chrome/common/extensions/api/extension_api.json b/chrome/common/extensions/api/extension_api.json index d507be1..50b97f2 100644 --- a/chrome/common/extensions/api/extension_api.json +++ b/chrome/common/extensions/api/extension_api.json @@ -6170,5 +6170,110 @@ ] } ] + }, + { + "namespace":"experimental.app", + "functions": [ + { + "name": "notify", + "type": "function", + "description": "Creates a notification from this app.", + "parameters": [ + { + "type": "object", + "name": "details", + "properties": { + "passive": { + "type": "boolean", + "optional": "true", + "description": "Whether the notification should be passive (true) or active (false). The default value is true." + }, + "title": { + "type": "string", + "optional": true, + "description": "The title of the notification." + }, + "bodyText": { + "type": "string", + "optional": true, + "description": "The text content of the notification." + }, + "linkUrl": { + "type": "string", + "optional": true, + "description": "The URL for an optional link to show along with the notification. If you specify a linkUrl, you must also specify a value for linkText." + }, + "linkText": { + "type": "string", + "optional": true, + "description": "If a linkUrl is provided, this is required and will be used as the linkified text. It should be relatively short." + }, + "iconData": { + "type": "object", + "isInstanceOf": "ImageData", + "optional": true, + "properties": {}, + "additionalProperties": { "type": "any" }, + "description": "Pixel data for an image to use as the icon for this notification. Must be an ImageData object (for example, from a canvas element)." + } + } + }, + { + "type": "function", + "name": "callback", + "optional": true, + "parameters": [], + "description": "A callback when the function is complete. Any errors will be reported in <a href='extension.html#property-lastError'>chrome.extension.lastError</a>." + } + ] + }, + { + "name": "clearAllNotifications", + "type": "function", + "description": "Clears all previously sent notifications.", + "parameters": [ + { + "type": "function", + "name": "callback", + "optional": true, + "description": "A callback when the function is complete. Any errors will be reported in <a href='extension.html#property-lastError'>chrome.extension.lastError</a>." + } + ] + }, + { + "name": "setLaunchIcon", + "type": "function", + "parameters": [ + { + "type": "object", + "name": "iconData", + "isInstanceOf": "ImageData", + "optional": true, + "properties": {}, + "additionalProperties": { "type": "any" }, + "description": "Pixel data for an image to replace the launch icon on the New Tab Page. Must be an ImageData object (for example, from a canvas element). See http://code.google.com/chrome/webstore/docs/images.html for more details." + }, + { + "type": "function", + "name": "callback", + "optional": true, + "description": "A callback when the function is complete. Any errors will be reported in <a href='extension.html#property-lastError'>chrome.extension.lastError</a>." + } + ] + }, + { + "name": "resetLaunchIcon", + "type": "function", + "description": "Resets the app's launch icon to its default value as specified in the manifest.json file.", + "parameters": [ + { + "type": "function", + "name": "callback", + "optional": true, + "description": "A callback when the function is complete. Any errors will be reported in <a href='extension.html#property-lastError'>chrome.extension.lastError</a>." + } + ] + } + ] } ] diff --git a/chrome/common/extensions/docs/experimental.app.html b/chrome/common/extensions/docs/experimental.app.html new file mode 100644 index 0000000..47d922be --- /dev/null +++ b/chrome/common/extensions/docs/experimental.app.html @@ -0,0 +1,1537 @@ +<!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> + <script type="text/javascript" src="js/sidebar.js"></script> + <title>Experimental App APIs - 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 class="enum">enumerated</span> + <span id="typeTemplate"> + <span> + <a> Type</a> + </span> + <span> + <span> + array of <span><span></span></span> + </span> + <span>paramType</span> + <span></span> + </span> + </span> + ) + </div> + + </em> + </dt> + <dd class="todo"> + Undocumented. + </dd> + <dd> + Description of this parameter from the json schema. + </dd> + <dd> + This parameter was added in version + <b><span></span></b>. + You must omit this parameter in earlier versions, + and you may omit it in any version. If you require this + parameter, the manifest key + <a href="manifest.html#minimum_chrome_version">minimum_chrome_version</a> + can ensure that your extension won't be run in an earlier browser version. + </dd> + + <!-- OBJECT PROPERTIES --> + <dd> + <dl> + <div> + <div> + </div> + </div> + </dl> + </dd> + + <!-- OBJECT METHODS --> + <dd> + <div></div> + </dd> + + <!-- OBJECT EVENT FIELDS --> + <dd> + <div></div> + </dd> + + <!-- FUNCTION PARAMETERS --> + <dd> + <div></div> + </dd> + + </div> <!-- /VALUE --> + + <div id="functionParametersTemplate"> + <h5>Parameters</h5> + <dl> + <div> + <div> + </div> + </div> + </dl> + </div> + </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><a href="whats_new.html">What's New?</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><a href="contextMenus.html">Context Menus</a></li> + <li><a href="notifications.html">Desktop Notifications</a></li> + <li><a href="omnibox.html">Omnibox</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> + </ul> + </li> + <li>Browser Interaction + <ul> + <li><a href="bookmarks.html">Bookmarks</a></li> + <li><a href="cookies.html">Cookies</a></li> + <li><a href="events.html">Events</a></li> + <li><a href="history.html">History</a></li> + <li><a href="management.html">Management</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="a11y.html">Accessibility</a></li> + <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="idle.html">Idle</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="hosting.html">Hosting</a></li> + <li><a href="external_extensions.html">Other Deployment Options</a></li> + </ul> + </li> + </ul> + </li> + <li><h2><a href="apps.html">Packaged Apps</a></h2></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> + </ul> + </li> + <li><a href="permission_warnings.html">Permission Warnings</a></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> + <div class="line"> </div> + <li><h2>More</h2> + <ul> + <li><a href="http://code.google.com/chrome/webstore/docs/index.html">Chrome Web Store</a></li> + <li><a href="http://code.google.com/chrome/apps/docs/developers_guide.html">Hosted Apps</a></li> + <li><a href="themes.html">Themes</a></li> + </ul> + </li> + </ul> + </div> + <script> + initToggles(); + </script> + + <div class="g-unit" id="gc-pagecontent"> + <div id="pageTitle"> + <h1 class="page_title">Experimental App APIs</h1> + </div> + <!-- TABLE OF CONTENTS --> + <div id="toc"> + <h2>Contents</h2> + <ol> + <li style="display: none; "> + <a>h2Name</a> + <ol> + <li> + <a>h3Name</a> + </li> + </ol> + </li> + <li> + <a href="#apiReference">API reference: chrome.experimental.app</a> + <ol> + <li style="display: none; "> + <a href="#properties">Properties</a> + <ol> + <li> + <a href="#property-anchor">propertyName</a> + </li> + </ol> + </li> + <li> + <a href="#global-methods">Methods</a> + <ol> + <li> + <a href="#method-clearAllNotifications">clearAllNotifications</a> + </li><li> + <a href="#method-notify">notify</a> + </li><li> + <a href="#method-resetLaunchIcon">resetLaunchIcon</a> + </li><li> + <a href="#method-setLaunchIcon">setLaunchIcon</a> + </li> + </ol> + </li> + <li style="display: none; "> + <a>Events</a> + <ol> + <li> + <a href="#event-anchor">eventName</a> + </li> + </ol> + </li> + <li style="display: none; "> + <a href="#types">Types</a> + <ol> + <li> + <a href="#id-anchor">id</a> + </li> + </ol> + </li> + </ol> + </li> + </ol> + </div> + <!-- /TABLE OF CONTENTS --> + + <!-- Standard content lead-in for experimental API pages --> + <p id="classSummary" style="display: none; "> + For information on how to use experimental APIs, see the <a href="experimental.html">chrome.experimental.* APIs</a> page. + </p> + + <!-- STATIC CONTENT PLACEHOLDER --> + <div id="static"><div id="pageData-name" class="pageData">Experimental App APIs</div> + +<!-- BEGIN AUTHORED CONTENT --> +<p>The current methods allow applications to generate passive notifications.</p> +<!-- END AUTHORED CONTENT --> +</div> + + <!-- API PAGE --> + <div class="apiPage"> + <a name="apiReference"></a> + <h2>API reference: chrome.experimental.app</h2> + + <!-- PROPERTIES --> + <div class="apiGroup" style="display: none; "> + <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 id="methodsTemplate" class="apiGroup"> + <a name="global-methods"></a> + <h3>Methods</h3> + + <!-- iterates over all functions --> + <div class="apiItem"> + <a name="method-clearAllNotifications"></a> <!-- method-anchor --> + <h4>clearAllNotifications</h4> + + <div class="summary"><span style="display: none; ">void</span> + <!-- Note: intentionally longer 80 columns --> + <span>chrome.experimental.app.clearAllNotifications</span>(<span class="optional"><span style="display: none; ">, </span><span>function</span> + <var><span>callback</span></var></span>)</div> + + <div class="description"> + <p class="todo" style="display: none; ">Undocumented.</p> + <p>Clears all previously sent notifications.</p> + + <!-- PARAMETERS --> + <h4>Parameters</h4> + <dl> + <div> + <div> + <dt> + <var>callback</var> + <em> + + <!-- TYPE --> + <div style="display:inline"> + ( + <span class="optional">optional</span> + <span class="enum" style="display: none; ">enumerated</span> + <span id="typeTemplate"> + <span style="display: none; "> + <a> Type</a> + </span> + <span> + <span style="display: none; "> + array of <span><span></span></span> + </span> + <span>function</span> + <span style="display: none; "></span> + </span> + </span> + ) + </div> + + </em> + </dt> + <dd class="todo" style="display: none; "> + Undocumented. + </dd> + <dd>A callback when the function is complete. Any errors will be reported in <a href="extension.html#property-lastError">chrome.extension.lastError</a>.</dd> + <dd style="display: none; "> + This parameter was added in version + <b><span></span></b>. + You must omit this parameter in earlier versions, + and you may omit it in any version. If you require this + parameter, the manifest key + <a href="manifest.html#minimum_chrome_version">minimum_chrome_version</a> + can ensure that your extension won't be run in an earlier browser version. + </dd> + + <!-- OBJECT PROPERTIES --> + <dd style="display: none; "> + <dl> + <div> + <div> + </div> + </div> + </dl> + </dd> + + <!-- OBJECT METHODS --> + <dd style="display: none; "> + <div></div> + </dd> + + <!-- OBJECT EVENT FIELDS --> + <dd style="display: none; "> + <div></div> + </dd> + + <!-- FUNCTION PARAMETERS --> + <dd style="display: none; "> + <div></div> + </dd> + + </div> + </div> + </dl> + + <!-- RETURNS --> + <h4 style="display: none; ">Returns</h4> + <dl> + <div style="display: none; "> + <div> + </div> + </div> + </dl> + + <!-- CALLBACK --> + <div> + <div> + <h4>Callback function</h4> + <p style="display: none; "> + 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>null</span>) <span class="subdued">{...}</span>;</pre> + <dl> + <div style="display: none; "> + <div> + </div> + </div> + </dl> + </div> + </div> + + <!-- MIN_VERSION --> + <p style="display: none; "> + This function was added in version <b><span></span></b>. + If you require this function, the manifest key + <a href="manifest.html#minimum_chrome_version">minimum_chrome_version</a> + can ensure that your extension won't be run in an earlier browser version. + </p> + </div> <!-- /description --> + + </div><div class="apiItem"> + <a name="method-notify"></a> <!-- method-anchor --> + <h4>notify</h4> + + <div class="summary"><span style="display: none; ">void</span> + <!-- Note: intentionally longer 80 columns --> + <span>chrome.experimental.app.notify</span>(<span class="null"><span style="display: none; ">, </span><span>object</span> + <var><span>details</span></var></span><span class="optional"><span>, </span><span>function</span> + <var><span>callback</span></var></span>)</div> + + <div class="description"> + <p class="todo" style="display: none; ">Undocumented.</p> + <p>Creates a notification from this app.</p> + + <!-- PARAMETERS --> + <h4>Parameters</h4> + <dl> + <div> + <div> + <dt> + <var>details</var> + <em> + + <!-- TYPE --> + <div style="display:inline"> + ( + <span class="optional" style="display: none; ">optional</span> + <span class="enum" style="display: none; ">enumerated</span> + <span id="typeTemplate"> + <span style="display: none; "> + <a> Type</a> + </span> + <span> + <span style="display: none; "> + array of <span><span></span></span> + </span> + <span>object</span> + <span style="display: none; "></span> + </span> + </span> + ) + </div> + + </em> + </dt> + <dd class="todo"> + Undocumented. + </dd> + <dd style="display: none; "> + Description of this parameter from the json schema. + </dd> + <dd style="display: none; "> + This parameter was added in version + <b><span></span></b>. + You must omit this parameter in earlier versions, + and you may omit it in any version. If you require this + parameter, the manifest key + <a href="manifest.html#minimum_chrome_version">minimum_chrome_version</a> + can ensure that your extension won't be run in an earlier browser version. + </dd> + + <!-- OBJECT PROPERTIES --> + <dd> + <dl> + <div> + <div> + <dt> + <var>passive</var> + <em> + + <!-- TYPE --> + <div style="display:inline"> + ( + <span class="optional">optional</span> + <span class="enum" style="display: none; ">enumerated</span> + <span id="typeTemplate"> + <span style="display: none; "> + <a> Type</a> + </span> + <span> + <span style="display: none; "> + array of <span><span></span></span> + </span> + <span>boolean</span> + <span style="display: none; "></span> + </span> + </span> + ) + </div> + + </em> + </dt> + <dd class="todo" style="display: none; "> + Undocumented. + </dd> + <dd>Whether the notification should be passive (true) or active (false). The default value is true.</dd> + <dd style="display: none; "> + This parameter was added in version + <b><span></span></b>. + You must omit this parameter in earlier versions, + and you may omit it in any version. If you require this + parameter, the manifest key + <a href="manifest.html#minimum_chrome_version">minimum_chrome_version</a> + can ensure that your extension won't be run in an earlier browser version. + </dd> + + <!-- OBJECT PROPERTIES --> + <dd style="display: none; "> + <dl> + <div> + <div> + </div> + </div> + </dl> + </dd> + + <!-- OBJECT METHODS --> + <dd style="display: none; "> + <div></div> + </dd> + + <!-- OBJECT EVENT FIELDS --> + <dd style="display: none; "> + <div></div> + </dd> + + <!-- FUNCTION PARAMETERS --> + <dd style="display: none; "> + <div></div> + </dd> + + </div> + </div><div> + <div> + <dt> + <var>title</var> + <em> + + <!-- TYPE --> + <div style="display:inline"> + ( + <span class="optional">optional</span> + <span class="enum" style="display: none; ">enumerated</span> + <span id="typeTemplate"> + <span style="display: none; "> + <a> Type</a> + </span> + <span> + <span style="display: none; "> + array of <span><span></span></span> + </span> + <span>string</span> + <span style="display: none; "></span> + </span> + </span> + ) + </div> + + </em> + </dt> + <dd class="todo" style="display: none; "> + Undocumented. + </dd> + <dd>The title of the notification.</dd> + <dd style="display: none; "> + This parameter was added in version + <b><span></span></b>. + You must omit this parameter in earlier versions, + and you may omit it in any version. If you require this + parameter, the manifest key + <a href="manifest.html#minimum_chrome_version">minimum_chrome_version</a> + can ensure that your extension won't be run in an earlier browser version. + </dd> + + <!-- OBJECT PROPERTIES --> + <dd style="display: none; "> + <dl> + <div> + <div> + </div> + </div> + </dl> + </dd> + + <!-- OBJECT METHODS --> + <dd style="display: none; "> + <div></div> + </dd> + + <!-- OBJECT EVENT FIELDS --> + <dd style="display: none; "> + <div></div> + </dd> + + <!-- FUNCTION PARAMETERS --> + <dd style="display: none; "> + <div></div> + </dd> + + </div> + </div><div> + <div> + <dt> + <var>bodyText</var> + <em> + + <!-- TYPE --> + <div style="display:inline"> + ( + <span class="optional">optional</span> + <span class="enum" style="display: none; ">enumerated</span> + <span id="typeTemplate"> + <span style="display: none; "> + <a> Type</a> + </span> + <span> + <span style="display: none; "> + array of <span><span></span></span> + </span> + <span>string</span> + <span style="display: none; "></span> + </span> + </span> + ) + </div> + + </em> + </dt> + <dd class="todo" style="display: none; "> + Undocumented. + </dd> + <dd>The text content of the notification.</dd> + <dd style="display: none; "> + This parameter was added in version + <b><span></span></b>. + You must omit this parameter in earlier versions, + and you may omit it in any version. If you require this + parameter, the manifest key + <a href="manifest.html#minimum_chrome_version">minimum_chrome_version</a> + can ensure that your extension won't be run in an earlier browser version. + </dd> + + <!-- OBJECT PROPERTIES --> + <dd style="display: none; "> + <dl> + <div> + <div> + </div> + </div> + </dl> + </dd> + + <!-- OBJECT METHODS --> + <dd style="display: none; "> + <div></div> + </dd> + + <!-- OBJECT EVENT FIELDS --> + <dd style="display: none; "> + <div></div> + </dd> + + <!-- FUNCTION PARAMETERS --> + <dd style="display: none; "> + <div></div> + </dd> + + </div> + </div><div> + <div> + <dt> + <var>linkUrl</var> + <em> + + <!-- TYPE --> + <div style="display:inline"> + ( + <span class="optional">optional</span> + <span class="enum" style="display: none; ">enumerated</span> + <span id="typeTemplate"> + <span style="display: none; "> + <a> Type</a> + </span> + <span> + <span style="display: none; "> + array of <span><span></span></span> + </span> + <span>string</span> + <span style="display: none; "></span> + </span> + </span> + ) + </div> + + </em> + </dt> + <dd class="todo" style="display: none; "> + Undocumented. + </dd> + <dd>The URL for an optional link to show along with the notification. If you specify a linkUrl, you must also specify a value for linkText.</dd> + <dd style="display: none; "> + This parameter was added in version + <b><span></span></b>. + You must omit this parameter in earlier versions, + and you may omit it in any version. If you require this + parameter, the manifest key + <a href="manifest.html#minimum_chrome_version">minimum_chrome_version</a> + can ensure that your extension won't be run in an earlier browser version. + </dd> + + <!-- OBJECT PROPERTIES --> + <dd style="display: none; "> + <dl> + <div> + <div> + </div> + </div> + </dl> + </dd> + + <!-- OBJECT METHODS --> + <dd style="display: none; "> + <div></div> + </dd> + + <!-- OBJECT EVENT FIELDS --> + <dd style="display: none; "> + <div></div> + </dd> + + <!-- FUNCTION PARAMETERS --> + <dd style="display: none; "> + <div></div> + </dd> + + </div> + </div><div> + <div> + <dt> + <var>linkText</var> + <em> + + <!-- TYPE --> + <div style="display:inline"> + ( + <span class="optional">optional</span> + <span class="enum" style="display: none; ">enumerated</span> + <span id="typeTemplate"> + <span style="display: none; "> + <a> Type</a> + </span> + <span> + <span style="display: none; "> + array of <span><span></span></span> + </span> + <span>string</span> + <span style="display: none; "></span> + </span> + </span> + ) + </div> + + </em> + </dt> + <dd class="todo" style="display: none; "> + Undocumented. + </dd> + <dd>If a linkUrl is provided, this is required and will be used as the linkified text. It should be relatively short.</dd> + <dd style="display: none; "> + This parameter was added in version + <b><span></span></b>. + You must omit this parameter in earlier versions, + and you may omit it in any version. If you require this + parameter, the manifest key + <a href="manifest.html#minimum_chrome_version">minimum_chrome_version</a> + can ensure that your extension won't be run in an earlier browser version. + </dd> + + <!-- OBJECT PROPERTIES --> + <dd style="display: none; "> + <dl> + <div> + <div> + </div> + </div> + </dl> + </dd> + + <!-- OBJECT METHODS --> + <dd style="display: none; "> + <div></div> + </dd> + + <!-- OBJECT EVENT FIELDS --> + <dd style="display: none; "> + <div></div> + </dd> + + <!-- FUNCTION PARAMETERS --> + <dd style="display: none; "> + <div></div> + </dd> + + </div> + </div><div> + <div> + <dt> + <var>iconData</var> + <em> + + <!-- TYPE --> + <div style="display:inline"> + ( + <span class="optional">optional</span> + <span class="enum" style="display: none; ">enumerated</span> + <span id="typeTemplate"> + <span style="display: none; "> + <a> Type</a> + </span> + <span> + <span style="display: none; "> + array of <span><span></span></span> + </span> + <span>ImageData</span> + <span style="display: none; "></span> + </span> + </span> + ) + </div> + + </em> + </dt> + <dd class="todo" style="display: none; "> + Undocumented. + </dd> + <dd>Pixel data for an image to use as the icon for this notification. Must be an ImageData object (for example, from a canvas element).</dd> + <dd style="display: none; "> + This parameter was added in version + <b><span></span></b>. + You must omit this parameter in earlier versions, + and you may omit it in any version. If you require this + parameter, the manifest key + <a href="manifest.html#minimum_chrome_version">minimum_chrome_version</a> + can ensure that your extension won't be run in an earlier browser version. + </dd> + + <!-- OBJECT PROPERTIES --> + <dd> + <dl> + <div style="display: none; "> + <div> + </div> + </div> + </dl> + </dd> + + <!-- OBJECT METHODS --> + <dd style="display: none; "> + <div></div> + </dd> + + <!-- OBJECT EVENT FIELDS --> + <dd style="display: none; "> + <div></div> + </dd> + + <!-- FUNCTION PARAMETERS --> + <dd style="display: none; "> + <div></div> + </dd> + + </div> + </div> + </dl> + </dd> + + <!-- OBJECT METHODS --> + <dd style="display: none; "> + <div></div> + </dd> + + <!-- OBJECT EVENT FIELDS --> + <dd style="display: none; "> + <div></div> + </dd> + + <!-- FUNCTION PARAMETERS --> + <dd style="display: none; "> + <div></div> + </dd> + + </div> + </div><div> + <div> + <dt> + <var>callback</var> + <em> + + <!-- TYPE --> + <div style="display:inline"> + ( + <span class="optional">optional</span> + <span class="enum" style="display: none; ">enumerated</span> + <span id="typeTemplate"> + <span style="display: none; "> + <a> Type</a> + </span> + <span> + <span style="display: none; "> + array of <span><span></span></span> + </span> + <span>function</span> + <span style="display: none; "></span> + </span> + </span> + ) + </div> + + </em> + </dt> + <dd class="todo" style="display: none; "> + Undocumented. + </dd> + <dd>A callback when the function is complete. Any errors will be reported in <a href="extension.html#property-lastError">chrome.extension.lastError</a>.</dd> + <dd style="display: none; "> + This parameter was added in version + <b><span></span></b>. + You must omit this parameter in earlier versions, + and you may omit it in any version. If you require this + parameter, the manifest key + <a href="manifest.html#minimum_chrome_version">minimum_chrome_version</a> + can ensure that your extension won't be run in an earlier browser version. + </dd> + + <!-- OBJECT PROPERTIES --> + <dd style="display: none; "> + <dl> + <div> + <div> + </div> + </div> + </dl> + </dd> + + <!-- OBJECT METHODS --> + <dd style="display: none; "> + <div></div> + </dd> + + <!-- OBJECT EVENT FIELDS --> + <dd style="display: none; "> + <div></div> + </dd> + + <!-- FUNCTION PARAMETERS --> + <dd style="display: none; "> + <div></div> + </dd> + + </div> + </div> + </dl> + + <!-- RETURNS --> + <h4 style="display: none; ">Returns</h4> + <dl> + <div style="display: none; "> + <div> + </div> + </div> + </dl> + + <!-- CALLBACK --> + <div> + <div> + <h4>Callback function</h4> + <p style="display: none; "> + 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></span>) <span class="subdued">{...}</span>;</pre> + <dl> + <div style="display: none; "> + <div> + </div> + </div> + </dl> + </div> + </div> + + <!-- MIN_VERSION --> + <p style="display: none; "> + This function was added in version <b><span></span></b>. + If you require this function, the manifest key + <a href="manifest.html#minimum_chrome_version">minimum_chrome_version</a> + can ensure that your extension won't be run in an earlier browser version. + </p> + </div> <!-- /description --> + + </div><div class="apiItem"> + <a name="method-resetLaunchIcon"></a> <!-- method-anchor --> + <h4>resetLaunchIcon</h4> + + <div class="summary"><span style="display: none; ">void</span> + <!-- Note: intentionally longer 80 columns --> + <span>chrome.experimental.app.resetLaunchIcon</span>(<span class="optional"><span style="display: none; ">, </span><span>function</span> + <var><span>callback</span></var></span>)</div> + + <div class="description"> + <p class="todo" style="display: none; ">Undocumented.</p> + <p>Resets the app's launch icon to its default value as specified in the manifest.json file.</p> + + <!-- PARAMETERS --> + <h4>Parameters</h4> + <dl> + <div> + <div> + <dt> + <var>callback</var> + <em> + + <!-- TYPE --> + <div style="display:inline"> + ( + <span class="optional">optional</span> + <span class="enum" style="display: none; ">enumerated</span> + <span id="typeTemplate"> + <span style="display: none; "> + <a> Type</a> + </span> + <span> + <span style="display: none; "> + array of <span><span></span></span> + </span> + <span>function</span> + <span style="display: none; "></span> + </span> + </span> + ) + </div> + + </em> + </dt> + <dd class="todo" style="display: none; "> + Undocumented. + </dd> + <dd>A callback when the function is complete. Any errors will be reported in <a href="extension.html#property-lastError">chrome.extension.lastError</a>.</dd> + <dd style="display: none; "> + This parameter was added in version + <b><span></span></b>. + You must omit this parameter in earlier versions, + and you may omit it in any version. If you require this + parameter, the manifest key + <a href="manifest.html#minimum_chrome_version">minimum_chrome_version</a> + can ensure that your extension won't be run in an earlier browser version. + </dd> + + <!-- OBJECT PROPERTIES --> + <dd style="display: none; "> + <dl> + <div> + <div> + </div> + </div> + </dl> + </dd> + + <!-- OBJECT METHODS --> + <dd style="display: none; "> + <div></div> + </dd> + + <!-- OBJECT EVENT FIELDS --> + <dd style="display: none; "> + <div></div> + </dd> + + <!-- FUNCTION PARAMETERS --> + <dd style="display: none; "> + <div></div> + </dd> + + </div> + </div> + </dl> + + <!-- RETURNS --> + <h4 style="display: none; ">Returns</h4> + <dl> + <div style="display: none; "> + <div> + </div> + </div> + </dl> + + <!-- CALLBACK --> + <div> + <div> + <h4>Callback function</h4> + <p style="display: none; "> + 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>null</span>) <span class="subdued">{...}</span>;</pre> + <dl> + <div style="display: none; "> + <div> + </div> + </div> + </dl> + </div> + </div> + + <!-- MIN_VERSION --> + <p style="display: none; "> + This function was added in version <b><span></span></b>. + If you require this function, the manifest key + <a href="manifest.html#minimum_chrome_version">minimum_chrome_version</a> + can ensure that your extension won't be run in an earlier browser version. + </p> + </div> <!-- /description --> + + </div><div class="apiItem"> + <a name="method-setLaunchIcon"></a> <!-- method-anchor --> + <h4>setLaunchIcon</h4> + + <div class="summary"><span style="display: none; ">void</span> + <!-- Note: intentionally longer 80 columns --> + <span>chrome.experimental.app.setLaunchIcon</span>(<span class="optional"><span style="display: none; ">, </span><span>ImageData</span> + <var><span>iconData</span></var></span><span class="optional"><span>, </span><span>function</span> + <var><span>callback</span></var></span>)</div> + + <div class="description"> + <p class="todo" style="display: none; ">Undocumented.</p> + <p style="display: none; "> + A description from the json schema def of the function goes here. + </p> + + <!-- PARAMETERS --> + <h4>Parameters</h4> + <dl> + <div> + <div> + <dt> + <var>iconData</var> + <em> + + <!-- TYPE --> + <div style="display:inline"> + ( + <span class="optional">optional</span> + <span class="enum" style="display: none; ">enumerated</span> + <span id="typeTemplate"> + <span style="display: none; "> + <a> Type</a> + </span> + <span> + <span style="display: none; "> + array of <span><span></span></span> + </span> + <span>ImageData</span> + <span style="display: none; "></span> + </span> + </span> + ) + </div> + + </em> + </dt> + <dd class="todo" style="display: none; "> + Undocumented. + </dd> + <dd>Pixel data for an image to replace the launch icon on the New Tab Page. Must be an ImageData object (for example, from a canvas element). See http://code.google.com/chrome/webstore/docs/images.html for more details.</dd> + <dd style="display: none; "> + This parameter was added in version + <b><span></span></b>. + You must omit this parameter in earlier versions, + and you may omit it in any version. If you require this + parameter, the manifest key + <a href="manifest.html#minimum_chrome_version">minimum_chrome_version</a> + can ensure that your extension won't be run in an earlier browser version. + </dd> + + <!-- OBJECT PROPERTIES --> + <dd> + <dl> + <div style="display: none; "> + <div> + </div> + </div> + </dl> + </dd> + + <!-- OBJECT METHODS --> + <dd style="display: none; "> + <div></div> + </dd> + + <!-- OBJECT EVENT FIELDS --> + <dd style="display: none; "> + <div></div> + </dd> + + <!-- FUNCTION PARAMETERS --> + <dd style="display: none; "> + <div></div> + </dd> + + </div> + </div><div> + <div> + <dt> + <var>callback</var> + <em> + + <!-- TYPE --> + <div style="display:inline"> + ( + <span class="optional">optional</span> + <span class="enum" style="display: none; ">enumerated</span> + <span id="typeTemplate"> + <span style="display: none; "> + <a> Type</a> + </span> + <span> + <span style="display: none; "> + array of <span><span></span></span> + </span> + <span>function</span> + <span style="display: none; "></span> + </span> + </span> + ) + </div> + + </em> + </dt> + <dd class="todo" style="display: none; "> + Undocumented. + </dd> + <dd>A callback when the function is complete. Any errors will be reported in <a href="extension.html#property-lastError">chrome.extension.lastError</a>.</dd> + <dd style="display: none; "> + This parameter was added in version + <b><span></span></b>. + You must omit this parameter in earlier versions, + and you may omit it in any version. If you require this + parameter, the manifest key + <a href="manifest.html#minimum_chrome_version">minimum_chrome_version</a> + can ensure that your extension won't be run in an earlier browser version. + </dd> + + <!-- OBJECT PROPERTIES --> + <dd style="display: none; "> + <dl> + <div> + <div> + </div> + </div> + </dl> + </dd> + + <!-- OBJECT METHODS --> + <dd style="display: none; "> + <div></div> + </dd> + + <!-- OBJECT EVENT FIELDS --> + <dd style="display: none; "> + <div></div> + </dd> + + <!-- FUNCTION PARAMETERS --> + <dd style="display: none; "> + <div></div> + </dd> + + </div> + </div> + </dl> + + <!-- RETURNS --> + <h4 style="display: none; ">Returns</h4> + <dl> + <div style="display: none; "> + <div> + </div> + </div> + </dl> + + <!-- CALLBACK --> + <div> + <div> + <h4>Callback function</h4> + <p style="display: none; "> + 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>null</span>) <span class="subdued">{...}</span>;</pre> + <dl> + <div style="display: none; "> + <div> + </div> + </div> + </dl> + </div> + </div> + + <!-- MIN_VERSION --> + <p style="display: none; "> + This function was added in version <b><span></span></b>. + If you require this function, the manifest key + <a href="manifest.html#minimum_chrome_version">minimum_chrome_version</a> + can ensure that your extension won't be run in an earlier browser version. + </p> + </div> <!-- /description --> + + </div> <!-- /apiItem --> + + </div> <!-- /apiGroup --> + + <!-- EVENTS --> + <div id="eventsTemplate" class="apiGroup" style="display: none; "> + <a></a> + <h3>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><span>, Type opt_param1, Type opt_param2</span>)); + </div> + + <div class="description"> + <p class="todo">Undocumented.</p> + <p> + A description from the json schema def of the event goes here. + </p> + + <!-- LISTENER PARAMETERS --> + <div> + <h4>Listener parameters</h4> + <dl> + <div> + <div> + </div> + </div> + </dl> + </div> + + <!-- EXTRA PARAMETERS --> + <div> + <h4>Extra parameters to addListener</h4> + <dl> + <div> + <div> + </div> + </div> + </dl> + </div> + + <!-- LISTENER RETURN VALUE --> + <h4>Listener returns</h4> + <dl> + <div> + <div> + </div> + </div> + </dl> + + </div> <!-- /description --> + </div> <!-- /apiItem --> + + </div> <!-- /apiGroup --> + + <!-- TYPES --> + <div class="apiGroup" style="display: none; "> + <a name="types"></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> + ©2011 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/experimental.html b/chrome/common/extensions/docs/experimental.html index ad2a5c0..5ac04c5 100644 --- a/chrome/common/extensions/docs/experimental.html +++ b/chrome/common/extensions/docs/experimental.html @@ -321,6 +321,7 @@ on the following experimental APIs: <ul> <li> + <a href="experimental.app.html">experimental.app</a></li><li> <a href="experimental.contentSettings.html">experimental.contentSettings</a></li><li> <a href="experimental.debugger.html">experimental.debugger</a></li><li> <a href="experimental.devtools.audits.html">experimental.devtools.audits</a></li><li> diff --git a/chrome/common/extensions/docs/samples.json b/chrome/common/extensions/docs/samples.json index 9fff1c7..ae080e0 100644 --- a/chrome/common/extensions/docs/samples.json +++ b/chrome/common/extensions/docs/samples.json @@ -36,6 +36,10 @@ "chrome.cookies.onChanged": "cookies.html#event-onChanged", "chrome.cookies.remove": "cookies.html#method-remove", "chrome.cookies.set": "cookies.html#method-set", + "chrome.experimental.app.clearAllNotifications": "experimental.app.html#method-clearAllNotifications", + "chrome.experimental.app.notify": "experimental.app.html#method-notify", + "chrome.experimental.app.resetLaunchIcon": "experimental.app.html#method-resetLaunchIcon", + "chrome.experimental.app.setLaunchIcon": "experimental.app.html#method-setLaunchIcon", "chrome.experimental.debugger.attach": "experimental.debugger.html#method-attach", "chrome.experimental.debugger.detach": "experimental.debugger.html#method-detach", "chrome.experimental.debugger.onDetach": "experimental.debugger.html#event-onDetach", diff --git a/chrome/common/extensions/docs/static/experimental.app.html b/chrome/common/extensions/docs/static/experimental.app.html new file mode 100644 index 0000000..3e3eca4 --- /dev/null +++ b/chrome/common/extensions/docs/static/experimental.app.html @@ -0,0 +1,5 @@ +<div id="pageData-name" class="pageData">Experimental App APIs</div> + +<!-- BEGIN AUTHORED CONTENT --> +<p>The current methods allow applications to generate passive notifications.</p> +<!-- END AUTHORED CONTENT --> diff --git a/chrome/renderer/resources/renderer_extension_bindings.js b/chrome/renderer/resources/renderer_extension_bindings.js index e55af2d..074d948 100644 --- a/chrome/renderer/resources/renderer_extension_bindings.js +++ b/chrome/renderer/resources/renderer_extension_bindings.js @@ -300,6 +300,7 @@ var chrome = chrome || {}; "cookies", "devtools", "experimental.accessibility", + "experimental.app", "experimental.bookmarkManager", "experimental.contentSettings", "experimental.debugger", |