输入法框架

2024-01-23 17:20 更新

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

说明

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

导入模块

  1. import inputMethod from '@ohos.inputMethod';

常量8+

常量值。

系统能力: SystemCapability.MiscServices.InputMethodFramework

参数名

类型

常量值

说明

MAX_TYPE_NUM

number

128

可支持的最大输入法个数。

InputMethodProperty8+

输入法应用属性。

系统能力: SystemCapability.MiscServices.InputMethodFramework

名称

类型

可读

可写

说明

name9+

string

输入法内部名称。必填。

id9+

string

输入法唯一标识。必填。

label9+

string

输入法对外显示名称。 非必填。

icon9+

string

输入法图标数据。非必填。

iconId9+

number

输入法图标资源号。非必填。

extra9+

object

输入法扩展信息。 必填。

packageName(deprecated)

string

输入法包名。必填。

说明: 从API version 8开始支持,从API version 9开始废弃,建议使用name替代。

methodId(deprecated)

string

输入法唯一标识。必填。

说明: 从API version 8开始支持,从API version 9开始废弃,建议使用id替代。

inputMethod.getController9+

getController(): InputMethodController

获取客户端实例InputMethodController

系统能力: SystemCapability.MiscServices.InputMethodFramework

返回值:

类型

说明

InputMethodController

回调返回当前客户端实例。

错误码:

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

错误码ID

错误信息

12800006

input method controller error.

示例:

  1. let inputMethodController = inputMethod.getController();

inputMethod.getSetting9+

getSetting(): InputMethodSetting

获取客户端设置实例InputMethodSetting

系统能力: SystemCapability.MiscServices.InputMethodFramework

返回值:

类型

说明

InputMethodSetting

回调返回当前客户端设置实例。

错误码:

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

错误码ID

错误信息

12800007

input method settings extension error.

示例:

  1. let inputMethodSetting = inputMethod.getSetting();

inputMethod.switchInputMethod9+

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.

示例:

  1. let im = inputMethod.getCurrentInputMethod();
  2. let prop = {
  3. packageName: im.packageName,
  4. methodId: im.methodId,
  5. name: im.packageName,
  6. id: im.methodId,
  7. extra: {}
  8. }
  9. try{
  10. inputMethod.switchInputMethod(prop, (err, result) => {
  11. if (err !== undefined) {
  12. console.error('Failed to switchInputMethod: ' + JSON.stringify(err));
  13. return;
  14. }
  15. if (result) {
  16. console.info('Succeeded in switching inputmethod.');
  17. } else {
  18. console.error('Failed to switchInputMethod.');
  19. }
  20. });
  21. } catch(err) {
  22. console.error('Failed to switchInputMethod: ' + JSON.stringify(err));
  23. }

inputMethod.switchInputMethod9+

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.

示例:

  1. let im = inputMethod.getCurrentInputMethod();
  2. let prop = {
  3. packageName: im.packageName,
  4. methodId: im.methodId,
  5. name: im.packageName,
  6. id: im.methodId,
  7. extra: {}
  8. }
  9. try {
  10. inputMethod.switchInputMethod(prop).then((result) => {
  11. if (result) {
  12. console.info('Succeeded in switching inputmethod.');
  13. } else {
  14. console.error('Failed to switchInputMethod.');
  15. }
  16. }).catch((err) => {
  17. console.error('Failed to switchInputMethod: ' + JSON.stringify(err));
  18. })
  19. } catch(err) {
  20. console.error('Failed to switchInputMethod: ' + JSON.stringify(err));
  21. }

inputMethod.getCurrentInputMethod9+

getCurrentInputMethod(): InputMethodProperty

获取当前输入法扩展应用,提供同步接口,返回当前输入法属性。

系统能力: SystemCapability.MiscServices.InputMethodFramework

返回值:

类型

说明

InputMethodProperty

返回当前输入法属性对象。

示例:

  1. let currentIme = inputMethod.getCurrentInputMethod();

inputMethod.switchCurrentInputMethodSubtype9+

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

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

需要权限: 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.

