summaryrefslogtreecommitdiffstats
path: root/chrome/common/extensions/api/chromeos_info_private.json
blob: d792908473ee663119a5bc9856cbc43af7009830 (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
96
97
98
99
// 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": "chromeosInfoPrivate",
    "description": "none",
    "compiler_options": {
      "implemented_in": "chrome/browser/chromeos/extensions/info_private_api.h"
    },
    "types": [
      {
        "id": "PropertyName",
        "type": "string",
        "enum": ["timezone",
                 "a11yLargeCursorEnabled",
                 "a11yStickyKeysEnabled",
                 "a11ySpokenFeedbackEnabled",
                 "a11yHighContrastEnabled",
                 "a11yScreenMagnifierEnabled",
                 "a11yAutoClickEnabled",
                 "a11yVirtualKeyboardEnabled",
                 "sendFunctionKeys"],
        "description": "Chrome OS system property name"
      }
    ],
    "functions": [
      {
        "name": "get",
        "description": "Fetches customization values for the given property names. See property names in the declaration of the returned dictionary.",
        "type": "function",
        "parameters": [
          {
            "name": "propertyNames",
            "type": "array",
            "description": "Chrome OS Property names",
            "items": {"type": "string"}
          },
          {
            "name": "callback",
            "type": "function",
            "parameters": [
              {
                "name": "propertiesDictionary",
                "type": "object",
                "description": "Dictionary which contains all requested properties",
                "properties": {
                  "board" : {"type": "string", "optional": true, "description": "Board name"},
                  "customizationId": {"type": "string", "optional": true, "description": "Customization ID"},
                  "homeProvider" : {"type": "string", "optional": true, "description": "Home provider which is used by the cellular device"},
                  "hwid": {"type": "string", "optional": true, "description": "Hardware ID"},
                  "initialLocale" : {"type": "string", "optional": true, "description": "Initial locale for the device"},
                  "isOwner" : {"type": "boolean", "optional": true, "description": "True if current logged in user is device owner"},
                  "clientId" : {"type": "string", "optional": true, "description": "Device client id"},
                  "timezone" : {"type": "string", "optional": true, "description": "Timezone"},
                  "a11yLargeCursorEnabled" : {"type": "boolean", "optional": true, "description": "If true, ChromeOS is showing enlarged cursor."},
                  "a11yStickyKeysEnabled" : {"type": "boolean", "optional": true, "description": "If true, sticky keys are turned on."},
                  "a11ySpokenFeedbackEnabled" : {"type": "boolean", "optional": true, "description": "If enabled, ChromeOS text-to-speech feature is turned on."},
                  "a11yHighContrastEnabled" : {"type": "boolean", "optional": true, "description": "If true, all displays have high contrast mode turned on."},
                  "a11yScreenMagnifierEnabled" : {"type": "boolean", "optional": true, "description": "If true, all displays have screen magnifier turned on."},
                  "a11yAutoClickEnabled" : {"type": "boolean", "optional": true, "description": "If true, auto mouse click accessibility feature is turned on."},
                  "a11yVirtualKeyboardEnabled" : {"type": "boolean", "optional": true, "description": "If true, virtual keyboard will be enabled."},
                  "sendFunctionKeys" : {"type": "boolean", "optional": true, "description": "If true, the ChromeOS top row keys send function keys."},
                  "supportedTimezones" : {
                    "type": "array",
                    "items": {
                      "type": "array",
                      "items": {"type": "string"}
                    },
                    "optional": true,
                    "description": "List of supported timezones definitions."
                  }
                }
              }
            ]
          }
        ]
      },
      {
        "name": "set",
        "description": "Sets values for the given system property.",
        "type": "function",
        "parameters": [
          {
            "name": "propertyName",
            "$ref": "PropertyName",
            "description": "Chrome OS system property name"
          },
          {
            "name": "propertyValue",
            "type": "any",
            "description": "Chrome OS system property value"
          }
        ]
      }
    ]
  }
]