• Home
  • Line#
  • Scopes#
  • Navigate#
  • Raw
  • Download
1# Input Method Framework Error Codes
2<!--Kit: IME Kit-->
3<!--Subsystem: MiscServices-->
4<!--Owner: @illybyy-->
5<!--Designer: @andeszhang-->
6<!--Tester: @murphy1984-->
7<!--Adviser: @zhang_yixin13-->
8
9> **NOTE**
10>
11> This topic describes only module-specific error codes. For details about universal error codes, see [Universal Error Codes](../errorcode-universal.md).
12
13## 12800001 Package Manager Error
14
15**Error Message**
16
17Bundle manager error.
18
19**Description**
20
21This error code is reported when an API of the package manager, such as **getInputMethods** and **listCurrentInputMethodSubtype**, fails to be called to obtain information.
22
23**Possible Causes**
24
25The package manager is not working correctly when APIs such as **getInputMethods** and **listCurrentInputMethodSubtype** are called to obtain the input method subtype.
26
27**Solution**
28
29None
30
31## 12800002 Input Method Engine Error
32
33**Error Message**
34
35Input method engine error. Possible causes:
361. input method panel not created.
372. the input method application does not subscribe to related events.
38
39**Description**
40
41The input method process is suspended in operations such as displaying and hiding the keyboard.
42
43**Possible Causes**
44
451. The input method panel is not created.
462. The input method application does not subscribe to related events.
47
48**Solution**
49
50Check whether the input method process is running properly. For example, click the text input box in an application to check whether the input keyboard is displayed.
51
52## 12800003 Input Method Client Error
53
54**Error Message**
55
56Input method client error. Possible causes:
571. the edit box is not focused.
582. no edit box is bound to current input method application.
59
60**Description**
61
62This error code is reported when the API for showing or hiding the keyboard fails to be called by an application.
63
64**Possible Causes**
65
661. The application is not focused.
672. The input method is disconnected from the application due to a service error with the application.
68
69**Solution**
70
711. Bind the input method to the application again: Close the background process of the application, start the application again, and touch a text input box. If the keyboard is displayed properly, the issue is resolved.
722. Place the application in the foreground and ensure that it is not covered by other applications or windows. Then touch the text input box to display the input method.
73
74## 12800004 Not an Input Method
75
76**Error Message**
77
78Not an input method application.
79
80**Description**
81
82This error code is reported when an API exclusive to input methods is called by an application of another type.
83
84**Possible Causes**
85
86An API that can be called only by an input method is called by an application of another type.
87
88**Solution**
89
90Call the API only in an input method.
91
92## 12800005 Configuration Persistence Error
93
94**Error Message**
95
96Configuration persistence error.
97
98**Description**
99
100This error code is reported when the configuration fails to be saved during input method switching.
101
102**Possible Causes**
103
104An exception occurs with the system parameter configuration module.
105
106**Solution**
107
108Run `hdc shell param get persist.sys.default_ime` to view the default input method parameters. If the parameters are displayed, the system parameter configuration module is working properly. In this case, restart the device and try again.
109
110## 12800006 Input Method Controller Error
111
112**Error Message**
113
114Input method controller error. Possible cause: create InputMethodController object failed.
115
116**Description**
117
118This error code is reported when the input method controller fails to be obtained.
119
120**Possible Causes**
121
122An error occurs during invoking of the **getController** API.
123
124**Solution**
125
126None
127
128## 12800007 Input Method Setter Error
129
130**Error Message**
131
132Input method setter error. Possible cause: create InputMethodSetting object failed.
133
134**Description**
135
136This error code is reported when an **InputMethodSetting** instance fails to be obtained.
137
138**Possible Causes**
139
140An error occurs during invoking of the **getSetting** API.
141
142**Solution**
143
144None
145
146## 12800008 Input Method Manager Service Error
147
148**Error Message**
149
150Input method manager service error. Possible cause: a system error, such as null pointer, IPC exception.
151
152**Description**
153
154This error code is reported when an API of the [input method framework](js-apis-inputmethod.md) fails to be called.
155
156**Possible Causes**
157
158The input method manager service fails to be found.
159
160**Solution**
161
162Run `ps -A | grep inputmethod` to check the process ID of the input method service. If the process ID is found, the service is working properly.
163
164## 12800009 Input Method Client Detached
165
166**Error Message**
167
168Input method client detached.
169
170**Description**
171
172This error code is reported when the current application is not attached to an input method.
173
174**Possible Causes**
175
176The current application calls **showTextInput** or **hideTextInput** when not attached to an input method.
177
178**Solution**
179
180Call the `attach` API and then try again.
181
182## 12800010 Not Preconfigured Default Input Method
183
184**Error Message**
185
186Not the preconfigured default input method.
187
188**Description**
189
190This error code is reported when the invoking application is not the preconfigured default input method.
191
192**Possible Causes**
193
194The API is called by an application other than the preconfigured default input method.
195
196**Solution**
197
198Use [getDefaultInputMethod](js-apis-inputmethod.md#inputmethodgetdefaultinputmethod11) to query the default input method of the system and determine whether the application uses the default input method. If the application does not use the default input method, this API cannot be called.
199
200## 12800011 Text Preview Not Supported
201
202**Error Message**
203
204Text preview not supported.
205
206**Description**
207
208Preview of the text input box is not supported.
209
210**Possible Causes**
211
212Preview of the text input box is not supported.
213
214**Solution**
215
216Use [getEditorAttributeSync](js-apis-inputmethodengine.md#geteditorattributesync10) to obtain the value of **isTextPreviewSupported** of [EditorAttribute](js-apis-inputmethodengine.md#editorattribute). If **isTextPreviewSupported** is **false**, this API cannot be called.
217
218## 12800012 Soft Keyboard Panel Not Created
219
220**Error Message**
221
222The input method panel does not exist.
223
224**Description**
225
226The input method panel of the soft keyboard type is not created.
227
228**Possible Causes**
229
230The input method panel of the soft keyboard type is not created.
231
232**Solution**
233
234Use [createPanel](js-apis-inputmethodengine.md#createpanel10) to create a [panel](js-apis-inputmethodengine.md#panel10) of the [soft keyboard type](js-apis-inputmethodengine.md#paneltype10).
235
236## 12800013 Window Manager Service Error
237
238**Error Message**
239
240Window manager service error.
241
242**Description**
243
244The window manager service is not running properly.
245
246**Possible Causes**
247
248After the API is called, the system uses the capabilities of the window manager module. This error is thrown due to an error of the window manager service.
249
250**Solution**
251
252Restart the device and try again.
253
254## 12800014 Non-Full Access Mode of the Input Method Application
255
256**Error Message**
257
258The input method is in basic mode.
259
260**Description**
261
262The input method application is in non-full access mode.
263
264**Possible Causes**
265
266This error is thrown if the input method is in non-full access mode after you call an API that requires the full access mode to be enabled.
267
268**Solution**
269
270Enable the full access mode of the input method in **Settings**.
271
272## 12800015 Message Receiver Unable to Receive Custom Communication Data
273
274**Error Message**
275
276The other side does not accept the request.
277
278**Description**
279
280The message receiver cannot receive custom communication data.
281
282**Possible Causes**
283
284This error is thrown if the message receiver does not register [MessageHandler](js-apis-inputmethodengine.md#messagehandler15) to receive data when you call the API for sending custom communication data.
285
286**Solution**
287
288To receive custom communication data, register a **MessageHandler** for the message receiver, call [recvMessage](js-apis-inputmethodengine.md#recvmessage15) in the input method application, and call [recvMessage](js-apis-inputmethod.md#recvmessage15) for the input method client.
289
290## 12800016 Input Method Client Not in Edit Mode
291
292**Error Message**
293
294Input method client is not editable.
295
296**Description**
297
298The input method client is not in edit mode.
299
300**Possible Causes**
301
302The input method client exits the edit mode after being attached. For example, [hideTextInput](js-apis-inputmethod.md#hidetextinput10) is called after the self-drawing component is attached to the input method through `Attach`.
303
304**Solution**
305
306Enter the edit mode again after the input method client is attached and exits the edit mode. For example, the self-drawing component should enter the edit mode again by calling [showTextInput](js-apis-inputmethod.md#showtextinput10).
307
308## 12800017 Invalid Panel Type or Panel Flag
309
310**Error Message**
311
312Invalid panel type or panel flag.
313
314**Description**
315
316Invalid panel type or panel flag.
317
318**Possible Causes**
319
320This error is thrown if the [panel type](js-apis-inputmethodengine.md#paneltype10) or [panel flag](js-apis-inputmethodengine.md#panelflag10) of the input method does not support API call, or you cannot pass the type or flag to the API.
321
322**Solution**
323
324Read the API usage description and adjust the input method panel type or panel status as required.
325
326## 12800018 Input Method Not Found
327
328**Error Message**
329
330The input method is not found.
331
332**Description**
333
334The input method is not found.
335
336**Possible Causes**
337
338The input method is not installed.
339
340**Solution**
341
342Call the [getAllInputMethods](js-apis-inputmethod.md#getallinputmethods11) to query all installed input methods.
343
344<!--Del-->
345## 12800019 Unsupported Operation by Default Input Method
346
347**Error Message**
348
349Current operation cannot be applied to the preconfigured default input method.
350
351**Description**
352
353The default input method configured in the system does not support this operation.
354
355**Possible Causes**
356
357[enableInputMethod](js-apis-inputmethod-sys.md#enableinputmethod20) or [EnabledState](js-apis-inputmethod.md#enabledstate15) is called to enable or disable the default input method.
358
359**Solution**
360
361Call the [getDefaultInputMethod](js-apis-inputmethod.md#inputmethodgetdefaultinputmethod11) API to query the default input method configured in the system, and check whether the input method in use is the default input method. If yes, no processing is performed.
362
363<!--DelEnd-->
364
365## 12800020 Invalid Immersive Effect
366
367**Error Message**
368
369Invalid immersive effect.
3701. The gradient mode and the fluid light mode can only be used when the immersive mode is enabled.
3712. The fluid light mode can only be used when the gradient mode is enabled.
3723. When the gradient mode is not enabled, the gradient height can only be 0.
373
374**Description**
375
3761. Gradient mode and fluid light mode can be used only when the immersive mode is enabled.
3772. The fluid light mode can be used only when the gradient mode is enabled.
3783. If the gradient mode is disabled, the gradient height can only be 0 px.
379
380**Possible Causes**
381
382The input parameters do not meet the preceding requirements when the [setImmersiveEffect](js-apis-inputmethodengine.md#setimmersiveeffect20) API is called to set the [ImmersiveEffect](js-apis-inputmethodengine.md#immersiveeffect20).
383
384**Solution**
3851. Enable the immersive mode, and then set the gradient mode and fluid light mode.
3862. Enable the gradient mode and then set the fluid light mode.
3873. If the gradient mode is disabled, set the gradient height to 0 px.
388
389
390## 12800021 Unsupported Operation by Default Input Method
391
392**Error Message**
393
394this operation is allowed only after adjustPanelRect or resize is called.
395
396**Description**
397
398The current API can be called only after any of the following APIs is called:
399  - [adjustPanelRect](js-apis-inputmethodengine.md#adjustpanelrect12) (available since API version 12)
400  - [adjustPanelRect](js-apis-inputmethodengine.md#adjustpanelrect15) (available since API version 15)
401  - [resize](js-apis-inputmethodengine.md#resize10) (available since API version 10)
402
403**Possible Causes**
404
405The [setImmersiveEffect](js-apis-inputmethodengine.md#setimmersiveeffect20) API can be called only after any of the following APIs is called:
406  - [adjustPanelRect](js-apis-inputmethodengine.md#adjustpanelrect12) (available since API version 12)
407  - [adjustPanelRect](js-apis-inputmethodengine.md#adjustpanelrect15) (available since API version 15)
408  - [resize](js-apis-inputmethodengine.md#resize10) (available since API version 10)
409
410**Solution**
411
412The **setImmersiveEffect** API can be called only after any of the following APIs is called:
413  - [adjustPanelRect](js-apis-inputmethodengine.md#adjustpanelrect12) (available since API version 12)
414  - [adjustPanelRect](js-apis-inputmethodengine.md#adjustpanelrect15) (available since API version 15)
415  - [resize](js-apis-inputmethodengine.md#resize10) (available since API version 10)
416