harmony 鸿蒙@ohos.inputMethod (输入法框架)

2022-08-09
浏览 (898)

@ohos.inputMethod (输入法框架)

本模块主要面向普通前台应用（备忘录、信息、设置等系统应用与三方应用），提供对输入法（输入法应用）的控制、管理能力，包括显示/隐藏输入法软键盘、切换输入法、获取所有输入法列表等等。

说明：

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

导入模块

import inputMethod from '@ohos.inputMethod';

常量⁸⁺

常量值。

系统能力： SystemCapability.MiscServices.InputMethodFramework

参数名	类型	常量值	说明
MAX_TYPE_NUM	number	128	可支持的最大输入法个数。

InputMethodProperty⁸⁺

输入法应用属性。

系统能力： SystemCapability.MiscServices.InputMethodFramework

名称	类型	可读	可写	说明
name⁹⁺	string	是	否	必填。输入法内部名称。
id⁹⁺	string	是	否	必填。输入法唯一标识。
label⁹⁺	string	是	否	非必填。输入法对外显示名称。
labelId¹⁰⁺	string	是	否	非必填。输入法对外显示名称资源号。
icon⁹⁺	string	是	否	非必填。输入法图标数据，可以通过iconId查询获取。预留字段，暂不支持使用。
iconId⁹⁺	number	是	否	非必填。输入法图标资源号。
extra⁹⁺	object	是	是	输入法扩展信息。预留字段，当前无具体含义，暂不支持使用。 - API version 10起：非必填； - API version 9：必填。
packageName^(deprecated)	string	是	否	输入法包名。必填。说明：从API version 8开始支持，从API version 9开始废弃，建议使用name替代。
methodId^(deprecated)	string	是	否	输入法唯一标识。必填。说明：从API version 8开始支持，从API version 9开始废弃，建议使用id替代。

inputMethod.getController⁹⁺

getController(): InputMethodController

获取客户端实例InputMethodController。

系统能力： SystemCapability.MiscServices.InputMethodFramework

返回值：

类型	说明
InputMethodController	回调返回当前客户端实例。

错误码：

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

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

示例：

let inputMethodController = inputMethod.getController();

inputMethod.getSetting⁹⁺

getSetting(): InputMethodSetting

获取客户端设置实例InputMethodSetting。

系统能力： SystemCapability.MiscServices.InputMethodFramework

返回值：

类型	说明
InputMethodSetting	回调返回当前客户端设置实例。

错误码：

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

错误码ID	错误信息
12800007	settings extension error.

示例：

let inputMethodSetting = inputMethod.getSetting();

inputMethod.switchInputMethod⁹⁺

switchInputMethod(target: InputMethodProperty, callback: AsyncCallback<boolean>): void

切换输入法，仅系统应用可用。使用callback异步回调。

需要权限： ohos.permission.CONNECT_IME_ABILITY

系统能力： SystemCapability.MiscServices.InputMethodFramework

参数：

参数名	类型	必填	说明
target	InputMethodProperty	是	目标输入法。
callback	AsyncCallback<boolean>	是	回调函数。当输入法切换成功，err为undefined，data为true；否则为错误对象。

错误码：

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

错误码ID	错误信息
12800005	configuration persisting error.
12800008	input method manager service error.

示例：

let currentIme = inputMethod.getCurrentInputMethod();
try{
  inputMethod.switchInputMethod(currentIme, (err: BusinessError, result: boolean) => {
    if (err) {
      console.error(`Failed to switchInputMethod: ${JSON.stringify(err)}`);
      return;
    }
    if (result) {
      console.log('Succeeded in switching inputmethod.');
    } else {
      console.error('Failed to switchInputMethod.');
    }
  });
} catch(err) {
  console.error(`Failed to switchInputMethod: ${JSON.stringify(err)}`);
}

inputMethod.switchInputMethod⁹⁺

switchInputMethod(target: InputMethodProperty): Promise<boolean>

切换输入法，仅系统应用可用。使用promise异步回调。

需要权限： ohos.permission.CONNECT_IME_ABILITY

系统能力： SystemCapability.MiscServices.InputMethodFramework

参数：

参数名	类型	必填	说明
target	InputMethodProperty	是	目标输入法。

返回值：

类型	说明
Promise<boolean>	Promise对象。返回true表示切换输入法成功，返回false表示切换输入法失败。

错误码：

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

错误码ID	错误信息
12800005	configuration persisting error.
12800008	input method manager service error.

示例：

let currentIme = inputMethod.getCurrentInputMethod();
try {
  inputMethod.switchInputMethod(currentIme).then((result: boolean) => {
    if (result) {
      console.log('Succeeded in switching inputmethod.');
    } else {
      console.error('Failed to switchInputMethod.');
    }
  }).catch((err: BusinessError) => {
    console.error(`Failed to switchInputMethod: ${JSON.stringify(err)}`);
  })
} catch (err) {
  console.error(`Failed to switchInputMethod: ${JSON.stringify(err)}`);
}

inputMethod.getCurrentInputMethod⁹⁺

getCurrentInputMethod(): InputMethodProperty

使用同步方法获取当前输入法。

系统能力： SystemCapability.MiscServices.InputMethodFramework

返回值：

类型	说明
InputMethodProperty	返回当前输入法属性对象。

示例：

let currentIme = inputMethod.getCurrentInputMethod();

inputMethod.switchCurrentInputMethodSubtype⁹⁺

switchCurrentInputMethodSubtype(target: InputMethodSubtype, callback: AsyncCallback<boolean>): void

切换当前输入法的子类型。使用callback异步回调。

说明：

在API version 9版本，仅支持系统应用调用；API version 10版本起，支持系统应用和当前输入法应用调用。

需要权限： ohos.permission.CONNECT_IME_ABILITY

系统能力： SystemCapability.MiscServices.InputMethodFramework

参数：

参数名	类型	必填	说明
target	InputMethodSubtype	是	目标输入法子类型。
callback	AsyncCallback<boolean>	是	回调函数。当输入法子类型切换成功，err为undefined，data为true；否则为错误对象。

错误码：

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

错误码ID	错误信息
12800005	configuration persisting error.
12800008	input method manager service error.

示例：

try {
  let extra: Record<string, string> = {}
  inputMethod.switchCurrentInputMethodSubtype({
    id: "ServiceExtAbility",
    label: "",
    name: "com.example.kikakeyboard",
    mode: "upper",
    locale: "",
    language: "",
    icon: "",
    iconId: 0,
    extra: extra
  }, (err: BusinessError, result: boolean) => {
    if (err) {
      console.error(`Failed to switchCurrentInputMethodSubtype: ${JSON.stringify(err)}`);
      return;
    }
    if (result) {
      console.log('Succeeded in switching currentInputMethodSubtype.');
    } else {
      console.error('Failed to switchCurrentInputMethodSubtype');
    }
  });
} catch(err) {
  console.error(`Failed to switchCurrentInputMethodSubtype: ${JSON.stringify(err)}`);
}

inputMethod.switchCurrentInputMethodSubtype⁹⁺

switchCurrentInputMethodSubtype(target: InputMethodSubtype): Promise<boolean>

切换当前输入法的子类型。使用promise异步回调。

说明：

在API version 9版本，仅支持系统应用调用；API version 10版本起，支持系统应用和当前输入法应用调用。

需要权限： ohos.permission.CONNECT_IME_ABILITY

系统能力： SystemCapability.MiscServices.InputMethodFramework

参数：

参数名	类型	必填	说明
target	InputMethodSubtype	是	目标输入法子类型。

返回值：

类型	说明
Promise<boolean>	Promise对象。返回true表示当前输入法切换子类型成功，返回false表示当前输入法切换子类型成功失败。

错误码：

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

错误码ID	错误信息
12800005	configuration persisting error.
12800008	input method manager service error.

示例：

try {
  let extra: Record<string, string> = {}
  inputMethod.switchCurrentInputMethodSubtype({
    id: "ServiceExtAbility",
    label: "",
    name: "com.example.kikakeyboard",
    mode: "upper",
    locale: "",
    language: "",
    icon: "",
    iconId: 0,
    extra: extra
  }).then((result: boolean) => {
    if (result) {
      console.log('Succeeded in switching currentInputMethodSubtype.');
    } else {
      console.error('Failed to switchCurrentInputMethodSubtype.');
    }
  }).catch((err: BusinessError) => {
    console.error(`Failed to switchCurrentInputMethodSubtype: ${JSON.stringify(err)}`);
  })
} catch(err) {
  console.error(`Failed to switchCurrentInputMethodSubtype: ${JSON.stringify(err)}`);
}

inputMethod.getCurrentInputMethodSubtype⁹⁺

getCurrentInputMethodSubtype(): InputMethodSubtype

获取当前输入法的子类型。

系统能力： SystemCapability.MiscServices.InputMethodFramework

返回值：

类型	说明
InputMethodSubtype	返回当前输入法子类型对象。

示例：

let currentImeSubType = inputMethod.getCurrentInputMethodSubtype();

inputMethod.switchCurrentInputMethodAndSubtype⁹⁺

switchCurrentInputMethodAndSubtype(inputMethodProperty: InputMethodProperty, inputMethodSubtype: InputMethodSubtype, callback: AsyncCallback<boolean>): void

切换至指定输入法的指定子类型，适用于跨输入法切换子类型，仅系统应用可用。使用callback异步回调。

需要权限： ohos.permission.CONNECT_IME_ABILITY

系统能力： SystemCapability.MiscServices.InputMethodFramework

参数：

参数名	类型	必填	说明
inputMethodProperty	InputMethodProperty	是	目标输入法。
inputMethodSubtype	InputMethodSubtype	是	目标输入法子类型。
callback	AsyncCallback<boolean>	是	回调函数。当输入法和子类型切换成功，err为undefined，data为获取到的切换子类型结果true；否则为错误对象。

错误码：

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

错误码ID	错误信息
12800005	configuration persisting error.
12800008	input method manager service error.

示例：

let currentIme = inputMethod.getCurrentInputMethod();
let imSubType = inputMethod.getCurrentInputMethodSubtype();
try {
  inputMethod.switchCurrentInputMethodAndSubtype(currentIme, imSubType, (err: BusinessError, result: boolean) => {
    if (err) {
      console.error(`Failed to switchCurrentInputMethodAndSubtype: ${JSON.stringify(err)}`);
      return;
    }
    if (result) {
      console.log('Succeeded in switching currentInputMethodAndSubtype.');
    } else {
      console.error('Failed to switchCurrentInputMethodAndSubtype.');
    }
  });
} catch (err) {
  console.error(`Failed to switchCurrentInputMethodAndSubtype: ${JSON.stringify(err)}`);
}

