@ohos.inputMethodEngine (输入法服务)

本模块面向输入法应用（包括系统输入法应用、三方输入法应用），为输入法应用提供能力，包括：创建软键盘窗口、插入/删除字符、选中文本、监听物理键盘按键事件等。

说明：

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

导入模块

import inputMethodEngine from '@ohos.inputMethodEngine';

常量

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

系统能力： SystemCapability.MiscServices.InputMethodFramework

inputMethodEngine.getInputMethodAbility⁹⁺

getInputMethodAbility(): InputMethodAbility

获取输入法应用客户端实例InputMethodAbility，仅支持输入法应用调用。
输入法应用获取该实例后，可订阅软键盘显示/隐藏请求事件、创建/销毁输入法面板等。

系统能力： SystemCapability.MiscServices.InputMethodFramework

返回值：

示例：

let InputMethodAbility = inputMethodEngine.getInputMethodAbility();

inputMethodEngine.getKeyboardDelegate⁹⁺

getKeyboardDelegate(): KeyboardDelegate

获取客户端编辑事件监听代理实例KeyboardDelegate。
输入法应用获取该实例后，可订阅物理键盘按键事件、选中文本变化事件等。

系统能力： SystemCapability.MiscServices.InputMethodFramework

返回值：

示例：

let KeyboardDelegate = inputMethodEngine.getKeyboardDelegate();

inputMethodEngine.getInputMethodEngine^(deprecated)

getInputMethodEngine(): InputMethodEngine

获取输入法应用客户端实例InputMethodEngine。
输入法应用获取该实例后，可订阅软键盘显示/隐藏请求事件等。

说明：

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

系统能力： SystemCapability.MiscServices.InputMethodFramework

返回值：

示例：

let InputMethodEngine = inputMethodEngine.getInputMethodEngine();

inputMethodEngine.createKeyboardDelegate^(deprecated)

createKeyboardDelegate(): KeyboardDelegate

获取客户端编辑事件监听代理实例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

参数：

示例：

try {
  inputMethodEngine.getInputMethodEngine()
    .on('inputStart', (kbController: inputMethodEngine.KeyboardController, textClient: inputMethodEngine.TextInputClient) => {
      let keyboardController = kbController;
      let textInputClient = textClient;
  });
} catch(err) {
  console.error(`Failed to inputStart: ${JSON.stringify(err)}`);
}

off('inputStart')

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

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

系统能力： SystemCapability.MiscServices.InputMethodFramework

参数：

示例：

try {
  inputMethodEngine.getInputMethodEngine()
    .off('inputStart', (kbController: inputMethodEngine.KeyboardController, textClient: inputMethodEngine.TextInputClient) => {
      console.log('delete inputStart notification.');
  });
} catch(err) {
  console.error(`Failed to inputStart: ${JSON.stringify(err)}`);
}

on('keyboardShow'|'keyboardHide')

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

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

系统能力： SystemCapability.MiscServices.InputMethodFramework

参数：

示例：

try {
  inputMethodEngine.getInputMethodEngine().on('keyboardShow', () => {
    console.log('inputMethodEngine keyboardShow.');
  });
  inputMethodEngine.getInputMethodEngine().on('keyboardHide', () => {
    console.log('inputMethodEngine keyboardHide.');
});
} catch(err) {
  console.error(`Failed to InputMethodEngine: ${JSON.stringify(err)}`);
}

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

参数：

示例：

try {
  inputMethodEngine.getInputMethodAbility()
    .on('inputStart', (kbController: inputMethodEngine.KeyboardController, client: inputMethodEngine.InputClient) => {
      let keyboardController = kbController;
      let inputClient = client;
  });
} catch(err) {
    console.error(`Failed to InputMethodAbility: ${JSON.stringify(err)}`);
}

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

参数：

示例：

try {
  inputMethodEngine.getInputMethodAbility().on('inputStop', () => {
    console.log('inputMethodAbility inputStop');
  });
} catch(err) {
    console.error(`Failed to inputStop: ${JSON.stringify(err)}`);
}

off('inputStop')⁹⁺

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

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

系统能力： SystemCapability.MiscServices.InputMethodFramework

参数：

示例：

try {
  inputMethodEngine.getInputMethodAbility().off('inputStop', () => {
    console.log('inputMethodAbility delete inputStop notification.');
  });
} catch(err) {
    console.error(`Failed to inputStop: ${JSON.stringify(err)}`);
}

on('setCallingWindow')⁹⁺

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

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

系统能力： SystemCapability.MiscServices.InputMethodFramework

参数：

示例：

try {
  inputMethodEngine.getInputMethodAbility().on('setCallingWindow', (wid: number) => {
    console.log('inputMethodAbility setCallingWindow');
  });
} catch(err) {
    console.error(`Failed to setCallingWindow: ${JSON.stringify(err)}`);
}

off('setCallingWindow')⁹⁺

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

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

系统能力： SystemCapability.MiscServices.InputMethodFramework

参数：

示例：

try {
  inputMethodEngine.getInputMethodAbility().off('setCallingWindow', (wid: number) => {
    console.log('inputMethodAbility delete setCallingWindow notification.');
  });
} catch(err) {
    console.error(`Failed to setCallingWindow: ${JSON.stringify(err)}`);
}

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

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

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

系统能力： SystemCapability.MiscServices.InputMethodFramework

参数：

示例：

try {
  inputMethodEngine.getInputMethodAbility().on('keyboardShow', () => {
    console.log('InputMethodAbility keyboardShow.');
  });
  inputMethodEngine.getInputMethodAbility().on('keyboardHide', () => {
    console.log('InputMethodAbility keyboardHide.');
  });
} catch(err) {
    console.error(`Failed to keyboard: ${JSON.stringify(err)}`);
}

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

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

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

系统能力： SystemCapability.MiscServices.InputMethodFramework

参数：

示例：

try {
  inputMethodEngine.getInputMethodAbility().off('keyboardShow', () => {
    console.log('InputMethodAbility delete keyboardShow notification.');
  });
  inputMethodEngine.getInputMethodAbility().off('keyboardHide', () => {
    console.log('InputMethodAbility delete keyboardHide notification.');
  });
} catch(err) {
    console.error(`Failed to keyboard: ${JSON.stringify(err)}`);
}

on('setSubtype')⁹⁺

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

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

系统能力： SystemCapability.MiscServices.InputMethodFramework

参数：

示例：

try {
  inputMethodEngine.getInputMethodAbility().on('setSubtype', (inputMethodSubtype: InputMethodSubtype) => {
    console.log('InputMethodAbility setSubtype.');
  });
} catch(err) {
    console.error(`Failed to setSubtype: ${JSON.stringify(err)}`);
}

off('setSubtype')⁹⁺

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

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

系统能力： SystemCapability.MiscServices.InputMethodFramework

参数：

示例：

try {
  inputMethodEngine.getInputMethodAbility().off('setSubtype', () => {
    console.log('InputMethodAbility delete setSubtype notification.');
  });
} catch(err) {
    console.error(`Failed to setSubtype: ${JSON.stringify(err)}`);
}

createPanel¹⁰⁺

createPanel(ctx: BaseContext, info: PanelInfo, callback: AsyncCallback<Panel>): void

创建输入法面板，仅支持输入法应用调用。使用callback异步回调。
单个输入法应用仅允许创建一个软键盘类型和状态栏类型的面板。

系统能力： SystemCapability.MiscServices.InputMethodFramework

参数：

错误码：

