@ohos.inputMethod (Input Method Framework)

The inputMethod module is oriented to common foreground applications (third-party applications and system applications such as Notes, Messaging, and Settings). It provides input method control and management capabilities, including displaying or hiding the soft keyboard, switching between input methods, and obtaining the list of all input methods.

NOTE

The initial APIs of this module are supported since API version 6. Newly added APIs will be marked with a superscript to indicate their earliest API version.

Modules to Import

import { inputMethod } from '@kit.IMEKit';

Constant

Provides the constants.

System capability: SystemCapability.MiscServices.InputMethodFramework

Name	Type	Value	Description
MAX_TYPE_NUM8+	number	128	Maximum number of supported input methods.

InputMethodProperty⁸⁺

Describes the input method application attributes.

System capability: SystemCapability.MiscServices.InputMethodFramework

Name	Type	Read-only	Optional	Description
name9+	string	Yes	No	Mandatory. Name of the input method package.
id9+	string	Yes	No	Mandatory. Unique identifier of an input method extension in an app. id and name form a globally unique identifier of the input method extension.
label9+	string	Yes	Yes	Optional. - When InputMethodProperty is used as the input parameter of an API for switching or querying, you do not need to set this field. You can use name and ID to uniquely specify an input method extension. - When InputMethodProperty is used as the return value of an API for querying (for example, getCurrentInputMethod), this field indicates the name of the input method extension displayed externally. Use the label configured for the InputMethodExtensionAbility. If no label is configured, the label of the application entry ability is automatically used. If no label is configured for the application entry ability, the label configured in AppScope is automatically used.
labelId10+	number	Yes	Yes	Optional. - When InputMethodProperty is used as the input parameter of an API for switching or querying, you do not need to set this field. You can use name and ID to uniquely specify an input method extension. - When InputMethodProperty is used as the return value of an API for querying (for example, getCurrentInputMethod), this field indicates the resource ID of the label field.
icon9+	string	Yes	Yes	Optional. - When InputMethodProperty is used as the input parameter of an API for switching or querying, you do not need to set this field. You can use name and ID to uniquely specify an input method extension. - When InputMethodProperty is used as the return value of an API for querying (for example, getCurrentInputMethod), this field indicates the input method icon data, which can be obtained through icon ID.
iconId9+	number	Yes	Yes	Optional. - When InputMethodProperty is used as the input parameter of an API for switching or querying, you do not need to set this field. You can use name and ID to uniquely specify an input method extension. - When InputMethodProperty is used as the return value of an API for querying (for example, getCurrentInputMethod), this field indicates the resource ID of the icon field.
enabledState20+	EnabledState	Yes	Yes	Optional. - When InputMethodProperty is used as the input parameter of an API for switching or querying, you do not need to set this field. You can use name and ID to uniquely specify an input method extension. - When InputMethodProperty is used as the return value of an API for querying (for example, getCurrentInputMethod), this field indicates whether the input method is enabled.
extra9+	object	No	Yes	Extra information about the input method. This parameter is reserved and currently has no specific meaning. - API version 10 and later: optional - API version 9: mandatory
packageName(deprecated)	string	Yes	No	Name of the input method package. Mandatory. Note: This API is supported since API version 8 and deprecated since API version 9. You are advised to use name instead.
methodId(deprecated)	string	Yes	No	Unique ID of the input method. Mandatory. Note: This API is supported since API version 8 and deprecated since API version 9. You are advised to use id instead.

CapitalizeMode²⁰⁺

Enumerates the modes of capitalizing the first letter of a text.

System capability: SystemCapability.MiscServices.InputMethodFramework

Name	Value	Description
NONE	0	The first letter is not capitalized.
SENTENCES	1	The first letter of each sentence is capitalized.
WORDS	2	The first letter of each word is capitalized.
CHARACTERS	3	All letters are capitalized.

inputMethod.getController⁹⁺

getController(): InputMethodController

Obtains an InputMethodController instance.

System capability: SystemCapability.MiscServices.InputMethodFramework

Return value

Type	Description
InputMethodController	InputMethodController instance.

Error codes

For details about the error codes, see Input Method Framework Error Codes.

ID	Error Message
12800006	input method controller error. Possible cause: create InputMethodController object failed.

Example

let inputMethodController: inputMethod.InputMethodController = inputMethod.getController();

inputMethod.getDefaultInputMethod¹¹⁺

getDefaultInputMethod(): InputMethodProperty

Obtains the default input method.

System capability: SystemCapability.MiscServices.InputMethodFramework

Return value

Type	Description
InputMethodProperty	Default input method.

Error codes

For details about the error codes, see Input Method Framework Error Codes.

ID	Error Message
12800008	input method manager service error. Possible cause: a system error, such as null pointer, IPC exception.

Example

let defaultIme: inputMethod.InputMethodProperty = inputMethod.getDefaultInputMethod();

inputMethod.getSystemInputMethodConfigAbility¹¹⁺

getSystemInputMethodConfigAbility(): ElementName

Obtains the information about the input method configuration page ability.

System capability: SystemCapability.MiscServices.InputMethodFramework

Return value

Type	Description
ElementName	Element name of the input method configuration page ability.

Error codes

For details about the error codes, see Input Method Framework Error Codes.

ID	Error Message
12800008	input method manager service error. Possible cause: a system error, such as null pointer, IPC exception.

Example

import { bundleManager } from '@kit.AbilityKit';

let inputMethodConfig: bundleManager.ElementName = inputMethod.getSystemInputMethodConfigAbility();

inputMethod.getSetting⁹⁺

getSetting(): InputMethodSetting

Obtains an InputMethodSetting instance.

System capability: SystemCapability.MiscServices.InputMethodFramework

Return value

Type	Description
InputMethodSetting	InputMethodSetting instance.

Error codes

For details about the error codes, see Input Method Framework Error Codes.

ID	Error Message
12800007	input method setter error. Possible cause: create InputMethodSetting object failed.

Example

let inputMethodSetting: inputMethod.InputMethodSetting = inputMethod.getSetting();

inputMethod.switchInputMethod⁹⁺

switchInputMethod(target: InputMethodProperty, callback: AsyncCallback<boolean>): void

Switches to another input method. This API uses an asynchronous callback to return the result.

NOTE

• In API versions 9 and 10, this API can only be called by system applications granted the ohos.permission.CONNECT_IME_ABILITY permission.
• Since API version 11, this API can only be called by the current input method application.

System capability: SystemCapability.MiscServices.InputMethodFramework

Parameters

Name	Type	Mandatory	Description
target	InputMethodProperty	Yes	Target input method.
callback	AsyncCallback<boolean>	Yes	Callback used to return the result. If the operation is successful, err is undefined and data is true. Otherwise, err is an error object.

Error codes

For details about the error codes, see Input Method Framework Error Codes and Universal Error Codes.

ID	Error Message
401	parameter error. Possible causes: 1. Mandatory parameters are left unspecified; 2. Incorrect parameter types; 3. Parameter verification failed.
12800005	configuration persistence error.
12800008	input method manager service error. Possible cause: a system error, such as null pointer, IPC exception.

Example

import { BusinessError } from '@kit.BasicServicesKit';

let currentIme: inputMethod.InputMethodProperty = inputMethod.getCurrentInputMethod();
inputMethod.switchInputMethod(currentIme, (err: BusinessError, result: boolean) => {
  if (err) {
    console.error(`Failed to switchInputMethod, code: ${err.code}, message: ${err.message}`);
    return;
  }
  if (result) {
    console.info('Succeeded in switching input method.');
  } else {
    console.error('Failed to switch input method.');
  }
});

NOTE

In API version 11, the error code 201 permissions check fails. is removed.

inputMethod.switchInputMethod⁹⁺

switchInputMethod(target: InputMethodProperty): Promise<boolean>

Switches to another input method. This API uses a promise to return the result.

NOTE

• In API versions 9 and 10, this API can only be called by system applications granted the ohos.permission.CONNECT_IME_ABILITY permission.
• Since API version 11, this API can only be called by the current input method application.

System capability: SystemCapability.MiscServices.InputMethodFramework

Parameters

Name	Type	Mandatory	Description
target	InputMethodProperty	Yes	Target input method.

Return value

Type	Description
Promise<boolean>	Promise used to return the result. The value true means that the switching is successful, and false means the opposite.

Error codes

For details about the error codes, see Input Method Framework Error Codes and Universal Error Codes.

ID	Error Message
401	parameter error. Possible causes: 1. Mandatory parameters are left unspecified; 2. Incorrect parameter types; 3. Parameter verification failed.
12800005	configuration persistence error.
12800008	input method manager service error. Possible cause: a system error, such as null pointer, IPC exception.

Example

import { BusinessError } from '@kit.BasicServicesKit';

let currentIme: inputMethod.InputMethodProperty = inputMethod.getCurrentInputMethod();
inputMethod.switchInputMethod(currentIme).then((result: boolean) => {
  if (result) {
    console.info('Succeeded in switching input method.');
  } else {
    console.error('Failed to switch input method.');
  }
}).catch((err: BusinessError) => {
  console.error(`Failed to switchInputMethod, code: ${err.code}, message: ${err.message}`);
});

NOTE

In API version 11, the error code 201 permissions check fails. is removed.

inputMethod.getCurrentInputMethod⁹⁺

getCurrentInputMethod(): InputMethodProperty

Obtains the current input method. This API returns the result synchronously.

System capability: SystemCapability.MiscServices.InputMethodFramework

Return value

Type	Description
InputMethodProperty	InputmethodProperty instance of the current input method.

Example

let currentIme: inputMethod.InputMethodProperty = inputMethod.getCurrentInputMethod();

inputMethod.switchCurrentInputMethodSubtype⁹⁺

switchCurrentInputMethodSubtype(target: InputMethodSubtype, callback: AsyncCallback<boolean>): void

Switches to another subtype of this input method. This API uses an asynchronous callback to return the result.

NOTE

• In API version 9, this API can only be called by system applications granted the ohos.permission.CONNECT_IME_ABILITY permission.
• In API version 10, this API can only be called by system applications and the current input method application, and the ohos.permission.CONNECT_IME_ABILITY permission is required.
• Since API version 11, this API can only be called by the current input method application.

System capability: SystemCapability.MiscServices.InputMethodFramework

Parameters

Name	Type	Mandatory	Description
target	InputMethodSubtype	Yes	Target input method subtype.
callback	AsyncCallback<boolean>	Yes	Callback used to return the result. If the operation is successful, err is undefined and data is true. Otherwise, err is an error object.

Error codes

For details about the error codes, see Input Method Framework Error Codes and Universal Error Codes.

ID	Error Message
401	parameter error. Possible causes: 1. Mandatory parameters are left unspecified; 2. Incorrect parameter types; 3. Parameter verification failed.
12800005	configuration persistence error.
12800008	input method manager service error. Possible cause: a system error, such as null pointer, IPC exception.

Example

import { BusinessError } from '@kit.BasicServicesKit';

let extra: Record<string, string> = {}
// For details, see the parameter description of **InputMethodSubtype**.
inputMethod.switchCurrentInputMethodSubtype({
  id: "ServiceExtAbility",
  label: "",
  name: "com.example.keyboard",
  mode: "upper",
  locale: "",
  language: "",
  icon: "",
  iconId: 0,
  extra: extra
}, (err: BusinessError, result: boolean) => {
  if (err) {
    console.error(`Failed to switchCurrentInputMethodSubtype, code: ${err.code}, message: ${err.message}`);
    return;
  }
  if (result) {
    console.info('Succeeded in switching currentInputMethodSubtype.');
  } else {
    console.error('Failed to switchCurrentInputMethodSubtype');
  }
});

NOTE

In API version 11, the error code 201 permissions check fails. is removed.

inputMethod.switchCurrentInputMethodSubtype⁹⁺

switchCurrentInputMethodSubtype(target: InputMethodSubtype): Promise<boolean>

Switches to another subtype of this input method. This API uses a promise to return the result.

NOTE

• In API version 9, this API can only be called by system applications granted the ohos.permission.CONNECT_IME_ABILITY permission.
• In API version 10, this API can only be called by system applications and the current input method application, and the ohos.permission.CONNECT_IME_ABILITY permission is required.
• Since API version 11, this API can only be called by the current input method application.

System capability: SystemCapability.MiscServices.InputMethodFramework

Parameters

Name	Type	Mandatory	Description
target	InputMethodSubtype	Yes	Target input method subtype.

Return value

Type	Description
Promise<boolean>	Promise used to return the result. The value true means that the switching is successful, and false means the opposite.

Error codes

For details about the error codes, see Input Method Framework Error Codes and Universal Error Codes.

ID	Error Message
401	parameter error. Possible causes: 1. Mandatory parameters are left unspecified; 2. Incorrect parameter types; 3. Parameter verification failed.
12800005	configuration persistence error.
12800008	input method manager service error. Possible cause: a system error, such as null pointer, IPC exception.

Example

import { BusinessError } from '@kit.BasicServicesKit';

let extra: Record<string, string> = {}
// For details, see the parameter description of **InputMethodSubtype**.
inputMethod.switchCurrentInputMethodSubtype({
  id: "ServiceExtAbility",
  label: "",
  name: "com.example.keyboard",
  mode: "upper",
  locale: "",
  language: "",
  icon: "",
  iconId: 0,
  extra: extra
}).then((result: boolean) => {
  if (result) {
    console.info('Succeeded in switching currentInputMethodSubtype.');
  } else {
    console.error('Failed to switchCurrentInputMethodSubtype.');
  }
}).catch((err: BusinessError) => {
  console.error(`Failed to switchCurrentInputMethodSubtype, code: ${err.code}, message: ${err.message}`);
});

NOTE

In API version 11, the error code 201 permissions check fails. is removed.

inputMethod.getCurrentInputMethodSubtype⁹⁺

getCurrentInputMethodSubtype(): InputMethodSubtype

Obtains the current input method subtype.

System capability: SystemCapability.MiscServices.InputMethodFramework

Return value

Type	Description
InputMethodSubtype	Current input method subtype.

Example

import { InputMethodSubtype } from '@kit.IMEKit';

let currentImeSubType: InputMethodSubtype = inputMethod.getCurrentInputMethodSubtype();

inputMethod.switchCurrentInputMethodAndSubtype⁹⁺

switchCurrentInputMethodAndSubtype(inputMethodProperty: InputMethodProperty, inputMethodSubtype: InputMethodSubtype, callback: AsyncCallback<boolean>): void

Switches to a specified subtype of a specified input method. This API uses an asynchronous callback to return the result.

NOTE

• In API versions 9 and 10, this API can only be called by system applications granted the ohos.permission.CONNECT_IME_ABILITY permission.
• Since API version 11, this API can only be called by the current input method application.

System capability: SystemCapability.MiscServices.InputMethodFramework

Parameters

Name	Type	Mandatory	Description
inputMethodProperty	InputMethodProperty	Yes	Target input method.
inputMethodSubtype	InputMethodSubtype	Yes	Target input method subtype.
callback	AsyncCallback<boolean>	Yes	Callback used to return the result. If the operation is successful, err is undefined and data is true. Otherwise, err is an error object.

Error codes

For details about the error codes, see Input Method Framework Error Codes and Universal Error Codes.

ID	Error Message
401	parameter error. Possible causes: 1. Mandatory parameters are left unspecified; 2. Incorrect parameter types; 3. Parameter verification failed.
12800005	configuration persistence error.
12800008	input method manager service error. Possible cause: a system error, such as null pointer, IPC exception.

Example

import { InputMethodSubtype } from '@kit.IMEKit';
import { BusinessError } from '@kit.BasicServicesKit';

let currentIme: inputMethod.InputMethodProperty = inputMethod.getCurrentInputMethod();
let imSubType: InputMethodSubtype = inputMethod.getCurrentInputMethodSubtype();
inputMethod.switchCurrentInputMethodAndSubtype(currentIme, imSubType, (err: BusinessError, result: boolean) => {
  if (err) {
    console.error(`Failed to switchCurrentInputMethodAndSubtype, code: ${err.code}, message: ${err.message}`);
    return;
  }
  if (result) {
    console.info('Succeeded in switching currentInputMethodAndSubtype.');
  } else {
    console.error('Failed to switchCurrentInputMethodAndSubtype.');
  }
});

