chrome/common/extensions/api/webstore.json

   1 // Copyright (c) 2012 The Chromium Authors. All rights reserved.
   2 // Use of this source code is governed by a BSD-style license that can be
   3 // found in the LICENSE file.
   4
   5 [
   6   {
   7     "namespace": "webstore",
   8     "description": "Use the <code>chrome.webstore</code> API to initiate app and extension installations \"inline\" from your site.",
   9     "types": [
  10       {
  11         "id": "InstallStage",
  12         "type": "string",
  13         "enum": ["installing", "downloading"],
  14         "description": "Enum used to indicate the stage of the installation process. 'downloading' indicates that the necessary files are being downloaded, and 'installing' indicates that the files are downloaded and are being actively installed."
  15       }
  16     ],  // types
  17     "events": [
  18       {
  19         "name": "onInstallStageChanged",
  20         "description": "Fired when an inline installation enters a new InstallStage. In order to receive notifications about this event, listeners must be registered before the inline installation begins.",
  21         "type": "function",
  22         "parameters": [
  23           {
  24             "name": "stage",
  25             "$ref": "InstallStage",
  26             "description": "The InstallStage that just began."
  27           }
  28         ]
  29       },  // onInstallStageChanged
  30       {
  31         "name": "onDownloadProgress",
  32         "description": "Fired periodically with the download progress of an inline install. In order to receive notifications about this event, listeners must be registered before the inline installation begins.",
  33         "type": "function",
  34         "parameters": [
  35           {
  36             "name": "percentDownloaded",
  37             "type": "number",
  38             "description": "The progress of the download, between 0 and 1. 0 indicates no progress; 1.0 indicates complete."
  39           }
  40         ]
  41       }  // onDownloadProgress
  42     ],  // events
  43     "functions": [
  44       {
  45         "name": "install",
  46         "allowAmbiguousOptionalArguments": true,
  47         "parameters": [
  48           {
  49             "name": "url",
  50             "type": "string",
  51             "optional": true,
  52             "description": "If you have more than one <code>&lt;link&gt;</code> tag on your page with the <code>chrome-webstore-item</code> relation, you can choose which item you'd like to install by passing in its URL here. If it is omitted, then the first (or only) link will be used. An exception will be thrown if the passed in URL does not exist on the page."
  53           },
  54           {
  55             "name": "successCallback",
  56             "type": "function",
  57             "optional": true,
  58             "parameters": [],
  59             "description": "This function is invoked when inline installation successfully completes (after the dialog is shown and the user agrees to add the item to Chrome). You may wish to use this to hide the user interface element that prompted the user to install the app or extension."
  60           },
  61           {
  62             "name": "failureCallback",
  63             "type": "function",
  64             "optional": true,
  65             "parameters": [
  66               {
  67                 "name": "error",
  68                 "type": "string",
  69                 "description": "The failure detail. You may wish to inspect or log this for debugging purposes, but you should not rely on specific strings being passed back."
  70               }
  71             ],
  72             "description": "This function is invoked when inline installation does not successfully complete. Possible reasons for this include the user canceling the dialog, the linked item not being found in the store, or the install being initiated from a non-verified site."
  73           }
  74         ]
  75       }  // install
  76     ]  // functions
  77   }  // webstore
  78 ]