示例：

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

let panelInfo: inputMethodEngine.PanelInfo = {
  type: inputMethodEngine.PanelType.SOFT_KEYBOARD,
  flag: inputMethodEngine.PanelFlag.FLG_FIXED
}
try {
  inputMethodEngine.getInputMethodAbility()
    .createPanel(this.context, panelInfo, (err: BusinessError, panel: inputMethodEngine.Panel) => {
      if (err) {
        console.error(`Failed to createPanel: ${JSON.stringify(err)}`);
        return;
      }
      console.log('Succeed in creating panel.');
    })
} catch (err) {
  console.error(`Failed to createPanel: ${JSON.stringify(err)}`);
}

createPanel¹⁰⁺

createPanel(ctx: BaseContext, info: PanelInfo): Promise<Panel>

创建输入法面板，仅支持输入法应用调用。使用promise异步回调。
单个输入法应用仅允许创建一个软键盘类型和状态栏类型的面板。

系统能力： SystemCapability.MiscServices.InputMethodFramework

参数：

返回值：

错误码：

示例：

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

let panelInfo: inputMethodEngine.PanelInfo = {
  type: inputMethodEngine.PanelType.SOFT_KEYBOARD,
  flag: inputMethodEngine.PanelFlag.FLG_FIXED
}
inputMethodEngine.getInputMethodAbility().createPanel(this.context, panelInfo)
  .then((panel: inputMethodEngine.Panel) => {
    console.log('Succeed in creating panel.');
  }).catch((err: BusinessError) => {
    console.error(`Failed to create panel: ${JSON.stringify(err)}`);
  })

destroyPanel¹⁰⁺

destroyPanel(panel: Panel, callback: AsyncCallback<void>): void

销毁输入法面板。使用callback异步回调。

系统能力： SystemCapability.MiscServices.InputMethodFramework

参数：

示例：

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

let panelInfo: inputMethodEngine.PanelInfo = {
  type: inputMethodEngine.PanelType.SOFT_KEYBOARD,
  flag: inputMethodEngine.PanelFlag.FLG_FIXED
}
let inputPanel: inputMethodEngine.Panel | undefined = undefined;
try {
  inputMethodEngine.getInputMethodAbility()
    .createPanel(this.context, panelInfo, (err: BusinessError, panel: inputMethodEngine.Panel) => {
      if (err) {
        console.error(`Failed to create panel: ${JSON.stringify(err)}`);
        return;
      }
      inputPanel = panel;
      console.log('Succeed in creating panel.');
    })
} catch (err) {
  console.error(`Failed to create panel: ${JSON.stringify(err)}`);
}
try {
  if (inputPanel) {
    inputMethodEngine.getInputMethodAbility().destroyPanel(inputPanel, (err: BusinessError) => {
      if (err !== undefined) {
        console.error(`Failed to destroy panel: ${JSON.stringify(err)}`);
        return;
      }
      console.log('Succeed in destroying panel.');
    })
  }
} catch (err) {
  console.error(`Failed to destroy panel: ${JSON.stringify(err)}`);
}

destroyPanel¹⁰⁺

destroyPanel(panel: Panel): Promise<void>

销毁输入法面板。使用promise异步回调。

系统能力： SystemCapability.MiscServices.InputMethodFramework

参数：

返回值：

示例：

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

let panelInfo: inputMethodEngine.PanelInfo = {
  type: inputMethodEngine.PanelType.SOFT_KEYBOARD,
  flag: inputMethodEngine.PanelFlag.FLG_FIXED
}
let inputPanel: inputMethodEngine.Panel | undefined = undefined;
try {
  inputMethodEngine.getInputMethodAbility()
    .createPanel(this.context, panelInfo, (err: BusinessError, panel: inputMethodEngine.Panel) => {
      if (err) {
        console.error(`Failed to create panel: ${JSON.stringify(err)}`);
        return;
      }
      inputPanel = panel;
      console.log('Succeed in creating panel.');
    })
} catch (err) {
  console.error(`Failed to create panel: ${JSON.stringify(err)}`);
}

try {
  if (inputPanel) {
    inputMethodEngine.getInputMethodAbility().destroyPanel(inputPanel).then(() => {
      console.log('Succeed in destroying panel.');
    }).catch((err: BusinessError) => {
      console.error(`Failed to destroy panel: ${JSON.stringify(err)}`);
    });
  }
} catch (err) {
  console.error(`Failed to destroy panel: ${JSON.stringify(err)}`);
}

KeyboardDelegate

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

on('keyDown'|'keyUp')

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

订阅硬键盘（即物理键盘）上物理按键的按下或抬起事件。使用callback异步回调。

系统能力： SystemCapability.MiscServices.InputMethodFramework

参数：

示例：

try {
  inputMethodEngine.getKeyboardDelegate().on('keyUp', (keyEvent: inputMethodEngine.KeyEvent) => {
    console.log('inputMethodEngine keyCode.(keyUp):' + JSON.stringify(keyEvent.keyCode));
    console.log('inputMethodEngine keyAction.(keyUp):' + JSON.stringify(keyEvent.keyAction));
    return true;
  });
  inputMethodEngine.getKeyboardDelegate().on('keyDown', (keyEvent: inputMethodEngine.KeyEvent) => {
    console.log('inputMethodEngine keyCode.(keyDown):' + JSON.stringify(keyEvent.keyCode));
    console.log('inputMethodEngine keyAction.(keyDown):' + JSON.stringify(keyEvent.keyAction));
    return true;
  });
} catch(err) {
    console.error(`Failed to KeyboardDelegate: ${JSON.stringify(err)}`);
}

off('keyDown'|'keyUp')

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

取消订阅硬键盘（即物理键盘）上物理按键的按下或抬起事件。使用callback异步回调。

系统能力： SystemCapability.MiscServices.InputMethodFramework

参数：

示例：

try {
  inputMethodEngine.getKeyboardDelegate().off('keyUp', (keyEvent: inputMethodEngine.KeyEvent) => {
    console.log('delete keyUp notification.');
    return true;
  });
  inputMethodEngine.getKeyboardDelegate().off('keyDown', (keyEvent: inputMethodEngine.KeyEvent) => {
    console.log('delete keyDown notification.');
    return true;
  });
} catch(err) {
    console.error(`Failed to keyevent: ${JSON.stringify(err)}`);
}

on('keyEvent')¹⁰⁺

on(type: 'keyEvent', callback: (event: InputKeyEvent) => boolean): void

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

系统能力： SystemCapability.MiscServices.InputMethodFramework

参数：

示例：

import type { KeyEvent } from '@ohos.multimodalInput.keyEvent';

try {
  inputMethodEngine.getKeyboardDelegate().on('keyEvent', (keyEvent: KeyEvent) => {
    console.log('inputMethodEngine keyEvent.action:' + JSON.stringify(keyEvent.action));
    console.log('inputMethodEngine keyEvent.key.code:' + JSON.stringify(keyEvent.key.code));
    console.log('inputMethodEngine keyEvent.ctrlKey:' + JSON.stringify(keyEvent.ctrlKey));
    return true;
  });
} catch(err) {
    console.error(`Failed to inputMethodEngine: ${JSON.stringify(err)}`);
}

off('keyEvent')¹⁰⁺

off(type: 'keyEvent', callback?: (event: InputKeyEvent) => boolean): void

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

系统能力： SystemCapability.MiscServices.InputMethodFramework

参数：

示例：

import type { KeyEvent } from '@ohos.multimodalInput.keyEvent';

