f42b8ab6创建于 2025年6月10日历史提交

@ohos.inputMethodEngine (输入法服务)

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

说明：

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

导入模块

import { inputMethodEngine } from '@kit.IMEKit';

常量

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

系统能力： 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	“前一个”功能键。
ENTER_KEY_TYPE_NEWLINE¹²⁺	number	8	“换行”功能键。
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	密码编辑框。
PATTERN_PASSWORD_NUMBER¹¹⁺	number	8	数字密码编辑框。
PATTERN_PASSWORD_SCREEN_LOCK¹¹⁺	number	9	锁屏密码编辑框。
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_UP⁹⁺	number	1	光标上移。
CURSOR_DOWN⁹⁺	number	2	光标下移。
CURSOR_LEFT⁹⁺	number	3	光标左移。
CURSOR_RIGHT⁹⁺	number	4	光标右移。
WINDOW_TYPE_INPUT_METHOD_FLOAT⁹⁺	number	2105	输入法应用窗口风格标识。

inputMethodEngine.getInputMethodAbility⁹⁺

getInputMethodAbility(): InputMethodAbility

获取输入法应用客户端实例InputMethodAbility，仅支持输入法应用调用。
输入法应用获取该实例后，可订阅软键盘显示/隐藏请求事件、创建/销毁输入法面板等。

系统能力： SystemCapability.MiscServices.InputMethodFramework

返回值：

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

示例：

let InputMethodAbility = inputMethodEngine.getInputMethodAbility();

inputMethodEngine.getKeyboardDelegate⁹⁺

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();

CommandDataType¹²⁺

type CommandDataType = number | string | boolean;

表示私有数据类型，接口参数具体类型根据其功能而定。

系统能力： SystemCapability.MiscServices.InputMethodFramework

类型	说明
string	表示值类型为字符串。
number	表示值类型为数字。
boolean	表示值类型为布尔值。

SizeChangeCallback¹⁵⁺

type SizeChangeCallback = (size: window.Size, keyboardArea?: KeyboardArea) => void

当输入法面板大小变化时触发的回调。

系统能力： SystemCapability.MiscServices.InputMethodFramework

参数名	类型	必填	说明
size	window.Size	是	当前面板大小。
keyboardArea	KeyboardArea	否	当前面板中可作为键盘区域的大小。

InputMethodEngine

下列API均需使用getInputMethodEngine获取到InputMethodEngine实例后，通过实例调用。

on('inputStart')

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

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

系统能力： SystemCapability.MiscServices.InputMethodFramework

参数：

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

示例：

try {
  inputMethodEngine.getInputMethodEngine()
    .on('inputStart', (kbController: inputMethodEngine.KeyboardController, textClient: inputMethodEngine.TextInputClient) => {
      let keyboardController = kbController;
      let textInputClient = textClient;
  });
} catch(err) {
  console.error(`Failed to inputStart: ${JSON.stringify(err)}`);
}

off('inputStart')

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

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

系统能力： SystemCapability.MiscServices.InputMethodFramework

参数：

参数名	类型	必填	说明
type	string	是	设置监听类型，固定取值为'inputStart'。
callback	(kbController: KeyboardController, textInputClient: TextInputClient) => void	否	取消订阅的回调函数。参数不填写时，取消订阅type对应的所有回调事件。

示例：

try {
  inputMethodEngine.getInputMethodEngine()
    .off('inputStart', (kbController: inputMethodEngine.KeyboardController, textClient: inputMethodEngine.TextInputClient) => {
      console.info('delete inputStart notification.');
  });
} catch(err) {
  console.error(`Failed to inputStart: ${JSON.stringify(err)}`);
}

on('keyboardShow'|'keyboardHide')

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

订阅输入法软键盘显示或隐藏事件。使用callback异步回调。

系统能力： SystemCapability.MiscServices.InputMethodFramework

参数：

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

示例：

try {
  inputMethodEngine.getInputMethodEngine().on('keyboardShow', () => {
    console.info('inputMethodEngine keyboardShow.');
  });
  inputMethodEngine.getInputMethodEngine().on('keyboardHide', () => {
    console.info('inputMethodEngine keyboardHide.');
  });
} catch(err) {
  console.error(`Failed to InputMethodEngine: ${JSON.stringify(err)}`);
}

off('keyboardShow'|'keyboardHide')

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

取消订阅输入法软键盘显示或隐藏事件。使用callback异步回调。

系统能力： SystemCapability.MiscServices.InputMethodFramework

参数：

参数名	类型	必填	说明
type	string	是	要取消监听的输入法软键盘类型。 -'keyboardShow'表示显示输入法软键盘。 -'keyboardHide'表示隐藏输入法软键盘。
callback	() => void	否	取消订阅的回调函数。参数不填写时，取消订阅type对应的所有回调事件。

示例：

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

InputMethodAbility

下列API均需使用getInputMethodAbility获取到InputMethodAbility实例后，通过实例调用。

on('inputStart')⁹⁺

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

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

系统能力： SystemCapability.MiscServices.InputMethodFramework

参数：

参数名	类型	必填	说明
type	string	是	设置监听类型，固定取值为'inputStart'。
callback	(kbController: KeyboardController, inputClient: InputClient) => void	是	回调函数，返回输入法操作相关实例。

示例：

try {
  inputMethodEngine.getInputMethodAbility()
    .on('inputStart', (kbController: inputMethodEngine.KeyboardController, client: inputMethodEngine.InputClient) => {
      let keyboardController = kbController;
      let inputClient = client;
  });
} catch(err) {
    console.error(`Failed to InputMethodAbility: ${JSON.stringify(err)}`);
}

off('inputStart')⁹⁺

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

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

系统能力： SystemCapability.MiscServices.InputMethodFramework

参数：

参数名	类型	必填	说明
type	string	是	设置监听类型，固定取值为'inputStart'。
callback	(kbController: KeyboardController, inputClient: InputClient) => void	否	取消订阅的回调函数。参数不填写时，取消订阅type对应的所有回调事件。

示例：

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

on('inputStop')⁹⁺

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

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

系统能力： SystemCapability.MiscServices.InputMethodFramework

参数：

参数名	类型	必填	说明
type	string	是	设置监听类型，固定取值为'inputStop'。
callback	() => void	是	回调函数。

示例：

try {
  inputMethodEngine.getInputMethodAbility().on('inputStop', () => {
    console.info('inputMethodAbility inputStop');
  });
} catch(err) {
    console.error(`Failed to inputStop: ${JSON.stringify(err)}`);
}

off('inputStop')⁹⁺

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

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

系统能力： SystemCapability.MiscServices.InputMethodFramework

参数：

参数名	类型	必填	说明
type	string	是	设置监听类型，固定取值为'inputStop'。
callback	() => void	是	取消订阅的回调函数。参数不填写时，取消订阅type对应的所有回调事件。

示例：

try {
  inputMethodEngine.getInputMethodAbility().off('inputStop', () => {
    console.info('inputMethodAbility delete inputStop notification.');
  });
} catch(err) {
    console.error(`Failed to inputStop: ${JSON.stringify(err)}`);
}

on('setCallingWindow')⁹⁺

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

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

系统能力： SystemCapability.MiscServices.InputMethodFramework

参数：

参数名	类型	必填	说明
type	string	是	设置监听类型，固定取值为'setCallingWindow'。
callback	(wid: number) => void	是	回调函数，返回调用方窗口的Id。

示例：

try {
  inputMethodEngine.getInputMethodAbility().on('setCallingWindow', (wid: number) => {
    console.info('inputMethodAbility setCallingWindow');
  });
} catch(err) {
    console.error(`Failed to setCallingWindow: ${JSON.stringify(err)}`);
}

off('setCallingWindow')⁹⁺

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

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

系统能力： SystemCapability.MiscServices.InputMethodFramework

参数：

参数名	类型	必填	说明
type	string	是	设置监听类型，固定取值为'setCallingWindow'。
callback	(wid:number) => void	是	取消订阅的回调函数。参数不填写时，取消订阅type对应的所有回调事件。

示例：

try {
  inputMethodEngine.getInputMethodAbility().off('setCallingWindow', (wid: number) => {
    console.info('inputMethodAbility delete setCallingWindow notification.');
  });
} catch(err) {
    console.error(`Failed to setCallingWindow: ${JSON.stringify(err)}`);
}

on('keyboardShow'|'keyboardHide')⁹⁺

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

订阅输入法软键盘显示或隐藏事件。使用callback异步回调。

系统能力： SystemCapability.MiscServices.InputMethodFramework

参数：

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

示例：

try {
  inputMethodEngine.getInputMethodAbility().on('keyboardShow', () => {
    console.info('InputMethodAbility keyboardShow.');
  });
  inputMethodEngine.getInputMethodAbility().on('keyboardHide', () => {
    console.info('InputMethodAbility keyboardHide.');
  });
} catch(err) {
    console.error(`Failed to keyboard: ${JSON.stringify(err)}`);
}

off('keyboardShow'|'keyboardHide')⁹⁺

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

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

系统能力： SystemCapability.MiscServices.InputMethodFramework

参数：

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

示例：

try {
  inputMethodEngine.getInputMethodAbility().off('keyboardShow', () => {
    console.info('InputMethodAbility delete keyboardShow notification.');
  });
  inputMethodEngine.getInputMethodAbility().off('keyboardHide', () => {
    console.info('InputMethodAbility delete keyboardHide notification.');
  });
} catch(err) {
    console.error(`Failed to keyboard: ${JSON.stringify(err)}`);
}

on('setSubtype')⁹⁺

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

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

系统能力： SystemCapability.MiscServices.InputMethodFramework

参数：

参数名	类型	必填	说明
type	string	是	设置监听类型，固定取值为'setSubtype'。
callback	(inputMethodSubtype: InputMethodSubtype) => void	是	回调函数，返回设置的输入法子类型。

示例：

import { InputMethodSubtype } from '@kit.IMEKit';

try {
  inputMethodEngine.getInputMethodAbility().on('setSubtype', (inputMethodSubtype: InputMethodSubtype) => {
    console.info('InputMethodAbility setSubtype.');
  });
} catch(err) {
    console.error(`Failed to setSubtype: ${JSON.stringify(err)}`);
}

off('setSubtype')⁹⁺

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

取消订阅输入法软键盘显示或隐藏事件。使用callback异步回调。

系统能力： SystemCapability.MiscServices.InputMethodFramework

参数：

参数名	类型	必填	说明
type	string	是	设置监听类型，固定取值为'setSubtype'。
callback	(inputMethodSubtype: InputMethodSubtype) => void	否	取消订阅的回调函数。参数不填写时，取消订阅type对应的所有回调事件。

示例：

try {
  inputMethodEngine.getInputMethodAbility().off('setSubtype', () => {
    console.info('InputMethodAbility delete setSubtype notification.');
  });
} catch(err) {
    console.error(`Failed to setSubtype: ${JSON.stringify(err)}`);
}

on('securityModeChange')¹¹⁺

on(type: 'securityModeChange', callback: Callback< SecurityMode>): void

订阅输入法安全模式改变类型事件。使用callback异步回调。

系统能力： SystemCapability.MiscServices.InputMethodFramework

参数：

参数名	类型	必填	说明
type	string	是	设置监听类型，固定取值为'securityModeChange'。
callback	Callback<SecurityMode>	是	回调函数，返回当前输入法应用的安全模式。

示例：

try {
  inputMethodEngine.getInputMethodAbility().on('securityModeChange', (securityMode: inputMethodEngine.SecurityMode) => {
    console.info(`InputMethodAbility securityModeChange, security is ${securityMode}`);
  });
} catch(err) {
    console.error(`Failed to on securityModeChange: ${JSON.stringify(err)}`);
}

off('securityModeChange')¹¹⁺

off(type: 'securityModeChange', callback?: Callback< SecurityMode>): void

取消订阅输入法安全模式改变类型事件。使用callback异步回调。

系统能力： SystemCapability.MiscServices.InputMethodFramework

参数：

参数名	类型	必填	说明
type	string	是	设置监听类型，固定取值为'securityModeChange'。
callback	Callback<SecurityMode>	否	取消订阅的回调函数。参数不填写时，取消订阅type对应的所有回调事件。

示例：

let securityChangeCallback = (securityMode: inputMethodEngine.SecurityMode) => {
  console.info(`InputMethodAbility securityModeChange, security is ${securityMode}`);
};
let inputMethodAbility = inputMethodEngine.getInputMethodAbility();
inputMethodAbility.on('securityModeChange', securityChangeCallback);
try {
  inputMethodAbility.off('securityModeChange', securityChangeCallback);
} catch(err) {
  console.error(`Failed to off securityModeChange: ${JSON.stringify(err)}`);
}

on('privateCommand')¹²⁺

on(type: 'privateCommand', callback: Callback<Record<string, CommandDataType>>): void;

订阅输入法私有数据事件。使用callback异步回调。

系统能力： SystemCapability.MiscServices.InputMethodFramework

参数：

参数名	类型	必填	说明
type	string	是	设置监听类型，固定取值为'privateCommand'。
callback	Callback<Record<string, CommandDataType>>	是	回调函数，返回向输入法应用发送的私有数据。

错误码：

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

错误码ID	错误信息
12800010	not the preconfigured default input method.

示例：

import { BusinessError } from '@kit.BasicServicesKit';
import { inputMethodEngine } from '@kit.IMEKit';

let privateCommandCallback = (record: Record<string, inputMethodEngine.CommandDataType>) => {
  for (let i = 0; i < record.length; i++) {
    console.info(`private command key: ${i}, value: ${record[i]}`);
  }
}
try {
  console.info(`regist private command `);
  inputMethodEngine.getInputMethodAbility().on('privateCommand', privateCommandCallback);
} catch (err) {
  let error = err as BusinessError;
  console.error(`regist private command error: ${error.code} ${error.message}`);
}

off('privateCommand')¹²⁺

off(type: 'privateCommand', callback?: Callback<Record<string, CommandDataType>>): void

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

系统能力： SystemCapability.MiscServices.InputMethodFramework

参数：

参数名	类型	必填	说明
type	string	是	设置监听类型，固定取值为'privateCommand'。
callback	Callback<Record<string, CommandDataType>>	否	取消订阅的回调函数。参数不填写时，取消订阅type对应的所有回调事件。

错误码：

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

错误码ID	错误信息
12800010	not the preconfigured default input method.

示例：

import { BusinessError } from '@kit.BasicServicesKit';
import { inputMethodEngine } from '@kit.IMEKit';

let privateCommandCallback = (record: Record<string, inputMethodEngine.CommandDataType>) => {
  for (let i = 0; i < record.length; i++) {
    console.info(`private command key: ${i}, value: ${record[i]}`);
  }
}
try {
  console.info(`regist private command `);
  inputMethodEngine.getInputMethodAbility().off('privateCommand', privateCommandCallback);
} catch (err) {
  let error = err as BusinessError;
  console.error(`regist private command error: ${error.code} ${error.message}`);
}

on('callingDisplayDidChange')¹⁸⁺

on(type: 'callingDisplayDidChange', callback: Callback<number>): void

订阅编辑框对应窗口所在屏幕ID变化。使用callback异步回调。

系统能力： SystemCapability.MiscServices.InputMethodFramework

参数：

参数名	类型	必填	说明
type	string	是	设置监听类型，固定取值为'callingDisplayDidChange'。
callback	Callback<number>	是	回调函数，返回编辑框设置对应窗口屏幕ID。

错误码：

