输入法服务

2024-01-23 17:22 更新

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

说明

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

导入模块

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

常量

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

系统能力: SystemCapability.MiscServices.InputMethodFramework

名称

类型

说明

ENTER_KEY_TYPE_UNSPECIFIED

number

0

无功能键。

ENTER_KEY_TYPE_GO

number

2

“前往”功能键。

ENTER_KEY_TYPE_SEARCH

number

3

“搜索”功能键。

ENTER_KEY_TYPE_SEND

number

4

“发送”功能键。

ENTER_KEY_TYPE_NEXT

number

5

“下一个”功能键。

ENTER_KEY_TYPE_DONE

number

6

“回车”功能键。

ENTER_KEY_TYPE_PREVIOUS

number

7

“前一个”功能键。

PATTERN_NULL

number

-1

无特殊性编辑框。

PATTERN_TEXT

number

0

文本编辑框。

PATTERN_NUMBER

number

2

数字编辑框。

PATTERN_PHONE

number

3

电话号码编辑框。

PATTERN_DATETIME

number

4

日期编辑框。

PATTERN_EMAIL

number

5

邮件编辑框。

PATTERN_URI

number

6

超链接编辑框。

PATTERN_PASSWORD

number

7

密码编辑框。

OPTION_ASCII

number

20

允许输入ASCII值。

OPTION_NONE

number

0

不指定编辑框输入属性。

OPTION_AUTO_CAP_CHARACTERS

number

2

允许输入字符。

OPTION_AUTO_CAP_SENTENCES

number

8

允许输入句子。

OPTION_AUTO_WORDS

number

4

允许输入单词。

OPTION_MULTI_LINE

number

1

允许输入多行。

OPTION_NO_FULLSCREEN

number

10

半屏样式。

FLAG_SELECTING

number

2

编辑框处于选择状态。

FLAG_SINGLE_LINE

number

1

编辑框为单行。

DISPLAY_MODE_PART

number

0

编辑框显示为半屏。

DISPLAY_MODE_FULL

number

1

编辑框显示为全屏。

CURSOR_UP9+

number

1

光标上移。

CURSOR_DOWN9+

number

2

光标下移。

CURSOR_LEFT9+

number

3

光标左移。

CURSOR_RIGHT9+

number

4

光标右移。

WINDOW_TYPE_INPUT_METHOD_FLOAT9+

number

2105

输入法应用窗口风格标识。

inputMethodEngine.getInputMethodAbility9+

getInputMethodAbility(): InputMethodAbility

获取服务端实例。

系统能力: SystemCapability.MiscServices.InputMethodFramework

返回值:

类型

说明

InputMethodAbility

服务端实例。

示例:

  1. let InputMethodAbility = inputMethodEngine.getInputMethodAbility();

inputMethodEngine.getKeyboardDelegate9+

getKeyboardDelegate(): KeyboardDelegate

获取客户端监听实例。

系统能力: SystemCapability.MiscServices.InputMethodFramework

返回值:

类型

说明

KeyboardDelegate

客户端监听实例。

示例:

  1. let KeyboardDelegate = inputMethodEngine.getKeyboardDelegate();

inputMethodEngine.getInputMethodEngine(deprecated)

getInputMethodEngine(): InputMethodEngine

获取服务端实例。

说明

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

系统能力: SystemCapability.MiscServices.InputMethodFramework

返回值:

类型

说明

InputMethodEngine

服务端实例。

示例:

  1. let InputMethodEngine = inputMethodEngine.getInputMethodEngine();

inputMethodEngine.createKeyboardDelegate(deprecated)

createKeyboardDelegate(): KeyboardDelegate

获取客户端监听实例。

说明

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

系统能力: SystemCapability.MiscServices.InputMethodFramework

返回值:

类型

说明

KeyboardDelegate

客户端监听实例。

示例:

  1. let keyboardDelegate = inputMethodEngine.createKeyboardDelegate();

InputMethodEngine

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

on('inputStart')

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

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

系统能力: SystemCapability.MiscServices.InputMethodFramework

参数:

参数名

类型

必填

说明

type

string

设置监听类型。

- type为‘inputStart’时表示订阅输入法绑定。

callback

(kbController: KeyboardController, textInputClient: TextInputClient) => void

回调函数,返回订阅输入法的KeyboardController和TextInputClient实例。

示例:

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

off('inputStart')

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

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

系统能力: SystemCapability.MiscServices.InputMethodFramework

参数:

参数名

类型

必填

说明

type

string

设置监听类型。

- type为‘inputStart’时表示订阅输入法绑定。

callback

(kbController: KeyboardController, textInputClient: TextInputClient) => void

回调函数,返回取消订阅的KeyboardController和TextInputClient实例。

示例:

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

on('keyboardShow'|'keyboardHide')

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

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

系统能力: SystemCapability.MiscServices.InputMethodFramework

参数:

参数名

类型

必填

说明

type

string

设置监听类型。

- type为'keyboardShow',表示订阅输入法显示。

- type为'keyboardHide',表示订阅输入法隐藏。

callback

() => void

回调函数。

