HarmonyOS API：@ohos.inputMethodEngine (输入法服务)

版本：v3.1 Beta

@ohos.inputMethodEngine (输入法服务)

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

本模块的作用是拉通输入法应用和其他三方应用（联系人、微信等），功能包括：将三方应用与输入法应用的服务进行绑定、三方应用通过输入法应用进行文本输入、三方应用对输入法应用进行显示键盘请求和隐藏键盘请求、三方应用对输入法应用当前状态进行监听等。

说明

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

导入模块

import inputMethodEngine from '@ohos.inputMethodEngine';

常量

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

系统能力： SystemCapability.MiscServices.InputMethodFramework

inputMethodEngine.getInputMethodAbility⁹⁺

getInputMethodAbility(): InputMethodAbility

获取服务端实例。

系统能力： SystemCapability.MiscServices.InputMethodFramework

返回值：

示例：

let InputMethodAbility = inputMethodEngine.getInputMethodAbility();

inputMethodEngine.getKeyboardDelegate⁹⁺

getKeyboardDelegate(): KeyboardDelegate

获取客户端监听实例。

系统能力： SystemCapability.MiscServices.InputMethodFramework

返回值：

示例：

let KeyboardDelegate = inputMethodEngine.getKeyboardDelegate();

inputMethodEngine.getInputMethodEngine^(deprecated)

getInputMethodEngine(): InputMethodEngine

获取服务端实例。

说明

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

系统能力： SystemCapability.MiscServices.InputMethodFramework

返回值：

示例：

let InputMethodEngine = inputMethodEngine.getInputMethodEngine();

inputMethodEngine.createKeyboardDelegate^(deprecated)

createKeyboardDelegate(): KeyboardDelegate

获取客户端监听实例。

说明

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

系统能力： SystemCapability.MiscServices.InputMethodFramework

返回值：

示例：

let keyboardDelegate = inputMethodEngine.createKeyboardDelegate();

InputMethodEngine

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

on('inputStart')

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

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

系统能力： SystemCapability.MiscServices.InputMethodFramework

参数：

示例：

inputMethodEngine.getInputMethodEngine().on('inputStart', (kbController, textClient) => {
    let keyboardController = kbController;
    let textInputClient = textClient;
});

off('inputStart')

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

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

系统能力： SystemCapability.MiscServices.InputMethodFramework

参数：

示例：

inputMethodEngine.getInputMethodEngine().off('inputStart', (kbController, textInputClient) => {
    console.log('delete inputStart notification.');
});

on('keyboardShow'|'keyboardHide')

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

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

系统能力： SystemCapability.MiscServices.InputMethodFramework

参数：

示例：

inputMethodEngine.getInputMethodEngine().on('keyboardShow', () => {
    console.log('inputMethodEngine keyboardShow.');
});
inputMethodEngine.getInputMethodEngine().on('keyboardHide', () => {
    console.log('inputMethodEngine keyboardHide.');
});

off('keyboardShow'|'keyboardHide')

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

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

系统能力： SystemCapability.MiscServices.InputMethodFramework

参数：

示例：

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

InputMethodAbility

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

on('inputStart')⁹⁺

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

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

系统能力： SystemCapability.MiscServices.InputMethodFramework

参数：

示例：

inputMethodEngine.getInputMethodAbility().on('inputStart', (kbController, client) => {
    let keyboardController = kbController;
    let inputClient = client;
});

off('inputStart')⁹⁺

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

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

系统能力： SystemCapability.MiscServices.InputMethodFramework

参数：

示例：

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

on('inputStop')⁹⁺

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

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

系统能力： SystemCapability.MiscServices.InputMethodFramework

参数：

示例：

inputMethodEngine.getInputMethodAbility().on('inputStop', () => {
    console.log('inputMethodAbility inputStop');
});

off('inputStop')⁹⁺

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

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

系统能力： SystemCapability.MiscServices.InputMethodFramework

参数：

示例：

inputMethodEngine.getInputMethodAbility().off('inputStop', () => {
    console.log('inputMethodAbility delete inputStop notification.');
});

on('setCallingWindow')⁹⁺

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

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

系统能力： SystemCapability.MiscServices.InputMethodFramework

参数：

示例：

inputMethodEngine.getInputMethodAbility().on('setCallingWindow', (wid) => {
    console.log('inputMethodAbility setCallingWindow');
});

off('setCallingWindow')⁹⁺

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

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

系统能力： SystemCapability.MiscServices.InputMethodFramework

参数：

示例：

inputMethodEngine.getInputMethodAbility().off('setCallingWindow', () => {
    console.log('inputMethodAbility delete setCallingWindow notification.');
});

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

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

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

系统能力： SystemCapability.MiscServices.InputMethodFramework

