HarmonyOS API：@ohos.inputMethod (输入法框架)

joytrian

发布于 2023-4-7 16:11

1.1w浏览

0收藏

版本：v3.1 Beta

@ohos.inputMethod (输入法框架)

更新时间: 2023-02-17 09:19

本模块提供对输入法框架的管理，包括隐藏输入法、查询已安装的输入法列表和显示输入法选择对话框。

说明

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

导入模块

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

常量⁸⁺

常量值。

系统能力： SystemCapability.MiscServices.InputMethodFramework

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

InputMethodProperty⁸⁺

输入法应用属性。

系统能力： SystemCapability.MiscServices.InputMethodFramework

名称	类型	可读	可写	说明
name⁹⁺	string	是	否	输入法内部名称。必填。
id⁹⁺	string	是	否	输入法唯一标识。必填。
label⁹⁺	string	是	否	输入法对外显示名称。非必填。
icon⁹⁺	string	是	否	输入法图标数据。非必填。
iconId⁹⁺	number	是	否	输入法图标资源号。非必填。
extra⁹⁺	object	是	是	输入法扩展信息。必填。
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();1.

inputMethod.getSetting⁹⁺

getSetting(): InputMethodSetting

获取客户端设置实例InputMethodSetting。

系统能力： SystemCapability.MiscServices.InputMethodFramework

返回值：

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

错误码：

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

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

示例：

let inputMethodSetting = inputMethod.getSetting();1.

inputMethod.getInputMethodController^(deprecated)

getInputMethodController(): InputMethodController

获取客户端实例InputMethodController。

说明

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

系统能力： SystemCapability.MiscServices.InputMethodFramework

返回值：

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

示例：

let inputMethodController = inputMethod.getInputMethodController();1.

inputMethod.getInputMethodSetting^(deprecated)

getInputMethodSetting(): InputMethodSetting

获取客户端设置实例InputMethodSetting。

说明

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

系统能力： SystemCapability.MiscServices.InputMethodFramework

返回值：

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

示例：

let inputMethodSetting = inputMethod.getInputMethodSetting();1.

InputMethodController

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

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

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

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

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) => {
    console.error('Failed to showSoftKeyboard: ' + JSON.stringify(err));
});1.
2.
3.
4.
5.

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

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) => {
    console.error('Failed to hideSoftKeyboard: ' + JSON.stringify(err));
});1.
2.
3.
4.
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；否则为错误对象。

示例：

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

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

InputMethodSetting⁸⁺

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

getInputMethods⁹⁺

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.

示例：

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

getInputMethods⁹⁺

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对象，返回已激活/未激活输入法列表。

示例：

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

showOptionalInputMethods⁹⁺

showOptionalInputMethods(callback: AsyncCallback<boolean>): void

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

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

系统能力： SystemCapability.MiscServices.InputMethodFramework

参数：

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

错误码：

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

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

示例：

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

showOptionalInputMethods⁹⁺

showOptionalInputMethods(): Promise<boolean>

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

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

系统能力： SystemCapability.MiscServices.InputMethodFramework

返回值：

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

错误码：

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

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

示例：

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

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

listInputMethod^(deprecated)

listInputMethod(): Promise<Array<InputMethodProperty>>

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

说明

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

系统能力： SystemCapability.MiscServices.InputMethodFramework

返回值：

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

示例：

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

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

displayOptionalInputMethod^(deprecated)

displayOptionalInputMethod(): Promise<void>

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

说明

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

系统能力： SystemCapability.MiscServices.InputMethodFramework

返回值：

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

示例：

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

文章转载自：https://developer.harmonyos.com/cn/docs/documentation/doc-references-V3/js-apis-inputmethod-0000001478061945-V3?catalogVersion=V3#ZH-CN_TOPIC_0000001478061945__导入模块

分类

卡片开发

三方库

标签

HarmonyOS API

已于2023-4-7 16:11:55修改

51CTO

51CTO博客

51CTO学堂

HarmonyOS API：@ohos.inputMethod (输入法框架)

@ohos.inputMethod (输入法框架)

导入模块

常量⁸⁺

InputMethodProperty⁸⁺

inputMethod.getController⁹⁺

inputMethod.getSetting⁹⁺

inputMethod.getInputMethodController^(deprecated)

inputMethod.getInputMethodSetting^(deprecated)

InputMethodController

stopInputSession⁹⁺

stopInputSession⁹⁺

showSoftKeyboard⁹⁺

showSoftKeyboard⁹⁺

hideSoftKeyboard⁹⁺

hideSoftKeyboard⁹⁺

stopInput^(deprecated)

stopInput^(deprecated)

InputMethodSetting⁸⁺

getInputMethods⁹⁺

getInputMethods⁹⁺

showOptionalInputMethods⁹⁺

showOptionalInputMethods⁹⁺

listInputMethod^(deprecated)

listInputMethod^(deprecated)

displayOptionalInputMethod^(deprecated)

displayOptionalInputMethod^(deprecated)

目录

订阅鸿蒙技术特刊，精选内容抢先看

51CTO

51CTO博客

51CTO学堂

HarmonyOS API：@ohos.inputMethod (输入法框架)

@ohos.inputMethod (输入法框架)

导入模块

常量8+

InputMethodProperty8+

inputMethod.getController9+

inputMethod.getSetting9+

inputMethod.getInputMethodController(deprecated)

inputMethod.getInputMethodSetting(deprecated)

InputMethodController

stopInputSession9+

stopInputSession9+

showSoftKeyboard9+

showSoftKeyboard9+

hideSoftKeyboard9+

hideSoftKeyboard9+

stopInput(deprecated)

stopInput(deprecated)

InputMethodSetting8+

getInputMethods9+

getInputMethods9+

showOptionalInputMethods9+

showOptionalInputMethods9+

listInputMethod(deprecated)

listInputMethod(deprecated)

displayOptionalInputMethod(deprecated)

displayOptionalInputMethod(deprecated)

目录

订阅鸿蒙技术特刊，精选内容抢先看

常量⁸⁺

InputMethodProperty⁸⁺

inputMethod.getController⁹⁺

inputMethod.getSetting⁹⁺

inputMethod.getInputMethodController^(deprecated)

inputMethod.getInputMethodSetting^(deprecated)

stopInputSession⁹⁺

stopInputSession⁹⁺

showSoftKeyboard⁹⁺

showSoftKeyboard⁹⁺

hideSoftKeyboard⁹⁺

hideSoftKeyboard⁹⁺

stopInput^(deprecated)

stopInput^(deprecated)

InputMethodSetting⁸⁺

getInputMethods⁹⁺

getInputMethods⁹⁺

showOptionalInputMethods⁹⁺

showOptionalInputMethods⁹⁺

listInputMethod^(deprecated)

listInputMethod^(deprecated)

displayOptionalInputMethod^(deprecated)

displayOptionalInputMethod^(deprecated)