Skip to content

D
Docs

OpenHarmony / Docs
1 年多 前同步成功

通知 159
Star 292
Fork 28
D
Docs
提交 47a3a514 编写于 作者: H Hollokin
浏览文件
操作

输入法错误码相关API资料补充 

Signed-off-by: NHollokin <taoyuxin2@huawei.com>
上级 5f45cefd
展开全部 隐藏空白更改
内联 并排
Showing with 298 addition and 224 deletion
zh-cn/application-dev/reference/apis/js-apis-inputmethod.md
浏览文件 @ 47a3a514
...@@ -32,8 +32,8 @@ import inputMethod from '@ohos.inputmethod'; ...@@ -32,8 +32,8 @@ import inputMethod from '@ohos.inputmethod';
| 名称 | 参数类型 | 可读 | 可写 | 说明 | | 名称 | 参数类型 | 可读 | 可写 | 说明 |
| -------- | -------- | -------- | -------- | -------- | | -------- | -------- | -------- | -------- | -------- |
| packageName<sup>deprecated</sup> | string | 是 | 否 | 包名。 | | packageName<sup>(deprecated)</sup> | string | 是 | 否 | 包名。 |
| methodId<sup>deprecated</sup> | string | 是 | 否 | Ability名。 | | methodId<sup>(deprecated)</sup> | string | 是 | 否 | Ability名。 |
| name<sup>9+</sup> | string | 是 | 否 | 包名，非必填项。 | | name<sup>9+</sup> | string | 是 | 否 | 包名，非必填项。 |
| id<sup>9+</sup> | string | 是 | 否 | Ability名，非必填项。 | | id<sup>9+</sup> | string | 是 | 否 | Ability名，非必填项。 |
| label<sup>9+</sup> | string | 是 | 否 | 输入法标签，非必填项。| | label<sup>9+</sup> | string | 是 | 否 | 输入法标签，非必填项。|
...@@ -41,7 +41,7 @@ import inputMethod from '@ohos.inputmethod'; ...@@ -41,7 +41,7 @@ import inputMethod from '@ohos.inputmethod';
| iconId<sup>9+</sup> | number | 是 | 否 | 输入法图标id，非必填项。 | | iconId<sup>9+</sup> | number | 是 | 否 | 输入法图标id，非必填项。 |
| extra<sup>9+</sup> | object | 是 | 否 | 输入法其他信息，非必填项。 | | extra<sup>9+</sup> | object | 是 | 否 | 输入法其他信息，非必填项。 |
## inputMethod.getInputMethodController<sup>deprecated</sup> ## inputMethod.getInputMethodController<sup>(deprecated)</sup>
getInputMethodController(): InputMethodController getInputMethodController(): InputMethodController
...@@ -86,7 +86,7 @@ getController(): InputMethodController ...@@ -86,7 +86,7 @@ getController(): InputMethodController
var InputMethodController = inputMethod.getController(); var InputMethodController = inputMethod.getController();
``` ```
## inputMethod.getInputMethodSetting<sup>deprecated</sup> ## inputMethod.getInputMethodSetting<sup>(deprecated)</sup>
getInputMethodSetting(): InputMethodSetting getInputMethodSetting(): InputMethodSetting
...@@ -169,7 +169,7 @@ try{ ...@@ -169,7 +169,7 @@ try{
}); });
} catch(err) { } catch(err) {
// 捕获参数错误 // 捕获参数错误
console.error('err: ' + err.code + 'err message: ' + err.message); console.error('switchInputMethod err: ' + JSON.stringify(err));
} }
``` ```
## inputMethod.switchInputMethod<sup>9+</sup> ## inputMethod.switchInputMethod<sup>9+</sup>
...@@ -204,10 +204,10 @@ try { ...@@ -204,10 +204,10 @@ try {
console.error('Failed to switchInputMethod.(promise)'); console.error('Failed to switchInputMethod.(promise)');
} }
}).catch((err) => { }).catch((err) => {
console.error('switchInputMethod promise err: ' + err); console.error('switchInputMethod promise err: ' + JSON.stringify(err));
}) })
} catch(err) { } catch(err) {
console.error('err: ' + err.code + 'err message: ' + err.message); console.error('switchInputMethod err: ' + JSON.stringify(err));
} }
``` ```
...@@ -268,7 +268,7 @@ try { ...@@ -268,7 +268,7 @@ try {
} }
}); });
} catch(err) { } catch(err) {
console.error('err: ' + err.code + 'err message: ' + err.message); console.error('switchCurrentInputMethodSubtype err: ' + JSON.stringify(err));
} }
``` ```
...@@ -303,10 +303,10 @@ try { ...@@ -303,10 +303,10 @@ try {
console.error('Failed to switchCurrentInputMethodSubtype.(promise)'); console.error('Failed to switchCurrentInputMethodSubtype.(promise)');
} }
}).catch((err) => { }).catch((err) => {
console.error('switchCurrentInputMethodSubtype promise err: ' + err); console.error('switchCurrentInputMethodSubtype err: ' + JSON.stringify(err));
}) })
} catch(err) { } catch(err) {
console.error('err: ' + err.code + 'err message: ' + err.message); console.error('switchCurrentInputMethodSubtype err: ' + JSON.stringify(err));
} }
``` ```
...@@ -353,14 +353,14 @@ switchCurrentInputMethodAndSubtype(inputMethodProperty: InputMethodProperty, inp ...@@ -353,14 +353,14 @@ switchCurrentInputMethodAndSubtype(inputMethodProperty: InputMethodProperty, inp
**示例：** **示例：**
```js ```js
let inputMethodProperty = {
packageName:"com.example.kikakeyboard",
methodId:"ServiceExtAbility"
}
let inputMethodSubProperty = { let inputMethodSubProperty = {
id: "com.example.kikainput", id: "com.example.kikainput",
label: "ServiceExtAbility" label: "ServiceExtAbility"
} }
let inputMethodProperty = {
name: 'com.example.kikakeyboard',
id: 'com.example.kikakeyboard'
}
try { try {
inputMethod.switchCurrentInputMethodAndSubtype(inputMethodProperty, inputMethodSubProperty, (err,result) => { inputMethod.switchCurrentInputMethodAndSubtype(inputMethodProperty, inputMethodSubProperty, (err,result) => {
if (err) { if (err) {
...@@ -374,7 +374,7 @@ try { ...@@ -374,7 +374,7 @@ try {
} }
}); });
} catch (err) { } catch (err) {
console.error('err: ' + err.code + 'err message: ' + err.message); console.error('switchCurrentInputMethodAndSubtype err: ' + JSON.stringify(err));
} }
``` ```
...@@ -398,14 +398,14 @@ switchCurrentInputMethodAndSubtype(inputMethodProperty: InputMethodProperty, inp ...@@ -398,14 +398,14 @@ switchCurrentInputMethodAndSubtype(inputMethodProperty: InputMethodProperty, inp
**示例：** **示例：**
```js ```js
let inputMethodProperty = {
packageName:"com.example.kikakeyboard",
methodId:"ServiceExtAbility"
}
let inputMethodSubProperty = { let inputMethodSubProperty = {
id: "com.example.kikainput", id: "com.example.kikainput",
label: "ServiceExtAbility" label: "ServiceExtAbility"
} }
let inputMethodProperty = {
name: 'com.example.kikakeyboard',
id: 'com.example.kikakeyboard'
}
try { try {
inputMethod.switchCurrentInputMethodAndSubtype(property, subType).then((result) => { inputMethod.switchCurrentInputMethodAndSubtype(property, subType).then((result) => {
if (result) { if (result) {
...@@ -417,7 +417,7 @@ try { ...@@ -417,7 +417,7 @@ try {
console.error('switchCurrentInputMethodAndSubtype promise err: ' + err); console.error('switchCurrentInputMethodAndSubtype promise err: ' + err);
}) })
} catch(err) { } catch(err) {
console.error('err: ' + err.code + 'err message: ' + err.message); console.error('switchCurrentInputMethodAndSubtype promise err: ' + err);
} }
``` ```
...@@ -425,12 +425,17 @@ try { ...@@ -425,12 +425,17 @@ try {
下列API示例中都需使用[getController](#inputmethodgetcontroller)回调获取到InputMethodController实例，再通过此实例调用对应方法。 下列API示例中都需使用[getController](#inputmethodgetcontroller)回调获取到InputMethodController实例，再通过此实例调用对应方法。
### stopInput<sup>deprecated</sup> ### stopInput<sup>(deprecated)</sup>
stopInput(callback: AsyncCallback&lt;boolean&gt;): void stopInput(callback: AsyncCallback&lt;boolean&gt;): void
隐藏输入法。使用callback形式返回结果。参数个数为1，否则抛出异常。 隐藏输入法。使用callback形式返回结果。参数个数为1，否则抛出异常。
> **说明：**
> 从API version 9开始废弃, 建议使用[stopInputSession](#stopInputSession)替代
>
> 从 API version 6开始支持。
**系统能力**：SystemCapability.MiscServices.InputMethodFramework **系统能力**：SystemCapability.MiscServices.InputMethodFramework
**参数：** **参数：**
...@@ -455,12 +460,17 @@ InputMethodController.stopInput((error, result) => { ...@@ -455,12 +460,17 @@ InputMethodController.stopInput((error, result) => {
}); });
``` ```
### stopInput<sup>deprecated</sup> ### stopInput<sup>(deprecated)</sup>
stopInput(): Promise&lt;boolean&gt; stopInput(): Promise&lt;boolean&gt;
隐藏输入法。使用promise形式返回结果。参数个数为0，否则抛出异常。 隐藏输入法。使用promise形式返回结果。参数个数为0，否则抛出异常。
> **说明：**
> 从API version 9开始废弃, 建议使用[stopInputSession](#stopInputSession)替代
>
> 从 API version 6开始支持。
**系统能力**： SystemCapability.MiscServices.InputMethodFramework **系统能力**： SystemCapability.MiscServices.InputMethodFramework
**返回值：** **返回值：**
...@@ -503,7 +513,7 @@ stopInputSession(callback: AsyncCallback&lt;boolean&gt;): void ...@@ -503,7 +513,7 @@ stopInputSession(callback: AsyncCallback&lt;boolean&gt;): void
try { try {
InputMethodController.stopInputSession((error, result) => { InputMethodController.stopInputSession((error, result) => {
if (error) { if (error) {
console.error('failed to stopInputSession because: ' + JSON.stringify(error)); console.error('stopInputSession err: ' + JSON.stringify(error));
return; return;
} }
if (result) { if (result) {
...@@ -512,8 +522,8 @@ try { ...@@ -512,8 +522,8 @@ try {
console.error('Failed to stopInputSession.(callback)'); console.error('Failed to stopInputSession.(callback)');
} }
}); });
} catch(err) { } catch(error) {
console.error('err: ' + err.code + 'err message: ' + err.message); console.error('stopInputSession err: ' + JSON.stringify(error));
} }
``` ```
...@@ -542,10 +552,10 @@ try { ...@@ -542,10 +552,10 @@ try {
console.error('Failed to stopInputSession.(promise)'); console.error('Failed to stopInputSession.(promise)');
} }
}).catch((err) => { }).catch((err) => {
console.error('stopInputSession promise err: ' + err); console.error('stopInputSession err: ' + JSON.stringify(err));
}) })
} catch(err) { } catch(err) {
console.error('err: ' + err.code + 'err message: ' + err.message); console.error('stopInputSession err: ' + JSON.stringify(err));
} }
``` ```
...@@ -724,13 +734,13 @@ let inputMethodSubProperty = { ...@@ -724,13 +734,13 @@ let inputMethodSubProperty = {
try { try {
InputMethodSetting.listInputMethodSubtype(inputMethodSubProperty, (err,data) => { InputMethodSetting.listInputMethodSubtype(inputMethodSubProperty, (err,data) => {
if (err) { if (err) {
console.error('listInputMethodSubtype failed because: ' + JSON.stringify(err)); console.error('listInputMethodSubtype failed: ' + JSON.stringify(err));
return; return;
} }
console.log('listInputMethodSubtype success'); console.log('listInputMethodSubtype success');
}); });
} catch (err) { } catch (err) {
console.error('err: ' + err.code + 'err message: ' + err.message); console.error('listInputMethodSubtype failed: ' + JSON.stringify(err));
} }
``` ```
...@@ -759,10 +769,10 @@ try { ...@@ -759,10 +769,10 @@ try {
InputMethodSetting.listInputMethodSubtype(inputMethodSubProperty).then((data) => { InputMethodSetting.listInputMethodSubtype(inputMethodSubProperty).then((data) => {
console.info('listInputMethodSubtype success'); console.info('listInputMethodSubtype success');
}).catch((err) => { }).catch((err) => {
console.error('listInputMethodSubtype promise err: ' + err); console.error('listInputMethodSubtype err: ' + JSON.stringify(err));
}) })
} catch(err) { } catch(err) {
console.error('err: ' + err.code + 'err message: ' + err.message); console.error('listInputMethodSubtype err: ' + JSON.stringify(err));
} }
``` ```
...@@ -784,15 +794,15 @@ listCurrentInputMethodSubtype(callback: AsyncCallback&lt;Array&lt;InputMethodSub ...@@ -784,15 +794,15 @@ listCurrentInputMethodSubtype(callback: AsyncCallback&lt;Array&lt;InputMethodSub
```js ```js
try { try {
InputMethodSetting.listCurrentInputMethodSubtype((err,data) => { InputMethodSetting.listCurrentInputMethodSubtype((err, data) => {
if (err) { if (err) {
console.error('listCurrentInputMethodSubtype failed because: ' + JSON.stringify(err)); console.error('listCurrentInputMethodSubtype failed: ' + JSON.stringify(err));
return; return;
} }
console.log('listCurrentInputMethodSubtype success'); console.log('listCurrentInputMethodSubtype success');
}); });
} catch(err) { } catch(err) {
console.error('err: ' + err.code + 'err message: ' + err.message); console.error('listCurrentInputMethodSubtype err: ' + JSON.stringify(err));
} }
``` ```
...@@ -820,9 +830,8 @@ try { ...@@ -820,9 +830,8 @@ try {
console.error('listCurrentInputMethodSubtype promise err: ' + err); console.error('listCurrentInputMethodSubtype promise err: ' + err);
}) })
} catch(err) { } catch(err) {
console.error('err: ' + err.code + 'err message: ' + err.message); console.error('listCurrentInputMethodSubtype err: ' + JSON.stringify(err));
} }
``` ```
### getInputMethods<sup>9+</sup> ### getInputMethods<sup>9+</sup>
...@@ -846,13 +855,13 @@ getInputMethods(enable: boolean, callback: AsyncCallback&lt;Array&lt;InputMethod ...@@ -846,13 +855,13 @@ getInputMethods(enable: boolean, callback: AsyncCallback&lt;Array&lt;InputMethod
try { try {
InputMethodSetting.getInputMethods(true, (err,data) => { InputMethodSetting.getInputMethods(true, (err,data) => {
if (err) { if (err) {
console.error('getInputMethods failed because: ' + JSON.stringify(err)); console.error('getInputMethods failed: ' + JSON.stringify(err));
return; return;
} }
console.log('getInputMethods success'); console.log('getInputMethods success');
}); });
} catch (err) { } catch (err) {
console.error('err: ' + err.code + 'err message: ' + err.message); console.error('getInputMethods failed: ' + JSON.stringify(err));
} }
``` ```
...@@ -883,19 +892,24 @@ try { ...@@ -883,19 +892,24 @@ try {
InputMethodSetting.getInputMethods(true).then((data) => { InputMethodSetting.getInputMethods(true).then((data) => {
console.info('getInputMethods success'); console.info('getInputMethods success');
}).catch((err) => { }).catch((err) => {
console.error('getInputMethods promise err: ' + err); console.error('getInputMethods promise err: ' + JSON.stringify(err));
}) })
} catch(err) { } catch(err) {
console.error('err: ' + err.code + 'err message: ' + err.message); console.error('getInputMethods promise err: ' + JSON.stringify(err));
} }
``` ```
### listInputMethod<sup>deprecated</sup> ### listInputMethod<sup>(deprecated)</sup>
listInputMethod(callback: AsyncCallback&lt;Array&lt;InputMethodProperty&gt;&gt;): void listInputMethod(callback: AsyncCallback&lt;Array&lt;InputMethodProperty&gt;&gt;): void
查询已安装的输入法列表。使用callback形式返回结果。参数个数为1，否则抛出异常。 查询已安装的输入法列表。使用callback形式返回结果。参数个数为1，否则抛出异常。
> **说明：**
> 从API version 9开始废弃, 建议使用[getInputMethods](#getInputMethods)替代
>
> 从 API version 8开始支持。
**系统能力**： SystemCapability.MiscServices.InputMethodFramework **系统能力**： SystemCapability.MiscServices.InputMethodFramework
**参数：** **参数：**
...@@ -916,12 +930,17 @@ InputMethodSetting.listInputMethod((err,data) => { ...@@ -916,12 +930,17 @@ InputMethodSetting.listInputMethod((err,data) => {
}); });
``` ```
### listInputMethod<sup>deprecated</sup> ### listInputMethod<sup>(deprecated)</sup>
listInputMethod(): Promise&lt;Array&lt;InputMethodProperty&gt;&gt; listInputMethod(): Promise&lt;Array&lt;InputMethodProperty&gt;&gt;
查询已安装的输入法列表。使用promise形式返回结果。参数个数为0，否则抛出异常。 查询已安装的输入法列表。使用promise形式返回结果。参数个数为0，否则抛出异常。
> **说明：**
> 从API version 9开始废弃, 建议使用[getInputMethods](#getInputMethods)替代
>
> 从 API version 8开始支持。
**系统能力**： SystemCapability.MiscServices.InputMethodFramework **系统能力**： SystemCapability.MiscServices.InputMethodFramework
**返回值：** **返回值：**
...@@ -936,16 +955,21 @@ listInputMethod(): Promise&lt;Array&lt;InputMethodProperty&gt;&gt; ...@@ -936,16 +955,21 @@ listInputMethod(): Promise&lt;Array&lt;InputMethodProperty&gt;&gt;
InputMethodSetting.listInputMethod().then((data) => { InputMethodSetting.listInputMethod().then((data) => {
console.info('listInputMethod success'); console.info('listInputMethod success');
}).catch((err) => { }).catch((err) => {
console.error('listInputMethod promise err: ' + err); console.error('listInputMethod promise err: ' + JSON.stringify(err));
}) })
``` ```
### displayOptionalInputMethod<sup>deprecated</sup> ### displayOptionalInputMethod<sup>(deprecated)</sup>
displayOptionalInputMethod(callback: AsyncCallback&lt;void&gt;): void displayOptionalInputMethod(callback: AsyncCallback&lt;void&gt;): void
显示输入法选择对话框。使用callback形式返回结果。参数个数为1，否则抛出异常。 显示输入法选择对话框。使用callback形式返回结果。参数个数为1，否则抛出异常。
> **说明：**
> 从API version 9开始废弃, 建议使用[showOptionalInputMethods](#showOptionalInputMethods)替代
>
> 从 API version 8开始支持。
**系统能力**： SystemCapability.MiscServices.InputMethodFramework **系统能力**： SystemCapability.MiscServices.InputMethodFramework
**参数：** **参数：**
...@@ -988,22 +1012,27 @@ showOptionalInputMethods(callback: AsyncCallback&lt;void&gt;): void ...@@ -988,22 +1012,27 @@ showOptionalInputMethods(callback: AsyncCallback&lt;void&gt;): void
try { try {
InputMethodSetting.showOptionalInputMethods((err) => { InputMethodSetting.showOptionalInputMethods((err) => {
if (err) { if (err) {
console.error('showOptionalInputMethods failed because: ' + JSON.stringify(err)); console.error('showOptionalInputMethods failed: ' + JSON.stringify(err));
return; return;
} }
console.info('showOptionalInputMethods success'); console.info('showOptionalInputMethods success');
}); });
} catch (err) { } catch (err) {
console.error('err: ' + err.code + 'err message: ' + err.message); console.error('showOptionalInputMethods failed: ' + JSON.stringify(err));
} }
``` ```
### displayOptionalInputMethod<sup>deprecated</sup> ### displayOptionalInputMethod<sup>(deprecated)</sup>
displayOptionalInputMethod(): Promise&lt;void&gt; displayOptionalInputMethod(): Promise&lt;void&gt;
显示输入法选择对话框。使用promise形式返回结果。参数个数为0，否则抛出异常。 显示输入法选择对话框。使用promise形式返回结果。参数个数为0，否则抛出异常。
> **说明：**
> 从API version 9开始废弃, 建议使用[showOptionalInputMethods](#showOptionalInputMethods)替代
>
> 从 API version 8开始支持。
**系统能力**： SystemCapability.MiscServices.InputMethodFramework **系统能力**： SystemCapability.MiscServices.InputMethodFramework
**返回值：** **返回值：**
......
zh-cn/application-dev/reference/errorcodes/errcode-InputMethodFramework.md
浏览文件 @ 47a3a514
# 输入法框架错误码 # 输入法框架错误码
## 12800201 权限校验异常 ## 201 权限校验异常
### 错误信息 ### 错误信息
the permissions check fails. the permissions check fails.
...@@ -11,7 +11,7 @@ the permissions check fails. ...@@ -11,7 +11,7 @@ the permissions check fails.
### 处理步骤 ### 处理步骤
给应用配置相应的权限 给应用配置相应的权限
## 12800401 参数校验异常 ## 401 参数校验异常
### 错误信息 ### 错误信息
the parameters check fails. the parameters check fails.
...@@ -22,7 +22,7 @@ the parameters check fails. ...@@ -22,7 +22,7 @@ the parameters check fails.
### 处理步骤 ### 处理步骤
修改接口调用时传入的参数个数或者类型 修改接口调用时传入的参数个数或者类型
## 12800801 功能支持异常 ## 801 功能支持异常
### 错误信息 ### 错误信息
call unsupported api. call unsupported api.
......
Markdown is supported
0% 或 .
You are about to add 0 people to the discussion. Proceed with caution.
先完成此消息的编辑！
想要评论请 注册 或