示例:

  1. inputMethodEngine.getInputMethodEngine().on('keyboardShow', () => {
  2. console.log('inputMethodEngine keyboardShow.');
  3. });
  4. inputMethodEngine.getInputMethodEngine().on('keyboardHide', () => {
  5. console.log('inputMethodEngine keyboardHide.');
  6. });

off('keyboardShow'|'keyboardHide')

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

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

系统能力: SystemCapability.MiscServices.InputMethodFramework

参数:

参数名

类型

必填

说明

type

string

设置监听类型。

- type为'keyboardShow',表示订阅输入法显示。

- type为'keyboardHide',表示订阅输入法隐藏。

callback

() => void

回调函数。

示例:

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

InputMethodAbility

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

on('inputStart')9+

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

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

系统能力: SystemCapability.MiscServices.InputMethodFramework

参数:

参数名

类型

必填

说明

type

string

设置监听类型。

- type为‘inputStart’时表示订阅输入法绑定。

callback

(kbController: KeyboardController, inputClient: InputClient) => void

回调函数,返回输入法操作相关实例。

示例:

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

off('inputStart')9+

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

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

系统能力: SystemCapability.MiscServices.InputMethodFramework

参数:

参数名

类型

必填

说明

type

string

设置监听类型。

- type为‘inputStart’时表示订阅输入法绑定。

callback

(kbController: KeyboardController, inputClient: InputClient) => void

回调函数,返回输入法操作相关实例。

示例:

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

on('inputStop')9+

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

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

系统能力: SystemCapability.MiscServices.InputMethodFramework

参数:

参数名

类型

必填

说明

type

string

设置监听类型。

- type为‘inputStop’时表示订阅停止输入法应用事件。

callback

() => void

回调函数。

示例:

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

off('inputStop')9+

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

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

系统能力: SystemCapability.MiscServices.InputMethodFramework

参数:

参数名

类型

必填

说明

type

string

设置监听类型。

- type为‘inputStop’时表示订阅停止输入法应用事件。

callback

() => void

回调函数。

示例:

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

on('setCallingWindow')9+

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

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

系统能力: SystemCapability.MiscServices.InputMethodFramework

参数:

参数名

类型

必填

说明

type

string

设置监听类型。

- type为‘setCallingWindow’时表示订阅设置调用窗口事件。

callback

(wid: number) => void

回调函数,返回调用方window id。

示例:

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

off('setCallingWindow')9+

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

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

系统能力: SystemCapability.MiscServices.InputMethodFramework

参数:

参数名

类型

必填

说明

type

string

设置监听类型。

- type为‘setCallingWindow’时表示订阅设置调用窗口事件。

callback

(wid:number) => void

回调函数,返回调用方window id。

示例:

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

on('keyboardShow'|'keyboardHide')9+

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

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

系统能力: SystemCapability.MiscServices.InputMethodFramework

参数:

参数名

类型

必填

说明

type

string

设置监听类型。

- type为'keyboardShow',表示订阅显示键盘事件。

- type为'keyboardHide',表示订阅隐藏键盘事件。

callback

() => void

回调函数。

示例:

  1. inputMethodEngine.getInputMethodAbility().on('keyboardShow', () => {
  2. console.log('InputMethodAbility keyboardShow.');
  3. });
  4. inputMethodEngine.getInputMethodAbility().on('keyboardHide', () => {
  5. console.log('InputMethodAbility keyboardHide.');
  6. });

off('keyboardShow'|'keyboardHide')9+

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

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

系统能力: SystemCapability.MiscServices.InputMethodFramework

参数:

参数名

类型

必填

说明

type

string

设置监听类型。

- type为'keyboardShow',表示取消订阅显示键盘事件。

- type为'keyboardHide',表示取消订阅隐藏键盘事件。

callback

() => void

回调函数。

示例:

  1. inputMethodEngine.getInputMethodAbility().off('keyboardShow', () => {
  2. console.log('InputMethodAbility delete keyboardShow notification.');
  3. });
  4. inputMethodEngine.getInputMethodAbility().off('keyboardHide', () => {
  5. console.log('InputMethodAbility delete keyboardHide notification.');
  6. });

on('setSubtype')9+

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

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

系统能力: SystemCapability.MiscServices.InputMethodFramework

参数:

参数名

类型

必填

说明

type

string

设置监听类型。

- type为'setSubtype',表示订阅输入法子类型的设置事件。

callback

(inputMethodSubtype: InputMethodSubtype) => void

回调函数,返回设置的输入法子类型。

示例:

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

off('setSubtype')9+

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

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

系统能力: SystemCapability.MiscServices.InputMethodFramework

参数:

参数名

类型

必填

说明

type

string

设置监听类型。

- type为'setSubtype',表示取消订阅输入法子类型的设置事件。

callback

(inputMethodSubtype: InputMethodSubtype) => void

回调函数,返回设置的输入法子类型。

示例:

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

KeyboardDelegate

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

on('keyDown'|'keyUp')

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

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

系统能力: SystemCapability.MiscServices.InputMethodFramework

参数:

参数名

类型

必填

说明

type

string

设置监听类型。

- type为'keyDown',表示订阅硬键盘按下事件。

- type为'keyUp',表示订阅硬键盘抬起事件。

callback

(event: KeyEvent) => boolean

回调函数,返回按键信息。