try {
  inputMethodEngine.getKeyboardDelegate().off('keyEvent', (keyEvent: KeyEvent) => {
    console.log('This is a callback function which will be deregistered.');
    return true;
  });
  inputMethodEngine.getKeyboardDelegate().off('keyEvent');
} catch(err) {
    console.error(`Failed to keyEvent: ${JSON.stringify(err)}`);
}

on('cursorContextChange')

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

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

系统能力： SystemCapability.MiscServices.InputMethodFramework

参数：

示例：

try {
  inputMethodEngine.getKeyboardDelegate().on('cursorContextChange', (x: number, y: number, height: number) => {
    console.log('inputMethodEngine cursorContextChange x:' + x);
    console.log('inputMethodEngine cursorContextChange y:' + y);
    console.log('inputMethodEngine cursorContextChange height:' + height);
  });
} catch(err) {
    console.error(`Failed to cursorContextChange: ${JSON.stringify(err)}`);
}

off('cursorContextChange')

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

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

系统能力： SystemCapability.MiscServices.InputMethodFramework

参数：

示例：

try {
  inputMethodEngine.getKeyboardDelegate().off('cursorContextChange', (x: number, y: number, height: number) => {
    console.log('delete cursorContextChange notification.');
  });
} catch(err) {
    console.error(`Failed to cursorContextChange: ${JSON.stringify(err)}`);
}

on('selectionChange')

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

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

系统能力： SystemCapability.MiscServices.InputMethodFramework

参数：

示例：

try {
  inputMethodEngine.getKeyboardDelegate()
    .on('selectionChange', (oldBegin: number, oldEnd: number, newBegin: number, newEnd: number) => {
      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);
    });
} catch(err) {
    console.error(`Failed to selectionChange: ${JSON.stringify(err)}`);
}

off('selectionChange')

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

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

系统能力： SystemCapability.MiscServices.InputMethodFramework

参数：

示例：

try {
  inputMethodEngine.getKeyboardDelegate()
    .off('selectionChange', (oldBegin: number, oldEnd: number, newBegin: number, newEnd: number)  => {
      console.log('delete selectionChange notification.');
    });
} catch(err) {
    console.error(`Failed to selectionChange: ${JSON.stringify(err)}`);
}

on('textChange')

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

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

系统能力： SystemCapability.MiscServices.InputMethodFramework

参数：

示例：

try {
  inputMethodEngine.getKeyboardDelegate().on('textChange', (text: string) => {
    console.log('inputMethodEngine textChange. text:' + text);
  });
} catch(err) {
    console.error(`Failed to textChange: ${JSON.stringify(err)}`);
}

off('textChange')

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

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

系统能力： SystemCapability.MiscServices.InputMethodFramework

参数：

示例：

try {
  inputMethodEngine.getKeyboardDelegate().off('textChange', (text: string) => {
    console.log('delete textChange notification. text:' + text);
  });
} catch(err) {
    console.error(`Failed to textChange: ${JSON.stringify(err)}`);
}

on('editorAttributeChanged')¹⁰⁺

on(type: 'editorAttributeChanged', callback: (attr: EditorAttribute) => void): void

订阅编辑框属性变化事件。使用callback异步回调。

系统能力： SystemCapability.MiscServices.InputMethodFramework

参数：

示例：

try {
  inputMethodEngine.getKeyboardDelegate().on('editorAttributeChanged', (attr: inputMethodEngine.EditorAttribute) => {
    console.log(`Succeeded in receiving attribute of editor, inputPattern = ${attr.inputPattern}, enterKeyType = ${attr.enterKeyType}`);
  });
} catch(err) {
    console.error(`Failed to textChange: ${JSON.stringify(err)}`);
}

off('editorAttributeChanged')¹⁰⁺

off(type: 'editorAttributeChanged', callback?: (attr: EditorAttribute) => void): void

取消订阅编辑框属性变化事件。使用callback异步回调。

系统能力： SystemCapability.MiscServices.InputMethodFramework

参数：

示例：

inputMethodEngine.getKeyboardDelegate().off('editorAttributeChanged');

Panel¹⁰⁺

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

setUiContent¹⁰⁺

setUiContent(path: string, callback: AsyncCallback<void>): void

为当前的输入法面板加载具体页面内容，使用callback异步回调。

系统能力： SystemCapability.MiscServices.InputMethodFramework

参数：

示例：

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

try {
  panel.setUiContent('pages/page2/page2', (err: BusinessError) => {
    if (err) {
      console.error(`Failed to setUiContent: ${JSON.stringify(err)}`);
      return;
    }
    console.log('Succeeded in setting the content.');
  });
} catch (err) {
  console.error(`Failed to setUiContent: ${JSON.stringify(err)}`);
}

setUiContent¹⁰⁺

setUiContent(path: string): Promise<void>

为当前的输入法面板加载具体页面内容，使用Promise异步回调。

系统能力： SystemCapability.MiscServices.InputMethodFramework

参数：

返回值：

示例：

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

try {
  panel.setUiContent('pages/page2/page2').then(() => {
    console.log('Succeeded in setting the content.');
  }).catch((err: BusinessError) => {
    console.error(`Failed to setUiContent: ${JSON.stringify(err)}`);
  });
} catch (err) {
  console.error(`Failed to setUiContent: ${JSON.stringify(err)}`);
}

setUiContent¹⁰⁺

setUiContent(path: string, storage: LocalStorage, callback: AsyncCallback<void>): void

为当前的输入法面板加载与LocalStorage相关联的具体页面内容，使用callback异步回调。

系统能力： SystemCapability.MiscServices.InputMethodFramework

参数：

示例：

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

let storage = new LocalStorage();
storage.setOrCreate('storageSimpleProp',121);
try {
  panel.setUiContent('pages/page2/page2', storage, (err: BusinessError) => {
    if (err) {
      console.error(`Failed to setUiContent: ${JSON.stringify(err)}`);
      return;
    }
    console.log('Succeeded in setting the content.');
  });
} catch (err) {
  console.error(`Failed to setUiContent: ${JSON.stringify(err)}`);
}

setUiContent¹⁰⁺

setUiContent(path: string, storage: LocalStorage): Promise<void>

为当前面板加载与LocalStorage相关联的具体页面内容，使用Promise异步回调。

系统能力： SystemCapability.MiscServices.InputMethodFramework

参数：

返回值：

示例：

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

let storage = new LocalStorage();
storage.setOrCreate('storageSimpleProp',121);
try {
  panel.setUiContent('pages/page2/page2')then(() => {
    console.log('Succeeded in setting the content.');
  }).catch((err: BusinessError) => {
    console.error(`Failed to setUiContent: ${JSON.stringify(err)}`);
  });
} catch (err) {
  console.error(`Failed to setUiContent: ${JSON.stringify(err)}`);
}

resize¹⁰⁺

resize(width: number, height: number, callback: AsyncCallback<void>): void

改变当前输入法面板的大小，使用callback异步回调。

说明

面板宽度不超出屏幕宽度，面板高度不高于屏幕高度的0.6倍。

系统能力： SystemCapability.MiscServices.InputMethodFramework

参数：

示例：

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

try {
  panel.resize(500, 1000, (err: BusinessError) => {
    if (err) {
      console.error(`Failed to resize panel: ${JSON.stringify(err)}`);
      return;
    }
    console.log('Succeeded in changing the panel size.');
  });
} catch (err) {
  console.error(`Failed to resize panel: ${JSON.stringify(err)}`);
}

