@ohos.inputMethodEngine (输入法服务)

本模块面向输入法应用（包括系统输入法应用、三方输入法应用），为输入法应用提供能力，功能包括：创建软键盘窗口、插入/删除字符、选中文本、物理键盘按键事件监听等。

说明：

本模块首批接口从API version 8开始支持。后续版本的新增接口，采用上角标单独标记接口的起始版本。

导入模块

import inputMethodEngine from '@ohos.inputMethodEngine';

常量

功能键常量值、编辑框常量值及光标常量值。

系统能力： SystemCapability.MiscServices.InputMethodFramework

名称 类型 值 说明
ENTER_KEY_TYPE_UNSPECIFIED number 0 无功能键。
ENTER_KEY_TYPE_GO number 2 “前往”功能键。
ENTER_KEY_TYPE_SEARCH number 3 “搜索”功能键。
ENTER_KEY_TYPE_SEND number 4 “发送”功能键。
ENTER_KEY_TYPE_NEXT number 5 “下一个”功能键。
ENTER_KEY_TYPE_DONE number 6 “回车”功能键。
ENTER_KEY_TYPE_PREVIOUS number 7 “前一个”功能键。
PATTERN_NULL number -1 无特殊性编辑框。
PATTERN_TEXT number 0 文本编辑框。
PATTERN_NUMBER number 2 数字编辑框。
PATTERN_PHONE number 3 电话号码编辑框。
PATTERN_DATETIME number 4 日期编辑框。
PATTERN_EMAIL number 5 邮件编辑框。
PATTERN_URI number 6 超链接编辑框。
PATTERN_PASSWORD number 7 密码编辑框。
OPTION_ASCII number 20 允许输入ASCII值。
OPTION_NONE number 0 不指定编辑框输入属性。
OPTION_AUTO_CAP_CHARACTERS number 2 允许输入字符。
OPTION_AUTO_CAP_SENTENCES number 8 允许输入句子。
OPTION_AUTO_WORDS number 4 允许输入单词。
OPTION_MULTI_LINE number 1 允许输入多行。
OPTION_NO_FULLSCREEN number 10 半屏样式。
FLAG_SELECTING number 2 编辑框处于选择状态。
FLAG_SINGLE_LINE number 1 编辑框为单行。
DISPLAY_MODE_PART number 0 编辑框显示为半屏。
DISPLAY_MODE_FULL number 1 编辑框显示为全屏。
CURSOR_UP9+ number 1 光标上移。
CURSOR_DOWN9+ number 2 光标下移。
CURSOR_LEFT9+ number 3 光标左移。
CURSOR_RIGHT9+ number 4 光标右移。
WINDOW_TYPE_INPUT_METHOD_FLOAT9+ number 2105 输入法应用窗口风格标识。

inputMethodEngine.getInputMethodAbility9+

getInputMethodAbility(): InputMethodAbility

为输入法应用获取输入法应用客户端实例InputMethodAbility。输入法应用获取该实例可订阅软键盘显示/隐藏请求事件等。

系统能力： SystemCapability.MiscServices.InputMethodFramework

返回值：

类型 说明
InputMethodAbility 输入法应用客户端。

示例：

let InputMethodAbility = inputMethodEngine.getInputMethodAbility();

inputMethodEngine.getKeyboardDelegate9+

getKeyboardDelegate(): KeyboardDelegate

为输入法应用获取客户端编辑事件监听代理实例KeyboardDelegate。输入法应用获取该实例可订阅物理键盘按键事件、选中文本变化事件等。

系统能力： SystemCapability.MiscServices.InputMethodFramework

返回值：

类型 说明
KeyboardDelegate 客户端编辑事件监听代理。

示例：

let KeyboardDelegate = inputMethodEngine.getKeyboardDelegate();

inputMethodEngine.getInputMethodEngine(deprecated)

getInputMethodEngine(): InputMethodEngine

为输入法应用获取输入法应用客户端实例InputMethodEngine。输入法应用获取该实例可订阅软键盘显示/隐藏请求事件等。

说明：

从API version 8开始支持，API version 9开始废弃, 建议使用getInputMethodAbility()替代。

系统能力： SystemCapability.MiscServices.InputMethodFramework

返回值：

类型 说明
InputMethodEngine 输入法应用客户端。

示例：

let InputMethodEngine = inputMethodEngine.getInputMethodEngine();

inputMethodEngine.createKeyboardDelegate(deprecated)

createKeyboardDelegate(): KeyboardDelegate

为输入法应用获取客户端编辑事件监听代理实例KeyboardDelegate。输入法应用获取该实例可订阅物理键盘按键事件、选中文本变化事件等。

说明：

从API version 8开始支持，API version 9开始废弃, 建议使用getKeyboardDelegate()替代。

系统能力： SystemCapability.MiscServices.InputMethodFramework

返回值：

类型 说明
KeyboardDelegate 客户端编辑事件监听代理。