示例:

  1. inputMethodEngine.getKeyboardDelegate().on('keyUp', (keyEvent) => {
  2. console.info('inputMethodEngine keyCode.(keyUp):' + JSON.stringify(keyEvent.keyCode));
  3. console.info('inputMethodEngine keyAction.(keyUp):' + JSON.stringify(keyEvent.keyAction));
  4. return true;
  5. });
  6. inputMethodEngine.getKeyboardDelegate().on('keyDown', (keyEvent) => {
  7. console.info('inputMethodEngine keyCode.(keyDown):' + JSON.stringify(keyEvent.keyCode));
  8. console.info('inputMethodEngine keyAction.(keyDown):' + JSON.stringify(keyEvent.keyAction));
  9. return true;
  10. });

off('keyDown'|'keyUp')

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

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

系统能力: SystemCapability.MiscServices.InputMethodFramework

参数:

参数名

类型

必填

说明

type

string

设置监听类型。

- type为'keyDown',表示取消订阅硬键盘按下事件。

- type为'keyUp',表示取消订阅硬键盘抬起事件。

callback

(event: KeyEvent) => boolean

回调函数,返回按键信息。

示例:

  1. inputMethodEngine.getKeyboardDelegate().off('keyUp', (keyEvent) => {
  2. console.log('delete keyUp notification.');
  3. return true;
  4. });
  5. inputMethodEngine.getKeyboardDelegate().off('keyDown', (keyEvent) => {
  6. console.log('delete keyDown notification.');
  7. return true;
  8. });

on('cursorContextChange')

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

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

系统能力: SystemCapability.MiscServices.InputMethodFramework

参数:

参数名

类型

必填

说明

type

string

光标变化事件。

- type为’cursorContextChange‘时,表示订阅光标变化事件。

callback

(x: number, y: number, height: number) => void

回调函数,返回光标信息。

- x为光标上端的的x坐标值。

- y为光标上端的y坐标值。

- height为光标的高度值。

示例:

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

off('cursorContextChange')

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

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

系统能力: SystemCapability.MiscServices.InputMethodFramework

参数:

参数名

类型

必填

说明

type

string

光标变化事件。

- type为’cursorContextChange‘时,表示光标变化。

callback

(x: number, y:number, height:number) => void

回调函数,返回光标信息。

- x为光标上端的的x坐标值。

- y为光标上端的y坐标值。

- height为光标的高度值。

示例:

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

on('selectionChange')

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

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

系统能力: SystemCapability.MiscServices.InputMethodFramework

参数:

参数名

类型

必填

说明

type

string

文本选择变化事件。

- type为’selectionChange‘时,表示选择文本变化。

callback

(oldBegin: number, oldEnd: number, newBegin: number, newEnd: number) => void

回调函数,返回文本选择信息。

- oldBegin为变化之前被选中文本的起始下标。

- oldEnd为变化之前被选中文本的终止下标。

- newBegin为变化之后被选中文本的起始下标。

- newEnd为变化之后被选中文本的终止下标。

示例:

  1. inputMethodEngine.getKeyboardDelegate().on('selectionChange', (oldBegin, oldEnd, newBegin, newEnd) => {
  2. console.log('inputMethodEngine beforeEach selectionChange oldBegin:' + oldBegin);
  3. console.log('inputMethodEngine beforeEach selectionChange oldEnd:' + oldEnd);
  4. console.log('inputMethodEngine beforeEach selectionChange newBegin:' + newBegin);
  5. console.log('inputMethodEngine beforeEach selectionChange newEnd:' + newEnd);
  6. });

off('selectionChange')

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

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

系统能力: SystemCapability.MiscServices.InputMethodFramework

参数:

参数名

类型

必填

说明

type

string

文本选择变化事件。

- type为’selectionChange‘时,表示选择文本变化。

callback

(oldBegin: number, oldEnd: number, newBegin: number, newEnd: number) => void

回调函数,返回文本选择信息。

- oldBegin为变化之前被选中文本的起始下标。

- oldEnd为变化之前被选中文本的终止下标。

- newBegin为变化之后被选中文本的起始下标。

- newEnd为变化之后被选中文本的终止下标。

示例:

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

on('textChange')

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

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

系统能力: SystemCapability.MiscServices.InputMethodFramework

参数:

参数名

类型

必填

说明

type

string

文本变化事件。

- type为’textChange‘时,表示订阅文本变化事件。

callback

(text: string) => void

回调函数,返回订阅的文本内容。

示例:

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

off('textChange')

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

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

系统能力: SystemCapability.MiscServices.InputMethodFramework

参数:

参数名

类型

必填

说明

type

string

文本变化事件。

- type为’textChange‘时,表示取消订阅文本变化事件。

callback

(text: string) => void

回调函数,返回取消订阅的文本内容。

示例:

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

KeyboardController

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

hide9+

hide(callback: AsyncCallback<void>): void

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

系统能力: SystemCapability.MiscServices.InputMethodFramework

参数:

参数名

类型

必填

说明

callback

AsyncCallback<void>

回调函数。当输入法隐藏成功,err为undefined,否则为错误对象。

错误码:

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

错误码ID

错误信息

12800003

input method client error.