NOTE

In API version 11, the error code 201 permissions check fails. is removed.

inputMethod.switchCurrentInputMethodAndSubtype⁹⁺

switchCurrentInputMethodAndSubtype(inputMethodProperty: InputMethodProperty, inputMethodSubtype: InputMethodSubtype): Promise<boolean>

Switches to a specified subtype of a specified input method. This API uses a promise to return the result.

NOTE

• In API versions 9 and 10, this API can only be called by system applications granted the ohos.permission.CONNECT_IME_ABILITY permission.
• Since API version 11, this API can only be called by the current input method application.

System capability: SystemCapability.MiscServices.InputMethodFramework

Parameters

Name	Type	Mandatory	Description
inputMethodProperty	InputMethodProperty	Yes	Target input method.
inputMethodSubtype	InputMethodSubtype	Yes	Target input method subtype.

Return value

Type	Description
Promise<boolean>	Promise used to return the result. The value true means that the switching is successful, and false means the opposite.

Error codes

For details about the error codes, see Input Method Framework Error Codes and Universal Error Codes.

ID	Error Message
401	parameter error. Possible causes: 1. Mandatory parameters are left unspecified; 2. Incorrect parameter types; 3. Parameter verification failed.
12800005	configuration persistence error.
12800008	input method manager service error. Possible cause: a system error, such as null pointer, IPC exception.

Example

import { InputMethodSubtype } from '@kit.IMEKit';
import { BusinessError } from '@kit.BasicServicesKit';

let currentIme: inputMethod.InputMethodProperty = inputMethod.getCurrentInputMethod();
let imSubType: InputMethodSubtype = inputMethod.getCurrentInputMethodSubtype();
inputMethod.switchCurrentInputMethodAndSubtype(currentIme, imSubType).then((result: boolean) => {
  if (result) {
    console.info('Succeeded in switching currentInputMethodAndSubtype.');
  } else {
    console.error('Failed to switchCurrentInputMethodAndSubtype.');
  }
}).catch((err: BusinessError) => {
  console.error(`Failed to switchCurrentInputMethodAndSubtype, code: ${err.code}, message: ${err.message}`);
});

NOTE

In API version 11, the error code 201 permissions check fails. is removed.

inputMethod.getInputMethodController^(deprecated)

getInputMethodController(): InputMethodController

Obtains an InputMethodController instance.

NOTE

This API is supported since API version 6 and deprecated since API version 9. You are advised to use getController instead.

System capability: SystemCapability.MiscServices.InputMethodFramework

Return value

Type	Description
InputMethodController	Current InputMethodController instance.

Example

let inputMethodController: inputMethod.InputMethodController = inputMethod.getInputMethodController();

inputMethod.getInputMethodSetting^(deprecated)

getInputMethodSetting(): InputMethodSetting

Obtains an InputMethodSetting instance.

NOTE

This API is supported since API version 8 and deprecated since API version 9. You are advised to use getSetting instead.

System capability: SystemCapability.MiscServices.InputMethodFramework

Return value

Type	Description
InputMethodSetting	InputMethodSetting instance.

Example

let inputMethodSetting: inputMethod.InputMethodSetting = inputMethod.getInputMethodSetting();

inputMethod.setSimpleKeyboardEnabled²⁰⁺

setSimpleKeyboardEnabled(enable: boolean): void

Enables or disables the simple keyboard.

System capability: SystemCapability.MiscServices.InputMethodFramework

Parameters

Name	Type	Mandatory	Description
enable	boolean	Yes	Whether to enable the simple keyboard. The value true means that the simple keyboard is enabled; the value false means the opposite. The native edit box takes effect when it is focused next time, while the self-drawing component takes effect when the input method is attached by calling attach next time.

Example

  let enable: boolean = false;
  inputMethod.setSimpleKeyboardEnabled(enable);

inputMethod.onAttachmentDidFail²²⁺

onAttachmentDidFail(callback: Callback<AttachFailureReason>): void

Subscribes to attachment failure events. This API uses an asynchronous callback to return the result.

System capability: SystemCapability.MiscServices.InputMethodFramework

Parameters

Name	Type	Mandatory	Description
callback	Callback<AttachFailureReason>	Yes	Callback used to return the reason for attachment failure. This callback is only invoked when the attachment failure is triggered by the registrant's process.

Example

import { Callback } from '@kit.BasicServicesKit';

let attachmentDidFailCallback: Callback<inputMethod.AttachFailureReason> = 
  (reason: inputMethod.AttachFailureReason): void => {
    console.info(`Attachment failed with reason: ${reason}.`);
  if (reason === inputMethod.AttachFailureReason.CALLER_NOT_FOCUSED) {
    console.info(`Failure reason is CALLER_NOT_FOCUSED.`);
  }
  };
inputMethod.onAttachmentDidFail(attachmentDidFailCallback);

inputMethod.offAttachmentDidFail²²⁺

offAttachmentDidFail(callback?: Callback<AttachFailureReason>): void

Unsubscribes from attachment failure events. This API uses an asynchronous callback to return the result.

System capability: SystemCapability.MiscServices.InputMethodFramework

Parameters

Name	Type	Mandatory	Description
callback	Callback<AttachFailureReason>	No	Callback used for unsubscription, which must be the same as that passed by the subscription API. If no parameter is specified, all callback functions for this event will be unsubscribed from.

Example

import { Callback } from '@kit.BasicServicesKit';

let attachmentDidFailCallback: Callback<inputMethod.AttachFailureReason> = 
  (reason: inputMethod.AttachFailureReason): void => {
    console.info(`Attachment failed with reason: ${reason}.`);
  if (reason === inputMethod.AttachFailureReason.CALLER_NOT_FOCUSED) {
    console.info(`Failure reason is CALLER_NOT_FOCUSED.`);
  }
  };
inputMethod.onAttachmentDidFail(attachmentDidFailCallback);
inputMethod.offAttachmentDidFail(attachmentDidFailCallback);

TextInputType¹⁰⁺

Enumerates the text input types.

System capability: SystemCapability.MiscServices.InputMethodFramework

Name	Value	Description
NONE	-1	None.
TEXT	0	Text.
MULTILINE	1	Multi-line.
NUMBER	2	Number.
PHONE	3	Phone number.
DATETIME	4	Date.
EMAIL_ADDRESS	5	Email address.
URL	6	URL.
VISIBLE_PASSWORD	7	Password.
NUMBER_PASSWORD11+	8	Numeric password.
SCREEN_LOCK_PASSWORD20+	9	Lock screen password.
USER_NAME20+	10	Username.
NEW_PASSWORD20+	11	New password.
NUMBER_DECIMAL20+	12	Number with a decimal point.
ONE_TIME_CODE20+	13	Verification code.

EnterKeyType¹⁰⁺

Enumerates the function types represented by the Enter key of the input method.

System capability: SystemCapability.MiscServices.InputMethodFramework

Name	Value	Description
UNSPECIFIED	0	Not specified.
NONE	1	None.
GO	2	Go.
SEARCH	3	Search.
SEND	4	Send.
NEXT	5	Next.
DONE	6	Done.
PREVIOUS	7	Previous.
NEWLINE12+	8	Line break.

KeyboardStatus¹⁰⁺

Enumerates the soft keyboard states of the input method.

System capability: SystemCapability.MiscServices.InputMethodFramework

Name	Value	Description
NONE	0	None.
HIDE	1	Hidden.
SHOW	2	Shown.

Direction¹⁰⁺

Enumerates the directions of cursor movement of the input method.

System capability: SystemCapability.MiscServices.InputMethodFramework

Name	Value	Description
CURSOR_UP	1	Upward.
CURSOR_DOWN	2	Downward.
CURSOR_LEFT	3	Leftward.
CURSOR_RIGHT	4	Rightward.

ExtendAction¹⁰⁺

Describes the type of the extended edit action on the text box.

System capability: SystemCapability.MiscServices.InputMethodFramework

Name	Value	Description
SELECT_ALL	0	Select all.
CUT	3	Cut.
COPY	4	Copy.
PASTE	5	Paste.

FunctionKey¹⁰⁺

Describes the type of the input method function key.

System capability: SystemCapability.MiscServices.InputMethodFramework

Name	Type	Read-only	Optional	Description
enterKeyType	EnterKeyType	No	No	Function type represented by the Enter key of the input method.

InputAttribute¹⁰⁺

Describes the attributes of the edit box, including the text input type and Enter key function type.

System capability: SystemCapability.MiscServices.InputMethodFramework

Name	Type	Read-only	Optional	Description
textInputType	TextInputType	No	No	Enumerates the text input types.
enterKeyType	EnterKeyType	No	No	Function type represented by the Enter key.
placeholder20+	string	No	Yes	Placeholder information set for the edit box. - When placeholder information is set for the edit box, the length cannot exceed 255 characters (a placeholder longer than 255 characters will be automatically truncated to 255 characters). It is used to prompt or guide users to enter temporary text or symbols. (For example, the placeholder prompts whether the input item is mandatory.) - If no placeholder is set for the edit box, the value is an empty string by default. - This field is provided for the input method application when attach is called.
abilityName20+	string	No	Yes	Ability name set for the edit box. - If the ability name is set for the edit box, the length cannot exceed 127 characters. (A name longer than 127 characters will be automatically truncated to 127 characters.) - If the ability name is not set for the edit box, the value is an empty string by default. - This field is provided for the input method application when attach is called.

TextConfig¹⁰⁺

Describes the configuration of the edit box.

System capability: SystemCapability.MiscServices.InputMethodFramework

Name	Type	Read-only	Optional	Description
inputAttribute	InputAttribute	No	No	Edit box attribute.
cursorInfo	CursorInfo	No	Yes	Cursor information.
selection	Range	No	Yes	Text selection range.
windowId	number	No	Yes	ID of the window where the edit box is located. The value must be an integer. You are advised to call getWindowProperties to obtain the window ID.
newEditBox20+	boolean	No	Yes	Whether the edit box is new. The value true means the edit box is new; the value false means the opposite.
capitalizeMode20+	CapitalizeMode	No	Yes	Whether to capitalize the first letter in the edit box. If it is not set or is set to an invalid value, the first letter is not capitalized by default.

CursorInfo¹⁰⁺

Represents the cursor information.

System capability: SystemCapability.MiscServices.InputMethodFramework

Name	Type	Read-only	Optional	Description
left	number	No	No	Horizontal coordinate of the cursor, in px. The value must be an integer. The minimum value is 0 and the maximum value is the width of the current screen.
top	number	No	No	Vertical coordinate of the cursor, in px. The value must be an integer. The minimum value is 0 and the maximum value is the height of the current screen.
width	number	No	No	Width of the cursor, in px. The value must be an integer. The minimum value is 0 and the maximum value is the width of the current screen.
height	number	No	No	Height of the cursor, in px. The value must be an integer. The minimum value is 0 and the maximum value is the height of the current screen.
displayId	number	No	Yes	ID of the monitor where the cursor is located. Since: 26.0.0

Range¹⁰⁺

Describes the range of the selected text.

System capability: SystemCapability.MiscServices.InputMethodFramework

Name	Type	Read-only	Optional	Description
start	number	No	No	Index of the first selected character in the text box. The value is an integer greater than or equal to 0, and cannot exceed the actual text length.
end	number	No	No	Index of the last selected character in the text box. The value is an integer greater than or equal to 0, and cannot exceed the actual text length. The end value must be greater than the start value.

Movement¹⁰⁺

Describes the direction in which the cursor moves when the text is selected.

System capability: SystemCapability.MiscServices.InputMethodFramework

Name	Type	Read-only	Optional	Description
direction	Direction	No	No	Direction in which the cursor moves when the text is selected.

InputWindowInfo¹⁰⁺

Describes the window information of the input method keyboard.

System capability: SystemCapability.MiscServices.InputMethodFramework

Name	Type	Read-only	Optional	Description
name	string	No	No	Name of the input method keyboard window.
left	number	No	No	Horizontal coordinate of the upper left corner of the input method keyboard window, in px. The value must be an integer. The minimum value is 0 and the maximum value is the width of the current screen.
top	number	No	No	Vertical coordinate of the upper left corner of the input method keyboard window, in px. The value must be an integer. The minimum value is 0 and the maximum value is the height of the current screen.
width	number	No	No	Width of the input method keyboard window, in px. The value must be an integer. The minimum value is 0 and the maximum value is the width of the current screen.
height	number	No	No	Height of the input method keyboard window, in px. The value must be an integer. The minimum value is 0 and the maximum value is the height of the current screen.
displayId23+	number	No	Yes	ID of the display where the soft keyboard window is located. Model restriction: This parameter can be used only in the stage model.

EnabledState¹⁵⁺

Indicates whether the input method is enabled.

System capability: SystemCapability.MiscServices.InputMethodFramework

Name	Value	Description
DISABLED	0	Disabled.
BASIC_MODE	1	Basic mode.
FULL_EXPERIENCE_MODE	2	Full experience mode.

RequestKeyboardReason¹⁵⁺

Enumerates the reasons for requesting the keyboard.

System capability: SystemCapability.MiscServices.InputMethodFramework

Name	Value	Description
NONE	0	The keyboard request is triggered for no reason.
MOUSE	1	The keyboard request is triggered by a mouse operation.
TOUCH	2	The keyboard request is triggered by a touch operation.
OTHER	20	The keyboard request is triggered by other reasons.

MessageHandler¹⁵⁺

Represents a custom communication object.

NOTE

You can register this object to receive custom communication data sent by the input method application. When the custom communication data is received, the onMessage callback in this object is triggered.

This object is globally unique. After multiple registrations, only the last registered object is valid and retained, and the onTerminated callback of the penultimate registered object is triggered.

If this object is unregistered, its onTerminated callback will be triggered.

onMessage¹⁵⁺

onMessage(msgId: string, msgParam?: ArrayBuffer): void

Receives custom data sent by the input method application.

NOTE

This callback is triggered when the registered MeesageHandler receives custom communication data sent by the input method application.

The msgId parameter is mandatory, and the msgParam parameter is optional. If only the custom msgId data is received, confirm it with the data sender.

System capability: SystemCapability.MiscServices.InputMethodFramework

Parameters

Name	Type	Mandatory	Description
msgId	string	Yes	Identifier of the received custom communication data.
msgParam	ArrayBuffer	No	Message body of the received custom communication data.

Example

let inputMethodController: inputMethod.InputMethodController = inputMethod.getController();

let messageHandler: inputMethod.MessageHandler = {
  onTerminated(): void {
    console.info('OnTerminated.');
  },
  onMessage(msgId: string, msgParam?: ArrayBuffer): void {
    console.info(`recv message, msg: ${msgId}, msgParam: ${JSON.stringify(msgParam)}`);
  }
};
inputMethodController.recvMessage(messageHandler);

onTerminated¹⁵⁺

onTerminated(): void

Listens for MessageHandler termination.

NOTE

When an application registers a new MessageHandler object, the OnTerminated callback of the previous registered MessageHandler object is triggered.

When an application unregisters a MessageHandler object, the OnTerminated callback of the current registered MessageHandler object is triggered.

System capability: SystemCapability.MiscServices.InputMethodFramework

Example

let inputMethodController: inputMethod.InputMethodController = inputMethod.getController();

let messageHandler: inputMethod.MessageHandler = {
  onTerminated(): void {
    console.info('OnTerminated.');
  },
  onMessage(msgId: string, msgParam?: ArrayBuffer): void {
    console.info(`recv message, msg: ${msgId}, msgParam: ${JSON.stringify(msgParam)}`);
  }
};
inputMethodController.recvMessage(messageHandler);

SetPreviewTextCallback¹⁷⁺