inputMethod.switchCurrentInputMethodAndSubtype⁹⁺

switchCurrentInputMethodAndSubtype(inputMethodProperty: InputMethodProperty, inputMethodSubtype: InputMethodSubtype): Promise<boolean>

切换至指定输入法的指定子类型，适用于跨输入法切换子类型，仅系统应用可用。使用promise异步回调。

需要权限： ohos.permission.CONNECT_IME_ABILITY

系统能力： SystemCapability.MiscServices.InputMethodFramework

参数：

参数名	类型	必填	说明
inputMethodProperty	InputMethodProperty	是	目标输入法。
inputMethodSubtype	InputMethodSubtype	是	目标输入法子类型。

返回值：

类型	说明
Promise<boolean>	Promise对象。返回true表示切换至指定输入法的指定子类型成功，返回false表示切换至指定输入法的指定子类型失败。

错误码：

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

错误码ID	错误信息
12800005	configuration persisting error.
12800008	input method manager service error.

示例：

let currentIme = inputMethod.getCurrentInputMethod();
let imSubType = inputMethod.getCurrentInputMethodSubtype();
try {
  inputMethod.switchCurrentInputMethodAndSubtype(currentIme, imSubType).then((result: boolean) => {
    if (result) {
      console.log('Succeeded in switching currentInputMethodAndSubtype.');
    } else {
      console.error('Failed to switchCurrentInputMethodAndSubtype.');
    }
  }).catch((err: BusinessError) => {
    console.error(`Failed to switchCurrentInputMethodAndSubtype: ${JSON.stringify(err)}`);
  })
} catch(err) {
  console.error(`Failed to switchCurrentInputMethodAndSubtype: ${JSON.stringify(err)}`);
}

inputMethod.getInputMethodController^(deprecated)

getInputMethodController(): InputMethodController

获取客户端实例InputMethodController。

说明：

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

系统能力： SystemCapability.MiscServices.InputMethodFramework

返回值：

类型	说明
InputMethodController	回调返回当前客户端实例。

示例：

let inputMethodController = inputMethod.getInputMethodController();

inputMethod.getInputMethodSetting^(deprecated)

getInputMethodSetting(): InputMethodSetting

获取客户端设置实例InputMethodSetting。

说明：

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

系统能力： SystemCapability.MiscServices.InputMethodFramework

返回值：

类型	说明
InputMethodSetting	回调返回当前客户端设置实例。

示例：

let inputMethodSetting = inputMethod.getInputMethodSetting();

TextInputType¹⁰⁺

文本输入类型。

系统能力： SystemCapability.MiscServices.InputMethodFramework

名称	值	说明
NONE	-1	NONE。
TEXT	0	文本类型。
MULTILINE	1	多行类型。
NUMBER	2	数字类型。
PHONE	3	电话号码类型。
DATETIME	4	日期类型。
EMAIL_ADDRESS	5	邮箱地址类型。
URL	6	链接类型。
VISIBLE_PASSWORD	7	密码类型。

EnterKeyType¹⁰⁺

Enter键的功能类型。

系统能力： SystemCapability.MiscServices.InputMethodFramework

名称	值	说明
UNSPECIFIED	0	未指定。
NONE	1	NONE。
GO	2	前往。
SEARCH	3	查找。
SEND	4	发送。
NEXT	5	下一步。
DONE	6	完成。
PREVIOUS	7	上一步。

KeyboardStatus¹⁰⁺

输入法软键盘状态。

系统能力： SystemCapability.MiscServices.InputMethodFramework

名称	值	说明
NONE	0	NONE。
HIDE	1	隐藏状态。
SHOW	2	显示状态。

Direction¹⁰⁺

光标移动方向。

系统能力： SystemCapability.MiscServices.InputMethodFramework

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

ExtendAction¹⁰⁺

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

系统能力： SystemCapability.MiscServices.InputMethodFramework

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

FunctionKey¹⁰⁺

输入法功能键类型。

系统能力： SystemCapability.MiscServices.InputMethodFramework

名称	类型	可读	可写	说明
enterKeyType¹⁰⁺	EnterKeyType	是	是	输入法enter键类型。

InputAttribute¹⁰⁺

编辑框属性，包含文本输入类型和Enter键功能类型。

系统能力： SystemCapability.MiscServices.InputMethodFramework

名称	类型	可读	可写	说明
textInputType¹⁰⁺	TextInputType	是	是	文本输入类型。
enterKeyType¹⁰⁺	EnterKeyType	是	是	Enter键功能类型。

TextConfig¹⁰⁺

编辑框的配置信息。

系统能力： SystemCapability.MiscServices.InputMethodFramework

名称	类型	只读	必填	说明
inputAttribute¹⁰⁺	InputAttribute	否	是	编辑框属性。
cursorInfo¹⁰⁺	CursorInfo	否	否	光标信息。
selection¹⁰⁺	Range	否	否	文本选中的范围。
windowId¹⁰⁺	number	否	否	编辑框所在的窗口Id。

CursorInfo¹⁰⁺

光标信息。

系统能力： SystemCapability.MiscServices.InputMethodFramework

名称	类型	可读	可写	说明
left	number	是	是	光标的left坐标。
top	number	是	是	光标的top坐标。
width	number	是	是	光标的宽度。
height	number	是	是	光标的高度。

Range¹⁰⁺

文本的选中范围。

系统能力： SystemCapability.MiscServices.InputMethodFramework

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

Movement¹⁰⁺

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

系统能力： SystemCapability.MiscServices.InputMethodFramework

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

InputWindowInfo¹⁰⁺

输入法软键盘的窗口信息。

系统能力： SystemCapability.MiscServices.InputMethodFramework

名称	类型	可读	可写	说明
name	string	是	是	输入法窗口的名称。
left	number	是	是	输入法窗口左上顶点的横坐标，单位为px。
top	number	是	是	输入法窗口左上顶点的纵坐标，单位为px。
width	number	是	是	输入法窗口的宽度，单位为px。
height	number	是	是	输入法窗口的高度，单位为px。

InputMethodController

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

attach¹⁰⁺

attach(showKeyboard: boolean, textConfig: TextConfig, callback: AsyncCallback<void>): void

自绘控件绑定输入法。使用callback异步回调。

说明

需要先调用此接口，完成自绘控件与输入法的绑定，才能使用以下功能：显示/隐藏键盘、更新光标信息、更改编辑框选中范围、保存配置信息、监听处理由输入法应用发送的信息或命令等。

系统能力： SystemCapability.MiscServices.InputMethodFramework

参数：

参数名	类型	必填	说明
showKeyboard	boolean	是	绑定输入法成功后，是否拉起输入法键盘。 - ture表示拉起，false表示不拉起。
textConfig	TextConfig	是	编辑框的配置信息。
callback	AsyncCallback<void>	是	回调函数。当绑定输入法成功后，err为undefined；否则为错误对象。

错误码：

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

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

示例：

try {
  let textConfig: inputMethod.TextConfig = {
    inputAttribute: {
      textInputType: 0,
      enterKeyType: 1
    }
  };
  inputMethodController.attach(true, textConfig, (err: BusinessError) => {
    if (err) {
      console.error(`Failed to attach: ${JSON.stringify(err)}`);
      return;
    }
    console.log('Succeeded in attaching the inputMethod.');
  });
} catch(err) {
  console.error(`Failed to attach: ${JSON.stringify(err)}`);
}

attach¹⁰⁺

attach(showKeyboard: boolean, textConfig: TextConfig): Promise<void>

自绘控件绑定输入法。使用promise异步回调。

说明

需要先调用此接口，完成自绘控件与输入法的绑定，才能使用以下功能：显示/隐藏键盘、更新光标信息、更改编辑框选中范围、保存配置信息、监听处理由输入法应用发送的信息或命令等。

系统能力： SystemCapability.MiscServices.InputMethodFramework

参数：

参数名	类型	必填	说明
showKeyboard	boolean	是	绑定输入法成功后，是否拉起输入法键盘。 - ture表示拉起，false表示不拉起。
textConfig	TextConfig	是	编辑框的配置信息。

返回值：

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

错误码：

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

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

示例：

try {
  let textConfig: inputMethod.TextConfig = {
    inputAttribute: {
      textInputType: 0,
      enterKeyType: 1
    }
  };
  inputMethodController.attach(true, textConfig).then(() => {
    console.log('Succeeded in attaching inputMethod.');
  }).catch((err: BusinessError) => {
    console.error(`Failed to attach: ${JSON.stringify(err)}`);
  })
} catch(err) {
  console.error(`Failed to attach: ${JSON.stringify(err)}`);
}

showTextInput¹⁰⁺

showTextInput(callback: AsyncCallback<void>): void

进入文本编辑状态。使用callback异步回调。

说明

编辑框与输入法绑定成功后，可调用该接口拉起软键盘，进入文本编辑状态。

系统能力： SystemCapability.MiscServices.InputMethodFramework

参数：

参数名	类型	必填	说明
callback	AsyncCallback<void>	是	回调函数。若成功进入编辑状态，err为undefined；否则为错误对象。

错误码：

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

错误码ID	错误信息
12800003	input method client error.
12800008	input method manager service error.
12800009	input method client is detached.

示例：

inputMethodController.showTextInput((err: BusinessError) => {
  if (err) {
    console.error(`Failed to showTextInput: ${JSON.stringify(err)}`);
    return;
  }
  console.log('Succeeded in showing the inputMethod.');
});

showTextInput¹⁰⁺

showTextInput(): Promise<void>

进入文本编辑状态。使用promise异步回调。

说明

编辑框与输入法绑定成功后，可调用该接口拉起软键盘，进入文本编辑状态。

系统能力： SystemCapability.MiscServices.InputMethodFramework

返回值：

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

错误码：

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

错误码ID	错误信息
12800003	input method client error.
12800008	input method manager service error.
12800009	input method client is detached.

示例：

inputMethodController.showTextInput().then(() => {
  console.log('Succeeded in showing text input.');
}).catch((err: BusinessError) => {
  console.error(`Failed to showTextInput: ${JSON.stringify(err)}`);
});

hideTextInput¹⁰⁺

hideTextInput(callback: AsyncCallback<void>): void

退出文本编辑状态。使用callback异步回调。

说明

调用接口时，若软键盘处于显示状态，调用接口后软键盘会被隐藏。

调用该接口不会解除与输入法的绑定，再次调用showTextInput时，可重新进入文本编辑状态。

系统能力： SystemCapability.MiscServices.InputMethodFramework

参数：

参数名	类型	必填	说明
callback	AsyncCallback<void>	是	回调函数。当成功退出编辑状态时，err为undefined；否则为错误对象。

错误码：

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

错误码ID	错误信息
12800003	input method client error.
12800008	input method manager service error.
12800009	input method client is detached.