示例:

  1. keyboardController.hide((err) => {
  2. if (err !== undefined) {
  3. console.error('Failed to hide keyboard: ' + JSON.stringify(err));
  4. return;
  5. }
  6. console.log('Succeeded in hiding keyboard.');
  7. });

hide9+

hide(): Promise<void>

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

系统能力: SystemCapability.MiscServices.InputMethodFramework

返回值:

类型

说明

Promise<void>

无返回结果的Promise对象。

错误码:

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

错误码ID

错误信息

12800003

input method client error.

示例:

  1. keyboardController.hide().then(() => {
  2. console.info('Succeeded in hiding keyboard.');
  3. }).catch((err) => {
  4. console.info('Failed to hide keyboard: ' + JSON.stringify(err));
  5. });

hideKeyboard(deprecated)

hideKeyboard(callback: AsyncCallback<void>): void

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

说明

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

系统能力: SystemCapability.MiscServices.InputMethodFramework

参数:

参数名

类型

必填

说明

callback

AsyncCallback<void>

回调函数。当输入法隐藏成功,err为undefined,否则为错误对象。

示例:

  1. keyboardController.hideKeyboard((err) => {
  2. if (err !== undefined) {
  3. console.error('Failed to hide Keyboard: ' + JSON.stringify(err));
  4. return;
  5. }
  6. console.log('Succeeded in hiding keyboard.');
  7. });

hideKeyboard(deprecated)

hideKeyboard(): Promise<void>

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

说明

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

系统能力: SystemCapability.MiscServices.InputMethodFramework

返回值:

类型

说明

Promise<void>

无返回结果的Promise对象。

示例:

  1. keyboardController.hideKeyboard().then(() => {
  2. console.info('Succeeded in hiding keyboard.');
  3. }).catch((err) => {
  4. console.info('Failed to hide Keyboard: ' + JSON.stringify(err));
  5. });

InputClient9+

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

sendKeyFunction9+

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

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

系统能力: SystemCapability.MiscServices.InputMethodFramework

参数:

参数名

类型

必填

说明

action

number

功能键键值。

当值为0时,表示无效按键;

当值为1时,表示确认键(即回车键)。

callback

AsyncCallback<boolean>

回调函数。当功能键发送成功,err为undefined,data为true;否则为错误对象。

错误码:

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

错误码ID

错误信息

12800003

input method client error.

示例:

  1. let action = 1;
  2. try {
  3. inputClient.sendKeyFunction(action, (err, result) => {
  4. if (err !== undefined) {
  5. console.error('Failed to sendKeyFunction: ' + JSON.stringify(err));
  6. return;
  7. }
  8. if (result) {
  9. console.info('Succeeded in sending key function. ');
  10. } else {
  11. console.error('Failed to sendKeyFunction. ');
  12. }
  13. });
  14. } catch (err) {
  15. console.error('sendKeyFunction err: ' + JSON.stringify(err));
  16. }

sendKeyFunction9+

sendKeyFunction(action: number): Promise<boolean>

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

系统能力: SystemCapability.MiscServices.InputMethodFramework

参数:

参数名

类型

必填

说明

action

number

功能键键值。

当值为0时,表示无效按键;

当值为1时,表示确认键(即回车键)。

返回值:

类型

说明

Promise<boolean>

Promise对象。返回true表示功能键发送成功;返回false表示功能键发送失败。

错误码:

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

错误码ID

错误信息

12800003

input method client error.

示例:

  1. let action = 1;
  2. try {
  3. inputClient.sendKeyFunction(action).then((result) => {
  4. if (result) {
  5. console.info('Succeeded in sending key function. ');
  6. } else {
  7. console.error('Failed to sendKeyFunction. ');
  8. }
  9. }).catch((err) => {
  10. console.error('Failed to sendKeyFunction:' + JSON.stringify(err));
  11. });
  12. } catch (err) {
  13. console.error('Failed to sendKeyFunction: ' + JSON.stringify(err));
  14. }

getForward9+

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

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

系统能力: SystemCapability.MiscServices.InputMethodFramework

参数:

参数名

类型

必填

说明

length

number

文本长度。

callback

AsyncCallback<string>

回调函数。当光标前固定长度的文本获取成功,err为undefined,data为获取到的文本;否则为错误对象。

错误码:

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

错误码ID

错误信息

12800003

input method client error.

12800006

Input method controller error.

示例:

  1. let length = 1;
  2. try {
  3. inputClient.getForward(length, (err, text) => {
  4. if (err !== undefined) {
  5. console.error('Failed to getForward: ' + JSON.stringify(err));
  6. return;
  7. }
  8. console.log('Succeeded in getting forward, text: ' + text);
  9. });
  10. } catch (err) {
  11. console.error('Failed to getForward: ' + JSON.stringify(err));
  12. }

getForward9+

getForward(length:number): Promise<string>

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

系统能力: SystemCapability.MiscServices.InputMethodFramework

参数:

参数名

类型

必填

说明

length

number

文本长度。

返回值:

类型

说明

Promise<string>

Promise对象,返回光标前固定长度的文本。

错误码:

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

错误码ID

错误信息

12800003

input method client error.

12800006

Input method controller error.

