src/chrome/common/extensions/api/webstore_private.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":"webstorePrivate",
   8     "description": "none",
   9     "functions": [
  10       {
  11         "name": "install",
  12         "nocompile": true,
  13         "description": "Installs the extension corresponding to the given id",
  14         "parameters": [
  15           {
  16             "name": "expected_id",
  17             "type": "string",
  18             "description": "The id of the extension to install."
  19           },
  20           {
  21             "name": "callback",
  22             "type": "function",
  23             "optional": true,
  24             "parameters": []
  25           }
  26         ]
  27       },
  28       {
  29         "name": "beginInstallWithManifest3",
  30         "description": "Initiates the install process for the given extension.",
  31         "parameters": [
  32           {
  33             "name": "details",
  34             "type": "object",
  35             "properties": {
  36               "id": {
  37                 "type": "string",
  38                 "description": "The id of the extension to be installled.",
  39                 "minLength": 32,
  40                 "maxLength": 32
  41               },
  42               "manifest": {
  43                 "type": "string",
  44                 "description": "A string with the contents of the extension's manifest.json file. During the install process, the browser will check that the downloaded extension's manifest matches what was passed in here.",
  45                 "minLength": 1
  46               },
  47               "iconUrl": {
  48                 "type": "string",
  49                 "optional": true,
  50                 "desciption": "A URL for the image to display in the confirmation dialog"
  51               },
  52               "iconData": {
  53                 "type": "string",
  54                 "optional": true,
  55                 "description": "An icon as a base64-encoded image, displayed in a confirmation dialog."
  56               },
  57               "localizedName": {
  58                 "type": "string",
  59                 "optional": true,
  60                 "description": "A string to use instead of the raw value of the 'name' key from manifest.json."
  61               },
  62               "locale": {
  63                 "type": "string",
  64                 "optional": true,
  65                 "description": "The name of the locale used for generating localizedName. This should be the name of one of the directories in the _locales folder of the extension, or the default_locale setting from the manifest."
  66               },
  67               "appInstallBubble": {
  68                 "type": "boolean",
  69                 "optional": true,
  70                 "description": "A flag to change the UI we show when an app is installed - a value of true means to show a bubble pointing at the new tab button (instead of the default behavior of opening the new tab page and animating the app icon)."
  71               },
  72               "enableLauncher": {
  73                 "type": "boolean",
  74                 "optional": true,
  75                 "description": "A flag to cause the app launcher to be installed before installing the extension, if it isn't installed already."
  76               },
  77               "authuser": {
  78                 "type": "string",
  79                 "optional": true,
  80                 "description": "The authuser index to be included with CRX download requests in multi-login sessions."
  81               }
  82             },
  83             "additionalProperties": { "type": "any" }
  84           },
  85           {
  86             "name": "callback",
  87             "type": "function",
  88             "description": "Called when the user has either accepted/rejected the dialog, or some error occurred (such as invalid manifest or icon image data).",
  89             "optional": true,
  90             "parameters": [
  91               {
  92                 "name": "result",
  93                 "type": "string",
  94                 "description": "A string result code, which will be empty upon success. The possible values in the case of errors include 'unknown_error', 'user_cancelled', 'manifest_error', 'icon_error', 'invalid_id', 'permission_denied', 'invalid_icon_url' and 'already_installed'."
  95               }
  96             ]
  97           }
  98         ]
  99
 100       },
 101       {
 102         "name": "completeInstall",
 103         "description": "",
 104         "parameters": [
 105           {
 106             "name": "expected_id",
 107             "type": "string",
 108             "description": "The id of the extension to be installed. This should match a previous call to beginInstallWithManifest3."
 109           },
 110           {
 111             "name": "callback",
 112             "type": "function",
 113             "optional": true,
 114             "parameters": []
 115           }
 116         ]
 117       },
 118       {
 119         "name": "enableAppLauncher",
 120         "description": "",
 121         "parameters": [
 122           {
 123             "name": "callback",
 124             "type": "function",
 125             "optional": true,
 126             "parameters": []
 127           }
 128         ]
 129       },
 130       {
 131         "name": "getBrowserLogin",
 132         "description": "Returns the logged-in sync user login if there is one, or the empty string otherwise.",
 133         "parameters": [
 134           {
 135             "name": "callback",
 136             "type": "function",
 137             "optional": false,
 138             "parameters": [
 139               {
 140                 "name": "info",
 141                 "type": "object",
 142                 "properties": {
 143                   "login": { "type": "string" }
 144                 }
 145               }
 146             ]
 147           }
 148         ]
 149       },
 150       {
 151         "name": "getStoreLogin",
 152         "description": "Returns the previous value set by setStoreLogin, or the empty string if there is none.",
 153         "parameters": [
 154           {
 155             "name": "callback",
 156             "type": "function",
 157             "optional": false,
 158             "parameters": [
 159               { "name": "login", "type": "string" }
 160             ]
 161           }
 162         ]
 163       },
 164       {
 165         "name": "setStoreLogin",
 166         "description": "Sets a preference value with the store login.",
 167         "parameters": [
 168           { "name": "login", "type": "string" },
 169           {
 170             "name": "callback",
 171             "type": "function",
 172             "optional": true,
 173             "parameters": []
 174           }
 175         ]
 176       },
 177       {
 178         "name": "getWebGLStatus",
 179         "description": "Invokes a callback that returns whether WebGL is blacklisted or not.",
 180         "parameters": [
 181           {
 182             "name": "callback",
 183             "type": "function",
 184             "optional": false,
 185             "parameters": [
 186               {
 187                 "name": "webgl_status",
 188                 "type": "string",
 189                 "enum": ["webgl_allowed", "webgl_blocked"]
 190               }
 191             ]
 192           }
 193         ]
 194       },
 195       {
 196         "name": "getIsLauncherEnabled",
 197         "description": "Returns whether the apps launcher is enabled or not.",
 198         "parameters": [
 199           {
 200             "name": "callback",
 201             "type": "function",
 202             "optional": false,
 203             "parameters": [
 204               { "name": "is_enabled", "type": "boolean" }
 205             ]
 206           }
 207         ]
 208       },
 209       {
 210         "name": "isInIncognitoMode",
 211         "description": "Returns whether the browser is in incognito mode or not.",
 212         "parameters": [
 213           {
 214             "name": "callback",
 215             "type": "function",
 216             "optional": false,
 217             "parameters": [
 218               { "name": "is_incognito", "type": "boolean" }
 219             ]
 220           }
 221         ]
 222       },
 223       {
 224         "name": "getEphemeralAppsEnabled",
 225         "description": "Returns whether the ephemeral apps feature is enabled.",
 226         "parameters": [
 227           {
 228             "name": "callback",
 229             "type": "function",
 230             "optional": false,
 231             "parameters": [
 232               { "name": "is_enabled", "type": "boolean" }
 233             ]
 234           }
 235         ]
 236       },
 237       {
 238         "name": "launchEphemeralApp",
 239         "description": "Installs an app ephemerally in Chrome (if not already fully installed) and launches the app. A user gesture is required.",
 240         "parameters": [
 241           {
 242             "name": "id",
 243             "type": "string",
 244             "description": "The extension id of the app to launch."
 245           },
 246           {
 247             "name": "callback",
 248             "type": "function",
 249             "optional": true,
 250             "parameters": [
 251               {
 252                 "name": "result",
 253                 "type": "string",
 254                 "enum": ["success", "user_gesture_required", "unknown_error", "feature_disabled", "unsupported_extension_type", "missing_dependencies", "install_error", "user_cancelled", "invalid_id", "blacklisted", "blocked_by_policy", "install_in_progress", "launch_in_progress"],
 255                 "description": "Whether an attempt to launch an app succeeded, or the reason for failure."
 256               }
 257             ]
 258           }
 259         ]
 260       }
 261     ]
 262   }
 263 ]