示例：

inputMethodController.hideTextInput((err: BusinessError) => {
  if (err) {
    console.error(`Failed to hideTextInput: ${JSON.stringify(err)}`);
    return;
  }
  console.log('Succeeded in hiding text input.');
});

hideTextInput¹⁰⁺

hideTextInput(): Promise<void>

退出文本编辑状态。使用promise异步回调。

说明

调用接口时，若软键盘处于显示状态，调用接口后软键盘会被隐藏。

调用该接口不会解除与输入法的绑定，再次调用showTextInput时，可重新进入文本编辑状态。

系统能力： SystemCapability.MiscServices.InputMethodFramework

返回值：

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

错误码：

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

错误码ID	错误信息
12800003	input method client error.
12800008	input method manager service error.
12800009	input method client is detached.

示例：

inputMethodController.hideTextInput().then(() => {
  console.log('Succeeded in hiding inputMethod.');
}).catch((err: BusinessError) => {
  console.error(`Failed to hideTextInput: ${JSON.stringify(err)}`);
})

detach¹⁰⁺

detach(callback: AsyncCallback<void>): void

自绘控件解除与输入法的绑定。使用callback异步回调。

系统能力： SystemCapability.MiscServices.InputMethodFramework

参数：

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

错误码：

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

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

示例：

inputMethodController.detach((err: BusinessError) => {
  if (err) {
    console.error(`Failed to detach: ${JSON.stringify(err)}`);
    return;
  }
  console.log('Succeeded in detaching inputMethod.');
});

detach¹⁰⁺

detach(): Promise<void>

自绘控件解除与输入法的绑定。使用promise异步回调。

系统能力： SystemCapability.MiscServices.InputMethodFramework

返回值：

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

错误码：

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

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

示例：

inputMethodController.detach().then(() => {
  console.log('Succeeded in detaching inputMethod.');
}).catch((err: BusinessError) => {
  console.error(`Failed to detach: ${JSON.stringify(err)}`);
});

setCallingWindow¹⁰⁺

setCallingWindow(windowId: number, callback: AsyncCallback<void>): void

设置要避让软键盘的窗口。使用callback异步回调。

说明

将绑定到输入法的应用程序所在的窗口Id传入，此窗口可以避让输入法窗口。

系统能力： SystemCapability.MiscServices.InputMethodFramework

参数：

参数名	类型	必填	说明
windowId	number	是	绑定输入法应用的应用程序所在的窗口Id。
callback	AsyncCallback<void>	是	回调函数。当设置成功时，err为undefined；否则为错误对象。

错误码：

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

错误码ID	错误信息
12800003	input method client error.
12800008	input method manager service error.
12800009	input method client is detached.

示例：

try {
  let windowId: number = 2000;
  inputMethodController.setCallingWindow(windowId, (err: BusinessError) => {
    if (err) {
      console.error(`Failed to setCallingWindow: ${JSON.stringify(err)}`);
      return;
    }
    console.log('Succeeded in setting callingWindow.');
  });
} catch(err) {
  console.error(`Failed to setCallingWindow: ${JSON.stringify(err)}`);
}

setCallingWindow¹⁰⁺

setCallingWindow(windowId: number): Promise<void>

设置要避让软键盘的窗口。使用promise异步回调。

说明

将绑定到输入法的应用程序所在的窗口Id传入，此窗口可以避让输入法窗口。

系统能力： SystemCapability.MiscServices.InputMethodFramework

参数：

参数名	类型	必填	说明
windowId	number	是	绑定输入法应用的应用程序所在的窗口Id。

返回值：

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

错误码：

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

错误码ID	错误信息
12800003	input method client error.
12800008	input method manager service error.
12800009	input method client is detached.

示例：

try {
  let windowId: number = 2000;
  inputMethodController.setCallingWindow(windowId).then(() => {
    console.log('Succeeded in setting callingWindow.');
  }).catch((err: BusinessError) => {
    console.error(`Failed to setCallingWindow: ${JSON.stringify(err)}`);
  })
} catch(err) {
  console.error(`Failed to setCallingWindow: ${JSON.stringify(err)}`);
}

updateCursor¹⁰⁺

updateCursor(cursorInfo: CursorInfo, callback: AsyncCallback<void>): void

更新当前编辑框内的光标信息。当光标信息发生变化时，调用该接口使输入法感知到光标变化。使用callback异步回调。

系统能力： SystemCapability.MiscServices.InputMethodFramework

参数：

参数名	类型	必填	说明
cursorInfo	CursorInfo	是	光标信息。
callback	AsyncCallback<void>	是	回调函数。当光标信息更新成功时，err为undefined；否则为错误对象。

错误码：

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

错误码ID	错误信息
12800003	input method client error.
12800008	input method manager service error.
12800009	input method client is detached.

示例：

try {
  let cursorInfo: inputMethod.CursorInfo = { left: 0, top: 0, width: 600, height: 800 };
  inputMethodController.updateCursor(cursorInfo, (err: BusinessError) => {
    if (err) {
      console.error(`Failed to updateCursor: ${JSON.stringify(err)}`);
      return;
    }
    console.log('Succeeded in updating cursorInfo.');
  });
} catch(err) {
  console.error(`Failed to updateCursor: ${JSON.stringify(err)}`);
}

updateCursor¹⁰⁺

updateCursor(cursorInfo: CursorInfo): Promise<void>

更新当前编辑框内的光标信息。当光标信息发生变化时，调用该接口使输入法感知到光标变化。使用promise异步回调。

系统能力： SystemCapability.MiscServices.InputMethodFramework

参数：

参数名	类型	必填	说明
cursorInfo	CursorInfo	是	光标信息。

返回值：

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

错误码：

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

错误码ID	错误信息
12800003	input method client error.
12800008	input method manager service error.
12800009	input method client is detached.

示例：

try {
  let cursorInfo: inputMethod.CursorInfo = { left: 0, top: 0, width: 600, height: 800 };
  inputMethodController.updateCursor(cursorInfo).then(() => {
    console.log('Succeeded in updating cursorInfo.');
  }).catch((err: BusinessError) => {
    console.error(`Failed to updateCursor: ${JSON.stringify(err)}`);
  })
} catch(err) {
  console.error(`Failed to updateCursor: ${JSON.stringify(err)}`);
}

changeSelection¹⁰⁺

changeSelection(text: string, start: number, end: number, callback: AsyncCallback<void>): void

更新当前编辑框内被选中的文本信息。当选中的文本内容或文本范围发生变化时，可调用该接口更新文本信息，使输入法应用感知到变化。使用callback异步回调。

系统能力： SystemCapability.MiscServices.InputMethodFramework

参数：

参数名	类型	必填	说明
text	string	是	整个输入文本。
start	number	是	所选文本的起始位置。
end	number	是	所选文本的结束位置。
callback	AsyncCallback<void>	是	回调函数。当文本信息更新成功时，err为undefined；否则为错误对象。

错误码：

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

错误码ID	错误信息
12800003	input method client error.
12800008	input method manager service error.
12800009	input method client is detached.

示例：

try {
  inputMethodController.changeSelection('text', 0, 5, (err: BusinessError) => {
    if (err) {
      console.error(`Failed to changeSelection: ${JSON.stringify(err)}`);
      return;
    }
    console.log('Succeeded in changing selection.');
  });
} catch(err) {
  console.error(`Failed to changeSelection: ${JSON.stringify(err)}`);
}

changeSelection¹⁰⁺

changeSelection(text: string, start: number, end: number): Promise<void>

更新当前编辑框内被选中的文本信息。当选中的文本内容或文本范围发生变化时，可调用该接口更新文本信息，使输入法应用感知到变化。使用promise异步回调。

系统能力： SystemCapability.MiscServices.InputMethodFramework

参数：

参数名	类型	必填	说明
text	string	是	整个输入文本。
start	number	是	所选文本的起始位置。
end	number	是	所选文本的结束位置。

返回值：

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

错误码：

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

错误码ID	错误信息
12800003	input method client error.
12800008	input method manager service error.
12800009	input method client is detached.

示例：

try {
  inputMethodController.changeSelection('test', 0, 5).then(() => {
    console.log('Succeeded in changing selection.');
  }).catch((err: BusinessError) => {
    console.error(`Failed to changeSelection: ${JSON.stringify(err)}`);
  })
} catch(err) {
  console.error(`Failed to changeSelection: ${JSON.stringify(err)}`);
}

updateAttribute¹⁰⁺

updateAttribute(attribute: InputAttribute, callback: AsyncCallback<void>): void

更新编辑框属性信息。使用callback异步回调。

系统能力： SystemCapability.MiscServices.InputMethodFramework

参数：

参数名	类型	必填	说明
attribute	InputAttribute	是	编辑框属性对象。
callback	AsyncCallback<void>	是	回调函数。当编辑框属性信息更新成功时，err为undefined；否则为错误对象。

错误码：

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

错误码ID	错误信息
12800003	input method client error.
12800008	input method manager service error.
12800009	input method client is detached.

示例：

try {
  let inputAttribute: inputMethod.InputAttribute = { textInputType: 0, enterKeyType: 1 };
  inputMethodController.updateAttribute(inputAttribute, (err: BusinessError) => {
    if (err) {
      console.error(`Failed to updateAttribute: ${JSON.stringify(err)}`);
      return;
    }
    console.log('Succeeded in updating attribute.');
  });
} catch(err) {
  console.error(`Failed to updateAttribute: ${JSON.stringify(err)}`);
}

updateAttribute¹⁰⁺

updateAttribute(attribute: InputAttribute): Promise<void>

更新编辑框属性信息。使用promise异步回调。

系统能力： SystemCapability.MiscServices.InputMethodFramework

参数：

参数名	类型	必填	说明
attribute	InputAttribute	是	编辑框属性对象。

返回值：

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

错误码：

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

错误码ID	错误信息
12800003	input method client error.
12800008	input method manager service error.
12800009	input method client is detached.

示例：

try {
  let inputAttribute: inputMethod.InputAttribute = { textInputType: 0, enterKeyType: 1 };
  inputMethodController.updateAttribute(inputAttribute).then(() => {
    console.log('Succeeded in updating attribute.');
  }).catch((err: BusinessError) => {
    console.error(`Failed to updateAttribute: ${JSON.stringify(err)}`);
  })
} catch(err) {
  console.error(`Failed to updateAttribute: ${JSON.stringify(err)}`);
}

stopInputSession⁹⁺

stopInputSession(callback: AsyncCallback<boolean>): void

结束输入会话。使用callback异步回调。

说明：

该接口需要编辑框与输入法绑定时才能调用，即点击编辑控件后，才可调用该接口结束输入会话。