示例：

let keyboardDelegate = inputMethodEngine.createKeyboardDelegate();

InputMethodEngine

下列API示例中都需使用getInputMethodEngine回调获取到InputMethodEngine实例，再通过此实例调用对应方法。

on('inputStart')

on(type: 'inputStart', callback: (kbController: KeyboardController, textInputClient: TextInputClient) => void): void

订阅输入法绑定成功事件。使用callback异步回调。

系统能力： SystemCapability.MiscServices.InputMethodFramework

参数：

参数名 类型 必填 说明
type string 是 设置监听类型。
- type为‘inputStart’时表示订阅输入法绑定。
callback (kbController: KeyboardController, textInputClient: TextInputClient) => void 是 回调函数，返回订阅输入法的KeyboardController和TextInputClient实例。

示例：

inputMethodEngine.getInputMethodEngine().on('inputStart', (kbController, textClient) => {
    let keyboardController = kbController;
    let textInputClient = textClient;
});

off('inputStart')

off(type: 'inputStart', callback?: (kbController: KeyboardController, textInputClient: TextInputClient) => void): void

取消订阅输入法绑定成功事件。

系统能力： SystemCapability.MiscServices.InputMethodFramework

参数：

参数名 类型 必填 说明
type string 是 设置监听类型。
- type为‘inputStart’时表示订阅输入法绑定。
callback (kbController: KeyboardController, textInputClient: TextInputClient) => void 否 回调函数，返回取消订阅的KeyboardController和TextInputClient实例。

示例：

inputMethodEngine.getInputMethodEngine().off('inputStart', (kbController, textInputClient) => {
    console.log('delete inputStart notification.');
});

on('keyboardShow'|'keyboardHide')

on(type: 'keyboardShow'|'keyboardHide', callback: () => void): void

订阅输入法事件。使用callback异步回调。

系统能力： SystemCapability.MiscServices.InputMethodFramework

参数：

参数名 类型 必填 说明
type string 是 设置监听类型。
- type为'keyboardShow'，表示订阅输入法显示。
- type为'keyboardHide'，表示订阅输入法隐藏。
callback () => void 是 回调函数。

示例：

inputMethodEngine.getInputMethodEngine().on('keyboardShow', () => {
    console.log('inputMethodEngine keyboardShow.');
});
inputMethodEngine.getInputMethodEngine().on('keyboardHide', () => {
    console.log('inputMethodEngine keyboardHide.');
});

off('keyboardShow'|'keyboardHide')

off(type: 'keyboardShow'|'keyboardHide', callback?: () => void): void

取消订阅输入法事件。使用callback异步回调。

系统能力： SystemCapability.MiscServices.InputMethodFramework

参数：

参数名 类型 必填 说明
type string 是 设置监听类型。
- type为'keyboardShow'，表示订阅输入法显示。
- type为'keyboardHide'，表示订阅输入法隐藏。
callback () => void 否 回调函数。

示例：

inputMethodEngine.getInputMethodEngine().off('keyboardShow');
inputMethodEngine.getInputMethodEngine().off('keyboardHide');

InputMethodAbility

下列API示例中都需使用getInputMethodAbility回调获取到InputMethodAbility实例，再通过此实例调用对应方法。

on('inputStart')9+

on(type: 'inputStart', callback: (kbController: KeyboardController, inputClient: InputClient) => void): void

订阅输入法绑定成功事件。使用callback异步回调。

系统能力： SystemCapability.MiscServices.InputMethodFramework

参数：

参数名 类型 必填 说明
type string 是 设置监听类型。
- type为‘inputStart’时表示订阅输入法绑定。
callback (kbController: KeyboardController, inputClient: InputClient) => void 是 回调函数，返回输入法操作相关实例。

示例：

inputMethodEngine.getInputMethodAbility().on('inputStart', (kbController, client) => {
    let keyboardController = kbController;
    let inputClient = client;
});

off('inputStart')9+

off(type: 'inputStart', callback?: (kbController: KeyboardController, inputClient: InputClient) => void): void

取消订阅输入法绑定成功事件。使用callback异步回调。

系统能力： SystemCapability.MiscServices.InputMethodFramework

参数：

参数名 类型 必填 说明
type string 是 设置监听类型。
- type为‘inputStart’时表示订阅输入法绑定。
callback (kbController: KeyboardController, inputClient: InputClient) => void 否 回调函数，返回输入法操作相关实例。

示例：

inputMethodEngine.getInputMethodAbility().off('inputStart');

on('inputStop')9+

on(type: 'inputStop', callback: () => void): void

订阅停止输入法应用事件。使用callback异步回调。

系统能力： SystemCapability.MiscServices.InputMethodFramework

参数：

参数名 类型 必填 说明
type string 是 设置监听类型。
- type为‘inputStop’时表示订阅停止输入法应用事件。
callback () => void 是 回调函数。

示例：