以下错误码的详细介绍请参见通用错误码说明文档。

错误码ID	错误信息
801	capability not supported.

示例：

import { BusinessError } from '@kit.BasicServicesKit';
import { inputMethodEngine } from '@kit.IMEKit';

let callingDisplayDidChangeCallback = (num: number) => {
  console.info(`display id: ${num}`);
}
try {
  console.info(`regist calling display changed`);
  inputMethodEngine.getInputMethodAbility().on('callingDisplayDidChange', callingDisplayDidChangeCallback);
} catch (err) {
  let error = err as BusinessError;
  console.error(`regist calling display changed error: ${error.code} ${error.message}`);
}

off('callingDisplayDidChange')¹⁸⁺

off(type: 'callingDisplayDidChange', callback?: Callback<number>): void

取消编辑框对应窗口所在屏幕ID变化。使用callback异步回调。

系统能力： SystemCapability.MiscServices.InputMethodFramework

参数：

参数名	类型	必填	说明
type	string	是	设置监听类型，固定取值为'callingDisplayDidChange'。
callback	Callback<number>	否	取消订阅的回调函数。参数不填写时，取消订阅type对应的所有回调事件。

示例：

import { BusinessError } from '@kit.BasicServicesKit';
import { inputMethodEngine } from '@kit.IMEKit';

try {
  console.info(`unregist calling display changed `);
  inputMethodEngine.getInputMethodAbility().off('callingDisplayDidChange', (num: number) => {
    console.info('InputMethodAbility delete calling display  notification.');
  });
} catch (err) {
  let error = err as BusinessError;
  console.error(`unregist calling display changed error: ${error.code} ${error.message}`);
}

getSecurityMode¹¹⁺

getSecurityMode(): SecurityMode

获取输入法应用的当前安全模式。

系统能力： SystemCapability.MiscServices.InputMethodFramework

返回值：

类型	说明
SecurityMode	安全模式。

错误码：

错误码ID	错误信息
12800004	not an input method.

示例：

try {
  let security = inputMethodEngine.getInputMethodAbility().getSecurityMode();
  console.error(`getSecurityMode, securityMode is : ${security}`);
} catch (err) {
  console.error(`Failed to getSecurityMode: ${JSON.stringify(err)}`);
}

createPanel¹⁰⁺

createPanel(ctx: BaseContext, info: PanelInfo, callback: AsyncCallback<Panel>): void

创建输入法面板，仅支持输入法应用调用。使用callback异步回调。
单个输入法应用仅允许创建一个软键盘类型和状态栏类型的面板。

系统能力： SystemCapability.MiscServices.InputMethodFramework

参数：

参数名	类型	必填	说明
ctx	BaseContext	是	当前输入法应用上下文信息。
info	PanelInfo	是	输入法应用信息。
callback	AsyncCallback<Panel>	是	回调函数。当输入法面板创建成功，返回当前创建的输入法面板对象。

错误码：

错误码ID	错误信息
401	parameter error. Possible causes: 1.Mandatory parameters are left unspecified; 2.Incorrect parameter types.
12800004	not an input method.

示例：

import { BusinessError } from '@kit.BasicServicesKit';

let panelInfo: inputMethodEngine.PanelInfo = {
  type: inputMethodEngine.PanelType.SOFT_KEYBOARD,
  flag: inputMethodEngine.PanelFlag.FLG_FIXED
}
try {
  inputMethodEngine.getInputMethodAbility()
    .createPanel(this.context, panelInfo, (err: BusinessError, panel: inputMethodEngine.Panel) => {
      if (err) {
        console.error(`Failed to createPanel: ${JSON.stringify(err)}`);
        return;
      }
      console.info('Succeed in creating panel.');
    })
} catch (err) {
  console.error(`Failed to createPanel: ${JSON.stringify(err)}`);
}

createPanel¹⁰⁺

createPanel(ctx: BaseContext, info: PanelInfo): Promise<Panel>

创建输入法面板，仅支持输入法应用调用。使用promise异步回调。
单个输入法应用仅允许创建一个软键盘类型和状态栏类型的面板。

系统能力： SystemCapability.MiscServices.InputMethodFramework

参数：

参数名	类型	必填	说明
ctx	BaseContext	是	当前输入法应用上下文信息。
info	PanelInfo	是	输入法面板信息。

返回值：

类型	说明
Promise<Panel>	回调函数。当输入法面板创建成功，返回当前创建的输入法面板对象。

错误码：

错误码ID	错误信息
401	parameter error. Possible causes: 1.Mandatory parameters are left unspecified; 2.Incorrect parameter types.
12800004	not an input method.

示例：

import { BusinessError } from '@kit.BasicServicesKit';

let panelInfo: inputMethodEngine.PanelInfo = {
  type: inputMethodEngine.PanelType.SOFT_KEYBOARD,
  flag: inputMethodEngine.PanelFlag.FLG_FIXED
}
inputMethodEngine.getInputMethodAbility().createPanel(this.context, panelInfo)
  .then((panel: inputMethodEngine.Panel) => {
    console.info('Succeed in creating panel.');
  }).catch((err: BusinessError) => {
    console.error(`Failed to create panel: ${JSON.stringify(err)}`);
  })

destroyPanel¹⁰⁺

destroyPanel(panel: Panel, callback: AsyncCallback<void>): void

销毁输入法面板。使用callback异步回调。

系统能力： SystemCapability.MiscServices.InputMethodFramework

参数：

参数名	类型	必填	说明
panel	Panel	是	要销毁的面板对象。
callback	AsyncCallback<void>	是	回调函数。当输入法面板销毁成功，err为undefined，否则为错误对象。

错误码：

以下错误码的详细介绍请参见通用错误码说明文档。

错误码ID	错误信息
401	parameter error. Possible causes: 1. Mandatory parameters are left unspecified; 2. Incorrect parameter types; 3. Parameter verification failed.

示例：

import { BusinessError } from '@kit.BasicServicesKit';

let panelInfo: inputMethodEngine.PanelInfo = {
  type: inputMethodEngine.PanelType.SOFT_KEYBOARD,
  flag: inputMethodEngine.PanelFlag.FLG_FIXED
}
let inputPanel: inputMethodEngine.Panel | undefined = undefined;
try {
  inputMethodEngine.getInputMethodAbility()
    .createPanel(this.context, panelInfo, (err: BusinessError, panel: inputMethodEngine.Panel) => {
      if (err) {
        console.error(`Failed to create panel: ${JSON.stringify(err)}`);
        return;
      }
      inputPanel = panel;
      console.info('Succeed in creating panel.');
    })
} catch (err) {
  console.error(`Failed to create panel: ${JSON.stringify(err)}`);
}
try {
  if (inputPanel) {
    inputMethodEngine.getInputMethodAbility().destroyPanel(inputPanel, (err: BusinessError) => {
      if (err !== undefined) {
        console.error(`Failed to destroy panel: ${JSON.stringify(err)}`);
        return;
      }
      console.info('Succeed in destroying panel.');
    })
  }
} catch (err) {
  console.error(`Failed to destroy panel: ${JSON.stringify(err)}`);
}

destroyPanel¹⁰⁺

destroyPanel(panel: Panel): Promise<void>

销毁输入法面板。使用promise异步回调。

系统能力： SystemCapability.MiscServices.InputMethodFramework

参数：

参数名	类型	必填	说明
panel	Panel	是	要销毁的面板对象。

返回值：

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

错误码：

以下错误码的详细介绍请参见通用错误码说明文档。

错误码ID	错误信息
401	parameter error. Possible causes: 1. Mandatory parameters are left unspecified; 2. Incorrect parameter types; 3. Parameter verification failed.

示例：

import { BusinessError } from '@kit.BasicServicesKit';

let panelInfo: inputMethodEngine.PanelInfo = {
  type: inputMethodEngine.PanelType.SOFT_KEYBOARD,
  flag: inputMethodEngine.PanelFlag.FLG_FIXED
}
let inputPanel: inputMethodEngine.Panel | undefined = undefined;
try {
  inputMethodEngine.getInputMethodAbility()
    .createPanel(this.context, panelInfo, (err: BusinessError, panel: inputMethodEngine.Panel) => {
      if (err) {
        console.error(`Failed to create panel: ${JSON.stringify(err)}`);
        return;
      }
      inputPanel = panel;
      console.info('Succeed in creating panel.');
    })
} catch (err) {
  console.error(`Failed to create panel: ${JSON.stringify(err)}`);
}

try {
  if (inputPanel) {
    inputMethodEngine.getInputMethodAbility().destroyPanel(inputPanel).then(() => {
      console.info('Succeed in destroying panel.');
    }).catch((err: BusinessError) => {
      console.error(`Failed to destroy panel: ${JSON.stringify(err)}`);
    });
  }
} catch (err) {
  console.error(`Failed to destroy panel: ${JSON.stringify(err)}`);
}

KeyboardDelegate

下列API均需使用getKeyboardDelegate获取到KeyboardDelegate实例后，通过实例调用。

on('keyDown'|'keyUp')

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

订阅硬键盘（即物理键盘）上物理按键的按下或抬起事件。使用callback异步回调。

系统能力： SystemCapability.MiscServices.InputMethodFramework

参数：

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

示例：

try {
  inputMethodEngine.getKeyboardDelegate().on('keyUp', (keyEvent: inputMethodEngine.KeyEvent) => {
    console.info(`inputMethodEngine keyCode.(keyDown): ${keyEvent.keyCode}`);
    console.info(`inputMethodEngine keyAction.(keyDown): ${keyEvent.keyAction}`);
    return true;
  });
  inputMethodEngine.getKeyboardDelegate().on('keyDown', (keyEvent: inputMethodEngine.KeyEvent) => {
    console.info(`inputMethodEngine keyCode.(keyDown): ${keyEvent.keyCode}`);
    console.info(`inputMethodEngine keyAction.(keyDown): ${keyEvent.keyAction}`);
    return true;
  });
} catch(err) {
    console.error(`Failed to KeyboardDelegate: ${JSON.stringify(err)}`);
}

off('keyDown'|'keyUp')

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

取消订阅硬键盘（即物理键盘）上物理按键的按下或抬起事件。使用callback异步回调。

系统能力： SystemCapability.MiscServices.InputMethodFramework

参数：

参数名	类型	必填	说明
type	string	是	设置监听类型。 - 'keyDown'表示键盘按下。 - 'keyUp'表示键盘抬起。
callback	(event: KeyEvent) => boolean	否	取消订阅的回调函数。参数不填写时，取消订阅type对应的所有回调事件。

示例：

try {
  inputMethodEngine.getKeyboardDelegate().off('keyUp', (keyEvent: inputMethodEngine.KeyEvent) => {
    console.info('delete keyUp notification.');
    return true;
  });
  inputMethodEngine.getKeyboardDelegate().off('keyDown', (keyEvent: inputMethodEngine.KeyEvent) => {
    console.info('delete keyDown notification.');
    return true;
  });
} catch(err) {
    console.error(`Failed to keyevent: ${JSON.stringify(err)}`);
}

on('keyEvent')¹⁰⁺

on(type: 'keyEvent', callback: (event: InputKeyEvent) => boolean): void

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

系统能力： SystemCapability.MiscServices.InputMethodFramework

参数：

参数名	类型	必填	说明
type	string	是	设置监听类型，固定取值为'keyEvent'。
callback	(event: InputKeyEvent) => boolean	是	回调函数，入参为按键事件信息，返回值类型为布尔类型。 - 入参按键事件信息的数据类型为InputKeyEvent。 - 若按键事件被事件订阅者消费，则callback应返回true，否则返回false。

示例：

import type { KeyEvent } from '@kit.InputKit';

try {
  inputMethodEngine.getKeyboardDelegate().on('keyEvent', (keyEvent: KeyEvent) => {
    console.info('inputMethodEngine keyEvent.action:' + JSON.stringify(keyEvent.action));
    console.info('inputMethodEngine keyEvent.key.code:' + JSON.stringify(keyEvent.key.code));
    console.info(`inputMethodEngine keyEvent.ctrlKey: ${keyEvent.ctrlKey}`);
    console.info(`inputMethodEngine keyEvent.unicodeChar: ${keyEvent.unicodeChar}`);
    return true;
  });
} catch(err) {
    console.error(`Failed to inputMethodEngine: ${JSON.stringify(err)}`);
}

off('keyEvent')¹⁰⁺

off(type: 'keyEvent', callback?: (event: InputKeyEvent) => boolean): void

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

系统能力： SystemCapability.MiscServices.InputMethodFramework

参数：

参数名	类型	必填	说明
type	string	是	设置监听类型，固定取值为'keyEvent'。
callback	function	否	取消订阅的回调函数。参数不填写时，取消订阅type对应的所有回调事件。

示例：

import type { KeyEvent } from '@kit.InputKit';

try {
  inputMethodEngine.getKeyboardDelegate().off('keyEvent', (keyEvent: KeyEvent) => {
    console.info('This is a callback function which will be deregistered.');
    return true;
  });
  inputMethodEngine.getKeyboardDelegate().off('keyEvent');
} catch(err) {
    console.error(`Failed to keyEvent: ${JSON.stringify(err)}`);
}

on('cursorContextChange')

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

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

系统能力： SystemCapability.MiscServices.InputMethodFramework

参数：

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

示例：

try {
  inputMethodEngine.getKeyboardDelegate().on('cursorContextChange', (x: number, y: number, height: number) => {
    console.info('inputMethodEngine cursorContextChange x:' + x);
    console.info('inputMethodEngine cursorContextChange y:' + y);
    console.info('inputMethodEngine cursorContextChange height:' + height);
  });
} catch(err) {
    console.error(`Failed to cursorContextChange: ${JSON.stringify(err)}`);
}

off('cursorContextChange')

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

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

系统能力： SystemCapability.MiscServices.InputMethodFramework

参数：

参数名	类型	必填	说明
type	string	是	光标变化事件，固定取值为'cursorContextChange'。
callback	(x: number, y:number, height:number) => void	否	取消订阅的回调函数。参数不填写时，取消订阅type对应的所有回调事件。

示例：

try {
  inputMethodEngine.getKeyboardDelegate().off('cursorContextChange', (x: number, y: number, height: number) => {
    console.info('delete cursorContextChange notification.');
  });
} catch(err) {
    console.error(`Failed to cursorContextChange: ${JSON.stringify(err)}`);
}

on('selectionChange')

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

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

系统能力： SystemCapability.MiscServices.InputMethodFramework

参数：

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

示例：

try {
  inputMethodEngine.getKeyboardDelegate()
    .on('selectionChange', (oldBegin: number, oldEnd: number, newBegin: number, newEnd: number) => {
      console.info('inputMethodEngine beforeEach selectionChange oldBegin:' + oldBegin);
      console.info('inputMethodEngine beforeEach selectionChange oldEnd:' + oldEnd);
      console.info('inputMethodEngine beforeEach selectionChange newBegin:' + newBegin);
      console.info('inputMethodEngine beforeEach selectionChange newEnd:' + newEnd);
    });
} catch(err) {
    console.error(`Failed to selectionChange: ${JSON.stringify(err)}`);
}

off('selectionChange')

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

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

系统能力： SystemCapability.MiscServices.InputMethodFramework

参数：

参数名	类型	必填	说明
type	string	是	文本选择变化事件，固定取值为'selectionChange'。
callback	(oldBegin: number, oldEnd: number, newBegin: number, newEnd: number) => void	否	取消订阅的回调函数。参数不填写时，取消订阅type对应的所有回调事件。