系统能力： SystemCapability.MiscServices.InputMethodFramework

参数：

参数名	类型	必填	说明
callback	AsyncCallback<boolean>	是	回调函数。当结束输入会话成功时，err为undefined，data为true；否则为错误对象。

错误码：

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

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

示例：

try {
  inputMethodController.stopInputSession((err: BusinessError, result: boolean) => {
    if (err) {
      console.error(`Failed to stopInputSession: ${JSON.stringify(err)}`);
      return;
    }
    if (result) {
      console.log('Succeeded in stopping inputSession.');
    } else {
      console.error('Failed to stopInputSession.');
    }
  });
} catch(err) {
  console.error(`Failed to stopInputSession: ${JSON.stringify(err)}`);
}

stopInputSession⁹⁺

stopInputSession(): Promise<boolean>

结束输入会话。使用promise异步回调。

说明：

该接口需要编辑框与输入法绑定时才能调用，即点击编辑控件后，才可调用该接口结束输入会话。

系统能力： SystemCapability.MiscServices.InputMethodFramework

返回值：

类型	说明
Promise<boolean>	Promise对象。返回true表示结束输入会话成功，返回false表示结束输入会话失败。

错误码：

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

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

示例：

try {
  inputMethodController.stopInputSession().then((result: boolean) => {
    if (result) {
      console.log('Succeeded in stopping inputSession.');
    } else {
      console.error('Failed to stopInputSession.');
    }
  }).catch((err: BusinessError) => {
    console.error(`Failed to stopInputSession: ${JSON.stringify(err)}`);
  })
} catch(err) {
  console.error(`Failed to stopInputSession: ${JSON.stringify(err)}`);
}

showSoftKeyboard⁹⁺

showSoftKeyboard(callback: AsyncCallback<void>): void

显示输入法软键盘。使用callback异步回调。

说明：

该接口需要编辑框与输入法绑定时才能调用，即点击编辑控件后，才可调用显示当前输入法的软键盘。

需要权限： ohos.permission.CONNECT_IME_ABILITY，仅系统应用可用。

系统能力： SystemCapability.MiscServices.InputMethodFramework

参数：

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

错误码：

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

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

示例：

inputMethodController.showSoftKeyboard((err: BusinessError) => {
  if (!err) {
    console.log('Succeeded in showing softKeyboard.');
  } else {
    console.error(`Failed to show softKeyboard: ${JSON.stringify(err)}`);
  }
})

showSoftKeyboard⁹⁺

showSoftKeyboard(): Promise<void>

显示输入法软键盘。使用Promise异步回调。

说明：

该接口需要编辑框与输入法绑定时才能调用，即点击编辑控件后，才可调用显示当前输入法的软键盘。

需要权限： ohos.permission.CONNECT_IME_ABILITY，仅系统应用可用。

系统能力： SystemCapability.MiscServices.InputMethodFramework

返回值：

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

错误码：

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

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

示例：

inputMethodController.showSoftKeyboard().then(() => {
  console.log('Succeeded in showing softKeyboard.');
}).catch((err: BusinessError) => {
  console.error(`Failed to show softKeyboard: ${JSON.stringify(err)}`);
});

hideSoftKeyboard⁹⁺

hideSoftKeyboard(callback: AsyncCallback<void>): void

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

说明：

该接口需要编辑框与输入法绑定时才能调用，即点击编辑控件后，才可调用隐藏当前输入法的软键盘。

需要权限： ohos.permission.CONNECT_IME_ABILITY，仅系统应用可用。

系统能力： SystemCapability.MiscServices.InputMethodFramework

参数：

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

错误码：

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

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

示例：

inputMethodController.hideSoftKeyboard((err: BusinessError) => {
  if (!err) {
    console.log('Succeeded in hiding softKeyboard.');
  } else {
    console.error(`Failed to hide softKeyboard: ${JSON.stringify(err)}`);
  }
})

hideSoftKeyboard⁹⁺

hideSoftKeyboard(): Promise<void>

隐藏输入法软键盘。使用Promise异步回调。

说明：

该接口需要编辑框与输入法绑定时才能调用，即点击编辑控件后，才可调用隐藏当前输入法的软键盘。

需要权限： ohos.permission.CONNECT_IME_ABILITY，仅系统应用可用。

系统能力： SystemCapability.MiscServices.InputMethodFramework

返回值：

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

错误码：

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

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

示例：

inputMethodController.hideSoftKeyboard().then(() => {
  console.log('Succeeded in hiding softKeyboard.');
}).catch((err: BusinessError) => {
  console.error(`Failed to hide softKeyboard: ${JSON.stringify(err)}`);
});

stopInput^(deprecated)

stopInput(callback: AsyncCallback<boolean>): void

结束输入会话。使用callback异步回调。

说明：

该接口需要编辑框与输入法绑定时才能调用，即点击编辑控件后，才可调用该接口结束输入会话。

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

系统能力： SystemCapability.MiscServices.InputMethodFramework

参数：

参数名	类型	必填	说明
callback	AsyncCallback<boolean>	是	回调函数。当会话结束成功，err为undefined，data为true；否则为错误对象。

示例：

inputMethodController.stopInput((err: BusinessError, result: boolean) => {
  if (err) {
    console.error(`Failed to stopInput: ${JSON.stringify(err)}`);
    return;
  }
  if (result) {
    console.log('Succeeded in stopping input.');
  } else {
    console.error('Failed to stopInput.');
  }
});

stopInput^(deprecated)

stopInput(): Promise<boolean>

结束输入会话。使用promise异步回调。

说明：

该接口需要编辑框与输入法绑定时才能调用，即点击编辑控件后，才可调用该接口结束输入会话。

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

系统能力： SystemCapability.MiscServices.InputMethodFramework

返回值：

类型	说明
Promise<boolean>	Promise对象。返回true表示会话结束成功；返回false表示会话结束失败。

示例：

inputMethodController.stopInput().then((result: boolean) => {
  if (result) {
    console.log('Succeeded in stopping input.');
  } else {
    console.error('Failed to stopInput.');
  }
}).catch((err: BusinessError) => {
  console.error(`Failed to stopInput: ${JSON.stringify(err)}`);
})

on(‘insertText’)¹⁰⁺

on(type: ‘insertText’, callback: (text: string) => void): void;

订阅输入法应用插入文本事件。使用callback异步回调。

系统能力： SystemCapability.MiscServices.InputMethodFramework

参数：

参数名	类型	必填	说明
type	string	是	设置监听类型，固定取值为’insertText’。
callback	(text: string) => void	是	回调函数，返回需要插入的文本内容。根据传入的文本，在回调函数中操作编辑框中的内容。

错误码：

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

错误码ID	错误信息
12800009	input method client is detached.

示例：

try {
  inputMethodController.on('insertText', (text: string) => {
    console.log(`Succeeded in subscribing insertText: ${text}`);
  });
} catch(err) {
  console.error(`Failed to subscribe insertText: ${JSON.stringify(err)}`);
}

off(‘insertText’)¹⁰⁺

off(type: ‘insertText’, callback?: (text: string) => void): void

取消订阅输入法应用插入文本事件。

系统能力： SystemCapability.MiscServices.InputMethodFramework

参数：

参数名	类型	必填	说明
type	string	是	设置监听类型，固定取值为’insertText’。
callback	(text: string) => void	否	取消订阅的回调函数，需要与on接口传入的保持一致。参数不填写时，取消订阅type对应的所有回调事件。

示例：

let onInsertTextCallback = (text: string) => {
    console.log(`Succeeded in subscribing insertText: ${text}`);
};
inputMethodController.off('insertText', onInsertTextCallback);
inputMethodController.off('insertText');

on(‘deleteLeft’)¹⁰⁺

on(type: ‘deleteLeft’, callback: (length: number) => void): void

订阅输入法应用向左删除事件。使用callback异步回调。

系统能力： SystemCapability.MiscServices.InputMethodFramework

参数：

参数名	类型	必填	说明
type	string	是	设置监听类型，固定取值为’deleteLeft’。
callback	(length: number) => void	是	回调函数，返回需要向左删除的文本长度。根据传入的删除长度，在回调函数中操作编辑框中的文本。

错误码：

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

错误码ID	错误信息
12800009	input method client is detached.

示例：

try {
  inputMethodController.on('deleteLeft', (length: number) => {
    console.log(`Succeeded in subscribing deleteLeft, length: ${length}`);
  });
} catch(err) {
  console.error(`Failed to subscribe deleteLeft: ${JSON.stringify(err)}`);
}

off(‘deleteLeft’)¹⁰⁺

off(type: ‘deleteLeft’, callback?: (length: number) => void): void

取消订阅输入法应用向左删除文本事件。

系统能力： SystemCapability.MiscServices.InputMethodFramework

参数：

参数名	类型	必填	说明
type	string	是	设置监听，固定取值为’deleteLeft’。
callback	(length: number) => void	否	取消订阅的回调函数，需要与on接口传入的保持一致。参数不填写时，取消订阅type对应的所有回调事件。

示例：

let onDeleteLeftCallback = (length: number) => {
    console.log(`Succeeded in subscribing deleteLeft, length: ${length}`);
};
inputMethodController.off('deleteLeft', onDeleteLeftCallback);
inputMethodController.off('deleteLeft');

on(‘deleteRight’)¹⁰⁺

on(type: ‘deleteRight’, callback: (length: number) => void): void

订阅输入法应用向右删除事件。使用callback异步回调。

系统能力： SystemCapability.MiscServices.InputMethodFramework

参数：

参数名	类型	必填	说明
type	string	是	设置监听类型，固定取值为’deleteRight’。
callback	(length: number) => void	是	回调函数，返回需要向右删除的文本长度。根据传入的删除长度，在回调函数中操作编辑框中的文本。

错误码：

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

错误码ID	错误信息
12800009	input method client is detached.

示例：

try {
  inputMethodController.on('deleteRight', (length: number) => {
    console.log(`Succeeded in subscribing deleteRight, length: ${length}`);
  });
} catch(err) {
  console.error(`Failed to subscribe deleteRight: ${JSON.stringify(err)}`);
}

off(‘deleteRight’)¹⁰⁺

off(type: ‘deleteRight’, callback?: (length: number) => void): void

取消订阅输入法应用向右删除文本事件。

系统能力： SystemCapability.MiscServices.InputMethodFramework

参数：

参数名	类型	必填	说明
type	string	是	设置监听类型，固定取值为`deleteRight`。
callback	(length: number) => void	否	取消订阅的回调函数，需要与on接口传入的保持一致。参数不填写时，取消订阅type对应的所有回调事件。

示例：

