From 1a1ff42375056704a46ac6644c11f5f99853832a Mon Sep 17 00:00:00 2001 From: Hollokin Date: Thu, 20 Oct 2022 21:34:23 +0800 Subject: [PATCH] =?UTF-8?q?=E8=BE=93=E5=85=A5=E6=B3=95=E6=A1=86=E6=9E=B6AP?= =?UTF-8?q?I=E8=B5=84=E6=96=99=E8=A1=A5=E5=85=85?= MIME-Version: 1.0 Content-Type: text/plain; charset=UTF-8 Content-Transfer-Encoding: 8bit Signed-off-by: Hollokin --- .../js-apis-inputmethod-extension-ability.md | 12 ++ .../reference/apis/js-apis-inputmethod.md | 36 +++++ .../apis/js-apis-inputmethodengine.md | 4 + .../apis/js-apis-inputmethodsubtype.md | 1 + .../errcode-InputMethodFramework.md | 140 ------------------ .../errcode-inputmethod-framework.md | 107 +++++++++++++ 6 files changed, 160 insertions(+), 140 deletions(-) delete mode 100644 zh-cn/application-dev/reference/errorcodes/errcode-InputMethodFramework.md create mode 100644 zh-cn/application-dev/reference/errorcodes/errcode-inputmethod-framework.md diff --git a/zh-cn/application-dev/reference/apis/js-apis-inputmethod-extension-ability.md b/zh-cn/application-dev/reference/apis/js-apis-inputmethod-extension-ability.md index 811e1c166b..edb7601015 100644 --- a/zh-cn/application-dev/reference/apis/js-apis-inputmethod-extension-ability.md +++ b/zh-cn/application-dev/reference/apis/js-apis-inputmethod-extension-ability.md @@ -28,6 +28,8 @@ onCreate(want: Want): void Extension生命周期回调，在拉起Extension输入法应用时调用，执行初始化输入法应用操作。 +**模型约束**： 此接口仅可在Stage模型下使用。 + **系统能力**：SystemCapability.MiscServices.InputMethodFramework **参数：** @@ -53,6 +55,8 @@ onDestroy(): void Extension生命周期回调，在销毁输入法应用时回调，执行资源清理等操作。 +**模型约束**： 此接口仅可在Stage模型下使用。 + **系统能力**：SystemCapability.MiscServices.InputMethodFramework **示例：** @@ -71,6 +75,8 @@ onRequest(want: Want, startId: number): void Extension生命周期回调，在一个输入法extention开始时回调，执行输入法的相关操作。 +**模型约束**： 此接口仅可在Stage模型下使用。 + **系统能力**：SystemCapability.MiscServices.InputMethodFramework **参数：** @@ -96,6 +102,8 @@ onConnect(want: Want): rpc.RemoteObject Extension生命周期回调，在输入法extention首次连接输入法ability时回调。 +**模型约束**： 此接口仅可在Stage模型下使用。 + **系统能力**：SystemCapability.MiscServices.InputMethodFramework **参数：** @@ -135,6 +143,8 @@ onDisconnect(want: Want): void Extension生命周期回调，在所有连接在输入法extention上的ability都断开的时候回调。 +**模型约束**： 此接口仅可在Stage模型下使用。 + **系统能力**：SystemCapability.MiscServices.InputMethodFramework **参数：** @@ -159,6 +169,8 @@ onReconnect(want: Want): void Extension生命周期回调，在一个新的客户端去尝试连接输入法extention的时候回调（先前连接在extention上的客户端全部断开的情况下）。 +**模型约束**： 此接口仅可在Stage模型下使用。 + **系统能力**：SystemCapability.MiscServices.InputMethodFramework **参数：** 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 c462a94e28..9966184e3a 100644 --- a/zh-cn/application-dev/reference/apis/js-apis-inputmethod.md +++ b/zh-cn/application-dev/reference/apis/js-apis-inputmethod.md @@ -47,6 +47,8 @@ getController(): InputMethodController 获取客户端实例[InputMethodController](#inputmethodcontroller)。 +**模型约束**： 此接口仅可在Stage模型下使用。 + **系统能力**：SystemCapability.MiscServices.InputMethodFramework **返回值：** @@ -67,6 +69,8 @@ getSetting(): InputMethodSetting 获取客户端设置实例[InputMethodSetting](#inputmethodsetting8)。 +**模型约束**： 此接口仅可在Stage模型下使用。 + **系统能力**： SystemCapability.MiscServices.InputMethodFramework **返回值：** @@ -88,6 +92,8 @@ switchInputMethod(target: InputMethodProperty, callback: AsyncCallback<boolea 切换输入法。此接口仅可在Stage模型下使用。使用callback形式返回结果。参数个数为2，否则抛出异常。 +**模型约束**： 此接口仅可在Stage模型下使用。 + **需要权限**： ohos.permission.CONNECT_IME_ABILITY **系统能力**：SystemCapability.MiscServices.InputMethodFramework @@ -124,6 +130,8 @@ switchInputMethod(target: InputMethodProperty): Promise<boolean> 切换输入法。此接口仅可在Stage模型下使用。使用promise形式返回结果。参数个数为1，否则抛出异常。 +**模型约束**： 此接口仅可在Stage模型下使用。 + **需要权限**： ohos.permission.CONNECT_IME_ABILITY **系统能力**： SystemCapability.MiscServices.InputMethodFramework @@ -164,6 +172,8 @@ getCurrentInputMethod(): InputMethodProperty 获取当前输入法扩展应用，提供同步接口，返回当前输入法属性对象。 +**模型约束**： 此接口仅可在Stage模型下使用。 + **系统能力**： SystemCapability.MiscServices.InputMethodFramework **返回值：** @@ -184,6 +194,8 @@ switchCurrentInputMethodSubtype(target: InputMethodSubtype, callback: AsyncCallb 在当前输入法应用内切换子类型。 +**模型约束**： 此接口仅可在Stage模型下使用。 + **需要权限**： ohos.permission.CONNECT_IME_ABILITY **系统能力**： SystemCapability.MiscServices.InputMethodFramework @@ -225,6 +237,8 @@ switchCurrentInputMethodSubtype(target: InputMethodSubtype): Promise<boolean& 在当前输入法应用内切换子类型。此接口仅可在Stage模型下使用。使用promise形式返回结果。参数个数为1，否则抛出异常。 +**模型约束**： 此接口仅可在Stage模型下使用。 + **需要权限**： ohos.permission.CONNECT_IME_ABILITY **系统能力**： SystemCapability.MiscServices.InputMethodFramework @@ -263,6 +277,8 @@ getCurrentInputMethodSubtype(): InputMethodSubtype 获取当前输入法子类型。 +**模型约束**： 此接口仅可在Stage模型下使用。 + **系统能力**： SystemCapability.MiscServices.InputMethodFramework **返回值：** @@ -283,6 +299,8 @@ switchCurrentInputMethodAndSubtype(inputMethodProperty: InputMethodProperty, inp 切换至指定输入法应用的指定子类型，用于跨输入法应用切换子类型。 +**模型约束**： 此接口仅可在Stage模型下使用。 + **需要权限**： ohos.permission.CONNECT_IME_ABILITY **系统能力**： SystemCapability.MiscServices.InputMethodFramework @@ -329,6 +347,8 @@ switchCurrentInputMethodAndSubtype(inputMethodProperty: InputMethodProperty, inp 切换至指定输入法应用的指定子类型，用于跨输入法应用切换子类型。参数个数为1，否则抛出异常。 +**模型约束**： 此接口仅可在Stage模型下使用。 + **需要权限**： ohos.permission.CONNECT_IME_ABILITY **系统能力**： SystemCapability.MiscServices.InputMethodFramework @@ -713,6 +733,8 @@ listInputMethodSubtype(inputMethodProperty: InputMethodProperty, callback: Async 获取指定输入法应用的所有子类型。使用callback形式返回结果。参数个数为2，否则抛出异常。 +**模型约束**： 此接口仅可在Stage模型下使用。 + **系统能力**： SystemCapability.MiscServices.InputMethodFramework **参数：** @@ -748,6 +770,8 @@ listInputMethodSubtype(inputMethodProperty: InputMethodProperty): Promise<Arr 获取指定输入法应用的所有子类型。使用promise形式返回结果。参数个数为1，否则抛出异常。 +**模型约束**： 此接口仅可在Stage模型下使用。 + **系统能力**： SystemCapability.MiscServices.InputMethodFramework **参数：** @@ -786,6 +810,8 @@ listCurrentInputMethodSubtype(callback: AsyncCallback<Array<InputMethodSub 查询当前输入法的子类型列表。使用callback形式返回结果。参数个数为1，否则抛出异常。 +**模型约束**： 此接口仅可在Stage模型下使用。 + **系统能力**： SystemCapability.MiscServices.InputMethodFramework **参数：** @@ -816,6 +842,8 @@ listCurrentInputMethodSubtype(): Promise<Array<InputMethodSubtype>> 查询当前输入法的子类型列表。使用promise形式返回结果。 +**模型约束**： 此接口仅可在Stage模型下使用。 + **系统能力**： SystemCapability.MiscServices.InputMethodFramework **返回值：** @@ -844,6 +872,8 @@ getInputMethods(enable: boolean, callback: AsyncCallback<Array<InputMethod 获取已激活/未激活输入法列表。参数enable取true，返回已激活输入法列表，取false返回未激活输入法列表。使用callback形式返回结果。参数个数为2，否则抛出异常。 +**模型约束**： 此接口仅可在Stage模型下使用。 + **系统能力**： SystemCapability.MiscServices.InputMethodFramework **参数：** @@ -875,6 +905,8 @@ getInputMethods(enable: boolean): Promise<Array<InputMethodProperty>> 获取已激活/未激活输入法列表。参数enable取true返回已激活输入法列表，取false返回未激活输入法列表。使用promise形式返回结果。参数个数为0，否则抛出异常。 +**模型约束**： 此接口仅可在Stage模型下使用。 + **系统能力**： SystemCapability.MiscServices.InputMethodFramework **参数：** @@ -909,6 +941,8 @@ showOptionalInputMethods(callback: AsyncCallback<void>): void 显示输入法选择对话框。使用callback形式返回结果。参数个数为1，否则抛出异常。 +**模型约束**： 此接口仅可在Stage模型下使用。 + **需要权限**： ohos.permission.CONNECT_IME_ABILITY **系统能力**： SystemCapability.MiscServices.InputMethodFramework @@ -941,6 +975,8 @@ showOptionalInputMethods(): Promise<void> 显示输入法选择对话框。使用promise形式返回结果。参数个数为0，否则抛出异常。 +**模型约束**： 此接口仅可在Stage模型下使用。 + **需要权限**： ohos.permission.CONNECT_IME_ABILITY **系统能力**： SystemCapability.MiscServices.InputMethodFramework diff --git a/zh-cn/application-dev/reference/apis/js-apis-inputmethodengine.md b/zh-cn/application-dev/reference/apis/js-apis-inputmethodengine.md index 077054425e..20ce581a27 100644 --- a/zh-cn/application-dev/reference/apis/js-apis-inputmethodengine.md +++ b/zh-cn/application-dev/reference/apis/js-apis-inputmethodengine.md @@ -1336,6 +1336,8 @@ moveCursor(direction: number, callback: AsyncCallback<void>): void 移动光标。使用callback形式返回结果。参数个数为1，否则抛出异常。 +**模型约束**： 此接口仅可在Stage模型下使用。 + **系统能力**： SystemCapability.MiscServices.InputMethodFramework **参数：** @@ -1367,6 +1369,8 @@ moveCursor(direction: number): Promise<void> 移动光标。使用promise形式返回结果。参数个数为1，否则抛出异常。 +**模型约束**： 此接口仅可在Stage模型下使用。 + **系统能力**： SystemCapability.MiscServices.InputMethodFramework **参数：** diff --git a/zh-cn/application-dev/reference/apis/js-apis-inputmethodsubtype.md b/zh-cn/application-dev/reference/apis/js-apis-inputmethodsubtype.md index d3b413849b..6833ef613b 100644 --- a/zh-cn/application-dev/reference/apis/js-apis-inputmethodsubtype.md +++ b/zh-cn/application-dev/reference/apis/js-apis-inputmethodsubtype.md @@ -15,6 +15,7 @@ | 名称 | 参数类型 | 可读 | 可写 | 必选 | 说明 | | -------- | -------- | -------- | -------- | -------- | -------- | | label | string | 是 | 否 | 否 | 输入法子类型的标签。 | +| name | string | 是 | 否 | 是 | 输入法子类型的名字。 | | id | string | 是 | 否 | 是 | 输入法子类型的id。 | | mode | string | 是 | 否 | 否 | 输入法子类型的模式，包括upper和lower。 | | locale | string | 是 | 否 | 是 | 输入法子类型的locale。 | diff --git a/zh-cn/application-dev/reference/errorcodes/errcode-InputMethodFramework.md b/zh-cn/application-dev/reference/errorcodes/errcode-InputMethodFramework.md deleted file mode 100644 index f975dd8350..0000000000 --- a/zh-cn/application-dev/reference/errorcodes/errcode-InputMethodFramework.md +++ /dev/null @@ -1,140 +0,0 @@ -# 输入法框架错误码 - -## 201 权限校验失败 - -### 错误信息 -the permissions check fails. - -### 可能原因 -该错误码特指接口权限校验（permission）不通过的情况，表示调用目标接口时未申请权限。 - -### 处理步骤 -在调用该接口时给应用配置相应的权限 - -## 401 参数检查失败 - -### 错误信息 -the parameters check fails. - -### 可能原因 -该错误码表示napi层eTS/TS/JS接口参数检查失败。 - -### 处理步骤 -按照参数类型、位置，传入合法参数 - -## 801 功能支持异常 - -### 错误信息 -call unsupported api. - -### 可能原因 -该错误码表示该设备不支持此接口，给SysCap不足够具体的api预留的 - -### 处理步骤 -取消调用此接口，或调用替代接口 - -## 12800001 包管理服务异常 - -### 错误信息 -package manager error. - -### 可能原因 -该错误码表示依赖包管理接口来获取输入法及子类型信息的调用失败 - -### 处理步骤 -1. 确认包管理服务正常 -2. 查询包信息接口正常 - -## 12800002 输入法应用异常 - -### 错误信息 -input method engine error - -### 可能原因 -该错误码表示用户调用输入法应用接口失败 - -### 处理步骤 -确认输入法应用进程正常 - -## 12800003 客户端应用异常 - -### 错误信息 -input method client error - -### 可能原因 -该错误码表示客户端应用（编辑控件）调用失败 - -### 处理步骤 -确认客户端应用该进程正常 - -## 12800004 按键事件处理异常 - -### 错误信息 -key event processing error - -### 可能原因 -该错误码表示按键事件分发、消费、监听异常 - -### 处理步骤 -确认窗口按键事件正常消费 - -## 12800005 配置固化失败 - -### 错误信息 -configuration persisting error - -### 可能原因 -该错误码表示保存输入法及子类型设置的调用异常 - -### 处理步骤 -确认输入法系统参数配置文件存在且权限正常（root: root, 644） - -## 12800006 输入法控制器异常 - -### 错误信息 -input method controller error - -### 可能原因 -该错误码表示在获取输入法控制器，并以此进行软键盘的显示、隐藏、输入会话的停止等时发生异常 - -### 处理步骤 -1. 确认输入法管理服务进程正常 -2. 确认获取输入法控制器接口调用正常 -3. 确认输入法应用进程正常 -4. 确认显示隐藏接口调用正常 - -## 12800007 输入法设置器异常 - -### 错误信息 -input method settings extension error - -### 可能原因 -该错误码表示在获取输入法设置器，并以此进行列出输入法应用、列出子类型、列出当前输入法时发生的异常 - -### 处理步骤 -1. 确认输入法管理服务进程正常 -2. 确认输入法应用进程正常 -3. 确认切换输入法接口调用正常 - -## 12800008 输入法管理服务异常 - -### 错误信息 -input method manager service error - -### 可能原因 -该错误码表示由于SA异常导致的调用InputMethodSystemAbility接口异常 - -### 处理步骤 -1. 确认输入法管理服务进程正常 -2. 尝试重启输入法管理服务 - -## 12899999 其他异常 - -### 错误信息 -others error - -### 可能原因 -该错误码表示除了上述异常之外的未定义异常 - -### 处理步骤 -无 \ No newline at end of file diff --git a/zh-cn/application-dev/reference/errorcodes/errcode-inputmethod-framework.md b/zh-cn/application-dev/reference/errorcodes/errcode-inputmethod-framework.md new file mode 100644 index 0000000000..f47e3e7567 --- /dev/null +++ b/zh-cn/application-dev/reference/errorcodes/errcode-inputmethod-framework.md @@ -0,0 +1,107 @@ +# 输入法框架错误码 + +## 12800001 包管理服务异常 + +**错误信息** +Package manager error. + +**可能原因** +该错误码表示依赖包管理接口来获取输入法及子类型信息的调用失败。 + +**处理步骤** +1. 确认包管理服务正常。 +2. 查询包信息接口正常。 + +## 12800002 输入法应用异常 + +**错误信息** +Input method engine error. + +**可能原因** +该错误码表示用户调用输入法应用接口失败。 + +**处理步骤** +确认输入法应用进程正常。 + +## 12800003 客户端应用异常 + +**错误信息** +Input method client error. + +**可能原因** +该错误码表示客户端应用（编辑控件）调用失败。 + +**处理步骤** +确认客户端应用该进程正常。 + +## 12800004 按键事件处理异常 + +**错误信息** +Key event processing error. + +**可能原因** +该错误码表示按键事件分发、消费、监听异常。 + +**处理步骤** +确认窗口按键事件正常消费。 + +## 12800005 配置固化失败 + +**错误信息** +Configuration persisting error. + +**可能原因** +该错误码表示保存输入法及子类型设置的调用异常。 + +**处理步骤** +确认输入法系统参数配置文件存在且权限正常（root: root, 644）。 + +## 12800006 输入法控制器异常 + +**错误信息** +Input method controller error. + +**可能原因** +该错误码表示在获取输入法控制器，并以此进行软键盘的显示、隐藏、输入会话的停止等时发生异常。 + +**处理步骤** +1. 确认输入法管理服务进程正常。 +2. 确认获取输入法控制器接口调用正常。 +3. 确认输入法应用进程正常。 +4. 确认显示隐藏接口调用正常。 + +## 12800007 输入法设置器异常 + +**错误信息** +Input method settings extension error. + +**可能原因** +该错误码表示在获取输入法设置器，并以此进行列出输入法应用、列出子类型、列出当前输入法时发生的异常。 + +**处理步骤** +1. 确认输入法管理服务进程正常。 +2. 确认输入法应用进程正常。 +3. 确认切换输入法接口调用正常。 + +## 12800008 输入法管理服务异常 + +**错误信息** +Input method manager service error. + +**可能原因** +该错误码表示由于SA异常导致的调用InputMethodSystemAbility接口异常。 + +**处理步骤** +1. 确认输入法管理服务进程正常。 +2. 尝试重启输入法管理服务。 + +## 12899999 其他异常 + +**错误信息** +Others error. + +**可能原因** +该错误码表示除了上述异常之外的未定义异常。 + +**处理步骤** +无。 \ No newline at end of file -- GitLab