示例：

try {
  inputMethodEngine.getKeyboardDelegate()
    .off('selectionChange', (oldBegin: number, oldEnd: number, newBegin: number, newEnd: number)  => {
      console.info('delete selectionChange notification.');
    });
} catch(err) {
    console.error(`Failed to selectionChange: ${JSON.stringify(err)}`);
}

on('textChange')

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

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

系统能力： SystemCapability.MiscServices.InputMethodFramework

参数：

参数名	类型	必填	说明
type	string	是	文本变化事件，固定取值为'textChange'。
callback	(text: string) => void	是	回调函数，返回订阅的文本内容。

示例：

try {
  inputMethodEngine.getKeyboardDelegate().on('textChange', (text: string) => {
    console.info('inputMethodEngine textChange. text:' + text);
  });
} catch(err) {
    console.error(`Failed to textChange: ${JSON.stringify(err)}`);
}

off('textChange')

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

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

系统能力： SystemCapability.MiscServices.InputMethodFramework

参数：

参数名	类型	必填	说明
type	string	是	文本变化事件，固定取值为'textChange'。
callback	(text: string) => void	否	取消订阅的回调函数。参数不填写时，取消订阅type对应的所有回调事件。

示例：

try {
  inputMethodEngine.getKeyboardDelegate().off('textChange', (text: string) => {
    console.info('delete textChange notification. text:' + text);
  });
} catch(err) {
    console.error(`Failed to textChange: ${JSON.stringify(err)}`);
}

on('editorAttributeChanged')¹⁰⁺

on(type: 'editorAttributeChanged', callback: (attr: EditorAttribute) => void): void

订阅编辑框属性变化事件。使用callback异步回调。

系统能力： SystemCapability.MiscServices.InputMethodFramework

参数：

参数名	类型	必填	说明
type	string	是	文本变化事件，固定取值为'editorAttributeChanged'。
callback	(attr: EditorAttribute) => void	是	回调函数，返回变化的编辑框属性。

示例：

try {
  inputMethodEngine.getKeyboardDelegate().on('editorAttributeChanged', (attr: inputMethodEngine.EditorAttribute) => {
    console.info(`Succeeded in receiving attribute of editor, inputPattern = ${attr.inputPattern}, enterKeyType = ${attr.enterKeyType}`);
  });
} catch(err) {
    console.error(`Failed to textChange: ${JSON.stringify(err)}`);
}

off('editorAttributeChanged')¹⁰⁺

off(type: 'editorAttributeChanged', callback?: (attr: EditorAttribute) => void): void

取消订阅编辑框属性变化事件。使用callback异步回调。

系统能力： SystemCapability.MiscServices.InputMethodFramework

参数：

参数名	类型	必填	说明
type	string	是	文本变化事件，固定取值为'editorAttributeChanged'。
callback	(attr: EditorAttribute) => void	否	所要取消订阅的回调处理函数。参数不填写时，默认取消订阅type对应的所有回调事件。

示例：

inputMethodEngine.getKeyboardDelegate().off('editorAttributeChanged');

Panel¹⁰⁺

下列API均需使用createPanel获取到Panel实例后，通过实例调用。

setUiContent¹⁰⁺

setUiContent(path: string, callback: AsyncCallback<void>): void

为当前的输入法面板加载具体页面内容，使用callback异步回调。

系统能力： SystemCapability.MiscServices.InputMethodFramework

参数：

参数名	类型	必填	说明
path	string	是	具体页面的路径。
callback	AsyncCallback<void>	是	回调函数。当面板页面内容加载成功，err为undefined，否则err为错误对象。

错误码：

以下错误码的详细介绍请参见通用错误码说明文档。

错误码ID	错误信息
401	parameter error. Possible causes: 1. Mandatory parameters are left unspecified; 2. Incorrect parameter types; 3. Parameter verification failed.

示例：

import { BusinessError } from '@kit.BasicServicesKit';

try {
  panel.setUiContent('pages/page2/page2', (err: BusinessError) => {
    if (err) {
      console.error(`Failed to setUiContent: ${JSON.stringify(err)}`);
      return;
    }
    console.info('Succeeded in setting the content.');
  });
} catch (err) {
  console.error(`Failed to setUiContent: ${JSON.stringify(err)}`);
}

setUiContent¹⁰⁺

setUiContent(path: string): Promise<void>

为当前的输入法面板加载具体页面内容，使用Promise异步回调。

系统能力： SystemCapability.MiscServices.InputMethodFramework

参数：

参数名	类型	必填	说明
path	string	是	具体页面的路径。

返回值：

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

错误码：

以下错误码的详细介绍请参见通用错误码说明文档。

错误码ID	错误信息
401	parameter error. Possible causes: 1. Mandatory parameters are left unspecified; 2. Incorrect parameter types; 3. Parameter verification failed.

示例：

import { BusinessError } from '@kit.BasicServicesKit';

try {
  panel.setUiContent('pages/page2/page2').then(() => {
    console.info('Succeeded in setting the content.');
  }).catch((err: BusinessError) => {
    console.error(`Failed to setUiContent: ${JSON.stringify(err)}`);
  });
} catch (err) {
  console.error(`Failed to setUiContent: ${JSON.stringify(err)}`);
}

setUiContent¹⁰⁺

setUiContent(path: string, storage: LocalStorage, callback: AsyncCallback<void>): void

为当前的输入法面板加载与LocalStorage相关联的具体页面内容，使用callback异步回调。

系统能力： SystemCapability.MiscServices.InputMethodFramework

参数：

参数名	类型	必填	说明
path	string	是	LocalStorage相关联的具体页面的路径。
storage	LocalStorage	是	存储单元，为应用程序范围内的可变和不可变状态属性提供存储。
callback	AsyncCallback<void>	是	回调函数。当面板页面内容加载成功，err为undefined，否则err为错误对象。

错误码：

以下错误码的详细介绍请参见通用错误码说明文档。

错误码ID	错误信息
401	parameter error. Possible causes: 1. Mandatory parameters are left unspecified; 2. Incorrect parameter types; 3. Parameter verification failed.

示例：

import { BusinessError } from '@kit.BasicServicesKit';

let storage = new LocalStorage();
storage.setOrCreate('storageSimpleProp',121);
try {
  panel.setUiContent('pages/page2/page2', storage, (err: BusinessError) => {
    if (err) {
      console.error(`Failed to setUiContent: ${JSON.stringify(err)}`);
      return;
    }
    console.info('Succeeded in setting the content.');
  });
} catch (err) {
  console.error(`Failed to setUiContent: ${JSON.stringify(err)}`);
}

setUiContent¹⁰⁺

setUiContent(path: string, storage: LocalStorage): Promise<void>

为当前面板加载与LocalStorage相关联的具体页面内容，使用Promise异步回调。

系统能力： SystemCapability.MiscServices.InputMethodFramework

参数：

参数名	类型	必填	说明
path	string	是	设置加载页面的路径。
storage	LocalStorage	是	存储单元，为应用程序范围内的可变状态属性和非可变状态属性提供存储。

返回值：

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

错误码：

以下错误码的详细介绍请参见通用错误码说明文档。

错误码ID	错误信息
401	parameter error. Possible causes: 1. Mandatory parameters are left unspecified; 2. Incorrect parameter types; 3. Parameter verification failed.

示例：

import { BusinessError } from '@kit.BasicServicesKit';

let storage = new LocalStorage();
storage.setOrCreate('storageSimpleProp',121);
try {
  panel.setUiContent('pages/page2/page2', storage).then(() => {
    console.info('Succeeded in setting the content.');
  }).catch((err: BusinessError) => {
    console.error(`Failed to setUiContent: ${JSON.stringify(err)}`);
  });
} catch (err) {
  console.error(`Failed to setUiContent: ${JSON.stringify(err)}`);
}

resize¹⁰⁺

resize(width: number, height: number, callback: AsyncCallback<void>): void

改变当前输入法面板的大小，使用callback异步回调。

说明

面板宽度不超出屏幕宽度，面板高度不高于屏幕高度的0.7倍。

系统能力： SystemCapability.MiscServices.InputMethodFramework

参数：

参数名	类型	必填	说明
width	number	是	目标面板的宽度，单位为px。
height	number	是	目标面板的高度，单位为px。
callback	AsyncCallback<void>	是	回调函数。当面板大小改变成功，err为undefined，否则err为错误对象。

错误码：

以下错误码的详细介绍请参见通用错误码说明文档。

错误码ID	错误信息
401	parameter error. Possible causes: 1. Mandatory parameters are left unspecified; 2. Incorrect parameter types; 3. Parameter verification failed.

示例：

import { BusinessError } from '@kit.BasicServicesKit';

try {
  panel.resize(500, 1000, (err: BusinessError) => {
    if (err) {
      console.error(`Failed to resize panel: ${JSON.stringify(err)}`);
      return;
    }
    console.info('Succeeded in changing the panel size.');
  });
} catch (err) {
  console.error(`Failed to resize panel: ${JSON.stringify(err)}`);
}

resize¹⁰⁺

resize(width: number, height: number): Promise<void>

改变当前输入法面板的大小，使用Promise异步回调。

说明

面板宽度不超出屏幕宽度，面板高度不高于屏幕高度的0.7倍。

系统能力： SystemCapability.MiscServices.InputMethodFramework

参数：

参数名	类型	必填	说明
width	number	是	目标面板的宽度，单位为px。
height	number	是	目标面板的高度，单位为px。

返回值：

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

错误码：

以下错误码的详细介绍请参见通用错误码说明文档。

错误码ID	错误信息
401	parameter error. Possible causes: 1. Mandatory parameters are left unspecified; 2. Incorrect parameter types; 3. Parameter verification failed.

示例：

import { BusinessError } from '@kit.BasicServicesKit';

try {
  panel.resize(500, 1000).then(() => {
    console.info('Succeeded in changing the panel size.');
  }).catch((err: BusinessError) => {
    console.error(`Failed to resize panel: ${JSON.stringify(err)}`);
  });
} catch (err) {
  console.error(`Failed to resize panel: ${JSON.stringify(err)}`);
}

moveTo¹⁰⁺

moveTo(x: number, y: number, callback: AsyncCallback<void>): void

移动面板位置，使用callback异步回调。面板状态为固定态时，不产生实际移动效果。

系统能力： SystemCapability.MiscServices.InputMethodFramework

参数：

参数名	类型	必填	说明
x	number	是	x轴方向移动的值，值大于0表示右移，单位为px。
y	number	是	y轴方向移动的值，值大于0表示下移，单位为px。
callback	AsyncCallback<void>	是	回调函数。当面板位置移动成功，err为undefined，否则err为错误对象。

错误码：

以下错误码的详细介绍请参见通用错误码说明文档。

错误码ID	错误信息
401	parameter error. Possible causes: 1. Mandatory parameters are left unspecified; 2. Incorrect parameter types.

示例：

import { BusinessError } from '@kit.BasicServicesKit';

try {
  panel.moveTo(300, 300, (err: BusinessError) =>{
    if (err) {
      console.error(`Failed to move panel: ${JSON.stringify(err)}`);
      return;
    }
    console.info('Succeeded in moving the panel.');
  });
} catch (err) {
    console.error(`Failed to move panel: ${JSON.stringify(err)}`);
}

moveTo¹⁰⁺

moveTo(x: number, y: number): Promise<void>

移动面板位置，使用promise异步回调。面板状态为固定态时，不产生实际移动效果。

系统能力： SystemCapability.MiscServices.InputMethodFramework

参数：

参数名	类型	必填	说明
x	number	是	x轴方向移动的值，值大于0表示右移，单位为px。
y	number	是	y轴方向移动的值，值大于0表示下移，单位为px。

返回值：

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

错误码：

以下错误码的详细介绍请参见通用错误码说明文档。

错误码ID	错误信息
401	parameter error. Possible causes: 1. Mandatory parameters are left unspecified; 2. Incorrect parameter types.

示例：

import { BusinessError } from '@kit.BasicServicesKit';

try {
  panel.moveTo(300, 300).then(() => {
    console.info('Succeeded in moving the panel.');
  }).catch((err: BusinessError) => {
    console.error(`Failed to move panel: ${JSON.stringify(err)}`);
  });
} catch (err) {
  console.error(`Failed to move panel: ${JSON.stringify(err)}`);
}

startMoving¹⁵⁺

startMoving(): void

发送移动命令给窗口，不产生实际移动效果（仅在鼠标点击作用才可以移动）。

系统能力： SystemCapability.MiscServices.InputMethodFramework

错误码：

以下错误码的详细介绍请参见输入法框架错误码,通用错误码说明文档。

错误码ID	错误信息
801	capability not supported.
12800002	input method engine error.
12800013	window manager service error.
12800017	invalid panel type or panel flag.

示例：


try {
  panel.startMoving();
  console.info('Succeeded in moving the panel.');
} catch (err) {
  console.error(`Failed to move panel: ${JSON.stringify(err)}`);
}

getDisplayId¹⁵⁺

getDisplayId(): Promise<number>

获取当前窗口的所在id,使用Promise异步回调。

系统能力： SystemCapability.MiscServices.InputMethodFramework

返回值：

类型	说明
Promise<number>	Promise对象。返回窗口的displayId。

错误码：

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

错误码ID	错误信息
12800002	input method engine error.
12800013	window manager service error.

示例：

import { BusinessError } from '@kit.BasicServicesKit';

try {
  panel.getDisplayId().then((result: number) => {
    console.info('get displayId:' + result);
  }).catch((err: BusinessError) => {
    console.error(`Failed to get displayId: ${JSON.stringify(err)}`);
  });
} catch (err) {
  console.error(`Failed to get displayId: ${JSON.stringify(err)}`);
}

show¹⁰⁺

show(callback: AsyncCallback<void>): void

显示当前输入法面板，使用callback异步回调。输入法应用与编辑框绑定成功后可正常调用。

系统能力： SystemCapability.MiscServices.InputMethodFramework

参数：

参数名	类型	必填	说明
callback	AsyncCallback<void>	是	回调函数。当面板显示成功，err为undefined，否则err为错误对象。

示例：

import { BusinessError } from '@kit.BasicServicesKit';

panel.show((err: BusinessError) => {
  if (err) {
    console.error(`Failed to show panel: ${JSON.stringify(err)}`);
    return;
  }
  console.info('Succeeded in showing the panel.');
});

show¹⁰⁺

show(): Promise<void>

显示当前输入法面板，使用promise异步回调。输入法应用与编辑框绑定成功后可正常调用。

系统能力： SystemCapability.MiscServices.InputMethodFramework

返回值：

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

示例：

import { BusinessError } from '@kit.BasicServicesKit';

panel.show().then(() => {
  console.info('Succeeded in showing the panel.');
}).catch((err: BusinessError) => {
  console.error(`Failed to show panel: ${JSON.stringify(err)}`);
});

hide¹⁰⁺

hide(callback: AsyncCallback<void>): void

隐藏当前输入法面板，使用callback异步回调。

系统能力： SystemCapability.MiscServices.InputMethodFramework

参数：

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

示例：

import { BusinessError } from '@kit.BasicServicesKit';

panel.hide((err: BusinessError) => {
  if (err) {
    console.error(`Failed to hide panel: ${JSON.stringify(err)}`);
    return;
  }
  console.info('Succeeded in hiding the panel.');
});

hide¹⁰⁺

hide(): Promise<void>

隐藏当前输入法面板，使用promise异步回调。