let onDeleteRightCallback = (length: number) => {
    console.log(`Succeeded in subscribing deleteRight, length: ${length}`);
};
inputMethodController.off('deleteRight', onDeleteRightCallback);
inputMethodController.off('deleteRight');

on(‘sendKeyboardStatus’)¹⁰⁺

on(type: ‘sendKeyboardStatus’, callback: (keyboardStatus: KeyboardStatus) => void): void

订阅输入法应用发送输入法软键盘状态事件。使用callback异步回调。

系统能力： SystemCapability.MiscServices.InputMethodFramework

参数：

参数名	类型	必填	说明
type	string	是	设置监听类型，固定取值为’sendKeyboardStatus’。
callback	(keyboardStatus: KeyboardStatus) => void	是	回调函数，返回软键盘状态。根据传入的软键盘状态，在回调函数中做相应操作。

错误码：

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

错误码ID	错误信息
12800009	input method client is detached.

示例：

try {
  inputMethodController.on('sendKeyboardStatus', (keyboardStatus: inputMethod.KeyboardStatus) => {
    console.log(`Succeeded in subscribing sendKeyboardStatus, keyboardStatus: ${keyboardStatus}`);
  });
} catch(err) {
  console.error(`Failed to subscribe sendKeyboardStatus: ${JSON.stringify(err)}`);
}

off(‘sendKeyboardStatus’)¹⁰⁺

off(type: ‘sendKeyboardStatus’, callback?: (keyboardStatus: KeyboardStatus) => void): void

取消订阅输入法应用发送软键盘状态事件。

系统能力： SystemCapability.MiscServices.InputMethodFramework

参数：

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

示例：

let onSendKeyboardStatus = (keyboardStatus: inputMethod.KeyboardStatus) => {
    console.log(`Succeeded in subscribing sendKeyboardStatus, keyboardStatus: ${keyboardStatus}`);
};
inputMethodController.off('sendKeyboardStatus', onSendKeyboardStatus);
inputMethodController.off('sendKeyboardStatus');

on(‘sendFunctionKey’)¹⁰⁺

on(type: ‘sendFunctionKey’, callback: (functionKey: FunctionKey) => void): void

订阅输入法应用发送功能键事件。使用callback异步回调。

系统能力： SystemCapability.MiscServices.InputMethodFramework

参数：

参数名	类型	必填	说明
type	string	是	设置监听类型，固定取值为’sendFunctionKey’。
callback	(functionKey: FunctionKey) => void	是	回调函数，返回输入法应用发送的功能键信息。根据返回的功能键信息，做相应操作。

错误码：

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

错误码ID	错误信息
12800009	input method client is detached.

示例：

try {
  inputMethodController.on('sendFunctionKey', (functionKey: inputMethod.FunctionKey) => {
    console.log(`Succeeded in subscribing sendFunctionKey, functionKey.enterKeyType: ${functionKey.enterKeyType}`);
  });
} catch(err) {
  console.error(`Failed to subscribe sendFunctionKey: ${JSON.stringify(err)}`);
}

off(‘sendFunctionKey’)¹⁰⁺

off(type: ‘sendFunctionKey’, callback?: (functionKey: FunctionKey) => void): void

取消订阅输入法应用发送功能键事件。

系统能力： SystemCapability.MiscServices.InputMethodFramework

参数：

参数名	类型	必填	说明
type	string	是	设置监听类型，固定取值为’sendFunctionKey’。
callback	(functionKey: FunctionKey) => void	否	取消订阅的回调函数，需要与on接口传入的保持一致。参数不填写时，取消订阅type对应的所有回调事件。

示例：

let onSendFunctionKey = (functionKey: inputMethod.FunctionKey) => {
    console.log(`Succeeded in subscribing sendFunctionKey, functionKey: ${functionKey.enterKeyType}`);
};
inputMethodController.off('sendFunctionKey', onSendFunctionKey);
inputMethodController.off('sendFunctionKey');

on(‘moveCursor’)¹⁰⁺

on(type: ‘moveCursor’, callback: (direction: Direction) => void): void

订阅输入法应用移动光标事件。使用callback异步回调。

系统能力： SystemCapability.MiscServices.InputMethodFramework

参数：

参数名	类型	必填	说明
type	string	是	设置监听类型，固定取值为’moveCursor’。
callback	callback: (direction: Direction¹⁰⁺) => void	是	回调函数，返回光标信息。根据返回的光标移动方向，改变光标位置，如光标向上或向下。

错误码：

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

错误码ID	错误信息
12800009	input method client is detached.

示例：

try {
  inputMethodController.on('moveCursor', (direction: inputMethod.Direction) => {
    console.log(`Succeeded in subscribing moveCursor, direction: ${direction}`);
  });
} catch(err) {
  console.error(`Failed to subscribe moveCursor: ${JSON.stringify(err)}`);
}

off(‘moveCursor’)¹⁰⁺

off(type: ‘moveCursor’, callback?: (direction: Direction) => void): void

取消订阅输入法应用移动光标事件。

系统能力： SystemCapability.MiscServices.InputMethodFramework

参数：

参数名	类型	必填	说明
type	string	是	设置监听类型，固定取值为’moveCursor’。
callback	(direction: Direction¹⁰⁺) => void	否	取消订阅的回调函数，需要与on接口传入的保持一致。参数不填写时，取消订阅type对应的所有回调事件。

示例：

let onMoveCursorCallback = (direction: inputMethod.Direction) => {
    console.log(`Succeeded in subscribing moveCursor, direction: ${direction}`);
};
inputMethodController.off('moveCursor', onMoveCursorCallback);
inputMethodController.off('moveCursor');

on(‘handleExtendAction’)¹⁰⁺

on(type: ‘handleExtendAction’, callback: (action: ExtendAction) => void): void

订阅输入法应用发送扩展编辑操作事件。使用callback异步回调。

系统能力： SystemCapability.MiscServices.InputMethodFramework

参数：

参数名	类型	必填	说明
type	string	是	设置监听类型，固定取值为’handleExtendAction’。
callback	callback: (action: ExtendAction) => void	是	回调函数，返回扩展编辑操作类型。根据传入的扩展编辑操作类型，做相应的操作，如剪切、复制等。

错误码：

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

错误码ID	错误信息
12800009	input method client is detached.

示例：

try {
  inputMethodController.on('handleExtendAction', (action: inputMethod.ExtendAction) => {
    console.log(`Succeeded in subscribing handleExtendAction, action: ${action}`);
  });
} catch(err) {
  console.error(`Failed to subscribe handleExtendAction: ${JSON.stringify(err)}`);
}

off(‘handleExtendAction’)¹⁰⁺

off(type: ‘handleExtendAction’, callback?: (action: ExtendAction) => void): void

取消订阅输入法应用发送扩展编辑操作事件。使用callback异步回调。

系统能力： SystemCapability.MiscServices.InputMethodFramework

参数：

参数名	类型	必填	说明
type	string	是	设置监听类型，固定取值为’handleExtendAction’。
callback	(action: ExtendAction) => void	否	取消订阅的回调函数，需要与on接口传入的保持一致。参数不填写时，取消订阅type对应的所有回调事件。

示例：

let onHandleExtendActionCallback = (action: inputMethod.ExtendAction) => {
    console.log(`Succeeded in subscribing handleExtendAction, action: ${action}`);
};
inputMethodController.off('handleExtendAction', onHandleExtendActionCallback);
inputMethodController.off('handleExtendAction');

on(‘selectByRange’)¹⁰⁺

on(type: ‘selectByRange’, callback: Callback<Range>): void

订阅输入法应用按范围选中文本事件。使用callback异步回调。

系统能力： SystemCapability.MiscServices.InputMethodFramework

参数：

参数名	类型	必填	说明
type	string	是	设置监听类型，固定取值为’selectByRange’。
callback	Callback<Range>	是	回调函数，返回需要选中的文本范围。根据传入的文本范围，开发者在回调函数中编辑框中相应文本。

示例：

inputMethodController.on('selectByRange', (range: inputMethod.Range) => {
  console.log(`Succeeded in subscribing selectByRange: start: ${range.start} , end: ${range.end}`);
});

off(‘selectByRange’)¹⁰⁺

off(type: ‘selectByRange’, callback?: Callback<Range>): void

取消订阅输入法应用按范围选中文本事件。使用callback异步回调。

系统能力： SystemCapability.MiscServices.InputMethodFramework

参数：

参数名	类型	必填	说明
type	string	是	设置监听类型，固定取值为’selectByRange’。
callback	Callback<Range>	否	取消订阅的回调函数，需要与on接口传入的保持一致。参数不填写时，取消订阅type对应的所有回调事件。

示例：

let onSelectByRangeCallback = (range: inputMethod.Range) => {
    console.log(`Succeeded in subscribing selectByRange, range: ${JSON.stringify(range)}`);
};
inputMethodController.off('selectByRange', onSelectByRangeCallback);
inputMethodController.off('selectByRange');

on(‘selectByMovement’)¹⁰⁺

on(type: ‘selectByMovement’, callback: Callback<Movement>): void

订阅输入法应用按光标移动方向，选中文本事件。使用callback异步回调。

系统能力： SystemCapability.MiscServices.InputMethodFramework

参数：

参数名	类型	必填	说明
type	string	是	设置监听类型，固定取值为’selectByMovement’。
callback	Callback<Movement>	是	回调函数，返回光标移动的方向。根据传入的光标移动方向，选中编辑框中相应文本。

示例：

inputMethodController.on('selectByMovement', (movement: inputMethod.Movement) => {
  console.log('Succeeded in subscribing selectByMovement: direction: ' + movement.direction);
});

off(‘selectByMovement’)¹⁰⁺

off(type: ‘selectByMovement’, callback?: Callback<Movement>): void

取消订阅输入法应用按光标移动方向，选中文本事件。使用callback异步回调。

系统能力： SystemCapability.MiscServices.InputMethodFramework

参数：

参数名	类型	必填	说明
type	string	是	设置监听类型，固定取值为’selectByMovement’。
callback	Callback<Movement>	否	取消订阅的回调函数，需要与on接口传入的保持一致。参数不填写时，取消订阅type对应的所有回调事件。

示例：

let onSelectByMovementCallback = (movement: inputMethod.Movement) => {
    console.log(`Succeeded in subscribing selectByMovement, movement.direction: ${movement.direction}`);
};
inputMethodController.off('selectByMovement', onSelectByMovementCallback);
inputMethodController.off('selectByMovement');

on(‘getLeftTextOfCursor’)¹⁰⁺

on(type: ‘getLeftTextOfCursor’, callback: (length: number) => string): void;

订阅输入法应用获取光标左侧指定长度文本事件。使用callback异步回调。

系统能力： SystemCapability.MiscServices.InputMethodFramework

参数：

