提交 534e97ce 编写于 作者: H Hollokin

错误码异常处理及输入法子类型API接口资料添加

Signed-off-by: NHollokin <taoyuxin2@huawei.com>
上级 bb190769
......@@ -64,3 +64,76 @@ Extension生命周期回调,在销毁输入法应用时回调,执行资源
}
}
```
## InputMethodExtensionAbility.onRequest()
onRequest(want: Want, startId: number): void;
Extension生命周期回调,在开始执行输入法应用时回调,执行输入法的相关操作。
**系统能力**:SystemCapability.MiscServices.InputMethodFramework
**示例:**
```js
class InputMethodExt extends InputMethodExtensionAbility {
onRequest() {
console.log('onRequest, want:' + want.abilityName + 'startId:' + startId);
}
}
```
## InputMethodExtensionAbility.onConnect()
onConnect(want: Want): rpc.RemoteObject;
Extension生命周期回调,在首次链接输入法ability时回调。
**系统能力**:SystemCapability.MiscServices.InputMethodFramework
**示例:**
```js
class InputMethodExt extends InputMethodExtensionAbility {
onConnect() {
console.log('onConnect, want:' + want.abilityName);
}
}
```
## InputMethodExtensionAbility.onDisconnect()
onDisconnect(want: Want): rpc.RemoteObject;
Extension生命周期回调,在所有链接在输入法extention上的ability都断开的时候回调。
**系统能力**:SystemCapability.MiscServices.InputMethodFramework
**示例:**
```js
class InputMethodExt extends InputMethodExtensionAbility {
onDisconnect() {
console.log('onDisconnect, want:' + want.abilityName);
}
}
```
## InputMethodExtensionAbility.onReconnect()
onReconnect(want: Want): rpc.RemoteObject;
Extension生命周期回调,在一个新的客户端去尝试连接输入法extention的时候回调(先前连接在extention上的客户端全部断开的情况下)。
**系统能力**:SystemCapability.MiscServices.InputMethodFramework
**示例:**
```js
class InputMethodExt extends InputMethodExtensionAbility {
onReconnect() {
console.log('onReconnect, want:' + want.abilityName);
}
}
```
# 输入法子类型
本模块提供对输入法子类型的属性管理
> ![icon-note.gif](public_sys-resources/icon-note.gif) **说明:**
>
> 本模块首批接口从API version 9开始支持。后续版本的新增接口,采用上角标单独标记接口的起始版本。
## InputMethodSubtype
属性值。
**系统能力**:以下各项对应的系统能力均为SystemCapability.MiscServices.InputMethodFramework
| 名称 | 参数类型 | 可读 | 可写 | 必选 | 说明 |
| -------- | -------- | -------- | -------- | -------- | -------- |
| label | string | 是 | 否 | 否 | 输入法子类型的标签。 |
| id | string | 是 | 否 | 是 | 输入法子类型的id。 |
| mode | string | 是 | 否 | 否 | 输入法子类型的模式,包括upper和lower。 |
| locale | string | 是 | 否 | 是 | 输入法子类型的locale。 |
| language | string | 是 | 否 | 是 | 输入法子类型的语言。 |
| icon | string | 是 | 否 | 否 | 输入法子类型的图标。 |
| iconId | number | 是 | 否 | 否 | 输入法子类型的图标id。 |
| extra | object | 是 | 是 | 是 | 输入法子类型的其他信息。 |
\ No newline at end of file
# 输入法框架错误码
## 12800201 权限校验异常
### 错误信息
the permissions check fails.
### 可能原因
该错误码表示未通过权限校验。
### 处理步骤
给应用配置相应的权限
## 12800401 参数校验异常
### 错误信息
the parameters check fails.
### 可能原因
该错误码表示调用接口时传入的参数个数不对或者参数类型不对。
### 处理步骤
修改接口调用时传入的参数个数或者类型
## 12800801 功能支持异常
### 错误信息
call unsupported api.
### 可能原因
该错误码表示调用了不被支持的接口
### 处理步骤
调用其他接口去实现想要的功能
## 12800001 包管理异常
### 错误信息
package manager error.
### 可能原因
该错误码表示
### 处理步骤
## 12800002 输入法引擎异常
### 错误信息
input method engine error
### 可能原因
该错误码表示未能正确获得输入法引擎
### 处理步骤
重新获取输入法引擎
## 12800003 输入法客户端异常
### 错误信息
input method client error
### 可能原因
该错误码表示在输入法客户端发生异常
### 处理步骤
检查修改在输入法客户端的操作
## 12800004 鼠标事件进程异常
### 错误信息
key event processing error
### 可能原因
该错误码表示在鼠标执行过程中发生异常
### 处理步骤
重新执行鼠标事件
## 12800005 配置持久化异常
### 错误信息
configuration persisting error
### 可能原因
该错误码表示获取先前的配置失败
### 处理步骤
重新获取先前配置
## 12800006 输入法控制器异常
### 错误信息
input method controller error
### 可能原因
该错误码表示使用输入法控制器时发生异常
### 处理步骤
重新获取输入法控制器
## 12800007 输入法配置拓展异常
### 错误信息
input method settings extension error
### 可能原因
该错误码表示使用输入法配置执行一些操作时候发生异常
### 处理步骤
重新获取输入法配置
## 12800008 输入法管理服务异常
### 错误信息
input method manager service error
### 可能原因
该错误码表示输入法服务侧发生异常
### 处理步骤
重新获取输入法服务
## 12899999 其他异常
### 错误信息
others error
### 可能原因
该错误码表示除了上述异常之外的未定义异常
### 处理步骤
\ No newline at end of file
Markdown is supported
0% .
You are about to add 0 people to the discussion. Proceed with caution.
先完成此消息的编辑!
想要评论请 注册