示例:

  1. try {
  2. inputMethod.switchCurrentInputMethodSubtype({
  3. id: "ServiceExtAbility",
  4. label: "",
  5. name: "com.example.kikakeyboard",
  6. mode: "upper",
  7. locale: "",
  8. language: "",
  9. icon: "",
  10. iconId: 0,
  11. extra: {}
  12. }, (err, result) => {
  13. if (err !== undefined) {
  14. console.error('Failed to switchCurrentInputMethodSubtype: ' + JSON.stringify(err));
  15. return;
  16. }
  17. if (result) {
  18. console.info('Succeeded in switching currentInputMethodSubtype.');
  19. } else {
  20. console.error('Failed to switchCurrentInputMethodSubtype');
  21. }
  22. });
  23. } catch(err) {
  24. console.error('Failed to switchCurrentInputMethodSubtype: ' + JSON.stringify(err));
  25. }

inputMethod.switchCurrentInputMethodSubtype9+

switchCurrentInputMethodSubtype(target: InputMethodSubtype): Promise<boolean>

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

需要权限: 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.

示例:

  1. try {
  2. inputMethod.switchCurrentInputMethodSubtype({
  3. id: "ServiceExtAbility",
  4. label: "",
  5. name: "com.example.kikakeyboard",
  6. mode: "upper",
  7. locale: "",
  8. language: "",
  9. icon: "",
  10. iconId: 0,
  11. extra: {}
  12. }).then((result) => {
  13. if (result) {
  14. console.info('Succeeded in switching currentInputMethodSubtype.');
  15. } else {
  16. console.error('Failed to switchCurrentInputMethodSubtype.');
  17. }
  18. }).catch((err) => {
  19. console.error('Failed to switchCurrentInputMethodSubtype: ' + JSON.stringify(err));
  20. })
  21. } catch(err) {
  22. console.error('Failed to switchCurrentInputMethodSubtype: ' + JSON.stringify(err));
  23. }

inputMethod.getCurrentInputMethodSubtype9+

getCurrentInputMethodSubtype(): InputMethodSubtype

获取当前输入法子类型。

系统能力: SystemCapability.MiscServices.InputMethodFramework

返回值:

类型

说明

InputMethodSubtype

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

示例:

  1. let currentImeSubType = inputMethod.getCurrentInputMethodSubtype();

inputMethod.switchCurrentInputMethodAndSubtype9+

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.

示例:

  1. let im = inputMethod.getCurrentInputMethod();
  2. let imSubType = inputMethod.getCurrentInputMethodSubtype();
  3. try {
  4. inputMethod.switchCurrentInputMethodAndSubtype(im, imSubType, (err,result) => {
  5. if (err !== undefined) {
  6. console.error('Failed to switchCurrentInputMethodAndSubtype: ' + JSON.stringify(err));
  7. return;
  8. }
  9. if (result) {
  10. console.info('Succeeded in switching currentInputMethodAndSubtype.');
  11. } else {
  12. console.error('Failed to switchCurrentInputMethodAndSubtype.');
  13. }
  14. });
  15. } catch (err) {
  16. console.error('Failed to switchCurrentInputMethodAndSubtype: ' + JSON.stringify(err));
  17. }

inputMethod.switchCurrentInputMethodAndSubtype9+

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.

示例:

  1. let im = inputMethod.getCurrentInputMethod();
  2. let imSubType = inputMethod.getCurrentInputMethodSubtype();
  3. try {
  4. inputMethod.switchCurrentInputMethodAndSubtype(im, imSubType).then((result) => {
  5. if (result) {
  6. console.info('Succeeded in switching currentInputMethodAndSubtype.');
  7. } else {
  8. console.error('Failed to switchCurrentInputMethodAndSubtype.');
  9. }
  10. }).catch((err) => {
  11. console.error('Failed to switchCurrentInputMethodAndSubtype: ' + JSON.stringify(err));
  12. })
  13. } catch(err) {
  14. console.error('Failed to switchCurrentInputMethodAndSubtype: ' + JSON.stringify(err));
  15. }