inputMethodEngine.getInputMethodAbility().on('inputStop', () => {
    console.log('inputMethodAbility inputStop');
});

off('inputStop')9+

off(type: 'inputStop', callback: () => void): void

取消订阅停止输入法应用事件。使用callback异步回调。

系统能力： SystemCapability.MiscServices.InputMethodFramework

参数：

参数名 类型 必填 说明
type string 是 设置监听类型。
- type为‘inputStop’时表示订阅停止输入法应用事件。
callback () => void 是 回调函数。

示例：

inputMethodEngine.getInputMethodAbility().off('inputStop', () => {
    console.log('inputMethodAbility delete inputStop notification.');
});

on('setCallingWindow')9+

on(type: 'setCallingWindow', callback: (wid: number) => void): void

订阅设置调用窗口事件。使用callback异步回调。

系统能力： SystemCapability.MiscServices.InputMethodFramework

参数：

参数名 类型 必填 说明
type string 是 设置监听类型。
- type为‘setCallingWindow’时表示订阅设置调用窗口事件。
callback (wid: number) => void 是 回调函数，返回调用方window id。

示例：

inputMethodEngine.getInputMethodAbility().on('setCallingWindow', (wid) => {
    console.log('inputMethodAbility setCallingWindow');
});

off('setCallingWindow')9+

off(type: 'setCallingWindow', callback: (wid:number) => void): void

取消订阅设置调用窗口事件。使用callback异步回调。

系统能力： SystemCapability.MiscServices.InputMethodFramework

参数：

参数名 类型 必填 说明
type string 是 设置监听类型。
- type为‘setCallingWindow’时表示订阅设置调用窗口事件。
callback (wid:number) => void 是 回调函数，返回调用方window id。

示例：

inputMethodEngine.getInputMethodAbility().off('setCallingWindow', () => {
    console.log('inputMethodAbility delete setCallingWindow notification.');
});

on('keyboardShow'|'keyboardHide')9+

on(type: 'keyboardShow'|'keyboardHide', callback: () => void): void

订阅输入法事件。使用callback异步回调。

系统能力： SystemCapability.MiscServices.InputMethodFramework

参数：

参数名 类型 必填 说明
type string 是 设置监听类型。
- type为'keyboardShow'，表示订阅显示键盘事件。
- type为'keyboardHide'，表示订阅隐藏键盘事件。
callback () => void 是 回调函数。

示例：

inputMethodEngine.getInputMethodAbility().on('keyboardShow', () => {
    console.log('InputMethodAbility keyboardShow.');
});
inputMethodEngine.getInputMethodAbility().on('keyboardHide', () => {
    console.log('InputMethodAbility keyboardHide.');
});

off('keyboardShow'|'keyboardHide')9+

off(type: 'keyboardShow'|'keyboardHide', callback?: () => void): void

取消订阅输入法事件。使用callback异步回调。

系统能力： SystemCapability.MiscServices.InputMethodFramework

参数：

参数名 类型 必填 说明
type string 是 设置监听类型。
- type为'keyboardShow'，表示取消订阅显示键盘事件。
- type为'keyboardHide'，表示取消订阅隐藏键盘事件。
callback () => void 否 回调函数。

示例：

inputMethodEngine.getInputMethodAbility().off('keyboardShow', () => {
    console.log('InputMethodAbility delete keyboardShow notification.');
});
inputMethodEngine.getInputMethodAbility().off('keyboardHide', () => {
    console.log('InputMethodAbility delete keyboardHide notification.');
});

on('setSubtype')9+

on(type: 'setSubtype', callback: (inputMethodSubtype: InputMethodSubtype) => void): void

订阅设置输入法子类型事件。使用callback异步回调。

系统能力： SystemCapability.MiscServices.InputMethodFramework

参数：

参数名 类型 必填 说明
type string 是 设置监听类型。
- type为'setSubtype'，表示订阅输入法子类型的设置事件。
callback (inputMethodSubtype: InputMethodSubtype) => void 是 回调函数，返回设置的输入法子类型。

示例：

inputMethodEngine.getInputMethodAbility().on('setSubtype', (inputMethodSubtype) => {
    console.log('InputMethodAbility setSubtype.');
});

off('setSubtype')9+

off(type: 'setSubtype', callback?: (inputMethodSubtype: InputMethodSubtype) => void): void

取消订阅输入法子类型事件。使用callback异步回调。

系统能力： SystemCapability.MiscServices.InputMethodFramework

参数：

参数名 类型 必填 说明
type string 是 设置监听类型。
- type为'setSubtype'，表示取消订阅输入法子类型的设置事件。
callback (inputMethodSubtype: InputMethodSubtype) => void 否 回调函数，返回设置的输入法子类型。

示例：

inputMethodEngine.getInputMethodAbility().off('setSubtype', () => {
    console.log('InputMethodAbility delete setSubtype notification.');
});

KeyboardDelegate

