chrome/common/extensions/api/extension.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": "extension",
   8     "description": "The <code>chrome.extension</code> API has utilities that can be used by any extension page. It includes support for exchanging messages between an extension and its content scripts or between extensions, as described in detail in <a href='messaging'>Message Passing</a>.",
   9     "compiler_options": {
  10       "implemented_in": "chrome/browser/extensions/api/module/module.h"
  11     },
  12     "properties": {
  13       "lastError": {
  14         "type": "object",
  15         "optional": true,
  16         "description": "Set for the lifetime of a callback if an ansychronous extension api has resulted in an error. If no error has occured lastError will be <var>undefined</var>.",
  17         "properties": {
  18           "message": { "type": "string", "description": "Description of the error that has taken place." }
  19         }
  20       },
  21       "inIncognitoContext": {
  22         "type": "boolean",
  23         "optional": true,
  24         "description": "True for content scripts running inside incognito tabs, and for extension pages running inside an incognito process. The latter only applies to extensions with 'split' incognito_behavior."
  25       }
  26     },
  27     "types": [
  28       {
  29         "id": "ViewType",
  30         "type": "string",
  31         "enum": ["tab", "notification", "popup"],
  32         "description": "The type of extension view."
  33       }
  34     ],
  35     "functions": [
  36       {
  37         "name": "sendRequest",
  38         "nocompile": true,
  39         "deprecated": "Please use $(ref:runtime.sendMessage).",
  40         "type": "function",
  41         "allowAmbiguousOptionalArguments": true,
  42         "description": "Sends a single request to other listeners within the extension. Similar to $(ref:runtime.connect), but only sends a single request with an optional response. The $(ref:extension.onRequest) event is fired in each page of the extension.",
  43         "parameters": [
  44           {"type": "string", "name": "extensionId", "optional": true, "description": "The extension ID of the extension you want to connect to. If omitted, default is your own extension."},
  45           { "type": "any", "name": "request" },
  46           {
  47             "type": "function",
  48             "name": "responseCallback",
  49             "optional": true,
  50             "parameters": [
  51               {
  52                 "name": "response",
  53                 "type": "any",
  54                 "description": "The JSON response object sent by the handler of the request. If an error occurs while connecting to the extension, the callback will be called with no arguments and $(ref:runtime.lastError) will be set to the error message."
  55               }
  56             ]
  57           }
  58         ]
  59       },
  60       {
  61         "name": "getURL",
  62         "nocompile": true,
  63         "type": "function",
  64         "description": "Converts a relative path within an extension install directory to a fully-qualified URL.",
  65         "parameters": [
  66           {
  67             "type": "string",
  68             "name": "path",
  69             "description": "A path to a resource within an extension expressed relative to its install directory."
  70           }
  71         ],
  72         "returns": {
  73           "type": "string",
  74           "description": "The fully-qualified URL to the resource."
  75         }
  76       },
  77       {
  78         "name": "getViews",
  79         "nocompile": true,
  80         "type": "function",
  81         "description": "Returns an array of the JavaScript 'window' objects for each of the pages running inside the current extension.",
  82         "parameters": [
  83           {
  84             "type": "object",
  85             "name": "fetchProperties",
  86             "optional": true,
  87             "properties": {
  88               "type": {
  89                 "$ref": "ViewType",
  90                 "optional": true,
  91                 "description": "The type of view to get. If omitted, returns all views (including background pages and tabs). Valid values: 'tab', 'notification', 'popup'."
  92               },
  93               "windowId": {
  94                 "type": "integer",
  95                 "optional": true,
  96                 "description": "The window to restrict the search to. If omitted, returns all views."
  97               }
  98             }
  99           }
 100         ],
 101         "returns": {
 102           "type": "array",
 103           "description": "Array of global objects",
 104           "items": {
 105             "name": "viewGlobals",
 106             "type": "object",
 107             "isInstanceOf": "Window",
 108             "additionalProperties": { "type": "any" }
 109           }
 110         }
 111       },
 112       {
 113         "name": "getBackgroundPage",
 114         "nocompile": true,
 115         "type": "function",
 116         "description": "Returns the JavaScript 'window' object for the background page running inside the current extension. Returns null if the extension has no background page.",
 117         "parameters": [],
 118         "returns": {
 119             "type": "object",
 120             "optional": true,
 121             "name": "backgroundPageGlobal",
 122             "isInstanceOf": "Window",
 123             "additionalProperties": { "type": "any" }
 124          }
 125       },
 126       {
 127         "name": "getExtensionTabs",
 128         "nocompile": true,
 129         "deprecated": "Please use $(ref:extension.getViews) <code>{type: \"tab\"}</code>.",
 130         "type": "function",
 131         "maximumManifestVersion": 1,
 132         "description": "Returns an array of the JavaScript 'window' objects for each of the tabs running inside the current extension. If <code>windowId</code> is specified, returns only the 'window' objects of tabs attached to the specified window.",
 133         "parameters": [
 134           {"type": "integer", "name": "windowId", "optional": true}
 135         ],
 136         "returns": {
 137           "type": "array",
 138           "description": "Array of global window objects",
 139           "items": {
 140             "type": "object",
 141             "name": "tabGlobals",
 142             "isInstanceOf": "Window",
 143             "additionalProperties": { "type": "any" }
 144           }
 145         }
 146       },
 147       {
 148         "name": "isAllowedIncognitoAccess",
 149         "type": "function",
 150         "description": "Retrieves the state of the extension's access to Incognito-mode (as determined by the user-controlled 'Allowed in Incognito' checkbox.",
 151         "min_version": "12.0.706.0",
 152         "parameters": [
 153           {
 154             "type": "function",
 155             "name": "callback",
 156             "parameters": [
 157               {
 158                 "name": "isAllowedAccess",
 159                 "type": "boolean",
 160                 "description": "True if the extension has access to Incognito mode, false otherwise."
 161               }
 162             ]
 163           }
 164         ]
 165       },
 166       {
 167         "name": "isAllowedFileSchemeAccess",
 168         "type": "function",
 169         "description": "Retrieves the state of the extension's access to the 'file://' scheme (as determined by the user-controlled 'Allow access to File URLs' checkbox.",
 170         "min_version": "12.0.706.0",
 171         "parameters": [
 172           {
 173             "type": "function",
 174             "name": "callback",
 175             "parameters": [
 176               {
 177                 "name": "isAllowedAccess",
 178                 "type": "boolean",
 179                 "description": "True if the extension can access the 'file://' scheme, false otherwise."
 180               }
 181             ]
 182           }
 183         ]
 184       },
 185       {
 186         "name": "setUpdateUrlData",
 187         "type": "function",
 188         "description": "Sets the value of the ap CGI parameter used in the extension's update URL.  This value is ignored for extensions that are hosted in the Chrome Extension Gallery.",
 189         "parameters": [
 190           {"type": "string", "name": "data", "maxLength": 1024}
 191         ]
 192       }
 193     ],
 194     "events": [
 195       {
 196         "name": "onRequest",
 197         "deprecated": "Please use $(ref:runtime.onMessage).",
 198         "type": "function",
 199         "options": {
 200           "unmanaged": true
 201         },
 202         "description": "Fired when a request is sent from either an extension process or a content script.",
 203         "parameters": [
 204           {"name": "request", "type": "any", "optional": true, "description": "The request sent by the calling script."},
 205           {"name": "sender", "$ref": "runtime.MessageSender" },
 206           {"name": "sendResponse", "type": "function", "description": "Function to call (at most once) when you have a response. The argument should be any JSON-ifiable object, or undefined if there is no response. If you have more than one <code>onRequest</code> listener in the same document, then only one may send a response." }
 207         ]
 208       },
 209       {
 210         "name": "onRequestExternal",
 211         "deprecated": "Please use $(ref:runtime.onMessageExternal).",
 212         "type": "function",
 213         "description": "Fired when a request is sent from another extension.",
 214         "parameters": [
 215           {"name": "request", "type": "any", "optional": true, "description": "The request sent by the calling script."},
 216           {"name": "sender", "$ref": "runtime.MessageSender" },
 217           {"name": "sendResponse", "type": "function", "description": "Function to call when you have a response. The argument should be any JSON-ifiable object, or undefined if there is no response." }
 218         ]
 219       }
 220     ]
 221   }
 222 ]