diff --git a/zh-cn/application-dev/reference/apis/Readme-CN.md b/zh-cn/application-dev/reference/apis/Readme-CN.md index bbcfe3bcfb0a7483b509261b90822e05e9151d66..a565c10d64dd7528f0be6cb5d38f850939fb1195 100755 --- a/zh-cn/application-dev/reference/apis/Readme-CN.md +++ b/zh-cn/application-dev/reference/apis/Readme-CN.md @@ -196,7 +196,7 @@ - [@ohos.hiTraceChain (分布式跟踪)](js-apis-hitracechain.md) - [@ohos.hiTraceMeter (性能打点)](js-apis-hitracemeter.md) - [@ohos.inputmethod (输入法框架)](js-apis-inputmethod.md) - - [@ohos.inputmethodengine (输入法服务)](js-apis-inputmethod-engine.md) + - [@ohos.inputmethodengine (输入法服务)](js-apis-inputmethodengine.md) - [@ohos.inputmethodextensionability (InputMethodExtensionAbility)](js-apis-inputmethod-extension-ability.md) - [@ohos.inputmethodextensioncontext (InputMethodExtensionContext)](js-apis-inputmethod-extension-context.md) - [@ohos.inputmethodsubtype(InputMethodSubtype)](js-apis-inputmethod-subtype.md) diff --git a/zh-cn/application-dev/reference/apis/js-apis-inputmethod.md b/zh-cn/application-dev/reference/apis/js-apis-inputmethod.md index 777e4aaa405cd781f4a651bef45af1899f343604..6167b9481743b914d7185b697727f4bb5caf458e 100644 --- a/zh-cn/application-dev/reference/apis/js-apis-inputmethod.md +++ b/zh-cn/application-dev/reference/apis/js-apis-inputmethod.md @@ -2,7 +2,9 @@ 本模块提供对输入法框架的管理，包括隐藏输入法、查询已安装的输入法列表和显示输入法选择对话框。 -> **说明：**
本模块首批接口从API version 6开始支持。后续版本的新增接口，采用上角标单独标记接口的起始版本。 +>**说明：** +> +>本模块首批接口从API version 6开始支持。后续版本的新增接口，采用上角标单独标记接口的起始版本。 ## 导入模块 @@ -20,18 +22,6 @@ import inputMethod from '@ohos.inputmethod'; | 参数名 | 参数类型 | 常量值 | 说明 | | -------- | -------- | -------- | -------- | | MAX_TYPE_NUM | number | 128 | 可支持的最大输入法个数。 | -| EXCEPTION_PERMISSION9+ | number | 201 | 错误码类型。详见[输入法框架错误码](../errorcodes/errcode-inputmethod-framework.md)，下同 | -| EXCEPTION_PARAMCHECK9+ | number | 401 | 错误码类型 | -| EXCEPTION_UNSUPPORTED9+ | number | 801 | 错误码类型 | -| EXCEPTION_PACKAGEMANAGER9+ | number | 12800001 | 错误码类型 | -| EXCEPTION_IMENGINE9+ | number | 12800002 | 错误码类型 | -| EXCEPTION_IMCLIENT9+ | number | 12800003 | 错误码类型 | -| EXCEPTION_KEYEVENT9+ | number | 12800004 | 错误码类型 | -| EXCEPTION_CONFPERSIST9+ | number | 12800005 | 错误码类型 | -| EXCEPTION_CONTROLLER9+ | number | 12800006 | 错误码类型 | -| EXCEPTION_SETTINGS9+ | number | 12800007 | 错误码类型 | -| EXCEPTION_IMMS9+ | number | 12800008 | 错误码类型 | -| EXCEPTION_OTHERS9+ | number | 12899999 | 错误码类型 | ## InputMethodProperty8+ @@ -41,8 +31,8 @@ import inputMethod from '@ohos.inputmethod'; | 名称 | 参数类型 | 可读 | 可写 | 说明 | | -------- | -------- | -------- | -------- | -------- | -| packageName(deprecated) | string | 是 | 否 | 输入法包名。
**说明：**从API8开始支持，从API9开始废弃，建议使用name替代。 | -| methodId(deprecated) | string | 是 | 否 | 输入法唯一标识。
**说明：**从API8开始支持，从API9开始废弃，建议使用id替代。 | +| packageName(deprecated) | string | 是 | 否 | 输入法包名。
**说明**：从API8开始支持，从API9开始废弃，建议使用name替代。 | +| methodId(deprecated) | string | 是 | 否 | 输入法唯一标识。
**说明**：从API8开始支持，从API9开始废弃，建议使用id替代。 | | name9+ | string | 是 | 否 | 输入法内部名称。 | | id9+ | string | 是 | 否 | 输入法唯一标识。 | | label9+ | string | 是 | 否 | 输入法对外显示名称。 | @@ -465,8 +455,9 @@ getInputMethodController(): InputMethodController 获取客户端实例[InputMethodController](#inputmethodcontroller)。 -> **说明：**
-> 从API version 6开始支持，从API version 9开始废弃, 建议使用[getController()](#inputmethodgetcontroller9)替代 +> **说明：** +> +> 从API version 6开始支持，从API version 9开始废弃, 建议使用[getController()](#inputmethodgetcontroller9)替代。 **系统能力**：SystemCapability.MiscServices.InputMethodFramework @@ -742,7 +733,8 @@ stopInput(callback: AsyncCallback<boolean>): void 隐藏输入法。使用callback异步回调。 -> **说明：**
+> **说明：** +> > 从API version 6开始支持，从API version 9开始废弃, 建议使用[stopInputSession()](#stopinputsession9)替代 **系统能力**：SystemCapability.MiscServices.InputMethodFramework @@ -775,7 +767,8 @@ stopInput(): Promise<boolean> 隐藏输入法。使用promise异步回调。 -> **说明：**
+> **说明：** +> > 从API version 6开始支持，从API version 9开始废弃, 建议使用[stopInputSession()](#stopinputsession9)替代 **系统能力**： SystemCapability.MiscServices.InputMethodFramework @@ -1181,7 +1174,8 @@ listInputMethod(callback: AsyncCallback<Array<InputMethodProperty>>) 查询已安装的输入法列表。使用callback异步回调。 -> **说明：**
+> **说明：** +> > 从API version 8开始支持，从API version 9开始废弃, 建议使用[getInputMethods](#getinputmethods9)替代 **系统能力**： SystemCapability.MiscServices.InputMethodFramework @@ -1210,7 +1204,8 @@ listInputMethod(): Promise<Array<InputMethodProperty>> 查询已安装的输入法列表。使用promise异步回调。 -> **说明：**
+> **说明：** +> > 从API version 8开始支持，从API version 9开始废弃, 建议使用[getInputMethods](#getinputmethods9-1)替代 **系统能力**： SystemCapability.MiscServices.InputMethodFramework @@ -1237,7 +1232,8 @@ displayOptionalInputMethod(callback: AsyncCallback<void>): void 显示输入法选择对话框。使用callback异步回调。 -> **说明：**
+> **说明：** +> > 从API version 8开始支持，从API version 9开始废弃, 建议使用[showOptionalInputMethods()](#showoptionalinputmethods9)替代 **系统能力**： SystemCapability.MiscServices.InputMethodFramework @@ -1266,7 +1262,8 @@ displayOptionalInputMethod(): Promise<void> 显示输入法选择对话框。使用promise异步回调。 -> **说明：**
+> **说明：** +> > 从API version 8开始支持，API version 9开始废弃, 建议使用[showOptionalInputMethods()](#showoptionalinputmethods9-1)替代 **系统能力**： SystemCapability.MiscServices.InputMethodFramework diff --git a/zh-cn/application-dev/reference/apis/js-apis-inputmethod-engine.md b/zh-cn/application-dev/reference/apis/js-apis-inputmethodengine.md similarity index 98% rename from zh-cn/application-dev/reference/apis/js-apis-inputmethod-engine.md rename to zh-cn/application-dev/reference/apis/js-apis-inputmethodengine.md index 4affcd76990333fb0f40947b450db364cb1c4a51..1044ae7dc34ed3334d2a6238be2cb02eac2c01c6 100644 --- a/zh-cn/application-dev/reference/apis/js-apis-inputmethod-engine.md +++ b/zh-cn/application-dev/reference/apis/js-apis-inputmethodengine.md @@ -2,7 +2,9 @@ 本模块的作用是拉通普通应用和输入法应用，功能包括：普通应用通过输入法应用进行文本输入、普通应用与输入法服务绑定、普通应用对输入法应用进行显示请求和隐藏请求、普通应用对输入法应用当前状态进行监听等等。 -> **说明：**
本模块首批接口从API version 8开始支持。后续版本的新增接口，采用上角标单独标记接口的起始版本。 +> **说明：** +> +>本模块首批接口从API version 8开始支持。后续版本的新增接口，采用上角标单独标记接口的起始版本。 ## 导入模块 @@ -96,7 +98,9 @@ getInputMethodEngine(): InputMethodEngine 获取服务端实例。 -> **说明：**
从API version 8开始支持，API version 9开始废弃, 建议使用[getInputMethodAbility()](#inputmethodenginegetinputmethodability9)替代 +> **说明：** +> +>从API version 8开始支持，API version 9开始废弃, 建议使用[getInputMethodAbility()](#inputmethodenginegetinputmethodability9)替代 **系统能力**： SystemCapability.MiscServices.InputMethodFramework @@ -118,7 +122,9 @@ createKeyboardDelegate(): KeyboardDelegate 获取客户端监听实例。 -> **说明：**
从API version 8开始支持，API version 9开始废弃, 建议使用[getKeyboardDelegate()](#inputmethodenginegetkeyboarddelegate9)替代。 +> **说明：** +> +>从API version 8开始支持，API version 9开始废弃, 建议使用[getKeyboardDelegate()](#inputmethodenginegetkeyboarddelegate9)替代。 **系统能力**： SystemCapability.MiscServices.InputMethodFramework @@ -858,7 +864,8 @@ hideKeyboard(callback: AsyncCallback<void>): void 隐藏输入法。使用callback异步回调。 -> **说明：**
+> **说明：** +> > 从API version 8开始支持，API version 9开始废弃, 建议使用[hide](#hide9)替代。 **系统能力**： SystemCapability.MiscServices.InputMethodFramework @@ -887,7 +894,8 @@ hideKeyboard(): Promise<void> 隐藏输入法。使用promise异步回调。 -> **说明：**
+> **说明：** +> > 从API version 8开始支持，API version 9开始废弃, 建议使用[hide](#hide9-1)替代。 **系统能力**： SystemCapability.MiscServices.InputMethodFramework @@ -912,7 +920,7 @@ async function InputMethodEngine() { ## InputClient9+ -下列API示例中都需使用[inputStart](#oninputstart9)回调获取到InputClient实例，再通过此实例调用对应方法。 +下列API示例中都需使用[on('inputStart')](#oninputstart9)回调获取到InputClient实例，再通过此实例调用对应方法。 ### sendKeyFunction9+ @@ -1633,7 +1641,8 @@ async function InputMethodAbility() { ## TextInputClient(deprecated) -> **说明：**
+> **说明：** +> > 从API version 8开始支持，API version 9开始废弃, 建议使用[InputClient](#inputclient9)替代。 下列API示例中都需使用[on('inputStart')](#oninputstart)回调获取到TextInputClient实例，再通过此实例调用对应方法。 @@ -1644,7 +1653,8 @@ getForward(length:number, callback: AsyncCallback<string>): void 获取光标前固定长度的文本。使用callback异步回调。 -> **说明：**
+> **说明：** +> > 从API version 8开始支持，API version 9开始废弃, 建议使用[getForward](#getforward9)替代。 **系统能力**： SystemCapability.MiscServices.InputMethodFramework @@ -1675,7 +1685,8 @@ getForward(length:number): Promise<string> 获取光标前固定长度的文本。使用promise异步回调。 -> **说明：**
+> **说明：** +> > 从API version 8开始支持，API version 9开始废弃, 建议使用[getForward](#getforward9)替代 **系统能力**： SystemCapability.MiscServices.InputMethodFramework @@ -1711,7 +1722,8 @@ getBackward(length:number, callback: AsyncCallback<string>): void 获取光标后固定长度的文本。使用callback异步回调。 -> **说明：**
+> **说明：** +> > 从API version 8开始支持，API version 9开始废弃, 建议使用[getBackward](#getbackward9)替代 **系统能力**： SystemCapability.MiscServices.InputMethodFramework @@ -1742,7 +1754,8 @@ getBackward(length:number): Promise<string> 获取光标后固定长度的文本。使用promise异步回调。 -> **说明：**
+> **说明：** +> > 从API version 8开始支持，API version 9开始废弃, 建议使用[getBackward](#getbackward9)替代 **系统能力**： SystemCapability.MiscServices.InputMethodFramework @@ -1778,7 +1791,8 @@ deleteForward(length:number, callback: AsyncCallback<boolean>): void 删除光标前固定长度的文本。使用callback异步回调。 -> **说明：**
+> **说明：** +> > 从API version 8开始支持，API version 9开始废弃, 建议使用[deleteForward](#deleteforward9)替代 **系统能力**： SystemCapability.MiscServices.InputMethodFramework @@ -1813,7 +1827,8 @@ deleteForward(length:number): Promise<boolean> 删除光标前固定长度的文本。使用promise异步回调。 -> **说明：**
+> **说明：** +> > 从API version 8开始支持，API version 9开始废弃, 建议使用[deleteForward](#deleteforward9)替代 **系统能力**： SystemCapability.MiscServices.InputMethodFramework @@ -1853,7 +1868,8 @@ deleteBackward(length:number, callback: AsyncCallback<boolean>): void 删除光标后固定长度的文本。使用callback异步回调。 -> **说明：**
+> **说明：** +> > 从API version 8开始支持，API version 9开始废弃, 建议使用[deleteBackward](#deletebackward9)替代 **系统能力**： SystemCapability.MiscServices.InputMethodFramework @@ -1888,7 +1904,8 @@ deleteBackward(length:number): Promise<boolean> 删除光标后固定长度的文本。使用callback异步回调。 -> **说明：**
+> **说明：** +> > 从API version 8开始支持，API version 9开始废弃, 建议使用[deleteBackward](#deletebackward9)替代 **系统能力**： SystemCapability.MiscServices.InputMethodFramework @@ -1927,7 +1944,8 @@ sendKeyFunction(action:number, callback: AsyncCallback<boolean>): void 发送功能键。使用callback异步回调。 -> **说明：**
+> **说明：** +> > 从API version 8开始支持，API version 9开始废弃, 建议使用[sendKeyFunction](#sendkeyfunction9)替代 **系统能力**： SystemCapability.MiscServices.InputMethodFramework @@ -1961,7 +1979,8 @@ sendKeyFunction(action:number): Promise<boolean> 发送功能键。使用promise异步回调。 -> **说明：**
+> **说明：** +> > 从API version 8开始支持，API version 9开始废弃, 建议使用[sendKeyFunction](#sendkeyfunction9)替代 **系统能力**： SystemCapability.MiscServices.InputMethodFramework @@ -2000,7 +2019,8 @@ insertText(text:string, callback: AsyncCallback<boolean>): void 插入文本。使用callback异步回调。 -> **说明：**
+> **说明：** +> > 从API version 8开始支持，API version 9开始废弃, 建议使用[insertText](#inserttext9)替代 **系统能力**： SystemCapability.MiscServices.InputMethodFramework @@ -2034,7 +2054,8 @@ insertText(text:string): Promise<boolean> 插入文本。使用promise异步回调。 -> **说明：**
+> **说明：** +> > 从API version 8开始支持，API version 9开始废弃, 建议使用[insertText](#inserttext9)替代 **系统能力**： SystemCapability.MiscServices.InputMethodFramework @@ -2073,7 +2094,8 @@ getEditorAttribute(callback: AsyncCallback<EditorAttribute>): void 获取编辑框属性值。使用callback异步回调。 -> **说明：**
+> **说明：** +> > 从API version 8开始支持，API version 9开始废弃, 建议使用[getEditorAttribute](#geteditorattribute9)替代 **系统能力**： SystemCapability.MiscServices.InputMethodFramework @@ -2103,7 +2125,8 @@ getEditorAttribute(): Promise<EditorAttribute> 获取编辑框属性值。使用promise异步回调。 -> **说明：**
+> **说明：** +> > 从API version 8开始支持，API version 9开始废弃, 建议使用[getEditorAttribute](#geteditorattribute9)替代 **系统能力**： SystemCapability.MiscServices.InputMethodFramework diff --git a/zh-cn/application-dev/reference/errorcodes/errcode-inputmethod-framework.md b/zh-cn/application-dev/reference/errorcodes/errcode-inputmethod-framework.md index c1651057a9acad6c0d0d57d3c77c3b731cb33037..6bdd883169d352976e85e95e268ec2a1ec8e8340 100644 --- a/zh-cn/application-dev/reference/errorcodes/errcode-inputmethod-framework.md +++ b/zh-cn/application-dev/reference/errorcodes/errcode-inputmethod-framework.md @@ -2,164 +2,162 @@ ## 12800001 包管理服务异常 -**错误信息**
+**错误信息** Package manager error. -**错误描述**
+**错误描述** 当依赖包管理接口来获取一些信息失败时，系统会报此错误码。 -**可能原因**
+**可能原因** -在调用getInputMethods、listCurrentInputMethodSubtype等接口获取输入法及子类型的时候，由于依赖包管理QueryExtensionAbilityInfos接口而导致异常时会报错。 +在调用getInputMethods、listCurrentInputMethodSubtype等接口获取输入法及子类型的时候，由于依赖包管理接口而导致异常时会报错。 -**处理步骤**
+**处理步骤** -1. 确认包管理服务是否正常。在日志中搜索401查看是否存在打印found service : 401。 -2. 确认查询包信息接口是否正常。在日志中搜索“QueryExtensionAbilityInfos”，查看相关打印中是否存在失败字样。 -3. 解决方法：无。 +无 ## 12800002 输入法应用异常 -**错误信息**
+**错误信息** Input method engine error. -**错误描述**
+**错误描述** 用户调用输入法应用接口失败时，系统会报此错误码。 -**可能原因**
+**可能原因** 在执行显示键盘、隐藏键盘等操作时，由于输入法应用进程死亡导致操作失败时会报错。 -**处理步骤**
+**处理步骤** 查看输入法应用进程是否正常。例如再次在普通应用（微信、联系人等第三方应用）中点击对话框看键盘能否被正常拉起。 ## 12800003 客户端应用异常 -**错误信息**
+**错误信息** Input method client error. -**错误描述**
+**错误描述** 当三方应用（微信、设置、联系人等）的对话框等编辑控件调用显示键盘、隐藏键盘失败时，系统会报此错误码。 -**可能原因**
+**可能原因** 当三方应用通过点击对话框去调用显示键盘、隐藏键盘功能失败时会报错。 -**处理步骤**
+**处理步骤** 将三方应用后台进程杀死，重新启动三方应用，通过点击对话框等方式触发输入法应用的键盘的显示，若键盘正常显示，则问题解决。 ## 12800004 按键事件处理异常 -**错误信息**
+**错误信息** Key event processing error. -**错误描述**
+**错误描述** 当按键事件异常时，系统会报此错误码。 -**可能原因**
+**可能原因** 按键事件分发、消费、监听异常时会报错。 -**处理步骤**
+**处理步骤** 无 ## 12800005 配置固化失败 -**错误信息**
+**错误信息** Configuration persisting error. -**错误描述**
+**错误描述** 当保存配置失败时，系统会报此错误码。 -**可能原因**
+**可能原因** 当保存输入法及子类型的设置的调用发生异常时会报错。 -**处理步骤**
+**处理步骤** -执行hdc命令setenforce 0关闭SELinux之后，重新执行接口调用，查看功能是否正常。若关闭SELinux之后功能正常，则确认输入法应用是否配置在系统参数配置文件中，详见[系统参数配置指导](https://gitee.com/openharmony/docs/blob/master/zh-cn/device-dev/subsystems/subsys-boot-init-sysparam.md)。 +执行hdc命令setenforce 0关闭SELinux之后，重新执行接口调用，查看功能是否正常。若关闭SELinux之后功能正常，则确认开发的输入法应用是否配置在系统参数配置文件中，详见[系统参数配置指导](https://gitee.com/openharmony/docs/blob/master/zh-cn/device-dev/subsystems/subsys-boot-init-sysparam.md)。 ## 12800006 输入法控制器异常 -**错误信息**
+**错误信息** Input method controller error. -**错误描述**
+**错误描述** 当获取到输入法控制器失败时，系统会报此错误码。 -**可能原因**
+**可能原因** 在调用getCotroller接口获取输入法控制器InputMethodController时发生异常时会报错。 -**处理步骤**
+**处理步骤** 无。 ## 12800007 输入法设置器异常 -**错误信息**
+**错误信息** Input method settings extension error. -**错误描述**
+**错误描述** 当获取到输入法设置器发生错误时，系统会报此错误码。 -**可能原因**
+**可能原因** 在调用getSetting接口获取输入法设置器InputMethodSetting时发生异常时会报错。 -**处理步骤**
+**处理步骤** 无。 ## 12800008 输入法管理服务异常 -**错误信息**
+**错误信息** Input method manager service error. -**错误描述**
+**错误描述** 获取输入法管理服务异常时，系统会报此错误码。 -**可能原因**
+**可能原因** 当调用[输入法框架](../apis/js-apis-inputmethod.md)中的任何接口都有可能由于依赖输入法管理服务，而服务找不到时发生此异常。 -**处理步骤**
+**处理步骤** 通过ps -A|grep inputmethod查看是否存在输入法服务的进程号，如果存在，则服务正常。 ## 12899999 其他异常 -**错误信息**
+**错误信息** Others error. -**错误描述**
+**错误描述** 发生除以上几种类型的错误之外的其他类型错误时，系统会报此错误码。 -**可能原因**
+**可能原因** 发生了除了上述异常之外的未定义异常时会报错。 -**处理步骤**
+**处理步骤** 无。 \ No newline at end of file