参数名	类型	必填	说明
type	string	是	设置监听类型，固定取值为’getLeftTextOfCursor’。
callback	(length: number) => string	是	回调函数，获取编辑框最新状态下光标左侧指定长度的文本内容并返回。

错误码：

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

错误码ID	错误信息
12800009	input method client is detached.

示例：

try {
  inputMethodController.on('getLeftTextOfCursor', (length: number) => {
    console.info(`Succeeded in subscribing getLeftTextOfCursor, length: ${length}`);
    let text:string = "";
    return text;
  });
} catch(err) {
  console.error(`Failed to subscribe getLeftTextOfCursor. err: ${JSON.stringify(err)}`);
}

off(‘getLeftTextOfCursor’)¹⁰⁺

off(type: ‘getLeftTextOfCursor’, callback?: (length: number) => string): void;

取消订阅输入法应用获取光标左侧指定长度文本事件。使用callback异步回调。

系统能力： SystemCapability.MiscServices.InputMethodFramework

参数：

参数名	类型	必填	说明
type	string	是	设置监听类型，固定取值为’getLeftTextOfCursor’。
callback	(length: number) => string	否	取消订阅的回调函数，需要与on接口传入的保持一致。参数不填写时，取消订阅type对应的所有回调事件。

示例：

try {
  let getLeftTextOfCursorCallback = (length: number) => {
    console.info(`Succeeded in unsubscribing getLeftTextOfCursor, length: ${length}`);
    let text:string = "";
    return text;
  };
  inputMethodController.off('getLeftTextOfCursor', getLeftTextOfCursorCallback);
  inputMethodController.off('getLeftTextOfCursor');
} catch(err) {
  console.error(`Failed to unsubscribing getLeftTextOfCursor. err: ${JSON.stringify(err)}`);
}

on(‘getRightTextOfCursor’)¹⁰⁺

on(type: ‘getRightTextOfCursor’, callback: (length: number) => string): void;

订阅输入法应用获取光标右侧指定长度文本事件。使用callback异步回调。

系统能力： SystemCapability.MiscServices.InputMethodFramework

参数：

参数名	类型	必填	说明
type	string	是	设置监听类型，固定取值为’getRightTextOfCursor’。
callback	(length: number) => string	是	回调函数，获取编辑框最新状态下光标右侧指定长度的文本内容并返回。

错误码：

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

错误码ID	错误信息
12800009	input method client is detached.

示例：

try {
  inputMethodController.on('getRightTextOfCursor', (length: number) => {
    console.info(`Succeeded in subscribing getRightTextOfCursor, length: ${length}`);
    let text:string = "";
    return text;
  });
} catch(err) {
  console.error(`Failed to subscribe getRightTextOfCursor. err: ${JSON.stringify(err)}`);
}

off(‘getRightTextOfCursor’)¹⁰⁺

off(type: ‘getRightTextOfCursor’, callback?: (length: number) => string): void;

取消订阅输入法应用获取光标右侧指定长度文本事件。使用callback异步回调。

系统能力： SystemCapability.MiscServices.InputMethodFramework

参数：

参数名	类型	必填	说明
type	string	是	设置监听类型，固定取值为’getRightTextOfCursor’。
callback	(length: number) => string	否	取消订阅的回调函数，需要与on接口传入的保持一致。参数不填写时，取消订阅type对应的所有回调事件。

示例：

try {
  let getRightTextOfCursorCallback = (length: number) => {
    console.info(`Succeeded in unsubscribing getRightTextOfCursor, length: ${length}`);
    let text:string = "";
    return text;
  };
  inputMethodController.off('getRightTextOfCursor', getRightTextOfCursorCallback);
  inputMethodController.off('getRightTextOfCursor');
} catch(err) {
  console.error(`Failed to unsubscribing getRightTextOfCursor. err: ${JSON.stringify(err)}`);
}

on(‘getTextIndexAtCursor’)¹⁰⁺

on(type: ‘getTextIndexAtCursor’, callback: () => number): void;

订阅输入法应用获取光标处文本索引事件。使用callback异步回调。

系统能力： SystemCapability.MiscServices.InputMethodFramework

参数：

参数名	类型	必填	说明
type	string	是	设置监听类型，固定取值为’getTextIndexAtCursor’。
callback	() => number	是	回调函数，获取编辑框最新状态下光标处文本索引并返回。

错误码：

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

错误码ID	错误信息
12800009	input method client is detached.

示例：

try {
  inputMethodController.on('getTextIndexAtCursor', () => {
    console.info(`Succeeded in subscribing getTextIndexAtCursor.`);
    let index:number = 0;
    return index;
  });
} catch(err) {
  console.error(`Failed to subscribe getTextIndexAtCursor. err: ${JSON.stringify(err)}`);
}

off(‘getTextIndexAtCursor’)¹⁰⁺

off(type: ‘getTextIndexAtCursor’, callback?: () => number): void;

取消订阅输入法应用获取光标处文本索引事件。使用callback异步回调。

系统能力： SystemCapability.MiscServices.InputMethodFramework

参数：

参数名	类型	必填	说明
type	string	是	设置监听类型，固定取值为’getTextIndexAtCursor’。
callback	() => number	否	取消订阅的回调函数，需要与on接口传入的保持一致。参数不填写时，取消订阅type对应的所有回调事件。

示例：

try {
  let getTextIndexAtCursorCallback = () => {
    console.info(`Succeeded in unsubscribing getTextIndexAtCursor.`);
    let index:number = 0;
    return index;
  };
  inputMethodController.off('getTextIndexAtCursor', getTextIndexAtCursorCallback);
  inputMethodController.off('getTextIndexAtCursor');
} catch(err) {
  console.error(`Failed to unsubscribing getTextIndexAtCursor. err: ${JSON.stringify(err)}`);
}

InputMethodSetting⁸⁺

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

on(‘imeChange’)⁹⁺

on(type: ‘imeChange’, callback: (inputMethodProperty: InputMethodProperty, inputMethodSubtype: InputMethodSubtype) => void): void

订阅输入法及子类型变化监听事件。使用callback异步回调。

系统能力： SystemCapability.MiscServices.InputMethodFramework

参数：

参数名	类型	必填	说明
type	string	是	设置监听类型，固定取值为’imeChange’。
callback	(inputMethodProperty: InputMethodProperty, inputMethodSubtype: InputMethodSubtype) => void	是	回调函数，返回输入法属性对象及子类型对象。

示例：

import InputMethodSubtype from '@ohos.InputMethodSubtype';
inputMethodSetting.on('imeChange', (inputMethodProperty: inputMethod.InputMethodProperty, inputMethodSubtype: InputMethodSubtype) => {
  console.log('Succeeded in subscribing imeChange: inputMethodProperty: ' + JSON.stringify(inputMethodProperty) + " , inputMethodSubtype: " + JSON.stringify(inputMethodSubtype));
});

off(‘imeChange’)⁹⁺

off(type: ‘imeChange’, callback?: (inputMethodProperty: InputMethodProperty, inputMethodSubtype: InputMethodSubtype) => void): void

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

系统能力： SystemCapability.MiscServices.InputMethodFramework

参数：

参数名	类型	必填	说明
type	string	是	设置监听类型，固定取值为’imeChange’。
callback	(inputMethodProperty: InputMethodProperty, inputMethodSubtype: InputMethodSubtype) => void	否	回调函数，返回取消订阅的输入法属性对象及子类型对象。

示例：

inputMethodSetting.off('imeChange');

on(‘imeShow’)¹⁰⁺

on(type: ‘imeShow’, callback: (info: Array<InputWindowInfo>) => void): void

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

系统接口：此接口为系统接口。

系统能力： SystemCapability.MiscServices.InputMethodFramework

参数：

参数名	类型	必填	说明
type	string	是	设置监听类型，固定取值为’imeShow’。
callback	(info: Array<InputWindowInfo>) => void	是	回调函数，返回输入法软键盘信息。

示例：

inputMethodSetting.on('imeShow', (info: Array<inputMethod.InputWindowInfo>) => {
    console.info('Succeeded in subscribing imeShow event.');
});

on(‘imeHide’)¹⁰⁺

on(type: ‘imeHide’, callback: (info: Array<InputWindowInfo>) => void): void

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

系统接口：此接口为系统接口。

系统能力： SystemCapability.MiscServices.InputMethodFramework

参数：

参数名	类型	必填	说明
type	string	是	设置监听类型，固定取值为’imeHide’。
callback	(info: Array<InputWindowInfo>) => void	是	回调函数，返回输入法软键盘信息。

示例：

inputMethodSetting.on('imeHide', (info: Array<inputMethod.InputWindowInfo>) => {
    console.info('Succeeded in subscribing imeHide event.');
});

off(‘imeShow’)¹⁰⁺

off(type: ‘imeShow’, callback?: (info: Array<InputWindowInfo>) => void): void

取消订阅输入法软键盘显示事件。

系统接口：此接口为系统接口。

系统能力： SystemCapability.MiscServices.InputMethodFramework

参数：

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

示例：

inputMethodSetting.off('imeShow');

off(‘imeHide’)¹⁰⁺

off(type: ‘imeHide’, callback?: (info: Array<InputWindowInfo>) => void): void

取消订阅输入法软键盘隐藏事件。

系统接口：此接口为系统接口。

系统能力： SystemCapability.MiscServices.InputMethodFramework

参数：

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

示例：

inputMethodSetting.off('imeHide');

listInputMethodSubtype⁹⁺

listInputMethodSubtype(inputMethodProperty: InputMethodProperty, callback: AsyncCallback<Array<InputMethodSubtype>>): void

获取指定输入法应用的所有子类型。使用callback异步回调。

系统能力： SystemCapability.MiscServices.InputMethodFramework

参数：

参数名	类型	必填	说明
inputMethodProperty	InputMethodProperty	是	输入法应用。
callback	AsyncCallback<Array<InputMethodSubtype>>	是	回调函数，返回指定输入法应用的所有子类型。

错误码：

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

错误码ID	错误信息
12800001	package manager error.
12800008	input method manager service error.

示例：

import inputMethod from '@ohos.inputMethod';
import InputMethodSubtype from '@ohos.InputMethodSubtype';
import { BusinessError } from '@ohos.base';

let inputMethodProperty: inputMethod.InputMethodProperty = {
  packageName: 'com.example.kikakeyboard',
  name: 'InputMethodExAbility',
  methodId: '',
  id: 'propertyId',
}
let inputMethodSetting = inputMethod.getSetting();
try {
  inputMethodSetting.listInputMethodSubtype(inputMethodProperty, (err: BusinessError, data: Array<InputMethodSubtype>) => {
    if (err) {
      console.error(`Failed to listInputMethodSubtype: ${JSON.stringify(err)}`);
      return;
    }
    console.log('Succeeded in listing inputMethodSubtype.');
  });
} catch (err) {
  console.error(`Failed to listInputMethodSubtype: ${JSON.stringify(err)}`);
}