下列API示例中都需使用getKeyboardDelegate回调获取到KeyboardDelegate实例，再通过此实例调用对应方法。

on('keyDown'|'keyUp')

on(type: 'keyDown'|'keyUp', callback: (event: KeyEvent) => boolean): void

订阅硬键盘（即物理键盘）事件。使用callback异步回调。

系统能力： SystemCapability.MiscServices.InputMethodFramework

参数：

参数名 类型 必填 说明
type string 是 设置监听类型。
- type为'keyDown'，表示订阅硬键盘按下事件。
- type为'keyUp'，表示订阅硬键盘抬起事件。
callback (event: KeyEvent) => boolean 是 回调函数，返回按键信息。

示例：

inputMethodEngine.getKeyboardDelegate().on('keyUp', (keyEvent) => {
    console.info('inputMethodEngine keyCode.(keyUp):' + JSON.stringify(keyEvent.keyCode));
    console.info('inputMethodEngine keyAction.(keyUp):' + JSON.stringify(keyEvent.keyAction));
    return true;
});
inputMethodEngine.getKeyboardDelegate().on('keyDown', (keyEvent) => {
    console.info('inputMethodEngine keyCode.(keyDown):' + JSON.stringify(keyEvent.keyCode));
    console.info('inputMethodEngine keyAction.(keyDown):' + JSON.stringify(keyEvent.keyAction));
    return true;
});

off('keyDown'|'keyUp')

off(type: 'keyDown'|'keyUp', callback?: (event: KeyEvent) => boolean): void

取消订阅硬键盘（即物理键盘）事件。使用callback异步回调。

系统能力： SystemCapability.MiscServices.InputMethodFramework

参数：

参数名 类型 必填 说明
type string 是 设置监听类型。
- type为'keyDown'，表示取消订阅硬键盘按下事件。
- type为'keyUp'，表示取消订阅硬键盘抬起事件。
callback (event: KeyEvent) => boolean 否 回调函数，返回按键信息。

示例：

inputMethodEngine.getKeyboardDelegate().off('keyUp', (keyEvent) => {
    console.log('delete keyUp notification.');
    return true;
});
inputMethodEngine.getKeyboardDelegate().off('keyDown', (keyEvent) => {
    console.log('delete keyDown notification.');
    return true;
});

on('cursorContextChange')

on(type: 'cursorContextChange', callback: (x: number, y:number, height:number) => void): void

订阅光标变化事件。使用callback异步回调。

系统能力： SystemCapability.MiscServices.InputMethodFramework

参数：

参数名 类型 必填 说明
type string 是 光标变化事件。
- type为’cursorContextChange‘时，表示订阅光标变化事件。
callback (x: number, y: number, height: number) => void 是 回调函数，返回光标信息。
- x为光标上端的的x坐标值。
- y为光标上端的y坐标值。
- height为光标的高度值。

示例：

inputMethodEngine.getKeyboardDelegate().on('cursorContextChange', (x, y, height) => {
    console.log('inputMethodEngine cursorContextChange x:' + x);
    console.log('inputMethodEngine cursorContextChange y:' + y);
    console.log('inputMethodEngine cursorContextChange height:' + height);
});

off('cursorContextChange')

off(type: 'cursorContextChange', callback?: (x: number, y: number, height: number) => void): void

取消订阅光标变化事件。使用callback异步回调。

系统能力： SystemCapability.MiscServices.InputMethodFramework

参数：

参数名 类型 必填 说明
type string 是 光标变化事件。
- type为’cursorContextChange‘时，表示光标变化。
callback (x: number, y:number, height:number) => void 否 回调函数，返回光标信息。
- x为光标上端的的x坐标值。
- y为光标上端的y坐标值。
- height为光标的高度值。

示例：

inputMethodEngine.getKeyboardDelegate().off('cursorContextChange', (x, y, height) => {
    console.log('delete cursorContextChange notification.');
});

on('selectionChange')

on(type: 'selectionChange', callback: (oldBegin: number, oldEnd: number, newBegin: number, newEnd: number) => void): void

订阅文本选择变化事件。使用callback异步回调。

系统能力： SystemCapability.MiscServices.InputMethodFramework

参数：

参数名 类型 必填 说明
type string 是 文本选择变化事件。
- type为’selectionChange‘时，表示选择文本变化。
callback (oldBegin: number, oldEnd: number, newBegin: number, newEnd: number) => void 是 回调函数，返回文本选择信息。
- oldBegin为变化之前被选中文本的起始下标。
- oldEnd为变化之前被选中文本的终止下标。
- newBegin为变化之后被选中文本的起始下标。
- newEnd为变化之后被选中文本的终止下标。

示例：

