chrome/common/extensions/api/chromeos_info_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": "chromeosInfoPrivate",
   8     "description": "none",
   9     "compiler_options": {
  10       "implemented_in": "chrome/browser/chromeos/extensions/info_private_api.h"
  11     },
  12     "platforms": ["chromeos"],
  13     "nodoc": "true",
  14     "functions": [
  15       {
  16         "name": "get",
  17         "description": "Fetches customization values for the given property names. See property names in the declaration of the returned dictionary.",
  18         "type": "function",
  19         "parameters": [
  20           {
  21             "name": "propertyNames",
  22             "type": "array",
  23             "description": "Chrome OS Property names",
  24             "items": {"type": "string"}
  25           },
  26           {
  27             "name": "callback",
  28             "type": "function",
  29             "parameters": [
  30               {
  31                 "name": "propertiesDictionary",
  32                 "type": "object",
  33                 "description": "Dictionary which contains all requested properties",
  34                 "properties": {
  35                   "board" : {"type": "string", "optional": true, "description": "Board name"},
  36                   "customizationId": {"type": "string", "optional": true, "description": "Customization ID"},
  37                   "homeProvider" : {"type": "string", "optional": true, "description": "Home provider which is used by the cellular device"},
  38                   "hwid": {"type": "string", "optional": true, "description": "Hardware ID"},
  39                   "initialLocale" : {"type": "string", "optional": true, "description": "Initial locale for the device"},
  40                   "isOwner" : {"type": "boolean", "optional": true, "description": "True if current logged in user is device owner"},
  41                   "timezone" : {"type": "string", "optional": true, "description": "Timezone"},
  42                   "a11yLargeCursorEnabled" : {"type": "boolean", "optional": true, "description": "If true, ChromeOS is showing enlarged cursor."},
  43                   "a11yStickyKeysEnabled" : {"type": "boolean", "optional": true, "description": "If true, sticky keys are turned on."},
  44                   "a11ySpokenFeedbackEnabled" : {"type": "boolean", "optional": true, "description": "If enabled, ChromeOS text-to-speech feature is turned on."},
  45                   "a11yHighContrastEnabled" : {"type": "boolean", "optional": true, "description": "If true, all displays have high contrast mode turned on."},
  46                   "a11yScreenMagnifierEnabled" : {"type": "boolean", "optional": true, "description": "If true, all displays have screen magnifier turned on."},
  47                   "a11yAutoClickEnabled" : {"type": "boolean", "optional": true, "description": "If true, auto mouse click accessibility feature is turned on."},
  48                   "a11yVirtualKeyboardEnabled" : {"type": "boolean", "optional": true, "description": "If true, virtual keyboard will be enabled."},
  49                   "sendFunctionKeys" : {"type": "boolean", "optional": true, "description": "If true, the ChromeOS top row keys send function keys."},
  50                   "supportedTimezones" : {
  51                     "type": "array",
  52                     "items": {
  53                       "type": "array",
  54                       "items": {"type": "string"}
  55                     },
  56                     "optional": true,
  57                     "description": "List of supported timezones definitions."
  58                   }
  59                 }
  60               }
  61             ]
  62           }
  63         ]
  64       },
  65       {
  66         "name": "set",
  67         "description": "Sets values for the given system property.",
  68         "type": "function",
  69         "parameters": [
  70           {
  71             "name": "propertyName",
  72             "type": "string",
  73             "enum": ["timezone",
  74                      "a11yLargeCursorEnabled",
  75                      "a11yStickyKeysEnabled",
  76                      "a11ySpokenFeedbackEnabled",
  77                      "a11yHighContrastEnabled",
  78                      "a11yScreenMagnifierEnabled",
  79                      "a11yAutoClickEnabled",
  80                      "a11yVirtualKeyboardEnabled",
  81                      "sendFunctionKeys"],
  82             "description": "Chrome OS system property name"
  83           },
  84           {
  85             "name": "propertyValue",
  86             "type": "any",
  87             "description": "Chrome OS system property value"
  88           }
  89         ]
  90       }
  91     ]
  92   }
  93 ]