listInputMethodSubtype⁹⁺

listInputMethodSubtype(inputMethodProperty: InputMethodProperty): Promise<Array<InputMethodSubtype>>

获取指定输入法应用的所有子类型。使用promise异步回调。

系统能力： SystemCapability.MiscServices.InputMethodFramework

参数：

参数名	类型	必填	说明
inputMethodProperty	InputMethodProperty	是	输入法应用。

返回值：

类型	说明
Promise>	Promise对象，返回指定输入法应用的所有子类型。

错误码：

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

错误码ID	错误信息
12800001	package manager error.
12800008	input method manager service error.

示例：

import inputMethod from '@ohos.inputMethod';
import InputMethodSubtype from '@ohos.InputMethodSubtype';
import { BusinessError } from '@ohos.base';

let inputMethodProperty: inputMethod.InputMethodProperty = {
  packageName: 'com.example.kikakeyboard',
  name: 'InputMethodExAbility',
  methodId: '',
  id: 'propertyId',
}
let inputMethodSetting = inputMethod.getSetting();
try {
  inputMethodSetting.listInputMethodSubtype(inputMethodProperty).then((data: Array<InputMethodSubtype>) => {
    console.log('Succeeded in listing inputMethodSubtype.');
  }).catch((err: BusinessError) => {
    console.error(`Failed to listInputMethodSubtype: ${JSON.stringify(err)}`);
  })
} catch(err) {
  console.error(`Failed to listInputMethodSubtype: ${JSON.stringify(err)}`);
}

listCurrentInputMethodSubtype⁹⁺

listCurrentInputMethodSubtype(callback: AsyncCallback<Array<InputMethodSubtype>>): void

查询当前输入法应用的所有子类型。使用callback异步回调。

系统能力： SystemCapability.MiscServices.InputMethodFramework

参数：

参数名	类型	必填	说明
callback	AsyncCallback<Array<InputMethodSubtype>>	是	回调函数，返回当前输入法应用的所有子类型。

错误码：

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

错误码ID	错误信息
12800001	package manager error.
12800008	input method manager service error.

示例：

import InputMethodSubtype from '@ohos.InputMethodSubtype';
import { BusinessError } from '@ohos.base';

let inputMethodSetting = inputMethod.getSetting();
try {
  inputMethodSetting.listCurrentInputMethodSubtype((err: BusinessError, data: Array<InputMethodSubtype>) => {
    if (err) {
      console.error(`Failed to listCurrentInputMethodSubtype: ${JSON.stringify(err)}`);
      return;
    }
    console.log('Succeeded in listing currentInputMethodSubtype.');
  });
} catch(err) {
  console.error(`Failed to listCurrentInputMethodSubtype: ${JSON.stringify(err)}`);
}

listCurrentInputMethodSubtype⁹⁺

listCurrentInputMethodSubtype(): Promise<Array<InputMethodSubtype>>

查询当前输入法应用的所有子类型。使用promise异步回调。

系统能力： SystemCapability.MiscServices.InputMethodFramework

返回值：

类型	说明
Promise>	Promise对象，返回当前输入法应用的所有子类型。

错误码：

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

错误码ID	错误信息
12800001	package manager error.
12800008	input method manager service error.

示例：

import InputMethodSubtype from '@ohos.InputMethodSubtype';
import { BusinessError } from '@ohos.base';

let inputMethodSetting = inputMethod.getSetting();
try {
  inputMethodSetting.listCurrentInputMethodSubtype().then((data: Array<InputMethodSubtype>) => {
    console.log('Succeeded in listing currentInputMethodSubtype.');
  }).catch((err: BusinessError) => {
    console.error(`Failed to listCurrentInputMethodSubtype: ${JSON.stringify(err)}`);
  })
} catch(err) {
  console.error(`Failed to listCurrentInputMethodSubtype: ${JSON.stringify(err)}`);
}

getInputMethods⁹⁺

getInputMethods(enable: boolean, callback: AsyncCallback<Array<InputMethodProperty>>): void

获取已激活/未激活的输入法应用列表。使用callback异步回调。

说明：

已激活输入法为使能的输入法应用。默认输入法默认使能，其他输入法可被设置为使能或非使能。

已激活输入法列表包括默认输入法和已被设置为使能的输入法应用，未激活输入法列表包括除使能输入法以外的其他已安装的输入法。

系统能力： SystemCapability.MiscServices.InputMethodFramework

参数：

参数名	类型	必填	说明
enable	boolean	是	true表示返回已激活输入法列表，false表示返回未激活输入法列表。
callback	AsyncCallback<Array<InputMethodProperty>>	是	回调函数，返回已激活/未激活输入法列表。

错误码：

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

错误码ID	错误信息
12800001	package manager error.
12800008	input method manager service error.

示例：

import { BusinessError } from '@ohos.base';

try {
  inputMethodSetting.getInputMethods(true, (err: BusinessError, data: Array<inputMethod.InputMethodProperty>) => {
    if (err) {
      console.error(`Failed to getInputMethods: ${JSON.stringify(err)}`);
      return;
    }
    console.log('Succeeded in getting inputMethods.');
  });
} catch (err: BusinessError) {
  console.error(`Failed to getInputMethods: ${JSON.stringify(err)}`);
}

getInputMethods⁹⁺

getInputMethods(enable: boolean): Promise<Array<InputMethodProperty>>

获取已激活/未激活的输入法应用列表。使用promise异步回调。

说明：

已激活输入法为使能的输入法应用。默认输入法默认使能，其他输入法可被设置为使能或非使能。

已激活输入法列表包括默认输入法和已被设置为使能的输入法应用，未激活输入法列表包括除使能输入法以外的其他已安装的输入法。

系统能力： SystemCapability.MiscServices.InputMethodFramework

参数：

参数名	类型	必填	说明
enable	boolean	是	- true表示返回已激活输入法列表，false表示返回未激活输入法列表。

返回值：

类型	说明
Promise<Array<InputMethodProperty>>	Promise对象，返回已激活/未激活输入法列表。

错误码：

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

错误码ID	错误信息
12800001	package manager error.
12800008	input method manager service error.

示例：

import { BusinessError } from '@ohos.base';

try {
  inputMethodSetting.getInputMethods(true).then((data: Array<inputMethod.InputMethodProperty>) => {
    console.log('Succeeded in getting inputMethods.');
  }).catch((err: BusinessError) => {
    console.error(`Failed to getInputMethods: ${JSON.stringify(err)}`);
  })
} catch(err: BusinessError) {
  console.error(`Failed to getInputMethods: ${JSON.stringify(err)}`);
}

getInputMethodsSync¹¹⁺

getInputMethodsSync(enable: boolean): Array<InputMethodProperty>

获取已激活/未激活的输入法应用列表。同步接口。

说明：

已激活输入法为使能的输入法应用。默认输入法默认使能，其他输入法可被设置为使能或非使能。

已激活输入法列表包括默认输入法和已被设置为使能的输入法应用，未激活输入法列表包括除使能输入法以外的其他已安装的输入法。

系统能力： SystemCapability.MiscServices.InputMethodFramework

参数：

参数名	类型	必填	说明
enable	boolean	是	- true表示返回已激活输入法列表，false表示返回未激活输入法列表。

返回值：

类型	说明
Array<InputMethodProperty>	返回已激活/未激活输入法列表。

错误码：

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

错误码ID	错误信息
12800001	package manager error.
12800008	input method manager service error.

示例：

import { BusinessError } from '@ohos.base';

try {
  let imeProp = inputMethodSetting.getInputMethodsSync(true);
} catch(err: BusinessError) {
  console.error(`Failed to getInputMethods: ${JSON.stringify(err)}`);
}

getAllInputMethods¹¹⁺

getAllInputMethods(callback: AsyncCallback<Array<InputMethodProperty>>): void

获取所有输入法应用列表。使用callback异步回调。

系统能力： SystemCapability.MiscServices.InputMethodFramework

参数：

参数名	类型	必填	说明
callback	AsyncCallback<Array<InputMethodProperty>>	是	回调函数，返回所有输入法列表。

错误码：

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

错误码ID	错误信息
12800001	package manager error.
12800008	input method manager service error.

示例：

import { BusinessError } from '@ohos.base';

try {
  inputMethodSetting.getAllInputMethods((err: BusinessError, data: Array<inputMethod.InputMethodProperty>) => {
    if (err) {
      console.error(`Failed to getAllInputMethods: ${JSON.stringify(err)}`);
      return;
    }
    console.log('Succeeded in getting all inputMethods.');
  });
} catch (err: BusinessError) {
  console.error(`Failed to getAllInputMethods: ${JSON.stringify(err)}`);
}

getAllInputMethods¹¹⁺

getAllInputMethods(): Promise<Array<InputMethodProperty>>

获取所有输入法应用列表。使用promise异步回调。

系统能力： SystemCapability.MiscServices.InputMethodFramework

返回值：

类型	说明
Promise<Array<InputMethodProperty>>	Promise对象，返回所有输入法列表。

错误码：

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

错误码ID	错误信息
12800001	package manager error.
12800008	input method manager service error.

示例：

import { BusinessError } from '@ohos.base';

inputMethodSetting.getAllInputMethods().then((data: Array<inputMethod.InputMethodProperty>) => {
  console.log('Succeeded in getting all inputMethods.');
}).catch((err: BussinessError) => {
  console.error(`Failed to getAllInputMethods: ${JSON.stringify(err)}`);
})

getAllInputMethodsSync¹¹⁺

getAllInputMethodsSync(): Array<InputMethodProperty>

获取所有输入法应用列表。同步接口。

系统能力： SystemCapability.MiscServices.InputMethodFramework

返回值：

类型	说明
Array<InputMethodProperty>	返回所有输入法列表

错误码：

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

错误码ID	错误信息
12800001	package manager error.
12800008	input method manager service error.

示例：

import { BusinessError } from '@ohos.base';

try {
  let imeProp = inputMethodSetting.getAllInputMethodsSync();
} catch(err: BusinessError) {
  console.error(`Failed to getAllInputMethodsSync: ${JSON.stringify(err)}`);
}

showOptionalInputMethods⁹⁺

showOptionalInputMethods(callback: AsyncCallback<boolean>): void

显示输入法选择对话框。使用callback异步回调。

系统能力： SystemCapability.MiscServices.InputMethodFramework

参数：

参数名	类型	必填	说明
callback	AsyncCallback<boolean>	是	回调函数。当输入法选择对话框显示成功，err为undefined，data为true；否则为错误对象。