inputMethodEngine.getKeyboardDelegate().on('selectionChange', (oldBegin, oldEnd, newBegin, newEnd) => {
    console.log('inputMethodEngine beforeEach selectionChange oldBegin:' + oldBegin);
    console.log('inputMethodEngine beforeEach selectionChange oldEnd:' + oldEnd);
    console.log('inputMethodEngine beforeEach selectionChange newBegin:' + newBegin);
    console.log('inputMethodEngine beforeEach selectionChange newEnd:' + newEnd);
});

off('selectionChange')

off(type: 'selectionChange', callback?: (oldBegin: number, oldEnd: number, newBegin: number, newEnd: number) => void): void

取消订阅文本选择变化事件。使用callback异步回调。

系统能力： SystemCapability.MiscServices.InputMethodFramework

参数：

参数名 类型 必填 说明
type string 是 文本选择变化事件。
- type为’selectionChange‘时，表示选择文本变化。
callback (oldBegin: number, oldEnd: number, newBegin: number, newEnd: number) => void 否 回调函数，返回文本选择信息。
- oldBegin为变化之前被选中文本的起始下标。
- oldEnd为变化之前被选中文本的终止下标。
- newBegin为变化之后被选中文本的起始下标。
- newEnd为变化之后被选中文本的终止下标。

示例：

inputMethodEngine.getKeyboardDelegate().off('selectionChange', (oldBegin, oldEnd, newBegin, newEnd) => {
  console.log('delete selectionChange notification.');
});

on('textChange')

on(type: 'textChange', callback: (text: string) => void): void

订阅文本变化事件。使用callback异步回调。

系统能力： SystemCapability.MiscServices.InputMethodFramework

参数：

参数名 类型 必填 说明
type string 是 文本变化事件。
- type为’textChange‘时，表示订阅文本变化事件。
callback (text: string) => void 是 回调函数，返回订阅的文本内容。

示例：

inputMethodEngine.getKeyboardDelegate().on('textChange', (text) => {
    console.log('inputMethodEngine textChange. text:' + text);
});

off('textChange')

off(type: 'textChange', callback?: (text: string) => void): void

取消订阅文本变化事件。使用callback异步回调。

系统能力： SystemCapability.MiscServices.InputMethodFramework

参数：

参数名 类型 必填 说明
type string 是 文本变化事件。
- type为’textChange‘时，表示取消订阅文本变化事件。
callback (text: string) => void 否 回调函数，返回取消订阅的文本内容。

示例：

inputMethodEngine.getKeyboardDelegate().off('textChange', (text) => {
    console.log('delete textChange notification. text:' + text);
});

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.

示例：

keyboardController.hide((err) => {
    if (err !== undefined) {
        console.error('Failed to hide keyboard: ' + JSON.stringify(err));
        return;
    }
    console.log('Succeeded in hiding keyboard.');
});

hide9+

hide(): Promise<void>

隐藏输入法。使用promise异步回调。

系统能力： SystemCapability.MiscServices.InputMethodFramework

返回值：

类型 说明
Promise<void> 无返回结果的Promise对象。

错误码：

以下错误码的详细介绍请参见输入法框架错误码。

错误码ID 错误信息
12800003 input method client error.

示例：

keyboardController.hide().then(() => {
    console.info('Succeeded in hiding keyboard.');
}).catch((err) => {
    console.info('Failed to hide keyboard: ' + JSON.stringify(err));
});

hideKeyboard(deprecated)

hideKeyboard(callback: AsyncCallback<void>): void

隐藏输入法。使用callback异步回调。

说明：

从API version 8开始支持，API version 9开始废弃, 建议使用hide替代。

系统能力： SystemCapability.MiscServices.InputMethodFramework

参数：

参数名 类型 必填 说明
callback AsyncCallback<void> 是 回调函数。当输入法隐藏成功，err为undefined，否则为错误对象。

示例：

keyboardController.hideKeyboard((err) => {
    if (err !== undefined) {
        console.error('Failed to hide Keyboard: ' + JSON.stringify(err));
        return;
    }
    console.log('Succeeded in hiding keyboard.');
});

hideKeyboard(deprecated)

hideKeyboard(): Promise<void>

隐藏输入法。使用promise异步回调。

说明：

从API version 8开始支持，API version 9开始废弃, 建议使用hide替代。

系统能力： SystemCapability.MiscServices.InputMethodFramework

返回值：

类型 说明
Promise<void> 无返回结果的Promise对象。

示例：

keyboardController.hideKeyboard().then(() => {
    console.info('Succeeded in hiding keyboard.');
}).catch((err) => {
    console.info('Failed to hide Keyboard: ' + JSON.stringify(err));
});

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.

示例：

let action = 1;
try {
    inputClient.sendKeyFunction(action, (err, result) => {
        if (err !== undefined) {
            console.error('Failed to sendKeyFunction: ' + JSON.stringify(err));
            return;
        }
        if (result) {
            console.info('Succeeded in sending key function. ');
        } else {
            console.error('Failed to sendKeyFunction. ');
        }
    });
} catch (err) {
    console.error('sendKeyFunction err: ' + JSON.stringify(err));
}

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.