resize¹⁰⁺

resize(width: number, height: number): Promise<void>

改变当前输入法面板的大小，使用Promise异步回调。

说明

面板宽度不超出屏幕宽度，面板高度不高于屏幕高度的0.6倍。

系统能力： SystemCapability.MiscServices.InputMethodFramework

参数：

返回值：

示例：

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

try {
  panel.resize(500, 1000).then(() => {
    console.log('Succeeded in changing the panel size.');
  }).catch((err: BusinessError) => {
    console.error(`Failed to resize panel: ${JSON.stringify(err)}`);
  });
} catch (err) {
  console.error(`Failed to resize panel: ${JSON.stringify(err)}`);
}

moveTo¹⁰⁺

moveTo(x: number, y: number, callback: AsyncCallback<void>): void

移动面板位置，使用callback异步回调。面板状态为固定态时，不产生实际移动效果。

系统能力： SystemCapability.MiscServices.InputMethodFramework

参数：

示例：

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

try {
  panel.moveTo(300, 300, (err: BusinessError) =>{
    if (err) {
      console.error(`Failed to move panel: ${JSON.stringify(err)}`);
      return;
    }
    console.log('Succeeded in moving the panel.');
  });
} catch (err) {
    console.error(`Failed to move panel: ${JSON.stringify(err)}`);
}

moveTo¹⁰⁺

moveTo(x: number, y: number): Promise<void>

移动面板位置，使用promise异步回调。面板状态为固定态时，不产生实际移动效果。

系统能力： SystemCapability.MiscServices.InputMethodFramework

参数：

返回值：

示例：

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

try {
  panel.moveTo(300, 300).then(() => {
    console.log('Succeeded in moving the panel.');
  }).catch((err: BusinessError) => {
    console.error(`Failed to move panel: ${JSON.stringify(err)}`);
  });
} catch (err) {
  console.error(`Failed to move panel: ${JSON.stringify(err)}`);
}

show¹⁰⁺

show(callback: AsyncCallback<void>): void

显示当前输入法面板，使用callback异步回调。输入法应用与编辑框绑定成功后可正常调用。

系统能力： SystemCapability.MiscServices.InputMethodFramework

参数：

示例：

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

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

show¹⁰⁺

show(): Promise<void>

显示当前输入法面板，使用promise异步回调。输入法应用与编辑框绑定成功后可正常调用。

系统能力： SystemCapability.MiscServices.InputMethodFramework

返回值：

示例：

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

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

hide¹⁰⁺

hide(callback: AsyncCallback<void>): void

隐藏当前输入法面板，使用callback异步回调。

系统能力： SystemCapability.MiscServices.InputMethodFramework

参数：

示例：

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

panel.hide((err: BusinessError) => {
  if (err) {
    console.error(`Failed to hide panel: ${JSON.stringify(err)}`);
    return;
  }
  console.log('Succeeded in hiding the panel.');
});

hide¹⁰⁺

hide(): Promise<void>

隐藏当前输入法面板，使用promise异步回调。

系统能力： SystemCapability.MiscServices.InputMethodFramework

返回值：

示例：

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

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

on('show')¹⁰⁺

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

监听当前面板显示状态，使用callback异步回调。

系统能力： SystemCapability.MiscServices.InputMethodFramework

参数：

示例：

try {
  panel.on('show', () => {
    console.log('Panel is showing.');
  });
} catch(err) {
    console.error(`Failed to show: ${JSON.stringify(err)}`);
}

on('hide')¹⁰⁺

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

监听当前面板隐藏状态，使用callback异步回调。

系统能力： SystemCapability.MiscServices.InputMethodFramework

参数：

示例：

try {
  panel.on('hide', () => {
    console.log('Panel is hiding.');
  });
} catch(err) {
    console.error(`Failed to hide: ${JSON.stringify(err)}`);
}

off('show')¹⁰⁺

off(type: 'show', callback?: () => void): void

取消监听当前输入法面板的隐藏状态，使用callback异步回调。

系统能力： SystemCapability.MiscServices.InputMethodFramework

参数：

示例：

try {
  panel.off('show');
} catch(err) {
    console.error(`Failed to show: ${JSON.stringify(err)}`);
}

off('hide')¹⁰⁺

off(type: 'hide', callback?: () => void): void

取消监听当前面板隐藏状态，使用callback异步回调。

系统能力： SystemCapability.MiscServices.InputMethodFramework

参数：

示例：

try {
  panel.off('hide');
} catch(err) {
    console.error(`Failed to hide: ${JSON.stringify(err)}`);
}

changeFlag¹⁰⁺

changeFlag(flag: PanelFlag): void

将输入法应用的面板状态改变为固定态或者悬浮态，仅对SOFT_KEYBOARD生效。

系统能力： SystemCapability.MiscServices.InputMethodFramework

参数：

示例：

try {
  let panelFlag = inputMethodEngine.PanelFlag.FLG_FIXED;
  panel.changeFlag(panelFlag);
} catch(err) {
    console.error(`Failed to panelFlag: ${JSON.stringify(err)}`);
}

KeyboardController

下列API均需使用on('inputStart')获取到KeyboardController实例后，通过实例调用。

hide⁹⁺

hide(callback: AsyncCallback<void>): void

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

系统能力： SystemCapability.MiscServices.InputMethodFramework

参数：

错误码：

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

示例：

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

keyboardController.hide((err: BusinessError) => {
  if (err) {
    console.error(`Failed to hide: ${JSON.stringify(err)}`);
    return;
  }
  console.log('Succeeded in hiding keyboard.');
});

hide⁹⁺

hide(): Promise<void>

隐藏输入法。使用promise异步回调。

系统能力： SystemCapability.MiscServices.InputMethodFramework

返回值：

错误码：

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

示例：

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

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

hideKeyboard^(deprecated)

hideKeyboard(callback: AsyncCallback<void>): void

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

说明：

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

系统能力： SystemCapability.MiscServices.InputMethodFramework

参数：

示例：

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

keyboardController.hideKeyboard((err: BusinessError) => {
  if (err) {
    console.error(`Failed to hideKeyboard: ${JSON.stringify(err)}`);
    return;
  }
  console.log('Succeeded in hiding keyboard.');
});

hideKeyboard^(deprecated)

hideKeyboard(): Promise<void>

隐藏输入法。使用promise异步回调。

说明：

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

系统能力： SystemCapability.MiscServices.InputMethodFramework

返回值：

示例：

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

keyboardController.hideKeyboard().then(() => {
  console.log('Succeeded in hiding keyboard.');
}).catch((err: BusinessError) => {
  console.log(`Failed to hideKeyboard: ${JSON.stringify(err)}`);
});

ExtendAction¹⁰⁺

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

系统能力: SystemCapability.MiscServices.InputMethodFramework

Direction¹⁰⁺

光标的移动方向。

系统能力: SystemCapability.MiscServices.InputMethodFramework

Range¹⁰⁺

选中的文本范围。

系统能力： SystemCapability.MiscServices.InputMethodFramework

Movement¹⁰⁺

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

系统能力： SystemCapability.MiscServices.InputMethodFramework

InputClient⁹⁺

下列API均需使用on('inputStart')获取到InputClient实例后，通过实例调用。

sendKeyFunction⁹⁺

sendKeyFunction(action:number, callback: AsyncCallback<boolean>): void

发送功能键。使用callback异步回调。

系统能力： SystemCapability.MiscServices.InputMethodFramework