系统能力： SystemCapability.MiscServices.InputMethodFramework

返回值：

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

示例：

import { BusinessError } from '@kit.BasicServicesKit';

panel.hide().then(() => {
  console.info('Succeeded in hiding the panel.');
}).catch((err: BusinessError) => {
  console.error(`Failed to hide panel: ${JSON.stringify(err)}`);
});

adjustPanelRect¹²⁺

adjustPanelRect(flag: PanelFlag, rect: PanelRect): void

预设置输入法应用横竖屏大小。接口调用完毕表示adjust请求已提交到输入法框架，不表示执行完毕。

系统能力： SystemCapability.MiscServices.InputMethodFramework

参数：

参数名	类型	必填	说明
flag	PanelFlag	是	目标面板状态类型。类型为FLG_FIXED或FLG_FLOATING。
rect	PanelRect	是	目标面板横屏状态及竖屏状态的横坐标，纵坐标，宽度以及高度。固定态：高度不能超过屏幕高度的70%，宽度不能超过屏幕宽度；悬浮态：高度不能超过屏幕高度，宽度不能超过屏幕宽度。

错误码：

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

错误码ID	错误信息
401	parameter error. Possible causes: 1. Mandatory parameters are left unspecified; 2. Incorrect parameter types; 3. Parameter verification failed.
12800013	window manager service error.

示例：

import { BusinessError } from '@kit.BasicServicesKit';

try {
  let panelFlag = inputMethodEngine.PanelFlag.FLG_FIXED;
  let panelRect:inputMethodEngine.PanelRect = {
    landscapeRect:{left:100, top:100, width:400, height:400},
    portraitRect:{left:200, top:200, width:300, height:300}
  };
  panel.adjustPanelRect(panelFlag, panelRect);
} catch(err) {
  console.error(`Failed to adjustPanelRect: ${JSON.stringify(err)}`);
}

adjustPanelRect¹⁵⁺

adjustPanelRect(flag: PanelFlag, rect: EnhancedPanelRect): void

预设置输入法应用横竖屏大小、位置、自定义避让区域以及热区。

说明:

仅用于SOFT_KEYBOARD类型，状态为FLG_FIXED或FLG_FLOATING的面板。此接口兼容adjustPanelRect的调用方法，若入参rect仅填写属性landscapeRect和portraitRect，则默认调用adjustPanelRect。

此接口为同步接口，接口返回仅代表系统侧收到设置的请求，不代表已完成设置。

系统能力： SystemCapability.MiscServices.InputMethodFramework

参数：

参数名	类型	必填	说明
flag	PanelFlag	是	目标面板状态类型。类型为FLG_FIXED或FLG_FLOATING。
rect	EnhancedPanelRect	是	目标面板横屏状态及竖屏状态的位置、大小、避让区域以及热区。

错误码：

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

错误码ID	错误信息
401	parameter error. Possible causes: 1. Mandatory parameters are left unspecified; 2. Incorrect parameter types; 3. Parameter verification failed.
12800013	window manager service error.
12800017	invalid panel type or panel flag.

示例：

import { BusinessError } from '@kit.BasicServicesKit';

try {
  let panelFlag = inputMethodEngine.PanelFlag.FLG_FIXED;
  let panelRect:inputMethodEngine.EnhancedPanelRect = {
    landscapeAvoidY: 650,
    landscapeInputRegion: [{left:300, top:650, width:2000, height:500}],
    portraitAvoidY: 1800,
    portraitInputRegion: [{left:0, top:1800, width:1200, height:800}],
    fullScreenMode: true
  };
  panel.adjustPanelRect(panelFlag, panelRect);
} catch(err) {
  console.error(`Failed to adjustPanelRect: ${JSON.stringify(err)}`);
}

updatelnputRegion¹⁵⁺

updateRegion(inputRegion: Array<window.Rect>): void

更新当前状态下输入法面板内的热区。

说明:

仅用于SOFT_KEYBOARD类型，状态为FLG_FIXED或FLG_FLOATING的面板。

此接口为同步接口，接口返回仅代表系统侧收到更新热区的请求，不代表已完成热区更新。

系统能力： SystemCapability.MiscServices.InputMethodFramework

参数：

参数名	类型	必填	说明
inputRegion	Array<window.Rect>	是	面板内接收输入事件的区域。 - 数组大小限制为[1, 4]。 - 传入的热区位置是相对于输入法面板窗口左顶点的位置。

错误码：

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

错误码ID	错误信息
401	parameter error. Possible causes: 1. Mandatory parameters are left unspecified; 2. Incorrect parameter types; 3. Parameter verification failed.
12800013	window manager service error.
12800017	invalid panel type or panel flag.

示例：

import { BusinessError } from '@kit.BasicServicesKit';
import { window } from '@kit.ArkUI';

try {
  let inputRegion: Array<window.Rect> = [{left:300, top:650, width:2000, height:500}];
  panel.updateRegion(inputRegion);
} catch(err) {
  console.error(`Failed to updateRegion: ${JSON.stringify(err)}`);
}

on('show')¹⁰⁺

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

监听当前面板显示状态，使用callback异步回调。

系统能力： SystemCapability.MiscServices.InputMethodFramework

参数：

参数名	类型	必填	说明
type	string	是	监听当前面板的状态类型，固定取值为'show'。
callback	() => void	是	回调函数。

示例：

try {
  panel.on('show', () => {
    console.info('Panel is showing.');
  });
} catch(err) {
    console.error(`Failed to show: ${JSON.stringify(err)}`);
}

on('hide')¹⁰⁺

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

监听当前面板隐藏状态，使用callback异步回调。

系统能力： SystemCapability.MiscServices.InputMethodFramework

参数：

参数名	类型	必填	说明
type	string	是	监听当前面板的状态类型，固定取值为'hide'。
callback	() => void	是	回调函数。

示例：

try {
  panel.on('hide', () => {
    console.info('Panel is hiding.');
  });
} catch(err) {
    console.error(`Failed to hide: ${JSON.stringify(err)}`);
}

on('sizeChange')¹²⁺

on(type: 'sizeChange', callback: SizeChangeCallback): void

监听当前面板大小变化，使用callback异步回调。

说明:

仅用于SOFT_KEYBOARD类型，状态为FLG_FIXED或FLG_FLOATING的面板。输入法通过adjustPanelRect等接口对面板大小进行调节时，系统会根据一定规则校验计算出最终的数值（例如超出屏幕等场景），输入法应用可通过该回调获取的真实面板大小，完成最终的面板布局刷新。

从API version 12-14开始支持，此接口回调函数中仅包含window.Size类型的必选参数。

从API version 15起，调用adjustPanelRect接口后，此接口回调函数增加KeyboardArea类型的可选参数。

系统能力： SystemCapability.MiscServices.InputMethodFramework

参数：

参数名	类型	必填	说明
type	string	是	监听当前面板的大小是否产生变化，固定值为'sizeChange'。
callback	SizeChangeCallback	是	回调函数。返回当前软键盘面板的大小，包含宽度和高度值。

示例：

import { window } from '@kit.ArkUI';
try {
  panel.on('sizeChange', (windowSize: window.Size) => {
    console.info(`panel size changed, width: ${windowSize.width}, height: ${windowSize.height}`);
  });
} catch(err) {
  console.error(`Failed to subscribe sizeChange: ${JSON.stringify(err)}`);
}
try {
  panel.on('sizeChange', (windowSize: window.Size, keyboardArea: inputMethodEngine.KeyboardArea) => {
    console.info(`panel size changed, windowSize: ${JSON.stringify(windowSize)}, keyboardArea: ${JSON.stringify(keyboardArea)}`);
  });
} catch(err) {
  console.error(`Failed to subscribe sizeChange: ${JSON.stringify(err)}`);
}

off('show')¹⁰⁺

off(type: 'show', callback?: () => void): void

取消监听当前输入法面板的隐藏状态，使用callback异步回调。

系统能力： SystemCapability.MiscServices.InputMethodFramework

参数：

参数名	类型	必填	说明
type	string	是	取消监听当前面板的状态类型，固定取值为'show'。
callback	() => void	否	取消订阅的回调函数。参数不填写时，取消订阅type对应的所有回调事件。

错误码：

以下错误码的详细介绍请参见通用错误码说明文档。

错误码ID	错误信息
401	parameter error. Possible causes: 1. Mandatory parameters are left unspecified; 2. Incorrect parameter types; 3. Parameter verification failed.

示例：

try {
  panel.off('show');
} catch(err) {
    console.error(`Failed to show: ${JSON.stringify(err)}`);
}

off('hide')¹⁰⁺

off(type: 'hide', callback?: () => void): void

取消监听当前面板隐藏状态，使用callback异步回调。

系统能力： SystemCapability.MiscServices.InputMethodFramework

参数：

参数名	类型	必填	说明
type	string	是	要取消监听的当前面板状态类型，固定取值为'hide'。
callback	() => void	否	取消订阅的回调函数。参数不填写时，取消订阅type对应的所有回调事件。

错误码：

以下错误码的详细介绍请参见通用错误码说明文档。

错误码ID	错误信息
401	parameter error. Possible causes: 1. Mandatory parameters are left unspecified; 2. Incorrect parameter types; 3. Parameter verification failed.

示例：

try {
  panel.off('hide');
} catch(err) {
    console.error(`Failed to hide: ${JSON.stringify(err)}`);
}

off('sizeChange')¹²⁺

off(type: 'sizeChange', callback?: SizeChangeCallback): void

取消监听当前面板大小变化，使用callback异步回调。

说明:

仅用于SOFT_KEYBOARD类型，状态为FLG_FIXED或FLG_FLOATING的面板。输入法通过adjustPanelRect等接口对面板大小进行调节时，系统会根据一定规则校验计算出最终的数值（例如超出屏幕等场景），输入法应用可通过该回调获取的真实面板大小，完成最终的面板布局刷新。

从API version 12-14开始支持，此接口回调函数中仅包含window.Size类型的必选参数。

从API version 15起，调用adjustPanelRect接口后，此接口回调函数增加KeyboardArea类型的可选参数。

系统能力： SystemCapability.MiscServices.InputMethodFramework

参数：

参数名	类型	必填	说明
type	string	是	监听当前面板的大小是否产生变化，固定取值为'sizeChange'。
callback	SizeChangeCallback	否	回调函数。返回当前软键盘面板的大小，包含宽度和高度值。

示例：

import { window } from '@kit.ArkUI';
try {
  panel.off('sizeChange', (windowSize: window.Size) => {
    console.info(`panel size changed, width: ${windowSize.width}, height: ${windowSize.height}`);
  });
} catch(err) {
    console.error(`Failed to subscribe sizeChange: ${JSON.stringify(err)}`);
}

changeFlag¹⁰⁺

changeFlag(flag: PanelFlag): void

将输入法应用的面板状态改变为固定态或者悬浮态，仅对SOFT_KEYBOARD生效。

系统能力： SystemCapability.MiscServices.InputMethodFramework

参数：

参数名	类型	必填	说明
flag	PanelFlag	是	目标面板状态类型。

错误码：

以下错误码的详细介绍请参见通用错误码说明文档。

错误码ID	错误信息
401	parameter error. Possible causes: 1. Mandatory parameters are left unspecified; 2. Incorrect parameter types; 3. Parameter verification failed.

示例：

try {
  let panelFlag = inputMethodEngine.PanelFlag.FLG_FIXED;
  panel.changeFlag(panelFlag);
} catch(err) {
    console.error(`Failed to panelFlag: ${JSON.stringify(err)}`);
}

setPrivacyMode¹¹⁺

setPrivacyMode(isPrivacyMode: boolean): void

将输入法应用的面板设置为隐私模式，隐私模式不可被录屏、截屏。

需要权限： ohos.permission.PRIVACY_WINDOW

系统能力： SystemCapability.MiscServices.InputMethodFramework

参数：

参数名	类型	必填	说明
isPrivacyMode	boolean	是	是否设置隐私模式。

错误码：

以下错误码的详细介绍请参见通用错误码说明文档。

错误码ID	错误信息
201	permissions check fails.
401	parameter error. Possible causes: 1. Mandatory parameters are left unspecified; 2. Incorrect parameter types.

示例：

try {
    let isPrivacyMode = true;
    panel.setPrivacyMode(isPrivacyMode);
} catch(err) {
    console.error(`Failed to set privacy mode: ${JSON.stringify(err)}`);
}

setImmersiveMode¹⁵⁺

setImmersiveMode(mode: ImmersiveMode): void

设置输入法应用的沉浸模式。只能设置不使用沉浸模式(NONE_IMMERSIVE)、浅色沉浸模式(LIGHT_IMMERSIVE)或深色沉浸模式(DARK_IMMERSIVE)。不能设置为沉浸模式(IMMERSIVE)。

系统能力： SystemCapability.MiscServices.InputMethodFramework

参数：

参数名	类型	必填	说明
mode	ImmersiveMode	是	沉浸模式。

错误码：

以下错误码的详细介绍请参见通用错误码说明文档和输入法框架错误码。

错误码ID	错误信息
401	parameter error. Possible causes: 1.Incorrect parameter types; 2.Parameter verification failed.
12800002	input method engine error.
12800013	window manager service error.

示例：

try {
  panel.setImmersiveMode(inputMethodEngine.ImmersiveMode.LIGHT_IMMERSIVE);
} catch (err) {
  console.error(`Failed to setImmersiveMode: ${JSON.stringify(err)}`);
}

getImmersiveMode¹⁵⁺

getImmersiveMode(): ImmersiveMode

获取输入法应用沉浸模式。

系统能力： SystemCapability.MiscServices.InputMethodFramework

返回值：

类型	说明
ImmersiveMode	沉浸模式。

示例：

try {
  let mode = panel.getImmersiveMode();
} catch (err) {
  console.error(`Failed to getImmersiveMode: ${JSON.stringify(err)}`);
}

KeyboardController

下列API均需使用on('inputStart')获取到KeyboardController实例后，通过实例调用。

hide⁹⁺

hide(callback: AsyncCallback<void>): void

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

系统能力： SystemCapability.MiscServices.InputMethodFramework

参数：

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

错误码：

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

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

示例：

import { BusinessError } from '@kit.BasicServicesKit';

keyboardController.hide((err: BusinessError) => {
  if (err) {
    console.error(`Failed to hide. Code:${err.code}, message:${err.message}`);
    return;
  }
  console.info('Succeeded in hiding keyboard.');
});

hide⁹⁺

hide(): Promise<void>

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

系统能力： SystemCapability.MiscServices.InputMethodFramework

返回值：

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

错误码：

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

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

示例：

import { BusinessError } from '@kit.BasicServicesKit';

keyboardController.hide().then(() => {
  console.info('Succeeded in hiding keyboard.');
}).catch((err: BusinessError) => {
  let error = err as BusinessError;
  console.error(`Failed to hide. Code:${error.code}, message:${error.message}`);
});

hideKeyboard^(deprecated)

hideKeyboard(callback: AsyncCallback<void>): void

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

说明：

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

系统能力： SystemCapability.MiscServices.InputMethodFramework

参数：

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

示例：

import { BusinessError } from '@kit.BasicServicesKit';

keyboardController.hideKeyboard((err: BusinessError) => {
  if (err) {
    console.error(`Failed to hideKeyboard: ${JSON.stringify(err)}`);
    return;
  }
  console.info('Succeeded in hiding keyboard.');
});

hideKeyboard^(deprecated)

hideKeyboard(): Promise<void>

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