示例：

let action = 1;
try {
    inputClient.sendKeyFunction(action).then((result) => {
        if (result) {
            console.info('Succeeded in sending key function. ');
        } else {
            console.error('Failed to sendKeyFunction. ');
        }
    }).catch((err) => {
        console.error('Failed to sendKeyFunction:' + JSON.stringify(err));
    });
} catch (err) {
    console.error('Failed to sendKeyFunction: ' + JSON.stringify(err));
}

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.

示例：

let length = 1;
try {
    inputClient.getForward(length, (err, text) => {
        if (err !== undefined) {
            console.error('Failed to getForward: ' + JSON.stringify(err));
            return;
        }
        console.log('Succeeded in getting forward, text: ' + text);
    });
} catch (err) {
    console.error('Failed to getForward: ' + JSON.stringify(err));
}

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.

示例：

let length = 1;
try {
    inputClient.getForward(length).then((text) => {
        console.info('Succeeded in getting forward, text: ' + text);
    }).catch((err) => {
        console.error('Failed to getForward: ' + JSON.stringify(err));
    });
} catch (err) {
    console.error('Failed to getForward: ' + JSON.stringify(err));
}

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.

示例：

let length = 1;
try {
    inputClient.getBackward(length, (err, text) => {
        if (err !== undefined) {
            console.error('Failed to getForward: ' + JSON.stringify(err));
            return;
        }
        console.log('Succeeded in getting backward, text: ' + text);
    });
} catch (err) {
    console.error('Failed to getForward: ' + JSON.stringify(err));
}

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.

示例：

let length = 1;
try {
    inputClient.getBackward(length).then((text) => {
        console.info('Succeeded in getting backward, text: ' + text);
    }).catch((err) => {
        console.error('Failed to getForward: ' + JSON.stringify(err));
    });
} catch (err) {
    console.error('Failed to getForward: ' + JSON.stringify(err));
}

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.

示例：

let length = 1;
try {
    inputClient.deleteForward(length, (err, result) => {
        if (err !== undefined) {
            console.error('Failed to delete forward: ' + JSON.stringify(err));
            return;
        }
        if (result) {
            console.info('Succeeded in deleting forward. ');
        } else {
            console.error('Failed to delete forward: ' + JSON.stringify(err));
        }
    });
} catch (err) {
    console.error('Failed to delete forward: ' + JSON.stringify(err));
}

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.

示例：

let length = 1;
try {
    inputClient.deleteForward(length).then((result) => {
        if (result) {
            console.info('Succeeded in deleting forward. ');
        } else {
            console.error('Failed to delete Forward. ');
        }
    }).catch((err) => {
        console.error('Failed to delete Forward: ' + JSON.stringify(err));
    });
} catch (err) {
    console.error('Failed to delete Forward: ' + JSON.stringify(err));
}

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.

示例：

let length = 1;
try {
    inputClient.deleteBackward(length, (err, result) => {
        if (err !== undefined) {
            console.error('Failed to delete Backward: ' + JSON.stringify(err));
            return;
        }
        if (result) {
            console.info('Succeeded in deleting backward. ');
        } else {
            console.error('Failed to delete Backward: ' + JSON.stringify(err));
        }
    });
} catch (err) {
    console.error('deleteBackward err: ' + JSON.stringify(err));
}

deleteBackward9+

