Merge Chromium + Blink git repositories
[chromium-blink-merge.git] / chrome / common / extensions / api / data_reduction_proxy.json
blob1dd904bb07199eea2a7e9bb3831bbbc97fe0d76f
1 // Copyright 2014 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.
6   {
7     "namespace": "dataReductionProxy",
8     "description": "Use the <code>chrome.dataReductionProxy</code> API to control the data reduction proxy and access usage metrics. This API relies on the <a href='types#ChromeSetting'>ChromeSetting prototype of the type API</a> for getting and setting Chrome's configuration.",
9     "properties": {
10       "spdyProxyEnabled": {
11         "nocompile": true,
12         "$ref": "types.ChromeSetting",
13         "value": ["spdy_proxy.enabled", {"type":"boolean"}],
14         "description": "Flag to enable data usage reduction by sending requests via data reduction proxy. This preference's value is a boolean, defaulting to <code>false</code>."
15       },
16       "dataReductionDailyContentLength": {
17         "nocompile": true,
18         "$ref": "types.ChromeSetting",
19         "value": ["data_reduction.daily_original_length", {"type":"array"}],
20         "description": "Each item contains the number uncompressed bytes through data reduction proxy per day."
21       },
22       "dataReductionDailyReceivedLength": {
23         "nocompile": true,
24         "$ref": "types.ChromeSetting",
25         "value": ["data_reduction.daily_received_length", {"type":"array"}],
26         "description": "Each item contains the number of compressed bytes through data reduction proxy per day."
27       }
28     },
29     "functions": [
30       {
31         "name": "clearDataSavings",
32         "type": "function",
33         "description": "Clear all data saving metrics obtained by using the data reduction proxy.",
34         "parameters": [
35           {
36             "type": "function",
37             "name": "callback",
38             "description": "Callback to call after data savings have been cleared",
39             "optional": true,
40             "parameters": []
41           }
42         ]
43       }
44     ]
45   }