提交 64a00496 编写于 作者: M ma-shaoyin

Signed-off-by: ma-shaoyin <mashaoyin1@huawei.com>

 Changes to be committed:
上级 e8c503ba
...@@ -45,9 +45,9 @@ getInputMethodController(): InputMethodController ...@@ -45,9 +45,9 @@ getInputMethodController(): InputMethodController
**返回值:** **返回值:**
| 类型 | 说明 | | 类型 | 说明 |
| -------- | -------- | | ----------------------------------------------- | ------------------------ |
| [InputMethodController](#inputmethodcontroller) | 回调返回当前客户端实例。 | | [InputMethodController](#inputmethodcontroller) | 回调返回当前客户端实例。 |
**示例:** **示例:**
...@@ -79,7 +79,7 @@ getInputMethodSetting(): InputMethodSetting ...@@ -79,7 +79,7 @@ getInputMethodSetting(): InputMethodSetting
switchInputMethod(target: InputmethodProperty, callback: AsyncCallback&lt;boolean&gt;): void; switchInputMethod(target: InputmethodProperty, callback: AsyncCallback&lt;boolean&gt;): void;
切换输入法。此接口仅可在Stage模型下使用。 切换输入法。此接口仅可在Stage模型下使用。使用callback形式返回结果。参数个数为2,否则抛出异常。
**系统能力**:SystemCapability.Miscservices.InputMethodFramework **系统能力**:SystemCapability.Miscservices.InputMethodFramework
...@@ -102,7 +102,7 @@ switchInputMethod(target: InputmethodProperty, callback: AsyncCallback&lt;boolea ...@@ -102,7 +102,7 @@ switchInputMethod(target: InputmethodProperty, callback: AsyncCallback&lt;boolea
## inputMethod.switchInputMethod<sup>9+</sup> ## inputMethod.switchInputMethod<sup>9+</sup>
switchInputMethod(target: InputmethodProperty): Promise&lt;boolean&gt; switchInputMethod(target: InputmethodProperty): Promise&lt;boolean&gt;
切换输入法。此接口仅可在Stage模型下使用。 切换输入法。此接口仅可在Stage模型下使用。使用promise形式返回结果。参数个数为1,否则抛出异常。
**系统能力**: SystemCapability.Miscservices.InputMethodFramework **系统能力**: SystemCapability.Miscservices.InputMethodFramework
...@@ -133,7 +133,7 @@ switchInputMethod(target: InputmethodProperty): Promise&lt;boolean&gt; ...@@ -133,7 +133,7 @@ switchInputMethod(target: InputmethodProperty): Promise&lt;boolean&gt;
stopInput(callback: AsyncCallback&lt;boolean&gt;): void stopInput(callback: AsyncCallback&lt;boolean&gt;): void
隐藏输入法。 隐藏输入法。使用callback形式返回结果。参数个数为1,否则抛出异常。
**系统能力**:SystemCapability.MiscServices.InputMethodFramework **系统能力**:SystemCapability.MiscServices.InputMethodFramework
...@@ -146,16 +146,24 @@ stopInput(callback: AsyncCallback&lt;boolean&gt;): void ...@@ -146,16 +146,24 @@ stopInput(callback: AsyncCallback&lt;boolean&gt;): void
**示例:** **示例:**
```js ```js
InputMethodController.stopInput((error)=>{ inputMethodController.stopInput((err, result) => {
console.info('stopInput'); if (err == undefined) {
}); console.error("stopInput callback result---err: " + err.msg);
return;
}
if (result) {
console.info("Success to stopInput.(callback)");
} else {
console.info("Failed to stopInput.(callback)");
}
});
``` ```
### stopInput ### stopInput
stopInput(): Promise&lt;boolean&gt; stopInput(): Promise&lt;boolean&gt;
隐藏输入法。 隐藏输入法。使用promise形式返回结果。参数个数为0,否则抛出异常。
**系统能力**: SystemCapability.MiscServices.InputMethodFramework **系统能力**: SystemCapability.MiscServices.InputMethodFramework
...@@ -169,15 +177,22 @@ stopInput(): Promise&lt;boolean&gt; ...@@ -169,15 +177,22 @@ stopInput(): Promise&lt;boolean&gt;
```js ```js
var isSuccess = InputMethodController.stopInput(); await inputMethodController.stopInput().then((result)=>{
console.info('stopInput isSuccess = ' + isSuccess); if (result) {
console.info("Success to stopInput.(promise)");
} else {
console.info("Failed to stopInput.(promise)");
}
}).catch((err) => {
console.error("stopInput promise err: " + err.msg);
});
``` ```
### showSoftKeyboard<sup>9+</sup> ### ### showSoftKeyboard<sup>9+</sup> ###
showSoftKeyboard(callback: AsyncCallback&lt;void&gt;): void showSoftKeyboard(callback: AsyncCallback&lt;void&gt;): void
显示软键盘,使用callback异步回调。 显示软键盘,使用callback异步回调。参数个数为1,否则抛出异常。
**系统能力:** SystemCapability.MiscServices.InputMethodFramework **系统能力:** SystemCapability.MiscServices.InputMethodFramework
...@@ -204,7 +219,7 @@ InputMethodController.showSoftKeyboard((err) => { ...@@ -204,7 +219,7 @@ InputMethodController.showSoftKeyboard((err) => {
showSoftKeyboard(): Promise&lt;void&gt; showSoftKeyboard(): Promise&lt;void&gt;
显示软键盘,使用Promise异步回调。 显示软键盘,使用Promise异步回调。参数个数为0,否则抛出异常。
**系统能力:** SystemCapability.MiscServices.InputMethodFramework **系统能力:** SystemCapability.MiscServices.InputMethodFramework
...@@ -228,7 +243,7 @@ InputMethodController.showSoftKeyboard().then(async (err) => { ...@@ -228,7 +243,7 @@ InputMethodController.showSoftKeyboard().then(async (err) => {
hideSoftKeyboard(callback: AsyncCallback&lt;void&gt;): void hideSoftKeyboard(callback: AsyncCallback&lt;void&gt;): void
隐藏软键盘,使用callback异步回调。 隐藏软键盘,使用callback异步回调。参数个数为1,否则抛出异常。
**系统能力:** SystemCapability.MiscServices.InputMethodFramework **系统能力:** SystemCapability.MiscServices.InputMethodFramework
...@@ -255,7 +270,7 @@ InputMethodController.hideSoftKeyboard((err) => { ...@@ -255,7 +270,7 @@ InputMethodController.hideSoftKeyboard((err) => {
hideSoftKeyboard(): Promise&lt;void&gt; hideSoftKeyboard(): Promise&lt;void&gt;
隐藏软键盘,使用Promise异步回调。 隐藏软键盘,使用Promise异步回调。参数个数为0,否则抛出异常。
**系统能力:** SystemCapability.MiscServices.InputMethodFramework **系统能力:** SystemCapability.MiscServices.InputMethodFramework
...@@ -283,7 +298,7 @@ InputMethodController.hideSoftKeyboard().then(async (err) => { ...@@ -283,7 +298,7 @@ InputMethodController.hideSoftKeyboard().then(async (err) => {
listInputMethod(callback: AsyncCallback&lt;Array&lt;InputMethodProperty&gt;&gt;): void listInputMethod(callback: AsyncCallback&lt;Array&lt;InputMethodProperty&gt;&gt;): void
查询已安装的输入法列表。 查询已安装的输入法列表。使用callback形式返回结果。参数个数为1,否则抛出异常。
**系统能力**: SystemCapability.MiscServices.InputMethodFramework **系统能力**: SystemCapability.MiscServices.InputMethodFramework
...@@ -295,19 +310,20 @@ listInputMethod(callback: AsyncCallback&lt;Array&lt;InputMethodProperty&gt;&gt;) ...@@ -295,19 +310,20 @@ listInputMethod(callback: AsyncCallback&lt;Array&lt;InputMethodProperty&gt;&gt;)
**示例:** **示例:**
```js ```js
InputMethodSetting.listInputMethod((properties)=>{ inputMethodSetting.listInputMethod((err,data) => {
for (var i = 0;i < properties.length; i++) { if (err == undefined) {
var property = properties[i]; console.error("listInputMethod callback result---err: " + err.msg);
console.info(property.packageName + "/" + property.methodId); return;
} }
}); console.info("listInputMethod callback result---data: " + JSON.stringify(data));
});
``` ```
### listInputMethod ### listInputMethod
listInputMethod(): Array&lt;InputMethodProperty&gt; listInputMethod(): Promise<Array<InputMethodProperty>>;
查询已安装的输入法列表。 查询已安装的输入法列表。使用promise形式返回结果。参数个数为0,否则抛出异常。
**系统能力**: SystemCapability.MiscServices.InputMethodFramework **系统能力**: SystemCapability.MiscServices.InputMethodFramework
...@@ -319,18 +335,18 @@ listInputMethod(): Array&lt;InputMethodProperty&gt; ...@@ -319,18 +335,18 @@ listInputMethod(): Array&lt;InputMethodProperty&gt;
**示例:** **示例:**
```js ```js
var properties = InputMethodSetting.listInputMethod(); await inputMethodSetting.listInputMethod().then((data)=>{
for (var i = 0;i < properties.length; i++) { console.info("listInputMethod promise result---data: " + JSON.stringify(data));
var property = properties[i]; }).catch((err) => {
console.info(property.packageName + "/" + property.methodId); console.info("listInputMethod promise err:" + err.msg);
} });
``` ```
### displayOptionalInputMethod ### displayOptionalInputMethod
displayOptionalInputMethod(callback: AsyncCallback&lt;void&gt;): void displayOptionalInputMethod(callback: AsyncCallback&lt;void&gt;): void
显示输入法选择对话框。 显示输入法选择对话框。使用callback形式返回结果。参数个数为1,否则抛出异常。
**系统能力**: SystemCapability.MiscServices.InputMethodFramework **系统能力**: SystemCapability.MiscServices.InputMethodFramework
...@@ -343,16 +359,20 @@ displayOptionalInputMethod(callback: AsyncCallback&lt;void&gt;): void ...@@ -343,16 +359,20 @@ displayOptionalInputMethod(callback: AsyncCallback&lt;void&gt;): void
**示例:** **示例:**
```js ```js
InputMethodSetting.displayOptionalInputMethod(()=>{ inputMethodSetting.displayOptionalInputMethod((err) => {
console.info('displayOptionalInputMethod is called'); if (err == undefined) {
}); console.error("displayOptionalInputMethod callback---err: " + err.msg);
return;
}
console.info("displayOptionalInputMethod callback");
});
``` ```
### displayOptionalInputMethod ### displayOptionalInputMethod
displayOptionalInputMethod(): Promise&lt;void&gt; displayOptionalInputMethod(): Promise&lt;void&gt;
显示输入法选择对话框。 显示输入法选择对话框。使用promise形式返回结果。参数个数为0,否则抛出异常。
**系统能力**: SystemCapability.MiscServices.InputMethodFramework **系统能力**: SystemCapability.MiscServices.InputMethodFramework
...@@ -360,10 +380,14 @@ displayOptionalInputMethod(callback: AsyncCallback&lt;void&gt;): void ...@@ -360,10 +380,14 @@ displayOptionalInputMethod(callback: AsyncCallback&lt;void&gt;): void
| 类型 | 说明 | | 类型 | 说明 |
| -------- | -------- | | -------- | -------- |
| Promise&lt;void&gt; | 回调函数。 | | Promise&lt;void&gt; | 无返回结果的Promise对象。 |
**示例:** **示例:**
```js ```js
InputMethodSetting.displayOptionalInputMethod(); await inputMethodSetting.displayOptionalInputMethod().then(()=>{
console.info("displayOptionalInputMethod promise");
}).catch((err) => {
console.info("listInputMethod promise err: " + err.msg);
});
``` ```
\ No newline at end of file
Markdown is supported
0% .
You are about to add 0 people to the discussion. Proceed with caution.
先完成此消息的编辑!
想要评论请 注册