示例:

  1. let length = 1;
  2. try {
  3. inputClient.getForward(length).then((text) => {
  4. console.info('Succeeded in getting forward, text: ' + text);
  5. }).catch((err) => {
  6. console.error('Failed to getForward: ' + JSON.stringify(err));
  7. });
  8. } catch (err) {
  9. console.error('Failed to getForward: ' + JSON.stringify(err));
  10. }

getBackward9+

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

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

系统能力: SystemCapability.MiscServices.InputMethodFramework

参数:

参数名

类型

必填

说明

length

number

文本长度。

callback

AsyncCallback<string>

回调函数。当光标后固定长度的文本获取成功,err为undefined,data为获取到的文本;否则为错误对象。

错误码:

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

错误码ID

错误信息

12800003

input method client error.

12800006

Input method controller error.

示例:

  1. let length = 1;
  2. try {
  3. inputClient.getBackward(length, (err, text) => {
  4. if (err !== undefined) {
  5. console.error('Failed to getForward: ' + JSON.stringify(err));
  6. return;
  7. }
  8. console.log('Succeeded in getting backward, text: ' + text);
  9. });
  10. } catch (err) {
  11. console.error('Failed to getForward: ' + JSON.stringify(err));
  12. }

getBackward9+

getBackward(length:number): Promise<string>

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

系统能力: SystemCapability.MiscServices.InputMethodFramework

参数:

参数名

类型

必填

说明

length

number

文本长度。

返回值:

类型

说明

Promise<string>

Promise对象,返回光标后固定长度的文本。

错误码:

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

错误码ID

错误信息

12800003

input method client error.

12800006

Input method controller error.

示例:

  1. let length = 1;
  2. try {
  3. inputClient.getBackward(length).then((text) => {
  4. console.info('Succeeded in getting backward, text: ' + text);
  5. }).catch((err) => {
  6. console.error('Failed to getForward: ' + JSON.stringify(err));
  7. });
  8. } catch (err) {
  9. console.error('Failed to getForward: ' + JSON.stringify(err));
  10. }

deleteForward9+

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

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

系统能力: SystemCapability.MiscServices.InputMethodFramework

参数:

参数名

类型

必填

说明

length

number

文本长度。

callback

AsyncCallback<boolean>

回调函数。当光标前固定长度的文本删除成功,err为undefined,data为true;否则为错误对象。

错误码:

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

错误码ID

错误信息

12800002

Input method engine error.

12800003

input method client error.

示例:

  1. let length = 1;
  2. try {
  3. inputClient.deleteForward(length, (err, result) => {
  4. if (err !== undefined) {
  5. console.error('Failed to delete forward: ' + JSON.stringify(err));
  6. return;
  7. }
  8. if (result) {
  9. console.info('Succeeded in deleting forward. ');
  10. } else {
  11. console.error('Failed to delete forward: ' + JSON.stringify(err));
  12. }
  13. });
  14. } catch (err) {
  15. console.error('Failed to delete forward: ' + JSON.stringify(err));
  16. }

deleteForward9+

deleteForward(length:number): Promise<boolean>

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

系统能力: SystemCapability.MiscServices.InputMethodFramework

参数:

参数名

类型

必填

说明

length

number

文本长度。

返回值:

类型

说明

Promise<boolean>

Promise对象。返回true表示删除光标前固定长度的文本成功;返回false表示删除光标前固定长度的文本失败。

错误码:

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

错误码ID

错误信息

12800002

Input method engine error.

12800003

input method client error.

示例:

  1. let length = 1;
  2. try {
  3. inputClient.deleteForward(length).then((result) => {
  4. if (result) {
  5. console.info('Succeeded in deleting forward. ');
  6. } else {
  7. console.error('Failed to delete Forward. ');
  8. }
  9. }).catch((err) => {
  10. console.error('Failed to delete Forward: ' + JSON.stringify(err));
  11. });
  12. } catch (err) {
  13. console.error('Failed to delete Forward: ' + JSON.stringify(err));
  14. }

deleteBackward9+

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

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

系统能力: SystemCapability.MiscServices.InputMethodFramework

参数:

参数名

类型

必填

说明

length

number

文本长度。

callback

AsyncCallback<boolean>

回调函数。当光标后固定长度的文本删除成功,err为undefined,data为true;否则为错误对象。

错误码:

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

错误码ID

错误信息

12800002

Input method engine error.

12800003

input method client error.

示例:

  1. let length = 1;
  2. try {
  3. inputClient.deleteBackward(length, (err, result) => {
  4. if (err !== undefined) {
  5. console.error('Failed to delete Backward: ' + JSON.stringify(err));
  6. return;
  7. }
  8. if (result) {
  9. console.info('Succeeded in deleting backward. ');
  10. } else {
  11. console.error('Failed to delete Backward: ' + JSON.stringify(err));
  12. }
  13. });
  14. } catch (err) {
  15. console.error('deleteBackward err: ' + JSON.stringify(err));
  16. }

deleteBackward9+

deleteBackward(length:number): Promise<boolean>

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

系统能力: SystemCapability.MiscServices.InputMethodFramework

参数:

参数名

类型

必填

说明

length

number

文本长度。

返回值:

类型

说明

Promise<boolean>

Promise对象。返回true表示删除光标后固定长度的文本成功;返回false表示删除光标后固定长度的文本失败。

错误码:

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

