Skip to content
体验新版
项目
组织
正在加载...
登录
切换导航
打开侧边栏
OpenHarmony
Docs
提交
beb27013
D
Docs
项目概览
OpenHarmony
/
Docs
1 年多 前同步成功
通知
159
Star
292
Fork
28
代码
文件
提交
分支
Tags
贡献者
分支图
Diff
Issue
0
列表
看板
标记
里程碑
合并请求
0
Wiki
0
Wiki
分析
仓库
DevOps
项目成员
Pages
D
Docs
项目概览
项目概览
详情
发布
仓库
仓库
文件
提交
分支
标签
贡献者
分支图
比较
Issue
0
Issue
0
列表
看板
标记
里程碑
合并请求
0
合并请求
0
Pages
分析
分析
仓库分析
DevOps
Wiki
0
Wiki
成员
成员
收起侧边栏
关闭侧边栏
动态
分支图
创建新Issue
提交
Issue看板
提交
beb27013
编写于
10月 20, 2022
作者:
H
Hollokin
浏览文件
操作
浏览文件
下载
电子邮件补丁
差异文件
输入法框架API资料补充
Signed-off-by:
N
Hollokin
<
taoyuxin2@huawei.com
>
上级
d787319f
变更
4
展开全部
显示空白变更内容
内联
并排
Showing
4 changed file
with
960 addition
and
970 deletion
+960
-970
zh-cn/application-dev/reference/apis/js-apis-inputmethod-extension-ability.md
...v/reference/apis/js-apis-inputmethod-extension-ability.md
+82
-42
zh-cn/application-dev/reference/apis/js-apis-inputmethod-extension-context.md
...v/reference/apis/js-apis-inputmethod-extension-context.md
+50
-51
zh-cn/application-dev/reference/apis/js-apis-inputmethod.md
zh-cn/application-dev/reference/apis/js-apis-inputmethod.md
+160
-178
zh-cn/application-dev/reference/apis/js-apis-inputmethodengine.md
...plication-dev/reference/apis/js-apis-inputmethodengine.md
+668
-699
未找到文件。
zh-cn/application-dev/reference/apis/js-apis-inputmethod-extension-ability.md
浏览文件 @
beb27013
...
...
@@ -4,8 +4,8 @@ InputMethodExtensionAbility模块,提供生态输入法应用开发者通过In
> **说明:**
>
> 本模块首批接口从API version 9开始支持。后续版本的新增接口,采用上角标单独标记接口的起始版本。
> 本模块接口仅可在Stage模型下使用。
>
-
本模块首批接口从API version 9开始支持。后续版本的新增接口,采用上角标单独标记接口的起始版本。
>
-
本模块接口仅可在Stage模型下使用。
## 导入模块
...
...
@@ -24,7 +24,7 @@ import InputMethodExtensionAbility from '@ohos.inputmethodextensionability';
## InputMethodExtensionAbility.onCreate()
onCreate(want: Want): void
;
onCreate(want: Want): void
Extension生命周期回调,在拉起Extension输入法应用时调用,执行初始化输入法应用操作。
...
...
@@ -38,18 +38,18 @@ Extension生命周期回调,在拉起Extension输入法应用时调用,执
**示例:**
```
js
class
InputMethodExt
extends
InputMethodExtensionAbility
{
```
js
class
InputMethodExt
extends
InputMethodExtensionAbility
{
onCreate
(
want
)
{
console
.
log
(
'
onCreate, want:
'
+
want
.
abilityName
);
}
}
```
}
```
## InputMethodExtensionAbility.onDestroy()
onDestroy(): void
;
onDestroy(): void
Extension生命周期回调,在销毁输入法应用时回调,执行资源清理等操作。
...
...
@@ -57,83 +57,123 @@ Extension生命周期回调,在销毁输入法应用时回调,执行资源
**示例:**
```
js
class
InputMethodExt
extends
InputMethodExtensionAbility
{
```
js
class
InputMethodExt
extends
InputMethodExtensionAbility
{
onDestroy
()
{
console
.
log
(
'
onDestroy
'
);
}
}
```
}
```
## InputMethodExtensionAbility.onRequest()
onRequest(want: Want, startId: number): void
;
onRequest(want: Want, startId: number): void
Extension生命周期回调,在一个输入法extention开始时回调,执行输入法的相关操作。
**系统能力**
:SystemCapability.MiscServices.InputMethodFramework
**参数:**
| 参数名 | 类型 | 必填 | 说明 |
| -------- | -------- | -------- | -------- |
| want |
[
Want
](
js-apis-application-Want.md
)
| 是 | 当前Extension相关的Want类型信息,包括ability名称、bundle名称等。 |
| startId | number | 是 | 返回拉起次数。首次拉起初始值返回1,多次之后自动递增。 |
**示例:**
```
js
class
InputMethodExt
extends
InputMethodExtensionAbility
{
onRequest
()
{
```
js
class
InputMethodExt
extends
InputMethodExtensionAbility
{
onRequest
(
want
,
startId
)
{
console
.
log
(
'
onRequest, want:
'
+
want
.
abilityName
+
'
startId:
'
+
startId
);
}
}
```
}
```
## InputMethodExtensionAbility.onConnect()
onConnect(want: Want): rpc.RemoteObject
;
onConnect(want: Want): rpc.RemoteObject
Extension生命周期回调,在输入法extention首次连接输入法ability时回调。
**系统能力**
:SystemCapability.MiscServices.InputMethodFramework
**参数:**
| 参数名 | 类型 | 必填 | 说明 |
| -------- | -------- | -------- | -------- |
| want |
[
Want
](
js-apis-application-Want.md
)
| 是 | 当前Extension相关的Want类型信息,包括ability名称、bundle名称等。 |
**返回值**
| 类型 | 说明 |
| ------------------------------- | ------------------------------------------------------------ |
| rpc.RemoteObject | 一个RemoteObject对象,用于和客户端进行通信。 |
**示例:**
```
js
class
InputMethodExt
extends
InputMethodExtensionAbility
{
onConnect
()
{
console
.
log
(
'
onConnect, want:
'
+
want
.
abilityName
);
```
js
import
rpc
from
'
@ohos.rpc
'
class
StubTest
extends
rpc
.
RemoteObject
{
constructor
(
des
)
{
super
(
des
);
}
onConnect
(
code
,
data
,
reply
,
option
)
{
}
}
class
ServiceExt
extends
ServiceExtension
{
onConnect
(
want
)
{
console
.
log
(
'
onConnect , want:
'
+
want
.
abilityName
);
return
new
StubTest
(
"
test
"
);
}
```
}
```
## InputMethodExtensionAbility.onDisconnect()
onDisconnect(want: Want):
rpc.RemoteObject;
onDisconnect(want: Want):
void
Extension生命周期回调,在所有连接在输入法extention上的ability都断开的时候回调。
**系统能力**
:SystemCapability.MiscServices.InputMethodFramework
**参数:**
| 参数名 | 类型 | 必填 | 说明 |
| -------- | -------- | -------- | -------- |
| want |
[
Want
](
js-apis-application-Want.md
)
| 是 | 当前Extension相关的Want类型信息,包括ability名称、bundle名称等。 |
**示例:**
```
js
class
InputMethodExt
extends
InputMethodExtensionAbility
{
onDisconnect
()
{
```
js
class
InputMethodExt
extends
InputMethodExtensionAbility
{
onDisconnect
(
want
)
{
console
.
log
(
'
onDisconnect, want:
'
+
want
.
abilityName
);
}
}
```
}
```
## InputMethodExtensionAbility.onReconnect()
onReconnect(want: Want):
rpc.RemoteObject;
onReconnect(want: Want):
void
Extension生命周期回调,在一个新的客户端去尝试连接输入法extention的时候回调(先前连接在extention上的客户端全部断开的情况下)。
**系统能力**
:SystemCapability.MiscServices.InputMethodFramework
**参数:**
| 参数名 | 类型 | 必填 | 说明 |
| -------- | -------- | -------- | -------- |
| want |
[
Want
](
js-apis-application-Want.md
)
| 是 | 当前Extension相关的Want类型信息,包括ability名称、bundle名称等。 |
**示例:**
```
js
class
InputMethodExt
extends
InputMethodExtensionAbility
{
onReconnect
()
{
```
js
class
InputMethodExt
extends
InputMethodExtensionAbility
{
onReconnect
(
want
)
{
console
.
log
(
'
onReconnect, want:
'
+
want
.
abilityName
);
}
}
```
}
```
zh-cn/application-dev/reference/apis/js-apis-inputmethod-extension-context.md
浏览文件 @
beb27013
...
...
@@ -6,8 +6,8 @@ InputMethodExtensionContext模块提供InputMethodExtensionAbility具有的能
> **说明:**
>
> 本模块首批接口从API version 9开始支持。后续版本的新增接口,采用上角标单独标记接口的起始版本。
> 本模块接口仅可在Stage模型下使用。
>
-
本模块首批接口从API version 9开始支持。后续版本的新增接口,采用上角标单独标记接口的起始版本。
>
-
本模块接口仅可在Stage模型下使用。
## 导入模块
...
...
@@ -20,12 +20,12 @@ import InputMethodExtensionContext from '@ohos.inputmethodextensioncontext';
在使用InputMethodExtensionContext的功能前,需要通过InputMethodExtensionAbility子类实例获取。
```
js
import
InputMethodExtensionAbility
from
'
@ohos.inputmethodextensionability
'
;
class
MainAbility
extends
InputMethodExtensionAbility
{
import
InputMethodExtensionAbility
from
'
@ohos.inputmethodextensionability
'
;
class
MainAbility
extends
InputMethodExtensionAbility
{
onCreate
()
{
let
context
=
this
.
context
;
}
}
}
```
## InputMethodExtensionContext.startAbility
...
...
@@ -45,15 +45,15 @@ startAbility(want: Want, callback: AsyncCallback<void>): void;
**示例:**
```
js
let
want
=
{
```
js
let
want
=
{
'
bundleName
'
:
'
com.example.myapp
'
,
'
abilityName
'
:
'
MyAbility
'
};
this
.
context
.
startAbility
(
want
,
(
err
)
=>
{
};
this
.
context
.
startAbility
(
want
,
(
err
)
=>
{
console
.
log
(
'
startAbility result:
'
+
JSON
.
stringify
(
err
));
});
```
});
```
## InputMethodExtensionContext.startAbility
...
...
@@ -78,18 +78,17 @@ startAbility(want: Want, options?: StartOptions): Promise\<void>;
**示例:**
```
js
let
want
=
{
```
js
let
want
=
{
'
bundleName
'
:
'
com.example.myapp
'
,
'
abilityName
'
:
'
MyAbility
'
};
this
.
context
.
startAbility
(
want
).
then
((
data
)
=>
{
};
this
.
context
.
startAbility
(
want
).
then
((
data
)
=>
{
console
.
log
(
'
success:
'
+
JSON
.
stringify
(
data
));
}).
catch
((
error
)
=>
{
}).
catch
((
error
)
=>
{
console
.
log
(
'
failed:
'
+
JSON
.
stringify
(
error
));
});
```
});
```
## InputMethodExtensionContext.startAbility
...
...
@@ -109,19 +108,19 @@ startAbility(want: Want, options: StartOptions, callback: AsyncCallback<void&
**示例:**
```
js
var
want
=
{
```
js
let
want
=
{
'
deviceId
'
:
''
,
'
bundleName
'
:
'
com.extreme.test
'
,
'
abilityName
'
:
'
MainAbility
'
};
var
options
=
{
};
let
options
=
{
windowMode
:
0
,
};
this
.
context
.
startAbility
(
want
,
options
,
(
error
)
=>
{
};
this
.
context
.
startAbility
(
want
,
options
,
(
error
)
=>
{
console
.
log
(
'
error.code =
'
+
error
.
code
)
})
```
})
```
## InputMethodExtensionContext.terminateSelf
...
...
@@ -139,11 +138,11 @@ terminateSelf(callback: AsyncCallback<void>): void;
**示例:**
```
js
```
js
this
.
context
.
terminateSelf
((
err
)
=>
{
console
.
log
(
'
terminateSelf result:
'
+
JSON
.
stringify
(
err
));
});
```
```
## InputMethodExtensionContext.terminateSelf
...
...
@@ -161,10 +160,10 @@ terminateSelf(): Promise<void>;
**示例:**
```
js
this
.
context
.
terminateSelf
().
then
((
data
)
=>
{
```
js
this
.
context
.
terminateSelf
().
then
((
data
)
=>
{
console
.
log
(
'
success:
'
+
JSON
.
stringify
(
data
));
}).
catch
((
error
)
=>
{
}).
catch
((
error
)
=>
{
console
.
log
(
'
failed:
'
+
JSON
.
stringify
(
error
));
});
```
});
```
zh-cn/application-dev/reference/apis/js-apis-inputmethod.md
浏览文件 @
beb27013
...
...
@@ -11,7 +11,6 @@
```
import inputMethod from '@ohos.inputmethod';
import InputMethodSubtype from './@ohos.inputMethodSubtype';
```
## inputMethod<sup>8+</sup>
...
...
@@ -42,31 +41,6 @@ import InputMethodSubtype from './@ohos.inputMethodSubtype';
| iconId
<sup>
9+
</sup>
| number | 是 | 否 | 输入法图标id,非必填项。 |
| extra
<sup>
9+
</sup>
| object | 是 | 否 | 输入法其他信息,非必填项。 |
## inputMethod.getInputMethodController<sup>(deprecated)</sup>
getInputMethodController(): InputMethodController
获取客户端实例
[
InputMethodController
](
#inputmethodcontroller
)
。
> **说明:**
> 从API version 9开始废弃, 建议使用[getController](#inputmethodgetcontroller9)替代
>
> 从 API version 6开始支持。
**系统能力**
:SystemCapability.MiscServices.InputMethodFramework
**返回值:**
| 类型 | 说明 |
| ----------------------------------------------- | ------------------------ |
|
[
InputMethodController
](
#inputmethodcontroller
)
| 回调返回当前客户端实例。 |
**示例:**
```
js
var
InputMethodController
=
inputMethod
.
getInputMethodController
();
```
## inputMethod.getController<sup>9+</sup>
getController(): InputMethodController
...
...
@@ -84,33 +58,7 @@ getController(): InputMethodController
**示例:**
```
js
var
InputMethodController
=
inputMethod
.
getController
();
```
## inputMethod.getInputMethodSetting<sup>(deprecated)</sup>
getInputMethodSetting(): InputMethodSetting
获取客户端设置实例
[
InputMethodSetting
](
#inputmethodsetting8
)
。
> **说明:**
> 从API version 9开始废弃, 建议使用[getSetting](#inputmethodgetsetting9)替代
>
> 从 API version 6开始支持。
**系统能力**
: SystemCapability.MiscServices.InputMethodFramework
**返回值:**
| 类型 | 说明 |
| ----------------------------------------- | ---------------------------- |
|
[
InputMethodSetting
](
#inputmethodsetting8
)
| 回调返回当前客户端设置实例。 |
**示例:**
```
js
var
InputMethodSetting
=
inputMethod
.
getInputMethodSetting
();
let
InputMethodController
=
inputMethod
.
getController
();
```
## inputMethod.getSetting<sup>9+</sup>
...
...
@@ -131,7 +79,7 @@ getSetting(): InputMethodSetting
**示例:**
```
js
var
InputMethodSetting
=
inputMethod
.
getSetting
();
let
InputMethodSetting
=
inputMethod
.
getSetting
();
```
## inputMethod.switchInputMethod<sup>9+</sup>
...
...
@@ -227,7 +175,7 @@ getCurrentInputMethod(): InputMethodProperty
**示例:**
```
js
var
currentIme
=
inputMethod
.
getCurrentInputMethod
();
let
currentIme
=
inputMethod
.
getCurrentInputMethod
();
```
## inputMethod.switchCurrentInputMethodSubtype<sup>9+</sup>
...
...
@@ -328,7 +276,7 @@ getCurrentInputMethodSubtype(): InputMethodSubtype
**示例:**
```
js
var
currentImeSubType
=
inputMethod
.
getCurrentInputMethodSubtype
();
let
currentImeSubType
=
inputMethod
.
getCurrentInputMethodSubtype
();
```
## inputMethod.switchCurrentInputMethodAndSubtype<sup>9+</sup>
...
...
@@ -420,78 +368,56 @@ try {
}
```
## InputMethodController
下列API示例中都需使用
[
getController
](
##inputmethodgetcontroller9
)
回调获取到InputMethodController实例,再通过此实例调用对应方法。
### stopInput<sup>(deprecated)</sup>
## inputMethod.getInputMethodController<sup>(deprecated)</sup>
stopInput(callback: AsyncCallback
<
boolean
>
): void
getInputMethodController(): InputMethodController
隐藏输入法。使用callback形式返回结果。参数个数为1,否则抛出异常
。
获取客户端实例
[
InputMethodController
](
#inputmethodcontroller
)
。
> **说明:**
> 从API version 9开始废弃, 建议使用[stopInputSession](#stopinputsession9)替代
>
> 从 API version 6开始支持。
> 从API version 6开始支持,从API version 9开始废弃, 建议使用[getController()](#inputmethodgetcontroller9)替代
**系统能力**
:SystemCapability.MiscServices.InputMethodFramework
**
参数
:**
**
返回值
:**
|
参数名 | 类型 | 必填 | 说明
|
| --------
| -------- | -------- |
-------- |
|
callback | AsyncCallback
<
boolean
>
| 是 | 返回输入法隐藏是否成功
。 |
|
类型 | 说明
|
| --------
--------------------------------------- | ----------------
-------- |
|
[
InputMethodController
](
#inputmethodcontroller
)
| 回调返回当前客户端实例
。 |
**示例:**
```
js
InputMethodController
.
stopInput
((
error
,
result
)
=>
{
if
(
error
)
{
console
.
error
(
'
failed to stopInput because:
'
+
JSON
.
stringify
(
error
));
return
;
}
if
(
result
)
{
console
.
info
(
'
Success to stopInput.(callback)
'
);
}
else
{
console
.
error
(
'
Failed to stopInput.(callback)
'
);
}
});
let
InputMethodController
=
inputMethod
.
getInputMethodController
();
```
##
# stopInput
<sup>(deprecated)</sup>
##
inputMethod.getInputMethodSetting
<sup>(deprecated)</sup>
stopInput(): Promise
<
boolean
>
getInputMethodSetting(): InputMethodSetting
隐藏输入法。使用promise形式返回结果。参数个数为0,否则抛出异常
。
获取客户端设置实例
[
InputMethodSetting
](
#inputmethodsetting8
)
。
> **说明:**
> 从API version 9开始废弃, 建议使用[stopInputSession](#stopinputsession9)替代
>
> 从 API version 6开始支持。
> 从API version 6开始支持,从API version 9开始废弃, 建议使用[getSetting()](#inputmethodgetsetting9)替代
**系统能力**
: SystemCapability.MiscServices.InputMethodFramework
**返回值:**
| 类型 | 说明 |
| --------
|
-------- |
|
Promise
<
boolean
>
| 返回输入法隐藏是否成功
。 |
| --------
--------------------------------- | --------------------
-------- |
|
[
InputMethodSetting
](
#inputmethodsetting8
)
| 回调返回当前客户端设置实例
。 |
**示例:**
```
js
InputMethodController
.
stopInput
().
then
((
result
)
=>
{
if
(
result
)
{
console
.
info
(
'
Success to stopInput.(promise)
'
);
}
else
{
console
.
error
(
'
Failed to stopInput.(promise)
'
);
}
}).
catch
((
err
)
=>
{
console
.
error
(
'
stopInput promise err:
'
+
err
);
})
let
InputMethodSetting
=
inputMethod
.
getInputMethodSetting
();
```
## InputMethodController
下列API示例中都需使用
[
getController
](
##inputmethodgetcontroller9
)
回调获取到InputMethodController实例,再通过此实例调用对应方法。
### stopInputSession<sup>9+</sup>
stopInputSession(callback: AsyncCallback
<
boolean
>
): void
...
...
@@ -528,7 +454,7 @@ try {
### stopInputSession
stopInputSession(): Promise
<
boolean
>
stopInputSession(): Promise
<
boolean
>
<sup>
9+
</sup>
隐藏输入法。使用promise形式返回结果。
...
...
@@ -658,6 +584,70 @@ InputMethodController.hideSoftKeyboard().then(async (err) => {
});
```
### stopInput<sup>(deprecated)</sup>
stopInput(callback: AsyncCallback
<
boolean
>
): void
隐藏输入法。使用callback形式返回结果。参数个数为1,否则抛出异常。
> **说明:**
> 从API version 6开始支持,从API version 9开始废弃, 建议使用[stopInputSession()](#stopinputsession9)替代
**系统能力**
:SystemCapability.MiscServices.InputMethodFramework
**参数:**
| 参数名 | 类型 | 必填 | 说明 |
| -------- | -------- | -------- | -------- |
| callback | AsyncCallback
<
boolean
>
| 是 | 返回输入法隐藏是否成功。 |
**示例:**
```
js
InputMethodController
.
stopInput
((
error
,
result
)
=>
{
if
(
error
)
{
console
.
error
(
'
failed to stopInput because:
'
+
JSON
.
stringify
(
error
));
return
;
}
if
(
result
)
{
console
.
info
(
'
Success to stopInput.(callback)
'
);
}
else
{
console
.
error
(
'
Failed to stopInput.(callback)
'
);
}
});
```
### stopInput<sup>(deprecated)</sup>
stopInput(): Promise
<
boolean
>
隐藏输入法。使用promise形式返回结果。参数个数为0,否则抛出异常。
> **说明:**
> 从API version 6开始支持,从API version 9开始废弃, 建议使用[stopInputSession()](#stopinputsession9)替代
**系统能力**
: SystemCapability.MiscServices.InputMethodFramework
**返回值:**
| 类型 | 说明 |
| -------- | -------- |
| Promise
<
boolean
>
| 返回输入法隐藏是否成功。 |
**示例:**
```
js
InputMethodController
.
stopInput
().
then
((
result
)
=>
{
if
(
result
)
{
console
.
info
(
'
Success to stopInput.(promise)
'
);
}
else
{
console
.
error
(
'
Failed to stopInput.(promise)
'
);
}
}).
catch
((
err
)
=>
{
console
.
error
(
'
stopInput promise err:
'
+
err
);
})
```
## InputMethodSetting<sup>8+</sup>
下列API示例中都需使用
[
getSetting
](
#inputmethodgetsetting9
)
回调获取到InputMethodSetting实例,再通过此实例调用对应方法。
...
...
@@ -679,14 +669,14 @@ on(type: 'imeChange', callback: (inputMethodProperty: InputMethodProperty, input
**示例:**
```
js
InputMethodEngine
.
on
(
'
imeChange
'
,
(
inputMethodProperty
,
inputMethodSubtype
)
=>
{
```
js
InputMethodEngine
.
on
(
'
imeChange
'
,
(
inputMethodProperty
,
inputMethodSubtype
)
=>
{
InputMethodProperty
=
inputMethodProperty
;
InputMethodSubtype
=
inputMethodSubtype
;
});
```
});
```
### off('imeChange')<
a name="imeChange"></a><
sup>9+</sup>
### off('imeChange')<sup>9+</sup>
on(type: 'imeChange', callback: (inputMethodProperty: InputMethodProperty, inputMethodSubtype: InputMethodSubtype) => void): void
...
...
@@ -703,9 +693,9 @@ on(type: 'imeChange', callback: (inputMethodProperty: InputMethodProperty, input
**示例:**
```
js
InputMethodAbility
.
off
(
'
imeChange
'
);
```
```
js
InputMethodAbility
.
off
(
'
imeChange
'
);
```
### listInputMethodSubtype<sup>9+</sup>
...
...
@@ -903,6 +893,62 @@ try {
}
```
### showOptionalInputMethods<sup>9+</sup>
showOptionalInputMethods(callback: AsyncCallback
<
void
>
): void
显示输入法选择对话框。使用callback形式返回结果。参数个数为1,否则抛出异常。
**需要权限**
: ohos.permission.CONNECT_IME_ABILITY
**系统能力**
: SystemCapability.MiscServices.InputMethodFramework
**参数:**
| 参数名 | 类型 | 必填 | 说明 |
| -------- | -------- | -------- | -------- |
| callback | AsyncCallback
<
void
>
| 是 | 回调函数。 |
**示例:**
```
js
try
{
InputMethodSetting
.
showOptionalInputMethods
((
err
)
=>
{
if
(
err
)
{
console
.
error
(
'
showOptionalInputMethods failed:
'
+
JSON
.
stringify
(
err
));
return
;
}
console
.
info
(
'
showOptionalInputMethods success
'
);
});
}
catch
(
err
)
{
console
.
error
(
'
showOptionalInputMethods failed:
'
+
JSON
.
stringify
(
err
));
}
```
### showOptionalInputMethods<sup>9+</sup>
showOptionalInputMethods(): Promise
<
void
>
显示输入法选择对话框。使用promise形式返回结果。参数个数为0,否则抛出异常。
**系统能力**
: SystemCapability.MiscServices.InputMethodFramework
**返回值:**
| 类型 | 说明 |
| -------- | -------- |
| Promise
<
void
>
| 无返回结果的Promise对象。 |
**示例:**
```
js
InputMethodSetting
.
showOptionalInputMethods
().
then
(()
=>
{
console
.
info
(
'
displayOptionalInputMethod success.(promise)
'
);
}).
catch
((
err
)
=>
{
console
.
error
(
'
displayOptionalInputMethod promise err:
'
+
err
);
})
```
### listInputMethod<sup>(deprecated)</sup>
listInputMethod(callback: AsyncCallback
<
Array
<
InputMethodProperty
>>
): void
...
...
@@ -910,9 +956,7 @@ listInputMethod(callback: AsyncCallback<Array<InputMethodProperty>>)
查询已安装的输入法列表。使用callback形式返回结果。参数个数为1,否则抛出异常。
> **说明:**
> 从API version 9开始废弃, 建议使用[getInputMethods](#getinputmethods9)替代
>
> 从 API version 8开始支持。
> 从API version 8开始支持,从API version 9开始废弃, 建议使用[getInputMethods](#getinputmethods9)替代
**系统能力**
: SystemCapability.MiscServices.InputMethodFramework
...
...
@@ -941,9 +985,7 @@ listInputMethod(): Promise<Array<InputMethodProperty>>
查询已安装的输入法列表。使用promise形式返回结果。参数个数为0,否则抛出异常。
> **说明:**
> 从API version 9开始废弃, 建议使用[getInputMethods](#getinputmethods9-1)替代
>
> 从 API version 8开始支持。
> 从API version 8开始支持,从API version 9开始废弃, 建议使用[getInputMethods](#getinputmethods9-1)替代
**系统能力**
: SystemCapability.MiscServices.InputMethodFramework
...
...
@@ -970,9 +1012,7 @@ displayOptionalInputMethod(callback: AsyncCallback<void>): void
显示输入法选择对话框。使用callback形式返回结果。参数个数为1,否则抛出异常。
> **说明:**
> 从API version 9开始废弃, 建议使用[showOptionalInputMethods](#showoptionalinputmethods9)替代
>
> 从 API version 8开始支持。
> 从API version 8开始支持,从API version 9开始废弃, 建议使用[showOptionalInputMethods()](#showoptionalinputmethods9)替代
**系统能力**
: SystemCapability.MiscServices.InputMethodFramework
...
...
@@ -994,38 +1034,6 @@ InputMethodSetting.displayOptionalInputMethod((err) => {
});
```
### showOptionalInputMethods<sup>9+</sup>
showOptionalInputMethods(callback: AsyncCallback
<
void
>
): void
显示输入法选择对话框。使用callback形式返回结果。参数个数为1,否则抛出异常。
**需要权限**
: ohos.permission.CONNECT_IME_ABILITY
**系统能力**
: SystemCapability.MiscServices.InputMethodFramework
**参数:**
| 参数名 | 类型 | 必填 | 说明 |
| -------- | -------- | -------- | -------- |
| callback | AsyncCallback
<
void
>
| 是 | 回调函数。 |
**示例:**
```
js
try
{
InputMethodSetting
.
showOptionalInputMethods
((
err
)
=>
{
if
(
err
)
{
console
.
error
(
'
showOptionalInputMethods failed:
'
+
JSON
.
stringify
(
err
));
return
;
}
console
.
info
(
'
showOptionalInputMethods success
'
);
});
}
catch
(
err
)
{
console
.
error
(
'
showOptionalInputMethods failed:
'
+
JSON
.
stringify
(
err
));
}
```
### displayOptionalInputMethod<sup>(deprecated)</sup>
displayOptionalInputMethod(): Promise
<
void
>
...
...
@@ -1033,9 +1041,7 @@ displayOptionalInputMethod(): Promise<void>
显示输入法选择对话框。使用promise形式返回结果。参数个数为0,否则抛出异常。
> **说明:**
> 从API version 9开始废弃, 建议使用[showOptionalInputMethods](#showoptionalinputmethods9-1)替代
>
> 从 API version 8开始支持。
> 从API version 8开始支持,API version 9开始废弃, 建议使用[showOptionalInputMethods()](#showoptionalinputmethods9-1)替代
**系统能力**
: SystemCapability.MiscServices.InputMethodFramework
...
...
@@ -1054,27 +1060,3 @@ InputMethodSetting.displayOptionalInputMethod().then(() => {
console
.
error
(
'
displayOptionalInputMethod promise err:
'
+
err
);
})
```
### showOptionalInputMethods<sup>9+</sup>
showOptionalInputMethods(): Promise
<
void
>
显示输入法选择对话框。使用promise形式返回结果。参数个数为0,否则抛出异常。
**系统能力**
: SystemCapability.MiscServices.InputMethodFramework
**返回值:**
| 类型 | 说明 |
| -------- | -------- |
| Promise
<
void
>
| 无返回结果的Promise对象。 |
**示例:**
```
js
InputMethodSetting
.
showOptionalInputMethods
().
then
(()
=>
{
console
.
info
(
'
displayOptionalInputMethod success.(promise)
'
);
}).
catch
((
err
)
=>
{
console
.
error
(
'
displayOptionalInputMethod promise err:
'
+
err
);
})
```
\ No newline at end of file
zh-cn/application-dev/reference/apis/js-apis-inputmethodengine.md
浏览文件 @
beb27013
此差异已折叠。
点击以展开。
编辑
预览
Markdown
is supported
0%
请重试
或
添加新附件
.
添加附件
取消
You are about to add
0
people
to the discussion. Proceed with caution.
先完成此消息的编辑!
取消
想要评论请
注册
或
登录