inputMethod.getInputMethodController(deprecated)

getInputMethodController(): InputMethodController

获取客户端实例InputMethodController

说明

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

系统能力: SystemCapability.MiscServices.InputMethodFramework

返回值:

类型

说明

InputMethodController

回调返回当前客户端实例。

示例:

  1. let inputMethodController = inputMethod.getInputMethodController();

inputMethod.getInputMethodSetting(deprecated)

getInputMethodSetting(): InputMethodSetting

获取客户端设置实例InputMethodSetting

说明

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

系统能力: SystemCapability.MiscServices.InputMethodFramework

返回值:

类型

说明

InputMethodSetting

回调返回当前客户端设置实例。

示例:

  1. let inputMethodSetting = inputMethod.getInputMethodSetting();

InputMethodController

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

stopInputSession9+

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.

示例:

  1. try {
  2. inputMethodController.stopInputSession((error, result) => {
  3. if (error !== undefined) {
  4. console.error('Failed to stopInputSession: ' + JSON.stringify(error));
  5. return;
  6. }
  7. if (result) {
  8. console.info('Succeeded in stopping inputSession.');
  9. } else {
  10. console.error('Failed to stopInputSession.');
  11. }
  12. });
  13. } catch(error) {
  14. console.error('Failed to stopInputSession: ' + JSON.stringify(error));
  15. }

stopInputSession9+

stopInputSession(): Promise<boolean>

结束输入会话。通过点击输入框实现输入会话的开启之后此接口才可生效。使用promise异步回调。

系统能力: SystemCapability.MiscServices.InputMethodFramework

返回值:

类型

说明

Promise<boolean>

Promise对象。返回true表示结束输入会话成功;返回false表示结束输入会话失败。

错误码:

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

错误码ID

错误信息

12800003

input method client error.

12800008

input method manager service error.

示例:

  1. try {
  2. inputMethodController.stopInputSession().then((result) => {
  3. if (result) {
  4. console.info('Succeeded in stopping inputSession.');
  5. } else {
  6. console.error('Failed to stopInputSession.');
  7. }
  8. }).catch((err) => {
  9. console.error('Failed to stopInputSession: ' + JSON.stringify(err));
  10. })
  11. } catch(err) {
  12. console.error('Failed to stopInputSession: ' + JSON.stringify(err));
  13. }

showSoftKeyboard9+

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.

示例:

  1. inputMethodController.showSoftKeyboard((err) => {
  2. if (err === undefined) {
  3. console.info('Succeeded in showing softKeyboard.');
  4. } else {
  5. console.error('Failed to showSoftKeyboard: ' + JSON.stringify(err));
  6. }
  7. })

showSoftKeyboard9+

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.

示例:

  1. inputMethodController.showSoftKeyboard().then(() => {
  2. console.log('Succeeded in showing softKeyboard.');
  3. }).catch((err) => {
  4. console.error('Failed to showSoftKeyboard: ' + JSON.stringify(err));
  5. });

hideSoftKeyboard9+

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.

示例:

  1. inputMethodController.hideSoftKeyboard((err) => {
  2. if (err === undefined) {
  3. console.info('Succeeded in hiding softKeyboard.');
  4. } else {
  5. console.error('Failed to hideSoftKeyboard: ' + JSON.stringify(err));
  6. }
  7. })

hideSoftKeyboard9+

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.

示例:

  1. inputMethodController.hideSoftKeyboard().then(() => {
  2. console.log('Succeeded in hiding softKeyboard.');
  3. }).catch((err) => {
  4. console.error('Failed to hideSoftKeyboard: ' + JSON.stringify(err));
  5. });

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

示例:

  1. inputMethodController.stopInput((error, result) => {
  2. if (error !== undefined) {
  3. console.error('Failed to stopInput: ' + JSON.stringify(error));
  4. return;
  5. }
  6. if (result) {
  7. console.info('Succeeded in stopping input.');
  8. } else {
  9. console.error('Failed to stopInput.');
  10. }
  11. });