错误码ID

错误信息

12800002

Input method engine error.

12800003

input method client error.

示例:

  1. let length = 1;
  2. inputClient.deleteBackward(length).then((result) => {
  3. if (result) {
  4. console.info('Succeeded in deleting backward. ');
  5. } else {
  6. console.error('Failed to deleteBackward. ');
  7. }
  8. }).catch((err) => {
  9. console.error('Failed to deleteBackward: ' + JSON.stringify(err));
  10. });

insertText9+

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

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

系统能力: SystemCapability.MiscServices.InputMethodFramework

参数:

参数名

类型

必填

说明

text

string

文本。

callback

AsyncCallback<boolean>

回调函数。当文本插入成功,err为undefined,data为true;否则为错误对象。

错误码:

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

错误码ID

错误信息

12800002

Input method engine error.

12800003

input method client error.

示例:

  1. inputClient.insertText('test', (err, result) => {
  2. if (err !== undefined) {
  3. console.error('Failed to insertText: ' + JSON.stringify(err));
  4. return;
  5. }
  6. if (result) {
  7. console.info('Succeeded in inserting text. ');
  8. } else {
  9. console.error('Failed to insertText. ');
  10. }
  11. });

insertText9+

insertText(text:string): Promise<boolean>

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

系统能力: SystemCapability.MiscServices.InputMethodFramework

参数:

参数名

类型

必填

说明

text

string

文本。

返回值:

类型

说明

Promise<boolean>

Promise对象。返回true表示插入文本成功;返回false表示插入文本失败。

错误码:

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

错误码ID

错误信息

12800002

Input method engine error.

12800003

input method client error.

示例:

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

getEditorAttribute9+

getEditorAttribute(callback: AsyncCallback<EditorAttribute>): void

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

系统能力: SystemCapability.MiscServices.InputMethodFramework

参数:

参数名

类型

必填

说明

callback

AsyncCallback<EditorAttribute>

回调函数。当编辑框属性值获取成功,err为undefined,data为编辑框属性值;否则为错误对象。

错误码:

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

错误码ID

错误信息

12800003

input method client error.

示例:

  1. inputClient.getEditorAttribute((err, editorAttribute) => {
  2. if (err !== undefined) {
  3. console.error('Failed to getEditorAttribute: ' + JSON.stringify(err));
  4. return;
  5. }
  6. console.log('editorAttribute.inputPattern: ' + JSON.stringify(editorAttribute.inputPattern));
  7. console.log('editorAttribute.enterKeyType: ' + JSON.stringify(editorAttribute.enterKeyType));
  8. });

getEditorAttribute9+

getEditorAttribute(): Promise<EditorAttribute>

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

系统能力: SystemCapability.MiscServices.InputMethodFramework

返回值:

类型

说明

Promise<EditorAttribute>

Promise对象,返回编辑框属性值。

错误码:

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

错误码ID

错误信息

12800003

input method client error.

示例:

  1. inputClient.getEditorAttribute().then((editorAttribute) => {
  2. console.info('editorAttribute.inputPattern: ' + JSON.stringify(editorAttribute.inputPattern));
  3. console.info('editorAttribute.enterKeyType: ' + JSON.stringify(editorAttribute.enterKeyType));
  4. }).catch((err) => {
  5. console.error('Failed to getEditorAttribute: ' + JSON.stringify(err));
  6. });

moveCursor9+

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

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

系统能力: SystemCapability.MiscServices.InputMethodFramework

参数:

参数名

类型

必填

说明

direction

number

光标移动方向。

callback

AsyncCallback<void>

回调函数。当光标移动成功,err为undefined,否则为错误对象。

错误码:

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

错误码ID

错误信息

12800003

input method client error.

示例:

  1. try {
  2. inputClient.moveCursor(inputMethodEngine.CURSOR_UP, (err) => {
  3. if (err !== undefined) {
  4. console.error('Failed to moveCursor: ' + JSON.stringify(err));
  5. return;
  6. }
  7. console.info('Succeeded in moving cursor.');
  8. });
  9. } catch (err) {
  10. console.error('Failed to moveCursor: ' + JSON.stringify(err));
  11. }

moveCursor9+

moveCursor(direction: number): Promise<void>

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

系统能力: SystemCapability.MiscServices.InputMethodFramework

参数:

参数名

类型

必填

说明

direction

number

光标移动方向。

返回值:

类型

说明

Promise<void>

无返回结果的Promise对象。

错误码:

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

错误码ID

错误信息

12800003

input method client error.

示例:

  1. try {
  2. inputClient.moveCursor(inputMethodEngine.CURSOR_UP).then(() => {
  3. console.log('Succeeded in moving cursor.');
  4. }).catch((err) => {
  5. console.error('Failed to moveCursor: ' + JSON.stringify(err));
  6. });
  7. } catch (err) {
  8. console.log('Failed to moveCursor: ' + JSON.stringify(err));
  9. }

EditorAttribute

编辑框属性值。

系统能力: SystemCapability.MiscServices.InputMethodFramework

名称

类型

可读

可写

说明

enterKeyType

number

编辑框的功能属性。

inputPattern

number

编辑框的文本属性。

KeyEvent

按键属性值。

系统能力: SystemCapability.MiscServices.InputMethodFramework