type SetPreviewTextCallback = (text: string, range: Range) => void

Callback triggered when the input method framework needs to display the text preview.

System capability: SystemCapability.MiscServices.InputMethodFramework

Parameters

Name	Type	Mandatory	Description
text	string	Yes	Text preview.
range	Range	Yes	Describes the range of the selected text.

AttachFailureReason²²⁺

Enumerates the reasons for attachment failure.

System capability: SystemCapability.MiscServices.InputMethodFramework

Name	Value	Description
CALLER_NOT_FOCUSED	0	The caller does not belong to the application of the focused window.
IME_ABNORMAL	1	The input method application is abnormal.
SERVICE_ABNORMAL	2	The input method framework service is abnormal.

AttachOptions²³⁺

Defines additional options for binding an input method.

Model restriction: This API can be used only in the stage model.

System capability: SystemCapability.MiscServices.InputMethodFramework

Name	Type	Read-only	Optional	Description
requestKeyboardReason	RequestKeyboardReason	No	Yes	Reason for requesting the keyboard.
showKeyboard	boolean	No	Yes	Whether to start the input method keyboard after the self-drawing component is attached to the input method. - true means to start the input method keyboard. - false means not to start the input method keyboard.

InputMethodController

In the following API examples, you must first use getController to obtain an InputMethodController instance, and then call the APIs using the obtained instance.

attach¹⁰⁺

attach(showKeyboard: boolean, textConfig: TextConfig, callback: AsyncCallback<void>): void

Attaches a self-drawing component to the input method. This API uses an asynchronous callback to return the result.

NOTE

An input method can use the following features only when it has a self-drawing component attached to it: showing or hiding the keyboard, updating the cursor information, changing the selection range of the edit box, saving the configuration information, and listening for and processing the information or commands sent by the input method.

If the window where the self-drawing component is located is set to be non-focusable via setWindowFocusable, the system cannot guarantee proper interaction between the self-drawing input component and the input method. If you want to draw an input box in a non-focusable window, refer to Input Box and Input Method Interaction in Non-Focusable Windows.

System capability: SystemCapability.MiscServices.InputMethodFramework

Parameters

Name	Type	Mandatory	Description
showKeyboard	boolean	Yes	Whether to start the input method keyboard after the self-drawing component is attached to the input method. - true means to start the input method keyboard. - false means not to start the input method keyboard.
textConfig	TextConfig	Yes	Configuration of the edit box.
callback	AsyncCallback<void>	Yes	Callback used to return the result. If the operation is successful, err is undefined. Otherwise, err is an error object.

Error codes

For details about the error codes, see Input Method Framework Error Codes and Universal Error Codes.

ID	Error Message
401	parameter error. Possible causes: 1. Mandatory parameters are left unspecified; 2. Incorrect parameter types.
12800003	input method client error. Possible causes: 1.the edit box is not focused. 2.no edit box is bound to current input method application. 3.ipc failed due to the large amount of data transferred or other reasons.
12800008	input method manager service error. Possible cause: a system error, such as null pointer, IPC exception.

Example

import { BusinessError } from '@kit.BasicServicesKit';

let inputAttribute: inputMethod.InputAttribute = {
  textInputType: inputMethod.TextInputType.TEXT,
  enterKeyType: inputMethod.EnterKeyType.GO
}
let textConfig: inputMethod.TextConfig = { inputAttribute: inputAttribute };
inputMethod.getController().attach(true, textConfig, (err: BusinessError) => {
  if (err) {
    console.error(`Failed to attach, code: ${err.code}, message: ${err.message}`);
    return;
  }
  console.info('Succeeded in attaching the inputMethod.');
});

attach¹⁰⁺

attach(showKeyboard: boolean, textConfig: TextConfig): Promise<void>

Attaches a self-drawing component to the input method. This API uses a promise to return the result.

NOTE

An input method can use the following features only when it has a self-drawing component attached to it: showing or hiding the keyboard, updating the cursor information, changing the selection range of the edit box, saving the configuration information, and listening for and processing the information or commands sent by the input method.

If the window where the self-drawing component is located is set to be non-focusable via setWindowFocusable, the system cannot guarantee proper interaction between the self-drawing input component and the input method. If you want to draw an input box in a non-focusable window, refer to Input Box and Input Method Interaction in Non-Focusable Windows.

System capability: SystemCapability.MiscServices.InputMethodFramework

Parameters

Name	Type	Mandatory	Description
showKeyboard	boolean	Yes	Whether to start the input method keyboard after the self-drawing component is attached to the input method. - true means to start the input method keyboard. - false means not to start the input method keyboard.
textConfig	TextConfig	Yes	Configuration of the edit box.

Return value

Type	Description
Promise<void>	Promise that returns no value.

Error codes

For details about the error codes, see Input Method Framework Error Codes and Universal Error Codes.

ID	Error Message
401	parameter error. Possible causes: 1. Mandatory parameters are left unspecified; 2. Incorrect parameter types.
12800003	input method client error. Possible causes: 1.the edit box is not focused. 2.no edit box is bound to current input method application. 3.ipc failed due to the large amount of data transferred or other reasons.
12800008	input method manager service error. Possible cause: a system error, such as null pointer, IPC exception.

Example

import { BusinessError } from '@kit.BasicServicesKit';

let inputAttribute: inputMethod.InputAttribute = {
  textInputType: inputMethod.TextInputType.TEXT,
  enterKeyType: inputMethod.EnterKeyType.GO
}
let textConfig: inputMethod.TextConfig = { inputAttribute: inputAttribute };
inputMethod.getController().attach(true, textConfig).then(() => {
  console.info('Succeeded in attaching inputMethod.');
}).catch((err: BusinessError) => {
  console.error(`Failed to attach, code: ${err.code}, message: ${err.message}`);
});

attach¹⁵⁺

attach(showKeyboard: boolean, textConfig: TextConfig, requestKeyboardReason: RequestKeyboardReason): Promise<void>

Attaches a self-drawing component to the input method. This API uses a promise to return the result.

NOTE

An input method can use the following features only when it has a self-drawing component attached to it: showing or hiding the keyboard, updating the cursor information, changing the selection range of the edit box, saving the configuration information, and listening for and processing the information or commands sent by the input method.

If the window where the self-drawing component is located is set to be non-focusable via setWindowFocusable, the system cannot guarantee proper interaction between the self-drawing input component and the input method. If you want to draw an input box in a non-focusable window, refer to Input Box and Input Method Interaction in Non-Focusable Windows.

System capability: SystemCapability.MiscServices.InputMethodFramework

Parameters

Name	Type	Mandatory	Description
showKeyboard	boolean	Yes	Whether to start the input method keyboard after the self-drawing component is attached to the input method. - true means to start the input method keyboard. - false means not to start the input method keyboard.
textConfig	TextConfig	Yes	Configuration of the edit box.
requestKeyboardReason	RequestKeyboardReason	Yes	Reason for requesting the keyboard.

Return value

Type	Description
Promise<void>	Promise that returns no value.

Error codes

For details about the error codes, see Input Method Framework Error Codes and Universal Error Codes.

ID	Error Message
401	parameter error. Possible causes: 1. Mandatory parameters are left unspecified; 2. Incorrect parameter types.
12800003	input method client error. Possible causes: 1.the edit box is not focused. 2.no edit box is bound to current input method application. 3.ipc failed due to the large amount of data transferred or other reasons.
12800008	input method manager service error. Possible cause: a system error, such as null pointer, IPC exception.

Example

import { BusinessError } from '@kit.BasicServicesKit';

let inputAttribute: inputMethod.InputAttribute = {
  textInputType: inputMethod.TextInputType.TEXT,
  enterKeyType: inputMethod.EnterKeyType.GO
}
let textConfig: inputMethod.TextConfig = { inputAttribute: inputAttribute };
let requestKeyboardReason: inputMethod.RequestKeyboardReason = inputMethod.RequestKeyboardReason.MOUSE;

inputMethod.getController().attach(true, textConfig, requestKeyboardReason).then(() => {
  console.info('Succeeded in attaching inputMethod.');
}).catch((err: BusinessError) => {
  console.error(`Failed to attach, code: ${err.code}, message: ${err.message}`);
});

attachWithUIContext²³⁺

attachWithUIContext(uiContext: UIContext, textConfig: TextConfig, attachOptions?: AttachOptions): Promise<void>

Attaches a self-drawing component to the input method. This API uses a promise to return the result.

NOTE

An input method can use the following features only when it has a self-drawing component attached to it: showing or hiding the keyboard, updating the cursor information, changing the selection range of the edit box, saving the configuration information, and listening for and processing the information or commands sent by the input method.

Model restriction: This API can be used only in the stage model.

System capability: SystemCapability.MiscServices.InputMethodFramework

Parameters

Name	Type	Mandatory	Description
uiContext	UIContext	Yes	UIContext instance.
textConfig	TextConfig	Yes	Configuration of the edit box.
attachOptions	AttachOptions	No	Additional options for binding.

Return value

Type	Description
Promise<void>	Promise that returns no value.

Error codes

For details about the error codes, see Input Method Framework Error Codes and Universal Error Codes.

ID	Error Message
12800003	input method client error. Possible causes:1.the edit box is not focused. 2.no edit box is bound to current input method application.3.ipc failed due to the large amount of data transferred or other reasons.
12800008	input method manager service error. Possible cause: a system error, such as null pointer, IPC exception.

Example

import { BusinessError } from '@kit.BasicServicesKit';
import { UIContext } from '@kit.ArkUI';

let uiContext: UIContext | undefined = UIContext.getCallingScopeUIContext();
let inputAttribute: inputMethod.InputAttribute = {
  textInputType: inputMethod.TextInputType.TEXT,
  enterKeyType: inputMethod.EnterKeyType.GO
}
let textConfig: inputMethod.TextConfig = { inputAttribute: inputAttribute };
let attachOptions: inputMethod.AttachOptions = { showKeyboard: true };
inputMethod.getController().attachWithUIContext(uiContext, textConfig, attachOptions).then(() => {
  console.info('Succeeded in attaching inputMethod.');
}).catch((err: BusinessError) => {
  console.error(`Failed to attach, code: ${err.code}, message: ${err.message}`);
});

discardTypingText²⁰⁺

discardTypingText(): Promise<void>

Discards the text that is being typed. This API uses a promise to return the result.

NOTE

This API can be called after the edit box is attached to an input method.

System capability: SystemCapability.MiscServices.InputMethodFramework

Return value

Type	Description
Promise<void>	Promise used to return the result. Promise that returns no value.

Error codes

For details about the error codes, see Input Method Framework Error Codes.

ID	Error Message
12800003	input method client error. Possible causes: 1.the edit box is not focused. 2.no edit box is bound to current input method application. 3.ipc failed due to the large amount of data transferred or other reasons.
12800009	input method client detached.
12800015	the other side does not accept the request.

Example

import { BusinessError } from '@kit.BasicServicesKit';

inputMethod.getController().discardTypingText().then(() => {
  console.info('Succeeded discardTypingText.');
}).catch((err: BusinessError) => {
  console.error(`Failed to discardTypingText, code: ${err.code}, message: ${err.message}`);
});

showTextInput¹⁰⁺

showTextInput(callback: AsyncCallback<void>): void

Enters the text editing mode. This API uses an asynchronous callback to return the result.

NOTE

After the edit box is attached to an input method, this API can be called to start the soft keyboard and enter the text editing state.

System capability: SystemCapability.MiscServices.InputMethodFramework

Parameters

Name	Type	Mandatory	Description
callback	AsyncCallback<void>	Yes	Callback used to return the result. If the operation is successful, err is undefined. Otherwise, err is an error object.

Error codes

For details about the error codes, see Input Method Framework Error Codes.

ID	Error Message
12800003	input method client error. Possible causes: 1.the edit box is not focused. 2.no edit box is bound to current input method application. 3.ipc failed due to the large amount of data transferred or other reasons.
12800008	input method manager service error. Possible cause: a system error, such as null pointer, IPC exception.
12800009	input method client detached.

Example

import { BusinessError } from '@kit.BasicServicesKit';

inputMethod.getController().showTextInput((err: BusinessError) => {
  if (err) {
    console.error(`Failed to showTextInput, code: ${err.code}, message: ${err.message}`);
    return;
  }
  console.info('Succeeded in showing the inputMethod.');
});

showTextInput¹⁰⁺

showTextInput(): Promise<void>

Enters the text editing mode. This API uses a promise to return the result.

NOTE

After the edit box is attached to an input method, this API can be called to start the soft keyboard and enter the text editing state.

System capability: SystemCapability.MiscServices.InputMethodFramework

Return value

Type	Description
Promise<void>	Promise that returns no value.

Error codes

For details about the error codes, see Input Method Framework Error Codes.

ID	Error Message
12800003	input method client error. Possible causes: 1.the edit box is not focused. 2.no edit box is bound to current input method application. 3.ipc failed due to the large amount of data transferred or other reasons.
12800008	input method manager service error. Possible cause: a system error, such as null pointer, IPC exception.
12800009	input method client detached.

Example

import { BusinessError } from '@kit.BasicServicesKit';

inputMethod.getController().showTextInput().then(() => {
  console.info('Succeeded in showing text input.');
}).catch((err: BusinessError) => {
  console.error(`Failed to showTextInput, code: ${err.code}, message: ${err.message}`);
});

showTextInput¹⁵⁺

showTextInput(requestKeyboardReason: RequestKeyboardReason): Promise<void>

Enters the text editing mode. This API uses a promise to return the result.

NOTE

After the edit box is attached to an input method, this API can be called to start the soft keyboard and enter the text editing state.

System capability: SystemCapability.MiscServices.InputMethodFramework

Parameters

Name	Type	Mandatory	Description
requestKeyboardReason	RequestKeyboardReason	Yes	Reason for requesting the keyboard.

Return value

Type	Description
Promise<void>	Promise that returns no value.

Error codes

For details about the error codes, see Input Method Framework Error Codes.

ID	Error Message
12800003	input method client error. Possible causes: 1.the edit box is not focused. 2.no edit box is bound to current input method application. 3.ipc failed due to the large amount of data transferred or other reasons.
12800008	input method manager service error. Possible cause: a system error, such as null pointer, IPC exception.
12800009	input method client detached.

Example

import { BusinessError } from '@kit.BasicServicesKit';

let requestKeyboardReason: inputMethod.RequestKeyboardReason = inputMethod.RequestKeyboardReason.MOUSE;

inputMethod.getController().showTextInput(requestKeyboardReason).then(() => {
  console.info('Succeeded in showing text input.');
}).catch((err: BusinessError) => {
  console.error(`Failed to showTextInput, code: ${err.code}, message: ${err.message}`);
});

hideTextInput¹⁰⁺

hideTextInput(callback: AsyncCallback<void>): void

Exits the text editing mode. This API uses an asynchronous callback to return the result.

NOTE

If the soft keyboard is displayed when this API is called, it will be hidden.

Calling this API does not detach the edit box from the input method. The edit box can call showTextInput again to reenter the text editing mode.

System capability: SystemCapability.MiscServices.InputMethodFramework

Parameters

Name	Type	Mandatory	Description
callback	AsyncCallback<void>	Yes	Callback used to return the result. If the operation is successful, err is undefined. Otherwise, err is an error object.

Error codes

For details about the error codes, see Input Method Framework Error Codes.

ID	Error Message
12800003	input method client error. Possible causes: 1.the edit box is not focused. 2.no edit box is bound to current input method application. 3.ipc failed due to the large amount of data transferred or other reasons.
12800008	input method manager service error. Possible cause: a system error, such as null pointer, IPC exception.
12800009	input method client detached.

Example

import { BusinessError } from '@kit.BasicServicesKit';

inputMethod.getController().hideTextInput((err: BusinessError) => {
  if (err) {
    console.error(`Failed to hideTextInput, code: ${err.code}, message: ${err.message}`);
    return;
  }
  console.info('Succeeded in hiding text input.');
});

hideTextInput¹⁰⁺