错误码：

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

错误码ID	错误信息
12800008	input method manager service error.

示例：

try {
  inputMethodSetting.showOptionalInputMethods((err: BusinessError, data: boolean) => {
    if (err) {
      console.error(`Failed to showOptionalInputMethods: ${JSON.stringify(err)}`);
      return;
    }
    console.log('Succeeded in showing optionalInputMethods.');
  });
} catch (err) {
  console.error(`Failed to showOptionalInputMethods: ${JSON.stringify(err)}`);
}

showOptionalInputMethods⁹⁺

showOptionalInputMethods(): Promise<boolean>

显示输入法选择对话框。使用promise异步回调。

系统能力： SystemCapability.MiscServices.InputMethodFramework

返回值：

类型	说明
Promise<boolean>	Promise对象。返回true表示输入法选择对话框显示成功，返回false表示输入法选择对话框显示失败。

错误码：

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

错误码ID	错误信息
12800008	input method manager service error.

示例：

inputMethodSetting.showOptionalInputMethods().then((data: boolean) => {
  console.log('Succeeded in showing optionalInputMethods.');
}).catch((err: Error) => {
  console.error(`Failed to showOptionalInputMethods: ${JSON.stringify(err)}`);
})

listInputMethod^(deprecated)

listInputMethod(callback: AsyncCallback<Array<InputMethodProperty>>): void

查询已安装的输入法列表。使用callback异步回调。

说明：

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

系统能力： SystemCapability.MiscServices.InputMethodFramework

参数：

参数名	类型	必填	说明
callback	AsyncCallback<Array<InputMethodProperty>>	是	回调函数，返回已安装的输入法列表。

示例：

inputMethodSetting.listInputMethod((err: BusinessError, data: Array<inputMethod.InputMethodProperty>) => {
  if (err) {
    console.error(`Failed to listInputMethod: ${JSON.stringify(err)}`);
    return;
  }
  console.log('Succeeded in listing inputMethod.');
 });

listInputMethod^(deprecated)

listInputMethod(): Promise<Array<InputMethodProperty>>

查询已安装的输入法列表。使用promise异步回调。

说明：

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

系统能力： SystemCapability.MiscServices.InputMethodFramework

返回值：

类型	说明
Promise>	Promise对象，返回已安装输入法列表。

示例：

inputMethodSetting.listInputMethod().then((data: Array<inputMethod.InputMethodProperty>) => {
  console.log('Succeeded in listing inputMethod.');
}).catch((err: Error) => {
  console.error(`Failed to listInputMethod: ${JSON.stringify(err)}`);
})

displayOptionalInputMethod^(deprecated)

displayOptionalInputMethod(callback: AsyncCallback<void>): void

显示输入法选择对话框。使用callback异步回调。

说明：

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

系统能力： SystemCapability.MiscServices.InputMethodFramework

参数：

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

示例：

inputMethodSetting.displayOptionalInputMethod((err: BusinessError) => {
  if (err) {
    console.error(`Failed to displayOptionalInputMethod: ${JSON.stringify(err)}`);
    return;
  }
  console.log('Succeeded in displaying optionalInputMethod.');
});

displayOptionalInputMethod^(deprecated)

displayOptionalInputMethod(): Promise<void>

显示输入法选择对话框。使用promise异步回调。

说明：

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

系统能力： SystemCapability.MiscServices.InputMethodFramework

返回值：

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

示例：

inputMethodSetting.displayOptionalInputMethod().then(() => {
  console.log('Succeeded in displaying optionalInputMethod.');
}).catch((err: Error) => {
  console.error(`Failed to displayOptionalInputMethod: ${JSON.stringify(err)}`);
})

你可能感兴趣的鸿蒙文章

harmony 鸿蒙接口

harmony 鸿蒙系统公共事件定义(待停用)

harmony 鸿蒙系统公共事件定义

harmony 鸿蒙开发说明

harmony 鸿蒙企业设备管理概述（仅对系统应用开放）

harmony 鸿蒙BundleStatusCallback

harmony 鸿蒙@ohos.bundle.innerBundleManager (innerBundleManager模块)

harmony 鸿蒙@ohos.distributedBundle (分布式包管理)

harmony 鸿蒙@ohos.bundle (Bundle模块)

harmony 鸿蒙@ohos.enterprise.EnterpriseAdminExtensionAbility (企业设备管理扩展能力)

0 赞

所属分类： 后端技术
本文标签： 鸿蒙软件
版权声明： 原创文章如转载，请注明本文链接: https://m.seaxiang.com/blog/dbb19e84d37b4b3ebdd5bc2d5e45cba6

harmony 鸿蒙@ohos.inputMethod (输入法框架)

@ohos.inputMethod (输入法框架)

导入模块

常量8+

InputMethodProperty8+

inputMethod.getController9+

inputMethod.getSetting9+

inputMethod.switchInputMethod9+

inputMethod.switchInputMethod9+

inputMethod.getCurrentInputMethod9+

inputMethod.switchCurrentInputMethodSubtype9+

inputMethod.switchCurrentInputMethodSubtype9+

inputMethod.getCurrentInputMethodSubtype9+

inputMethod.switchCurrentInputMethodAndSubtype9+

inputMethod.switchCurrentInputMethodAndSubtype9+

inputMethod.getInputMethodController(deprecated)

inputMethod.getInputMethodSetting(deprecated)

TextInputType10+

EnterKeyType10+

KeyboardStatus10+

Direction10+

ExtendAction10+

FunctionKey10+

InputAttribute10+

TextConfig10+

CursorInfo10+

Range10+

Movement10+

InputWindowInfo10+

InputMethodController

attach10+

attach10+

showTextInput10+

showTextInput10+

hideTextInput10+

hideTextInput10+

detach10+

detach10+

setCallingWindow10+

setCallingWindow10+

updateCursor10+

updateCursor10+

changeSelection10+

changeSelection10+

updateAttribute10+

updateAttribute10+

stopInputSession9+

stopInputSession9+

showSoftKeyboard9+

showSoftKeyboard9+

hideSoftKeyboard9+

hideSoftKeyboard9+

stopInput(deprecated)

stopInput(deprecated)

on(‘insertText’)10+

off(‘insertText’)10+

on(‘deleteLeft’)10+

off(‘deleteLeft’)10+

on(‘deleteRight’)10+

off(‘deleteRight’)10+

on(‘sendKeyboardStatus’)10+

off(‘sendKeyboardStatus’)10+

on(‘sendFunctionKey’)10+

off(‘sendFunctionKey’)10+

on(‘moveCursor’)10+

off(‘moveCursor’)10+

on(‘handleExtendAction’)10+

off(‘handleExtendAction’)10+

on(‘selectByRange’)10+

off(‘selectByRange’)10+

on(‘selectByMovement’)10+

off(‘selectByMovement’)10+

on(‘getLeftTextOfCursor’)10+

off(‘getLeftTextOfCursor’)10+

on(‘getRightTextOfCursor’)10+

off(‘getRightTextOfCursor’)10+

on(‘getTextIndexAtCursor’)10+

off(‘getTextIndexAtCursor’)10+

InputMethodSetting8+

on(‘imeChange’)9+

常量⁸⁺

InputMethodProperty⁸⁺

inputMethod.getController⁹⁺

inputMethod.getSetting⁹⁺

inputMethod.switchInputMethod⁹⁺

inputMethod.switchInputMethod⁹⁺

inputMethod.getCurrentInputMethod⁹⁺

inputMethod.switchCurrentInputMethodSubtype⁹⁺

inputMethod.switchCurrentInputMethodSubtype⁹⁺

inputMethod.getCurrentInputMethodSubtype⁹⁺

inputMethod.switchCurrentInputMethodAndSubtype⁹⁺

inputMethod.switchCurrentInputMethodAndSubtype⁹⁺

inputMethod.getInputMethodController^(deprecated)

inputMethod.getInputMethodSetting^(deprecated)

TextInputType¹⁰⁺

EnterKeyType¹⁰⁺

KeyboardStatus¹⁰⁺

Direction¹⁰⁺

ExtendAction¹⁰⁺

FunctionKey¹⁰⁺

InputAttribute¹⁰⁺

TextConfig¹⁰⁺

CursorInfo¹⁰⁺

Range¹⁰⁺

Movement¹⁰⁺

InputWindowInfo¹⁰⁺

attach¹⁰⁺

attach¹⁰⁺

showTextInput¹⁰⁺

showTextInput¹⁰⁺

hideTextInput¹⁰⁺

hideTextInput¹⁰⁺

detach¹⁰⁺

detach¹⁰⁺

setCallingWindow¹⁰⁺

setCallingWindow¹⁰⁺

updateCursor¹⁰⁺

updateCursor¹⁰⁺

changeSelection¹⁰⁺

changeSelection¹⁰⁺

updateAttribute¹⁰⁺

updateAttribute¹⁰⁺

stopInputSession⁹⁺

stopInputSession⁹⁺

showSoftKeyboard⁹⁺

showSoftKeyboard⁹⁺

hideSoftKeyboard⁹⁺

hideSoftKeyboard⁹⁺

stopInput^(deprecated)

stopInput^(deprecated)

on(‘insertText’)¹⁰⁺

off(‘insertText’)¹⁰⁺

on(‘deleteLeft’)¹⁰⁺

off(‘deleteLeft’)¹⁰⁺

on(‘deleteRight’)¹⁰⁺

off(‘deleteRight’)¹⁰⁺

on(‘sendKeyboardStatus’)¹⁰⁺

off(‘sendKeyboardStatus’)¹⁰⁺

on(‘sendFunctionKey’)¹⁰⁺

off(‘sendFunctionKey’)¹⁰⁺

on(‘moveCursor’)¹⁰⁺

off(‘moveCursor’)¹⁰⁺

on(‘handleExtendAction’)¹⁰⁺

off(‘handleExtendAction’)¹⁰⁺

on(‘selectByRange’)¹⁰⁺

off(‘selectByRange’)¹⁰⁺

on(‘selectByMovement’)¹⁰⁺

off(‘selectByMovement’)¹⁰⁺

on(‘getLeftTextOfCursor’)¹⁰⁺

off(‘getLeftTextOfCursor’)¹⁰⁺

on(‘getRightTextOfCursor’)¹⁰⁺

off(‘getRightTextOfCursor’)¹⁰⁺

on(‘getTextIndexAtCursor’)¹⁰⁺

off(‘getTextIndexAtCursor’)¹⁰⁺

InputMethodSetting⁸⁺

on(‘imeChange’)⁹⁺

off(‘imeChange’)⁹⁺

on(‘imeShow’)¹⁰⁺

on(‘imeHide’)¹⁰⁺

off(‘imeShow’)¹⁰⁺