The inputMethod module is oriented to common foreground applications (third-party applications and system applications such as Notes, Messaging, and Settings). It provides input method control and management capabilities, including displaying or hiding the soft keyboard, switching between input methods, and obtaining the list of all input methods.
NOTE
The initial APIs of this module are supported since API version 6. Newly added APIs will be marked with a superscript to indicate their earliest API version.
import { inputMethod } from '@kit.IMEKit';
Provides the constants.
System capability: SystemCapability.MiscServices.InputMethodFramework
Name | Type | Value | Description |
---|---|---|---|
MAX_TYPE_NUM8+ | number | 128 | Maximum number of supported input methods. |
Describes the input method application attributes.
System capability: SystemCapability.MiscServices.InputMethodFramework
Name | Type | Read-only | Optional | Description |
---|---|---|---|---|
name9+ | string | Yes | No | Mandatory. Name of the input method package. |
id9+ | string | Yes | No | Mandatory. Unique identifier of an input method extension in an app. id and name form a globally unique identifier of the input method extension. |
label9+ | string | Yes | Yes | Optional. - When InputMethodProperty is used as the input parameter of an API for switching or querying, you do not need to set this field. You can use name and ID to uniquely specify an input method extension. - When InputMethodProperty is used as the return value of an API for querying (for example, getCurrentInputMethod), this field indicates the name of the input method extension displayed externally. Use the label configured for the InputmethodExtensionAbility. If no label is configured, the label of the application entry ability is automatically used. If no label is configured for the application entry ability, the label configured in AppScope is automatically used. |
labelId10+ | number | Yes | Yes | Optional. - When InputMethodProperty is used as the input parameter of an API for switching or querying, you do not need to set this field. You can use name and ID to uniquely specify an input method extension. - When InputMethodProperty is used as the return value of an API for querying (for example, getCurrentInputMethod), this field indicates the resource ID of the label field. |
icon9+ | string | Yes | Yes | Optional. - When InputMethodProperty is used as the input parameter of an API for switching or querying, you do not need to set this field. You can use name and ID to uniquely specify an input method extension. - When InputMethodProperty is used as the return value of an API for querying (for example, getCurrentInputMethod), this field indicates the input method icon data, which can be obtained through icon ID. |
iconId9+ | number | Yes | Yes | Optional. - When InputMethodProperty is used as the input parameter of an API for switching or querying, you do not need to set this field. You can use name and ID to uniquely specify an input method extension. - When InputMethodProperty is used as the return value of an API for querying (for example, getCurrentInputMethod), this field indicates the resource ID of the icon field. |
extra9+ | object | No | Yes | Extra information about the input method. This parameter is reserved and currently has no specific meaning. - API version 10 and later: optional - API version 9: mandatory |
packageName(deprecated) | string | Yes | No | Name of the input method package. Mandatory. NOTE This API is supported since API version 8 and deprecated since API version 9. You are advised to use name instead. |
methodId(deprecated) | string | Yes | No | Unique ID of the input method. Mandatory. NOTE This API is supported since API version 8 and deprecated since API version 9. You are advised to use id instead. |
getController(): InputMethodController
Obtains an InputMethodController instance.
System capability: SystemCapability.MiscServices.InputMethodFramework
Return value
Type | Description |
---|---|
InputMethodController | InputMethodController instance. |
Error codes
For details about the error codes, see Input Method Framework Error Codes.
ID | Error Message |
---|---|
12800006 | input method controller error. |
Example
let inputMethodController = inputMethod.getController();
getDefaultInputMethod(): InputMethodProperty
Obtains the default input method.
System capability: SystemCapability.MiscServices.InputMethodFramework
Return value
Type | Description |
---|---|
InputMethodProperty | Default input method. |
Error codes
For details about the error codes, see Input Method Framework Error Codes.
ID | Error Message |
---|---|
12800008 | input method manager service error. |
Example
try {
let defaultIme = inputMethod.getDefaultInputMethod();
} catch(err) {
console.error(`Failed to getDefaultInputMethod: ${JSON.stringify(err)}`);
}
getSystemInputMethodConfigAbility(): ElementName
Obtains the information about the input method configuration page ability.
System capability: SystemCapability.MiscServices.InputMethodFramework
Return value
Type | Description |
---|---|
ElementName | Element name of the input method configuration page ability. |
Error codes
For details about the error codes, see Input Method Framework Error Codes.
ID | Error Message |
---|---|
12800008 | input method manager service error. |
Example
try {
let inputMethodConfig = inputMethod.getSystemInputMethodConfigAbility();
} catch(err) {
console.error(`Failed to get getSystemInputMethodConfigAbility: ${JSON.stringify(err)}`);
}
getSetting(): InputMethodSetting
Obtains an InputMethodSetting instance.
System capability: SystemCapability.MiscServices.InputMethodFramework
Return value
Type | Description |
---|---|
InputMethodSetting | InputMethodSetting instance. |
Error codes
For details about the error codes, see Input Method Framework Error Codes.
ID | Error Message |
---|---|
12800007 | setter error. |
Example
let inputMethodSetting = inputMethod.getSetting();
switchInputMethod(target: InputMethodProperty, callback: AsyncCallback<boolean>): void
Switches to another input method. This API uses an asynchronous callback to return the result.
NOTE
- In API versions 9 and 10, this API can only be called by system applications granted the ohos.permission.CONNECT_IME_ABILITY permission.
- Since API version 11, this API can only be called by the current input method application.
System capability: SystemCapability.MiscServices.InputMethodFramework
Parameters
Name | Type | Mandatory | Description |
---|---|---|---|
target | InputMethodProperty | Yes | Target input method. |
callback | AsyncCallback<boolean> | Yes | Callback used to return the result. If the operation is successful, err is undefined and data is true. Otherwise, err is an error object. |
Error codes
For details about the error codes, see Input Method Framework Error Codes and Universal Error Codes.
ID | Error Message |
---|---|
401 | parameter error. Possible causes: 1. Mandatory parameters are left unspecified; 2. Incorrect parameter types; 3. Parameter verification failed. |
12800005 | configuration persistence error. |
12800008 | input method manager service error. |
Example
import { BusinessError } from '@kit.BasicServicesKit';
let currentIme = inputMethod.getCurrentInputMethod();
try{
inputMethod.switchInputMethod(currentIme, (err: BusinessError, result: boolean) => {
if (err) {
console.error(`Failed to switchInputMethod: ${JSON.stringify(err)}`);
return;
}
if (result) {
console.info('Succeeded in switching inputmethod.');
} else {
console.error('Failed to switchInputMethod.');
}
});
} catch(err) {
console.error(`Failed to switchInputMethod: ${JSON.stringify(err)}`);
}
NOTE
Since API version 11, the error code
201 permissions check fails
is removed.
switchInputMethod(target: InputMethodProperty): Promise<boolean>
Switches to another input method. This API uses a promise to return the result.
NOTE
- In API versions 9 and 10, this API can only be called by system applications granted the ohos.permission.CONNECT_IME_ABILITY permission.
- Since API version 11, this API can only be called by the current input method application.
System capability: SystemCapability.MiscServices.InputMethodFramework
Parameters
Name | Type | Mandatory | Description |
---|---|---|---|
target | InputMethodProperty | Yes | Target input method. |
Return value
Type | Description |
---|---|
Promise<boolean> | Promise used to return the result. The value true means that the switching is successful, and false means the opposite. |
Error codes
For details about the error codes, see Input Method Framework Error Codes and Universal Error Codes.
ID | Error Message |
---|---|
401 | parameter error. Possible causes: 1. Mandatory parameters are left unspecified; 2. Incorrect parameter types; 3. Parameter verification failed. |
12800005 | configuration persistence error. |
12800008 | input method manager service error. |
Example
import { BusinessError } from '@kit.BasicServicesKit';
let currentIme = inputMethod.getCurrentInputMethod();
try {
inputMethod.switchInputMethod(currentIme).then((result: boolean) => {
if (result) {
console.info('Succeeded in switching inputmethod.');
} else {
console.error('Failed to switchInputMethod.');
}
}).catch((err: BusinessError) => {
console.error(`Failed to switchInputMethod: ${JSON.stringify(err)}`);
})
} catch (err) {
console.error(`Failed to switchInputMethod: ${JSON.stringify(err)}`);
}
NOTE
Since API version 11, the error code
201 permissions check fails
is removed.
getCurrentInputMethod(): InputMethodProperty
Obtains the current input method. This API returns the result synchronously.
System capability: SystemCapability.MiscServices.InputMethodFramework
Return value
Type | Description |
---|---|
InputMethodProperty | InputmethodProperty instance of the current input method. |
Example
let currentIme = inputMethod.getCurrentInputMethod();
switchCurrentInputMethodSubtype(target: InputMethodSubtype, callback: AsyncCallback<boolean>): void
Switches to another subtype of this input method. This API uses an asynchronous callback to return the result.
NOTE
- In API version 9, this API can only be called by system applications granted the ohos.permission.CONNECT_IME_ABILITY permission.
- In API version 10, this API can only be called by system applications and the current input method application, and the ohos.permission.CONNECT_IME_ABILITY permission is required.
- Since API version 11, this API can only be called by the current input method application.
System capability: SystemCapability.MiscServices.InputMethodFramework
Parameters
Name | Type | Mandatory | Description |
---|---|---|---|
target | InputMethodSubtype | Yes | Target input method subtype. |
callback | AsyncCallback<boolean> | Yes | Callback used to return the result. If the operation is successful, err is undefined and data is true. Otherwise, err is an error object. |
Error codes
For details about the error codes, see Input Method Framework Error Codes and Universal Error Codes.
ID | Error Message |
---|---|
401 | parameter error. Possible causes: 1. Mandatory parameters are left unspecified; 2. Incorrect parameter types; 3. Parameter verification failed. |
12800005 | configuration persistence error. |
12800008 | input method manager service error. |
Example
import { BusinessError } from '@kit.BasicServicesKit';
try {
let extra: Record<string, string> = {}
inputMethod.switchCurrentInputMethodSubtype({
id: "ServiceExtAbility",
label: "",
name: "com.example.kikakeyboard",
mode: "upper",
locale: "",
language: "",
icon: "",
iconId: 0,
extra: extra
}, (err: BusinessError, result: boolean) => {
if (err) {
console.error(`Failed to switchCurrentInputMethodSubtype: ${JSON.stringify(err)}`);
return;
}
if (result) {
console.info('Succeeded in switching currentInputMethodSubtype.');
} else {
console.error('Failed to switchCurrentInputMethodSubtype');
}
});
} catch(err) {
console.error(`Failed to switchCurrentInputMethodSubtype: ${JSON.stringify(err)}`);
}
NOTE
Since API version 11, the error code
201 permissions check fails
is removed.
switchCurrentInputMethodSubtype(target: InputMethodSubtype): Promise<boolean>
Switches to another subtype of this input method. This API uses a promise to return the result.
NOTE
- In API version 9, this API can only be called by system applications granted the ohos.permission.CONNECT_IME_ABILITY permission.
- In API version 10, this API can only be called by system applications and the current input method application, and the ohos.permission.CONNECT_IME_ABILITY permission is required.
- Since API version 11, this API can only be called by the current input method application.
System capability: SystemCapability.MiscServices.InputMethodFramework
Parameters
Name | Type | Mandatory | Description |
---|---|---|---|
target | InputMethodSubtype | Yes | Target input method subtype. |
Return value
Type | Description |
---|---|
Promise<boolean> | Promise used to return the result. The value true means that the switching is successful, and false means the opposite. |
Error codes
For details about the error codes, see Input Method Framework Error Codes and Universal Error Codes.
ID | Error Message |
---|---|
401 | parameter error. Possible causes: 1. Mandatory parameters are left unspecified; 2. Incorrect parameter types; 3. Parameter verification failed. |
12800005 | configuration persistence error. |
12800008 | input method manager service error. |
Example
import { BusinessError } from '@kit.BasicServicesKit';
try {
let extra: Record<string, string> = {}
inputMethod.switchCurrentInputMethodSubtype({
id: "ServiceExtAbility",
label: "",
name: "com.example.kikakeyboard",
mode: "upper",
locale: "",
language: "",
icon: "",
iconId: 0,
extra: extra
}).then((result: boolean) => {
if (result) {
console.info('Succeeded in switching currentInputMethodSubtype.');
} else {
console.error('Failed to switchCurrentInputMethodSubtype.');
}
}).catch((err: BusinessError) => {
console.error(`Failed to switchCurrentInputMethodSubtype: ${JSON.stringify(err)}`);
})
} catch(err) {
console.error(`Failed to switchCurrentInputMethodSubtype: ${JSON.stringify(err)}`);
}
NOTE
Since API version 11, the error code
201 permissions check fails
is removed.
getCurrentInputMethodSubtype(): InputMethodSubtype
Obtains the current input method subtype.
System capability: SystemCapability.MiscServices.InputMethodFramework
Return value
Type | Description |
---|---|
InputMethodSubtype | Current input method subtype. |
Example
let currentImeSubType = inputMethod.getCurrentInputMethodSubtype();
switchCurrentInputMethodAndSubtype(inputMethodProperty: InputMethodProperty, inputMethodSubtype: InputMethodSubtype, callback: AsyncCallback<boolean>): void
Switches to a specified subtype of a specified input method. This API uses an asynchronous callback to return the result.
NOTE
- In API versions 9 and 10, this API can only be called by system applications granted the ohos.permission.CONNECT_IME_ABILITY permission.
- Since API version 11, this API can only be called by the current input method application.
System capability: SystemCapability.MiscServices.InputMethodFramework
Parameters
Name | Type | Mandatory | Description |
---|---|---|---|
inputMethodProperty | InputMethodProperty | Yes | Target input method. |
inputMethodSubtype | InputMethodSubtype | Yes | Target input method subtype. |
callback | AsyncCallback<boolean> | Yes | Callback used to return the result. If the operation is successful, err is undefined and data is true. Otherwise, err is an error object. |
Error codes
For details about the error codes, see Input Method Framework Error Codes and Universal Error Codes.
ID | Error Message |
---|---|
401 | parameter error. Possible causes: 1. Mandatory parameters are left unspecified; 2. Incorrect parameter types; 3. Parameter verification failed. |
12800005 | configuration persistence error. |
12800008 | input method manager service error. |
Example
import { BusinessError } from '@kit.BasicServicesKit';
let currentIme = inputMethod.getCurrentInputMethod();
let imSubType = inputMethod.getCurrentInputMethodSubtype();
try {
inputMethod.switchCurrentInputMethodAndSubtype(currentIme, imSubType, (err: BusinessError, result: boolean) => {
if (err) {
console.error(`Failed to switchCurrentInputMethodAndSubtype: ${JSON.stringify(err)}`);
return;
}
if (result) {
console.info('Succeeded in switching currentInputMethodAndSubtype.');
} else {
console.error('Failed to switchCurrentInputMethodAndSubtype.');
}
});
} catch (err) {
console.error(`Failed to switchCurrentInputMethodAndSubtype: ${JSON.stringify(err)}`);
}
NOTE
Since API version 11, the error code
201 permissions check fails
is removed.
switchCurrentInputMethodAndSubtype(inputMethodProperty: InputMethodProperty, inputMethodSubtype: InputMethodSubtype): Promise<boolean>
Switches to a specified subtype of a specified input method. This API uses a promise to return the result.
NOTE
- In API versions 9 and 10, this API can only be called by system applications granted the ohos.permission.CONNECT_IME_ABILITY permission.
- Since API version 11, this API can only be called by the current input method application.
System capability: SystemCapability.MiscServices.InputMethodFramework
Parameters
Name | Type | Mandatory | Description |
---|---|---|---|
inputMethodProperty | InputMethodProperty | Yes | Target input method. |
inputMethodSubtype | InputMethodSubtype | Yes | Target input method subtype. |
Return value
Type | Description |
---|---|
Promise<boolean> | Promise used to return the result. The value true means that the switching is successful, and false means the opposite. |
Error codes
For details about the error codes, see Input Method Framework Error Codes and Universal Error Codes.
ID | Error Message |
---|---|
401 | parameter error. Possible causes: 1. Mandatory parameters are left unspecified; 2. Incorrect parameter types; 3. Parameter verification failed. |
12800005 | configuration persistence error. |
12800008 | input method manager service error. |
Example
import { BusinessError } from '@kit.BasicServicesKit';
let currentIme = inputMethod.getCurrentInputMethod();
let imSubType = inputMethod.getCurrentInputMethodSubtype();
try {
inputMethod.switchCurrentInputMethodAndSubtype(currentIme, imSubType).then((result: boolean) => {
if (result) {
console.info('Succeeded in switching currentInputMethodAndSubtype.');
} else {
console.error('Failed to switchCurrentInputMethodAndSubtype.');
}
}).catch((err: BusinessError) => {
console.error(`Failed to switchCurrentInputMethodAndSubtype: ${JSON.stringify(err)}`);
})
} catch(err) {
console.error(`Failed to switchCurrentInputMethodAndSubtype: ${JSON.stringify(err)}`);
}
NOTE
Since API version 11, the error code
201 permissions check fails
is removed.
getInputMethodController(): InputMethodController
Obtains an InputMethodController instance.
NOTE
This API is supported since API version 6 and deprecated since API version 9. You are advised to use getController() instead.
System capability: SystemCapability.MiscServices.InputMethodFramework
Return value
Type | Description |
---|---|
InputMethodController | Current InputMethodController instance. |
Example
let inputMethodController = inputMethod.getInputMethodController();
getInputMethodSetting(): InputMethodSetting
Obtains an InputMethodSetting instance.
NOTE
This API is supported since API version 6 and deprecated since API version 9. You are advised to use getSetting() instead.
System capability: SystemCapability.MiscServices.InputMethodFramework
Return value
Type | Description |
---|---|
InputMethodSetting | InputMethodSetting instance. |
Example
let inputMethodSetting = inputMethod.getInputMethodSetting();
Enumerates the text input types.
System capability: SystemCapability.MiscServices.InputMethodFramework
Name | Value | Description |
---|---|---|
NONE | -1 | None. |
TEXT | 0 | Text. |
MULTILINE | 1 | Multi-line. |
NUMBER | 2 | Number. |
PHONE | 3 | Phone number. |
DATETIME | 4 | Date. |
EMAIL_ADDRESS | 5 | Email address. |
URL | 6 | URL. |
VISIBLE_PASSWORD | 7 | Password. |
NUMBER_PASSWORD11+ | 8 | Numeric password. |
Enumerates the function types represented by the Enter key of the input method.
System capability: SystemCapability.MiscServices.InputMethodFramework
Name | Value | Description |
---|---|---|
UNSPECIFIED | 0 | Not specified. |
NONE | 1 | None. |
GO | 2 | Go. |
SEARCH | 3 | Search. |
SEND | 4 | Send. |
NEXT | 5 | Next. |
DONE | 6 | Done. |
PREVIOUS | 7 | Previous. |
NEWLINE12+ | 8 | Line break. |
Enumerates the soft keyboard states of the input method.
System capability: SystemCapability.MiscServices.InputMethodFramework
Name | Value | Description |
---|---|---|
NONE | 0 | None. |
HIDE | 1 | Hidden. |
SHOW | 2 | Shown. |
Enumerates the directions of cursor movement of the input method.
System capability: SystemCapability.MiscServices.InputMethodFramework
Name | Value | Description |
---|---|---|
CURSOR_UP | 1 | Upward. |
CURSOR_DOWN | 2 | Downward. |
CURSOR_LEFT | 3 | Leftward. |
CURSOR_RIGHT | 4 | Rightward. |
Describes the type of the extended edit action on the text box.
System capability: SystemCapability.MiscServices.InputMethodFramework
Name | Value | Description |
---|---|---|
SELECT_ALL | 0 | Select all. |
CUT | 3 | Cut. |
COPY | 4 | Copy. |
PASTE | 5 | Paste. |
Describes the type of the input method function key.
System capability: SystemCapability.MiscServices.InputMethodFramework
Name | Type | Read-only | Optional | Description |
---|---|---|---|---|
enterKeyType10+ | EnterKeyType | No | No | Function type represented by the Enter key of the input method. |
Describes the attributes of the edit box, including the text input type and Enter key function type.
System capability: SystemCapability.MiscServices.InputMethodFramework
Name | Type | Read-only | Optional | Description |
---|---|---|---|---|
textInputType10+ | TextInputType | No | No | Enumerates the text input types. |
enterKeyType10+ | EnterKeyType | No | No | Function type represented by the Enter key. |
Describes the configuration of the edit box.
System capability: SystemCapability.MiscServices.InputMethodFramework
Name | Type | Read-only | Optional | Description |
---|---|---|---|---|
inputAttribute10+ | InputAttribute | No | No | Edit box attribute. |
cursorInfo10+ | CursorInfo | No | Yes | Cursor information. |
selection10+ | Range | No | Yes | Text selection range. |
windowId10+ | number | No | Yes | ID of the window where the edit box is located. |
Represents the cursor information.
System capability: SystemCapability.MiscServices.InputMethodFramework
Name | Type | Read-only | Optional | Description |
---|---|---|---|---|
left | number | No | No | Left coordinate of the cursor. |
top | number | No | No | Top coordinate of the cursor. |
width | number | No | No | Width of the cursor. |
height | number | No | No | Height of the cursor. |
Describes the range of the selected text.
System capability: SystemCapability.MiscServices.InputMethodFramework
Name | Type | Read-only | Optional | Description |
---|---|---|---|---|
start | number | No | No | Index of the first selected character in the text box. |
end | number | No | No | Index of the last selected character in the text box. |
Describes the direction in which the cursor moves when the text is selected.
System capability: SystemCapability.MiscServices.InputMethodFramework
Name | Type | Read-only | Optional | Description |
---|---|---|---|---|
direction | Direction | No | No | Direction in which the cursor moves when the text is selected. |
Describes the window information of the input method keyboard.
System capability: SystemCapability.MiscServices.InputMethodFramework
Name | Type | Read-only | Optional | Description |
---|---|---|---|---|
name | string | No | No | Name of the input method keyboard window. |
left | number | No | No | Horizontal coordinate of the upper left corner of the input method keyboard window, in px. |
top | number | No | No | Vertical coordinate of the upper left corner of the input method keyboard window, in px. |
width | number | No | No | Width of the input method keyboard window, in px. |
height | number | No | No | Height of the input method keyboard window, in px. |
Indicates whether the input method is enabled.
System capability: SystemCapability.MiscServices.InputMethodFramework
Name | Value | Description |
---|---|---|
DISABLED | 0 | Disabled. |
BASIC_MODE | 1 | Basic mode. |
FULL_EXPERIENCE_MODE | 2 | Full experience mode. |
Describes the reason for keyboard request.
System capability: SystemCapability.MiscServices.InputMethodFramework
Name | Value | Description |
---|---|---|
NONE | 0 | The keyboard request is triggered for no reason. |
MOUSE | 1 | The keyboard request is triggered by a mouse operation. |
TOUCH | 2 | The keyboard request is triggered by a touch operation. |
OTHER | 20 | The keyboard request is triggered by other reasons. |
Represents a custom communication object.
NOTE
You can register this object to receive custom communication data sent by the input method application. When the custom communication data is received, the onMessage callback in this object is triggered.
This object is globally unique. After multiple registrations, only the last registered object is valid and retained, and the onTerminated callback of the penultimate registered object is triggered.
If this object is unregistered, its onTerminated callback will be triggered.
onMessage(msgId: string, msgParam?: ArrayBuffer): void
Receives custom data sent by the input method application.
NOTE
This callback is triggered when the registered MeesageHandler receives custom communication data sent by the input method application.
The msgId parameter is mandatory, and the msgParam parameter is optional. If only the custom msgId data is received, confirm it with the data sender.
System capability: SystemCapability.MiscServices.InputMethodFramework
Parameters
Name | Type | Mandatory | Description |
---|---|---|---|
msgId | string | Yes | Identifier of the received custom communication data. |
msgParam | ArrayBuffer | No | Message body of the received custom communication data. |
Example
import { BusinessError } from '@kit.BasicServicesKit';
let inputMethodController = inputMethod.getController();
try {
let messageHandler: inputMethod.MessageHandler = {
onTerminated(): void {
console.info('OnTerminated.');
},
onMessage(msgId: string, msgParam?:ArrayBuffer): void {
console.info('recv message.');
}
}
inputMethodController.recvMessage(messageHandler);
} catch(err) {
console.error(`Failed to recvMessage: ${JSON.stringify(err)}`);
}
onTerminated(): void
Listens for MessageHandler termination.
NOTE
When an application registers a new MessageHandler object, the OnTerminated callback of the previous registered MessageHandler object is triggered.
When an application unregisters a MessageHandler object, the OnTerminated callback of the current registered MessageHandler object is triggered.
System capability: SystemCapability.MiscServices.InputMethodFramework
Example
import { BusinessError } from '@kit.BasicServicesKit';
let inputMethodController = inputMethod.getController();
try {
let messageHandler: inputMethod.MessageHandler = {
onTerminated(): void {
console.info('OnTerminated.');
},
onMessage(msgId: string, msgParam?:ArrayBuffer): void {
console.info('recv message.');
}
}
inputMethodController.recvMessage(messageHandler);
} catch(err) {
console.error(`Failed to recvMessage: ${JSON.stringify(err)}`);
}
type SetPreviewTextCallback = (text: string, range: Range) => void
Callback triggered when the input method framework needs to display the text preview.
System capability: SystemCapability.MiscServices.InputMethodFramework
Name | Type | Mandatory | Description |
---|---|---|---|
text | string | Yes | Text preview. |
range | Range | Yes | Describes the range of the selected text. |
In the following API examples, you must first use getController to obtain an InputMethodController instance, and then call the APIs using the obtained instance.
attach(showKeyboard: boolean, textConfig: TextConfig, callback: AsyncCallback<void>): void
Attaches a self-drawing component to the input method. This API uses an asynchronous callback to return the result.
NOTE
An input method can use the following features only when it has a self-drawing component attached to it: showing or hiding the keyboard, updating the cursor information, changing the selection range of the edit box, saving the configuration information, and listening for and processing the information or commands sent by the input method.
System capability: SystemCapability.MiscServices.InputMethodFramework
Parameters
Name | Type | Mandatory | Description |
---|---|---|---|
showKeyboard | boolean | Yes | Whether to start the input method keyboard after the self-drawing component is attached to the input method. - true means to start the input method keyboard. - false means not to start the input method keyboard. |
textConfig | TextConfig | Yes | Configuration of the edit box. |
callback | AsyncCallback<void> | Yes | Callback used to return the result. If the operation is successful, err is undefined. Otherwise, err is an error object. |
Error codes
For details about the error codes, see Input Method Framework Error Codes and Universal Error Codes.
ID | Error Message |
---|---|
401 | parameter error. Possible causes: 1. Mandatory parameters are left unspecified; 2. Incorrect parameter types. |
12800003 | input method client error. |
12800008 | input method manager service error. |
Example
import { BusinessError } from '@kit.BasicServicesKit';
try {
let textConfig: inputMethod.TextConfig = {
inputAttribute: {
textInputType: 0,
enterKeyType: 1
}
};
inputMethodController.attach(true, textConfig, (err: BusinessError) => {
if (err) {
console.error(`Failed to attach: ${JSON.stringify(err)}`);
return;
}
console.info('Succeeded in attaching the inputMethod.');
});
} catch(err) {
console.error(`Failed to attach: ${JSON.stringify(err)}`);
}
attach(showKeyboard: boolean, textConfig: TextConfig): Promise<void>
Attaches a self-drawing component to the input method. This API uses a promise to return the result.
NOTE
An input method can use the following features only when it has a self-drawing component attached to it: showing or hiding the keyboard, updating the cursor information, changing the selection range of the edit box, saving the configuration information, and listening for and processing the information or commands sent by the input method.
System capability: SystemCapability.MiscServices.InputMethodFramework
Parameters
Name | Type | Mandatory | Description |
---|---|---|---|
showKeyboard | boolean | Yes | Whether to start the input method keyboard after the self-drawing component is attached to the input method. - true means to start the input method keyboard. - false means not to start the input method keyboard. |
textConfig | TextConfig | Yes | Configuration of the edit box. |
Return value
Type | Description |
---|---|
Promise<void> | Promise that returns no value. |
Error codes
For details about the error codes, see Input Method Framework Error Codes and Universal Error Codes.
ID | Error Message |
---|---|
401 | parameter error. Possible causes: 1. Mandatory parameters are left unspecified; 2. Incorrect parameter types. |
12800003 | input method client error. |
12800008 | input method manager service error. |
Example
import { BusinessError } from '@kit.BasicServicesKit';
try {
let textConfig: inputMethod.TextConfig = {
inputAttribute: {
textInputType: 0,
enterKeyType: 1
}
};
inputMethodController.attach(true, textConfig).then(() => {
console.info('Succeeded in attaching inputMethod.');
}).catch((err: BusinessError) => {
console.error(`Failed to attach: ${JSON.stringify(err)}`);
})
} catch(err) {
console.error(`Failed to attach: ${JSON.stringify(err)}`);
}
attach(showKeyboard: boolean, textConfig: TextConfig, requestKeyboardReason: RequestKeyboardReason): Promise<void>
Attaches a self-drawing component to the input method. This API uses a promise to return the result.
NOTE
An input method can use the following features only when it has a self-drawing component attached to it: showing or hiding the keyboard, updating the cursor information, changing the selection range of the edit box, saving the configuration information, and listening for and processing the information or commands sent by the input method.
System capability: SystemCapability.MiscServices.InputMethodFramework
Parameters
Name | Type | Mandatory | Description |
---|---|---|---|
showKeyboard | boolean | Yes | Whether to start the input method keyboard after the self-drawing component is attached to the input method. - true means to start the input method keyboard. - false means not to start the input method keyboard. |
textConfig | TextConfig | Yes | Configuration of the edit box. |
requestKeyboardReason | RequestKeyboardReason | Yes | Reason for keyboard request. |
Return value
Type | Description |
---|---|
Promise<void> | Promise that returns no value. |
Error codes
For details about the error codes, see Input Method Framework Error Codes and Universal Error Codes.
ID | Error Message |
---|---|
401 | parameter error. Possible causes: 1. Mandatory parameters are left unspecified; 2. Incorrect parameter types. |
12800003 | input method client error. |
12800008 | input method manager service error. |
Example
import { BusinessError } from '@kit.BasicServicesKit';
try {
let textConfig: inputMethod.TextConfig = {
inputAttribute: {
textInputType: 0,
enterKeyType: 1
}
};
let requestKeyboardReason: inputMethod.RequestKeyboardReason = inputMethod.RequestKeyboardReason.MOUSE;
inputMethodController.attach(true, textConfig, requestKeyboardReason).then(() => {
console.info('Succeeded in attaching inputMethod.');
}).catch((err: BusinessError) => {
console.error(`Failed to attach: ${JSON.stringify(err)}`);
})
} catch(err) {
console.error(`Failed to attach: ${JSON.stringify(err)}`);
}
showTextInput(callback: AsyncCallback<void>): void
Enters the text editing mode. This API uses an asynchronous callback to return the result.
NOTE
After the edit box is attached to an input method, this API can be called to start the soft keyboard and enter the text editing state.
System capability: SystemCapability.MiscServices.InputMethodFramework
Parameters
Name | Type | Mandatory | Description |
---|---|---|---|
callback | AsyncCallback<void> | Yes | Callback used to return the result. If the operation is successful, err is undefined. Otherwise, err is an error object. |
Error codes
For details about the error codes, see Input Method Framework Error Codes.
ID | Error Message |
---|---|
12800003 | input method client error. |
12800008 | input method manager service error. |
12800009 | input method client detached. |
Example
import { BusinessError } from '@kit.BasicServicesKit';
inputMethodController.showTextInput((err: BusinessError) => {
if (err) {
console.error(`Failed to showTextInput: ${JSON.stringify(err)}`);
return;
}
console.info('Succeeded in showing the inputMethod.');
});
showTextInput(): Promise<void>
Enters the text editing mode. This API uses a promise to return the result.
NOTE
After the edit box is attached to an input method, this API can be called to start the soft keyboard and enter the text editing state.
System capability: SystemCapability.MiscServices.InputMethodFramework
Return value
Type | Description |
---|---|
Promise<void> | Promise that returns no value. |
Error codes
For details about the error codes, see Input Method Framework Error Codes.
ID | Error Message |
---|---|
12800003 | input method client error. |
12800008 | input method manager service error. |
12800009 | input method client detached. |
Example
import { BusinessError } from '@kit.BasicServicesKit';
inputMethodController.showTextInput().then(() => {
console.info('Succeeded in showing text input.');
}).catch((err: BusinessError) => {
console.error(`Failed to showTextInput: ${JSON.stringify(err)}`);
});
showTextInput(requestKeyboardReason: RequestKeyboardReason): Promise<void>
Enters the text editing mode. This API uses a promise to return the result.
NOTE
After the edit box is attached to an input method, this API can be called to start the soft keyboard and enter the text editing state.
System capability: SystemCapability.MiscServices.InputMethodFramework
Parameters
Name | Type | Mandatory | Description |
---|---|---|---|
requestKeyboardReason | RequestKeyboardReason | Yes | Reason for keyboard request. |
Return value
Type | Description |
---|---|
Promise<void> | Promise that returns no value. |
Error codes
For details about the error codes, see Input Method Framework Error Codes.
ID | Error Message |
---|---|
12800003 | input method client error. |
12800008 | input method manager service error. |
12800009 | input method client detached. |
Example
import { BusinessError } from '@kit.BasicServicesKit';
let requestKeyboardReason = inputMethod.RequestKeyboardReason.MOUSE;
inputMethodController.showTextInput(requestKeyboardReason).then(() => {
console.info('Succeeded in showing text input.');
}).catch((err: BusinessError) => {
console.error(`Failed to showTextInput: ${JSON.stringify(err)}`);
});
hideTextInput(callback: AsyncCallback<void>): void
Exits the text editing mode. This API uses an asynchronous callback to return the result.
NOTE
If the soft keyboard is displayed when this API is called, it will be hidden.
Calling this API does not detach the edit box from the input method. The edit box can call showTextInput again to reenter the text editing mode.
System capability: SystemCapability.MiscServices.InputMethodFramework
Parameters
Name | Type | Mandatory | Description |
---|---|---|---|
callback | AsyncCallback<void> | Yes | Callback used to return the result. If the operation is successful, err is undefined. Otherwise, err is an error object. |
Error codes
For details about the error codes, see Input Method Framework Error Codes.
ID | Error Message |
---|---|
12800003 | input method client error. |
12800008 | input method manager service error. |
12800009 | input method client detached. |
Example
import { BusinessError } from '@kit.BasicServicesKit';
inputMethodController.hideTextInput((err: BusinessError) => {
if (err) {
console.error(`Failed to hideTextInput: ${JSON.stringify(err)}`);
return;
}
console.info('Succeeded in hiding text input.');
});
hideTextInput(): Promise<void>
Exits the text editing mode. This API uses a promise to return the result.
NOTE
If the soft keyboard is displayed when this API is called, it will be hidden.
Calling this API does not detach the edit box from the input method. The edit box can call showTextInput again to reenter the text editing mode.
System capability: SystemCapability.MiscServices.InputMethodFramework
Return value
Type | Description |
---|---|
Promise<void> | Promise that returns no value. |
Error codes
For details about the error codes, see Input Method Framework Error Codes.
ID | Error Message |
---|---|
12800003 | input method client error. |
12800008 | input method manager service error. |
12800009 | input method client detached. |
Example
import { BusinessError } from '@kit.BasicServicesKit';
inputMethodController.hideTextInput().then(() => {
console.info('Succeeded in hiding inputMethod.');
}).catch((err: BusinessError) => {
console.error(`Failed to hideTextInput: ${JSON.stringify(err)}`);
})
detach(callback: AsyncCallback<void>): void
Detaches the self-drawing component from the input method. This API uses an asynchronous callback to return the result.
System capability: SystemCapability.MiscServices.InputMethodFramework
Parameters
Name | Type | Mandatory | Description |
---|---|---|---|
callback | AsyncCallback<void> | Yes | Callback used to return the result. If the operation is successful, err is undefined. Otherwise, err is an error object. |
Error codes
For details about the error codes, see Input Method Framework Error Codes.
ID | Error Message |
---|---|
12800003 | input method client error. |
12800008 | input method manager service error. |
Example
import { BusinessError } from '@kit.BasicServicesKit';
inputMethodController.detach((err: BusinessError) => {
if (err) {
console.error(`Failed to detach: ${JSON.stringify(err)}`);
return;
}
console.info('Succeeded in detaching inputMethod.');
});
detach(): Promise<void>
Detaches the self-drawing component from the input method. This API uses a promise to return the result.
System capability: SystemCapability.MiscServices.InputMethodFramework
Return value
Type | Description |
---|---|
Promise<void> | Promise that returns no value. |
Error codes
For details about the error codes, see Input Method Framework Error Codes.
ID | Error Message |
---|---|
12800003 | input method client error. |
12800008 | input method manager service error. |
Example
import { BusinessError } from '@kit.BasicServicesKit';
inputMethodController.detach().then(() => {
console.info('Succeeded in detaching inputMethod.');
}).catch((err: BusinessError) => {
console.error(`Failed to detach: ${JSON.stringify(err)}`);
});
setCallingWindow(windowId: number, callback: AsyncCallback<void>): void
Sets the window to be avoided by the input method. This API uses an asynchronous callback to return the result.
NOTE
After the window ID of the application bound to the input method is passed in the API, the input method window will not cover the window holding the application.
System capability: SystemCapability.MiscServices.InputMethodFramework
Parameters
Name | Type | Mandatory | Description |
---|---|---|---|
windowId | number | Yes | Window ID of the application bound to the input method. |
callback | AsyncCallback<void> | Yes | Callback used to return the result. If the operation is successful, err is undefined. Otherwise, err is an error object. |
Error codes
For details about the error codes, see Input Method Framework Error Codes and Universal Error Codes.
ID | Error Message |
---|---|
401 | parameter error. Possible causes: 1. Mandatory parameters are left unspecified; 2. Incorrect parameter types. |
12800003 | input method client error. |
12800008 | input method manager service error. |
12800009 | input method client detached. |
Example
import { BusinessError } from '@kit.BasicServicesKit';
try {
let windowId: number = 2000;
inputMethodController.setCallingWindow(windowId, (err: BusinessError) => {
if (err) {
console.error(`Failed to setCallingWindow: ${JSON.stringify(err)}`);
return;
}
console.info('Succeeded in setting callingWindow.');
});
} catch(err) {
console.error(`Failed to setCallingWindow: ${JSON.stringify(err)}`);
}
setCallingWindow(windowId: number): Promise<void>
Sets the window to be avoided by the input method. This API uses a promise to return the result.
NOTE
After the window ID of the application bound to the input method is passed in the API, the input method window will not cover the window holding the application.
System capability: SystemCapability.MiscServices.InputMethodFramework
Parameters
Name | Type | Mandatory | Description |
---|---|---|---|
windowId | number | Yes | Window ID of the application bound to the input method. |
Return value
Type | Description |
---|---|
Promise<void> | Promise that returns no value. |
Error codes
For details about the error codes, see Input Method Framework Error Codes and Universal Error Codes.
ID | Error Message |
---|---|
401 | parameter error. Possible causes: 1. Mandatory parameters are left unspecified; 2. Incorrect parameter types. |
12800003 | input method client error. |
12800008 | input method manager service error. |
12800009 | input method client detached. |
Example
import { BusinessError } from '@kit.BasicServicesKit';
try {
let windowId: number = 2000;
inputMethodController.setCallingWindow(windowId).then(() => {
console.info('Succeeded in setting callingWindow.');
}).catch((err: BusinessError) => {
console.error(`Failed to setCallingWindow: ${JSON.stringify(err)}`);
})
} catch(err) {
console.error(`Failed to setCallingWindow: ${JSON.stringify(err)}`);
}
updateCursor(cursorInfo: CursorInfo, callback: AsyncCallback<void>): void
Updates the cursor information in this edit box. This API can be called to notify the input method of the cursor changes. This API uses an asynchronous callback to return the result.
System capability: SystemCapability.MiscServices.InputMethodFramework
Parameters
Name | Type | Mandatory | Description |
---|---|---|---|
cursorInfo | CursorInfo | Yes | Cursor information. |
callback | AsyncCallback<void> | Yes | Callback used to return the result. If the operation is successful, err is undefined. Otherwise, err is an error object. |
Error codes
For details about the error codes, see Input Method Framework Error Codes and Universal Error Codes.
ID | Error Message |
---|---|
401 | parameter error. Possible causes: 1. Mandatory parameters are left unspecified; 2. Incorrect parameter types; 3. Parameter verification failed. |
12800003 | input method client error. |
12800008 | input method manager service error. |
12800009 | input method client detached. |
Example
import { BusinessError } from '@kit.BasicServicesKit';
try {
let cursorInfo: inputMethod.CursorInfo = { left: 0, top: 0, width: 600, height: 800 };
inputMethodController.updateCursor(cursorInfo, (err: BusinessError) => {
if (err) {
console.error(`Failed to updateCursor: ${JSON.stringify(err)}`);
return;
}
console.info('Succeeded in updating cursorInfo.');
});
} catch(err) {
console.error(`Failed to updateCursor: ${JSON.stringify(err)}`);
}
updateCursor(cursorInfo: CursorInfo): Promise<void>
Updates the cursor information in this edit box. This API can be called to notify the input method of the cursor changes. This API uses a promise to return the result.
System capability: SystemCapability.MiscServices.InputMethodFramework
Parameters
Name | Type | Mandatory | Description |
---|---|---|---|
cursorInfo | CursorInfo | Yes | Cursor information. |
Return value
Type | Description |
---|---|
Promise<void> | Promise that returns no value. |
Error codes
For details about the error codes, see Input Method Framework Error Codes and Universal Error Codes.
ID | Error Message |
---|---|
401 | parameter error. Possible causes: 1. Mandatory parameters are left unspecified; 2. Incorrect parameter types; 3. Parameter verification failed. |
12800003 | input method client error. |
12800008 | input method manager service error. |
12800009 | input method client detached. |
Example
import { BusinessError } from '@kit.BasicServicesKit';
try {
let cursorInfo: inputMethod.CursorInfo = { left: 0, top: 0, width: 600, height: 800 };
inputMethodController.updateCursor(cursorInfo).then(() => {
console.info('Succeeded in updating cursorInfo.');
}).catch((err: BusinessError) => {
console.error(`Failed to updateCursor: ${JSON.stringify(err)}`);
})
} catch(err) {
console.error(`Failed to updateCursor: ${JSON.stringify(err)}`);
}
changeSelection(text: string, start: number, end: number, callback: AsyncCallback<void>): void
Updates the information about the selected text in this edit box, to notify the input method when the selected text content or text range changes. This API uses an asynchronous callback to return the result.
System capability: SystemCapability.MiscServices.InputMethodFramework
Parameters
Name | Type | Mandatory | Description |
---|---|---|---|
text | string | Yes | All input text. |
start | number | Yes | Start position of the selected text. |
end | number | Yes | End position of the selected text. |
callback | AsyncCallback<void> | Yes | Callback used to return the result. If the operation is successful, err is undefined. Otherwise, err is an error object. |
Error codes
For details about the error codes, see Input Method Framework Error Codes and Universal Error Codes.
ID | Error Message |
---|---|
401 | parameter error. Possible causes: 1. Mandatory parameters are left unspecified; 2. Incorrect parameter types. |
12800003 | input method client error. |
12800008 | input method manager service error. |
12800009 | input method client detached. |
Example
import { BusinessError } from '@kit.BasicServicesKit';
try {
inputMethodController.changeSelection('text', 0, 5, (err: BusinessError) => {
if (err) {
console.error(`Failed to changeSelection: ${JSON.stringify(err)}`);
return;
}
console.info('Succeeded in changing selection.');
});
} catch(err) {
console.error(`Failed to changeSelection: ${JSON.stringify(err)}`);
}
changeSelection(text: string, start: number, end: number): Promise<void>
Updates the information about the selected text in this edit box, to notify the input method when the selected text content or text range changes. This API uses a promise to return the result.
System capability: SystemCapability.MiscServices.InputMethodFramework
Parameters
Name | Type | Mandatory | Description |
---|---|---|---|
text | string | Yes | All input text. |
start | number | Yes | Start position of the selected text. |
end | number | Yes | End position of the selected text. |
Return value
Type | Description |
---|---|
Promise<void> | Promise that returns no value. |
Error codes
For details about the error codes, see Input Method Framework Error Codes and Universal Error Codes.
ID | Error Message |
---|---|
401 | parameter error. Possible causes: 1. Mandatory parameters are left unspecified; 2. Incorrect parameter types. |
12800003 | input method client error. |
12800008 | input method manager service error. |
12800009 | input method client detached. |
Example
import { BusinessError } from '@kit.BasicServicesKit';
try {
inputMethodController.changeSelection('test', 0, 5).then(() => {
console.info('Succeeded in changing selection.');
}).catch((err: BusinessError) => {
console.error(`Failed to changeSelection: ${JSON.stringify(err)}`);
})
} catch(err) {
console.error(`Failed to changeSelection: ${JSON.stringify(err)}`);
}
updateAttribute(attribute: InputAttribute, callback: AsyncCallback<void>): void
Updates the attribute information of this edit box. This API uses an asynchronous callback to return the result.
System capability: SystemCapability.MiscServices.InputMethodFramework
Parameters
Name | Type | Mandatory | Description |
---|---|---|---|
attribute | InputAttribute | Yes | Attribute information. |
callback | AsyncCallback<void> | Yes | Callback used to return the result. If the operation is successful, err is undefined. Otherwise, err is an error object. |
Error codes
For details about the error codes, see Input Method Framework Error Codes and Universal Error Codes.
ID | Error Message |
---|---|
401 | parameter error. Possible causes: 1. Mandatory parameters are left unspecified; 2. Incorrect parameter types. |
12800003 | input method client error. |
12800008 | input method manager service error. |
12800009 | input method client detached. |
Example
import { BusinessError } from '@kit.BasicServicesKit';
try {
let inputAttribute: inputMethod.InputAttribute = { textInputType: 0, enterKeyType: 1 };
inputMethodController.updateAttribute(inputAttribute, (err: BusinessError) => {
if (err) {
console.error(`Failed to updateAttribute: ${JSON.stringify(err)}`);
return;
}
console.info('Succeeded in updating attribute.');
});
} catch(err) {
console.error(`Failed to updateAttribute: ${JSON.stringify(err)}`);
}
updateAttribute(attribute: InputAttribute): Promise<void>
Updates the attribute information of this edit box. This API uses a promise to return the result.
System capability: SystemCapability.MiscServices.InputMethodFramework
Parameters
Name | Type | Mandatory | Description |
---|---|---|---|
attribute | InputAttribute | Yes | Attribute information. |
Return value
Type | Description |
---|---|
Promise<void> | Promise that returns no value. |
Error codes
For details about the error codes, see Input Method Framework Error Codes and Universal Error Codes.
ID | Error Message |
---|---|
401 | parameter error. Possible causes: 1. Mandatory parameters are left unspecified; 2. Incorrect parameter types. |
12800003 | input method client error. |
12800008 | input method manager service error. |
12800009 | input method client detached. |
Example
import { BusinessError } from '@kit.BasicServicesKit';
try {
let inputAttribute: inputMethod.InputAttribute = { textInputType: 0, enterKeyType: 1 };
inputMethodController.updateAttribute(inputAttribute).then(() => {
console.info('Succeeded in updating attribute.');
}).catch((err: BusinessError) => {
console.error(`Failed to updateAttribute: ${JSON.stringify(err)}`);
})
} catch(err) {
console.error(`Failed to updateAttribute: ${JSON.stringify(err)}`);
}
stopInputSession(callback: AsyncCallback<boolean>): void
Ends this input session. This API uses an asynchronous callback to return the result.
NOTE
This API can be called only when the edit box is attached to the input method. That is, it can be called to end the input session only when the edit box is focused.
System capability: SystemCapability.MiscServices.InputMethodFramework
Parameters
Name | Type | Mandatory | Description |
---|---|---|---|
callback | AsyncCallback<boolean> | Yes | Callback used to return the result. If the operation is successful, err is undefined and data is true. Otherwise, err is an error object. |
Error codes
For details about the error codes, see Input Method Framework Error Codes.
ID | Error Message |
---|---|
12800003 | input method client error. |
12800008 | input method manager service error. |
Example
import { BusinessError } from '@kit.BasicServicesKit';
try {
inputMethodController.stopInputSession((err: BusinessError, result: boolean) => {
if (err) {
console.error(`Failed to stopInputSession: ${JSON.stringify(err)}`);
return;
}
if (result) {
console.info('Succeeded in stopping inputSession.');
} else {
console.error('Failed to stopInputSession.');
}
});
} catch(err) {
console.error(`Failed to stopInputSession: ${JSON.stringify(err)}`);
}
stopInputSession(): Promise<boolean>
Ends this input session. This API uses a promise to return the result.
NOTE
This API can be called only when the edit box is attached to the input method. That is, it can be called to end the input session only when the edit box is focused.
System capability: SystemCapability.MiscServices.InputMethodFramework
Return value
Type | Description |
---|---|
Promise<boolean> | Promise used to return the result. The value true means that the operation is successful, and false means the opposite. |
Error codes
For details about the error codes, see Input Method Framework Error Codes.
ID | Error Message |
---|---|
12800003 | input method client error. |
12800008 | input method manager service error. |
Example
import { BusinessError } from '@kit.BasicServicesKit';
try {
inputMethodController.stopInputSession().then((result: boolean) => {
if (result) {
console.info('Succeeded in stopping inputSession.');
} else {
console.error('Failed to stopInputSession.');
}
}).catch((err: BusinessError) => {
console.error(`Failed to stopInputSession: ${JSON.stringify(err)}`);
})
} catch(err) {
console.error(`Failed to stopInputSession: ${JSON.stringify(err)}`);
}
showSoftKeyboard(callback: AsyncCallback<void>): void
Shows the soft keyboard. This API uses an asynchronous callback to return the result.
NOTE
This API can be called only when the edit box is attached to the input method. That is, it can be called to show the soft keyboard only when the edit box is focused.
Required permissions: ohos.permission.CONNECT_IME_ABILITY (for system applications only)
System capability: SystemCapability.MiscServices.InputMethodFramework
Parameters
Name | Type | Mandatory | Description |
---|---|---|---|
callback | AsyncCallback<void> | Yes | Callback used to return the result. If the operation is successful, err is undefined. Otherwise, err is an error object. |
Error codes
For details about the error codes, see Input Method Framework Error Codes and Universal Error Codes.
ID | Error Message |
---|---|
201 | permissions check fails. |
12800003 | input method client error. |
12800008 | input method manager service error. |
Example
import { BusinessError } from '@kit.BasicServicesKit';
inputMethodController.showSoftKeyboard((err: BusinessError) => {
if (!err) {
console.info('Succeeded in showing softKeyboard.');
} else {
console.error(`Failed to show softKeyboard: ${JSON.stringify(err)}`);
}
})
showSoftKeyboard(): Promise<void>
Shows the soft keyboard. This API uses a promise to return the result.
NOTE
This API can be called only when the edit box is attached to the input method. That is, it can be called to show the soft keyboard only when the edit box is focused.
Required permissions: ohos.permission.CONNECT_IME_ABILITY (for system applications only)
System capability: SystemCapability.MiscServices.InputMethodFramework
Return value
Type | Description |
---|---|
Promise<void> | Promise that returns no value. |
Error codes
For details about the error codes, see Input Method Framework Error Codes and Universal Error Codes.
ID | Error Message |
---|---|
201 | permissions check fails. |
12800003 | input method client error. |
12800008 | input method manager service error. |
Example
import { BusinessError } from '@kit.BasicServicesKit';
inputMethodController.showSoftKeyboard().then(() => {
console.info('Succeeded in showing softKeyboard.');
}).catch((err: BusinessError) => {
console.error(`Failed to show softKeyboard: ${JSON.stringify(err)}`);
});
hideSoftKeyboard(callback: AsyncCallback<void>): void
Hides the soft keyboard. This API uses an asynchronous callback to return the result.
NOTE
This API can be called only when the edit box is attached to the input method. That is, it can be called to hide the soft keyboard only when the edit box is focused.
Required permissions: ohos.permission.CONNECT_IME_ABILITY (for system applications only)
System capability: SystemCapability.MiscServices.InputMethodFramework
Parameters
Name | Type | Mandatory | Description |
---|---|---|---|
callback | AsyncCallback<void> | Yes | Callback used to return the result. If the operation is successful, err is undefined. Otherwise, err is an error object. |
Error codes
For details about the error codes, see Input Method Framework Error Codes and Universal Error Codes.
ID | Error Message |
---|---|
201 | permissions check fails. |
12800003 | input method client error. |
12800008 | input method manager service error. |
Example
import { BusinessError } from '@kit.BasicServicesKit';
inputMethodController.hideSoftKeyboard((err: BusinessError) => {
if (!err) {
console.info('Succeeded in hiding softKeyboard.');
} else {
console.error(`Failed to hide softKeyboard: ${JSON.stringify(err)}`);
}
})
hideSoftKeyboard(): Promise<void>
Hides the soft keyboard. This API uses a promise to return the result.
NOTE
This API can be called only when the edit box is attached to the input method. That is, it can be called to hide the soft keyboard only when the edit box is focused.
Required permissions: ohos.permission.CONNECT_IME_ABILITY (for system applications only)
System capability: SystemCapability.MiscServices.InputMethodFramework
Return value
Type | Description |
---|---|
Promise<void> | Promise that returns no value. |
Error codes
For details about the error codes, see Input Method Framework Error Codes and Universal Error Codes.
ID | Error Message |
---|---|
201 | permissions check fails. |
12800003 | input method client error. |
12800008 | input method manager service error. |
Example
import { BusinessError } from '@kit.BasicServicesKit';
inputMethodController.hideSoftKeyboard().then(() => {
console.info('Succeeded in hiding softKeyboard.');
}).catch((err: BusinessError) => {
console.error(`Failed to hide softKeyboard: ${JSON.stringify(err)}`);
});
sendMessage(msgId: string, msgParam?: ArrayBuffer): Promise<void>
Sends the custom communication to the input method application. This API uses a promise to return the result.
NOTE
This API can be called only when the edit box is attached to the input method and enter the edit mode, and the input method application is in full experience mode.
The maximum length of msgId is 256 B, and the maximum length of msgParam is 128 KB.
System capability: SystemCapability.MiscServices.InputMethodFramework
Parameters
Name | Type | Mandatory | Description |
---|---|---|---|
msgId | string | Yes | Identifier of the custom data to be sent to the input method application. |
msgParam | ArrayBuffer | No | Message body of the custom data to be sent to the input method application. |
Return value
Type | Description |
---|---|
Promise<void> | Promise that returns no value. |
Error codes
For details about the error codes, see Input Method Framework Error Codes and Universal Error Codes.
ID | Error Message |
---|---|
401 | parameter error. Possible causes: 1. Incorrect parameter types. 2. Incorrect parameter length. |
12800003 | input method client error. |
12800009 | input method client detached. |
12800014 | the input method is in basic mode. |
12800015 | the other side does not accept the request. |
12800016 | input method client is not editable. |
Example
import { BusinessError } from '@kit.BasicServicesKit';
let msgId: string = "testMsgId";
let msgParam: ArrayBuffer = new ArrayBuffer(128);
inputMethodController.sendMessage(msgId, msgParam).then(() => {
console.info('Succeeded send message.');
}).catch((err: BusinessError) => {
console.error(`Failed to send message: ${JSON.stringify(err)}`);
});
recvMessage(msgHandler?: MessageHandler): void
Registers or unregisters MessageHandler.
NOTE
The MessageHandler object is globally unique. After multiple registrations, only the last registered object is valid and retained, and the onTerminated callback of the penultimate registered object is triggered.
If no parameter is set, unregister MessageHandler. Its onTerminated callback will be triggered.
System capability: SystemCapability.MiscServices.InputMethodFramework
Parameters
Name | Type | Mandatory | Description |
---|---|---|---|
msgHandler | MessageHandler | No | This object receives custom communication data from the input method application through onMessage and receives a message for terminating the subscription to this object through onTerminated. If no parameter is set, unregister MessageHandler. Its onTerminated callback will be triggered. |
Return value
Type | Description |
---|---|
void | No value is returned. |
Error codes
For details about the error codes, see Input Method Framework Error Codes and Universal Error Codes.
ID | Error Message |
---|---|
401 | parameter error. Possible causes: 1. Incorrect parameter types. |
Example
import { BusinessError } from '@kit.BasicServicesKit';
try {
let messageHandler: inputMethod.MessageHandler = {
onTerminated(): void {
console.info('OnTerminated.');
},
onMessage(msgId: string, msgParam?:ArrayBuffer): void {
console.info('recv message.');
}
}
inputMethodController.recvMessage(messageHandler);
inputMethodController.recvMessage();
} catch(err) {
console.error(`Failed to recvMessage: ${JSON.stringify(err)}`);
}
stopInput(callback: AsyncCallback<boolean>): void
Ends this input session. This API uses an asynchronous callback to return the result.
NOTE
This API can be called only when the edit box is attached to the input method. That is, it can be called to end the input session only when the edit box is focused.
This API is supported since API version 6 and deprecated since API version 9. You are advised to use stopInputSession() instead.
System capability: SystemCapability.MiscServices.InputMethodFramework
Parameters
Name | Type | Mandatory | Description |
---|---|---|---|
callback | AsyncCallback<boolean> | Yes | Callback used to return the result. If the operation is successful, err is undefined and data is true. Otherwise, err is an error object. |
Example
import { BusinessError } from '@kit.BasicServicesKit';
inputMethodController.stopInput((err: BusinessError, result: boolean) => {
if (err) {
console.error(`Failed to stopInput: ${JSON.stringify(err)}`);
return;
}
if (result) {
console.info('Succeeded in stopping input.');
} else {
console.error('Failed to stopInput.');
}
});
stopInput(): Promise<boolean>
Ends this input session. This API uses a promise to return the result.
NOTE
This API can be called only when the edit box is attached to the input method. That is, it can be called to end the input session only when the edit box is focused.
This API is supported since API version 6 and deprecated since API version 9. You are advised to use stopInputSession() instead.
System capability: SystemCapability.MiscServices.InputMethodFramework
Return value
Type | Description |
---|---|
Promise<boolean> | Promise used to return the result. The value true means that the operation is successful, and false means the opposite. |
Example
import { BusinessError } from '@kit.BasicServicesKit';
inputMethodController.stopInput().then((result: boolean) => {
if (result) {
console.info('Succeeded in stopping input.');
} else {
console.error('Failed to stopInput.');
}
}).catch((err: BusinessError) => {
console.error(`Failed to stopInput: ${JSON.stringify(err)}`);
})
on(type: 'insertText', callback: (text: string) => void): void
Enables listening for the text insertion event of the input method. This API uses an asynchronous callback to return the result.
System capability: SystemCapability.MiscServices.InputMethodFramework
Parameters
Name | Type | Mandatory | Description |
---|---|---|---|
type | string | Yes | Listening type. The value is fixed at 'insertText'. |
callback | (text: string) => void | Yes | Callback used to return the text to be inserted. The application needs to operate the content in the edit box based on the text content returned in the callback. |
Error codes
For details about the error codes, see Input Method Framework Error Codes and Universal Error Codes.
ID | Error Message |
---|---|
401 | parameter error. Possible causes: 1. Mandatory parameters are left unspecified; 2. Incorrect parameter types; 3. Parameter verification failed. |
12800009 | input method client detached. |
Example
function callback1(text: string) {
console.info('Succeeded in getting callback1 data: ' + JSON.stringify(text));
}
function callback2(text: string) {
console.info('Succeeded in getting callback2 data: ' + JSON.stringify(text));
}
try {
inputMethodController.on('insertText', callback1);
inputMethodController.on('insertText', callback2);
// Cancel only callback1 of insertText.
inputMethodController.off('insertText', callback1);
// Cancel all callbacks of insertText.
inputMethodController.off('insertText');
} catch(err) {
console.error(`Failed to subscribe insertText: ${JSON.stringify(err)}`);
}
off(type: 'insertText', callback?: (text: string) => void): void
Disables listening for the text insertion event of the input method.
System capability: SystemCapability.MiscServices.InputMethodFramework
Parameters
Name | Type | Mandatory | Description |
---|---|---|---|
type | string | Yes | Listening type. The value is fixed at 'insertText'. |
callback | (text: string) => void | No | Callback used for disable listening, which must be the same as that passed by the on API. If this parameter is not specified, listening will be disabled for all callbacks corresponding to the specified type. |
Example
let onInsertTextCallback = (text: string) => {
console.info(`Succeeded in subscribing insertText: ${text}`);
};
inputMethodController.off('insertText', onInsertTextCallback);
inputMethodController.off('insertText');
on(type: 'deleteLeft', callback: (length: number) => void): void
Enables listening for the leftward delete event. This API uses an asynchronous callback to return the result.
System capability: SystemCapability.MiscServices.InputMethodFramework
Parameters
Name | Type | Mandatory | Description |
---|---|---|---|
type | string | Yes | Listening type. The value is fixed at 'deleteLeft'. |
callback | (length: number) => void | Yes | Callback used to return the length of the text to be deleted leftward. The application needs to operate the content in the edit box based on the length returned in the callback. |
Error codes
For details about the error codes, see Input Method Framework Error Codes and Universal Error Codes.
ID | Error Message |
---|---|
401 | parameter error. Possible causes: 1. Mandatory parameters are left unspecified; 2. Incorrect parameter types; 3. Parameter verification failed. |
12800009 | input method client detached. |
Example
try {
inputMethodController.on('deleteLeft', (length: number) => {
console.info(`Succeeded in subscribing deleteLeft, length: ${length}`);
});
} catch(err) {
console.error(`Failed to subscribe deleteLeft: ${JSON.stringify(err)}`);
}
off(type: 'deleteLeft', callback?: (length: number) => void): void
Disables listening for the leftward delete event.
System capability: SystemCapability.MiscServices.InputMethodFramework
Parameters
Name | Type | Mandatory | Description |
---|---|---|---|
type | string | Yes | Listening type. The value is fixed at 'deleteLeft'. |
callback | (length: number) => void | No | Callback used for disable listening, which must be the same as that passed by the on API. If this parameter is not specified, listening will be disabled for all callbacks corresponding to the specified type. |
Example
let onDeleteLeftCallback = (length: number) => {
console.info(`Succeeded in subscribing deleteLeft, length: ${length}`);
};
inputMethodController.off('deleteLeft', onDeleteLeftCallback);
inputMethodController.off('deleteLeft');
on(type: 'deleteRight', callback: (length: number) => void): void
Enables listening for the rightward delete event. This API uses an asynchronous callback to return the result.
System capability: SystemCapability.MiscServices.InputMethodFramework
Parameters
Name | Type | Mandatory | Description |
---|---|---|---|
type | string | Yes | Listening type. The value is fixed at 'deleteRight'. |
callback | (length: number) => void | Yes | Callback used to return the length of the text to be deleted rightward. The application needs to operate the content in the edit box based on the length returned in the callback. |
Error codes
For details about the error codes, see Input Method Framework Error Codes and Universal Error Codes.
ID | Error Message |
---|---|
401 | parameter error. Possible causes: 1. Mandatory parameters are left unspecified; 2. Incorrect parameter types; 3. Parameter verification failed. |
12800009 | input method client detached. |
Example
try {
inputMethodController.on('deleteRight', (length: number) => {
console.info(`Succeeded in subscribing deleteRight, length: ${length}`);
});
} catch(err) {
console.error(`Failed to subscribe deleteRight: ${JSON.stringify(err)}`);
}
off(type: 'deleteRight', callback?: (length: number) => void): void
Disables listening for the rightward delete event.
System capability: SystemCapability.MiscServices.InputMethodFramework
Parameters
Name | Type | Mandatory | Description |
---|---|---|---|
type | string | Yes | Listening type. The value is fixed at deleteRight . |
callback | (length: number) => void | No | Callback used for disable listening, which must be the same as that passed by the on API. If this parameter is not specified, listening will be disabled for all callbacks corresponding to the specified type. |
Example
let onDeleteRightCallback = (length: number) => {
console.info(`Succeeded in subscribing deleteRight, length: ${length}`);
};
inputMethodController.off('deleteRight', onDeleteRightCallback);
inputMethodController.off('deleteRight');
on(type: 'sendKeyboardStatus', callback: (keyboardStatus: KeyboardStatus) => void): void
Enables listening for the soft keyboard status event of the input method. This API uses an asynchronous callback to return the result.
System capability: SystemCapability.MiscServices.InputMethodFramework
Parameters
Name | Type | Mandatory | Description |
---|---|---|---|
type | string | Yes | Listening type. The value is fixed at 'sendKeyboardStatus'. |
callback | (keyboardStatus: KeyboardStatus) => void | Yes | Callback used to return the soft keyboard status. The application needs to perform operations based on the soft keyboard state returned in the callback. |
Error codes
For details about the error codes, see Input Method Framework Error Codes and Universal Error Codes.
ID | Error Message |
---|---|
401 | parameter error. Possible causes: 1. Mandatory parameters are left unspecified; 2. Incorrect parameter types; 3. Parameter verification failed. |
12800009 | input method client detached. |
Example
try {
inputMethodController.on('sendKeyboardStatus', (keyboardStatus: inputMethod.KeyboardStatus) => {
console.info(`Succeeded in subscribing sendKeyboardStatus, keyboardStatus: ${keyboardStatus}`);
});
} catch(err) {
console.error(`Failed to subscribe sendKeyboardStatus: ${JSON.stringify(err)}`);
}
off(type: 'sendKeyboardStatus', callback?: (keyboardStatus: KeyboardStatus) => void): void
Disables listening for the soft keyboard status event of the input method.
System capability: SystemCapability.MiscServices.InputMethodFramework
Parameters
Name | Type | Mandatory | Description |
---|---|---|---|
type | string | Yes | Listening type. The value is fixed at 'sendKeyboardStatus'. |
callback | (keyboardStatus: KeyboardStatus) => void | No | Callback used for disable listening. If this parameter is not specified, listening will be disabled for all callbacks corresponding to the specified type. |
Example
let onSendKeyboardStatus = (keyboardStatus: inputMethod.KeyboardStatus) => {
console.info(`Succeeded in subscribing sendKeyboardStatus, keyboardStatus: ${keyboardStatus}`);
};
inputMethodController.off('sendKeyboardStatus', onSendKeyboardStatus);
inputMethodController.off('sendKeyboardStatus');
on(type: 'sendFunctionKey', callback: (functionKey: FunctionKey) => void): void
Enables listening for the function key sending event of the input method. This API uses an asynchronous callback to return the result.
System capability: SystemCapability.MiscServices.InputMethodFramework
Parameters
Name | Type | Mandatory | Description |
---|---|---|---|
type | string | Yes | Listening type. The value is fixed at 'sendFunctionKey'. |
callback | (functionKey: FunctionKey) => void | Yes | Callback used to return the function key information sent by the input method. The application needs to perform operations based on the function key information returned in the callback. |
Error codes
For details about the error codes, see Input Method Framework Error Codes and Universal Error Codes.
ID | Error Message |
---|---|
401 | parameter error. Possible causes: 1. Mandatory parameters are left unspecified; 2. Incorrect parameter types; 3. Parameter verification failed. |
12800009 | input method client detached. |
Example
try {
inputMethodController.on('sendFunctionKey', (functionKey: inputMethod.FunctionKey) => {
console.info(`Succeeded in subscribing sendFunctionKey, functionKey.enterKeyType: ${functionKey.enterKeyType}`);
});
} catch(err) {
console.error(`Failed to subscribe sendFunctionKey: ${JSON.stringify(err)}`);
}
off(type: 'sendFunctionKey', callback?: (functionKey: FunctionKey) => void): void
Disables listening for the function key sending event of the input method.
System capability: SystemCapability.MiscServices.InputMethodFramework
Parameters
Name | Type | Mandatory | Description |
---|---|---|---|
type | string | Yes | Listening type. The value is fixed at 'sendFunctionKey'. |
callback | (functionKey: FunctionKey) => void | No | Callback used for disable listening, which must be the same as that passed by the on API. If this parameter is not specified, listening will be disabled for all callbacks corresponding to the specified type. |
Example
let onSendFunctionKey = (functionKey: inputMethod.FunctionKey) => {
console.info(`Succeeded in subscribing sendFunctionKey, functionKey: ${functionKey.enterKeyType}`);
};
inputMethodController.off('sendFunctionKey', onSendFunctionKey);
inputMethodController.off('sendFunctionKey');
on(type: 'moveCursor', callback: (direction: Direction) => void): void
Enables listening for the cursor movement event of the input method. This API uses an asynchronous callback to return the result.
System capability: SystemCapability.MiscServices.InputMethodFramework
Parameters
Name | Type | Mandatory | Description |
---|---|---|---|
type | string | Yes | Listening type. The value is fixed at 'moveCursor'. |
callback | (direction: Direction) => void | Yes | Callback used to return the cursor movement direction. The application needs to change the cursor position based on the cursor movement direction returned in the callback. |
Error codes
For details about the error codes, see Input Method Framework Error Codes and Universal Error Codes.
ID | Error Message |
---|---|
401 | parameter error. Possible causes: 1. Mandatory parameters are left unspecified; 2. Incorrect parameter types; 3. Parameter verification failed. |
12800009 | input method client detached. |
Example
try {
inputMethodController.on('moveCursor', (direction: inputMethod.Direction) => {
console.info(`Succeeded in subscribing moveCursor, direction: ${direction}`);
});
} catch(err) {
console.error(`Failed to subscribe moveCursor: ${JSON.stringify(err)}`);
}
off(type: 'moveCursor', callback?: (direction: Direction) => void): void
Disables listening for the cursor movement event of the input method.
System capability: SystemCapability.MiscServices.InputMethodFramework
Parameters
Name | Type | Mandatory | Description |
---|---|---|---|
type | string | Yes | Listening type. The value is fixed at 'moveCursor'. |
callback | (direction: Direction10+) => void | No | Callback used for disable listening, which must be the same as that passed by the on API. If this parameter is not specified, listening will be disabled for all callbacks corresponding to the specified type. |
Example
let onMoveCursorCallback = (direction: inputMethod.Direction) => {
console.info(`Succeeded in subscribing moveCursor, direction: ${direction}`);
};
inputMethodController.off('moveCursor', onMoveCursorCallback);
inputMethodController.off('moveCursor');
on(type: 'handleExtendAction', callback: (action: ExtendAction) => void): void
Enables listening for the extended action handling event of the input method. This API uses an asynchronous callback to return the result.
System capability: SystemCapability.MiscServices.InputMethodFramework
Parameters
Name | Type | Mandatory | Description |
---|---|---|---|
type | string | Yes | Listening type. The value is fixed at 'handleExtendAction'. |
callback | (action: ExtendAction) => void | Yes | Callback used to return the extended action type. The application needs to perform operations based on the extended action type returned in the callback. |
Error codes
For details about the error codes, see Input Method Framework Error Codes and Universal Error Codes.
ID | Error Message |
---|---|
401 | parameter error. Possible causes: 1. Mandatory parameters are left unspecified; 2. Incorrect parameter types; 3. Parameter verification failed. |
12800009 | input method client detached. |
Example
try {
inputMethodController.on('handleExtendAction', (action: inputMethod.ExtendAction) => {
console.info(`Succeeded in subscribing handleExtendAction, action: ${action}`);
});
} catch(err) {
console.error(`Failed to subscribe handleExtendAction: ${JSON.stringify(err)}`);
}
off(type: 'handleExtendAction', callback?: (action: ExtendAction) => void): void
Disables listening for the extended action handling event of the input method. This API uses an asynchronous callback to return the result.
System capability: SystemCapability.MiscServices.InputMethodFramework
Parameters
Name | Type | Mandatory | Description |
---|---|---|---|
type | string | Yes | Listening type. The value is fixed at 'handleExtendAction'. |
callback | (action: ExtendAction) => void | No | Callback used for disable listening, which must be the same as that passed by the on API. If this parameter is not specified, listening will be disabled for all callbacks corresponding to the specified type. |
Example
try {
let onHandleExtendActionCallback = (action: inputMethod.ExtendAction) => {
console.info(`Succeeded in subscribing handleExtendAction, action: ${action}`);
};
inputMethodController.off('handleExtendAction', onHandleExtendActionCallback);
inputMethodController.off('handleExtendAction');
} catch(err) {
console.error(`Failed to subscribe handleExtendAction: ${JSON.stringify(err)}`);
}
on(type: 'selectByRange', callback: Callback<Range>): void
Enables listening for the select-by-range event. This API uses an asynchronous callback to return the result.
System capability: SystemCapability.MiscServices.InputMethodFramework
Parameters
Name | Type | Mandatory | Description |
---|---|---|---|
type | string | Yes | Listening type. The value is fixed at 'selectByRange'. |
callback | Callback<Range> | Yes | Callback used to return the range of the text to be selected. The application needs to select the text based on the range returned in the callback. |
Error codes
For details about the error codes, see Universal Error Codes.
ID | Error Message |
---|---|
401 | parameter error. Possible causes: 1. Mandatory parameters are left unspecified; 2. Incorrect parameter types; 3. Parameter verification failed. |
Example
try {
inputMethodController.on('selectByRange', (range: inputMethod.Range) => {
console.info(`Succeeded in subscribing selectByRange: start: ${range.start} , end: ${range.end}`);
});
} catch(err) {
console.error(`Failed to subscribe selectByRange: ${JSON.stringify(err)}`);
}
off(type: 'selectByRange', callback?: Callback<Range>): void
Disables listening for the select-by-range event. This API uses an asynchronous callback to return the result.
System capability: SystemCapability.MiscServices.InputMethodFramework
Parameters
Name | Type | Mandatory | Description |
---|---|---|---|
type | string | Yes | Listening type. The value is fixed at 'selectByRange'. |
callback | Callback<Range> | No | Callback used for disable listening, which must be the same as that passed by the on API. If this parameter is not specified, listening will be disabled for all callbacks corresponding to the specified type. |
Example
try {
let onSelectByRangeCallback = (range: inputMethod.Range) => {
console.info(`Succeeded in subscribing selectByRange, start: ${range.start} , end: ${range.end}`);
};
inputMethodController.off('selectByRange', onSelectByRangeCallback);
inputMethodController.off('selectByRange');
} catch(err) {
console.error(`Failed to subscribe selectByRange: ${JSON.stringify(err)}`);
}
on(type: 'selectByMovement', callback: Callback<Movement>): void
Enables listening for the select-by-cursor-movement event. This API uses an asynchronous callback to return the result.
System capability: SystemCapability.MiscServices.InputMethodFramework
Parameters
Name | Type | Mandatory | Description |
---|---|---|---|
type | string | Yes | Listening type. The value is fixed at 'selectByMovement'. |
callback | Callback<Movement> | Yes | Callback used to return the direction in which the cursor moves. The application needs to select the text based on the direction returned in the callback. |
Error codes
For details about the error codes, see Universal Error Codes.
ID | Error Message |
---|---|
401 | parameter error. Possible causes: 1. Mandatory parameters are left unspecified; 2. Incorrect parameter types; 3. Parameter verification failed. |
Example
try {
inputMethodController.on('selectByMovement', (movement: inputMethod.Movement) => {
console.info('Succeeded in subscribing selectByMovement: direction: ' + movement.direction);
});
} catch(err) {
console.error(`Failed to subscribe selectByMovement: ${JSON.stringify(err)}`);
}
off(type: 'selectByMovement', callback?: Callback<Movement>): void
Disables listening for the select-by-cursor-movement event. This API uses an asynchronous callback to return the result.
System capability: SystemCapability.MiscServices.InputMethodFramework
Parameters
Name | Type | Mandatory | Description |
---|---|---|---|
type | string | Yes | Listening type. The value is fixed at 'selectByMovement'. |
callback | Callback<Movement> | No | Callback used for disable listening, which must be the same as that passed by the on API. If this parameter is not specified, listening will be disabled for all callbacks corresponding to the specified type. |
Example
try {
let onSelectByMovementCallback = (movement: inputMethod.Movement) => {
console.info(`Succeeded in subscribing selectByMovement, movement.direction: ${movement.direction}`);
};
inputMethodController.off('selectByMovement', onSelectByMovementCallback);
inputMethodController.off('selectByMovement');
} catch(err) {
console.error(`Failed to unsubscribing selectByMovement: ${JSON.stringify(err)}`);
}
on(type: 'getLeftTextOfCursor', callback: (length: number) => string): void
Enables listening for the event of obtaining the length of text deleted leftward. This API uses an asynchronous callback to return the result.
System capability: SystemCapability.MiscServices.InputMethodFramework
Parameters
Name | Type | Mandatory | Description |
---|---|---|---|
type | string | Yes | Listening type. The value is fixed at 'getLeftTextOfCursor'. |
callback | (length: number) => string | Yes | Callback used to obtain the text of the specified length deleted leftward. |
Error codes
For details about the error codes, see Input Method Framework Error Codes and Universal Error Codes.
ID | Error Message |
---|---|
401 | parameter error. Possible causes: 1. Mandatory parameters are left unspecified; 2. Incorrect parameter types; 3. Parameter verification failed. |
12800009 | input method client detached. |
Example
try {
inputMethodController.on('getLeftTextOfCursor', (length: number) => {
console.info(`Succeeded in subscribing getLeftTextOfCursor, length: ${length}`);
let text:string = "";
return text;
});
} catch(err) {
console.error(`Failed to unsubscribing getLeftTextOfCursor. err: ${JSON.stringify(err)}`);
}
off(type: 'getLeftTextOfCursor', callback?: (length: number) => string): void
Disables listening for the event of obtaining the length of text deleted leftward. This API uses an asynchronous callback to return the result.
System capability: SystemCapability.MiscServices.InputMethodFramework
Parameters
Name | Type | Mandatory | Description |
---|---|---|---|
type | string | Yes | Listening type. The value is fixed at 'getLeftTextOfCursor'. |
callback | (length: number) => string | No | Callback used for disable listening, which must be the same as that passed by the on API. If this parameter is not specified, listening will be disabled for all callbacks corresponding to the specified type. |
Example
try {
let getLeftTextOfCursorCallback = (length: number) => {
console.info(`Succeeded in unsubscribing getLeftTextOfCursor, length: ${length}`);
let text:string = "";
return text;
};
inputMethodController.off('getLeftTextOfCursor', getLeftTextOfCursorCallback);
inputMethodController.off('getLeftTextOfCursor');
} catch(err) {
console.error(`Failed to unsubscribing getLeftTextOfCursor. err: ${JSON.stringify(err)}`);
}
on(type: 'getRightTextOfCursor', callback: (length: number) => string): void
Enables listening for the event of obtaining the length of text deleted rightward. This API uses an asynchronous callback to return the result.
System capability: SystemCapability.MiscServices.InputMethodFramework
Parameters
Name | Type | Mandatory | Description |
---|---|---|---|
type | string | Yes | Listening type. The value is fixed at 'getRightTextOfCursor'. |
callback | (length: number) => string | Yes | Callback used to obtain the text of the specified length deleted rightward. |
Error codes
For details about the error codes, see Input Method Framework Error Codes and Universal Error Codes.
ID | Error Message |
---|---|
401 | parameter error. Possible causes: 1. Mandatory parameters are left unspecified; 2. Incorrect parameter types; 3. Parameter verification failed. |
12800009 | input method client detached. |
Example
try {
inputMethodController.on('getRightTextOfCursor', (length: number) => {
console.info(`Succeeded in subscribing getRightTextOfCursor, length: ${length}`);
let text:string = "";
return text;
});
} catch(err) {
console.error(`Failed to subscribe getRightTextOfCursor. err: ${JSON.stringify(err)}`);
}
off(type: 'getRightTextOfCursor', callback?: (length: number) => string): void
Disables listening for the event of obtaining the length of text deleted rightward. This API uses an asynchronous callback to return the result.
System capability: SystemCapability.MiscServices.InputMethodFramework
Parameters
Name | Type | Mandatory | Description |
---|---|---|---|
type | string | Yes | Listening type. The value is fixed at 'getRightTextOfCursor'. |
callback | (length: number) => string | No | Callback used for disable listening, which must be the same as that passed by the on API. If this parameter is not specified, listening will be disabled for all callbacks corresponding to the specified type. |
Example
try {
let getRightTextOfCursorCallback = (length: number) => {
console.info(`Succeeded in unsubscribing getRightTextOfCursor, length: ${length}`);
let text:string = "";
return text;
};
inputMethodController.off('getRightTextOfCursor', getRightTextOfCursorCallback);
inputMethodController.off('getRightTextOfCursor');
} catch(err) {
console.error(`Failed to unsubscribing getRightTextOfCursor. err: ${JSON.stringify(err)}`);
}
on(type: 'getTextIndexAtCursor', callback: () => number): void
Enables listening for the event of obtaining the index of text at the cursor. This API uses an asynchronous callback to return the result.
System capability: SystemCapability.MiscServices.InputMethodFramework
Parameters
Name | Type | Mandatory | Description |
---|---|---|---|
type | string | Yes | Listening type. The value is fixed at 'getTextIndexAtCursor'. |
callback | () => number | Yes | Callback used to obtain the index of text at the cursor. |
Error codes
For details about the error codes, see Input Method Framework Error Codes and Universal Error Codes.
ID | Error Message |
---|---|
401 | parameter error. Possible causes: 1. Mandatory parameters are left unspecified; 2. Incorrect parameter types; 3. Parameter verification failed. |
12800009 | input method client detached. |
Example
try {
inputMethodController.on('getTextIndexAtCursor', () => {
console.info(`Succeeded in subscribing getTextIndexAtCursor.`);
let index:number = 0;
return index;
});
} catch(err) {
console.error(`Failed to subscribe getTextIndexAtCursor. err: ${JSON.stringify(err)}`);
}
off(type: 'getTextIndexAtCursor', callback?: () => number): void
Disables listening for the event of obtaining the index of text at the cursor. This API uses an asynchronous callback to return the result.
System capability: SystemCapability.MiscServices.InputMethodFramework
Parameters
Name | Type | Mandatory | Description |
---|---|---|---|
type | string | Yes | Listening type. The value is fixed at 'getTextIndexAtCursor'. |
callback | () => number | No | Callback used for disable listening, which must be the same as that passed by the on API. If this parameter is not specified, listening will be disabled for all callbacks corresponding to the specified type. |
Example
try {
let getTextIndexAtCursorCallback = () => {
console.info(`Succeeded in unsubscribing getTextIndexAtCursor.`);
let index:number = 0;
return index;
};
inputMethodController.off('getTextIndexAtCursor', getTextIndexAtCursorCallback);
inputMethodController.off('getTextIndexAtCursor');
} catch(err) {
console.error(`Failed to unsubscribing getTextIndexAtCursor. err: ${JSON.stringify(err)}`);
}
on(type: 'setPreviewText', callback: SetPreviewTextCallback): void
Subscribes to the event for text preview operations in an input method application. This API uses an asynchronous callback to return the result.
NOTE
To use the text preview function, you need to subscribe to this event before calling attach and subscribe to this event together with on('finishTextPreview').
System capability: SystemCapability.MiscServices.InputMethodFramework
Parameters
Name | Type | Mandatory | Description |
---|---|---|---|
type | string | Yes | Event type, which is 'setPreviewText'. |
callback | SetPreviewTextCallback | Yes | Callback used to return the result. It is used to receive and return the text preview. |
Error codes
For details about the error codes, see Universal Error Codes.
ID | Error Message |
---|---|
401 | Parameter error. Possible causes: 1. Mandatory parameters are left unspecified; 2. Incorrect parameter types; 3. Parameter verification failed. |
Example
let setPreviewTextCallback1: inputMethod.SetPreviewTextCallback = (text: string, range: inputMethod.Range) => {
console.info(`SetPreviewTextCallback1: Received text - ${text}, Received range - start: ${range.start}, end: ${range.end}`);
};
let setPreviewTextCallback2: inputMethod.SetPreviewTextCallback = (text: string, range: inputMethod.Range) => {
console.info(`setPreviewTextCallback2: Received text - ${text}, Received range - start: ${range.start}, end: ${range.end}`);
};
try {
inputMethodController.on('setPreviewText', setPreviewTextCallback1);
console.info(`SetPreviewTextCallback1 subscribed to setPreviewText`);
inputMethodController.on('setPreviewText', setPreviewTextCallback2);
console.info(`SetPreviewTextCallback2 subscribed to setPreviewText`);
// Cancel only the callback1 of setPreviewText.
inputMethodController.off('setPreviewText', setPreviewTextCallback1);
console.info(`SetPreviewTextCallback1 unsubscribed from setPreviewText`);
// Cancel all callbacks of setPreviewText.
inputMethodController.off('setPreviewText');
console.info(`All callbacks unsubscribed from setPreviewText`);
} catch(err) {
console.error(`Failed to operate on setPreviewText: ${JSON.stringify(err)}`);
}
off(type: 'setPreviewText', callback?: SetPreviewTextCallback): void
Unsubscribes from the event for text preview operations in an input method application. This API uses an asynchronous callback to return the result.
System capability: SystemCapability.MiscServices.InputMethodFramework
Parameters
Name | Type | Mandatory | Description |
---|---|---|---|
type | string | Yes | Event type, which is 'setPreviewText'. |
callback | SetPreviewTextCallback | No | Callback used for disable listening, which must be the same as that passed by the on API. If this parameter is not specified, listening will be disabled for all callbacks corresponding to the specified type. |
Example
let setPreviewTextCallback1: inputMethod.SetPreviewTextCallback = (text: string, range: inputMethod.Range) => {
console.info(`SetPreviewTextCallback1: Received text - ${text}, Received range - start: ${range.start}, end: ${range.end}`);
};
let setPreviewTextCallback2: inputMethod.SetPreviewTextCallback = (text: string, range: inputMethod.Range) => {
console.info(`setPreviewTextCallback2: Received text - ${text}, Received range - start: ${range.start}, end: ${range.end}`);
};
try {
inputMethodController.on('setPreviewText', setPreviewTextCallback1);
console.info(`SetPreviewTextCallback1 subscribed to setPreviewText`);
inputMethodController.on('setPreviewText', setPreviewTextCallback2);
console.info(`SetPreviewTextCallback2 subscribed to setPreviewText`);
// Cancel only the callback1 of setPreviewText.
inputMethodController.off('setPreviewText', setPreviewTextCallback1);
console.info(`SetPreviewTextCallback1 unsubscribed from setPreviewText`);
// Cancel all callbacks of setPreviewText.
inputMethodController.off('setPreviewText');
console.info(`All callbacks unsubscribed from setPreviewText`);
} catch(err) {
console.error(`Failed to operate on setPreviewText: ${JSON.stringify(err)}`);
}
on(type: 'finishTextPreview', callback: Callback<void>): void
Subscribes to the event of finishing text preview. This API uses an asynchronous callback to return the result.
NOTE
To use the text preview function, you need to subscribe to this event before calling attach and subscribe to this event together with on('setPreviewText').
System capability: SystemCapability.MiscServices.InputMethodFramework
Parameters
Name | Type | Mandatory | Description |
---|---|---|---|
type | string | Yes | Event type, which is 'finishTextPreview'. |
callback | Callback<void> | Yes | Callback used to return the result. It is used to process the logic of finishing text preview. Return type: void |
Error codes
For details about the error codes, see Universal Error Codes.
ID | Error Message |
---|---|
401 | Parameter error. Possible causes: 1. Mandatory parameters are left unspecified; 2. Incorrect parameter types; 3. Parameter verification failed. |
Example
let finishTextPreviewCallback1 = () => {
console.info(`FinishTextPreviewCallback1: finishTextPreview event triggered`);
};
let finishTextPreviewCallback2 = () => {
console.info(`FinishTextPreviewCallback2: finishTextPreview event triggered`);
};
try {
inputMethodController.on('finishTextPreview', finishTextPreviewCallback1);
console.info(`FinishTextPreviewCallback1 subscribed to finishTextPreview`);
inputMethodController.on('finishTextPreview', finishTextPreviewCallback2);
console.info(`FinishTextPreviewCallback2 subscribed to finishTextPreview`);
// Cancel only the callback1 of finishTextPreview.
inputMethodController.off('finishTextPreview', finishTextPreviewCallback1);
console.info(`FinishTextPreviewCallback1 unsubscribed from finishTextPreview`);
// Cancel all callbacks of finishTextPreview.
inputMethodController.off('finishTextPreview');
console.info(`All callbacks unsubscribed from finishTextPreview`);
} catch(err) {
console.error(`Failed to operate on finishTextPreview (subscribe/off): ${JSON.stringify(err)}`);
}
off(type: 'finishTextPreview', callback?: Callback<void>): void
Unsubscribes from the event of finishing text preview. This API uses an asynchronous callback to return the result.
System capability: SystemCapability.MiscServices.InputMethodFramework
Parameters
Name | Type | Mandatory | Description |
---|---|---|---|
type | string | Yes | Event type, which is 'finishTextPreview'. |
callback | Callback<void> | No | Callback used for disable listening, which must be the same as that passed by the on API. If this parameter is not specified, listening will be disabled for all callbacks corresponding to the specified type. |
Example
let finishTextPreviewCallback1 = () => {
console.info(`FinishTextPreviewCallback1: finishTextPreview event triggered`);
};
let finishTextPreviewCallback2 = () => {
console.info(`FinishTextPreviewCallback2: finishTextPreview event triggered`);
};
try {
inputMethodController.on('finishTextPreview', finishTextPreviewCallback1);
console.info(`FinishTextPreviewCallback1 subscribed to finishTextPreview`);
inputMethodController.on('finishTextPreview', finishTextPreviewCallback2);
console.info(`FinishTextPreviewCallback2 subscribed to finishTextPreview`);
// Cancel only the callback1 of finishTextPreview.
inputMethodController.off('finishTextPreview', finishTextPreviewCallback1);
console.info(`FinishTextPreviewCallback1 unsubscribed from finishTextPreview`);
// Cancel all callbacks of finishTextPreview.
inputMethodController.off('finishTextPreview');
console.info(`All callbacks unsubscribed from finishTextPreview`);
} catch(err) {
console.error(`Failed to operate on finishTextPreview (subscribe/off): ${JSON.stringify(err)}`);
}
In the following API examples, you must first use getSetting to obtain an InputMethodSetting instance, and then call the APIs using the obtained instance.
on(type: 'imeChange', callback: (inputMethodProperty: InputMethodProperty, inputMethodSubtype: InputMethodSubtype) => void): void
Enables listening for the input method and subtype change event. This API uses an asynchronous callback to return the result.
System capability: SystemCapability.MiscServices.InputMethodFramework
Parameters
Name | Type | Mandatory | Description |
---|---|---|---|
type | string | Yes | Listening type. The value is fixed at 'imeChange'. |
callback | (inputMethodProperty: InputMethodProperty, inputMethodSubtype: InputMethodSubtype) => void | Yes | Callback used to return the input method attributes and subtype. |
Example
import { InputMethodSubtype } from '@kit.IMEKit';
try {
inputMethodSetting.on('imeChange', (inputMethodProperty: inputMethod.InputMethodProperty, inputMethodSubtype: InputMethodSubtype) => {
console.info('Succeeded in subscribing imeChange: inputMethodProperty: ' + JSON.stringify(inputMethodProperty) + " , inputMethodSubtype: " + JSON.stringify(inputMethodSubtype));
});
} catch(err) {
console.error(`Failed to unsubscribing inputMethodProperty. err: ${JSON.stringify(err)}`);
}
off(type: 'imeChange', callback?: (inputMethodProperty: InputMethodProperty, inputMethodSubtype: InputMethodSubtype) => void): void
Disables listening for the input method and subtype change event. This API uses an asynchronous callback to return the result.
System capability: SystemCapability.MiscServices.InputMethodFramework
Parameters
Name | Type | Mandatory | Description |
---|---|---|---|
type | string | Yes | Listening type. The value is fixed at 'imeChange'. |
callback | (inputMethodProperty: InputMethodProperty, inputMethodSubtype: InputMethodSubtype) => void | No | Callback used to return the input method attributes and subtype. |
Example
inputMethodSetting.off('imeChange');
listInputMethodSubtype(inputMethodProperty: InputMethodProperty, callback: AsyncCallback<Array<InputMethodSubtype>>): void
Obtains all subtypes of a specified input method. This API uses an asynchronous callback to return the result.
System capability: SystemCapability.MiscServices.InputMethodFramework
Parameters
Name | Type | Mandatory | Description |
---|---|---|---|
inputMethodProperty | InputMethodProperty | Yes | Input method. |
callback | AsyncCallback<Array<InputMethodSubtype>> | Yes | Callback used to return all subtypes of the specified input method. |
Error codes
For details about the error codes, see Input Method Framework Error Codes and Universal Error Codes.
ID | Error Message |
---|---|
401 | parameter error. Possible causes: 1. Mandatory parameters are left unspecified; 2. Incorrect parameter types; 3. Parameter verification failed. |
12800001 | bundle manager error. |
12800008 | input method manager service error. |
Example
import { InputMethodSubtype } from '@kit.IMEKit';
import { BusinessError } from '@kit.BasicServicesKit';
let inputMethodProperty: inputMethod.InputMethodProperty = {
name: 'com.example.kikakeyboard',
id: 'propertyId',
packageName: 'com.example.kikakeyboard',
methodId: 'propertyId',
}
let inputMethodSetting = inputMethod.getSetting();
try {
inputMethodSetting.listInputMethodSubtype(inputMethodProperty, (err: BusinessError, data: Array<InputMethodSubtype>) => {
if (err) {
console.error(`Failed to listInputMethodSubtype: ${JSON.stringify(err)}`);
return;
}
console.info('Succeeded in listing inputMethodSubtype.');
});
} catch (err) {
console.error(`Failed to listInputMethodSubtype: ${JSON.stringify(err)}`);
}
listInputMethodSubtype(inputMethodProperty: InputMethodProperty): Promise<Array<InputMethodSubtype>>
Obtains all subtypes of a specified input method. This API uses a promise to return the result.
System capability: SystemCapability.MiscServices.InputMethodFramework
Parameters
Name | Type | Mandatory | Description |
---|---|---|---|
inputMethodProperty | InputMethodProperty | Yes | Input method. |
Return value
Type | Description |
---|---|
Promise<Array<InputMethodSubtype>> | Promise used to return all subtypes of the specified input method. |
Error codes
For details about the error codes, see Input Method Framework Error Codes and Universal Error Codes.
ID | Error Message |
---|---|
401 | parameter error. Possible causes: 1. Mandatory parameters are left unspecified; 2. Incorrect parameter types; 3. Parameter verification failed. |
12800001 | bundle manager error. |
12800008 | input method manager service error. |
Example
import { InputMethodSubtype } from '@kit.IMEKit';
import { BusinessError } from '@kit.BasicServicesKit';
let inputMethodProperty: inputMethod.InputMethodProperty = {
name: 'com.example.kikakeyboard',
id: 'propertyId',
packageName: 'com.example.kikakeyboard',
methodId: 'propertyId',
}
let inputMethodSetting = inputMethod.getSetting();
try {
inputMethodSetting.listInputMethodSubtype(inputMethodProperty).then((data: Array<InputMethodSubtype>) => {
console.info('Succeeded in listing inputMethodSubtype.');
}).catch((err: BusinessError) => {
console.error(`Failed to listInputMethodSubtype: ${JSON.stringify(err)}`);
})
} catch(err) {
console.error(`Failed to listInputMethodSubtype: ${JSON.stringify(err)}`);
}
listCurrentInputMethodSubtype(callback: AsyncCallback<Array<InputMethodSubtype>>): void
Obtains all subtypes of this input method. This API uses an asynchronous callback to return the result.
System capability: SystemCapability.MiscServices.InputMethodFramework
Parameters
Name | Type | Mandatory | Description |
---|---|---|---|
callback | AsyncCallback<Array<InputMethodSubtype>> | Yes | Callback used to return all subtypes of the current input method. |
Error codes
For details about the error codes, see Input Method Framework Error Codes and Universal Error Codes.
ID | Error Message |
---|---|
12800001 | bundle manager error. |
12800008 | input method manager service error. |
Example
import { InputMethodSubtype } from '@kit.IMEKit';
import { BusinessError } from '@kit.BasicServicesKit';
let inputMethodSetting = inputMethod.getSetting();
try {
inputMethodSetting.listCurrentInputMethodSubtype((err: BusinessError, data: Array<InputMethodSubtype>) => {
if (err) {
console.error(`Failed to listCurrentInputMethodSubtype: ${JSON.stringify(err)}`);
return;
}
console.info('Succeeded in listing currentInputMethodSubtype.');
});
} catch(err) {
console.error(`Failed to listCurrentInputMethodSubtype: ${JSON.stringify(err)}`);
}
listCurrentInputMethodSubtype(): Promise<Array<InputMethodSubtype>>
Obtains all subtypes of this input method. This API uses a promise to return the result.
System capability: SystemCapability.MiscServices.InputMethodFramework
Return value
Type | Description |
---|---|
Promise<Array<InputMethodSubtype>> | Promise used to return all subtypes of the current input method. |
Error codes
For details about the error codes, see Input Method Framework Error Codes and Universal Error Codes.
ID | Error Message |
---|---|
12800001 | bundle manager error. |
12800008 | input method manager service error. |
Example
import { InputMethodSubtype } from '@kit.IMEKit';
import { BusinessError } from '@kit.BasicServicesKit';
let inputMethodSetting = inputMethod.getSetting();
try {
inputMethodSetting.listCurrentInputMethodSubtype().then((data: Array<InputMethodSubtype>) => {
console.info('Succeeded in listing currentInputMethodSubtype.');
}).catch((err: BusinessError) => {
console.error(`Failed to listCurrentInputMethodSubtype: ${JSON.stringify(err)}`);
})
} catch(err) {
console.error(`Failed to listCurrentInputMethodSubtype: ${JSON.stringify(err)}`);
}
getInputMethods(enable: boolean, callback: AsyncCallback<Array<InputMethodProperty>>): void
Obtains a list of activated or deactivated input methods. This API uses an asynchronous callback to return the result.
NOTE
An activated input method refers to an input method that is enabled. The default input method is enabled by default. Other input methods can be enabled or disabled as needed.
The list of activated input methods includes the default input method and enabled input methods. The list of deactivated input methods includes all installed input methods except the enabled ones.
System capability: SystemCapability.MiscServices.InputMethodFramework
Parameters
Name | Type | Mandatory | Description |
---|---|---|---|
enable | boolean | Yes | Whether to return a list of activated input methods. The value true means to return a list of activated input methods, and false means to return a list of deactivated input methods. |
callback | AsyncCallback<Array<InputMethodProperty>> | Yes | Callback used to return a list of activated or deactivated input methods. |
Error codes
For details about the error codes, see Input Method Framework Error Codes and Universal Error Codes.
ID | Error Message |
---|---|
401 | parameter error. Possible causes: 1. Mandatory parameters are left unspecified; 2. Incorrect parameter types. |
12800001 | bundle manager error. |
12800008 | input method manager service error. |
Example
import { BusinessError } from '@kit.BasicServicesKit';
try {
inputMethodSetting.getInputMethods(true, (err: BusinessError, data: Array<inputMethod.InputMethodProperty>) => {
if (err) {
console.error(`Failed to getInputMethods: ${JSON.stringify(err)}`);
return;
}
console.info('Succeeded in getting inputMethods.');
});
} catch (err) {
console.error(`Failed to getInputMethods: ${JSON.stringify(err)}`);
}
getInputMethods(enable: boolean): Promise<Array<InputMethodProperty>>
Obtains a list of activated or deactivated input methods. This API uses a promise to return the result.
NOTE
An activated input method refers to an input method that is enabled. The default input method is enabled by default. Other input methods can be enabled or disabled as needed.
The list of activated input methods includes the default input method and enabled input methods. The list of deactivated input methods includes all installed input methods except the enabled ones.
System capability: SystemCapability.MiscServices.InputMethodFramework
Parameters
Name | Type | Mandatory | Description |
---|---|---|---|
enable | boolean | Yes | Whether to return a list of activated input methods. The value true means to return a list of activated input methods, and false means to return a list of deactivated input methods. |
Return value
Type | Description |
---|---|
Promise<Array<InputMethodProperty>> | Promise used to return a list of activated or deactivated input methods. |
Error codes
For details about the error codes, see Input Method Framework Error Codes and Universal Error Codes.
ID | Error Message |
---|---|
401 | parameter error. Possible causes: 1. Mandatory parameters are left unspecified; 2. Incorrect parameter types. |
12800001 | bundle manager error. |
12800008 | input method manager service error. |
Example
import { BusinessError } from '@kit.BasicServicesKit';
try {
inputMethodSetting.getInputMethods(true).then((data: Array<inputMethod.InputMethodProperty>) => {
console.info('Succeeded in getting inputMethods.');
}).catch((err: BusinessError) => {
console.error(`Failed to getInputMethods: ${JSON.stringify(err)}`);
})
} catch(err) {
console.error(`Failed to getInputMethods: ${JSON.stringify(err)}`);
}
getInputMethodsSync(enable: boolean): Array<InputMethodProperty>
Obtains a list of activated or deactivated input methods. This API returns the result synchronously.
NOTE
An activated input method refers to an input method that is enabled. The default input method is enabled by default. Other input methods can be enabled or disabled as needed.
The list of activated input methods includes the default input method and enabled input methods. The list of deactivated input methods includes all installed input methods except the enabled ones.
System capability: SystemCapability.MiscServices.InputMethodFramework
Parameters
Name | Type | Mandatory | Description |
---|---|---|---|
enable | boolean | Yes | Whether to return a list of activated input methods. The value true means to return a list of activated input methods, and false means to return a list of deactivated input methods. |
Return value
Type | Description |
---|---|
Array<InputMethodProperty> | List of activated or deactivated input methods. |
Error codes
For details about the error codes, see Input Method Framework Error Codes and Universal Error Codes.
ID | Error Message |
---|---|
401 | parameter error. Possible causes: 1. Mandatory parameters are left unspecified; 2. Incorrect parameter types. |
12800001 | bundle manager error. |
12800008 | input method manager service error. |
Example
try {
let imeProp = inputMethodSetting.getInputMethodsSync(true);
} catch(err) {
console.error(`Failed to getInputMethods: ${JSON.stringify(err)}`);
}
getAllInputMethods(callback: AsyncCallback<Array<InputMethodProperty>>): void
Obtains a list of all input methods. This API uses an asynchronous callback to return the result.
System capability: SystemCapability.MiscServices.InputMethodFramework
Parameters
Name | Type | Mandatory | Description |
---|---|---|---|
callback | AsyncCallback<Array<InputMethodProperty>> | Yes | Callback used to return a list of all input methods. |
Error codes
For details about the error codes, see Input Method Framework Error Codes and Universal Error Codes.
ID | Error Message |
---|---|
12800001 | bundle manager error. |
12800008 | input method manager service error. |
Example
import { BusinessError } from '@kit.BasicServicesKit';
try {
inputMethodSetting.getAllInputMethods((err: BusinessError, data: Array<inputMethod.InputMethodProperty>) => {
if (err) {
console.error(`Failed to getAllInputMethods: ${JSON.stringify(err)}`);
return;
}
console.info('Succeeded in getting all inputMethods.');
});
} catch (err) {
console.error(`Failed to getAllInputMethods: ${JSON.stringify(err)}`);
}
getAllInputMethods(): Promise<Array<InputMethodProperty>>
Obtains a list of all input methods. This API uses a promise to return the result.
System capability: SystemCapability.MiscServices.InputMethodFramework
Return value
Type | Description |
---|---|
Promise<Array<InputMethodProperty>> | Promise used to return a list of all input methods. |
Error codes
For details about the error codes, see Input Method Framework Error Codes and Universal Error Codes.
ID | Error Message |
---|---|
12800001 | bundle manager error. |
12800008 | input method manager service error. |
Example
import { BusinessError } from '@kit.BasicServicesKit';
inputMethodSetting.getAllInputMethods().then((data: Array<inputMethod.InputMethodProperty>) => {
console.info('Succeeded in getting all inputMethods.');
}).catch((err: BusinessError) => {
console.error(`Failed to getAllInputMethods: ${JSON.stringify(err)}`);
})
getAllInputMethodsSync(): Array<InputMethodProperty>
Obtains a list of all input methods. This API returns the result synchronously.
System capability: SystemCapability.MiscServices.InputMethodFramework
Return value
Type | Description |
---|---|
Array<InputMethodProperty> | List of all input methods. |
Error codes
For details about the error codes, see Input Method Framework Error Codes.
ID | Error Message |
---|---|
12800001 | bundle manager error. |
12800008 | input method manager service error. |
Example
try {
let imeProp = inputMethodSetting.getAllInputMethodsSync();
} catch(err) {
console.error(`Failed to getAllInputMethodsSync: ${JSON.stringify(err)}`);
}
showOptionalInputMethods(callback: AsyncCallback<boolean>): void
Displays a dialog box for selecting an input method. This API uses an asynchronous callback to return the result.
NOTE
This API is supported since API version 9 and deprecated since API version 18.
System capability: SystemCapability.MiscServices.InputMethodFramework
Parameters
Name | Type | Mandatory | Description |
---|---|---|---|
callback | AsyncCallback<boolean> | Yes | Callback used to return the result. If the operation is successful, err is undefined and data is true. Otherwise, err is an error object. |
Error codes
For details about the error codes, see Input Method Framework Error Codes.
ID | Error Message |
---|---|
12800008 | input method manager service error. |
Example
import { BusinessError } from '@kit.BasicServicesKit';
try {
inputMethodSetting.showOptionalInputMethods((err: BusinessError, data: boolean) => {
if (err) {
console.error(`Failed to showOptionalInputMethods: ${JSON.stringify(err)}`);
return;
}
console.info('Succeeded in showing optionalInputMethods.');
});
} catch (err) {
console.error(`Failed to showOptionalInputMethods: ${JSON.stringify(err)}`);
}
showOptionalInputMethods(): Promise<boolean>
Displays a dialog box for selecting an input method. This API uses a promise to return the result.
NOTE
This API is supported since API version 9 and deprecated since API version 18.
System capability: SystemCapability.MiscServices.InputMethodFramework
Return value
Type | Description |
---|---|
Promise<boolean> | Promise used to return the result. If the operation is successful, err is undefined and data is true. Otherwise, err is an error object. |
Error codes
For details about the error codes, see Input Method Framework Error Codes.
ID | Error Message |
---|---|
12800008 | input method manager service error. |
Example
import { BusinessError } from '@kit.BasicServicesKit';
inputMethodSetting.showOptionalInputMethods().then((data: boolean) => {
console.info('Succeeded in showing optionalInputMethods.');
}).catch((err: BusinessError) => {
console.error(`Failed to showOptionalInputMethods: ${JSON.stringify(err)}`);
})
listInputMethod(callback: AsyncCallback<Array<InputMethodProperty>>): void
Obtains a list of installed input methods. This API uses an asynchronous callback to return the result.
NOTE
This API is supported since API version 8 and deprecated since API version 9. You are advised to use getInputMethods instead.
System capability: SystemCapability.MiscServices.InputMethodFramework
Parameters
Name | Type | Mandatory | Description |
---|---|---|---|
callback | AsyncCallback<Array<InputMethodProperty>> | Yes | Callback used to return the list of installed input methods. |
Example
import { BusinessError } from '@kit.BasicServicesKit';
inputMethodSetting.listInputMethod((err: BusinessError, data: Array<inputMethod.InputMethodProperty>) => {
if (err) {
console.error(`Failed to listInputMethod: ${JSON.stringify(err)}`);
return;
}
console.info('Succeeded in listing inputMethod.');
});
listInputMethod(): Promise<Array<InputMethodProperty>>
Obtains a list of installed input methods. This API uses a promise to return the result.
NOTE
This API is supported since API version 8 and deprecated since API version 9. You are advised to use getInputMethods instead.
System capability: SystemCapability.MiscServices.InputMethodFramework
Return value
Type | Description |
---|---|
Promise<Array<InputMethodProperty>> | Promise used to return the list of installed input methods. |
Example
import { BusinessError } from '@kit.BasicServicesKit';
inputMethodSetting.listInputMethod().then((data: Array<inputMethod.InputMethodProperty>) => {
console.info('Succeeded in listing inputMethod.');
}).catch((err: BusinessError) => {
console.error(`Failed to listInputMethod: ${JSON.stringify(err)}`);
})
displayOptionalInputMethod(callback: AsyncCallback<void>): void
Displays a dialog box for selecting an input method. This API uses an asynchronous callback to return the result.
NOTE
This API is supported since API version 8 and deprecated since API version 9.
System capability: SystemCapability.MiscServices.InputMethodFramework
Parameters
Name | Type | Mandatory | Description |
---|---|---|---|
callback | AsyncCallback<void> | Yes | Callback used to return the result. If the operation is successful, err is undefined. Otherwise, err is an error object. |
Example
import { BusinessError } from '@kit.BasicServicesKit';
inputMethodSetting.displayOptionalInputMethod((err: BusinessError) => {
if (err) {
console.error(`Failed to displayOptionalInputMethod: ${JSON.stringify(err)}`);
return;
}
console.info('Succeeded in displaying optionalInputMethod.');
});
displayOptionalInputMethod(): Promise<void>
Displays a dialog box for selecting an input method. This API uses a promise to return the result.
NOTE
This API is supported since API version 8 and deprecated since API version 9.
System capability: SystemCapability.MiscServices.InputMethodFramework
Return value
Type | Description |
---|---|
Promise<void> | Promise that returns no value. |
Example
import { BusinessError } from '@kit.BasicServicesKit';
inputMethodSetting.displayOptionalInputMethod().then(() => {
console.info('Succeeded in displaying optionalInputMethod.');
}).catch((err: BusinessError) => {
console.error(`Failed to displayOptionalInputMethod: ${JSON.stringify(err)}`);
})
getInputMethodState(): Promise<EnabledState>
Obtains the input method state. This API uses a promise to return the result.
System capability: SystemCapability.MiscServices.InputMethodFramework
Return value
Type | Description |
---|---|
Promise<EnabledState> | Promise used to return the result. EnabledState.DISABLED indicates that the input method is disabled, EnabledState.BASIC_MODE indicates that the input method is in basic mode, and EnabledState.FULL_EXPERIENCE_MODE indicates that the input method is in full experience mode. |
Error codes
For details about the error codes, see Input Method Framework Error Codes and Universal Error Codes.
ID | Error Message |
---|---|
12800004 | not an input method application. |
12800008 | input method manager service error. |
Example
import { BusinessError } from '@kit.BasicServicesKit';
inputMethodSetting.getInputMethodState().then((status: inputMethod.EnabledState) => {
console.info(`Succeeded in getInputMethodState, status: ${status}`);
}).catch((err: BusinessError) => {
console.error(`Failed to getInputMethodState: ${JSON.stringify(err)}`);
})
此处可能存在不合适展示的内容,页面不予展示。您可通过相关编辑功能自查并修改。
如您确认内容无涉及 不当用语 / 纯广告导流 / 暴力 / 低俗色情 / 侵权 / 盗版 / 虚假 / 无价值内容或违法国家有关法律法规的内容,可点击提交进行申诉,我们将尽快为您处理。