| blob | 5fe854708bda0c7f760a5c4478bde2be7db6b6a1 |
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.
5 [
6 {
7 "namespace": "inputMethodPrivate",
8 "description": "none",
9 "functions": [
10 {
11 "name": "getInputMethodConfig",
12 "type": "function",
13 "description": "Gets configurations for input methods.",
14 "parameters": [
15 {
16 "name": "callback",
17 "type": "function",
18 "optional": false,
19 "description": "Callback which is called with the config object.",
20 "parameters": [
21 {
22 "name": "config",
23 "type": "object",
24 "description": "The input method config object.",
25 "properties": {
26 "isPhysicalKeyboardAutocorrectEnabled": {"type": "boolean"}
27 }
28 }
29 ]
30 }
31 ]
32 }, {
33 "name": "getInputMethods",
34 "type": "function",
35 "description": "Gets all whitelisted input methods.",
36 "parameters": [
37 {
38 "name": "callback",
39 "type": "function",
40 "optional": false,
41 "description": "Callback which is called with the input method objects.",
42 "parameters": [
43 {
44 "name": "inputMethods",
45 "type": "array",
46 "description": "Whitelisted input method objects.",
47 "items": {
48 "type": "object",
49 "properties": {
50 "id": {"type": "string"},
51 "name": {"type": "string"},
52 "indicator": {"type": "string"}
53 }
54 }
55 }
56 ]
57 }
58 ]
59 }, {
60 "name": "getCurrentInputMethod",
61 "type": "function",
62 "description": "Gets the current input method.",
63 "parameters": [
64 {
65 "name": "callback",
66 "type": "function",
67 "optional": false,
68 "description": "Callback which is called with the current input method.",
69 "parameters": [
70 {
71 "name": "inputMethodId",
72 "type": "string",
73 "description": "Current input method."
74 }
75 ]
76 }
77 ]
78 }, {
79 "name": "setCurrentInputMethod",
80 "type": "function",
81 "description": "Sets the current input method.",
82 "parameters": [
83 {
84 "name": "inputMethodId",
85 "type": "string",
86 "optional": false,
87 "description": "The input method ID to be set as current input method."
88 },
89 {
90 "name": "callback",
91 "type": "function",
92 "optional": true,
93 "description": "Callback which is called once the current input method is set. If unsuccessful $(ref:runtime.lastError) is set.",
94 "parameters": []
95 }
96 ]
97 }, {
98 "name": "fetchAllDictionaryWords",
99 "type": "function",
100 "description": "Fetches a list of all the words currently in the dictionary.",
101 "parameters": [
102 {
103 "name": "callback",
104 "type": "function",
105 "optional": false,
106 "description": "Callback which is called once the list of dictionary words are ready.",
107 "parameters": [
108 {
109 "name": "words",
110 "type": "array",
111 "description": "List of dictionary words.",
112 "items": {
113 "type": "string"
114 }
115 }
116 ]
117 }
118 ]
119 }, {
120 "name": "addWordToDictionary",
121 "type": "function",
122 "description": "Adds a single word to be stored in the dictionary.",
123 "parameters": [
124 {
125 "name": "word",
126 "type": "string",
127 "optional": false,
128 "description": "A new word to add to the dictionary."
129 },
130 {
131 "name": "callback",
132 "type": "function",
133 "optional": true,
134 "description": "Callback which is called once the word is added. If unsuccessful $(ref:runtime.lastError) is set.",
135 "parameters": []
136 }
137 ]
138 }, {
139 "name": "getEncryptSyncEnabled",
140 "type": "function",
141 "description": "Gets whether the encrypt sync is enabled.",
142 "parameters": [
143 {
144 "name": "callback",
145 "type": "function",
146 "optional": true,
147 "description": "Callback which is called to provide the result.",
148 "parameters": [
149 {
150 "name": "enabled",
151 "type": "boolean",
152 "optional": false,
153 "description": "The result of whether enabled."
154 }
155 ]
156 }
157 ]
158 }
159 ],
160 "events": [
161 {
162 "name": "onChanged",
163 "type": "function",
164 "description": "Fired when the input method is changed.",
165 "parameters": [
166 {
167 "name": "newInputMethodId",
168 "type": "string",
169 "description": "New input method which is being used."
170 }
171 ]
172 }, {
173 "name": "onCompositionBoundsChanged",
174 "type": "function",
175 "description": "Fired when the composition bounds or cursor bounds are changed.",
176 "parameters": [
177 {
178 "name": "firstBounds",
179 "type": "object",
180 "description": "The bounds information for the first character in composition.",
181 "properties": {
182 "x": {"type": "integer"},
183 "y": {"type": "integer"},
184 "w": {"type": "integer"},
185 "h": {"type": "integer"}
186 }
187 }, {
188 "name": "boundsList",
189 "type": "array",
190 "description": "List of bounds information.",
191 "items": {
192 "type": "object",
193 "properties": {
194 "x": {"type": "integer"},
195 "y": {"type": "integer"},
196 "w": {"type": "integer"},
197 "h": {"type": "integer"}
198 }
199 }
200 }
201 ]
202 }, {
203 "name": "onDictionaryLoaded",
204 "type": "function",
205 "description": "Fired when the custom spelling dictionary is loaded.",
206 "parameters": []
207 }, {
208 "name": "onDictionaryChanged",
209 "type": "function",
210 "description": "Fired when words are added or removed from the custom spelling dictionary.",
211 "parameters": [
212 {
213 "name": "added",
214 "type": "array",
215 "description": "List of added words.",
216 "items": {
217 "type": "string"
218 }
219 }, {
220 "name": "removed",
221 "type": "array",
222 "description": "List of removed words.",
223 "items": {
224 "type": "string"
225 }
226 }
227 ]
228 }
229 ]
230 }
231 ]