参数：

错误码：

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

示例：

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

let action = 1;
try {
  inputClient.sendKeyFunction(action, (err: BusinessError, result: boolean) => {
    if (err) {
      console.error(`Failed to sendKeyFunction: ${JSON.stringify(err)}`);
      return;
    }
    if (result) {
      console.log('Succeeded in sending key function.');
    } else {
      console.error('Failed to sendKeyFunction.');
    }
  });
} catch (err) {
  console.error(`Failed to sendKeyFunction: ${JSON.stringify(err)}`);
}

sendKeyFunction⁹⁺

sendKeyFunction(action: number): Promise<boolean>

发送功能键。使用promise异步回调。

系统能力： SystemCapability.MiscServices.InputMethodFramework

参数：

返回值：

错误码：

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

示例：

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

let action = 1;
try {
  inputClient.sendKeyFunction(action).then((result: boolean) => {
    if (result) {
      console.log('Succeeded in sending key function.');
    } else {
      console.error('Failed to sendKeyFunction.');
    }
  }).catch((err: BusinessError) => {
    console.error(`Failed to sendKeyFunction: ${JSON.stringify(err)}`);
  });
} catch (err) {
  console.error(`Failed to sendKeyFunction: ${JSON.stringify(err)}`);
}

getForward⁹⁺

getForward(length:number, callback: AsyncCallback<string>): void

获取光标前固定长度的文本。使用callback异步回调。

系统能力： SystemCapability.MiscServices.InputMethodFramework

参数：

错误码：

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

示例：

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

let length = 1;
try {
  inputClient.getForward(length, (err: BusinessError, text: string) => {
    if (err) {
      console.error(`Failed to getForward: ${JSON.stringify(err)}`);
      return;
    }
    console.log('Succeeded in getting forward, text: ' + text);
  });
} catch (err) {
  console.error(`Failed to getForward: ${JSON.stringify(err)}`);
}

getForward⁹⁺

getForward(length:number): Promise<string>

获取光标前固定长度的文本。使用promise异步回调。

系统能力： SystemCapability.MiscServices.InputMethodFramework

参数：

返回值：

错误码：

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

示例：

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

let length = 1;
try {
  inputClient.getForward(length).then((text: string) => {
    console.log('Succeeded in getting forward, text: ' + text);
  }).catch((err: BusinessError) => {
    console.error(`Failed to getForward: ${JSON.stringify(err)}`);
  });
} catch (err) {
  console.error(`Failed to getForward: ${JSON.stringify(err)}`);
}

getForwardSync¹⁰⁺

getForwardSync(length:number): string

获取光标前固定长度的文本。

系统能力： SystemCapability.MiscServices.InputMethodFramework

参数：

返回值：

错误码：

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

示例：

let length = 1;
try {
  let text: string = inputClient.getForwardSync(length);
  console.log(`Succeeded in getting forward, text: ${text}`);
} catch (err) {
  console.error(`Failed to getForwardSync: ${JSON.stringify(err)}`);
}

getBackward⁹⁺

getBackward(length:number, callback: AsyncCallback<string>): void

获取光标后固定长度的文本。使用callback异步回调。

系统能力： SystemCapability.MiscServices.InputMethodFramework

参数：

错误码：

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

示例：

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

let length = 1;
try {
  inputClient.getBackward(length, (err: BusinessError, text: string) => {
    if (err) {
      console.error(`Failed to getBackward: ${JSON.stringify(err)}`);
      return;
    }
    console.log('Succeeded in getting backward, text: ' + text);
  });
} catch (err) {
  console.error(`Failed to getBackward: ${JSON.stringify(err)}`);
}

getBackward⁹⁺

getBackward(length:number): Promise<string>

获取光标后固定长度的文本。使用promise异步回调。

系统能力： SystemCapability.MiscServices.InputMethodFramework

参数：

返回值：

错误码：

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

示例：

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

let length = 1;
try {
  inputClient.getBackward(length).then((text: string) => {
    console.log('Succeeded in getting backward, text: ' + text);
  }).catch((err: BusinessError) => {
    console.error(`Failed to getBackward: ${JSON.stringify(err)}`);
  });
} catch (err) {
  console.error(`Failed to getBackward: ${JSON.stringify(err)}`);
}

getBackwardSync¹⁰⁺

getBackwardSync(length:number): string

获取光标后固定长度的文本。

系统能力： SystemCapability.MiscServices.InputMethodFramework

参数：

返回值：

错误码：

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

示例：

let length = 1;
try {
  let text: string = inputClient.getBackwardSync(length);
  console.log(`Succeeded in getting backward, text: ${text}`);
} catch (err) {
  console.error(`Failed to getBackwardSync: ${JSON.stringify(err)}`);
}

deleteForward⁹⁺

deleteForward(length:number, callback: AsyncCallback<boolean>): void

删除光标前固定长度的文本。使用callback异步回调。

系统能力： SystemCapability.MiscServices.InputMethodFramework

参数：

错误码：

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

示例：

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

let length = 1;
try {
  inputClient.deleteForward(length, (err: BusinessError, result: boolean) => {
    if (err) {
      console.error(`Failed to deleteForward: ${JSON.stringify(err)}`);
      return;
    }
    if (result) {
      console.log('Succeeded in deleting forward.');
    } else {
      console.error(`Failed to deleteForward.`);
    }
  });
} catch (err) {
  console.error(`Failed to deleteForward: ${JSON.stringify(err)}`);
}

deleteForward⁹⁺

deleteForward(length:number): Promise<boolean>

删除光标前固定长度的文本。使用promise异步回调。

系统能力： SystemCapability.MiscServices.InputMethodFramework

参数：

返回值：

错误码：

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

示例：

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

let length = 1;
try {
  inputClient.deleteForward(length).then((result: boolean) => {
    if (result) {
      console.log('Succeeded in deleting forward.');
    } else {
      console.error('Failed to delete Forward.');
    }
  }).catch((err: BusinessError) => {
    console.error(`Failed to deleteForward: ${JSON.stringify(err)}`);
  });
} catch (err) {
  console.error(`Failed to deleteForward: ${JSON.stringify(err)}`);
}

deleteForwardSync¹⁰⁺

deleteForwardSync(length:number): void

删除光标前固定长度的文本。

系统能力： SystemCapability.MiscServices.InputMethodFramework

参数：

错误码：

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

示例：

let length = 1;
try {
  inputClient.deleteForwardSync(length);
  console.log('Succeeded in deleting forward.');
} catch (err) {
  console.error('deleteForwardSync err: ' + JSON.stringify(err));
}

deleteBackward⁹⁺

deleteBackward(length:number, callback: AsyncCallback<boolean>): void

删除光标后固定长度的文本。使用callback异步回调。

系统能力： SystemCapability.MiscServices.InputMethodFramework

参数：

错误码：

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

示例：

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

let length = 1;
try {
  inputClient.deleteBackward(length, (err: BusinessError, result: boolean) => {
    if (err) {
      console.error(`Failed to deleteBackward: ${JSON.stringify(err)}`);
      return;
    }
    if (result) {
      console.log('Succeeded in deleting backward.');
    } else {
      console.error(`Failed to deleteBackward.`);
    }
  });
} catch (err) {
  console.error('deleteBackward err: ' + JSON.stringify(err));
}

deleteBackward⁹⁺

deleteBackward(length:number): Promise<boolean>

删除光标后固定长度的文本。使用promise异步回调。