stopInput(deprecated)

stopInput(): Promise<boolean>

结束输入会话。通过点击输入框实现输入会话的开启之后该接口的调用才可生效。使用promise异步回调。

说明

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

系统能力: SystemCapability.MiscServices.InputMethodFramework

返回值:

类型

说明

Promise<boolean>

Promise对象。返回true表示输入法隐藏成功;返回false表示输入法隐藏失败。

示例:

  1. inputMethodController.stopInput().then((result) => {
  2. if (result) {
  3. console.info('Succeeded in stopping input.');
  4. } else {
  5. console.error('Failed to stopInput.');
  6. }
  7. }).catch((err) => {
  8. console.error('Failed to stopInput: ' + err);
  9. })

InputMethodSetting8+

下列API示例中都需使用getSetting获取到InputMethodSetting实例,再通过此实例调用对应方法。

on('imeChange')9+

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

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

系统能力: SystemCapability.MiscServices.InputMethodFramework

参数:

参数名

类型

必填

说明

type

string

设置监听类型。

-type为‘imeChange’时表示订阅输入法及子类型变化监听事件。

callback

(inputMethodProperty: InputMethodProperty, inputMethodSubtype:

InputMethodSubtype) => void

回调函数,返回输入法属性对象及输入法子类型对象。

示例:

  1. inputMethodSetting.on('imeChange', (inputMethodProperty, inputMethodSubtype) => {
  2. console.info('Succeeded in subscribing imeChange: inputMethodProperty: ' + JSON.stringify(inputMethodProperty) + " , inputMethodSubtype: " + JSON.stringify(inputMethodSubtype));
  3. });

off('imeChange')9+

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

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

系统能力: SystemCapability.MiscServices.InputMethodFramework

参数:

参数名

类型

必填

说明

type

string

设置监听类型。

-type为‘imeChange’时表示取消订阅输入法及子类型变化监听事件。

callback

(inputMethodProperty: InputMethodProperty, inputMethodSubtype:

InputMethodSubtype) => void

回调函数,返回取消订阅的输入法属性对象及输入法子类型对象。

示例:

  1. inputMethodSetting.off('imeChange');

listInputMethodSubtype9+

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.

示例:

  1. let inputMethodProperty = {
  2. packageName: 'com.example.kikakeyboard',
  3. methodId: 'com.example.kikakeyboard',
  4. name: 'com.example.kikakeyboard',
  5. id: 'com.example.kikakeyboard',
  6. extra:{}
  7. }
  8. try {
  9. inputMethodSetting.listInputMethodSubtype(inputMethodProperty, (err,data) => {
  10. if (err !== undefined) {
  11. console.error('Failed to listInputMethodSubtype: ' + JSON.stringify(err));
  12. return;
  13. }
  14. console.log('Succeeded in listing inputMethodSubtype.');
  15. });
  16. } catch (err) {
  17. console.error('Failed to listInputMethodSubtype: ' + JSON.stringify(err));
  18. }

listInputMethodSubtype9+

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

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

系统能力: SystemCapability.MiscServices.InputMethodFramework

参数:

参数名

类型

必填

说明

inputMethodProperty

InputMethodProperty

子类型所属的输入法应用。

返回值:

类型

说明

Promise<Array<InputMethodSubtype>>

Promise对象,返回指定输入法应用的所有子类型。

错误码:

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

错误码ID

错误信息

12800001

package manager error.

12800008

input method manager service error.

示例:

  1. let inputMethodProperty = {
  2. packageName: 'com.example.kikakeyboard',
  3. methodId: 'com.example.kikakeyboard',
  4. name: 'com.example.kikakeyboard',
  5. id: 'com.example.kikakeyboard',
  6. extra:{}
  7. }
  8. try {
  9. inputMethodSetting.listInputMethodSubtype(inputMethodProperty).then((data) => {
  10. console.info('Succeeded in listing inputMethodSubtype.');
  11. }).catch((err) => {
  12. console.error('Failed to listInputMethodSubtype: ' + JSON.stringify(err));
  13. })
  14. } catch(err) {
  15. console.error('Failed to listInputMethodSubtype: ' + JSON.stringify(err));
  16. }

