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

版本：v3.1 Beta

@ohos.inputMethod (输入法框架)

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

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

说明

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

导入模块

import inputMethod from '@ohos.inputMethod';

常量⁸⁺

常量值。

系统能力： SystemCapability.MiscServices.InputMethodFramework

InputMethodProperty⁸⁺

输入法应用属性。

系统能力： SystemCapability.MiscServices.InputMethodFramework

inputMethod.getController⁹⁺

getController(): InputMethodController

获取客户端实例​​InputMethodController​​。

系统能力： SystemCapability.MiscServices.InputMethodFramework

返回值：

错误码：

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

示例：

let inputMethodController = inputMethod.getController();

inputMethod.getSetting⁹⁺

getSetting(): InputMethodSetting

获取客户端设置实例​​InputMethodSetting​​。

系统能力： SystemCapability.MiscServices.InputMethodFramework

返回值：

错误码：

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

示例：

let inputMethodSetting = inputMethod.getSetting();

inputMethod.getInputMethodController^(deprecated)

getInputMethodController(): InputMethodController

获取客户端实例​​InputMethodController​​。

说明

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

系统能力： SystemCapability.MiscServices.InputMethodFramework

返回值：

示例：

let inputMethodController = inputMethod.getInputMethodController();

inputMethod.getInputMethodSetting^(deprecated)

getInputMethodSetting(): InputMethodSetting

获取客户端设置实例​​InputMethodSetting​​。

说明

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

系统能力： SystemCapability.MiscServices.InputMethodFramework

返回值：

示例：

let inputMethodSetting = inputMethod.getInputMethodSetting();

InputMethodController

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

stopInputSession⁹⁺

stopInputSession(callback: AsyncCallback<boolean>): void

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

系统能力： SystemCapability.MiscServices.InputMethodFramework

参数：

错误码：

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

示例：

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

stopInputSession⁹⁺

stopInputSession(): Promise<boolean>

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

系统能力： SystemCapability.MiscServices.InputMethodFramework

返回值：

错误码：

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

示例：

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

showSoftKeyboard⁹⁺

showSoftKeyboard(callback: AsyncCallback<void>): void

显示软键盘。需要与输入框绑定使用。当点击输入框后，才可通过该接口的调用显示出当前输入法的软键盘。使用callback异步回调。

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

系统能力： SystemCapability.MiscServices.InputMethodFramework

参数：

错误码：

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

示例：

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

showSoftKeyboard⁹⁺

showSoftKeyboard(): Promise<void>

显示软键盘。需要与输入框绑定使用。当点击输入框后，才可通过该接口的调用显示出当前输入法的软键盘。使用Promise异步回调。

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

系统能力： SystemCapability.MiscServices.InputMethodFramework

返回值：

错误码：

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

示例：

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

hideSoftKeyboard⁹⁺

hideSoftKeyboard(callback: AsyncCallback<void>): void

隐藏软键盘。需要与输入框绑定使用。点击输入框后，才可以使用该接口的调用隐藏软键盘。使用callback异步回调。

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

系统能力： SystemCapability.MiscServices.InputMethodFramework

参数：

错误码：

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

示例：

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

hideSoftKeyboard⁹⁺

hideSoftKeyboard(): Promise<void>

隐藏软键盘。需要与输入框绑定使用。点击输入框后，才可以使用该接口的调用隐藏软键盘。使用Promise异步回调。

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

系统能力： SystemCapability.MiscServices.InputMethodFramework

返回值：

错误码：

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

示例：

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

stopInput^(deprecated)

stopInput(callback: AsyncCallback<boolean>): void

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

说明

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

系统能力： SystemCapability.MiscServices.InputMethodFramework

参数：

示例：

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.');
    }
});

stopInput^(deprecated)

stopInput(): Promise<boolean>

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

说明

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

系统能力： SystemCapability.MiscServices.InputMethodFramework

返回值：

示例：

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

InputMethodSetting⁸⁺

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

getInputMethods⁹⁺

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

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

系统能力： SystemCapability.MiscServices.InputMethodFramework

参数：

错误码：

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

示例：

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

getInputMethods⁹⁺

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

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

系统能力： SystemCapability.MiscServices.InputMethodFramework

参数：

错误码：

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

返回值：

示例：

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

showOptionalInputMethods⁹⁺

showOptionalInputMethods(callback: AsyncCallback<boolean>): void

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

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

系统能力： SystemCapability.MiscServices.InputMethodFramework

参数：

错误码：

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

示例：

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

showOptionalInputMethods⁹⁺

showOptionalInputMethods(): Promise<boolean>

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

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

系统能力： SystemCapability.MiscServices.InputMethodFramework

返回值：

错误码：

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

示例：

inputMethodSetting.showOptionalInputMethods().then((data) => {
    console.info('Succeeded in showing optionalInputMethods.');
}).catch((err) => {
    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

参数：

示例：

inputMethodSetting.listInputMethod((err,data) => {
    if (err !== undefined) {
        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

返回值：

示例：

inputMethodSetting.listInputMethod().then((data) => {
    console.info('Succeeded in listing inputMethod.');
}).catch((err) => {
    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

参数：

示例：

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

displayOptionalInputMethod^(deprecated)

displayOptionalInputMethod(): Promise<void>

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

说明

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

系统能力： SystemCapability.MiscServices.InputMethodFramework

返回值：

示例：

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

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