参数：

示例：

inputMethodEngine.getInputMethodAbility().on('keyboardShow', () => {
    console.log('InputMethodAbility keyboardShow.');
});
inputMethodEngine.getInputMethodAbility().on('keyboardHide', () => {
    console.log('InputMethodAbility keyboardHide.');
});

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

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

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

系统能力： SystemCapability.MiscServices.InputMethodFramework

参数：

示例：

inputMethodEngine.getInputMethodAbility().off('keyboardShow', () => {
    console.log('InputMethodAbility delete keyboardShow notification.');
});
inputMethodEngine.getInputMethodAbility().off('keyboardHide', () => {
    console.log('InputMethodAbility delete keyboardHide notification.');
});

on('setSubtype')⁹⁺

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

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

系统能力： SystemCapability.MiscServices.InputMethodFramework

参数：

示例：

inputMethodEngine.getInputMethodAbility().on('setSubtype', (inputMethodSubtype) => {
    console.log('InputMethodAbility setSubtype.');
});

off('setSubtype')⁹⁺

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

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

系统能力： SystemCapability.MiscServices.InputMethodFramework

参数：

示例：

inputMethodEngine.getInputMethodAbility().off('setSubtype', () => {
    console.log('InputMethodAbility delete setSubtype notification.');
});

KeyboardDelegate

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

on('keyDown'|'keyUp')

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

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

系统能力： SystemCapability.MiscServices.InputMethodFramework

参数：

示例：

inputMethodEngine.getKeyboardDelegate().on('keyUp', (keyEvent) => {
    console.info('inputMethodEngine keyCode.(keyUp):' + JSON.stringify(keyEvent.keyCode));
    console.info('inputMethodEngine keyAction.(keyUp):' + JSON.stringify(keyEvent.keyAction));
    return true;
});
inputMethodEngine.getKeyboardDelegate().on('keyDown', (keyEvent) => {
    console.info('inputMethodEngine keyCode.(keyDown):' + JSON.stringify(keyEvent.keyCode));
    console.info('inputMethodEngine keyAction.(keyDown):' + JSON.stringify(keyEvent.keyAction));
    return true;
});

off('keyDown'|'keyUp')

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

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

系统能力： SystemCapability.MiscServices.InputMethodFramework

参数：

示例：

inputMethodEngine.getKeyboardDelegate().off('keyUp', (keyEvent) => {
    console.log('delete keyUp notification.');
    return true;
});
inputMethodEngine.getKeyboardDelegate().off('keyDown', (keyEvent) => {
    console.log('delete keyDown notification.');
    return true;
});

on('cursorContextChange')

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

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

系统能力： SystemCapability.MiscServices.InputMethodFramework

参数：

示例：

inputMethodEngine.getKeyboardDelegate().on('cursorContextChange', (x, y, height) => {
    console.log('inputMethodEngine cursorContextChange x:' + x);
    console.log('inputMethodEngine cursorContextChange y:' + y);
    console.log('inputMethodEngine cursorContextChange height:' + height);
});

off('cursorContextChange')

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

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

系统能力： SystemCapability.MiscServices.InputMethodFramework

参数：

示例：

inputMethodEngine.getKeyboardDelegate().off('cursorContextChange', (x, y, height) => {
    console.log('delete cursorContextChange notification.');
});

on('selectionChange')

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

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

系统能力： SystemCapability.MiscServices.InputMethodFramework

参数：

示例：

inputMethodEngine.getKeyboardDelegate().on('selectionChange', (oldBegin, oldEnd, newBegin, newEnd) => {
    console.log('inputMethodEngine beforeEach selectionChange oldBegin:' + oldBegin);
    console.log('inputMethodEngine beforeEach selectionChange oldEnd:' + oldEnd);
    console.log('inputMethodEngine beforeEach selectionChange newBegin:' + newBegin);
    console.log('inputMethodEngine beforeEach selectionChange newEnd:' + newEnd);
});

off('selectionChange')

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

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

系统能力： SystemCapability.MiscServices.InputMethodFramework

参数：

示例：

inputMethodEngine.getKeyboardDelegate().off('selectionChange', (oldBegin, oldEnd, newBegin, newEnd) => {
  console.log('delete selectionChange notification.');
});

on('textChange')

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

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

系统能力： SystemCapability.MiscServices.InputMethodFramework

参数：

示例：

inputMethodEngine.getKeyboardDelegate().on('textChange', (text) => {
    console.log('inputMethodEngine textChange. text:' + text);
});

off('textChange')

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

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

系统能力： SystemCapability.MiscServices.InputMethodFramework

参数：

示例：

inputMethodEngine.getKeyboardDelegate().off('textChange', (text) => {
    console.log('delete textChange notification. text:' + text);
});

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