hideTextInput(): Promise<void>

Exits the text editing mode. This API uses a promise to return the result.

NOTE

If the soft keyboard is displayed when this API is called, it will be hidden.

Calling this API does not detach the edit box from the input method. The edit box can call showTextInput again to reenter the text editing mode.

System capability: SystemCapability.MiscServices.InputMethodFramework

Return value

Type	Description
Promise<void>	Promise that returns no value.

Error codes

For details about the error codes, see Input Method Framework Error Codes.

ID	Error Message
12800003	input method client error. Possible causes: 1.the edit box is not focused. 2.no edit box is bound to current input method application. 3.ipc failed due to the large amount of data transferred or other reasons.
12800008	input method manager service error. Possible cause: a system error, such as null pointer, IPC exception.
12800009	input method client detached.

Example

import { BusinessError } from '@kit.BasicServicesKit';

inputMethod.getController().hideTextInput().then(() => {
  console.info('Succeeded in hiding inputMethod.');
}).catch((err: BusinessError) => {
  console.error(`Failed to hideTextInput, code: ${err.code}, message: ${err.message}`);
})

detach¹⁰⁺

detach(callback: AsyncCallback<void>): void

Detaches the self-drawing component from the input method. This API uses an asynchronous callback to return the result.

System capability: SystemCapability.MiscServices.InputMethodFramework

Parameters

Name	Type	Mandatory	Description
callback	AsyncCallback<void>	Yes	Callback used to return the result. If the operation is successful, err is undefined. Otherwise, err is an error object.

Error codes

For details about the error codes, see Input Method Framework Error Codes.

ID	Error Message
12800003	input method client error. Possible causes: 1.the edit box is not focused. 2.no edit box is bound to current input method application. 3.ipc failed due to the large amount of data transferred or other reasons.
12800008	input method manager service error. Possible cause: a system error, such as null pointer, IPC exception.

Example

import { BusinessError } from '@kit.BasicServicesKit';

inputMethod.getController().detach((err: BusinessError) => {
  if (err) {
    console.error(`Failed to detach, code: ${err.code}, message: ${err.message}`);
    return;
  }
  console.info('Succeeded in detaching inputMethod.');
});

detach¹⁰⁺

detach(): Promise<void>

Detaches the self-drawing component from the input method. This API uses a promise to return the result.

System capability: SystemCapability.MiscServices.InputMethodFramework

Return value

Type	Description
Promise<void>	Promise that returns no value.

Error codes

For details about the error codes, see Input Method Framework Error Codes.

ID	Error Message
12800003	input method client error. Possible causes: 1.the edit box is not focused. 2.no edit box is bound to current input method application. 3.ipc failed due to the large amount of data transferred or other reasons.
12800008	input method manager service error. Possible cause: a system error, such as null pointer, IPC exception.

Example

import { BusinessError } from '@kit.BasicServicesKit';

inputMethod.getController().detach().then(() => {
  console.info('Succeeded in detaching inputMethod.');
}).catch((err: BusinessError) => {
  console.error(`Failed to detach, code: ${err.code}, message: ${err.message}`);
});

setCallingWindow¹⁰⁺

setCallingWindow(windowId: number, callback: AsyncCallback<void>): void

Sets the window to be avoided by the input method. This API uses an asynchronous callback to return the result.

NOTE

After the window ID of the application bound to the input method is passed in the API, the input method window will not cover the window holding the application.

System capability: SystemCapability.MiscServices.InputMethodFramework

Parameters

Name	Type	Mandatory	Description
windowId	number	Yes	Window ID of the application bound to the input method. The value must be an integer.
callback	AsyncCallback<void>	Yes	Callback used to return the result. If the operation is successful, err is undefined. Otherwise, err is an error object.

Error codes

For details about the error codes, see Input Method Framework Error Codes and Universal Error Codes.

ID	Error Message
401	parameter error. Possible causes: 1. Mandatory parameters are left unspecified; 2. Incorrect parameter types.
12800003	input method client error. Possible causes: 1.the edit box is not focused. 2.no edit box is bound to current input method application. 3.ipc failed due to the large amount of data transferred or other reasons.
12800008	input method manager service error. Possible cause: a system error, such as null pointer, IPC exception.
12800009	input method client detached.

Example

import { BusinessError } from '@kit.BasicServicesKit';

let windowId: number = 2000;
inputMethod.getController().setCallingWindow(windowId, (err: BusinessError) => {
  if (err) {
    console.error(`Failed to setCallingWindow, code: ${err.code}, message: ${err.message}`);
    return;
  }
  console.info('Succeeded in setting callingWindow.');
});

setCallingWindow¹⁰⁺

setCallingWindow(windowId: number): Promise<void>

Sets the window to be avoided by the input method. This API uses a promise to return the result.

NOTE

After the window ID of the application bound to the input method is passed in the API, the input method window will not cover the window holding the application.

System capability: SystemCapability.MiscServices.InputMethodFramework

Parameters

Name	Type	Mandatory	Description
windowId	number	Yes	Window ID of the application bound to the input method. The value must be an integer.

Return value

Type	Description
Promise<void>	Promise that returns no value.

Error codes

For details about the error codes, see Input Method Framework Error Codes and Universal Error Codes.

ID	Error Message
401	parameter error. Possible causes: 1. Mandatory parameters are left unspecified; 2. Incorrect parameter types.
12800003	input method client error. Possible causes: 1.the edit box is not focused. 2.no edit box is bound to current input method application. 3.ipc failed due to the large amount of data transferred or other reasons.
12800008	input method manager service error. Possible cause: a system error, such as null pointer, IPC exception.
12800009	input method client detached.

Example

import { BusinessError } from '@kit.BasicServicesKit';

let windowId: number = 2000;
inputMethod.getController().setCallingWindow(windowId).then(() => {
  console.info('Succeeded in setting callingWindow.');
}).catch((err: BusinessError) => {
  console.error(`Failed to setCallingWindow, code: ${err.code}, message: ${err.message}`);
})

updateCursor¹⁰⁺

updateCursor(cursorInfo: CursorInfo, callback: AsyncCallback<void>): void

Updates the cursor information in this edit box. This API can be called to notify the input method of the cursor changes. This API uses an asynchronous callback to return the result.

System capability: SystemCapability.MiscServices.InputMethodFramework

Parameters

Name	Type	Mandatory	Description
cursorInfo	CursorInfo	Yes	Cursor information.
callback	AsyncCallback<void>	Yes	Callback used to return the result. If the operation is successful, err is undefined. Otherwise, err is an error object.

Error codes

For details about the error codes, see Input Method Framework Error Codes and Universal Error Codes.

ID	Error Message
401	parameter error. Possible causes: 1. Mandatory parameters are left unspecified; 2. Incorrect parameter types; 3. Parameter verification failed.
12800003	input method client error. Possible causes: 1.the edit box is not focused. 2.no edit box is bound to current input method application. 3.ipc failed due to the large amount of data transferred or other reasons.
12800008	input method manager service error. Possible cause: a system error, such as null pointer, IPC exception.
12800009	input method client detached.

Example

import { BusinessError } from '@kit.BasicServicesKit';

let cursorInfo: inputMethod.CursorInfo = {
  left: 0,
  top: 0,
  width: 600,
  height: 800
};
inputMethod.getController().updateCursor(cursorInfo, (err: BusinessError) => {
  if (err) {
    console.error(`Failed to updateCursor, code: ${err.code}, message: ${err.message}`);
    return;
  }
  console.info('Succeeded in updating cursorInfo.');
});

updateCursor¹⁰⁺

updateCursor(cursorInfo: CursorInfo): Promise<void>

Updates the cursor information in this edit box. This API can be called to notify the input method of the cursor changes. This API uses a promise to return the result.

System capability: SystemCapability.MiscServices.InputMethodFramework

Parameters

Name	Type	Mandatory	Description
cursorInfo	CursorInfo	Yes	Cursor information.

Return value

Type	Description
Promise<void>	Promise that returns no value.

Error codes

For details about the error codes, see Input Method Framework Error Codes and Universal Error Codes.

ID	Error Message
401	parameter error. Possible causes: 1. Mandatory parameters are left unspecified; 2. Incorrect parameter types; 3. Parameter verification failed.
12800003	input method client error. Possible causes: 1.the edit box is not focused. 2.no edit box is bound to current input method application. 3.ipc failed due to the large amount of data transferred or other reasons.
12800008	input method manager service error. Possible cause: a system error, such as null pointer, IPC exception.
12800009	input method client detached.

Example

import { BusinessError } from '@kit.BasicServicesKit';

let cursorInfo: inputMethod.CursorInfo = {
  left: 0,
  top: 0,
  width: 600,
  height: 800
};
inputMethod.getController().updateCursor(cursorInfo).then(() => {
  console.info('Succeeded in updating cursorInfo.');
}).catch((err: BusinessError) => {
  console.error(`Failed to updateCursor, code: ${err.code}, message: ${err.message}`);
});

changeSelection¹⁰⁺

changeSelection(text: string, start: number, end: number, callback: AsyncCallback<void>): void

Updates the information about the selected text in this edit box, to notify the input method when the selected text content or text range changes. This API uses an asynchronous callback to return the result.

System capability: SystemCapability.MiscServices.InputMethodFramework

Parameters

Name	Type	Mandatory	Description
text	string	Yes	All input text.
start	number	Yes	Start position of the selected text. The value is an integer greater than or equal to 0.
end	number	Yes	End position of the selected text. The value is an integer greater than or equal to 0.
callback	AsyncCallback<void>	Yes	Callback used to return the result. If the operation is successful, err is undefined. Otherwise, err is an error object.

Error codes

For details about the error codes, see Input Method Framework Error Codes and Universal Error Codes.

ID	Error Message
401	parameter error. Possible causes: 1. Mandatory parameters are left unspecified; 2. Incorrect parameter types.
12800003	input method client error. Possible causes: 1.the edit box is not focused. 2.no edit box is bound to current input method application. 3.ipc failed due to the large amount of data transferred or other reasons.
12800008	input method manager service error. Possible cause: a system error, such as null pointer, IPC exception.
12800009	input method client detached.

Example

import { BusinessError } from '@kit.BasicServicesKit';

inputMethod.getController().changeSelection('text', 0, 5, (err: BusinessError) => {
  if (err) {
    console.error(`Failed to changeSelection, code: ${err.code}, message: ${err.message}`);
    return;
  }
  console.info('Succeeded in changing selection.');
});

changeSelection¹⁰⁺

changeSelection(text: string, start: number, end: number): Promise<void>

Updates the information about the selected text in this edit box, to notify the input method when the selected text content or text range changes. This API uses a promise to return the result.

System capability: SystemCapability.MiscServices.InputMethodFramework

Parameters

Name	Type	Mandatory	Description
text	string	Yes	All input text.
start	number	Yes	Start position of the selected text. The value is an integer greater than or equal to 0.
end	number	Yes	End position of the selected text. The value is an integer greater than or equal to 0.

Return value

Type	Description
Promise<void>	Promise that returns no value.

Error codes

For details about the error codes, see Input Method Framework Error Codes and Universal Error Codes.

ID	Error Message
401	parameter error. Possible causes: 1. Mandatory parameters are left unspecified; 2. Incorrect parameter types.
12800003	input method client error. Possible causes: 1.the edit box is not focused. 2.no edit box is bound to current input method application. 3.ipc failed due to the large amount of data transferred or other reasons.
12800008	input method manager service error. Possible cause: a system error, such as null pointer, IPC exception.
12800009	input method client detached.

Example

import { BusinessError } from '@kit.BasicServicesKit';

inputMethod.getController().changeSelection('test', 0, 5).then(() => {
  console.info('Succeeded in changing selection.');
}).catch((err: BusinessError) => {
  console.error(`Failed to changeSelection, code: ${err.code}, message: ${err.message}`);
});

updateAttribute¹⁰⁺

updateAttribute(attribute: InputAttribute, callback: AsyncCallback<void>): void

Updates the attribute information of this edit box. This API uses an asynchronous callback to return the result.

System capability: SystemCapability.MiscServices.InputMethodFramework

Parameters

Name	Type	Mandatory	Description
attribute	InputAttribute	Yes	Attribute information.
callback	AsyncCallback<void>	Yes	Callback used to return the result. If the operation is successful, err is undefined. Otherwise, err is an error object.

Error codes

For details about the error codes, see Input Method Framework Error Codes and Universal Error Codes.

ID	Error Message
401	parameter error. Possible causes: 1. Mandatory parameters are left unspecified; 2. Incorrect parameter types.
12800003	input method client error. Possible causes: 1.the edit box is not focused. 2.no edit box is bound to current input method application. 3.ipc failed due to the large amount of data transferred or other reasons.
12800008	input method manager service error. Possible cause: a system error, such as null pointer, IPC exception.
12800009	input method client detached.

Example

import { BusinessError } from '@kit.BasicServicesKit';

let inputAttribute: inputMethod.InputAttribute = { textInputType: 0, enterKeyType: 1 };
inputMethod.getController().updateAttribute(inputAttribute, (err: BusinessError) => {
  if (err) {
    console.error(`Failed to updateAttribute, code: ${err.code}, message: ${err.message}`);
    return;
  }
  console.info('Succeeded in updating attribute.');
});

updateAttribute¹⁰⁺

updateAttribute(attribute: InputAttribute): Promise<void>

Updates the attribute information of this edit box. This API uses a promise to return the result.

System capability: SystemCapability.MiscServices.InputMethodFramework

Parameters

Name	Type	Mandatory	Description
attribute	InputAttribute	Yes	Attribute information.

Return value

Type	Description
Promise<void>	Promise that returns no value.

Error codes

For details about the error codes, see Input Method Framework Error Codes and Universal Error Codes.

ID	Error Message
401	parameter error. Possible causes: 1. Mandatory parameters are left unspecified; 2. Incorrect parameter types.
12800003	input method client error. Possible causes: 1.the edit box is not focused. 2.no edit box is bound to current input method application. 3.ipc failed due to the large amount of data transferred or other reasons.
12800008	input method manager service error. Possible cause: a system error, such as null pointer, IPC exception.
12800009	input method client detached.

Example

import { BusinessError } from '@kit.BasicServicesKit';

let inputAttribute: inputMethod.InputAttribute = { textInputType: 0, enterKeyType: 1 };
inputMethod.getController().updateAttribute(inputAttribute).then(() => {
  console.info('Succeeded in updating attribute.');
}).catch((err: BusinessError) => {
  console.error(`Failed to updateAttribute, code: ${err.code}, message: ${err.message}`);
});

stopInputSession⁹⁺

stopInputSession(callback: AsyncCallback<boolean>): void

Ends this input session. This API uses an asynchronous callback to return the result.

NOTE

This API can be called only when the edit box is attached to the input method. That is, it can be called to end the input session only when the edit box is focused.

System capability: SystemCapability.MiscServices.InputMethodFramework

Parameters

Name	Type	Mandatory	Description
callback	AsyncCallback<boolean>	Yes	Callback used to return the result. If the operation is successful, err is undefined and data is true. Otherwise, err is an error object.

Error codes

For details about the error codes, see Input Method Framework Error Codes.

ID	Error Message
12800003	input method client error. Possible causes: 1.the edit box is not focused. 2.no edit box is bound to current input method application. 3.ipc failed due to the large amount of data transferred or other reasons.
12800008	input method manager service error. Possible cause: a system error, such as null pointer, IPC exception.

Example

import { BusinessError } from '@kit.BasicServicesKit';

inputMethod.getController().stopInputSession((err: BusinessError, result: boolean) => {
  if (err) {
    console.error(`Failed to stopInputSession, code: ${err.code}, message: ${err.message}`);
    return;
  }
  if (result) {
    console.info('Succeeded in stopping inputSession.');
  } else {
    console.error('Failed to stopInputSession.');
  }
});

stopInputSession⁹⁺

stopInputSession(): Promise<boolean>

Ends this input session. This API uses a promise to return the result.

NOTE