listCurrentInputMethodSubtype9+

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.

示例:

  1. try {
  2. inputMethodSetting.listCurrentInputMethodSubtype((err, data) => {
  3. if (err !== undefined) {
  4. console.error('Failed to listCurrentInputMethodSubtype: ' + JSON.stringify(err));
  5. return;
  6. }
  7. console.log('Succeeded in listing currentInputMethodSubtype.');
  8. });
  9. } catch(err) {
  10. console.error('Failed to listCurrentInputMethodSubtype: ' + JSON.stringify(err));
  11. }

listCurrentInputMethodSubtype9+

listCurrentInputMethodSubtype(): Promise<Array<InputMethodSubtype>>

查询当前输入法的子类型列表。使用promise异步回调。

系统能力: SystemCapability.MiscServices.InputMethodFramework

返回值:

类型

说明

Promise<Array<InputMethodSubtype>>

Promise对象,返回当前输入法应用的所有子类型。

错误码:

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

错误码ID

错误信息

12800001

package manager error.

12800008

input method manager service error.

示例:

  1. try {
  2. inputMethodSetting.listCurrentInputMethodSubtype().then((data) => {
  3. console.info('Succeeded in listing currentInputMethodSubtype.');
  4. }).catch((err) => {
  5. console.error('Failed to listCurrentInputMethodSubtype: ' + JSON.stringify(err));
  6. })
  7. } catch(err) {
  8. console.error('Failed to listCurrentInputMethodSubtype: ' + JSON.stringify(err));
  9. }

getInputMethods9+

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

获取已激活/未激活输入法列表。参数enable取true,返回已激活输入法列表,取false返回未激活输入法列表。已激活/未激活输入法的确切功能当前版本未支持。当前版本中,已激活输入法包括当前使用的输入法,未激活输入法包括当前输入法以外的其他已安装的输入法。使用callback异步回调。

系统能力: SystemCapability.MiscServices.InputMethodFramework

参数:

参数名

类型

必填

说明

enable

boolean

指定返回已激活/未激活。

callback

AsyncCallback<Array<InputMethodProperty>>

回调函数,返回已激活/未激活输入法列表。

错误码:

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

错误码ID

错误信息

12800001

package manager error.

12800008

input method manager service error.

示例:

  1. try {
  2. inputMethodSetting.getInputMethods(true, (err,data) => {
  3. if (err !== undefined) {
  4. console.error('Failed to getInputMethods: ' + JSON.stringify(err));
  5. return;
  6. }
  7. console.log('Succeeded in getting inputMethods.');
  8. });
  9. } catch (err) {
  10. console.error('Failed to getInputMethods: ' + JSON.stringify(err));
  11. }

getInputMethods9+

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

获取已激活/未激活输入法列表。参数enable取true,返回已激活输入法列表,取false返回未激活输入法列表。已激活/未激活输入法的确切功能当前版本未支持。当前版本中,已激活输入法包括当前使用的输入法,未激活输入法包括当前输入法以外的其他已安装的输入法。使用promise异步回调。

系统能力: SystemCapability.MiscServices.InputMethodFramework

参数:

参数名

类型

必填

说明

enable

boolean

指定返回已激活/未激活。

错误码:

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

错误码ID

错误信息

12800001

package manager error.

12800008

input method manager service error.

返回值:

类型

说明

Promise<Array<InputMethodProperty>>

Promise对象,返回已激活/未激活输入法列表。

示例:

  1. try {
  2. inputMethodSetting.getInputMethods(true).then((data) => {
  3. console.info('Succeeded in getting inputMethods.');
  4. }).catch((err) => {
  5. console.error('Failed to getInputMethods: ' + JSON.stringify(err));
  6. })
  7. } catch(err) {
  8. console.error('Failed to getInputMethods: ' + JSON.stringify(err));
  9. }

showOptionalInputMethods9+