名称

类型

可读

可写

说明

keyCode

number

按键的键值。键码值说明参考 KeyCode

keyAction

number

按键的状态。

当值为2时,表示按下事件;

当值为3时,表示抬起事件。

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

参数:

参数名

类型

必填

说明

length

number

文本长度。

callback

AsyncCallback<string>

回调函数。当光标前固定长度的文本获取成功,err为undefined,data为获取到的文本;否则为错误对象。

示例:

  1. let length = 1;
  2. textInputClient.getForward(length, (err, text) => {
  3. if (err !== undefined) {
  4. console.error('Failed to getForward: ' + JSON.stringify(err));
  5. return;
  6. }
  7. console.log('Succeeded in getting forward, text: ' + text);
  8. });

getForward(deprecated)

getForward(length:number): Promise<string>

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

说明

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

系统能力: SystemCapability.MiscServices.InputMethodFramework

参数:

参数名

类型

必填

说明

length

number

文本长度。

返回值:

类型

说明

Promise<string>

Promise对象,返回光标前固定长度的文本。

示例:

  1. let length = 1;
  2. textInputClient.getForward(length).then((text) => {
  3. console.info('Succeeded in getting forward, text: ' + text);
  4. }).catch((err) => {
  5. console.error('Failed to getForward: ' + JSON.stringify(err));
  6. });

getBackward(deprecated)

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

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

说明

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

系统能力: SystemCapability.MiscServices.InputMethodFramework

参数:

参数名

类型

必填

说明

length

number

文本长度。

callback

AsyncCallback<string>

回调函数。当光标后固定长度的文本获取成功,err为undefined,data为获取到的文本;否则为错误对象。

示例:

  1. let length = 1;
  2. textInputClient.getBackward(length, (err, text) => {
  3. if (err !== undefined) {
  4. console.error('Failed to getBackward: ' + JSON.stringify(err));
  5. return;
  6. }
  7. console.log('Succeeded in getting borward, text: ' + text);
  8. });

getBackward(deprecated)

getBackward(length:number): Promise<string>

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

说明

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

系统能力: SystemCapability.MiscServices.InputMethodFramework

参数:

参数名

类型

必填

说明

length

number

文本长度。

返回值:

类型

说明

Promise<string>

Promise对象,返回光标后固定长度的文本。

示例:

  1. let length = 1;
  2. textInputClient.getBackward(length).then((text) => {
  3. console.info('Succeeded in getting backward: ' + JSON.stringify(text));
  4. }).catch((err) => {
  5. console.error('Failed to getBackward: ' + JSON.stringify(err));
  6. });

deleteForward(deprecated)

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

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

说明

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

系统能力: SystemCapability.MiscServices.InputMethodFramework

参数:

参数名

类型

必填

说明

length

number

文本长度。

callback

AsyncCallback<boolean>

回调函数。当光标前固定长度的文本删除成功,err为undefined,data为true;否则为错误对象。

示例:

  1. let length = 1;
  2. textInputClient.deleteForward(length, (err, result) => {
  3. if (err !== undefined) {
  4. console.error('Failed to deleteForward: ' + JSON.stringify(err));
  5. return;
  6. }
  7. if (result) {
  8. console.info('Succeeded in deleting forward. ');
  9. } else {
  10. console.error('Failed to deleteForward. ');
  11. }
  12. });

deleteForward(deprecated)

deleteForward(length:number): Promise<boolean>

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

说明

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

系统能力: SystemCapability.MiscServices.InputMethodFramework

参数:

参数名

类型

必填

说明

length

number

文本长度。

返回值:

类型

说明

Promise<boolean>

Promise对象。返回true表示删除光标前固定长度的文本成功;返回false表示删除光标前固定长度的文本失败。

示例:

  1. let length = 1;
  2. textInputClient.deleteForward(length).then((result) => {
  3. if (result) {
  4. console.info('Succeeded in deleting forward. ');
  5. } else {
  6. console.error('Failed to delete forward. ');
  7. }
  8. }).catch((err) => {
  9. console.error('Failed to delete forward: ' + JSON.stringify(err));
  10. });

deleteBackward(deprecated)

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

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

说明

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

系统能力: SystemCapability.MiscServices.InputMethodFramework

参数:

参数名

类型

必填

说明

length

number

文本长度。

callback

AsyncCallback<boolean>

回调函数。当光标后固定长度的文本删除成功,err为undefined,data为true;否则为错误对象。

示例:

  1. let length = 1;
  2. textInputClient.deleteBackward(length, (err, result) => {
  3. if (err !== undefined) {
  4. console.error('Failed to delete backward: ' + JSON.stringify(err));
  5. return;
  6. }
  7. if (result) {
  8. console.info('Succeeded in deleting backward. ');
  9. } else {
  10. console.error('Failed to deleteBackward. ');
  11. }
  12. });

deleteBackward(deprecated)

deleteBackward(length:number): Promise<boolean>

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

说明

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

系统能力: SystemCapability.MiscServices.InputMethodFramework

参数:

参数名

类型

必填

说明

length

number

文本长度。

返回值:

类型

说明

Promise<boolean>

Promise对象。返回true表示删除光标后固定长度的文本成功;返回false表示删除光标后固定长度的文本失败。