系统能力： SystemCapability.MiscServices.InputMethodFramework

参数：

返回值：

错误码：

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

示例：

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

let length = 1;
inputClient.deleteBackward(length).then((result: boolean) => {
  if (result) {
    console.log('Succeeded in deleting backward.');
  } else {
    console.error('Failed to deleteBackward.');
  }
}).catch((err: BusinessError) => {
  console.error(`Failed to deleteBackward: ${JSON.stringify(err)}`);
});

deleteBackwardSync¹⁰⁺

deleteBackwardSync(length:number): void

删除光标后固定长度的文本。

系统能力： SystemCapability.MiscServices.InputMethodFramework

参数：

错误码：

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

示例：

let length = 1;
try {
  inputClient.deleteBackwardSync(length);
  console.log('Succeeded in deleting backward.');
} catch (err) {
  console.error('deleteBackwardSync err: ' + JSON.stringify(err));
}

insertText⁹⁺

insertText(text:string, callback: AsyncCallback<boolean>): void

插入文本。使用callback异步回调。

系统能力： SystemCapability.MiscServices.InputMethodFramework

参数：

错误码：

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

示例：

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

inputClient.insertText('test', (err: BusinessError, result: boolean) => {
  if (err) {
    console.error(`Failed to insertText: ${JSON.stringify(err)}`);
    return;
  }
  if (result) {
    console.log('Succeeded in inserting text.');
  } else {
    console.error('Failed to insertText.');
  }
});

insertText⁹⁺

insertText(text:string): Promise<boolean>

插入文本。使用promise异步回调。

系统能力： SystemCapability.MiscServices.InputMethodFramework

参数：

返回值：

错误码：

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

示例：

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

try {
  inputClient.insertText('test').then((result: boolean) => {
    if (result) {
      console.log('Succeeded in inserting text.');
    } else {
      console.error('Failed to insertText.');
    }
  }).catch((err: BusinessError) => {
    console.error(`Failed to insertText: ${JSON.stringify(err)}`);
  });
} catch (err) {
  console.error(`Failed to insertText: ${JSON.stringify(err)}`);
}

insertTextSync¹⁰⁺

insertTextSync(text: string): void

插入文本。

系统能力： SystemCapability.MiscServices.InputMethodFramework

参数：

错误码：

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

示例：

try {
  inputClient.insertTextSync('test');
  console.log('Succeeded in inserting text.');
} catch (err) {
  console.error(`Failed to insertTextSync: ${JSON.stringify(err)}`);
}

getEditorAttribute⁹⁺

getEditorAttribute(callback: AsyncCallback<EditorAttribute>): void

获取编辑框属性值。使用callback异步回调。

系统能力： SystemCapability.MiscServices.InputMethodFramework

参数：

错误码：

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

示例：

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

inputClient.getEditorAttribute((err: BusinessError, editorAttribute: inputMethodEngine.EditorAttribute) => {
  if (err) {
    console.error(`Failed to getEditorAttribute: ${JSON.stringify(err)}`);
    return;
  }
  console.log('editorAttribute.inputPattern: ' + JSON.stringify(editorAttribute.inputPattern));
  console.log('editorAttribute.enterKeyType: ' + JSON.stringify(editorAttribute.enterKeyType));
});

getEditorAttribute⁹⁺

getEditorAttribute(): Promise<EditorAttribute>

获取编辑框属性值。使用promise异步回调。

系统能力： SystemCapability.MiscServices.InputMethodFramework

返回值：

错误码：

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

示例：

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

try {
  inputClient.getEditorAttribute().then((editorAttribute: inputMethodEngine.EditorAttribute) => {
    console.log('editorAttribute.inputPattern: ' + JSON.stringify(editorAttribute.inputPattern));
    console.log('editorAttribute.enterKeyType: ' + JSON.stringify(editorAttribute.enterKeyType));
  }).catch((err: BusinessError) => {
    console.error(`Failed to getEditorAttribute: ${JSON.stringify(err)}`);
  });
} catch(err) {
    console.error(`Failed to getEditorAttribute: ${JSON.stringify(err)}`);
}

getEditorAttributeSync¹⁰⁺

getEditorAttributeSync(): EditorAttribute

获取编辑框属性值。

系统能力： SystemCapability.MiscServices.InputMethodFramework

返回值：

错误码：

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

示例：

try {
  let editorAttribute: inputMethodEngine.EditorAttribute = inputClient.getEditorAttributeSync();
  console.log(`Succeeded in getEditorAttributeSync, editorAttribute = ${JSON.stringify(editorAttribute)}`);
} catch (err) {
  console.error(`Failed to getEditorAttributeSync: ${JSON.stringify(err)}`);
}

moveCursor⁹⁺

moveCursor(direction: number, callback: AsyncCallback<void>): void

移动光标。使用callback异步回调。

系统能力： SystemCapability.MiscServices.InputMethodFramework

参数：

错误码：

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

示例：

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

try {
  inputClient.moveCursor(inputMethodEngine.Direction.CURSOR_UP, (err: BusinessError) => {
    if (err) {
      console.error(`Failed to moveCursor: ${JSON.stringify(err)}`);
      return;
    }
    console.log('Succeeded in moving cursor.');
  });
} catch (err) {
  console.error(`Failed to moveCursor: ${JSON.stringify(err)}`);
}

moveCursor⁹⁺

moveCursor(direction: number): Promise<void>

移动光标。使用promise异步回调。

系统能力： SystemCapability.MiscServices.InputMethodFramework

参数：

返回值：

错误码：

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

示例：

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

try {
  inputClient.moveCursor(inputMethodEngine.Direction.CURSOR_UP).then(() => {
    console.log('Succeeded in moving cursor.');
  }).catch((err: BusinessError) => {
    console.error(`Failed to moveCursor: ${JSON.stringify(err)}`);
  });
} catch (err) {
  console.error(`Failed to moveCursor: ${JSON.stringify(err)}`);
}

moveCursorSync¹⁰⁺

moveCursorSync(direction: number): void

移动光标。

系统能力： SystemCapability.MiscServices.InputMethodFramework

参数：

错误码：

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

示例：

try {
  inputClient.moveCursorSync(inputMethodEngine.Direction.CURSOR_UP);
  console.log('Succeeded in moving cursor.');
} catch (err) {
  console.error(`Failed to moveCursorSync: ${JSON.stringify(err)}`);
}

selectByRange¹⁰⁺

selectByRange(range: Range, callback: AsyncCallback<void>): void

根据索引范围选中文本。使用callback异步回调。

系统能力： SystemCapability.MiscServices.InputMethodFramework

参数：

错误码：

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

示例：

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

try {
  let range: inputMethodEngine.Range = { start: 0, end: 1 };
  inputClient.selectByRange(range, (err: BusinessError) => {
    if (err) {
      console.error(`Failed to selectByRange: ${JSON.stringify(err)}`);
      return;
    }
    console.log('Succeeded in selecting by range.');
  });
} catch (err) {
  console.error(`Failed to selectByRange: ${JSON.stringify(err)}`);
}

selectByRange¹⁰⁺

selectByRange(range: Range): Promise<void>

根据索引范围选中文本。使用promise异步回调。

系统能力： SystemCapability.MiscServices.InputMethodFramework

参数：

返回值：

错误码：

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

示例：

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

