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