说明：

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

系统能力： SystemCapability.MiscServices.InputMethodFramework

返回值：

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

示例：

import { BusinessError } from '@kit.BasicServicesKit';

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

exitCurrentInputType¹¹⁺

exitCurrentInputType(callback: AsyncCallback<void>): void

退出当前输入类型，仅支持系统配置的默认输入法应用调用。使用callback异步回调。

系统能力： SystemCapability.MiscServices.InputMethodFramework

参数：

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

错误码：

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

错误码ID	错误信息
12800008	input method manager service error.
12800010	not the preconfigured default input method.

示例：

import { BusinessError } from '@kit.BasicServicesKit';

keyboardController.exitCurrentInputType((err: BusinessError) => {
  if (err) {
    console.error(`Failed to exit current input type. Code:${err.code}, message:${err.message}`);
    return;
  }
  console.info('Succeeded in exiting current input type.');
});

exitCurrentInputType¹¹⁺

exitCurrentInputType(): Promise<void>

退出当前输入类型，仅支持系统配置的默认输入法应用调用。使用promise异步回调。

系统能力： SystemCapability.MiscServices.InputMethodFramework

返回值：

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

错误码：

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

错误码ID	错误信息
12800008	input method manager service error.
12800010	not the preconfigured default input method.

示例：

import { BusinessError } from '@kit.BasicServicesKit';

keyboardController.exitCurrentInputType().then(() => {
  console.info('Succeeded in exiting current input type.');
}).catch((err: BusinessError) => {
  let error = err as BusinessError;
  console.error(`Failed to exit current input type. Code:${error.code}, message:${error.message}`);
});

SecurityMode¹¹⁺

输入法的安全模式，如BASIC或FULL。

系统能力: SystemCapability.MiscServices.InputMethodFramework

名称	值	说明
BASIC	0	基础访问模式，基础打字模式，会限制网络访问。
FULL	1	完全访问模式，不做限制，可以访问网络。

ExtendAction¹⁰⁺

编辑框中文本的扩展编辑操作类型，如剪切、复制等。

系统能力: SystemCapability.MiscServices.InputMethodFramework

名称	值	说明
SELECT_ALL	0	全选。
CUT	3	剪切。
COPY	4	复制。
PASTE	5	粘贴。

Direction¹⁰⁺

光标的移动方向。

系统能力: SystemCapability.MiscServices.InputMethodFramework

名称	值	说明
CURSOR_UP	1	向上。
CURSOR_DOWN	2	向下。
CURSOR_LEFT	3	向左。
CURSOR_RIGHT	4	向右。

Range¹⁰⁺

选中的文本范围。

系统能力： SystemCapability.MiscServices.InputMethodFramework

名称	类型	只读	可选	说明
start	number	否	否	选中文本的首字符在编辑框的索引值。
end	number	否	否	选中文本的末字符在编辑框的索引值。

Movement¹⁰⁺

选中文本时，光标移动的方向

系统能力： SystemCapability.MiscServices.InputMethodFramework

名称	类型	只读	可选	说明
direction	Direction	否	否	选中文本时，光标的移动方向。

MessageHandler¹⁵⁺

自定义通信对象。

说明

开发者可通过注册此对象来接收已绑定当前输入法应用的编辑框应用所发送的自定义通信数据，接收到自定义通信数据时会触发此对象中onMessage回调函数。

此对象全局唯一，多次注册仅保留最后一次注册的对象及有效性，并触发上一个已注册对象的onTerminated回调函数。

若取消注册全局已注册的对象时，会触发被取消对象中onTerminated回调函数。

onMessage¹⁵⁺

onMessage(msgId: string, msgParam?: ArrayBuffer): void

接收已绑定当前输入法应用的编辑框应用发送的自定义数据回调函数。

说明

当已注册的MeesageHandler接收到来自已绑定当前输入法应用的编辑框应用所发送的自定义通信数据时，会触发该回调函数。

msgId为必选参数，msgParam为可选参数。存在收到仅有msgId自定义数据的可能，需与数据发送方确认自定义数据。

系统能力： SystemCapability.MiscServices.InputMethodFramework

参数：

参数名	类型	必填	说明
msgId	string	是	接收到的自定义通信数据的标识符。
msgParam	ArrayBuffer	否	接收到的自定义通信数据的消息体。

示例：

import { BusinessError } from '@kit.BasicServicesKit';

try {
  inputMethodEngine.getInputMethodAbility()
    .on('inputStart', (kbController: inputMethodEngine.KeyboardController, client: inputMethodEngine.InputClient) => {
      let keyboardController = kbController;
      let inputClient = client;
      try {
        let messageHandler: inputMethodEngine.MessageHandler = {
          onTerminated(): void {
            console.info('OnTerminated.');
          },
          onMessage(msgId: string, msgParam?:ArrayBuffer): void {
            console.info('recv message.');
          }
        }
        inputClient.recvMessage(messageHandler);
      } catch(err) {
        console.error(`Failed to recvMessage: ${JSON.stringify(err)}`);
      }
  });
} catch(err) {
    console.error(`Failed to InputMethodAbility: ${JSON.stringify(err)}`);
}

onTerminated¹⁵⁺

onTerminated(): void

监听对象终止回调函数。

说明

当应用注册新的MessageHandler对象时，会触发上一个已注册MessageHandler对象的OnTerminated回调函数。

当应用取消注册时，会触发当前已注册MessageHandler对象的OnTerminated回调函数。

系统能力： SystemCapability.MiscServices.InputMethodFramework

示例：

import { BusinessError } from '@kit.BasicServicesKit';

try {
  inputMethodEngine.getInputMethodAbility()
    .on('inputStart', (kbController: inputMethodEngine.KeyboardController, client: inputMethodEngine.InputClient) => {
      let keyboardController = kbController;
      let inputClient = client;
      try {
        let messageHandler: inputMethodEngine.MessageHandler = {
          onTerminated(): void {
            console.info('OnTerminated.');
          },
          onMessage(msgId: string, msgParam?:ArrayBuffer): void {
            console.info('recv message.');
          }
        }
        inputClient.recvMessage(messageHandler);
      } catch(err) {
        console.error(`Failed to recvMessage: ${JSON.stringify(err)}`);
      }
  });
} catch(err) {
    console.error(`Failed to InputMethodAbility: ${JSON.stringify(err)}`);
}

InputClient⁹⁺

下列API均需使用on('inputStart')获取到InputClient实例后，通过实例调用。

sendKeyFunction⁹⁺

sendKeyFunction(action:number, callback: AsyncCallback<boolean>): void

发送功能键。使用callback异步回调。

系统能力： SystemCapability.MiscServices.InputMethodFramework

参数：

参数名	类型	必填	说明
action	number	是	功能键键值。 - 当值为0时，表示无效按键。 - 当值为1时，表示确认键（即回车键）。
callback	AsyncCallback<boolean>	是	回调函数。当功能键发送成功，err为undefined，data为true；否则为错误对象。

错误码：

以下错误码的详细介绍请参见输入法框架错误码，通用错误码说明文档。

错误码ID	错误信息
401	parameter error. Possible causes: 1. Mandatory parameters are left unspecified; 2. Incorrect parameter types.
12800003	input method client error.

示例：

import { BusinessError } from '@kit.BasicServicesKit';

