chrome/common/extensions/api/system_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": "systemPrivate",
   8     "description": "none",
   9     "types": [
  10       {
  11         "id": "UpdateStatusState",
  12         "type": "string",
  13         "enum": ["NotAvailable", "Updating", "NeedRestart"],
  14         "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."
  15       },
  16       {
  17         "id": "GetIncognitoModeAvailabilityValue",
  18         "type": "string",
  19         "enum": ["enabled", "disabled", "forced"],
  20         "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)."
  21       },
  22       {
  23         "id": "UpdateStatus",
  24         "type": "object",
  25         "description": "Information about the system update.",
  26         "properties": {
  27           "state": {
  28             "$ref": "UpdateStatusState",
  29             "description": "State of system update."
  30           },
  31           "downloadProgress": {
  32             "type": "number",
  33             "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."
  34           }
  35         }
  36       },
  37       {
  38         "id": "VolumeInfo",
  39         "type": "object",
  40         "description": "Information about the volume.",
  41         "properties": {
  42           "volume": {"type": "number", "description": "The value of the volume percent. This must be between 0.0 and 100.0."},
  43           "isVolumeMuted": {"type": "boolean", "description": "True if the volume is muted."}
  44         }
  45       },
  46       {
  47         "id": "BrightnessChangeInfo",
  48         "type": "object",
  49         "description": "Information about a change to the screen brightness.",
  50         "properties": {
  51           "brightness": {
  52             "type": "number",
  53             "description": "The value of the current screen brightness in percent, between 0.0 and 100.0."
  54           },
  55           "userInitiated": {
  56             "type": "boolean",
  57             "description": "Whether this change was initiated by user."
  58           }
  59         }
  60       }
  61     ],
  62     "functions": [
  63       {
  64         "name": "getIncognitoModeAvailability",
  65         "type": "function",
  66         "description": "Returns whether the incognito mode is enabled, disabled or forced",
  67         "parameters": [
  68           {
  69             "name": "callback",
  70             "type": "function",
  71             "description": "Called with the result.",
  72             "parameters": [
  73               {
  74                 "name": "value",
  75                 "$ref": "GetIncognitoModeAvailabilityValue"
  76               }
  77             ]
  78           }
  79         ]
  80       },
  81       {
  82         "name": "getUpdateStatus",
  83         "type": "function",
  84         "description": "Gets information about the system update.",
  85         "parameters": [
  86           {
  87             "type": "function",
  88             "name": "callback",
  89             "parameters": [
  90               {
  91                 "$ref": "UpdateStatus",
  92                 "name": "status",
  93                 "description": "Details of the system update"
  94               }
  95             ]
  96           }
  97         ]
  98       },
  99       {
 100         "name": "getApiKey",
 101         "type": "function",
 102         "description": "Gets Chrome's API key to use for requests to Google services.",
 103         "parameters": [
 104           {
 105             "type": "function",
 106             "name": "callback",
 107             "parameters": [
 108               {
 109                 "name": "key",
 110                 "type": "string",
 111                 "description": "The API key."
 112               }
 113             ]
 114           }
 115         ]
 116       }
 117     ],
 118     "events": [
 119       {
 120         "name": "onVolumeChanged",
 121         "type": "function",
 122         "description": "Fired when the volume is changed.",
 123         "parameters": [
 124           {
 125             "$ref": "VolumeInfo",
 126             "name": "volume",
 127             "description": "Information about the current state of the system volume control, including whether it is muted."
 128           }
 129         ]
 130       },
 131       {
 132         "name": "onBrightnessChanged",
 133         "type": "function",
 134         "description": "Fired when the screen brightness is changed.",
 135         "parameters": [
 136           {
 137             "$ref": "BrightnessChangeInfo",
 138             "name": "brightness",
 139             "description": "Information about a change to the screen brightness."
 140           }
 141         ]
 142       },
 143       {
 144         "name": "onScreenUnlocked",
 145         "type": "function",
 146         "description": "Fired when the screen is unlocked.",
 147         "parameters": []
 148       },
 149       {
 150         "name": "onWokeUp",
 151         "type": "function",
 152         "description": "Fired when the device wakes up from sleep.",
 153         "parameters": []
 154       }
 155     ]
 156   }
 157 ]