showOptionalInputMethods(callback: AsyncCallback<boolean>): void

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

系统能力: SystemCapability.MiscServices.InputMethodFramework

参数:

参数名

类型

必填

说明

callback

AsyncCallback<boolean>

回调函数。当输入法选择对话框显示成功,err为undefined,data为true;否则为错误对象。

错误码:

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

错误码ID

错误信息

12800008

input method manager service error.

示例:

  1. try {
  2. inputMethodSetting.showOptionalInputMethods((err, data) => {
  3. if (err !== undefined) {
  4. console.error('Failed to showOptionalInputMethods: ' + JSON.stringify(err));
  5. return;
  6. }
  7. console.info('Succeeded in showing optionalInputMethods.');
  8. });
  9. } catch (err) {
  10. console.error('Failed to showOptionalInputMethods: ' + JSON.stringify(err));
  11. }

showOptionalInputMethods9+

showOptionalInputMethods(): Promise<boolean>

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

系统能力: SystemCapability.MiscServices.InputMethodFramework

返回值:

类型

说明

Promise<boolean>

Promise对象。返回true表示输入法选择对话框显示成功;返回false表示输入法选择对话框显示失败。

错误码:

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

错误码ID

错误信息

12800008

input method manager service error.

示例:

  1. inputMethodSetting.showOptionalInputMethods().then((data) => {
  2. console.info('Succeeded in showing optionalInputMethods.');
  3. }).catch((err) => {
  4. console.error('Failed to showOptionalInputMethods: ' + JSON.stringify(err));
  5. })

listInputMethod(deprecated)

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

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

说明

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

系统能力: SystemCapability.MiscServices.InputMethodFramework

参数:

参数名

类型

必填

说明

callback

AsyncCallback<Array<InputMethodProperty>>

回调函数,返回已安装的输入法列表。

示例:

  1. inputMethodSetting.listInputMethod((err,data) => {
  2. if (err !== undefined) {
  3. console.error('Failed to listInputMethod: ' + JSON.stringify(err));
  4. return;
  5. }
  6. console.log('Succeeded in listing inputMethod.');
  7. });

listInputMethod(deprecated)

listInputMethod(): Promise<Array<InputMethodProperty>>

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

说明

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

系统能力: SystemCapability.MiscServices.InputMethodFramework

返回值:

类型

说明

Promise<Array<InputMethodProperty>>

Promise对象,返回已安装输入法列表。

示例:

  1. inputMethodSetting.listInputMethod().then((data) => {
  2. console.info('Succeeded in listing inputMethod.');
  3. }).catch((err) => {
  4. console.error('Failed to listInputMethod: ' + JSON.stringify(err));
  5. })

displayOptionalInputMethod(deprecated)

displayOptionalInputMethod(callback: AsyncCallback<void>): void

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

说明

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

系统能力: SystemCapability.MiscServices.InputMethodFramework

参数:

参数名

类型

必填

说明

callback

AsyncCallback<void>

回调函数。当输入法选择对话框显示成功。err为undefined,否则为错误对象。

示例:

  1. inputMethodSetting.displayOptionalInputMethod((err) => {
  2. if (err !== undefined) {
  3. console.error('Failed to displayOptionalInputMethod: ' + JSON.stringify(err));
  4. return;
  5. }
  6. console.info('Succeeded in displaying optionalInputMethod.');
  7. });

displayOptionalInputMethod(deprecated)

displayOptionalInputMethod(): Promise<void>

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

说明

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

系统能力: SystemCapability.MiscServices.InputMethodFramework

返回值:

类型

说明

Promise<void>

无返回结果的Promise对象。

示例:

  1. inputMethodSetting.displayOptionalInputMethod().then(() => {
  2. console.info('Succeeded in displaying optionalInputMethod.');
  3. }).catch((err) => {
  4. console.error('Failed to displayOptionalInputMethod: ' + JSON.stringify(err));
  5. })
以上内容是否对您有帮助:
在线笔记
App下载
App下载

扫描二维码

下载编程狮App

公众号
微信公众号

编程狮公众号