示例:

  1. let length = 1;
  2. textInputClient.deleteBackward(length).then((result) => {
  3. if (result) {
  4. console.info('Succeeded in deleting backward. ');
  5. } else {
  6. console.error('Failed to deleteBackward. ');
  7. }
  8. }).catch((err) => {
  9. console.error('Failed to deleteBackward: ' + JSON.stringify(err));
  10. });

sendKeyFunction(deprecated)

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

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

说明

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

系统能力: SystemCapability.MiscServices.InputMethodFramework

参数:

参数名

类型

必填

说明

action

number

功能键键值。

当值为0时,表示无效按键;

当值为1时,表示确认键(即回车键)。

callback

AsyncCallback<boolean>

回调函数。当功能键发送成功,err为undefined,data为true;否则为错误对象。

示例:

  1. let action = 1;
  2. textInputClient.sendKeyFunction(action, (err, result) => {
  3. if (err !== undefined) {
  4. console.error('Failed to sendKeyFunction: ' + JSON.stringify(err));
  5. return;
  6. }
  7. if (result) {
  8. console.info('Succeeded in sending key function. ');
  9. } else {
  10. console.error('Failed to sendKeyFunction. ');
  11. }
  12. });

sendKeyFunction(deprecated)

sendKeyFunction(action: number): Promise<boolean>

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

说明

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

系统能力: SystemCapability.MiscServices.InputMethodFramework

参数:

参数名

类型

必填

说明

action

number

功能键键值。

当值为0时,表示无效按键;

当值为1时,表示确认键(即回车键)。

返回值:

类型

说明

Promise<boolean>

Promise对象。返回true表示发送功能键成功;返回false表示发送功能键失败。

示例:

  1. let action = 1;
  2. textInputClient.sendKeyFunction(action).then((result) => {
  3. if (result) {
  4. console.info('Succeeded in sending key function. ');
  5. } else {
  6. console.error('Failed to sendKeyFunction. ');
  7. }
  8. }).catch((err) => {
  9. console.error('Failed to sendKeyFunction:' + JSON.stringify(err));
  10. });

insertText(deprecated)

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

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

说明

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

系统能力: SystemCapability.MiscServices.InputMethodFramework

参数:

参数名

类型

必填

说明

text

string

文本。

callback

AsyncCallback<boolean>

回调函数。当文本插入成功,err为undefined,data为true;否则为错误对象。

示例:

  1. textInputClient.insertText('test', (err, result) => {
  2. if (err !== undefined) {
  3. console.error('Failed to insertText: ' + JSON.stringify(err));
  4. return;
  5. }
  6. if (result) {
  7. console.info('Succeeded in inserting text. ');
  8. } else {
  9. console.error('Failed to insertText. ');
  10. }
  11. });

insertText(deprecated)

insertText(text:string): Promise<boolean>

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

说明

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

系统能力: SystemCapability.MiscServices.InputMethodFramework

参数:

参数名

类型

必填

说明

text

string

文本。

返回值:

类型

说明

Promise<boolean>

Promise对象。返回true表示插入文本成功;返回false表示插入文本失败。

示例:

  1. textInputClient.insertText('test').then((result) => {
  2. if (result) {
  3. console.info('Succeeded in inserting text. ');
  4. } else {
  5. console.error('Failed to insertText. ');
  6. }
  7. }).catch((err) => {
  8. console.error('Failed to insertText: ' + JSON.stringify(err));
  9. });

getEditorAttribute(deprecated)

getEditorAttribute(callback: AsyncCallback<EditorAttribute>): void

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

说明

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

系统能力: SystemCapability.MiscServices.InputMethodFramework

参数:

参数名

类型

必填

说明

callback

AsyncCallback<EditorAttribute>

回调函数。当编辑框的属性值获取成功,err为undefined,data为编辑框属性值;否则为错误对象。

示例:

  1. textInputClient.getEditorAttribute((err, editorAttribute) => {
  2. if (err !== undefined) {
  3. console.error('Failed to getEditorAttribute: ' + JSON.stringify(err));
  4. return;
  5. }
  6. console.log('editorAttribute.inputPattern: ' + JSON.stringify(editorAttribute.inputPattern));
  7. console.log('editorAttribute.enterKeyType: ' + JSON.stringify(editorAttribute.enterKeyType));
  8. });

getEditorAttribute(deprecated)

getEditorAttribute(): Promise<EditorAttribute>

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

说明

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

系统能力: SystemCapability.MiscServices.InputMethodFramework

返回值:

类型

说明

Promise<EditorAttribute>

Promise对象,返回编辑框属性值。

示例:

  1. textInputClient.getEditorAttribute().then((editorAttribute) => {
  2. console.info('editorAttribute.inputPattern: ' + JSON.stringify(editorAttribute.inputPattern));
  3. console.info('editorAttribute.enterKeyType: ' + JSON.stringify(editorAttribute.enterKeyType));
  4. }).catch((err) => {
  5. console.error('Failed to getEditorAttribute: ' + JSON.stringify(err));
  6. });
  1. });
以上内容是否对您有帮助:
在线笔记
App下载
App下载

扫描二维码

下载编程狮App

公众号
微信公众号

编程狮公众号