This API can be called only when the edit box is attached to the input method. That is, it can be called to end the input session only when the edit box is focused.

System capability: SystemCapability.MiscServices.InputMethodFramework

Return value

Type	Description
Promise<boolean>	Promise used to return the result. The value true means that the operation is successful, and false means the opposite.

Error codes

For details about the error codes, see Input Method Framework Error Codes.

ID	Error Message
12800003	input method client error. Possible causes: 1.the edit box is not focused. 2.no edit box is bound to current input method application. 3.ipc failed due to the large amount of data transferred or other reasons.
12800008	input method manager service error. Possible cause: a system error, such as null pointer, IPC exception.

Example

import { BusinessError } from '@kit.BasicServicesKit';

inputMethod.getController().stopInputSession().then((result: boolean) => {
  if (result) {
    console.info('Succeeded in stopping inputSession.');
  } else {
    console.error('Failed to stopInputSession.');
  }
}).catch((err: BusinessError) => {
  console.error(`Failed to stopInputSession, code: ${err.code}, message: ${err.message}`);
});

showSoftKeyboard⁹⁺

showSoftKeyboard(callback: AsyncCallback<void>): void

Shows the soft keyboard. This API uses an asynchronous callback to return the result.

NOTE

This API can be called only when the edit box is attached to the input method. That is, it can be called to show the soft keyboard only when the edit box is focused.

Required permissions: ohos.permission.CONNECT_IME_ABILITY (for system applications only)

System capability: SystemCapability.MiscServices.InputMethodFramework

Parameters

Name	Type	Mandatory	Description
callback	AsyncCallback<void>	Yes	Callback used to return the result. If the operation is successful, err is undefined. Otherwise, err is an error object.

Error codes

For details about the error codes, see Input Method Framework Error Codes and Universal Error Codes.

ID	Error Message
201	permissions check fails.
12800003	input method client error. Possible causes: 1.the edit box is not focused. 2.no edit box is bound to current input method application. 3.ipc failed due to the large amount of data transferred or other reasons.
12800008	input method manager service error. Possible cause: a system error, such as null pointer, IPC exception.

Example

import { BusinessError } from '@kit.BasicServicesKit';

inputMethod.getController().showSoftKeyboard((err: BusinessError) => {
  if (!err) {
    console.info('Succeeded in showing softKeyboard.');
  } else {
    console.error(`Failed to show softKeyboard, ${err.code}, message: ${err.message}`);
  }
});

showSoftKeyboard⁹⁺

showSoftKeyboard(): Promise<void>

Shows the soft keyboard. This API uses a promise to return the result.

NOTE

This API can be called only when the edit box is attached to the input method. That is, it can be called to show the soft keyboard only when the edit box is focused.

Required permissions: ohos.permission.CONNECT_IME_ABILITY (for system applications only)

System capability: SystemCapability.MiscServices.InputMethodFramework

Return value

Type	Description
Promise<void>	Promise that returns no value.

Error codes

For details about the error codes, see Input Method Framework Error Codes and Universal Error Codes.

ID	Error Message
201	permissions check fails.
12800003	input method client error. Possible causes: 1.the edit box is not focused. 2.no edit box is bound to current input method application. 3.ipc failed due to the large amount of data transferred or other reasons.
12800008	input method manager service error. Possible cause: a system error, such as null pointer, IPC exception.

Example

import { BusinessError } from '@kit.BasicServicesKit';

inputMethod.getController().showSoftKeyboard().then(() => {
  console.info('Succeeded in showing softKeyboard.');
}).catch((err: BusinessError) => {
  console.error(`Failed to show softKeyboard, code: ${err.code}, message: ${err.message}`);
});

hideSoftKeyboard⁹⁺

hideSoftKeyboard(callback: AsyncCallback<void>): void

Hides the soft keyboard. This API uses an asynchronous callback to return the result.

NOTE

This API can be called only when the edit box is attached to the input method. That is, it can be called to hide the soft keyboard only when the edit box is focused.

Required permissions: ohos.permission.CONNECT_IME_ABILITY (for system applications only)

System capability: SystemCapability.MiscServices.InputMethodFramework

Parameters

Name	Type	Mandatory	Description
callback	AsyncCallback<void>	Yes	Callback used to return the result. If the operation is successful, err is undefined. Otherwise, err is an error object.

Error codes

For details about the error codes, see Input Method Framework Error Codes and Universal Error Codes.

ID	Error Message
201	permissions check fails.
12800003	input method client error. Possible causes: 1.the edit box is not focused. 2.no edit box is bound to current input method application. 3.ipc failed due to the large amount of data transferred or other reasons.
12800008	input method manager service error. Possible cause: a system error, such as null pointer, IPC exception.

Example

import { BusinessError } from '@kit.BasicServicesKit';

inputMethod.getController().hideSoftKeyboard((err: BusinessError) => {
  if (!err) {
    console.info('Succeeded in hiding softKeyboard.');
  } else {
    console.error(`Failed to hide softKeyboard, code: ${err.code}, message: ${err.message}`);
  }
})

hideSoftKeyboard⁹⁺

hideSoftKeyboard(): Promise<void>

Hides the soft keyboard. This API uses a promise to return the result.

NOTE

This API can be called only when the edit box is attached to the input method. That is, it can be called to hide the soft keyboard only when the edit box is focused.

Required permissions: ohos.permission.CONNECT_IME_ABILITY (for system applications only)

System capability: SystemCapability.MiscServices.InputMethodFramework

Return value

Type	Description
Promise<void>	Promise that returns no value.

Error codes

For details about the error codes, see Input Method Framework Error Codes and Universal Error Codes.

ID	Error Message
201	permissions check fails.
12800003	input method client error. Possible causes: 1.the edit box is not focused. 2.no edit box is bound to current input method application. 3.ipc failed due to the large amount of data transferred or other reasons.
12800008	input method manager service error. Possible cause: a system error, such as null pointer, IPC exception.

Example

import { BusinessError } from '@kit.BasicServicesKit';

inputMethod.getController().hideSoftKeyboard().then(() => {
  console.info('Succeeded in hiding softKeyboard.');
}).catch((err: BusinessError) => {
  console.error(`Failed to hide softKeyboard, code: ${err.code}, message: ${err.message}`);
});

sendMessage¹⁵⁺

sendMessage(msgId: string, msgParam?: ArrayBuffer): Promise<void>

Sends the custom communication to the input method application. This API uses a promise to return the result.

NOTE

This API can be called only when the edit box is attached to the input method and enter the edit mode, and the input method application is in full experience mode.

The maximum length of msgId is 256 B, and the maximum length of msgParam is 128 KB.

System capability: SystemCapability.MiscServices.InputMethodFramework

Parameters

Name	Type	Mandatory	Description
msgId	string	Yes	Identifier of the custom data to be sent to the input method application.
msgParam	ArrayBuffer	No	Message body of the custom data to be sent to the input method application.

Return value

Type	Description
Promise<void>	Promise that returns no value.

Error codes

For details about the error codes, see Input Method Framework Error Codes and Universal Error Codes.

ID	Error Message
401	parameter error. Possible causes: 1. Incorrect parameter types. 2. Incorrect parameter length.
12800003	input method client error. Possible causes: 1.the edit box is not focused. 2.no edit box is bound to current input method application. 3.ipc failed due to the large amount of data transferred or other reasons.
12800009	input method client detached.
12800014	the input method is in basic mode.
12800015	the other side does not accept the request.
12800016	input method client is not editable.

Example

import { BusinessError } from '@kit.BasicServicesKit';

let msgId: string = "testMsgId";
let msgParam: ArrayBuffer = new ArrayBuffer(128);
inputMethod.getController().sendMessage(msgId, msgParam).then(() => {
  console.info('Succeeded send message.');
}).catch((err: BusinessError) => {
  console.error(`Failed to send message, code: ${err.code}, message: ${err.message}`);
});

recvMessage¹⁵⁺

recvMessage(msgHandler?: MessageHandler): void

Registers or unregisters MessageHandler.

NOTE

The MessageHandler object is globally unique. After multiple registrations, only the last registered object is valid and retained, and the onTerminated callback of the penultimate registered object is triggered.

If no parameter is set, unregister MessageHandler. Its onTerminated callback will be triggered.

System capability: SystemCapability.MiscServices.InputMethodFramework

Parameters

Name	Type	Mandatory	Description
msgHandler	MessageHandler	No	This object receives custom communication data from the input method application through onMessage and receives a message for terminating the subscription to this object through onTerminated. If no parameter is set, unregister MessageHandler. Its onTerminated callback will be triggered.

Error codes

For details about the error codes, see Input Method Framework Error Codes and Universal Error Codes.

ID	Error Message
401	parameter error. Possible causes: 1. Incorrect parameter types.

Example

import { BusinessError } from '@kit.BasicServicesKit';

let messageHandler: inputMethod.MessageHandler = {
  onTerminated(): void {
    console.info('OnTerminated.');
  },
  onMessage(msgId: string, msgParam?: ArrayBuffer): void {
    console.info('recv message.');
  }
};
let inputMethodController: inputMethod.InputMethodController = inputMethod.getController();
inputMethodController.recvMessage(messageHandler);
// Unregister the MessageHandler.
inputMethodController.recvMessage();

stopInput^(deprecated)

stopInput(callback: AsyncCallback<boolean>): void

Ends this input session. This API uses an asynchronous callback to return the result.

NOTE

This API can be called only when the edit box is attached to the input method. That is, it can be called to end the input session only when the edit box is focused.

This API is supported since API version 6 and deprecated since API version 9. You are advised to use stopInputSession instead.

System capability: SystemCapability.MiscServices.InputMethodFramework

Parameters

Name	Type	Mandatory	Description
callback	AsyncCallback<boolean>	Yes	Callback used to return the result. If the operation is successful, err is undefined and data is true. Otherwise, err is an error object.

Example

import { BusinessError } from '@kit.BasicServicesKit';

inputMethod.getController().stopInput((err: BusinessError, result: boolean) => {
  if (err) {
    console.error(`Failed to stopInput, code: ${err.code}, message: ${err.message}`);
    return;
  }
  if (result) {
    console.info('Succeeded in stopping input.');
  } else {
    console.error('Failed to stopInput.');
  }
});

stopInput^(deprecated)

stopInput(): Promise<boolean>

Ends this input session. This API uses a promise to return the result.

NOTE

This API can be called only when the edit box is attached to the input method. That is, it can be called to end the input session only when the edit box is focused.

This API is supported since API version 6 and deprecated since API version 9. You are advised to use stopInputSession instead.

System capability: SystemCapability.MiscServices.InputMethodFramework

Return value

Type	Description
Promise<boolean>	Promise used to return the result. The value true means that the operation is successful, and false means the opposite.

Example

import { BusinessError } from '@kit.BasicServicesKit';

inputMethod.getController().stopInput().then((result: boolean) => {
  if (result) {
    console.info('Succeeded in stopping input.');
  } else {
    console.error('Failed to stopInput.');
  }
}).catch((err: BusinessError) => {
  console.error(`Failed to stopInput, code: ${err.code}, message: ${err.message}`);
})

on('insertText')¹⁰⁺

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

Enables listening for the text insertion event of the input method. This API uses an asynchronous callback to return the result.

System capability: SystemCapability.MiscServices.InputMethodFramework

Parameters

Name	Type	Mandatory	Description
type	string	Yes	Listening type. The value is fixed at 'insertText'.
callback	(text: string) => void	Yes	Callback used to return the text to be inserted. The application needs to operate the content in the edit box based on the text content returned in the callback.

Error codes

For details about the error codes, see Input Method Framework Error Codes and Universal Error Codes.

ID	Error Message
401	parameter error. Possible causes: 1. Mandatory parameters are left unspecified; 2. Incorrect parameter types; 3. Parameter verification failed.
12800009	input method client detached.

Example

function callback1(text: string): void {
  console.info(`Succeeded in getting callback1, data: ${text}`);
}

function callback2(text: string): void {
  console.info(`Succeeded in getting callback2, data: ${text}`);
}

let inputMethodController: inputMethod.InputMethodController = inputMethod.getController();
// Register a callback.
inputMethodController.on('insertText', callback1);
inputMethodController.on('insertText', callback2);
// Cancel only callback1 of insertText.
inputMethodController.off('insertText', callback1);
// Cancel all callbacks of insertText.
inputMethodController.off('insertText');

off('insertText')¹⁰⁺

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

Disables listening for the text insertion event of the input method.

System capability: SystemCapability.MiscServices.InputMethodFramework

Parameters

Name	Type	Mandatory	Description
type	string	Yes	Listening type. The value is fixed at 'insertText'.
callback	(text: string) => void	No	Callback used for disable listening, which must be the same as that passed by the on API. If this parameter is not specified, listening will be disabled for all callbacks corresponding to the specified type.

Example

import { Callback } from '@kit.BasicServicesKit';

let onInsertTextCallback: Callback<string> = (text: string): void => {
  console.info(`Succeeded in subscribing insertText: ${text}`);
};

let inputMethodController: inputMethod.InputMethodController = inputMethod.getController();
inputMethodController.off('insertText', onInsertTextCallback);
inputMethodController.off('insertText');

on('deleteLeft')¹⁰⁺

on(type: 'deleteLeft', callback: (length: number) => void): void

Enables listening for the leftward delete event. This API uses an asynchronous callback to return the result.

System capability: SystemCapability.MiscServices.InputMethodFramework

Parameters

Name	Type	Mandatory	Description
type	string	Yes	Listening type. The value is fixed at 'deleteLeft'.
callback	(length: number) => void	Yes	Callback used to return the length of the text to be deleted leftward. The application needs to operate the content in the edit box based on the length returned in the callback.

Error codes

For details about the error codes, see Input Method Framework Error Codes and Universal Error Codes.

ID	Error Message
401	parameter error. Possible causes: 1. Mandatory parameters are left unspecified; 2. Incorrect parameter types; 3. Parameter verification failed.
12800009	input method client detached.

Example

inputMethod.getController().on('deleteLeft', (length: number) => {
  console.info(`Succeeded in subscribing deleteLeft, length: ${length}`);
});

off('deleteLeft')¹⁰⁺

off(type: 'deleteLeft', callback?: (length: number) => void): void

Disables listening for the leftward delete event.

System capability: SystemCapability.MiscServices.InputMethodFramework

Parameters

Name	Type	Mandatory	Description
type	string	Yes	Listening type. The value is fixed at 'deleteLeft'.
callback	(length: number) => void	No	Callback used for disable listening, which must be the same as that passed by the on API. If this parameter is not specified, listening will be disabled for all callbacks corresponding to the specified type.

Example

import { Callback } from '@kit.BasicServicesKit';

let onDeleteLeftCallback: Callback<number> = (length: number): void => {
  console.info(`Succeeded in subscribing deleteLeft, length: ${length}`);
};

let inputMethodController: inputMethod.InputMethodController = inputMethod.getController();
inputMethodController.off('deleteLeft', onDeleteLeftCallback);
inputMethodController.off('deleteLeft');

on('deleteRight')¹⁰⁺

on(type: 'deleteRight', callback: (length: number) => void): void

Enables listening for the rightward delete event. This API uses an asynchronous callback to return the result.

System capability: SystemCapability.MiscServices.InputMethodFramework

Parameters

Name	Type	Mandatory	Description
type	string	Yes	Listening type. The value is fixed at 'deleteRight'.
callback	(length: number) => void	Yes	Callback used to return the length of the text to be deleted rightward. The application needs to operate the content in the edit box based on the length returned in the callback.

Error codes

For details about the error codes, see Input Method Framework Error Codes and Universal Error Codes.

ID	Error Message
401	parameter error. Possible causes: 1. Mandatory parameters are left unspecified; 2. Incorrect parameter types; 3. Parameter verification failed.
12800009	input method client detached.

Example

inputMethod.getController().on('deleteRight', (length: number) => {
  console.info(`Succeeded in subscribing deleteRight, length: ${length}`);
});

