
HarmonyOS API:@ohos.inputMethodEngine (输入法服务)
版本:v3.1 Beta
@ohos.inputMethodEngine (输入法服务)
KeyboardController
下列API示例中都需使用on('inputStart')回调获取到KeyboardController实例,再通过此实例调用对应方法。
hide9+
hide(callback: AsyncCallback<void>): void
隐藏输入法。使用callback异步回调。
系统能力: SystemCapability.MiscServices.InputMethodFramework
参数:
参数名 | 类型 | 必填 | 说明 |
callback | AsyncCallback<void> | 是 | 回调函数。当输入法隐藏成功,err为undefined,否则为错误对象。 |
错误码:
以下错误码的详细介绍请参见输入法框架错误码。
错误码ID | 错误信息 |
12800003 | Input method client error. |
示例:
hide9+
hide(): Promise<void>
隐藏输入法。使用promise异步回调。
系统能力: SystemCapability.MiscServices.InputMethodFramework
返回值:
类型 | 说明 |
Promise<void> | 无返回结果的Promise对象。 |
错误码:
以下错误码的详细介绍请参见输入法框架错误码。
错误码ID | 错误信息 |
12800003 | Input method client error. |
示例:
hideKeyboard(deprecated)
hideKeyboard(callback: AsyncCallback<void>): void
隐藏输入法。使用callback异步回调。
说明
从API version 8开始支持,API version 9开始废弃, 建议使用hide替代。
系统能力: SystemCapability.MiscServices.InputMethodFramework
参数:
参数名 | 类型 | 必填 | 说明 |
callback | AsyncCallback<void> | 是 | 回调函数。当输入法隐藏成功,err为undefined,否则为错误对象。 |
示例:
hideKeyboard(deprecated)
hideKeyboard(): Promise<void>
隐藏输入法。使用promise异步回调。
说明
从API version 8开始支持,API version 9开始废弃, 建议使用hide替代。
系统能力: SystemCapability.MiscServices.InputMethodFramework
返回值:
类型 | 说明 |
Promise<void> | 无返回结果的Promise对象。 |
示例:
InputClient9+
下列API示例中都需使用on('inputStart')回调获取到InputClient实例,再通过此实例调用对应方法。
sendKeyFunction9+
sendKeyFunction(action:number, callback: AsyncCallback<boolean>): void
发送功能键。使用callback异步回调。
系统能力: SystemCapability.MiscServices.InputMethodFramework
参数:
参数名 | 类型 | 必填 | 说明 |
action | number | 是 | 功能键键值。 当值为0时,表示无效按键; 当值为1时,表示确认键(即回车键)。 |
callback | AsyncCallback<boolean> | 是 | 回调函数。当功能键发送成功,err为undefined,data为true;否则为错误对象。 |
错误码:
以下错误码的详细介绍请参见输入法框架错误码。
错误码ID | 错误信息 |
12800003 | Input method client error. |
示例:
sendKeyFunction9+
sendKeyFunction(action: number): Promise<boolean>
发送功能键。使用promise异步回调。
系统能力: SystemCapability.MiscServices.InputMethodFramework
参数:
参数名 | 类型 | 必填 | 说明 |
action | number | 是 | 功能键键值。 当值为0时,表示无效按键; 当值为1时,表示确认键(即回车键)。 |
返回值:
类型 | 说明 |
Promise<boolean> | Promise对象。返回true表示功能键发送成功;返回false表示功能键发送失败。 |
错误码:
以下错误码的详细介绍请参见输入法框架错误码。
错误码ID | 错误信息 |
12800003 | Input method client error. |
示例:
getForward9+
getForward(length:number, callback: AsyncCallback<string>): void
获取光标前固定长度的文本。使用callback异步回调。
系统能力: SystemCapability.MiscServices.InputMethodFramework
参数:
参数名 | 类型 | 必填 | 说明 |
length | number | 是 | 文本长度。 |
callback | AsyncCallback<string> | 是 | 回调函数。当光标前固定长度的文本获取成功,err为undefined,data为获取到的文本;否则为错误对象。 |
错误码:
以下错误码的详细介绍请参见输入法框架错误码。
错误码ID | 错误信息 |
12800003 | Input method client error. |
12800006 | Input method controller error. |
示例:
getForward9+
getForward(length:number): Promise<string>
获取光标前固定长度的文本。使用promise异步回调。
系统能力: SystemCapability.MiscServices.InputMethodFramework
参数:
参数名 | 类型 | 必填 | 说明 |
length | number | 是 | 文本长度。 |
返回值:
类型 | 说明 |
Promise<string> | Promise对象,返回光标前固定长度的文本。 |
错误码:
以下错误码的详细介绍请参见输入法框架错误码。
错误码ID | 错误信息 |
12800003 | Input method client error. |
12800006 | Input method controller error. |
示例:
getBackward9+
getBackward(length:number, callback: AsyncCallback<string>): void
获取光标后固定长度的文本。使用callback异步回调。
系统能力: SystemCapability.MiscServices.InputMethodFramework
参数:
参数名 | 类型 | 必填 | 说明 |
length | number | 是 | 文本长度。 |
callback | AsyncCallback<string> | 是 | 回调函数。当光标后固定长度的文本获取成功,err为undefined,data为获取到的文本;否则为错误对象。 |
错误码:
以下错误码的详细介绍请参见输入法框架错误码。
错误码ID | 错误信息 |
12800003 | Input method client error. |
12800006 | Input method controller error. |
示例:
getBackward9+
getBackward(length:number): Promise<string>
获取光标后固定长度的文本。使用promise异步回调。
系统能力: SystemCapability.MiscServices.InputMethodFramework
参数:
参数名 | 类型 | 必填 | 说明 |
length | number | 是 | 文本长度。 |
返回值:
类型 | 说明 |
Promise<string> | Promise对象,返回光标后固定长度的文本。 |
错误码:
以下错误码的详细介绍请参见输入法框架错误码。
错误码ID | 错误信息 |
12800003 | Input method client error. |
12800006 | Input method controller error. |
示例:
deleteForward9+
deleteForward(length:number, callback: AsyncCallback<boolean>): void
删除光标前固定长度的文本。使用callback异步回调。
系统能力: SystemCapability.MiscServices.InputMethodFramework
参数:
参数名 | 类型 | 必填 | 说明 |
length | number | 是 | 文本长度。 |
callback | AsyncCallback<boolean> | 是 | 回调函数。当光标前固定长度的文本删除成功,err为undefined,data为true;否则为错误对象。 |
错误码:
以下错误码的详细介绍请参见输入法框架错误码。
错误码ID | 错误信息 |
12800002 | Input method engine error. |
12800003 | Input method client error. |
示例:
deleteForward9+
deleteForward(length:number): Promise<boolean>
删除光标前固定长度的文本。使用promise异步回调。
系统能力: SystemCapability.MiscServices.InputMethodFramework
参数:
参数名 | 类型 | 必填 | 说明 |
length | number | 是 | 文本长度。 |
返回值:
类型 | 说明 |
Promise<boolean> | Promise对象。返回true表示删除光标前固定长度的文本成功;返回false表示删除光标前固定长度的文本失败。 |
错误码:
以下错误码的详细介绍请参见输入法框架错误码。
错误码ID | 错误信息 |
12800002 | Input method engine error. |
12800003 | Input method client error. |
示例:
deleteBackward9+
deleteBackward(length:number, callback: AsyncCallback<boolean>): void
删除光标后固定长度的文本。使用callback异步回调。
系统能力: SystemCapability.MiscServices.InputMethodFramework
参数:
参数名 | 类型 | 必填 | 说明 |
length | number | 是 | 文本长度。 |
callback | AsyncCallback<boolean> | 是 | 回调函数。当光标后固定长度的文本删除成功,err为undefined,data为true;否则为错误对象。 |
错误码:
以下错误码的详细介绍请参见输入法框架错误码。
错误码ID | 错误信息 |
12800002 | Input method engine error. |
12800003 | Input method client error. |
示例:
deleteBackward9+
deleteBackward(length:number): Promise<boolean>
删除光标后固定长度的文本。使用callback异步回调。
系统能力: SystemCapability.MiscServices.InputMethodFramework
参数:
参数名 | 类型 | 必填 | 说明 |
length | number | 是 | 文本长度。 |
返回值:
类型 | 说明 |
Promise<boolean> | Promise对象。返回true表示删除光标后固定长度的文本成功;返回false表示删除光标后固定长度的文本失败。 |
错误码:
以下错误码的详细介绍请参见输入法框架错误码。
错误码ID | 错误信息 |
12800002 | Input method engine error. |
12800003 | Input method client error. |
示例:
insertText9+
insertText(text:string, callback: AsyncCallback<boolean>): void
插入文本。使用callback异步回调。
系统能力: SystemCapability.MiscServices.InputMethodFramework
参数:
参数名 | 类型 | 必填 | 说明 |
text | string | 是 | 文本。 |
callback | AsyncCallback<boolean> | 是 | 回调函数。当文本插入成功,err为undefined,data为true;否则为错误对象。 |
错误码:
以下错误码的详细介绍请参见输入法框架错误码。
错误码ID | 错误信息 |
12800002 | Input method engine error. |
12800003 | Input method client error. |
示例:
insertText9+
insertText(text:string): Promise<boolean>
插入文本。使用promise异步回调。
系统能力: SystemCapability.MiscServices.InputMethodFramework
参数:
参数名 | 类型 | 必填 | 说明 |
text | string | 是 | 文本。 |
返回值:
类型 | 说明 |
Promise<boolean> | Promise对象。返回true表示插入文本成功;返回false表示插入文本失败。 |
错误码:
以下错误码的详细介绍请参见输入法框架错误码。
错误码ID | 错误信息 |
12800002 | Input method engine error. |
12800003 | Input method client error. |
示例:
getEditorAttribute9+
getEditorAttribute(callback: AsyncCallback<EditorAttribute>): void
获取编辑框属性值。使用callback异步回调。
系统能力: SystemCapability.MiscServices.InputMethodFramework
参数:
参数名 | 类型 | 必填 | 说明 |
callback | AsyncCallback<EditorAttribute> | 是 | 回调函数。当编辑框属性值获取成功,err为undefined,data为编辑框属性值;否则为错误对象。 |
错误码:
以下错误码的详细介绍请参见输入法框架错误码。
错误码ID | 错误信息 |
12800003 | Input method client error. |
示例:
getEditorAttribute9+
getEditorAttribute(): Promise<EditorAttribute>
获取编辑框属性值。使用promise异步回调。
系统能力: SystemCapability.MiscServices.InputMethodFramework
返回值:
类型 | 说明 |
Promise<EditorAttribute> | Promise对象,返回编辑框属性值。 |
错误码:
以下错误码的详细介绍请参见输入法框架错误码。
错误码ID | 错误信息 |
12800003 | Input method client error. |
示例:
moveCursor9+
moveCursor(direction: number, callback: AsyncCallback<void>): void
移动光标。使用callback异步回调。
系统能力: SystemCapability.MiscServices.InputMethodFramework
参数:
参数名 | 类型 | 必填 | 说明 |
direction | number | 是 | 光标移动方向。 |
callback | AsyncCallback<void> | 是 | 回调函数。当光标移动成功,err为undefined,否则为错误对象。 |
错误码:
以下错误码的详细介绍请参见输入法框架错误码。
错误码ID | 错误信息 |
12800003 | Input method client error. |
示例:
moveCursor9+
moveCursor(direction: number): Promise<void>
移动光标。使用promise异步回调。
系统能力: SystemCapability.MiscServices.InputMethodFramework
参数:
参数名 | 类型 | 必填 | 说明 |
direction | number | 是 | 光标移动方向。 |
返回值:
类型 | 说明 |
Promise<void> | 无返回结果的Promise对象。 |
错误码:
以下错误码的详细介绍请参见输入法框架错误码。
错误码ID | 错误信息 |
12800003 | Input method client error. |
示例:
EditorAttribute
编辑框属性值。
系统能力: SystemCapability.MiscServices.InputMethodFramework
名称 | 类型 | 可读 | 可写 | 说明 |
enterKeyType | number | 是 | 否 | 编辑框的功能属性。 |
inputPattern | number | 是 | 否 | 编辑框的文本属性。 |
KeyEvent
按键属性值。
系统能力: SystemCapability.MiscServices.InputMethodFramework
名称 | 类型 | 可读 | 可写 | 说明 |
keyCode | number | 是 | 否 | 按键的键值。 |
keyAction | number | 是 | 否 | 按键的状态。 |
TextInputClient(deprecated)
说明
从API version 8开始支持,API version 9开始废弃, 建议使用InputClient替代。
下列API示例中都需使用on('inputStart')回调获取到TextInputClient实例,再通过此实例调用对应方法。
getForward(deprecated)
getForward(length:number, callback: AsyncCallback<string>): void
获取光标前固定长度的文本。使用callback异步回调。
说明
从API version 8开始支持,API version 9开始废弃, 建议使用getForward替代。
系统能力: SystemCapability.MiscServices.InputMethodFramework
参数:
参数名 | 类型 | 必填 | 说明 |
length | number | 是 | 文本长度。 |
callback | AsyncCallback<string> | 是 | 回调函数。当光标前固定长度的文本获取成功,err为undefined,data为获取到的文本;否则为错误对象。 |
示例:
getForward(deprecated)
getForward(length:number): Promise<string>
获取光标前固定长度的文本。使用promise异步回调。
说明
从API version 8开始支持,API version 9开始废弃, 建议使用getForward替代。
系统能力: SystemCapability.MiscServices.InputMethodFramework
参数:
参数名 | 类型 | 必填 | 说明 |
length | number | 是 | 文本长度。 |
返回值:
类型 | 说明 |
Promise<string> | Promise对象,返回光标前固定长度的文本。 |
示例:
getBackward(deprecated)
getBackward(length:number, callback: AsyncCallback<string>): void
获取光标后固定长度的文本。使用callback异步回调。
说明
从API version 8开始支持,API version 9开始废弃, 建议使用getBackward替代。
系统能力: SystemCapability.MiscServices.InputMethodFramework
参数:
参数名 | 类型 | 必填 | 说明 |
length | number | 是 | 文本长度。 |
callback | AsyncCallback<string> | 是 | 回调函数。当光标后固定长度的文本获取成功,err为undefined,data为获取到的文本;否则为错误对象。 |
示例:
getBackward(deprecated)
getBackward(length:number): Promise<string>
获取光标后固定长度的文本。使用promise异步回调。
说明
从API version 8开始支持,API version 9开始废弃, 建议使用getBackward替代。
系统能力: SystemCapability.MiscServices.InputMethodFramework
参数:
参数名 | 类型 | 必填 | 说明 |
length | number | 是 | 文本长度。 |
返回值:
类型 | 说明 |
Promise<string> | Promise对象,返回光标后固定长度的文本。 |
示例:
deleteForward(deprecated)
deleteForward(length:number, callback: AsyncCallback<boolean>): void
删除光标前固定长度的文本。使用callback异步回调。
说明
从API version 8开始支持,API version 9开始废弃, 建议使用deleteForward替代。
系统能力: SystemCapability.MiscServices.InputMethodFramework
参数:
参数名 | 类型 | 必填 | 说明 |
length | number | 是 | 文本长度。 |
callback | AsyncCallback<boolean> | 是 | 回调函数。当光标前固定长度的文本删除成功,err为undefined,data为true;否则为错误对象。 |
示例:
deleteForward(deprecated)
deleteForward(length:number): Promise<boolean>
删除光标前固定长度的文本。使用promise异步回调。
说明
从API version 8开始支持,API version 9开始废弃, 建议使用deleteForward替代。
系统能力: SystemCapability.MiscServices.InputMethodFramework
参数:
参数名 | 类型 | 必填 | 说明 |
length | number | 是 | 文本长度。 |
返回值:
类型 | 说明 |
Promise<boolean> | Promise对象。返回true表示删除光标前固定长度的文本成功;返回false表示删除光标前固定长度的文本失败。 |
示例:
deleteBackward(deprecated)
deleteBackward(length:number, callback: AsyncCallback<boolean>): void
删除光标后固定长度的文本。使用callback异步回调。
说明
从API version 8开始支持,API version 9开始废弃, 建议使用deleteBackward替代。
系统能力: SystemCapability.MiscServices.InputMethodFramework
参数:
参数名 | 类型 | 必填 | 说明 |
length | number | 是 | 文本长度。 |
callback | AsyncCallback<boolean> | 是 | 回调函数。当光标后固定长度的文本删除成功,err为undefined,data为true;否则为错误对象。 |
示例:
deleteBackward(deprecated)
deleteBackward(length:number): Promise<boolean>
删除光标后固定长度的文本。使用callback异步回调。
说明
从API version 8开始支持,API version 9开始废弃, 建议使用deleteBackward替代。
系统能力: SystemCapability.MiscServices.InputMethodFramework
参数:
参数名 | 类型 | 必填 | 说明 |
length | number | 是 | 文本长度。 |
返回值:
类型 | 说明 |
Promise<boolean> | Promise对象。返回true表示删除光标后固定长度的文本成功;返回false表示删除光标后固定长度的文本失败。 |
示例:
sendKeyFunction(deprecated)
sendKeyFunction(action: number, callback: AsyncCallback<boolean>): void
发送功能键。使用callback异步回调。
说明
从API version 8开始支持,API version 9开始废弃, 建议使用sendKeyFunction替代。
系统能力: SystemCapability.MiscServices.InputMethodFramework
参数:
参数名 | 类型 | 必填 | 说明 |
action | number | 是 | 功能键键值。 当值为0时,表示无效按键; 当值为1时,表示确认键(即回车键)。 |
callback | AsyncCallback<boolean> | 是 | 回调函数。当功能键发送成功,err为undefined,data为true;否则为错误对象。 |
示例:
sendKeyFunction(deprecated)
sendKeyFunction(action: number): Promise<boolean>
发送功能键。使用promise异步回调。
说明
从API version 8开始支持,API version 9开始废弃, 建议使用sendKeyFunction替代。
系统能力: SystemCapability.MiscServices.InputMethodFramework
参数:
参数名 | 类型 | 必填 | 说明 |
action | number | 是 | 功能键键值。 当值为0时,表示无效按键; 当值为1时,表示确认键(即回车键)。 |
返回值:
类型 | 说明 |
Promise<boolean> | Promise对象。返回true表示发送功能键成功;返回false表示发送功能键失败。 |
示例:
insertText(deprecated)
insertText(text:string, callback: AsyncCallback<boolean>): void
插入文本。使用callback异步回调。
说明
从API version 8开始支持,API version 9开始废弃, 建议使用insertText替代。
系统能力: SystemCapability.MiscServices.InputMethodFramework
参数:
参数名 | 类型 | 必填 | 说明 |
text | string | 是 | 文本。 |
callback | AsyncCallback<boolean> | 是 | 回调函数。当文本插入成功,err为undefined,data为true;否则为错误对象。 |
示例:
insertText(deprecated)
insertText(text:string): Promise<boolean>
插入文本。使用promise异步回调。
说明
从API version 8开始支持,API version 9开始废弃, 建议使用insertText替代。
系统能力: SystemCapability.MiscServices.InputMethodFramework
参数:
参数名 | 类型 | 必填 | 说明 |
text | string | 是 | 文本。 |
返回值:
类型 | 说明 |
Promise<boolean> | Promise对象。返回true表示插入文本成功;返回false表示插入文本失败。 |
示例:
getEditorAttribute(deprecated)
getEditorAttribute(callback: AsyncCallback<EditorAttribute>): void
获取编辑框属性值。使用callback异步回调。
说明
从API version 8开始支持,API version 9开始废弃, 建议使用getEditorAttribute替代。
系统能力: SystemCapability.MiscServices.InputMethodFramework
参数:
参数名 | 类型 | 必填 | 说明 |
callback | AsyncCallback<EditorAttribute> | 是 | 回调函数。当编辑框的属性值获取成功,err为undefined,data为编辑框属性值;否则为错误对象。 |
示例:
getEditorAttribute(deprecated)
getEditorAttribute(): Promise<EditorAttribute>
获取编辑框属性值。使用promise异步回调。
说明
从API version 8开始支持,API version 9开始废弃, 建议使用getEditorAttribute替代。
系统能力: SystemCapability.MiscServices.InputMethodFramework
返回值:
类型 | 说明 |
Promise<EditorAttribute> | Promise对象,返回编辑框属性值。 |
示例:
