summaryrefslogtreecommitdiffstats
path: root/chrome/common/extensions/api/managed_mode_private.json
blob: 8c5a63b311e91eb27a341db28a032b535d90597d (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
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
// 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": "managedModePrivate",
    "nodoc": true,
    "functions": [
      {
        "name": "enter",
        "type": "function",
        "description": "Shows a confirmation dialog, then puts the browser into managed mode. The callback parameter will be true if managed mode was entered successfully, false if the user cancelled the confirmation. If managed mode is already on, trying to enter it again will have no effect.",
        "parameters": [
          {
            "type": "function",
            "name": "callback",
            "optional": true,
            "parameters": [
              {
                "name": "result",
                "type": "object",
                "description": "The result of the attempt to enter managed mode.",
                "properties": {
                  "success": {
                    "description": "True if managed mode was entered successfully, false if the user cancelled the confirmation.",
                    "type": "boolean"
                  }
                }
              }
            ]
          }
        ]
      },
      {
        "name": "get",
        "type": "function",
        "description": "Gets the value of the setting describing whether managed mode is in effect.",
        "parameters": [
          {
            "type": "function",
            "name": "callback",
            "parameters": [
              {
                "name": "details",
                "type": "object",
                "description": "Details of the currently effective value.",
                "properties": {
                  "value": {
                    "description": "The value of the setting.",
                    "type": "boolean"
                  }
                }
              }
            ]
          }
        ]
      },
      {
        "name": "setPolicy",
        "type": "function",
        "description": "Sets a policy.",
        "parameters": [
          {
            "name": "key",
            "type": "string",
            "description": "Policy key."
          },
          {
            "name": "value",
            "type": "any",
            "description": "Policy value."
          },
          {
            "type": "function",
            "name": "callback",
            "optional": true,
            "parameters": []
          }
        ]
      },
      {
        "name": "getPolicy",
        "type": "function",
        "description": "Gets a policy value.",
        "parameters": [
          {
            "name": "key",
            "type": "string",
            "description": "Policy key."
          },
          {
            "type": "function",
            "name": "callback",
            "optional": true,
            "parameters": [
              {
                "name": "value",
                "type": "any",
                "description": "Policy value or null if no policy is set.",
                "optional": true
              }
            ]
          }
        ]
      }
    ],
    "events": [
      {
        "name": "onChange",
        "description": "Fired when the value of the setting changes.",
        "parameters": [
          {
            "type": "object",
            "name": "details",
            "properties": {
              "value": {
                "description": "The value of the setting.",
                "type": "any"
              }
            }
          }
        ]
      }
    ]
  }
]