off('deleteRight')¹⁰⁺

off(type: 'deleteRight', callback?: (length: number) => void): void

Disables listening for the rightward delete event.

System capability: SystemCapability.MiscServices.InputMethodFramework

Parameters

Name	Type	Mandatory	Description
type	string	Yes	Listening type. The value is fixed at deleteRight.
callback	(length: number) => void	No	Callback used for disable listening, which must be the same as that passed by the on API. If this parameter is not specified, listening will be disabled for all callbacks corresponding to the specified type.

Example

import { Callback } from '@kit.BasicServicesKit';

let onDeleteRightCallback: Callback<number> = (length: number): void => {
  console.info(`Succeeded in subscribing deleteRight, length: ${length}`);
};
let inputMethodController: inputMethod.InputMethodController = inputMethod.getController();
inputMethodController.off('deleteRight', onDeleteRightCallback);
inputMethodController.off('deleteRight');

on('sendKeyboardStatus')¹⁰⁺

on(type: 'sendKeyboardStatus', callback: (keyboardStatus: KeyboardStatus) => void): void

Enables listening for the soft keyboard status event of the input method. This API uses an asynchronous callback to return the result.

System capability: SystemCapability.MiscServices.InputMethodFramework

Parameters

Name	Type	Mandatory	Description
type	string	Yes	Listening type. The value is fixed at 'sendKeyboardStatus'.
callback	(keyboardStatus: KeyboardStatus) => void	Yes	Callback used to return the soft keyboard status. The application needs to perform operations based on the soft keyboard state returned in the callback.

Error codes

For details about the error codes, see Input Method Framework Error Codes and Universal Error Codes.

ID	Error Message
401	parameter error. Possible causes: 1. Mandatory parameters are left unspecified; 2. Incorrect parameter types; 3. Parameter verification failed.
12800009	input method client detached.

Example

inputMethod.getController().on('sendKeyboardStatus', (keyboardStatus: inputMethod.KeyboardStatus) => {
  console.info(`Succeeded in subscribing sendKeyboardStatus, keyboardStatus: ${keyboardStatus}`);
});

off('sendKeyboardStatus')¹⁰⁺

off(type: 'sendKeyboardStatus', callback?: (keyboardStatus: KeyboardStatus) => void): void

Disables listening for the input method soft keyboard status event of the input method.

System capability: SystemCapability.MiscServices.InputMethodFramework

Parameters

Name	Type	Mandatory	Description
type	string	Yes	Listening type. The value is fixed at 'sendKeyboardStatus'.
callback	(keyboardStatus: KeyboardStatus) => void	No	Callback used for disable listening. If this parameter is not specified, listening will be disabled for all callbacks corresponding to the specified type.

Example

import { Callback } from '@kit.BasicServicesKit';

let onSendKeyboardStatus: Callback<inputMethod.KeyboardStatus> = (keyboardStatus: inputMethod.KeyboardStatus): void => {
  console.info(`Succeeded in subscribing sendKeyboardStatus, keyboardStatus: ${keyboardStatus}`);
};

let inputMethodController: inputMethod.InputMethodController = inputMethod.getController();
inputMethodController.off('sendKeyboardStatus', onSendKeyboardStatus);
inputMethodController.off('sendKeyboardStatus');

on('sendFunctionKey')¹⁰⁺

on(type: 'sendFunctionKey', callback: (functionKey: FunctionKey) => void): void

Enables listening for the function key sending event of the input method. This API uses an asynchronous callback to return the result.

System capability: SystemCapability.MiscServices.InputMethodFramework

Parameters

Name	Type	Mandatory	Description
type	string	Yes	Listening type. The value is fixed at 'sendFunctionKey'.
callback	(functionKey: FunctionKey) => void	Yes	Callback used to return the function key information sent by the input method. The application needs to perform operations based on the function key information returned in the callback.

Error codes

For details about the error codes, see Input Method Framework Error Codes and Universal Error Codes.

ID	Error Message
401	parameter error. Possible causes: 1. Mandatory parameters are left unspecified; 2. Incorrect parameter types; 3. Parameter verification failed.
12800009	input method client detached.

Example

inputMethod.getController().on('sendFunctionKey', (functionKey: inputMethod.FunctionKey) => {
  console.info(`Succeeded in subscribing sendFunctionKey, functionKey.enterKeyType: ${functionKey.enterKeyType}`);
});

off('sendFunctionKey')¹⁰⁺

off(type: 'sendFunctionKey', callback?: (functionKey: FunctionKey) => void): void

Disables listening for the function key sending event of the input method.

System capability: SystemCapability.MiscServices.InputMethodFramework

Parameters

Name	Type	Mandatory	Description
type	string	Yes	Listening type. The value is fixed at 'sendFunctionKey'.
callback	(functionKey: FunctionKey) => void	No	Callback used for disable listening, which must be the same as that passed by the on API. If this parameter is not specified, listening will be disabled for all callbacks corresponding to the specified type.

Example

import { Callback } from '@kit.BasicServicesKit';

let onSendFunctionKey: Callback<inputMethod.FunctionKey> = (functionKey: inputMethod.FunctionKey): void => {
  console.info(`Succeeded in subscribing sendFunctionKey, functionKey: ${functionKey.enterKeyType}`);
};

let inputMethodController: inputMethod.InputMethodController = inputMethod.getController();
inputMethodController.off('sendFunctionKey', onSendFunctionKey);
inputMethodController.off('sendFunctionKey');

on('moveCursor')¹⁰⁺

on(type: 'moveCursor', callback: (direction: Direction) => void): void

Enables listening for the cursor movement event of the input method. This API uses an asynchronous callback to return the result.

System capability: SystemCapability.MiscServices.InputMethodFramework

Parameters

Name	Type	Mandatory	Description
type	string	Yes	Listening type. The value is fixed at 'moveCursor'.
callback	(direction: Direction) => void	Yes	Callback used to return the cursor movement direction. The application needs to change the cursor position based on the cursor movement direction returned in the callback.

Error codes

For details about the error codes, see Input Method Framework Error Codes and Universal Error Codes.

ID	Error Message
401	parameter error. Possible causes: 1. Mandatory parameters are left unspecified; 2. Incorrect parameter types; 3. Parameter verification failed.
12800009	input method client detached.

Example

inputMethod.getController().on('moveCursor', (direction: inputMethod.Direction) => {
  console.info(`Succeeded in subscribing moveCursor, direction: ${direction}`);
});

off('moveCursor')¹⁰⁺

off(type: 'moveCursor', callback?: (direction: Direction) => void): void

Disables listening for the cursor movement event of the input method.

System capability: SystemCapability.MiscServices.InputMethodFramework

Parameters

Name	Type	Mandatory	Description
type	string	Yes	Listening type. The value is fixed at 'moveCursor'.
callback	(direction: Direction) => void	No	Callback used for disable listening, which must be the same as that passed by the on API. If this parameter is not specified, listening will be disabled for all callbacks corresponding to the specified type.

Example

import { Callback } from '@kit.BasicServicesKit';

let onMoveCursorCallback: Callback<inputMethod.Direction> = (direction: inputMethod.Direction): void => {
  console.info(`Succeeded in subscribing moveCursor, direction: ${direction}`);
};

let inputMethodController: inputMethod.InputMethodController = inputMethod.getController();
inputMethodController.off('moveCursor', onMoveCursorCallback);
inputMethodController.off('moveCursor');

on('handleExtendAction')¹⁰⁺

on(type: 'handleExtendAction', callback: (action: ExtendAction) => void): void

Enables listening for the extended action handling event of the input method. This API uses an asynchronous callback to return the result.

System capability: SystemCapability.MiscServices.InputMethodFramework

Parameters

Name	Type	Mandatory	Description
type	string	Yes	Listening type. The value is fixed at 'handleExtendAction'.
callback	(action: ExtendAction) => void	Yes	Callback used to return the extended action type. The application needs to perform operations based on the extended action type returned in the callback.

Error codes

For details about the error codes, see Input Method Framework Error Codes and Universal Error Codes.

ID	Error Message
401	parameter error. Possible causes: 1. Mandatory parameters are left unspecified; 2. Incorrect parameter types; 3. Parameter verification failed.
12800009	input method client detached.

Example

inputMethod.getController().on('handleExtendAction', (action: inputMethod.ExtendAction) => {
  console.info(`Succeeded in subscribing handleExtendAction, action: ${action}`);
});

off('handleExtendAction')¹⁰⁺

off(type: 'handleExtendAction', callback?: (action: ExtendAction) => void): void

Disables listening for the extended action handling event of the input method. This API uses an asynchronous callback to return the result.

System capability: SystemCapability.MiscServices.InputMethodFramework

Parameters

Name	Type	Mandatory	Description
type	string	Yes	Listening type. The value is fixed at 'handleExtendAction'.
callback	(action: ExtendAction) => void	No	Callback used for disable listening, which must be the same as that passed by the on API. If this parameter is not specified, listening will be disabled for all callbacks corresponding to the specified type.

Example

import { Callback } from '@kit.BasicServicesKit';

let onHandleExtendActionCallback: Callback<inputMethod.ExtendAction> = (action: inputMethod.ExtendAction): void => {
  console.info(`Succeeded in subscribing handleExtendAction, action: ${action}`);
};

let inputMethodController: inputMethod.InputMethodController = inputMethod.getController();
inputMethodController.off('handleExtendAction', onHandleExtendActionCallback);
inputMethodController.off('handleExtendAction');

on('selectByRange')¹⁰⁺

on(type: 'selectByRange', callback: Callback<Range>): void

Enables listening for the select-by-range event. This API uses an asynchronous callback to return the result.

System capability: SystemCapability.MiscServices.InputMethodFramework

Parameters

Name	Type	Mandatory	Description
type	string	Yes	Listening type. The value is fixed at 'selectByRange'.
callback	Callback<Range>	Yes	Callback used to return the range of the text to be selected. The application needs to select the text based on the range returned in the callback.

Error codes

For details about the error codes, see Universal Error Codes.

ID	Error Message
401	parameter error. Possible causes: 1. Mandatory parameters are left unspecified; 2. Incorrect parameter types; 3. Parameter verification failed.

Example

inputMethod.getController().on('selectByRange', (range: inputMethod.Range) => {
  console.info(`Succeeded in subscribing selectByRange: start: ${range.start} , end: ${range.end}`);
});

off('selectByRange')¹⁰⁺

off(type: 'selectByRange', callback?: Callback<Range>): void

Disables listening for the select-by-range event. This API uses an asynchronous callback to return the result.

System capability: SystemCapability.MiscServices.InputMethodFramework

Parameters

Name	Type	Mandatory	Description
type	string	Yes	Listening type. The value is fixed at 'selectByRange'.
callback	Callback<Range>	No	Callback used for disable listening, which must be the same as that passed by the on API. If this parameter is not specified, listening will be disabled for all callbacks corresponding to the specified type.

Example

import { Callback } from '@kit.BasicServicesKit';

let onSelectByRangeCallback: Callback<inputMethod.Range> = (range: inputMethod.Range): void => {
  console.info(`Succeeded in subscribing selectByRange, start: ${range.start} , end: ${range.end}`);
};

let inputMethodController: inputMethod.InputMethodController = inputMethod.getController();
inputMethodController.off('selectByRange', onSelectByRangeCallback);
inputMethodController.off('selectByRange');

on('selectByMovement')¹⁰⁺

on(type: 'selectByMovement', callback: Callback<Movement>): void

Enables listening for the select-by-cursor-movement event. This API uses an asynchronous callback to return the result.

System capability: SystemCapability.MiscServices.InputMethodFramework

Parameters

Name	Type	Mandatory	Description
type	string	Yes	Listening type. The value is fixed at 'selectByMovement'.
callback	Callback<Movement>	Yes	Callback used to return the direction in which the cursor moves. The application needs to select the text based on the direction returned in the callback.

Error codes

For details about the error codes, see Universal Error Codes.

ID	Error Message
401	parameter error. Possible causes: 1. Mandatory parameters are left unspecified; 2. Incorrect parameter types; 3. Parameter verification failed.

Example

inputMethod.getController().on('selectByMovement', (movement: inputMethod.Movement) => {
  console.info('Succeeded in subscribing selectByMovement: direction: ' + movement.direction);
});

off('selectByMovement')¹⁰⁺

off(type: 'selectByMovement', callback?: Callback<Movement>): void

Disables listening for the select-by-cursor-movement event. This API uses an asynchronous callback to return the result.

System capability: SystemCapability.MiscServices.InputMethodFramework

Parameters

Name	Type	Mandatory	Description
type	string	Yes	Listening type. The value is fixed at 'selectByMovement'.
callback	Callback<Movement>	No	Callback used for disable listening, which must be the same as that passed by the on API. If this parameter is not specified, listening will be disabled for all callbacks corresponding to the specified type.

Example

import { Callback } from '@kit.BasicServicesKit';

let onSelectByMovementCallback: Callback<inputMethod.Movement> = (movement: inputMethod.Movement): void => {
  console.info(`Succeeded in subscribing selectByMovement, movement.direction: ${movement.direction}`);
};

let inputMethodController: inputMethod.InputMethodController = inputMethod.getController();
inputMethodController.off('selectByMovement', onSelectByMovementCallback);
inputMethodController.off('selectByMovement');

on('getLeftTextOfCursor')¹⁰⁺

on(type: 'getLeftTextOfCursor', callback: (length: number) => string): void

Enables listening for the event of obtaining the length of text deleted leftward. This API uses an asynchronous callback to return the result.

System capability: SystemCapability.MiscServices.InputMethodFramework

Parameters

Name	Type	Mandatory	Description
type	string	Yes	Listening type. The value is fixed at 'getLeftTextOfCursor'.
callback	(length: number) => string	Yes	Callback used to obtain the text of the specified length deleted leftward.

Error codes

For details about the error codes, see Input Method Framework Error Codes and Universal Error Codes.

ID	Error Message
401	parameter error. Possible causes: 1. Mandatory parameters are left unspecified; 2. Incorrect parameter types; 3. Parameter verification failed.
12800009	input method client detached.

Example

inputMethod.getController().on('getLeftTextOfCursor', (length: number) => {
  console.info(`Succeeded in subscribing getLeftTextOfCursor, length: ${length}`);
  let text: string = "";
  return text;
});

off('getLeftTextOfCursor')¹⁰⁺

off(type: 'getLeftTextOfCursor', callback?: (length: number) => string): void

Disables listening for the event of obtaining the length of text deleted leftward. This API uses an asynchronous callback to return the result.

System capability: SystemCapability.MiscServices.InputMethodFramework

Parameters

Name	Type	Mandatory	Description
type	string	Yes	Listening type. The value is fixed at 'getLeftTextOfCursor'.
callback	(length: number) => string	No	Callback used for disable listening, which must be the same as that passed by the on API. If this parameter is not specified, listening will be disabled for all callbacks corresponding to the specified type.

Example

let getLeftTextOfCursorCallback: (length: number) => string = (length: number): string => {
  console.info(`Succeeded in unsubscribing getLeftTextOfCursor, length: ${length}`);
  let text: string = "";
  return text;
};

let inputMethodController: inputMethod.InputMethodController = inputMethod.getController();
inputMethodController.off('getLeftTextOfCursor', getLeftTextOfCursorCallback);
inputMethodController.off('getLeftTextOfCursor');

on('getRightTextOfCursor')¹⁰⁺

on(type: 'getRightTextOfCursor', callback: (length: number) => string): void

Enables listening for the event of obtaining the length of text deleted rightward. This API uses an asynchronous callback to return the result.

System capability: SystemCapability.MiscServices.InputMethodFramework

Parameters

Name	Type	Mandatory	Description
type	string	Yes	Listening type. The value is fixed at 'getRightTextOfCursor'.
callback	(length: number) => string	Yes	Callback used to obtain the text of the specified length deleted rightward.

Error codes

For details about the error codes, see Input Method Framework Error Codes and Universal Error Codes.

