From 33af5f3cbea0f8b58c53f6efad996aee8f70590b Mon Sep 17 00:00:00 2001 From: Hollokin Date: Fri, 28 Oct 2022 15:37:47 +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=E4=BF=AE=E6=94=B9?= 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 | 5 - .../js-apis-inputmethod-extension-context.md | 165 +----------------- .../reference/apis/js-apis-inputmethod.md | 8 +- .../errcode-inputmethod-framework.md | 64 +++++-- 4 files changed, 61 insertions(+), 181 deletions(-) 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 ddb102e963..af6975561b 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 @@ -5,7 +5,6 @@ InputMethodExtensionAbility模块，提供生态输入法应用开发者通过In > **说明：** > > - 本模块首批接口从API version 9开始支持。后续版本的新增接口，采用上角标单独标记接口的起始版本。 -> - 本模块接口仅可在Stage模型下使用。 ## 导入模块 @@ -28,8 +27,6 @@ onCreate(want: Want): void Extension生命周期回调，在拉起Extension输入法应用时调用，执行初始化输入法应用操作。 -**模型约束**： 此接口仅可在Stage模型下使用。 - **系统能力**：SystemCapability.MiscServices.InputMethodFramework **参数：** @@ -55,8 +52,6 @@ onDestroy(): void Extension生命周期回调，在销毁输入法应用时回调，执行资源清理等操作。 -**模型约束**： 此接口仅可在Stage模型下使用。 - **系统能力**：SystemCapability.MiscServices.InputMethodFramework **示例：** diff --git a/zh-cn/application-dev/reference/apis/js-apis-inputmethod-extension-context.md b/zh-cn/application-dev/reference/apis/js-apis-inputmethod-extension-context.md index a86630a7a9..ca7f615bcb 100644 --- a/zh-cn/application-dev/reference/apis/js-apis-inputmethod-extension-context.md +++ b/zh-cn/application-dev/reference/apis/js-apis-inputmethod-extension-context.md @@ -7,7 +7,6 @@ InputMethodExtensionContext模块提供InputMethodExtensionAbility具有的能 > **说明：** > > - 本模块首批接口从API version 9开始支持。后续版本的新增接口，采用上角标单独标记接口的起始版本。 -> - 本模块接口仅可在Stage模型下使用。 ## 导入模块 @@ -28,171 +27,19 @@ class MainAbility extends InputMethodExtensionAbility { } ``` -## InputMethodExtensionContext.startAbility - -startAbility(want: Want, callback: AsyncCallback<void>): void; - -启动Ability。使用callback异步回调。 - -**模型约束**： 此接口仅可在Stage模型下使用。 - -**系统能力**：SystemCapability.MiscServices.InputMethodFramework - -**参数：** - -| 参数名 | 类型 | 必填 | 说明 | -| -------- | -------- | -------- | -------- | -| want | [Want](js-apis-application-Want.md) | 是 | Want类型参数，传入需要启动的ability的信息，如ability名称，包名等。 | -| callback | AsyncCallback<void> | 是 | 回调函数。当启动Ability成功，err为undefined；否则为错误对象。 | - -**示例：** - -```ts -let want = { - 'bundleName': 'com.example.myapp', - 'abilityName': 'MyAbility' -}; -this.context.startAbility(want, (err) => { - console.log('startAbility result:' + JSON.stringify(err)); -}); -``` - -## InputMethodExtensionContext.startAbility - -startAbility(want: Want, options?: StartOptions): Promise\; - -启动Ability，包含Want类型参数，以及可选填的StartOption类型参数。通过Promise方法返回结果。 - -**模型约束**： 此接口仅可在Stage模型下使用。 - -**系统能力**：SystemCapability.MiscServices.InputMethodFramework - -**参数：** - -| 参数名 | 类型 | 必填 | 说明 | -| -------- | -------- | -------- | -------- | -| want | [Want](js-apis-application-Want.md) | 是 | Want类型参数，传入需要启动的ability的信息，如ability名称，包名等。 | -| options | [StartOptions](js-apis-application-StartOptions.md) | 否 | 启动Ability所携带的参数。 | - -**返回值：** - - | 类型 | 说明 | - | -------- | -------- | - | Promise<void> | 返回一个Promise，包含接口的结果。 | - -**示例：** - -```ts -let want = { - 'bundleName': 'com.example.myapp', - 'abilityName': 'MyAbility' -}; -this.context.startAbility(want).then((data) => { - console.log('success:' + JSON.stringify(data)); -}).catch((error) => { - console.log('failed:' + JSON.stringify(error)); -}); -``` - -## InputMethodExtensionContext.startAbility - -startAbility(want: Want, options: StartOptions, callback: AsyncCallback<void>): void - -启动Ability。使用callback异步回调。 - -**模型约束**： 此接口仅可在Stage模型下使用。 - -**系统能力**：SystemCapability.MiscServices.InputMethodFramework - -**参数：** - -| 参数名 | 类型 | 必填 | 说明 | -| -------- | -------- | -------- | -------- | -| want | [Want](js-apis-application-Want.md) | 是 | 启动Ability的want信息。 | -| options | [StartOptions](js-apis-application-StartOptions.md) | 是 | 启动Ability所携带的参数。 | -| callback | AsyncCallback<void> | 是 | 回调函数。当启动Ability成功，err为undefined；否则为错误对象。| - -**示例：** - -```ts -let want = { - 'deviceId': '', - 'bundleName': 'com.extreme.test', - 'abilityName': 'MainAbility' -}; -let options = { - windowMode: 0, -}; -this.context.startAbility(want, options, (error) => { - console.log('error.code = ' + error.code) -}) -``` - -## InputMethodExtensionContext.terminateSelf - -terminateSelf(callback: AsyncCallback<void>): void; - -停止输入法应用自身。使用callback异步回调。 - -**模型约束**： 此接口仅可在Stage模型下使用。 - -**系统能力**：SystemCapability.MiscServices.InputMethodFramework - -**参数：** - -| 参数名 | 类型 | 必填 | 说明 | -| -------- | ------------------------- | ---- | -------------------------------------- | -| callback | AsyncCallback<void> | 是 | 回调函数。当启动Ability成功，err为undefined；否则为错误对象。 | - -**示例：** - -```ts -this.context.terminateSelf((err) => { - console.log('terminateSelf result:' + JSON.stringify(err)); -}); -``` - -## InputMethodExtensionContext.terminateSelf - -terminateSelf(): Promise<void>; - -停止输入法应用自身。通过Promise返回结果。 - -**模型约束**： 此接口仅可在Stage模型下使用。 - -**系统能力**：SystemCapability.MiscServices.InputMethodFramework - -**返回值：** - -| 类型 | 说明 | -| -------- | -------- | -| Promise<void> | Promise对象，无返回结果的Promise对象。 | - -**示例：** - -```ts -this.context.terminateSelf().then((data) => { - console.log('success:' + JSON.stringify(data)); -}).catch((error) => { - console.log('failed:' + JSON.stringify(error)); -}); -``` - ## InputMethodExtensionContext.destroy9+ destroy(callback: AsyncCallback\): void 停止输入法应用自身。使用callback异步回调。 -**模型约束**： 此接口仅可在Stage模型下使用。 - **系统能力**：SystemCapability.MiscServices.InputMethodFramework **参数：** -| 参数名 | 类型 | 必填 | 说明 | -| -------- | ------------------------- | ---- | -------------------------------------- | -| callback | AsyncCallback<void> | 是 | 回调函数。当启动Ability成功，err为undefined；否则为错误对象。 | +| 参数名 | 类型 | 必填 | 说明 | +| -------- | -------------------- | ---- | ------------------------------------------------------------ | +| callback | AsyncCallback\ | 是 | 回调函数。当启动Ability成功，err为undefined；否则为错误对象。 | **示例：** @@ -204,19 +51,17 @@ this.context.destroy((err) => { ## InputMethodExtensionContext.destroy9+ -destroy(): Promise<void>; +destroy(): Promise { + InputMethodSetting.listInputMethodSubtype(inputMethodProperty).then((data) => { console.info('listInputMethodSubtype success'); }).catch((err) => { console.error('listInputMethodSubtype err: ' + JSON.stringify(err)); 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 f47e3e7567..e6ae8b8b6a 100644 --- a/zh-cn/application-dev/reference/errorcodes/errcode-inputmethod-framework.md +++ b/zh-cn/application-dev/reference/errorcodes/errcode-inputmethod-framework.md @@ -5,20 +5,30 @@ **错误信息** Package manager error. +**错误描述** + +当依赖包管理接口来获取一些信息失败时，系统会报此错误码。 + **可能原因** -该错误码表示依赖包管理接口来获取输入法及子类型信息的调用失败。 +依赖包管理接口来获取输入法及子类型信息失败时会报错。 **处理步骤** -1. 确认包管理服务正常。 -2. 查询包信息接口正常。 + +1. 确认包管理服务是否正常。 +2. 确认查询包信息接口是否正常。 ## 12800002 输入法应用异常 **错误信息** Input method engine error. +**错误描述** + +用户调用输入法应用接口失败时，系统会报此错误码。 + **可能原因** -该错误码表示用户调用输入法应用接口失败。 + +输入法应用进程死亡时会报错 **处理步骤** 确认输入法应用进程正常。 @@ -28,19 +38,27 @@ Input method engine error. **错误信息** Input method client error. +**错误描述** + +当客户端应用（编辑控件）调用失败时，系统会报此错误码。 + **可能原因** -该错误码表示客户端应用（编辑控件）调用失败。 +执行显示键盘或者隐藏键盘等操作时，找不到客户端的情况下会报错。 **处理步骤** -确认客户端应用该进程正常。 +确认客户端应用进程正常。 ## 12800004 按键事件处理异常 **错误信息** Key event processing error. +**错误描述** + +当按键事件异常时，系统会报此错误码。 + **可能原因** -该错误码表示按键事件分发、消费、监听异常。 +按键事件分发、消费、监听异常时会报错。 **处理步骤** 确认窗口按键事件正常消费。 @@ -50,8 +68,12 @@ Key event processing error. **错误信息** Configuration persisting error. +**错误描述** + +当保存配置失败时，系统会报此错误码。 + **可能原因** -该错误码表示保存输入法及子类型设置的调用异常。 +当保存输入法及子类型的设置的调用发生异常时会报错。 **处理步骤** 确认输入法系统参数配置文件存在且权限正常（root: root, 644）。 @@ -61,8 +83,12 @@ Configuration persisting error. **错误信息** Input method controller error. +**错误描述** + +当获取到输入法控制器，并基于此进行一些操作发生错误时，系统会报此错误码。 + **可能原因** -该错误码表示在获取输入法控制器，并以此进行软键盘的显示、隐藏、输入会话的停止等时发生异常。 +进行软键盘的显示、隐藏、输入会话的停止等操作发生异常时会报错。 **处理步骤** 1. 确认输入法管理服务进程正常。 @@ -75,10 +101,15 @@ Input method controller error. **错误信息** Input method settings extension error. +**错误描述** + +当获取到输入法设置器，并基于此进行一些操作发生错误时，系统会报此错误码。 + **可能原因** -该错误码表示在获取输入法设置器，并以此进行列出输入法应用、列出子类型、列出当前输入法时发生的异常。 +列出输入法应用、列出子类型、列出当前输入法应用等发生异常时会报错。 **处理步骤** + 1. 确认输入法管理服务进程正常。 2. 确认输入法应用进程正常。 3. 确认切换输入法接口调用正常。 @@ -88,10 +119,15 @@ Input method settings extension error. **错误信息** Input method manager service error. +**错误描述** + +获取输入法管理服务异常时，系统会报此错误码。 + **可能原因** -该错误码表示由于SA异常导致的调用InputMethodSystemAbility接口异常。 +由于SA异常导致的调用InputMethodSystemAbility接口异常时会报错。 **处理步骤** + 1. 确认输入法管理服务进程正常。 2. 尝试重启输入法管理服务。 @@ -100,8 +136,12 @@ Input method manager service error. **错误信息** Others error. +**错误描述** + +发生除以上几种类型的错误之外的其他类型错误时，系统会报此错误码。 + **可能原因** -该错误码表示除了上述异常之外的未定义异常。 +发生了除了上述异常之外的未定义异常时会报错。 **处理步骤** 无。 \ No newline at end of file -- GitLab