chrome/common/extensions/api/web_request_internal.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": "webRequestInternal",
   8     "nodoc": true,
   9     "internal": true,
  10     "functions": [
  11       {
  12         "name": "addEventListener",
  13         "type": "function",
  14         "description": "Used internally to implement the special form of addListener for the webRequest events.",
  15         "parameters": [
  16           {"type": "function", "name": "callback"},
  17           {
  18             "$ref": "webRequest.RequestFilter",
  19             "name": "filter",
  20             "description": "A set of filters that restricts the events that will be sent to this listener."
  21           },
  22           {
  23             "type": "array",
  24             "optional": true,
  25             "name": "extraInfoSpec",
  26             "description": "Array of extra information that should be passed to the listener function.",
  27             "items": {
  28               "type": "string",
  29               "enum": ["requestHeaders", "responseHeaders", "blocking", "asyncBlocking", "requestBody"]
  30             }
  31           },
  32           {"type": "string", "name": "eventName"},
  33           {"type": "string", "name": "subEventName"}
  34         ]
  35       },
  36       {
  37         "name": "eventHandled",
  38         "type": "function",
  39         "description": "Used internally to send a response for a blocked event.",
  40         "parameters": [
  41           {"type": "string", "name": "eventName"},
  42           {"type": "string", "name": "subEventName"},
  43           {"type": "string", "name": "requestId"},
  44           {
  45             "$ref": "webRequest.BlockingResponse",
  46             "optional": true,
  47             "name": "response"
  48           }
  49         ]
  50       }
  51     ]
  52   }
  53 ]