ID	Error Message
401	parameter error. Possible causes: 1. Mandatory parameters are left unspecified; 2. Incorrect parameter types; 3. Parameter verification failed.
12800009	input method client detached.

Example

inputMethod.getController().on('getRightTextOfCursor', (length: number) => {
  console.info(`Succeeded in subscribing getRightTextOfCursor, length: ${length}`);
  let text: string = "";
  return text;
});

off('getRightTextOfCursor')¹⁰⁺

off(type: 'getRightTextOfCursor', callback?: (length: number) => string): void

Disables listening for the event of obtaining the length of text deleted rightward. This API uses an asynchronous callback to return the result.

System capability: SystemCapability.MiscServices.InputMethodFramework

Parameters

Name	Type	Mandatory	Description
type	string	Yes	Listening type. The value is fixed at 'getRightTextOfCursor'.
callback	(length: number) => string	No	Callback used for disable listening, which must be the same as that passed by the on API. If this parameter is not specified, listening will be disabled for all callbacks corresponding to the specified type.

Example

let getRightTextOfCursorCallback: (length: number) => string = (length: number): string => {
  console.info(`Succeeded in unsubscribing getRightTextOfCursor, length: ${length}`);
  let text: string = "";
  return text;
};

let inputMethodController: inputMethod.InputMethodController = inputMethod.getController();
inputMethodController.off('getRightTextOfCursor', getRightTextOfCursorCallback);
inputMethodController.off('getRightTextOfCursor');

on('getTextIndexAtCursor')¹⁰⁺

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

Enables listening for the event of obtaining the index of text at the cursor. This API uses an asynchronous callback to return the result.

System capability: SystemCapability.MiscServices.InputMethodFramework

Parameters

Name	Type	Mandatory	Description
type	string	Yes	Listening type. The value is fixed at 'getTextIndexAtCursor'.
callback	() => number	Yes	Callback used to obtain the index of text at the cursor.

Error codes

For details about the error codes, see Input Method Framework Error Codes and Universal Error Codes.

ID	Error Message
401	parameter error. Possible causes: 1. Mandatory parameters are left unspecified; 2. Incorrect parameter types; 3. Parameter verification failed.
12800009	input method client detached.

Example

inputMethod.getController().on('getTextIndexAtCursor', () => {
  console.info(`Succeeded in subscribing getTextIndexAtCursor.`);
  let index: number = 0;
  return index;
});

off('getTextIndexAtCursor')¹⁰⁺

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

Disables listening for the event of obtaining the index of text at the cursor. This API uses an asynchronous callback to return the result.

System capability: SystemCapability.MiscServices.InputMethodFramework

Parameters

Name	Type	Mandatory	Description
type	string	Yes	Listening type. The value is fixed at 'getTextIndexAtCursor'.
callback	() => number	No	Callback used for disable listening, which must be the same as that passed by the on API. If this parameter is not specified, listening will be disabled for all callbacks corresponding to the specified type.

Example

let getTextIndexAtCursorCallback: () => number = (): number => {
  console.info(`Succeeded in unsubscribing getTextIndexAtCursor.`);
  let index: number = 0;
  return index;
};

let inputMethodController: inputMethod.InputMethodController = inputMethod.getController();
inputMethodController.off('getTextIndexAtCursor', getTextIndexAtCursorCallback);
inputMethodController.off('getTextIndexAtCursor');

on('setPreviewText')¹⁷⁺

on(type: 'setPreviewText', callback: SetPreviewTextCallback): void

Subscribes to the event for text preview operations in an input method application. This API uses an asynchronous callback to return the result.

NOTE

To use the text preview function, you need to subscribe to this event before calling attach and subscribe to this event together with on('finishTextPreview').

System capability: SystemCapability.MiscServices.InputMethodFramework

Parameters

Name	Type	Mandatory	Description
type	string	Yes	Event type, which is 'setPreviewText'.
callback	SetPreviewTextCallback	Yes	Callback used to return the result. It is used to receive and return the text preview.

Error codes

For details about the error codes, see Universal Error Codes.

ID	Error Message
401	Parameter error. Possible causes: 1. Mandatory parameters are left unspecified; 2. Incorrect parameter types; 3. Parameter verification failed.

Example

let setPreviewTextCallback1: inputMethod.SetPreviewTextCallback = (text: string, range: inputMethod.Range): void => {
  console.info(`SetPreviewTextCallback1: Received text - ${text}, Received range - start: ${range.start}, end: ${range.end}`);
};

let setPreviewTextCallback2: inputMethod.SetPreviewTextCallback = (text: string, range: inputMethod.Range): void => {
  console.info(`setPreviewTextCallback2: Received text - ${text}, Received range - start: ${range.start}, end: ${range.end}`);
};

let inputMethodController: inputMethod.InputMethodController = inputMethod.getController();
inputMethodController.on('setPreviewText', setPreviewTextCallback1);
console.info(`SetPreviewTextCallback1 subscribed to setPreviewText`);
inputMethodController.on('setPreviewText', setPreviewTextCallback2);
console.info(`SetPreviewTextCallback2 subscribed to setPreviewText`);
// Cancel only the callback1 of setPreviewText.
inputMethodController.off('setPreviewText', setPreviewTextCallback1);
console.info(`SetPreviewTextCallback1 unsubscribed from setPreviewText`);
// Cancel all callbacks of setPreviewText.
inputMethodController.off('setPreviewText');
console.info(`All callbacks unsubscribed from setPreviewText`);

off('setPreviewText')¹⁷⁺

off(type: 'setPreviewText', callback?: SetPreviewTextCallback): void

Unsubscribes from the event for text preview operations in an input method application. This API uses an asynchronous callback to return the result.

System capability: SystemCapability.MiscServices.InputMethodFramework

Parameters

Name	Type	Mandatory	Description
type	string	Yes	Event type, which is 'setPreviewText'.
callback	SetPreviewTextCallback	No	Callback used for disable listening, which must be the same as that passed by the on API. If this parameter is not specified, listening will be disabled for all callbacks corresponding to the specified type.

Example

let setPreviewTextCallback1: inputMethod.SetPreviewTextCallback = (text: string, range: inputMethod.Range): void => {
  console.info(`SetPreviewTextCallback1: Received text - ${text}, Received range - start: ${range.start}, end: ${range.end}`);
};

let setPreviewTextCallback2: inputMethod.SetPreviewTextCallback = (text: string, range: inputMethod.Range): void => {
  console.info(`setPreviewTextCallback2: Received text - ${text}, Received range - start: ${range.start}, end: ${range.end}`);
};

let inputMethodController: inputMethod.InputMethodController = inputMethod.getController();
inputMethodController.on('setPreviewText', setPreviewTextCallback1);
console.info(`SetPreviewTextCallback1 subscribed to setPreviewText`);
inputMethodController.on('setPreviewText', setPreviewTextCallback2);
console.info(`SetPreviewTextCallback2 subscribed to setPreviewText`);
// Cancel only the callback1 of setPreviewText.
inputMethodController.off('setPreviewText', setPreviewTextCallback1);
console.info(`SetPreviewTextCallback1 unsubscribed from setPreviewText`);
// Cancel all callbacks of setPreviewText.
inputMethodController.off('setPreviewText');
console.info(`All callbacks unsubscribed from setPreviewText`);

on('finishTextPreview')¹⁷⁺

on(type: 'finishTextPreview', callback: Callback<void>): void

Subscribes to the event of finishing text preview. This API uses an asynchronous callback to return the result.

NOTE

To use the text preview function, you need to subscribe to this event before calling attach and subscribe to this event together with on('setPreviewText').

System capability: SystemCapability.MiscServices.InputMethodFramework

Parameters

Name	Type	Mandatory	Description
type	string	Yes	Event type, which is 'finishTextPreview'.
callback	Callback<void>	Yes	Callback used to return the result. It is used to process the logic of finishing text preview. Return type: void

Error codes

For details about the error codes, see Universal Error Codes.

ID	Error Message
401	Parameter error. Possible causes: 1. Mandatory parameters are left unspecified; 2. Incorrect parameter types; 3. Parameter verification failed.

Example

import { Callback } from '@kit.BasicServicesKit';

let finishTextPreviewCallback1: Callback<void> = (): void => {
  console.info(`FinishTextPreviewCallback1: finishTextPreview event triggered`);
};
let finishTextPreviewCallback2: Callback<void> = (): void => {
  console.info(`FinishTextPreviewCallback2: finishTextPreview event triggered`);
};

let inputMethodController: inputMethod.InputMethodController = inputMethod.getController();
inputMethodController.on('finishTextPreview', finishTextPreviewCallback1);
console.info(`FinishTextPreviewCallback1 subscribed to finishTextPreview`);
inputMethodController.on('finishTextPreview', finishTextPreviewCallback2);
console.info(`FinishTextPreviewCallback2 subscribed to finishTextPreview`);
// Cancel only the callback1 of finishTextPreview.
inputMethodController.off('finishTextPreview', finishTextPreviewCallback1);
console.info(`FinishTextPreviewCallback1 unsubscribed from finishTextPreview`);
// Cancel all callbacks of finishTextPreview.
inputMethodController.off('finishTextPreview');
console.info(`All callbacks unsubscribed from finishTextPreview`);

off('finishTextPreview')¹⁷⁺

off(type: 'finishTextPreview', callback?: Callback<void>): void

Unsubscribes from the event of finishing text preview. This API uses an asynchronous callback to return the result.

System capability: SystemCapability.MiscServices.InputMethodFramework

Parameters

Name	Type	Mandatory	Description
type	string	Yes	Event type, which is 'finishTextPreview'.
callback	Callback<void>	No	Callback used for disable listening, which must be the same as that passed by the on API. If this parameter is not specified, listening will be disabled for all callbacks corresponding to the specified type.

Example

import { Callback } from '@kit.BasicServicesKit';

let finishTextPreviewCallback1: Callback<void> = (): void => {
  console.info(`FinishTextPreviewCallback1: finishTextPreview event triggered`);
};
let finishTextPreviewCallback2: Callback<void> = (): void => {
  console.info(`FinishTextPreviewCallback2: finishTextPreview event triggered`);
};

let inputMethodController: inputMethod.InputMethodController = inputMethod.getController();
inputMethodController.on('finishTextPreview', finishTextPreviewCallback1);
console.info(`FinishTextPreviewCallback1 subscribed to finishTextPreview`);
inputMethodController.on('finishTextPreview', finishTextPreviewCallback2);
console.info(`FinishTextPreviewCallback2 subscribed to finishTextPreview`);
// Cancel only the callback1 of finishTextPreview.
inputMethodController.off('finishTextPreview', finishTextPreviewCallback1);
console.info(`FinishTextPreviewCallback1 unsubscribed from finishTextPreview`);
// Cancel all callbacks of finishTextPreview.
inputMethodController.off('finishTextPreview');
console.info(`All callbacks unsubscribed from finishTextPreview`);

InputMethodSetting⁸⁺

In the following API examples, you must first use getSetting to obtain an InputMethodSetting instance, and then call the APIs using the obtained instance.

on('imeChange')⁹⁺

on(type: 'imeChange', callback: (inputMethodProperty: InputMethodProperty, inputMethodSubtype: InputMethodSubtype) => void): void

Enables listening for the input method and subtype change event. This API uses an asynchronous callback to return the result.

System capability: SystemCapability.MiscServices.InputMethodFramework

Parameters

Name	Type	Mandatory	Description
type	string	Yes	Listening type. The value is fixed at 'imeChange'.
callback	(inputMethodProperty: InputMethodProperty, inputMethodSubtype: InputMethodSubtype) => void	Yes	Callback used to return the input method attributes and subtype.

Example

import { InputMethodSubtype } from '@kit.IMEKit';

inputMethod.getSetting()
  .on('imeChange', (inputMethodProperty: inputMethod.InputMethodProperty, inputMethodSubtype: InputMethodSubtype) => {
    console.info(`Succeeded in subscribing imeChange: inputMethodProperty.name: ${inputMethodProperty.name} ` +
      `, inputMethodSubtype.id: ${inputMethodSubtype.id}`);
  });

off('imeChange')⁹⁺

off(type: 'imeChange', callback?: (inputMethodProperty: InputMethodProperty, inputMethodSubtype: InputMethodSubtype) => void): void

Disables listening for the input method and subtype change event. This API uses an asynchronous callback to return the result.

System capability: SystemCapability.MiscServices.InputMethodFramework

Parameters

Name	Type	Mandatory	Description
type	string	Yes	Listening type. The value is fixed at 'imeChange'.
callback	(inputMethodProperty: InputMethodProperty, inputMethodSubtype: InputMethodSubtype) => void	No	Callback used to return the input method attributes and subtype.

Example

inputMethod.getSetting().off('imeChange');

listInputMethodSubtype⁹⁺

listInputMethodSubtype(inputMethodProperty: InputMethodProperty, callback: AsyncCallback<Array<InputMethodSubtype>>): void

Obtains all subtypes of a specified input method. This API uses an asynchronous callback to return the result.

System capability: SystemCapability.MiscServices.InputMethodFramework

Parameters

Name	Type	Mandatory	Description
inputMethodProperty	InputMethodProperty	Yes	Input method.
callback	AsyncCallback<Array<InputMethodSubtype>>	Yes	Callback used to return all subtypes of the specified input method.

Error codes

For details about the error codes, see Input Method Framework Error Codes and Universal Error Codes.

ID	Error Message
401	parameter error. Possible causes: 1. Mandatory parameters are left unspecified; 2. Incorrect parameter types; 3. Parameter verification failed.
12800001	bundle manager error.
12800008	input method manager service error. Possible cause: a system error, such as null pointer, IPC exception.

Example

import { InputMethodSubtype } from '@kit.IMEKit';
import { BusinessError } from '@kit.BasicServicesKit';

let inputMethodProperty: inputMethod.InputMethodProperty = {
  name: 'com.example.keyboard',
  id: 'propertyId',
  packageName: 'com.example.keyboard',
  methodId: 'propertyId',
}
let inputMethodSetting: inputMethod.InputMethodSetting = inputMethod.getSetting();

inputMethodSetting.listInputMethodSubtype(inputMethodProperty,
  (err: BusinessError, data: Array<InputMethodSubtype>) => {
    if (err) {
      console.error(`Failed to listInputMethodSubtype, code: ${err.code}, message: ${err.message}`);
      return;
    }
    console.info('Succeeded in listing inputMethodSubtype.');
  });

listInputMethodSubtype⁹⁺

listInputMethodSubtype(inputMethodProperty: InputMethodProperty): Promise<Array<InputMethodSubtype>>

Obtains all subtypes of a specified input method. This API uses a promise to return the result.

System capability: SystemCapability.MiscServices.InputMethodFramework

Parameters

Name	Type	Mandatory	Description
inputMethodProperty	InputMethodProperty	Yes	Input method.

Return value

Type	Description
Promise<Array<InputMethodSubtype>>	Promise used to return all subtypes of the specified input method.

Error codes

For details about the error codes, see Input Method Framework Error Codes and Universal Error Codes.

ID	Error Message
401	parameter error. Possible causes: 1. Mandatory parameters are left unspecified; 2. Incorrect parameter types; 3. Parameter verification failed.
12800001	bundle manager error.
12800008	input method manager service error. Possible cause: a system error, such as null pointer, IPC exception.

Example

import { InputMethodSubtype } from '@kit.IMEKit';
import { BusinessError } from '@kit.BasicServicesKit';

let inputMethodProperty: inputMethod.InputMethodProperty = {
  name: 'com.example.keyboard',
  id: 'propertyId',
  packageName: 'com.example.keyboard',
  methodId: 'propertyId',
}
let inputMethodSetting: inputMethod.InputMethodSetting = inputMethod.getSetting();

inputMethodSetting.listInputMethodSubtype(inputMethodProperty).then((data: Array<InputMethodSubtype>) => {
  console.info('Succeeded in listing inputMethodSubtype.');
}).catch((err: BusinessError) => {
  console.error(`Failed to listInputMethodSubtype, code: ${err.code}, message: ${err.message}`);
})