try {
  let range: inputMethodEngine.Range = { start: 0, end: 1 };
  inputClient.selectByRange(range).then(() => {
    console.log('Succeeded in selecting by range.');
  }).catch((err: BusinessError) => {
    console.error(`Failed to selectByRange: ${JSON.stringify(err)}`);
  });
} catch (err) {
  console.error(`Failed to selectByRange: ${JSON.stringify(err)}`);
}

selectByRangeSync¹⁰⁺

selectByRangeSync(range: Range): void

根据索引范围选中文本。

系统能力： SystemCapability.MiscServices.InputMethodFramework

参数：

错误码：

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

示例：

try {
  let range: inputMethodEngine.Range = { start: 0, end: 1 };
  inputClient.selectByRangeSync(range);
  console.log('Succeeded in selecting by range.');
} catch (err) {
  console.error(`Failed to selectByRangeSync: ${JSON.stringify(err)}`);
}

selectByMovement¹⁰⁺

selectByMovement(movement: Movement, callback: AsyncCallback<void>): void

根据光标移动方向选中文本。使用callback异步回调。

系统能力： SystemCapability.MiscServices.InputMethodFramework

参数：

错误码：

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

示例：

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

try {
  let movement: inputMethodEngine.Movement = { direction: 1 };
  inputClient.selectByMovement(movement, (err: BusinessError) => {
    if (err) {
      console.error(`Failed to selectByMovement: ${JSON.stringify(err)}`);
      return;
    }
    console.log('Succeeded in selecting by movement.');
  });
} catch (err) {
  console.error(`Failed to selectByMovement: ${JSON.stringify(err)}`);
}

selectByMovement¹⁰⁺

selectByMovement(movement: Movement): Promise<void>

根据索引范围选中文本。使用promise异步回调。

系统能力： SystemCapability.MiscServices.InputMethodFramework

参数：

返回值：

错误码：

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

示例：

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

try {
  let movement: inputMethodEngine.Movement = { direction: 1 };
  inputClient.selectByMovement(movement).then(() => {
    console.log('Succeeded in selecting by movement.');
  }).catch((err: BusinessError) => {
    console.error(`Failed to selectByMovement: ${JSON.stringify(err)}`);
  });
} catch (err) {
  console.error(`Failed to selectByMovement: ${JSON.stringify(err)}`);
}

selectByMovementSync¹⁰⁺

selectByMovementSync(movement: Movement): void

根据光标移动方向选中文本。

系统能力： SystemCapability.MiscServices.InputMethodFramework

参数：

错误码：

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

示例：

try {
  let movement: inputMethodEngine.Movement = { direction: 1 };  
  inputClient.selectByMovementSync(movement);
  console.log('Succeeded in selecting by movement.');
} catch (err) {
  console.error(`Failed to selectByMovement: ${JSON.stringify(err)}`);
}

getTextIndexAtCursor¹⁰⁺

getTextIndexAtCursor(callback: AsyncCallback<number>): void

获取光标所在处的文本索引。使用callback异步回调。

系统能力： SystemCapability.MiscServices.InputMethodFramework

参数：

错误码：

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

示例：

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

inputClient.getTextIndexAtCursor((err: BusinessError, index: number) => {
  if (err) {
    console.error(`Failed to getTextIndexAtCursor: ${JSON.stringify(err)}`);
    return;
  }
  console.log('Succeeded in getTextIndexAtCursor: ' + index);
});

getTextIndexAtCursor¹⁰⁺

getTextIndexAtCursor(): Promise<number>

获取光标所在处的文本索引。使用promise异步回调。

系统能力： SystemCapability.MiscServices.InputMethodFramework

返回值：

错误码：

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

示例：

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

inputClient.getTextIndexAtCursor().then((index: number) => {
  console.log('Succeeded in getTextIndexAtCursor: ' + index);
}).catch((err: BusinessError) => {
  console.error(`Failed to getTextIndexAtCursor: ${JSON.stringify(err)}`);
});

getTextIndexAtCursorSync¹⁰⁺

getTextIndexAtCursorSync(): number

获取光标所在处的文本索引。

系统能力： SystemCapability.MiscServices.InputMethodFramework

返回值：

错误码：

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

示例：

try{
  let index: number = inputClient.getTextIndexAtCursorSync();
  console.log(`Succeeded in getTextIndexAtCursorSync, index: ${index}`);
} catch (err) {
  console.error(`Failed to getTextIndexAtCursorSync: ${JSON.stringify(err)}`);
}

sendExtendAction¹⁰⁺

sendExtendAction(action: ExtendAction, callback: AsyncCallback<void>): void

发送扩展编辑操作。使用callback异步回调。

说明

输入法应用调用该接口向编辑框发送扩展编辑操作，编辑框监听相应事件on('handleExtendAction')，从而进一步做出处理。

系统能力： SystemCapability.MiscServices.InputMethodFramework

参数：

错误码：

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

示例：

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

try {
  inputClient.sendExtendAction(inputMethodEngine.ExtendAction.COPY, (err: BusinessError) => {
    if (err) {
      console.error(`Failed to sendExtendAction: ${JSON.stringify(err)}`);
      return;
    }
    console.log('Succeeded in sending extend action.');
  });
} catch(err) {
  console.error(`Failed to sendExtendAction: ${JSON.stringify(err)}`);
}

sendExtendAction¹⁰⁺

sendExtendAction(action: ExtendAction): Promise<void>

发送扩展编辑操作。使用promise异步回调。

说明

输入法应用调用该接口向编辑框发送扩展编辑操作，编辑框监听相应事件on('handleExtendAction')，从而进一步做出处理。

系统能力： SystemCapability.MiscServices.InputMethodFramework

参数：

返回值：

错误码：

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

示例：

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

try {
  inputClient.sendExtendAction(inputMethodEngine.ExtendAction.COPY).then(() => {
    console.log('Succeeded in sending extend action.');
  }).catch((err: BusinessError) => {
    console.error(`Failed to sendExtendAction: ${JSON.stringify(err)}`);
  });
} catch(err) {
  console.error(`Failed to sendExtendAction: ${JSON.stringify(err)}`);
}

EditorAttribute

编辑框属性值。

系统能力： SystemCapability.MiscServices.InputMethodFramework

KeyEvent

按键属性值。

系统能力： SystemCapability.MiscServices.InputMethodFramework

PanelFlag¹⁰⁺

输入法面板状态类型枚举。

系统能力： SystemCapability.MiscServices.InputMethodFramework

PanelType¹⁰⁺

输入法面板类型枚举。

系统能力： SystemCapability.MiscServices.InputMethodFramework

PanelInfo¹⁰⁺

系统能力： SystemCapability.MiscServices.InputMethodFramework

输入法面板属性。

TextInputClient^(deprecated)

说明：

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

下列API示例中都需使用on('inputStart')回调获取到TextInputClient实例，再通过此实例调用对应方法。

getForward^(deprecated)

getForward(length:number, callback: AsyncCallback<string>): void

获取光标前固定长度的文本。使用callback异步回调。

说明：

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

系统能力： SystemCapability.MiscServices.InputMethodFramework

参数：

示例：

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

let length = 1;
textInputClient.getForward(length, (err: BusinessError, text: string) => {
  if (err) {
    console.error(`Failed to getForward: ${JSON.stringify(err)}`);
    return;
  }
  console.log('Succeeded in getting forward, text: ' + text);
});

getForward^(deprecated)

getForward(length:number): Promise<string>

获取光标前固定长度的文本。使用promise异步回调。

说明：

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

系统能力： SystemCapability.MiscServices.InputMethodFramework

参数：

返回值：

示例：

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