let action = 1;
try {
  inputClient.sendKeyFunction(action, (err: BusinessError, result: boolean) => {
    if (err) {
      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(`Failed to sendKeyFunction: ${JSON.stringify(err)}`);
}

sendKeyFunction⁹⁺

sendKeyFunction(action: number): Promise<boolean>

发送功能键。使用promise异步回调。

系统能力： SystemCapability.MiscServices.InputMethodFramework

参数：

参数名	类型	必填	说明
action	number	是	功能键键值。当值为0时，表示无效按键；当值为1时，表示确认键（即回车键）。

返回值：

类型	说明
Promise<boolean>	Promise对象。返回true表示功能键发送成功；返回false表示功能键发送失败。

错误码：

以下错误码的详细介绍请参见输入法框架错误码，通用错误码说明文档。

错误码ID	错误信息
401	parameter error. Possible causes: 1. Mandatory parameters are left unspecified; 2. Incorrect parameter types.
12800003	input method client error.

示例：

import { BusinessError } from '@kit.BasicServicesKit';

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

getForward⁹⁺

getForward(length:number, callback: AsyncCallback<string>): void

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

系统能力： SystemCapability.MiscServices.InputMethodFramework

参数：

参数名	类型	必填	说明
length	number	是	文本长度。不能小于0。
callback	AsyncCallback<string>	是	回调函数。当光标前固定长度的文本获取成功，err为undefined，data为获取到的文本；否则为错误对象。

错误码：

以下错误码的详细介绍请参见输入法框架错误码，通用错误码说明文档。

错误码ID	错误信息
401	parameter error. Possible causes: 1. Mandatory parameters are left unspecified; 2. Incorrect parameter types.
12800003	input method client error.
12800006	Input method controller error.

示例：

import { BusinessError } from '@kit.BasicServicesKit';

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

getForward⁹⁺

getForward(length:number): Promise<string>

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

系统能力： SystemCapability.MiscServices.InputMethodFramework

参数：

参数名	类型	必填	说明
length	number	是	文本长度。不能小于0

返回值：

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

错误码：

以下错误码的详细介绍请参见输入法框架错误码，通用错误码说明文档。

错误码ID	错误信息
401	parameter error. Possible causes: 1. Mandatory parameters are left unspecified; 2. Incorrect parameter types.
12800003	input method client error.
12800006	Input method controller error.

示例：

import { BusinessError } from '@kit.BasicServicesKit';

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

getForwardSync¹⁰⁺

getForwardSync(length:number): string

获取光标前固定长度的文本。

系统能力： SystemCapability.MiscServices.InputMethodFramework

参数：

参数名	类型	必填	说明
length	number	是	文本长度。不能小于0。

返回值：

类型	说明
string	返回光标前固定长度的文本。

错误码：

以下错误码的详细介绍请参见输入法框架错误码，通用错误码说明文档。

错误码ID	错误信息
401	parameter error. Possible causes: 1. Mandatory parameters are left unspecified; 2. Incorrect parameter types; 3. Parameter verification failed.
12800003	input method client error.
12800006	input method controller error.

示例：

let length = 1;
try {
  let text: string = inputClient.getForwardSync(length);
  console.info(`Succeeded in getting forward, text: ${text}`);
} catch (err) {
  console.error(`Failed to getForwardSync: ${JSON.stringify(err)}`);
}

getBackward⁹⁺

getBackward(length:number, callback: AsyncCallback<string>): void

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

系统能力： SystemCapability.MiscServices.InputMethodFramework

参数：

参数名	类型	必填	说明
length	number	是	文本长度。不能小于0。
callback	AsyncCallback<string>	是	回调函数。当光标后固定长度的文本获取成功，err为undefined，data为获取到的文本；否则为错误对象。

错误码：

以下错误码的详细介绍请参见输入法框架错误码，通用错误码说明文档。

错误码ID	错误信息
401	parameter error. Possible causes: 1. Mandatory parameters are left unspecified; 2. Incorrect parameter types.
12800003	input method client error.
12800006	Input method controller error.

示例：

import { BusinessError } from '@kit.BasicServicesKit';

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

getBackward⁹⁺

getBackward(length:number): Promise<string>

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

系统能力： SystemCapability.MiscServices.InputMethodFramework

参数：

参数名	类型	必填	说明
length	number	是	文本长度。不能小于0。

返回值：

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

错误码：

以下错误码的详细介绍请参见输入法框架错误码，通用错误码说明文档。

错误码ID	错误信息
401	parameter error. Possible causes: 1. Mandatory parameters are left unspecified; 2. Incorrect parameter types.
12800003	input method client error.
12800006	Input method controller error.

示例：

import { BusinessError } from '@kit.BasicServicesKit';

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

getBackwardSync¹⁰⁺

getBackwardSync(length:number): string

获取光标后固定长度的文本。

系统能力： SystemCapability.MiscServices.InputMethodFramework

参数：

参数名	类型	必填	说明
length	number	是	文本长度。不能小于0。

返回值：

类型	说明
string	返回光标后固定长度的文本。

错误码：

以下错误码的详细介绍请参见输入法框架错误码，通用错误码说明文档。

错误码ID	错误信息
401	parameter error. Possible causes: 1. Mandatory parameters are left unspecified; 2. Incorrect parameter types; 3. Parameter verification failed.
12800003	input method client error.
12800006	input method controller error.

示例：

let length = 1;
try {
  let text: string = inputClient.getBackwardSync(length);
  console.info(`Succeeded in getting backward, text: ${text}`);
} catch (err) {
  console.error(`Failed to getBackwardSync: ${JSON.stringify(err)}`);
}

deleteForward⁹⁺

deleteForward(length:number, callback: AsyncCallback<boolean>): void

删除光标前固定长度的文本。使用callback异步回调。

系统能力： SystemCapability.MiscServices.InputMethodFramework

参数：

参数名	类型	必填	说明
length	number	是	文本长度。不能小于0。
callback	AsyncCallback<boolean>	是	回调函数。当光标前固定长度的文本删除成功，err为undefined，data为true；否则为错误对象。

错误码：

以下错误码的详细介绍请参见输入法框架错误码，通用错误码说明文档。

错误码ID	错误信息
401	parameter error. Possible causes: 1. Mandatory parameters are left unspecified; 2. Incorrect parameter types.
12800002	Input method engine error.
12800003	input method client error.

示例：

import { BusinessError } from '@kit.BasicServicesKit';

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

deleteForward⁹⁺

deleteForward(length:number): Promise<boolean>

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

系统能力： SystemCapability.MiscServices.InputMethodFramework

参数：

参数名	类型	必填	说明
length	number	是	文本长度。不能小于0。

返回值：

类型	说明
Promise<boolean>	Promise对象。返回true表示删除光标前固定长度的文本成功；返回false表示删除光标前固定长度的文本失败。

错误码：

以下错误码的详细介绍请参见输入法框架错误码，通用错误码说明文档。

错误码ID	错误信息
401	parameter error. Possible causes: 1. Mandatory parameters are left unspecified; 2. Incorrect parameter types.
12800002	Input method engine error.
12800003	input method client error.

示例：

import { BusinessError } from '@kit.BasicServicesKit';

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

deleteForwardSync¹⁰⁺

deleteForwardSync(length:number): void

删除光标前固定长度的文本。

系统能力： SystemCapability.MiscServices.InputMethodFramework

参数：

参数名	类型	必填	说明
length	number	是	文本长度。不能小于0。

错误码：

以下错误码的详细介绍请参见输入法框架错误码，通用错误码说明文档。

错误码ID	错误信息
401	parameter error. Possible causes: 1. Mandatory parameters are left unspecified; 2. Incorrect parameter types; 3. Parameter verification failed.
12800002	input method engine error.
12800003	input method client error.

示例：

let length = 1;
try {
  inputClient.deleteForwardSync(length);
  console.info('Succeeded in deleting forward.');
} catch (err) {
  console.error('deleteForwardSync err: ' + JSON.stringify(err));
}

deleteBackward⁹⁺

deleteBackward(length:number, callback: AsyncCallback<boolean>): void

删除光标后固定长度的文本。使用callback异步回调。

系统能力： SystemCapability.MiscServices.InputMethodFramework

参数：

参数名	类型	必填	说明
length	number	是	文本长度。不能小于0。
callback	AsyncCallback<boolean>	是	回调函数。当光标后固定长度的文本删除成功，err为undefined，data为true；否则为错误对象。

错误码：

以下错误码的详细介绍请参见输入法框架错误码，通用错误码说明文档。

错误码ID	错误信息
401	parameter error. Possible causes: 1. Mandatory parameters are left unspecified; 2. Incorrect parameter types.
12800002	Input method engine error.
12800003	input method client error.

示例：

import { BusinessError } from '@kit.BasicServicesKit';

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

deleteBackward⁹⁺

deleteBackward(length:number): Promise<boolean>

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

系统能力： SystemCapability.MiscServices.InputMethodFramework

参数：

参数名	类型	必填	说明
length	number	是	文本长度。不能小于0。

返回值：

类型	说明
Promise<boolean>	Promise对象。返回true表示删除光标后固定长度的文本成功；返回false表示删除光标后固定长度的文本失败。

错误码：

以下错误码的详细介绍请参见输入法框架错误码，通用错误码说明文档。

错误码ID	错误信息
401	parameter error. Possible causes: 1. Mandatory parameters are left unspecified; 2. Incorrect parameter types.
12800002	Input method engine error.
12800003	input method client error.

示例：

import { BusinessError } from '@kit.BasicServicesKit';

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

deleteBackwardSync¹⁰⁺

deleteBackwardSync(length:number): void

删除光标后固定长度的文本。

系统能力： SystemCapability.MiscServices.InputMethodFramework

参数：

参数名	类型	必填	说明
length	number	是	文本长度。不能小于0。

错误码：

以下错误码的详细介绍请参见输入法框架错误码，通用错误码说明文档。

错误码ID	错误信息
401	parameter error. Possible causes: 1. Mandatory parameters are left unspecified; 2. Incorrect parameter types; 3. Parameter verification failed.
12800002	input method engine error.
12800003	input method client error.

示例：

let length = 1;
try {
  inputClient.deleteBackwardSync(length);
  console.info('Succeeded in deleting backward.');
} catch (err) {
  console.error('deleteBackwardSync err: ' + JSON.stringify(err));
}

insertText⁹⁺

insertText(text:string, callback: AsyncCallback<boolean>): void

插入文本。使用callback异步回调。

系统能力： SystemCapability.MiscServices.InputMethodFramework

参数：

参数名	类型	必填	说明
text	string	是	文本内容。
callback	AsyncCallback<boolean>	是	回调函数。当文本插入成功，err为undefined，data为true；否则为错误对象。

错误码：

以下错误码的详细介绍请参见输入法框架错误码，通用错误码说明文档。

错误码ID	错误信息
401	parameter error. Possible causes: 1. Mandatory parameters are left unspecified; 2. Incorrect parameter types.
12800002	Input method engine error.
12800003	input method client error.

示例：

import { BusinessError } from '@kit.BasicServicesKit';

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

insertText⁹⁺

insertText(text:string): Promise<boolean>

插入文本。使用promise异步回调。

系统能力： SystemCapability.MiscServices.InputMethodFramework

参数：

参数名	类型	必填	说明
text	string	是	文本。

返回值：

类型	说明
Promise<boolean>	Promise对象。返回true表示插入文本成功；返回false表示插入文本失败。

错误码：

以下错误码的详细介绍请参见输入法框架错误码，通用错误码说明文档。

错误码ID	错误信息
401	parameter error. Possible causes: 1. Mandatory parameters are left unspecified; 2. Incorrect parameter types.
12800002	Input method engine error.
12800003	input method client error.

示例：

import { BusinessError } from '@kit.BasicServicesKit';

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

insertTextSync¹⁰⁺

insertTextSync(text: string): void

插入文本。

系统能力： SystemCapability.MiscServices.InputMethodFramework

参数：

参数名	类型	必填	说明
text	string	是	文本内容。

错误码：

以下错误码的详细介绍请参见输入法框架错误码，通用错误码说明文档。

错误码ID	错误信息
401	parameter error. Possible causes: 1. Mandatory parameters are left unspecified; 2. Incorrect parameter types.
12800002	input method engine error.
12800003	input method client error.

示例：

try {
  inputClient.insertTextSync('test');
  console.info('Succeeded in inserting text.');
} catch (err) {
  console.error(`Failed to insertTextSync: ${JSON.stringify(err)}`);
}

getEditorAttribute⁹⁺

getEditorAttribute(callback: AsyncCallback<EditorAttribute>): void

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

系统能力： SystemCapability.MiscServices.InputMethodFramework

参数：

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

错误码：

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

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

示例：

import { BusinessError } from '@kit.BasicServicesKit';

inputClient.getEditorAttribute((err: BusinessError, editorAttribute: inputMethodEngine.EditorAttribute) => {
  if (err) {
    console.error(`Failed to getEditorAttribute: ${JSON.stringify(err)}`);
    return;
  }
  console.info(`editorAttribute.inputPattern:  ${editorAttribute.inputPattern}`);
  console.info(`editorAttribute.enterKeyType:  ${editorAttribute.enterKeyType}`);
});

getEditorAttribute⁹⁺

getEditorAttribute(): Promise<EditorAttribute>

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

系统能力： SystemCapability.MiscServices.InputMethodFramework

返回值：

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

错误码：

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

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

示例：

import { BusinessError } from '@kit.BasicServicesKit';

try {
  inputClient.getEditorAttribute().then((editorAttribute: inputMethodEngine.EditorAttribute) => {
    console.info(`editorAttribute.inputPattern:  ${editorAttribute.inputPattern}`);
    console.info(`editorAttribute.enterKeyType:  ${editorAttribute.enterKeyType}`);
  }).catch((err: BusinessError) => {
    console.error(`Failed to getEditorAttribute: ${JSON.stringify(err)}`);
  });
} catch(err) {
    console.error(`Failed to getEditorAttribute: ${JSON.stringify(err)}`);
}

getEditorAttributeSync¹⁰⁺

getEditorAttributeSync(): EditorAttribute

获取编辑框属性值。

系统能力： SystemCapability.MiscServices.InputMethodFramework

返回值：

类型	说明
EditorAttribute	编辑框属性对象。

错误码：

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

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

示例：

try {
  let editorAttribute: inputMethodEngine.EditorAttribute = inputClient.getEditorAttributeSync();
    console.info(`editorAttribute.inputPattern:  ${editorAttribute.inputPattern}`);
    console.info(`editorAttribute.enterKeyType:  ${editorAttribute.enterKeyType}`);
} catch (err) {
  console.error(`Failed to getEditorAttributeSync: ${JSON.stringify(err)}`);
}

moveCursor⁹⁺

moveCursor(direction: number, callback: AsyncCallback<void>): void

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

系统能力： SystemCapability.MiscServices.InputMethodFramework

参数：

参数名	类型	必填	说明
direction	number	是	光标移动方向。 - 当值为1时，表示向上。 - 当值为2时，表示向下。 - 当值为3时，表示向左。 - 当值为4时，表示向右。不能小于0。
callback	AsyncCallback<void>	是	回调函数。当光标移动成功，err为undefined，否则为错误对象。

错误码：

以下错误码的详细介绍请参见输入法框架错误码，通用错误码说明文档。

错误码ID	错误信息
401	parameter error. Possible causes: 1. Mandatory parameters are left unspecified; 2. Incorrect parameter types; 3. Parameter verification failed.
12800003	input method client error.

示例：

import { BusinessError } from '@kit.BasicServicesKit';

try {
  inputClient.moveCursor(inputMethodEngine.Direction.CURSOR_UP, (err: BusinessError) => {
    if (err) {
      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)}`);
}

moveCursor⁹⁺

moveCursor(direction: number): Promise<void>

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

系统能力： SystemCapability.MiscServices.InputMethodFramework

参数：

参数名	类型	必填	说明
direction	number	是	光标移动方向。 - 当值为1时，表示向上。 - 当值为2时，表示向下。 - 当值为3时，表示向左。 - 当值为4时，表示向右。不能小于0。

返回值：

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

错误码：

以下错误码的详细介绍请参见输入法框架错误码，通用错误码说明文档。

错误码ID	错误信息
401	parameter error. Possible causes: 1. Mandatory parameters are left unspecified; 2. Incorrect parameter types; 3. Parameter verification failed.
12800003	input method client error.

示例：

import { BusinessError } from '@kit.BasicServicesKit';

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

moveCursorSync¹⁰⁺

moveCursorSync(direction: number): void

移动光标。

系统能力： SystemCapability.MiscServices.InputMethodFramework

参数：

参数名	类型	必填	说明
direction	number	是	光标移动方向。 - 当值为1时，表示向上。 - 当值为2时，表示向下。 - 当值为3时，表示向左。 - 当值为4时，表示向右。不能小于0。

错误码：

以下错误码的详细介绍请参见输入法框架错误码，通用错误码说明文档。

错误码ID	错误信息
401	parameter error. Possible causes: 1. Mandatory parameters are left unspecified; 2. Incorrect parameter types; 3. Parameter verification failed.
12800003	input method client error.

示例：

try {
  inputClient.moveCursorSync(inputMethodEngine.Direction.CURSOR_UP);
  console.info('Succeeded in moving cursor.');
} catch (err) {
  console.error(`Failed to moveCursorSync: ${JSON.stringify(err)}`);
}

selectByRange¹⁰⁺

selectByRange(range: Range, callback: AsyncCallback<void>): void

根据索引范围选中文本。使用callback异步回调。

系统能力： SystemCapability.MiscServices.InputMethodFramework

参数：

参数名	类型	必填	说明
range	Range	是	选中文本的范围。
callback	AsyncCallback<void>	是	回调函数。当成功发送选中事件后，err为undefined，否则为错误对象。

错误码：

以下错误码的详细介绍请参见输入法框架错误码，通用错误码说明文档。

错误码ID	错误信息
401	parameter error. Possible causes: 1. Mandatory parameters are left unspecified; 2. Incorrect parameter types; 3. Parameter verification failed.
12800003	input method client error.

示例：

import { BusinessError } from '@kit.BasicServicesKit';

try {
  let range: inputMethodEngine.Range = { start: 0, end: 1 };
  inputClient.selectByRange(range, (err: BusinessError) => {
    if (err) {
      console.error(`Failed to selectByRange: ${JSON.stringify(err)}`);
      return;
    }
    console.info('Succeeded in selecting by range.');
  });
} catch (err) {
  console.error(`Failed to selectByRange: ${JSON.stringify(err)}`);
}

selectByRange¹⁰⁺

selectByRange(range: Range): Promise<void>

根据索引范围选中文本。使用promise异步回调。

系统能力： SystemCapability.MiscServices.InputMethodFramework

参数：

参数名	类型	必填	说明
range	Range	是	选中文本的范围。

返回值：

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

错误码：

以下错误码的详细介绍请参见输入法框架错误码，通用错误码说明文档。

错误码ID	错误信息
401	parameter error. Possible causes: 1. Mandatory parameters are left unspecified; 2. Incorrect parameter types; 3. Parameter verification failed.
12800003	input method client error.

示例：

import { BusinessError } from '@kit.BasicServicesKit';

try {
  let range: inputMethodEngine.Range = { start: 0, end: 1 };
  inputClient.selectByRange(range).then(() => {
    console.info('Succeeded in selecting by range.');
  }).catch((err: BusinessError) => {
    console.error(`Failed to selectByRange: ${JSON.stringify(err)}`);
  });
} catch (err) {
  console.error(`Failed to selectByRange: ${JSON.stringify(err)}`);
}

selectByRangeSync¹⁰⁺

selectByRangeSync(range: Range): void

根据索引范围选中文本。

系统能力： SystemCapability.MiscServices.InputMethodFramework

参数：

参数名	类型	必填	说明
range	Range	是	选中文本的范围。

错误码：

以下错误码的详细介绍请参见输入法框架错误码，通用错误码说明文档。

错误码ID	错误信息
401	parameter error. Possible causes: 1. Mandatory parameters are left unspecified; 2. Incorrect parameter types; 3. Parameter verification failed.
12800003	input method client error.

示例：

try {
  let range: inputMethodEngine.Range = { start: 0, end: 1 };
  inputClient.selectByRangeSync(range);
  console.info('Succeeded in selecting by range.');
} catch (err) {
  console.error(`Failed to selectByRangeSync: ${JSON.stringify(err)}`);
}

selectByMovement¹⁰⁺

selectByMovement(movement: Movement, callback: AsyncCallback<void>): void

根据光标移动方向选中文本。使用callback异步回调。

系统能力： SystemCapability.MiscServices.InputMethodFramework

参数：

参数名	类型	必填	说明
movement	Movement	是	选中时光标移动的方向。
callback	AsyncCallback<void>	是	回调函数。当成功发送选中事件后，err为undefined，否则为错误对象。

错误码：

以下错误码的详细介绍请参见输入法框架错误码，通用错误码说明文档。

错误码ID	错误信息
401	parameter error. Possible causes: 1. Mandatory parameters are left unspecified; 2. Incorrect parameter types; 3. Parameter verification failed.
12800003	input method client error.

示例：

import { BusinessError } from '@kit.BasicServicesKit';

try {
  let movement: inputMethodEngine.Movement = { direction: 1 };
  inputClient.selectByMovement(movement, (err: BusinessError) => {
    if (err) {
      console.error(`Failed to selectByMovement: ${JSON.stringify(err)}`);
      return;
    }
    console.info('Succeeded in selecting by movement.');
  });
} catch (err) {
  console.error(`Failed to selectByMovement: ${JSON.stringify(err)}`);
}

selectByMovement¹⁰⁺

selectByMovement(movement: Movement): Promise<void>

根据索引范围选中文本。使用promise异步回调。

系统能力： SystemCapability.MiscServices.InputMethodFramework

参数：

参数名	类型	必填	说明
movement	Movement	是	选中时光标移动的方向。

返回值：

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

错误码：

以下错误码的详细介绍请参见输入法框架错误码，通用错误码说明文档。

错误码ID	错误信息
401	parameter error. Possible causes: 1. Mandatory parameters are left unspecified; 2. Incorrect parameter types; 3. Parameter verification failed.
12800003	input method client error.

示例：

import { BusinessError } from '@kit.BasicServicesKit';

try {
  let movement: inputMethodEngine.Movement = { direction: 1 };
  inputClient.selectByMovement(movement).then(() => {
    console.info('Succeeded in selecting by movement.');
  }).catch((err: BusinessError) => {
    console.error(`Failed to selectByMovement: ${JSON.stringify(err)}`);
  });
} catch (err) {
  console.error(`Failed to selectByMovement: ${JSON.stringify(err)}`);
}

selectByMovementSync¹⁰⁺

selectByMovementSync(movement: Movement): void

根据光标移动方向选中文本。

系统能力： SystemCapability.MiscServices.InputMethodFramework

参数：

参数名	类型	必填	说明
movement	Movement	是	选中时光标移动的方向。

错误码：

以下错误码的详细介绍请参见输入法框架错误码，通用错误码说明文档。

错误码ID	错误信息
401	parameter error. Possible causes: 1. Mandatory parameters are left unspecified; 2. Incorrect parameter types.
12800003	input method client error.

示例：

try {
  let movement: inputMethodEngine.Movement = { direction: 1 };  
  inputClient.selectByMovementSync(movement);
  console.info('Succeeded in selecting by movement.');
} catch (err) {
  console.error(`Failed to selectByMovement: ${JSON.stringify(err)}`);
}

getTextIndexAtCursor¹⁰⁺

getTextIndexAtCursor(callback: AsyncCallback<number>): void

获取光标所在处的文本索引。使用callback异步回调。

系统能力： SystemCapability.MiscServices.InputMethodFramework

参数：

参数名	类型	必填	说明
callback	AsyncCallback<number>	是	回调函数。当文本索引获取成功，err为undefined，否则为错误对象。

错误码：

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

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

示例：

import { BusinessError } from '@kit.BasicServicesKit';

inputClient.getTextIndexAtCursor((err: BusinessError, index: number) => {
  if (err) {
    console.error(`Failed to getTextIndexAtCursor: ${JSON.stringify(err)}`);
    return;
  }
  console.info('Succeeded in getTextIndexAtCursor: ' + index);
});

getTextIndexAtCursor¹⁰⁺

getTextIndexAtCursor(): Promise<number>

获取光标所在处的文本索引。使用promise异步回调。

系统能力： SystemCapability.MiscServices.InputMethodFramework

返回值：

类型	说明
Promise<number>	Promise对象，返回光标所在处的文本索引。

错误码：

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

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

示例：

import { BusinessError } from '@kit.BasicServicesKit';

inputClient.getTextIndexAtCursor().then((index: number) => {
  console.info('Succeeded in getTextIndexAtCursor: ' + index);
}).catch((err: BusinessError) => {
  console.error(`Failed to getTextIndexAtCursor: ${JSON.stringify(err)}`);
});

getTextIndexAtCursorSync¹⁰⁺

getTextIndexAtCursorSync(): number

获取光标所在处的文本索引。

系统能力： SystemCapability.MiscServices.InputMethodFramework

返回值：

类型	说明
number	返回光标所在处的文本索引。

错误码：

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

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

示例：

try{
  let index: number = inputClient.getTextIndexAtCursorSync();
  console.info(`Succeeded in getTextIndexAtCursorSync, index: ${index}`);
} catch (err) {
  console.error(`Failed to getTextIndexAtCursorSync: ${JSON.stringify(err)}`);
}

sendExtendAction¹⁰⁺

sendExtendAction(action: ExtendAction, callback: AsyncCallback<void>): void

发送扩展编辑操作。使用callback异步回调。

说明

输入法应用调用该接口向编辑框发送扩展编辑操作，编辑框监听相应事件on('handleExtendAction')，从而进一步做出处理。

系统能力： SystemCapability.MiscServices.InputMethodFramework

参数：

参数名	类型	必填	说明
action	ExtendAction	是	要发送的扩展操作。
callback	AsyncCallback<void>	是	回调函数。发送成功，err为undefined，否则为错误对象。

错误码：

以下错误码的详细介绍请参见输入法框架错误码，通用错误码说明文档。

错误码ID	错误信息
401	parameter error. Possible causes: 1. Mandatory parameters are left unspecified; 2. Incorrect parameter types.
12800003	input method client error.
12800006	Input method controller error.

示例：

import { BusinessError } from '@kit.BasicServicesKit';

try {
  inputClient.sendExtendAction(inputMethodEngine.ExtendAction.COPY, (err: BusinessError) => {
    if (err) {
      console.error(`Failed to sendExtendAction: ${JSON.stringify(err)}`);
      return;
    }
    console.info('Succeeded in sending extend action.');
  });
} catch(err) {
  console.error(`Failed to sendExtendAction: ${JSON.stringify(err)}`);
}

sendExtendAction¹⁰⁺

sendExtendAction(action: ExtendAction): Promise<void>

发送扩展编辑操作。使用promise异步回调。

说明

输入法应用调用该接口向编辑框发送扩展编辑操作，编辑框监听相应事件on('handleExtendAction')，从而进一步做出处理。

系统能力： SystemCapability.MiscServices.InputMethodFramework

参数：

参数名	类型	必填	说明
action	ExtendAction	是	要发送的扩展操作。

返回值：

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

错误码：

以下错误码的详细介绍请参见输入法框架错误码，通用错误码说明文档。

错误码ID	错误信息
401	parameter error. Possible causes: 1. Mandatory parameters are left unspecified; 2. Incorrect parameter types.
12800003	input method client error.
12800006	Input method controller error.

示例：

import { BusinessError } from '@kit.BasicServicesKit';

try {
  inputClient.sendExtendAction(inputMethodEngine.ExtendAction.COPY).then(() => {
    console.info('Succeeded in sending extend action.');
  }).catch((err: BusinessError) => {
    console.error(`Failed to sendExtendAction: ${JSON.stringify(err)}`);
  });
} catch(err) {
  console.error(`Failed to sendExtendAction: ${JSON.stringify(err)}`);
}

sendPrivateCommand¹²⁺

sendPrivateCommand(commandData: Record<string, CommandDataType>): Promise<void>

发送私有数据至需要与输入法应用通信的系统其他部分。

说明:

私有数据通道是系统预置输入法应用与系统特定组件（如文本框、桌面应用等）的通信机制，常用于设备级厂商在特定设备上实现自定义的输入法功能。

私有数据规格限制：总大小32KB，数量限制5条。

系统能力： SystemCapability.MiscServices.InputMethodFramework

参数：

参数名	类型	必填	说明
commandData	Record<string, CommandDataType>	是	私有数据。

返回值：

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

错误码：

以下错误码的详细介绍请参见输入法框架错误码，通用错误码说明文档。

错误码ID	错误信息
401	parameter error. Possible causes: 1. Mandatory parameters are left unspecified; 2. Incorrect parameter types; 3. Parameter verification failed.
12800003	input method client error.
12800010	not the preconfigured default input method.

示例：

import { inputMethodEngine } from '@kit.IMEKit';
import { BusinessError } from '@kit.BasicServicesKit';

inputMethodEngine.getInputMethodAbility().on('inputStart', (kbController, textInputClient) => {
  try {
    let record: Record<string, inputMethodEngine.CommandDataType> = {
      "valueString1": "abcdefg",
      "valueString2": true,
      "valueString3": 500,
    }
    textInputClient.sendPrivateCommand(record).then(() => {
    }).catch((err: BusinessError) => {
      if (err !== undefined) {
        let error = err as BusinessError;
        console.error(`sendPrivateCommand catch error: ${error.code} ${error.message}`);
      }
    });
  } catch (err) {
    let error = err as BusinessError;
    console.error(`sendPrivateCommand catch error: ${error.code} ${error.message}`);
  }
})

getCallingWindowInfo¹²⁺

getCallingWindowInfo(): Promise<WindowInfo>

获取当前拉起输入法的输入框所在应用窗口信息。使用promise异步回调。

说明：

本接口仅适用于适配使用Panel作为软键盘窗口的输入法应用。

系统能力： SystemCapability.MiscServices.InputMethodFramework

返回值：

类型	说明
Promise<WindowInfo>	Promise对象，返回拉起输入法的输入框所在应用窗口信息。

错误码：

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

错误码ID	错误信息
12800003	input method client error.
12800012	the input method panel does not exist.
12800013	window manager service error.

示例：

import { BusinessError } from '@kit.BasicServicesKit';

try {
  inputClient.getCallingWindowInfo().then((windowInfo: inputMethodEngine.WindowInfo) => {
    console.info(`windowInfo.rect: ${JSON.stringify(windowInfo.rect)}`);
    console.info('windowInfo.status: ' + JSON.stringify(windowInfo.status));
  }).catch((err: BusinessError) => {
    console.error(`Failed to getCallingWindowInfo: ${JSON.stringify(err)}`);
  });
} catch(err) {
    console.error(`Failed to getCallingWindowInfo: ${JSON.stringify(err)}`);
}

setPreviewText¹²⁺

setPreviewText(text: string, range: Range): Promise<void>

设置预上屏文本。使用promise异步回调。

系统能力： SystemCapability.MiscServices.InputMethodFramework

参数：

参数名	类型	必填	说明
text	string	是	将被预上屏的文本。
range	Range	是	目标替换的文本范围。 - 当值为{ start: -1, end: -1 }时，默认将参数text替换当前预上屏区域全部文本。 - 当start等于end，默认将参数text插入start对应的光标位置。 - 当start不等于end，将参数text替换range对应区域的文本。 - 当start与end为其他含有负数值的组合，按照参数错误返回。 - 当输入框已有预上屏文本，参数range不得超过预上屏文本范围，否则按照参数错误返回。 - 当输入框无预上屏文本，参数range不得超过输入框文本范围，否则按照参数错误返回。

返回值：

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

错误码：

以下错误码的详细介绍请参见输入法框架错误码，通用错误码说明文档。

错误码ID	错误信息
401	parameter error. Possible causes: 1. Mandatory parameters are left unspecified; 2. Incorrect parameter types; 3. Parameter verification failed.
12800003	input method client error.
12800011	text preview not supported.

示例：

import { BusinessError } from '@kit.BasicServicesKit';

try {
  let range: inputMethodEngine.Range = { start: 0, end: 1 };
  inputClient.setPreviewText('test', range).then(() => {
    console.info('Succeeded in setting preview text.');
  }).catch((err: BusinessError) => {
    console.error(`Failed to setPreviewText: ${JSON.stringify(err)}`);
  });
} catch(err) {
    console.error(`Failed to setPreviewText: ${JSON.stringify(err)}`);
}

setPreviewTextSync¹²⁺

setPreviewTextSync(text: string, range: Range): void

设置预上屏文本。

系统能力： SystemCapability.MiscServices.InputMethodFramework

参数：

参数名	类型	必填	说明
text	string	是	将被预上屏的文本。
range	Range	是	目标替换的文本范围。 - 当值为{ start: -1, end: -1 }时，默认将参数text替换当前预上屏区域全部文本。 - 当start等于end，默认将参数text插入start对应的光标位置。 - 当start不等于end，将参数text替换range对应区域的文本。 - 当start与end为其他含有负数值的组合，按照参数错误返回。 - 当输入框已有预上屏文本，参数range不得超过预上屏文本范围，否则按照参数错误返回。 - 当输入框无预上屏文本，参数range不得超过输入框文本范围，否则按照参数错误返回。

错误码：

以下错误码的详细介绍请参见输入法框架错误码，通用错误码说明文档。

错误码ID	错误信息
401	parameter error. Possible causes: 1. Mandatory parameters are left unspecified; 2. Incorrect parameter types; 3. Parameter verification failed.
12800003	input method client error.
12800011	text preview not supported.

示例：

try {
  let range: inputMethodEngine.Range = { start: 0, end: 1 };
  inputClient.setPreviewTextSync('test', range);
  console.info('Succeeded in setting preview text with synchronized method.');
} catch (err) {
  console.error(`Failed to setPreviewTextSync: ${JSON.stringify(err)}`);
}

finishTextPreview¹²⁺

finishTextPreview(): Promise<void>

结束预上屏。使用promise异步回调。

说明：

若当前输入框已有预上屏状态文本，调用此接口后，预上屏内容将被系统正式上屏。

系统能力： SystemCapability.MiscServices.InputMethodFramework

返回值：

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

错误码：

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

错误码ID	错误信息
12800003	input method client error.
12800011	text preview not supported.

示例：

import { BusinessError } from '@kit.BasicServicesKit';

try {
  inputClient.finishTextPreview().then(() => {
    console.info('Succeeded in finishing text preview.');
  }).catch((err: BusinessError) => {
    console.error(`Failed to finishTextPreview: ${JSON.stringify(err)}`);
  });
} catch(err) {
    console.error(`Failed to finishTextPreview: ${JSON.stringify(err)}`);
}

finishTextPreviewSync¹²⁺

finishTextPreviewSync(): void

结束预上屏。

说明：

若当前输入框已有预上屏状态文本，调用此接口后，预上屏内容将被系统正式上屏。

系统能力： SystemCapability.MiscServices.InputMethodFramework

错误码：

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

错误码ID	错误信息
12800003	input method client error.
12800011	text preview not supported.

示例：

try {
  inputClient.finishTextPreviewSync();
  console.info('Succeeded in finishing text preview with synchronized method.');
} catch (err) {
  console.error(`Failed to finishTextPreviewSync: ${JSON.stringify(err)}`);
}

sendMessage¹⁵⁺

sendMessage(msgId: string, msgParam?: ArrayBuffer): Promise<void>

发送自定义通信至已绑定当前输入法应用的编辑框应用。使用Promise异步回调。

说明：

该接口需要编辑框与输入法绑定并进入编辑状态，且输入法应用处于完整体验模式时才能调用。

msgId最大限制256B，msgParam最大限制128KB。

系统能力： SystemCapability.MiscServices.InputMethodFramework

参数：

参数名	类型	必填	说明
msgId	string	是	需要发送至已绑定当前输入法应用的编辑框应用的自定义数据的标识符。
msgParam	ArrayBuffer	否	需要发送至已绑定当前输入法应用的编辑框应用的自定义数据的消息体。

返回值：

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

错误码：

以下错误码的详细介绍请参见输入法框架错误码，通用错误码说明文档。

错误码ID	错误信息
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.

示例：

import { BusinessError } from '@kit.BasicServicesKit';

let msgId: string = "testMsgId";
let msgParam: ArrayBuffer = new ArrayBuffer(128);
inputClient.sendMessage(msgId, msgParam).then(() => {
  console.info('Succeeded send message.');
}).catch((err: BusinessError) => {
  console.error(`Failed to send message: ${JSON.stringify(err)}`);
});

recvMessage¹⁵⁺

recvMessage(msgHandler?: MessageHandler): void;

注册或取消注册Messagehandler。

说明：

MessageHandler对象全局唯一，多次注册仅保留最后一次注册的对象及有效性，并触发上一个已注册对象的onTerminated回调函数。

未填写参数，则取消全局已注册的MessageHandler，并会触发被取消注册对象中onTerminated回调函数。

系统能力： SystemCapability.MiscServices.InputMethodFramework

参数：

参数名	类型	必填	说明
msgHandler	MessageHandler	否	该对象将通过onMessage接收来自已绑定当前输入法应用的编辑框应用所发送的自定义通信数据，以及onTerminated接收终止此对象订阅的消息。若不填写此参数，则取消全局已注册的MessageHandler对象，并触发其onTerminated回调函数。

返回值：

类型	说明
void	无返回结果。

错误码：

以下错误码的详细介绍请参见输入法框架错误码，通用错误码说明文档。

错误码ID	错误信息
401	parameter error. Possible causes: 1. Incorrect parameter types.

示例：

import { BusinessError } from '@kit.BasicServicesKit';

try {
  inputMethodEngine.getInputMethodAbility()
    .on('inputStart', (kbController: inputMethodEngine.KeyboardController, client: inputMethodEngine.InputClient) => {
      let keyboardController = kbController;
      let inputClient = client;
      try {
        let messageHandler: inputMethodEngine.MessageHandler = {
          onTerminated(): void {
            console.info('OnTerminated.');
          },
          onMessage(msgId: string, msgParam?:ArrayBuffer): void {
            console.info('recv message.');
          }
        }
        inputClient.recvMessage(messageHandler);
      } catch(err) {
        console.error(`Failed to recvMessage: ${JSON.stringify(err)}`);
      }
  });
} catch(err) {
    console.error(`Failed to InputMethodAbility: ${JSON.stringify(err)}`);
}

EditorAttribute

编辑框属性值。

系统能力： SystemCapability.MiscServices.InputMethodFramework

名称	类型	只读	可选	说明
enterKeyType	number	是	否	编辑框的功能属性，详见常量中的功能键定义。
inputPattern	number	是	否	编辑框的文本属性，详见常量中的编译框定义。
isTextPreviewSupported¹²⁺	boolean	否	否	编辑框是否支持预上屏。
bundleName¹⁴⁺	string	是	是	编辑框所属应用包名；该值可能为""，使用该属性时需要考虑为""的场景。
immersiveMode¹⁵⁺	ImmersiveMode	是	是	输入法沉浸模式。
windowId¹⁸⁺	number	是	是	编辑框设置所属窗口ID。
displayId¹⁸⁺	number	是	是	编辑框设置窗口对应的屏幕ID。如果没有设置windowId，取当前焦点窗口屏幕ID。

KeyEvent

按键属性值。

系统能力： SystemCapability.MiscServices.InputMethodFramework

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

PanelFlag¹⁰⁺

输入法面板状态类型枚举。

系统能力： SystemCapability.MiscServices.InputMethodFramework

名称	值	说明
FLG_FIXED	0	固定态面板类型。
FLG_FLOATING	1	悬浮态面板类型。
FLAG_CANDIDATE¹⁵⁺	2	候选词态面板类型。

PanelType¹⁰⁺

输入法面板类型枚举。

系统能力： SystemCapability.MiscServices.InputMethodFramework

名称	值	说明
SOFT_KEYBOARD	0	软键盘类型。
STATUS_BAR	1	状态栏类型。

PanelInfo¹⁰⁺

输入法面板属性。

系统能力： SystemCapability.MiscServices.InputMethodFramework

名称	类型	只读	可选	说明
type	PanelType	否	否	面板的类型。
flag	PanelFlag	否	是	面板的状态类型。

PanelRect¹²⁺

输入法面板位置大小信息。

系统能力： SystemCapability.MiscServices.InputMethodFramework

名称	类型	只读	可选	说明
landscapeRect	window.Rect	否	否	横屏状态时输入法面板窗口的位置大小。
portraitRect	window.Rect	否	否	竖屏状态时输入法面板窗口的位置大小。

EnhancedPanelRect¹⁵⁺

增强的输入法面板位置、大小信息，包含自定义避让区域、自定义热区。

系统能力： SystemCapability.MiscServices.InputMethodFramework

名称	类型	只读	可选	说明
landscapeRect	window.Rect	否	是	横屏状态时输入法面板窗口的位置大小。 - 当fullScreenMode不填写或值为false时，此属性为必选。
portraitRect	window.Rect	否	是	竖屏状态时，输入法面板窗口的位置大小。 - 当fullScreenMode不填写或值为false时，此属性为必选。
landscapeAvoidY	number	否	是	横屏状态时，面板中的避让线距离面板顶部的距离。默认值为0。 - 应用内其他系统组件会对避让线以下的输入法面板区域进行避让。 - 面板为固定态时，避让线到屏幕底部的高度不能超过屏幕高度的70%。
landscapeInputRegion	Array<window.Rect>	否	是	横屏状态时，面板接收输入事件的区域。 - 数组大小限制为[1, 4]。默认值为横屏时的面板大小。 - 传入的热区位置是相对于输入法面板窗口左顶点的位置。
portraitAvoidY	number	否	是	竖屏状态时，面板中的避让线距离面板顶部的距离。默认值为0。 - 应用内其他系统组件会对避让线以下的输入法面板区域进行避让。 - 面板为固定态时，避让线到屏幕底部的高度不能超过屏幕高度的70%。
portraitInputRegion	Array<window.Rect>	否	是	竖屏状态时，面板接收输入事件的区域。 - 数组大小限制为[1, 4]。默认值为竖屏时的面板大小。 - 传入的热区位置是相对于输入法面板窗口左顶点的位置。
fullScreenMode	boolean	否	是	是否开启全屏模式。默认值为false。 - 值为true，landscapeRect和portraitRect可不填写。 - 值为false，landscapeRect和portraitRect为必选属性。

KeyboardArea¹⁵⁺

面板中的键盘区域。

系统能力： SystemCapability.MiscServices.InputMethodFramework

名称	类型	只读	可选	说明
top	number	是	否	键盘区域的上边界到面板区域上边界的距离，单位为px，该参数为整数。
bottom	number	是	否	键盘区域的下边界到面板区域下边界的距离，单位为px，该参数为整数。
left	number	是	否	键盘区域的左边界到面板区域左边界的距离，单位为px，该参数为整数。
right	number	是	否	键盘区域的右边界到面板区域右边界的距离，单位为px，该参数为整数。

WindowInfo¹²⁺

窗口信息。

系统能力： SystemCapability.MiscServices.InputMethodFramework

名称	类型	只读	可选	说明
rect	window.Rect	否	否	窗口矩形区域。
status	window.WindowStatusType	否	否	窗口模式类型。

ImmersiveMode¹⁵⁺

枚举，输入法沉浸模式。

系统能力： SystemCapability.MiscServices.InputMethodFramework

名称	值	说明
NONE_IMMERSIVE	0	不使用沉浸模式。
IMMERSIVE	1	沉浸模式，由输入法应用确定沉浸模式类型。
LIGHT_IMMERSIVE	2	浅色沉浸模式。
DARK_IMMERSIVE	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	是	文本长度。不能小于0。
callback	AsyncCallback<string>	是	回调函数。当光标前固定长度的文本获取成功，err为undefined，data为获取到的文本；否则为错误对象。

示例：

import { BusinessError } from '@kit.BasicServicesKit';

let length = 1;
textInputClient.getForward(length, (err: BusinessError, text: string) => {
  if (err) {
    console.error(`Failed to getForward: ${JSON.stringify(err)}`);
    return;
  }
  console.info('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	是	文本长度。不能小于0。

返回值：

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

示例：

import { BusinessError } from '@kit.BasicServicesKit';

let length = 1;
textInputClient.getForward(length).then((text: string) => {
  console.info('Succeeded in getting forward, text: ' + text);
}).catch((err: BusinessError) => {
  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	是	文本长度。不能小于0。
callback	AsyncCallback<string>	是	回调函数。当光标后固定长度的文本获取成功，err为undefined，data为获取到的文本；否则为错误对象。

示例：

import { BusinessError } from '@kit.BasicServicesKit';

let length = 1;
textInputClient.getBackward(length, (err: BusinessError, text: string) => {
  if (err) {
    console.error(`Failed to getBackward: ${JSON.stringify(err)}`);
    return;
  }
  console.info('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	是	文本长度。不能小于0。

返回值：

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

示例：

import { BusinessError } from '@kit.BasicServicesKit';

let length = 1;
textInputClient.getBackward(length).then((text: string) => {
  console.info('Succeeded in getting backward: ' + JSON.stringify(text));
}).catch((err: BusinessError) => {
  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	是	文本长度。不能小于0。
callback	AsyncCallback<boolean>	是	回调函数。当光标前固定长度的文本删除成功，err为undefined，data为true；否则为错误对象。

示例：

import { BusinessError } from '@kit.BasicServicesKit';

let length = 1;
textInputClient.deleteForward(length, (err: BusinessError, result: boolean) => {
  if (err) {
    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	是	文本长度。不能小于0。

返回值：

类型	说明
Promise<boolean>	Promise对象。返回true表示删除光标前固定长度的文本成功；返回false表示删除光标前固定长度的文本失败。

示例：

import { BusinessError } from '@kit.BasicServicesKit';

let length = 1;
textInputClient.deleteForward(length).then((result: boolean) => {
  if (result) {
    console.info('Succeeded in deleting forward.');
  } else {
    console.error('Failed to delete forward.');
  }
}).catch((err: BusinessError) => {
  console.error(`Failed to deleteForward: ${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	是	文本长度。不能小于0。
callback	AsyncCallback<boolean>	是	回调函数。当光标后固定长度的文本删除成功，err为undefined，data为true；否则为错误对象。

示例：

import { BusinessError } from '@kit.BasicServicesKit';

let length = 1;
textInputClient.deleteBackward(length, (err: BusinessError, result: boolean) => {
  if (err) {
    console.error(`Failed to deleteBackward: ${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>

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

说明：

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

系统能力： SystemCapability.MiscServices.InputMethodFramework

参数：

参数名	类型	必填	说明
length	number	是	文本长度。不能小于0。

返回值：

类型	说明
Promise<boolean>	Promise对象。返回true表示删除光标后固定长度的文本成功；返回false表示删除光标后固定长度的文本失败。

示例：

import { BusinessError } from '@kit.BasicServicesKit';

let length = 1;
textInputClient.deleteBackward(length).then((result: boolean) => {
  if (result) {
    console.info('Succeeded in deleting backward.');
  } else {
    console.error('Failed to deleteBackward.');
  }
}).catch((err: BusinessError) => {
  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；否则为错误对象。

示例：

import { BusinessError } from '@kit.BasicServicesKit';

let action = 1;
textInputClient.sendKeyFunction(action, (err: BusinessError, result: boolean) => {
  if (err) {
    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表示发送功能键失败。

示例：

import { BusinessError } from '@kit.BasicServicesKit';

let action = 1;
textInputClient.sendKeyFunction(action).then((result: boolean) => {
  if (result) {
    console.info('Succeeded in sending key function.');
  } else {
    console.error('Failed to sendKeyFunction.');
  }
}).catch((err: BusinessError) => {
  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；否则为错误对象。

示例：

import { BusinessError } from '@kit.BasicServicesKit';

textInputClient.insertText('test', (err: BusinessError, result: boolean) => {
  if (err) {
    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表示插入文本失败。

示例：

import { BusinessError } from '@kit.BasicServicesKit';

textInputClient.insertText('test').then((result: boolean) => {
  if (result) {
    console.info('Succeeded in inserting text.');
  } else {
    console.error('Failed to insertText.');
  }
}).catch((err: BusinessError) => {
  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为编辑框属性值；否则为错误对象。

示例：

import { BusinessError } from '@kit.BasicServicesKit';

textInputClient.getEditorAttribute((err: BusinessError, editorAttribute: inputMethodEngine.EditorAttribute) => {
  if (err) {
    console.error(`Failed to getEditorAttribute: ${JSON.stringify(err)}`);
    return;
  }
  console.info(`editorAttribute.inputPattern: ${editorAttribute.inputPattern}`;
  console.info(`editorAttribute.enterKeyType: ${editorAttribute.enterKeyType}`);
});

getEditorAttribute^(deprecated)

getEditorAttribute(): Promise<EditorAttribute>

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

说明：

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

系统能力： SystemCapability.MiscServices.InputMethodFramework

返回值：

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

示例：

import { BusinessError } from '@kit.BasicServicesKit';

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

@ohos.inputMethodEngine (输入法服务)

导入模块

常量

inputMethodEngine.getInputMethodAbility9+

inputMethodEngine.getKeyboardDelegate9+

inputMethodEngine.getInputMethodEngine(deprecated)

inputMethodEngine.createKeyboardDelegate(deprecated)

CommandDataType12+

SizeChangeCallback15+

InputMethodEngine

on('inputStart')

off('inputStart')

on('keyboardShow'|'keyboardHide')

off('keyboardShow'|'keyboardHide')

InputMethodAbility

on('inputStart')9+

off('inputStart')9+

on('inputStop')9+

off('inputStop')9+

on('setCallingWindow')9+

off('setCallingWindow')9+

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

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

on('setSubtype')9+

off('setSubtype')9+

on('securityModeChange')11+

off('securityModeChange')11+

on('privateCommand')12+

off('privateCommand')12+

on('callingDisplayDidChange')18+

off('callingDisplayDidChange')18+

getSecurityMode11+

createPanel10+

createPanel10+

destroyPanel10+

destroyPanel10+

KeyboardDelegate

on('keyDown'|'keyUp')

off('keyDown'|'keyUp')

on('keyEvent')10+

off('keyEvent')10+

on('cursorContextChange')

off('cursorContextChange')

on('selectionChange')

off('selectionChange')

on('textChange')

off('textChange')

on('editorAttributeChanged')10+

off('editorAttributeChanged')10+

Panel10+

setUiContent10+

setUiContent10+

setUiContent10+

setUiContent10+

resize10+

resize10+

moveTo10+

moveTo10+

startMoving15+

getDisplayId15+

show10+

show10+

hide10+

hide10+

adjustPanelRect12+

adjustPanelRect15+

updatelnputRegion15+

on('show')10+

on('hide')10+

on('sizeChange')12+

off('show')10+

off('hide')10+

off('sizeChange')12+

changeFlag10+

setPrivacyMode11+

setImmersiveMode15+

getImmersiveMode15+

KeyboardController

hide9+

hide9+

inputMethodEngine.getInputMethodAbility⁹⁺

inputMethodEngine.getKeyboardDelegate⁹⁺

inputMethodEngine.getInputMethodEngine^(deprecated)

inputMethodEngine.createKeyboardDelegate^(deprecated)

CommandDataType¹²⁺

SizeChangeCallback¹⁵⁺

on('inputStart')⁹⁺

off('inputStart')⁹⁺

on('inputStop')⁹⁺

off('inputStop')⁹⁺

on('setCallingWindow')⁹⁺

off('setCallingWindow')⁹⁺

on('keyboardShow'|'keyboardHide')⁹⁺

off('keyboardShow'|'keyboardHide')⁹⁺

on('setSubtype')⁹⁺

off('setSubtype')⁹⁺

on('securityModeChange')¹¹⁺

off('securityModeChange')¹¹⁺

on('privateCommand')¹²⁺

off('privateCommand')¹²⁺

on('callingDisplayDidChange')¹⁸⁺

off('callingDisplayDidChange')¹⁸⁺

getSecurityMode¹¹⁺

createPanel¹⁰⁺

createPanel¹⁰⁺

destroyPanel¹⁰⁺

destroyPanel¹⁰⁺

on('keyEvent')¹⁰⁺

off('keyEvent')¹⁰⁺

on('editorAttributeChanged')¹⁰⁺

off('editorAttributeChanged')¹⁰⁺

Panel¹⁰⁺

setUiContent¹⁰⁺

setUiContent¹⁰⁺

setUiContent¹⁰⁺

setUiContent¹⁰⁺

resize¹⁰⁺

resize¹⁰⁺

moveTo¹⁰⁺

moveTo¹⁰⁺

startMoving¹⁵⁺

getDisplayId¹⁵⁺

show¹⁰⁺

show¹⁰⁺

hide¹⁰⁺

hide¹⁰⁺

adjustPanelRect¹²⁺

adjustPanelRect¹⁵⁺

updatelnputRegion¹⁵⁺

on('show')¹⁰⁺

on('hide')¹⁰⁺

on('sizeChange')¹²⁺

off('show')¹⁰⁺

off('hide')¹⁰⁺

off('sizeChange')¹²⁺

changeFlag¹⁰⁺

setPrivacyMode¹¹⁺

setImmersiveMode¹⁵⁺

getImmersiveMode¹⁵⁺

hide⁹⁺

hide⁹⁺

hideKeyboard^(deprecated)

hideKeyboard^(deprecated)

exitCurrentInputType¹¹⁺

exitCurrentInputType¹¹⁺

SecurityMode¹¹⁺

ExtendAction¹⁰⁺

Direction¹⁰⁺

Range¹⁰⁺

Movement¹⁰⁺

MessageHandler¹⁵⁺

onMessage¹⁵⁺

onTerminated¹⁵⁺

InputClient⁹⁺

sendKeyFunction⁹⁺

sendKeyFunction⁹⁺

getForward⁹⁺

getForward⁹⁺

getForwardSync¹⁰⁺

getBackward⁹⁺