listCurrentInputMethodSubtype⁹⁺

listCurrentInputMethodSubtype(callback: AsyncCallback<Array<InputMethodSubtype>>): void

Obtains all subtypes of this input method. This API uses an asynchronous callback to return the result.

System capability: SystemCapability.MiscServices.InputMethodFramework

Parameters

Name	Type	Mandatory	Description
callback	AsyncCallback<Array<InputMethodSubtype>>	Yes	Callback used to return all subtypes of the current input method.

Error codes

For details about the error codes, see Input Method Framework Error Codes and Universal Error Codes.

ID	Error Message
12800001	bundle manager error.
12800008	input method manager service error. Possible cause: a system error, such as null pointer, IPC exception.

Example

import { InputMethodSubtype } from '@kit.IMEKit';
import { BusinessError } from '@kit.BasicServicesKit';

let inputMethodSetting: inputMethod.InputMethodSetting = inputMethod.getSetting();
inputMethodSetting.listCurrentInputMethodSubtype((err: BusinessError, data: Array<InputMethodSubtype>) => {
  if (err) {
    console.error(`Failed to listCurrentInputMethodSubtype, code: ${err.code}, message: ${err.message}`);
    return;
  }
  console.info('Succeeded in listing currentInputMethodSubtype.');
});

listCurrentInputMethodSubtype⁹⁺

listCurrentInputMethodSubtype(): Promise<Array<InputMethodSubtype>>

Obtains all subtypes of this input method. This API uses a promise to return the result.

System capability: SystemCapability.MiscServices.InputMethodFramework

Return value

Type	Description
Promise<Array<InputMethodSubtype>>	Promise used to return all subtypes of the current input method.

Error codes

For details about the error codes, see Input Method Framework Error Codes and Universal Error Codes.

ID	Error Message
12800001	bundle manager error.
12800008	input method manager service error. Possible cause: a system error, such as null pointer, IPC exception.

Example

import { InputMethodSubtype } from '@kit.IMEKit';
import { BusinessError } from '@kit.BasicServicesKit';

let inputMethodSetting: inputMethod.InputMethodSetting = inputMethod.getSetting();

inputMethodSetting.listCurrentInputMethodSubtype().then((data: Array<InputMethodSubtype>) => {
  console.info('Succeeded in listing currentInputMethodSubtype.');
}).catch((err: BusinessError) => {
  console.error(`Failed to listCurrentInputMethodSubtype, code: ${err.code}, message: ${err.message}`);
})

getInputMethods⁹⁺

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

Obtains a list of activated or deactivated input methods. This API uses an asynchronous callback to return the result.

NOTE

An activated input method refers to an input method that is enabled. The default input method is enabled by default. Other input methods can be enabled or disabled as needed.

The list of activated input methods includes the default input method and enabled input methods. The list of deactivated input methods includes all installed input methods except the enabled ones.

System capability: SystemCapability.MiscServices.InputMethodFramework

Parameters

Name	Type	Mandatory	Description
enable	boolean	Yes	Whether to return a list of activated input methods. The value true means to return a list of activated input methods, and false means to return a list of deactivated input methods.
callback	AsyncCallback<Array<InputMethodProperty>>	Yes	Callback used to return a list of activated or deactivated input methods.

Error codes

For details about the error codes, see Input Method Framework Error Codes and Universal Error Codes.

ID	Error Message
401	parameter error. Possible causes: 1. Mandatory parameters are left unspecified; 2. Incorrect parameter types.
12800001	bundle manager error.
12800008	input method manager service error. Possible cause: a system error, such as null pointer, IPC exception.

Example

import { BusinessError } from '@kit.BasicServicesKit';

inputMethod.getSetting().getInputMethods(true, (err: BusinessError, data: Array<inputMethod.InputMethodProperty>) => {
  if (err) {
    console.error(`Failed to getInputMethods, code: ${err.code}, message: ${err.message}`);
    return;
  }
  console.info('Succeeded in getting inputMethods.');
});

getInputMethods⁹⁺

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

Obtains a list of activated or deactivated input methods. This API uses a promise to return the result.

NOTE

An activated input method refers to an input method that is enabled. The default input method is enabled by default. Other input methods can be enabled or disabled as needed.

The list of activated input methods includes the default input method and enabled input methods. The list of deactivated input methods includes all installed input methods except the enabled ones.

System capability: SystemCapability.MiscServices.InputMethodFramework

Parameters

Name	Type	Mandatory	Description
enable	boolean	Yes	Whether to return a list of activated input methods. The value true means to return a list of activated input methods, and false means to return a list of deactivated input methods.

Return value

Type	Description
Promise<Array<InputMethodProperty>>	Promise used to return a list of activated or deactivated input methods.

Error codes

For details about the error codes, see Input Method Framework Error Codes and Universal Error Codes.

ID	Error Message
401	parameter error. Possible causes: 1. Mandatory parameters are left unspecified; 2. Incorrect parameter types.
12800001	bundle manager error.
12800008	input method manager service error. Possible cause: a system error, such as null pointer, IPC exception.

Example

import { BusinessError } from '@kit.BasicServicesKit';

inputMethod.getSetting().getInputMethods(true).then((data: Array<inputMethod.InputMethodProperty>) => {
  console.info('Succeeded in getting inputMethods.');
}).catch((err: BusinessError) => {
  console.error(`Failed to getInputMethods, code: ${err.code}, message: ${err.message}`);
})

getInputMethodsSync¹¹⁺

getInputMethodsSync(enable: boolean): Array<InputMethodProperty>

Obtains a list of activated or deactivated input methods. This API returns the result synchronously.

NOTE

An activated input method refers to an input method that is enabled. The default input method is enabled by default. Other input methods can be enabled or disabled as needed.

The list of activated input methods includes the default input method and enabled input methods. The list of deactivated input methods includes all installed input methods except the enabled ones.

System capability: SystemCapability.MiscServices.InputMethodFramework

Parameters

Name	Type	Mandatory	Description
enable	boolean	Yes	Whether to return a list of activated input methods. The value true means to return a list of activated input methods, and false means to return a list of deactivated input methods.

Return value

Type	Description
Array<InputMethodProperty>	List of activated or deactivated input methods.

Error codes

For details about the error codes, see Input Method Framework Error Codes and Universal Error Codes.

ID	Error Message
401	parameter error. Possible causes: 1. Mandatory parameters are left unspecified; 2. Incorrect parameter types.
12800001	bundle manager error.
12800008	input method manager service error. Possible cause: a system error, such as null pointer, IPC exception.

Example

let imeProperty: Array<inputMethod.InputMethodProperty> = inputMethod.getSetting().getInputMethodsSync(true);

getAllInputMethods¹¹⁺

getAllInputMethods(callback: AsyncCallback<Array<InputMethodProperty>>): void

Obtains a list of all input methods. This API uses an asynchronous callback to return the result.

System capability: SystemCapability.MiscServices.InputMethodFramework

Parameters

Name	Type	Mandatory	Description
callback	AsyncCallback<Array<InputMethodProperty>>	Yes	Callback used to return a list of all input methods.

Error codes

For details about the error codes, see Input Method Framework Error Codes.

ID	Error Message
12800001	bundle manager error.
12800008	input method manager service error. Possible cause: a system error, such as null pointer, IPC exception.

Example

import { BusinessError } from '@kit.BasicServicesKit';

inputMethod.getSetting().getAllInputMethods((err: BusinessError, data: Array<inputMethod.InputMethodProperty>) => {
  if (err) {
    console.error(`Failed to getAllInputMethods, code: ${err.code}, message: ${err.message}`);
    return;
  }
  console.info('Succeeded in getting all inputMethods.');
});

getAllInputMethods¹¹⁺

getAllInputMethods(): Promise<Array<InputMethodProperty>>

Obtains a list of all input methods. This API uses a promise to return the result.

System capability: SystemCapability.MiscServices.InputMethodFramework

Return value

Type	Description
Promise<Array<InputMethodProperty>>	Promise used to return a list of all input methods.

Error codes

For details about the error codes, see Input Method Framework Error Codes and Universal Error Codes.

ID	Error Message
12800001	bundle manager error.
12800008	input method manager service error. Possible cause: a system error, such as null pointer, IPC exception.

Example

import { BusinessError } from '@kit.BasicServicesKit';

inputMethod.getSetting().getAllInputMethods().then((data: Array<inputMethod.InputMethodProperty>) => {
  console.info('Succeeded in getting all inputMethods.');
}).catch((err: BusinessError) => {
  console.error(`Failed to getAllInputMethods, code: ${err.code}, message: ${err.message}`);
})

getAllInputMethodsSync¹¹⁺

getAllInputMethodsSync(): Array<InputMethodProperty>

Obtains a list of all input methods. This API returns the result synchronously.

System capability: SystemCapability.MiscServices.InputMethodFramework

Return value

Type	Description
Array<InputMethodProperty>	List of all input methods.

Error codes

For details about the error codes, see Input Method Framework Error Codes.

ID	Error Message
12800001	bundle manager error.
12800008	input method manager service error. Possible cause: a system error, such as null pointer, IPC exception.

Example

let imeProperty: Array<inputMethod.InputMethodProperty> = inputMethod.getSetting().getAllInputMethodsSync();

showOptionalInputMethods^(deprecated)

showOptionalInputMethods(callback: AsyncCallback<boolean>): void

Displays a dialog box for selecting an input method. This API uses an asynchronous callback to return the result.

NOTE

This API is supported since API version 9 and deprecated since API version 18. You are advised to use InputMethodListDialog instead.

System capability: SystemCapability.MiscServices.InputMethodFramework

Parameters

Name	Type	Mandatory	Description
callback	AsyncCallback<boolean>	Yes	Callback used to return the result. If the operation is successful, err is undefined and data is true. Otherwise, err is an error object.

Error codes

For details about the error codes, see Input Method Framework Error Codes.

ID	Error Message
12800008	input method manager service error. Possible cause: a system error, such as null pointer, IPC exception.

Example

import { BusinessError } from '@kit.BasicServicesKit';

inputMethod.getSetting().showOptionalInputMethods((err: BusinessError, result: boolean) => {
  if (err) {
    console.error(`Failed to showOptionalInputMethods, code: ${err.code}, message: ${err.message}`);
    return;
  }
  if (result) {
    console.info('Succeeded in showing optionalInputMethods.');
  } else {
    console.error(`Failed to showOptionalInputMethods.`);
  }
});

showOptionalInputMethods^(deprecated)

showOptionalInputMethods(): Promise<boolean>

Displays a dialog box for selecting an input method. This API uses a promise to return the result.

NOTE

This API is supported since API version 9 and deprecated since API version 18. You are advised to use InputMethodListDialog instead.

System capability: SystemCapability.MiscServices.InputMethodFramework

Return value

Type	Description
Promise<boolean>	Promise used to return the result. If the operation is successful, err is undefined and data is true. Otherwise, err is an error object.

Error codes

For details about the error codes, see Input Method Framework Error Codes.

ID	Error Message
12800008	input method manager service error. Possible cause: a system error, such as null pointer, IPC exception.

Example

import { BusinessError } from '@kit.BasicServicesKit';

inputMethod.getSetting().showOptionalInputMethods().then((result: boolean) => {
  if (result) {
    console.info('Succeeded in showing optionalInputMethods.');
  } else {
    console.error(`Failed to showOptionalInputMethods.`);
  }
}).catch((err: BusinessError) => {
  console.error(`Failed to showOptionalInputMethods, code: ${err.code}, message: ${err.message}`);
})

listInputMethod^(deprecated)

listInputMethod(callback: AsyncCallback<Array<InputMethodProperty>>): void

Obtains a list of installed input methods. This API uses an asynchronous callback to return the result.

NOTE

This API is supported since API version 8 and deprecated since API version 9. You are advised to use getInputMethods instead.

System capability: SystemCapability.MiscServices.InputMethodFramework

Parameters

Name	Type	Mandatory	Description
callback	AsyncCallback<Array<InputMethodProperty>>	Yes	Callback used to return the list of installed input methods.

Example

import { BusinessError } from '@kit.BasicServicesKit';

inputMethod.getSetting().listInputMethod((err: BusinessError, data: Array<inputMethod.InputMethodProperty>) => {
  if (err) {
    console.error(`Failed to listInputMethod, code: ${err.code}, message: ${err.message}`);
    return;
  }
  console.info('Succeeded in listing inputMethod.');
});

listInputMethod^(deprecated)

listInputMethod(): Promise<Array<InputMethodProperty>>

Obtains a list of installed input methods. This API uses a promise to return the result.

NOTE

This API is supported since API version 8 and deprecated since API version 9. You are advised to use getInputMethods instead.

System capability: SystemCapability.MiscServices.InputMethodFramework

Return value

Type	Description
Promise<Array<InputMethodProperty>>	Promise used to return the list of installed input methods.

Example

import { BusinessError } from '@kit.BasicServicesKit';

inputMethod.getSetting().listInputMethod().then((data: Array<inputMethod.InputMethodProperty>) => {
  console.info('Succeeded in listing inputMethod.');
}).catch((err: BusinessError) => {
  console.error(`Failed to listInputMethod, code: ${err.code}, message: ${err.message}`);
})

displayOptionalInputMethod^(deprecated)

displayOptionalInputMethod(callback: AsyncCallback<void>): void

Displays a dialog box for selecting an input method. This API uses an asynchronous callback to return the result.

NOTE

This API is supported since API version 8 and deprecated since API version 9. You are advised to use InputMethodListDialog instead.

System capability: SystemCapability.MiscServices.InputMethodFramework

Parameters

Name	Type	Mandatory	Description
callback	AsyncCallback<void>	Yes	Callback used to return the result. If the operation is successful, err is undefined. Otherwise, err is an error object.

Example

import { BusinessError } from '@kit.BasicServicesKit';

inputMethod.getSetting().displayOptionalInputMethod((err: BusinessError) => {
  if (err) {
    console.error(`Failed to displayOptionalInputMethod, code: ${err.code}, message: ${err.message}`);
    return;
  }
  console.info('Succeeded in displaying optionalInputMethod.');
});

displayOptionalInputMethod^(deprecated)

displayOptionalInputMethod(): Promise<void>

Displays a dialog box for selecting an input method. This API uses a promise to return the result.

NOTE

This API is supported since API version 8 and deprecated since API version 9. You are advised to use InputMethodListDialog instead.

System capability: SystemCapability.MiscServices.InputMethodFramework

Return value

Type	Description
Promise<void>	Promise that returns no value.

Example

import { BusinessError } from '@kit.BasicServicesKit';

inputMethod.getSetting().displayOptionalInputMethod().then(() => {
  console.info('Succeeded in displaying optionalInputMethod.');
}).catch((err: BusinessError) => {
  console.error(`Failed to displayOptionalInputMethod, code: ${err.code}, message: ${err.message}`);
})

getInputMethodState¹⁵⁺

getInputMethodState(): Promise<EnabledState>

Obtains the input method state. This API uses a promise to return the result.

System capability: SystemCapability.MiscServices.InputMethodFramework

Return value

Type	Description
Promise<EnabledState>	Promise used to return the result. EnabledState.DISABLED indicates that the input method is disabled, EnabledState.BASIC_MODE indicates that the input method is in basic mode, and EnabledState.FULL_EXPERIENCE_MODE indicates that the input method is in full experience mode.

Error codes

For details about the error codes, see Input Method Framework Error Codes.

ID	Error Message
12800004	not an input method application.
12800008	input method manager service error. Possible cause: a system error, such as null pointer, IPC exception.

Example

import { BusinessError } from '@kit.BasicServicesKit';

inputMethod.getSetting().getInputMethodState().then((status: inputMethod.EnabledState) => {
  console.info(`Succeeded in getInputMethodState, status: ${status}`);
}).catch((err: BusinessError) => {
  console.error(`Failed to getInputMethodState, code: ${err.code}, message: ${err.message}`);
})