Home | History | Annotate | Download | only in api 
      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                   "clientId" : {"type": "string", "optional": true, "description": "Device client id"},
     42                   "timezone" : {"type": "string", "optional": true, "description": "Timezone"},
     43                   "a11yLargeCursorEnabled" : {"type": "boolean", "optional": true, "description": "If true, ChromeOS is showing enlarged cursor."},
     44                   "a11yStickyKeysEnabled" : {"type": "boolean", "optional": true, "description": "If true, sticky keys are turned on."},
     45                   "a11ySpokenFeedbackEnabled" : {"type": "boolean", "optional": true, "description": "If enabled, ChromeOS text-to-speech feature is turned on."},
     46                   "a11yHighContrastEnabled" : {"type": "boolean", "optional": true, "description": "If true, all displays have high contrast mode turned on."},
     47                   "a11yScreenMagnifierEnabled" : {"type": "boolean", "optional": true, "description": "If true, all displays have screen magnifier turned on."},
     48                   "a11yAutoClickEnabled" : {"type": "boolean", "optional": true, "description": "If true, auto mouse click accessibility feature is turned on."},
     49                   "a11yVirtualKeyboardEnabled" : {"type": "boolean", "optional": true, "description": "If true, virtual keyboard will be enabled."},
     50                   "sendFunctionKeys" : {"type": "boolean", "optional": true, "description": "If true, the ChromeOS top row keys send function keys."},
     51                   "supportedTimezones" : {
     52                     "type": "array",
     53                     "items": {
     54                       "type": "array",
     55                       "items": {"type": "string"}
     56                     },
     57                     "optional": true,
     58                     "description": "List of supported timezones definitions."
     59                   }
     60                 }
     61               }
     62             ]
     63           }
     64         ]
     65       },
     66       {
     67         "name": "set",
     68         "description": "Sets values for the given system property.",
     69         "type": "function",
     70         "parameters": [
     71           {
     72             "name": "propertyName",
     73             "type": "string",
     74             "enum": ["timezone",
     75                      "a11yLargeCursorEnabled",
     76                      "a11yStickyKeysEnabled",
     77                      "a11ySpokenFeedbackEnabled",
     78                      "a11yHighContrastEnabled",
     79                      "a11yScreenMagnifierEnabled",
     80                      "a11yAutoClickEnabled",
     81                      "a11yVirtualKeyboardEnabled",
     82                      "sendFunctionKeys"],
     83             "description": "Chrome OS system property name"
     84           },
     85           {
     86             "name": "propertyValue",
     87             "type": "any",
     88             "description": "Chrome OS system property value"
     89           }
     90         ]
     91       }
     92     ]
     93   }
     94 ]
     95