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
128
129
130
131
132
133
134
135
136
137
138
139
140
141
142
143
144
145
146
147
148
149
150
151
152
153
154
155
156
157
158
159
160
161
162
163
164
165
166
167
168
|
[
{
"namespace": "types",
"description": "Contains types used by other schemas.",
"types": [
{
"id": "SettingScope",
"type": "string",
"enum": [
"regular",
"regular_only",
"incognito_persistent",
"incognito_session_only"
],
"description": "The scope of the Setting. One of<ul><li><var>regular</var>: setting for the regular profile (which is inherited by the incognito profile if not overridden elsewhere),</li><li><var>regular_only</var>: setting for the regular profile only (not inherited by the incognito profile),</li><li><var>incognito_persistent</var>: setting for the incognito profile that survives browser restarts (overrides regular preferences),</li><li><var>incognito_session_only</var>: setting for the incognito profile that can only be set during an incognito session and is deleted when the incognito session ends (overrides regular and incognito_persistent preferences).</li></ul> Only <var>regular</var> is supported by Firefox at this time."
},
{
"id": "LevelOfControl",
"type": "string",
"enum": [
"not_controllable",
"controlled_by_other_extensions",
"controllable_by_this_extension",
"controlled_by_this_extension"
],
"description": "One of<ul><li><var>not_controllable</var>: cannot be controlled by any extension</li><li><var>controlled_by_other_extensions</var>: controlled by extensions with higher precedence</li><li><var>controllable_by_this_extension</var>: can be controlled by this extension</li><li><var>controlled_by_this_extension</var>: controlled by this extension</li></ul>"
},
{
"id": "Setting",
"type": "object",
"functions": [
{
"name": "get",
"type": "function",
"description": "Gets the value of a setting.",
"async": "callback",
"parameters": [
{
"name": "details",
"type": "object",
"description": "Which setting to consider.",
"properties": {
"incognito": {
"type": "boolean",
"optional": true,
"description": "Whether to return the value that applies to the incognito session (default false)."
}
}
},
{
"name": "callback",
"type": "function",
"parameters": [
{
"name": "details",
"type": "object",
"description": "Details of the currently effective value.",
"properties": {
"value": {
"description": "The value of the setting.",
"type": "any"
},
"levelOfControl": {
"$ref": "types.LevelOfControl",
"description": "The level of control of the setting."
},
"incognitoSpecific": {
"description": "Whether the effective value is specific to the incognito session.<br/>This property will <em>only</em> be present if the <var>incognito</var> property in the <var>details</var> parameter of <code>get()</code> was true.",
"type": "boolean",
"optional": true
}
}
}
]
}
]
},
{
"name": "set",
"type": "function",
"description": "Sets the value of a setting.",
"async": "callback",
"parameters": [
{
"name": "details",
"type": "object",
"description": "Which setting to change.",
"properties": {
"value": {
"description": "The value of the setting. <br/>Note that every setting has a specific value type, which is described together with the setting. An extension should <em>not</em> set a value of a different type.",
"type": "any"
},
"scope": {
"$ref": "types.SettingScope",
"optional": true,
"description": "Where to set the setting (default: regular)."
}
}
},
{
"name": "callback",
"type": "function",
"description": "Called at the completion of the set operation.",
"optional": true,
"parameters": []
}
]
},
{
"name": "clear",
"type": "function",
"description": "Clears the setting, restoring any default value.",
"async": "callback",
"parameters": [
{
"name": "details",
"type": "object",
"description": "Which setting to clear.",
"properties": {
"scope": {
"$ref": "types.SettingScope",
"optional": true,
"description": "Where to clear the setting (default: regular)."
}
}
},
{
"name": "callback",
"type": "function",
"description": "Called at the completion of the clear operation.",
"optional": true,
"parameters": []
}
]
}
],
"events": [
{
"name": "onChange",
"type": "function",
"description": "Fired after the setting changes.",
"parameters": [
{
"type": "object",
"name": "details",
"properties": {
"value": {
"description": "The value of the setting after the change.",
"type": "any"
},
"levelOfControl": {
"$ref": "types.LevelOfControl",
"description": "The level of control of the setting."
},
"incognitoSpecific": {
"description": "Whether the value that has changed is specific to the incognito session.<br/>This property will <em>only</em> be present if the user has enabled the extension in incognito mode.",
"type": "boolean",
"optional": true
}
}
}
]
}
]
}
]
}
]
|