deleteBackward(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.

示例：

let length = 1;
inputClient.deleteBackward(length).then((result) => {
    if (result) {
        console.info('Succeeded in deleting backward. ');
    } else {
        console.error('Failed to deleteBackward. ');
    }
}).catch((err) => {
    console.error('Failed to deleteBackward: ' + JSON.stringify(err));
});

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.

示例：

inputClient.insertText('test', (err, result) => {
    if (err !== undefined) {
        console.error('Failed to insertText: ' + JSON.stringify(err));
        return;
    }
    if (result) {
        console.info('Succeeded in inserting text. ');
    } else {
        console.error('Failed to insertText. ');
    }
});

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.

示例：

try {
    inputClient.insertText('test').then((result) => {
        if (result) {
            console.info('Succeeded in inserting text. ');
        } else {
            console.error('Failed to insertText. ');
        }
    }).catch((err) => {
        console.error('Failed to insertText: ' + JSON.stringify(err));
    });
} catch (err) {
    console.error('Failed to insertText: ' + JSON.stringify(err));
}

getEditorAttribute9+

getEditorAttribute(callback: AsyncCallback<EditorAttribute>): void

获取编辑框属性值。使用callback异步回调。

系统能力： SystemCapability.MiscServices.InputMethodFramework

参数：

参数名 类型 必填 说明
callback AsyncCallback<EditorAttribute> 是 回调函数。当编辑框属性值获取成功，err为undefined，data为编辑框属性值；否则为错误对象。

错误码：

以下错误码的详细介绍请参见输入法框架错误码。

错误码ID 错误信息
12800003 input method client error.

示例：

inputClient.getEditorAttribute((err, editorAttribute) => {
    if (err !== undefined) {
        console.error('Failed to getEditorAttribute: ' + JSON.stringify(err));
        return;
    }
    console.log('editorAttribute.inputPattern: ' + JSON.stringify(editorAttribute.inputPattern));
    console.log('editorAttribute.enterKeyType: ' + JSON.stringify(editorAttribute.enterKeyType));
});

getEditorAttribute9+

getEditorAttribute(): Promise<EditorAttribute>

获取编辑框属性值。使用promise异步回调。

系统能力： SystemCapability.MiscServices.InputMethodFramework

返回值：

类型 说明
Promise<EditorAttribute> Promise对象，返回编辑框属性值。

错误码：

以下错误码的详细介绍请参见输入法框架错误码。

错误码ID 错误信息
12800003 input method client error.

示例：

inputClient.getEditorAttribute().then((editorAttribute) => {
    console.info('editorAttribute.inputPattern: ' + JSON.stringify(editorAttribute.inputPattern));
    console.info('editorAttribute.enterKeyType: ' + JSON.stringify(editorAttribute.enterKeyType));
}).catch((err) => {
    console.error('Failed to getEditorAttribute: ' + JSON.stringify(err));
});

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.

示例：

try {
    inputClient.moveCursor(inputMethodEngine.CURSOR_UP, (err) => {
        if (err !== undefined) {
            console.error('Failed to moveCursor: ' + JSON.stringify(err));
            return;
        }
        console.info('Succeeded in moving cursor.');
    });
} catch (err) {
    console.error('Failed to moveCursor: ' + JSON.stringify(err));
}

moveCursor9+

moveCursor(direction: number): Promise<void>

移动光标。使用promise异步回调。

系统能力： SystemCapability.MiscServices.InputMethodFramework

参数：

参数名 类型 必填 说明
direction number 是 光标移动方向。

返回值：

类型 说明
Promise<void> 无返回结果的Promise对象。

错误码：

以下错误码的详细介绍请参见输入法框架错误码。

错误码ID 错误信息
12800003 input method client error.

示例：

try {
    inputClient.moveCursor(inputMethodEngine.CURSOR_UP).then(() => {
        console.log('Succeeded in moving cursor.');
    }).catch((err) => {
        console.error('Failed to moveCursor: ' + JSON.stringify(err));
    });
} catch (err) {
    console.log('Failed to moveCursor: ' + JSON.stringify(err));
}

EditorAttribute

编辑框属性值。

系统能力： SystemCapability.MiscServices.InputMethodFramework

名称 类型 可读 可写 说明
enterKeyType number 是 否 编辑框的功能属性。
inputPattern number 是 否 编辑框的文本属性。

KeyEvent

按键属性值。

系统能力： SystemCapability.MiscServices.InputMethodFramework

名称 类型 可读 可写 说明
keyCode number 是 否 按键的键值。键码值说明参考KeyCode。
keyAction number 是 否 按键事件类型。
- 当值为2时，表示按下事件；
- 当值为3时，表示抬起事件。

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为获取到的文本；否则为错误对象。

示例：

let length = 1;
textInputClient.getForward(length, (err, text) => {
    if (err !== undefined) {
        console.error('Failed to getForward: ' + JSON.stringify(err));
        return;
    }
    console.log('Succeeded in getting forward, text: ' + text);
});

getForward(deprecated)

getForward(length:number): Promise<string>

获取光标前固定长度的文本。使用promise异步回调。

说明：

从API version 8开始支持，API version 9开始废弃, 建议使用getForward替代。

系统能力： SystemCapability.MiscServices.InputMethodFramework

参数：

参数名 类型 必填 说明
length number 是 文本长度。

返回值：

类型 说明
Promise<string> Promise对象，返回光标前固定长度的文本。

示例：

let length = 1;
textInputClient.getForward(length).then((text) => {
    console.info('Succeeded in getting forward, text: ' + text);
}).catch((err) => {
    console.error('Failed to getForward: ' + JSON.stringify(err));
});

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为获取到的文本；否则为错误对象。

示例：

let length = 1;
textInputClient.getBackward(length, (err, text) => {
    if (err !== undefined) {
        console.error('Failed to getBackward: ' + JSON.stringify(err));
        return;
    }
    console.log('Succeeded in getting borward, text: ' + text);
});

getBackward(deprecated)

getBackward(length:number): Promise<string>

获取光标后固定长度的文本。使用promise异步回调。

说明：

从API version 8开始支持，API version 9开始废弃, 建议使用getBackward替代。

系统能力： SystemCapability.MiscServices.InputMethodFramework

参数：

参数名 类型 必填 说明
length number 是 文本长度。

返回值：

类型 说明
Promise<string> Promise对象，返回光标后固定长度的文本。

示例：

let length = 1;
textInputClient.getBackward(length).then((text) => {
    console.info('Succeeded in getting backward: ' + JSON.stringify(text));
}).catch((err) => {
    console.error('Failed to getBackward: ' + JSON.stringify(err));
});

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；否则为错误对象。

示例：

let length = 1;
textInputClient.deleteForward(length, (err, result) => {
    if (err !== undefined) {
        console.error('Failed to deleteForward: ' + JSON.stringify(err));
        return;
    }
    if (result) {
        console.info('Succeeded in deleting forward. ');
    } else {
        console.error('Failed to deleteForward. ');
    }
});

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表示删除光标前固定长度的文本失败。

示例：

let length = 1;
textInputClient.deleteForward(length).then((result) => {
    if (result) {
        console.info('Succeeded in deleting forward. ');
    } else {
        console.error('Failed to delete forward. ');
    }
}).catch((err) => {
    console.error('Failed to delete forward: ' + JSON.stringify(err));
});

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；否则为错误对象。

示例：

let length = 1;
textInputClient.deleteBackward(length, (err, result) => {
    if (err !== undefined) {
        console.error('Failed to delete backward: ' + JSON.stringify(err));
        return;
    }
    if (result) {
        console.info('Succeeded in deleting backward. ');
    } else {
        console.error('Failed to deleteBackward. ');
    }
});

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表示删除光标后固定长度的文本失败。

示例：

let length = 1;
textInputClient.deleteBackward(length).then((result) => {
    if (result) {
        console.info('Succeeded in deleting backward. ');
    } else {
        console.error('Failed to deleteBackward. ');
    }
}).catch((err) => {
    console.error('Failed to deleteBackward: ' + JSON.stringify(err));
});

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；否则为错误对象。

示例：

let action = 1;
textInputClient.sendKeyFunction(action, (err, result) => {
    if (err !== undefined) {
        console.error('Failed to sendKeyFunction: ' + JSON.stringify(err));
        return;
    }
    if (result) {
        console.info('Succeeded in sending key function. ');
    } else {
        console.error('Failed to sendKeyFunction. ');
    }
});

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表示发送功能键失败。

示例：

let action = 1;
textInputClient.sendKeyFunction(action).then((result) => {
    if (result) {
        console.info('Succeeded in sending key function. ');
    } else {
        console.error('Failed to sendKeyFunction. ');
    }
}).catch((err) => {
    console.error('Failed to sendKeyFunction:' + JSON.stringify(err));
});

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；否则为错误对象。

示例：

textInputClient.insertText('test', (err, result) => {
    if (err !== undefined) {
        console.error('Failed to insertText: ' + JSON.stringify(err));
        return;
    }
    if (result) {
        console.info('Succeeded in inserting text. ');
    } else {
        console.error('Failed to insertText. ');
    }
});

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表示插入文本失败。

示例：

textInputClient.insertText('test').then((result) => {
    if (result) {
        console.info('Succeeded in inserting text. ');
    } else {
        console.error('Failed to insertText. ');
    }
}).catch((err) => {
    console.error('Failed to insertText: ' + JSON.stringify(err));
});

getEditorAttribute(deprecated)

getEditorAttribute(callback: AsyncCallback<EditorAttribute>): void

获取编辑框属性值。使用callback异步回调。

说明：

从API version 8开始支持，API version 9开始废弃, 建议使用getEditorAttribute替代。

系统能力： SystemCapability.MiscServices.InputMethodFramework

参数：

参数名 类型 必填 说明
callback AsyncCallback<EditorAttribute> 是 回调函数。当编辑框的属性值获取成功，err为undefined，data为编辑框属性值；否则为错误对象。

示例：

textInputClient.getEditorAttribute((err, editorAttribute) => {
    if (err !== undefined) {
        console.error('Failed to getEditorAttribute: ' + JSON.stringify(err));
        return;
    }
    console.log('editorAttribute.inputPattern: ' + JSON.stringify(editorAttribute.inputPattern));
    console.log('editorAttribute.enterKeyType: ' + JSON.stringify(editorAttribute.enterKeyType));
});

getEditorAttribute(deprecated)

getEditorAttribute(): Promise<EditorAttribute>

获取编辑框属性值。使用promise异步回调。

说明：

从API version 8开始支持，API version 9开始废弃, 建议使用getEditorAttribute替代。

系统能力： SystemCapability.MiscServices.InputMethodFramework

返回值：

类型 说明
Promise<EditorAttribute> Promise对象，返回编辑框属性值。

示例：

textInputClient.getEditorAttribute().then((editorAttribute) => {
    console.info('editorAttribute.inputPattern: ' + JSON.stringify(editorAttribute.inputPattern));
    console.info('editorAttribute.enterKeyType: ' + JSON.stringify(editorAttribute.enterKeyType));
}).catch((err) => {
    console.error('Failed to getEditorAttribute: ' + JSON.stringify(err));
});