let length = 1;
textInputClient.getForward(length).then((text: string) => {
  console.log('Succeeded in getting forward, text: ' + text);
}).catch((err: BusinessError) => {
  console.error(`Failed to getForward: ${JSON.stringify(err)}`);
});

getBackward^(deprecated)

getBackward(length:number, callback: AsyncCallback<string>): void

获取光标后固定长度的文本。使用callback异步回调。

说明：

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

系统能力： SystemCapability.MiscServices.InputMethodFramework

参数：

示例：

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

let length = 1;
textInputClient.getBackward(length, (err: BusinessError, text: string) => {
  if (err) {
    console.error(`Failed to getBackward: ${JSON.stringify(err)}`);
    return;
  }
  console.log('Succeeded in getting borward, text: ' + text);
});

getBackward^(deprecated)

getBackward(length:number): Promise<string>

获取光标后固定长度的文本。使用promise异步回调。

说明：

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

系统能力： SystemCapability.MiscServices.InputMethodFramework

参数：

返回值：

示例：

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

let length = 1;
textInputClient.getBackward(length).then((text: string) => {
  console.log('Succeeded in getting backward: ' + JSON.stringify(text));
}).catch((err: BusinessError) => {
  console.error(`Failed to getBackward: ${JSON.stringify(err)}`);
});

deleteForward^(deprecated)

deleteForward(length:number, callback: AsyncCallback<boolean>): void

删除光标前固定长度的文本。使用callback异步回调。

说明：

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

系统能力： SystemCapability.MiscServices.InputMethodFramework

参数：

示例：

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

let length = 1;
textInputClient.deleteForward(length, (err: BusinessError, result: boolean) => {
  if (err) {
    console.error(`Failed to deleteForward: ${JSON.stringify(err)}`);
    return;
  }
  if (result) {
    console.log('Succeeded in deleting forward.');
  } else {
    console.error('Failed to deleteForward.');
  }
});

deleteForward^(deprecated)

deleteForward(length:number): Promise<boolean>

删除光标前固定长度的文本。使用promise异步回调。

说明：

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

系统能力： SystemCapability.MiscServices.InputMethodFramework

参数：

返回值：

示例：

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

let length = 1;
textInputClient.deleteForward(length).then((result: boolean) => {
  if (result) {
    console.log('Succeeded in deleting forward.');
  } else {
    console.error('Failed to delete forward.');
  }
}).catch((err: BusinessError) => {
  console.error(`Failed to deleteForward: ${JSON.stringify(err)}`);
});

deleteBackward^(deprecated)

deleteBackward(length:number, callback: AsyncCallback<boolean>): void

删除光标后固定长度的文本。使用callback异步回调。

说明：

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

系统能力： SystemCapability.MiscServices.InputMethodFramework

参数：

示例：

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

let length = 1;
textInputClient.deleteBackward(length, (err: BusinessError, result: boolean) => {
  if (err) {
    console.error(`Failed to deleteBackward: ${JSON.stringify(err)}`);
    return;
  }
  if (result) {
    console.log('Succeeded in deleting backward.');
  } else {
    console.error('Failed to deleteBackward.');
  }
});

deleteBackward^(deprecated)

deleteBackward(length:number): Promise<boolean>

删除光标后固定长度的文本。使用promise异步回调。

说明：

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

系统能力： SystemCapability.MiscServices.InputMethodFramework

参数：

返回值：

示例：

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

let length = 1;
textInputClient.deleteBackward(length).then((result: boolean) => {
  if (result) {
    console.log('Succeeded in deleting backward.');
  } else {
    console.error('Failed to deleteBackward.');
  }
}).catch((err: BusinessError) => {
  console.error(`Failed to deleteBackward: ${JSON.stringify(err)}`);
});

sendKeyFunction^(deprecated)

sendKeyFunction(action: number, callback: AsyncCallback<boolean>): void

发送功能键。使用callback异步回调。

说明：

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

系统能力： SystemCapability.MiscServices.InputMethodFramework

参数：

示例：

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

let action = 1;
textInputClient.sendKeyFunction(action, (err: BusinessError, result: boolean) => {
  if (err) {
    console.error(`Failed to sendKeyFunction: ${JSON.stringify(err)}`);
    return;
  }
  if (result) {
    console.log('Succeeded in sending key function.');
  } else {
    console.error('Failed to sendKeyFunction.');
  }
});

sendKeyFunction^(deprecated)

sendKeyFunction(action: number): Promise<boolean>

发送功能键。使用promise异步回调。

说明：

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

系统能力： SystemCapability.MiscServices.InputMethodFramework

参数：

返回值：

示例：

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

let action = 1;
textInputClient.sendKeyFunction(action).then((result: boolean) => {
  if (result) {
    console.log('Succeeded in sending key function.');
  } else {
    console.error('Failed to sendKeyFunction.');
  }
}).catch((err: BusinessError) => {
  console.error(`Failed to sendKeyFunction: ${JSON.stringify(err)}`);
});

insertText^(deprecated)

insertText(text:string, callback: AsyncCallback<boolean>): void

插入文本。使用callback异步回调。

说明：

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

系统能力： SystemCapability.MiscServices.InputMethodFramework

参数：

示例：

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

textInputClient.insertText('test', (err: BusinessError, result: boolean) => {
  if (err) {
    console.error(`Failed to insertText: ${JSON.stringify(err)}`);
    return;
  }
  if (result) {
    console.log('Succeeded in inserting text.');
  } else {
    console.error('Failed to insertText.');
  }
});

insertText^(deprecated)

insertText(text:string): Promise<boolean>

插入文本。使用promise异步回调。

说明：

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

系统能力： SystemCapability.MiscServices.InputMethodFramework

参数：

返回值：

示例：

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

textInputClient.insertText('test').then((result: boolean) => {
  if (result) {
    console.log('Succeeded in inserting text.');
  } else {
    console.error('Failed to insertText.');
  }
}).catch((err: BusinessError) => {
  console.error(`Failed to insertText: ${JSON.stringify(err)}`);
});

getEditorAttribute^(deprecated)

getEditorAttribute(callback: AsyncCallback<EditorAttribute>): void

获取编辑框属性值。使用callback异步回调。

说明：

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

系统能力： SystemCapability.MiscServices.InputMethodFramework

参数：

示例：

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

textInputClient.getEditorAttribute((err: BusinessError, editorAttribute: inputMethodEngine.EditorAttribute) => {
  if (err) {
    console.error(`Failed to getEditorAttribute: ${JSON.stringify(err)}`);
    return;
  }
  console.log('editorAttribute.inputPattern: ' + JSON.stringify(editorAttribute.inputPattern));
  console.log('editorAttribute.enterKeyType: ' + JSON.stringify(editorAttribute.enterKeyType));
});

getEditorAttribute^(deprecated)

getEditorAttribute(): Promise<EditorAttribute>

获取编辑框属性值。使用promise异步回调。

说明：

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

系统能力： SystemCapability.MiscServices.InputMethodFramework

返回值：

示例：

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

textInputClient.getEditorAttribute().then((editorAttribute: inputMethodEngine.EditorAttribute) => {
  console.log('editorAttribute.inputPattern: ' + JSON.stringify(editorAttribute.inputPattern));
  console.log('editorAttribute.enterKeyType: ' + JSON.stringify(editorAttribute.enterKeyType));
}).catch((err: BusinessError) => {
  console.error(`Failed to getEditorAttribute: ${JSON.stringify(err)}`);
});