summaryrefslogtreecommitdiff
path: root/chromium/chrome/common/extensions/api/system_private.json
blob: ce65acb1bb4d0b68f96ded1f18d551413289ee4d (plain)
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
// Copyright (c) 2012 The Chromium Authors. All rights reserved.
// Use of this source code is governed by a BSD-style license that can be
// found in the LICENSE file.

[
  {
    "namespace": "systemPrivate",
    "description": "none",
    "types": [
      {
        "id": "UpdateStatusState",
        "type": "string",
        "enum": ["NotAvailable", "Updating", "NeedRestart"],
        "description": "State of system update.  NotAvailable when there is no available update or the update system is in error state, Updating when a system update is in progress, NeedRestart when a system update is finished and restart is needed."
      },
      {
        "id": "GetIncognitoModeAvailabilityValue",
        "type": "string",
        "enum": ["enabled", "disabled", "forced"],
        "description": "Exposes whether the incognito mode is available to windows. One of 'enabled', 'disabled' (user cannot browse pages in Incognito mode), 'forced' (all pages/sessions are forced into Incognito mode)."
      },
      {
        "id": "UpdateStatus",
        "type": "object",
        "description": "Information about the system update.",
        "properties": {
          "state": {
            "$ref": "UpdateStatusState",
            "description": "State of system update."
          },
          "downloadProgress": {
            "type": "number",
            "description": "Value between 0 and 1 describing the progress of system update download.  This value will be set to 0 when |state| is NotAvailable, 1 when NeedRestart."
          }
        }
      }
    ],
    "functions": [
      {
        "name": "getIncognitoModeAvailability",
        "type": "function",
        "description": "Returns whether the incognito mode is enabled, disabled or forced",
        "parameters": [
          {
            "name": "callback",
            "type": "function",
            "description": "Called with the result.",
            "parameters": [
              {
                "name": "value",
                "$ref": "GetIncognitoModeAvailabilityValue"
              }
            ]
          }
        ]
      },
      {
        "name": "getUpdateStatus",
        "type": "function",
        "description": "Gets information about the system update.",
        "parameters": [
          {
            "type": "function",
            "name": "callback",
            "parameters": [
              {
                "$ref": "UpdateStatus",
                "name": "status",
                "description": "Details of the system update"
              }
            ]
          }
        ]
      },
      {
        "name": "getApiKey",
        "type": "function",
        "description": "Gets Chrome's API key to use for requests to Google services.",
        "parameters": [
          {
            "type": "function",
            "name": "callback",
            "parameters": [
              {
                "name": "key",
                "type": "string",
                "description": "The API key."
              }
            ]
          }
        ]
      }
    ]
  }
]