Skip to content
体验新版
项目
组织
正在加载...
登录
切换导航
打开侧边栏
OpenHarmony
Docs
提交
a4b6da7a
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看板
未验证
提交
a4b6da7a
编写于
2年前
作者:
O
openharmony_ci
提交者:
Gitee
2年前
浏览文件
操作
浏览文件
下载
差异文件
!12297 【输入法框架】API参考内容优化改进
Merge pull request !12297 from Hollokin/master
上级
38930ae0
bb6f45dc
master
OpenHarmony-4.0-Beta1
OpenHarmony-4.0-Beta2
bak_OpenHarmony-4.0-Beta1_20230529
docs-modify
monthly_20230815
revert-merge-17651-master
revert-merge-19334-OpenHarmony-4.0-Beta1
revert-merge-19586-master
revert-merge-20613-master
revert-merge-21757-OpenHarmony-4.0-Beta2
revert-merge-21765-OpenHarmony-4.0-Beta2
revert-merge-23766-master
weekly_20221213
weekly_20221220
weekly_20221227
weekly_20230103
weekly_20230110
weekly_20230117
weekly_20230124
weekly_20230131
weekly_20230207
weekly_20230214
weekly_20230221
weekly_20230228
weekly_20230307
weekly_20230314
weekly_20230321
weekly_20230328
weekly_20230404
weekly_20230411
weekly_20230418
weekly_20230425
weekly_20230502
weekly_20230509
weekly_20230516
weekly_20230523
weekly_20230530
weekly_20230606
weekly_20230613
weekly_20230619
weekly_20230626
weekly_20230627
weekly_20230704
weekly_20230712
weekly_20230725
weekly_20230801
weekly_20230808
weekly_20230815
weekly_20230822
weekly_20230829
weekly_20230905
OpenHarmony-v4.0-Beta2
OpenHarmony-v4.0-Beta1
无相关合并请求
变更
3
展开全部
隐藏空白更改
内联
并排
Showing
3 changed file
with
94 addition
and
90 deletion
+94
-90
zh-cn/application-dev/reference/apis/js-apis-inputmethod-subtype.md
...ication-dev/reference/apis/js-apis-inputmethod-subtype.md
+1
-1
zh-cn/application-dev/reference/apis/js-apis-inputmethod.md
zh-cn/application-dev/reference/apis/js-apis-inputmethod.md
+22
-20
zh-cn/application-dev/reference/apis/js-apis-inputmethodengine.md
...plication-dev/reference/apis/js-apis-inputmethodengine.md
+71
-69
未找到文件。
zh-cn/application-dev/reference/apis/js-apis-inputmethod-subtype.md
浏览文件 @
a4b6da7a
# 输入法子类型
本模块提供对输入法子类型的属性管理。
本模块提供对输入法子类型的属性管理。
输入法应用子类型的含义,如:输入法的中文版、英文版、大写模式、小写模式等都属于输入法的子类型。
> **说明:**
>
...
...
This diff is collapsed.
Click to expand it.
zh-cn/application-dev/reference/apis/js-apis-inputmethod.md
浏览文件 @
a4b6da7a
...
...
@@ -31,14 +31,14 @@ import inputMethod from '@ohos.inputmethod';
| 名称 | 类型 | 可读 | 可写 | 说明 |
| -------- | -------- | -------- | -------- | -------- |
| packageName
<sup>
(deprecated)
</sup>
| string | 是 | 否 | 输入法包名。
<br/>
**说明:**
从API8开始支持,从API9开始废弃,建议使用name替代。 |
| methodId
<sup>
(deprecated)
</sup>
| string | 是 | 否 | 输入法唯一标识。
<br/>
**说明:**
从API8开始支持,从API9开始废弃,建议使用id替代。 |
| name
<sup>
9+
</sup>
| string | 是 | 否 | 输入法内部名称。 |
| id
<sup>
9+
</sup>
| string | 是 | 否 | 输入法唯一标识。 |
| label
<sup>
9+
</sup>
| string | 是 | 否 | 输入法对外显示名称。 |
| icon
<sup>
9+
</sup>
| string | 是 | 否 | 输入法图标数据。 |
| iconId
<sup>
9+
</sup>
| number | 是 | 否 | 输入法图标资源号。 |
| extra
<sup>
9+
</sup>
| object | 是 | 否 | 输入法扩展信息。 |
| packageName
<sup>
(deprecated)
</sup>
| string | 是 | 否 | 输入法包名。
<br/>
**说明:**
从API version 8开始支持,从API version 9开始废弃,建议使用name替代。 |
| methodId
<sup>
(deprecated)
</sup>
| string | 是 | 否 | 输入法唯一标识。
<br/>
**说明:**
从API version 8开始支持,从API version 9开始废弃,建议使用id替代。 |
## inputMethod.getController<sup>9+</sup>
...
...
@@ -505,7 +505,9 @@ getInputMethodSetting(): InputMethodSetting
获取客户端设置实例
[
InputMethodSetting
](
#inputmethodsetting8
)
。
> **说明:**<br />从API version 6开始支持,从API version 9开始废弃, 建议使用[getSetting()](#inputmethodgetsetting9)替代。
> **说明:**
>
> 从API version 6开始支持,从API version 9开始废弃, 建议使用[getSetting()](#inputmethodgetsetting9)替代。
**系统能力:**
SystemCapability.MiscServices.InputMethodFramework
...
...
@@ -523,13 +525,13 @@ let inputMethodSetting = inputMethod.getInputMethodSetting();
## InputMethodController
下列API示例中都需使用
[
getController
](
#inputmethodgetcontroller9
)
回调
获取到InputMethodController实例,再通过此实例调用对应方法。
下列API示例中都需使用
[
getController
](
#inputmethodgetcontroller9
)
获取到InputMethodController实例,再通过此实例调用对应方法。
### stopInputSession<sup>9+</sup>
stopInputSession(callback: AsyncCallback
<
boolean
>
): void
结束输入会话。使用callback异步回调。
结束输入会话。
通过点击输入框实现输入会话的开启之后该接口的调用才可生效。
使用callback异步回调。
**系统能力:**
SystemCapability.MiscServices.InputMethodFramework
...
...
@@ -537,7 +539,7 @@ stopInputSession(callback: AsyncCallback<boolean>): void
| 参数名 | 类型 | 必填 | 说明 |
| -------- | -------- | -------- | -------- |
| callback | AsyncCallback
<
boolean
>
| 是 | 回调函数。当
输入法隐藏成功
,err为undefined,data为true;否则为错误对象。 |
| callback | AsyncCallback
<
boolean
>
| 是 | 回调函数。当
结束输入会话成功时
,err为undefined,data为true;否则为错误对象。 |
**错误码:**
...
...
@@ -572,7 +574,7 @@ try {
stopInputSession(): Promise
<
boolean
>
结束输入会话。使用promise异步回调。
结束输入会话。
通过点击输入框实现输入会话的开启之后此接口才可生效。
使用promise异步回调。
**系统能力:**
SystemCapability.MiscServices.InputMethodFramework
...
...
@@ -580,7 +582,7 @@ stopInputSession(): Promise<boolean>
| 类型 | 说明 |
| -------- | -------- |
| Promise
<
boolean
>
| Promise对象。返回true表示
输入法隐藏成功;返回false表示输入法隐藏
失败。 |
| Promise
<
boolean
>
| Promise对象。返回true表示
结束输入会话成功;返回false表示结束输入会话
失败。 |
**错误码:**
...
...
@@ -685,7 +687,7 @@ inputMethodController.showSoftKeyboard().then(async (err) => {
hideSoftKeyboard(callback: AsyncCallback
<
void
>
): void
隐藏软键盘。使用callback异步回调。
隐藏软键盘。
需要与输入框绑定使用。点击输入框后,才可以使用该接口的调用隐藏软键盘。
使用callback异步回调。
**需要权限:**
ohos.permission.CONNECT_IME_ABILITY
...
...
@@ -722,7 +724,7 @@ inputMethodController.hideSoftKeyboard((err) => {
hideSoftKeyboard(): Promise
<
void
>
隐藏软键盘
,使用Promise异步回调。参数个数为0,否则抛出异常
。
隐藏软键盘
。需要与输入框绑定使用。点击输入框后,才可以使用该接口的调用隐藏软键盘。使用Promise异步回调
。
**需要权限:**
ohos.permission.CONNECT_IME_ABILITY
...
...
@@ -757,7 +759,7 @@ inputMethodController.hideSoftKeyboard().then(async (err) => {
stopInput(callback: AsyncCallback
<
boolean
>
): void
结束输入会话。使用callback异步回调。
结束输入会话。
通过点击输入框实现输入会话的开启之后该接口的调用才可生效。
使用callback异步回调。
> **说明:**
>
...
...
@@ -791,7 +793,7 @@ inputMethodController.stopInput((error, result) => {
stopInput(): Promise
<
boolean
>
结束输入会话。使用promise异步回调。
结束输入会话。
通过点击输入框实现输入会话的开启之后该接口的调用才可生效。
使用promise异步回调。
> **说明:**
>
...
...
@@ -821,7 +823,7 @@ inputMethodController.stopInput().then((result) => {
## InputMethodSetting<sup>8+</sup>
下列API示例中都需使用
[
getSetting
](
#inputmethodgetsetting9
)
回调
获取到InputMethodSetting实例,再通过此实例调用对应方法。
下列API示例中都需使用
[
getSetting
](
#inputmethodgetsetting9
)
获取到InputMethodSetting实例,再通过此实例调用对应方法。
### on('imeChange')<sup>9+</sup>
...
...
@@ -879,7 +881,7 @@ listInputMethodSubtype(inputMethodProperty: InputMethodProperty, callback: Async
| 参数名 | 类型 | 必填 | 说明 |
| -------- | -------------------------------------------------- | ---- | ---------------------- |
| inputMethodProperty | InputMethodProperty| 是 |
指定获取
子类型所属的输入法应用。 |
| inputMethodProperty | InputMethodProperty| 是 | 子类型所属的输入法应用。 |
| callback | AsyncCallback
<
Array
<
[
InputMethodSubtype
](./
js-apis-inputmethod-subtype.md#inputmethodsubtype
)
>
>
| 是 | 回调函数,返回指定输入法应用的所有子类型。 |
**错误码:**
...
...
@@ -924,13 +926,13 @@ listInputMethodSubtype(inputMethodProperty: InputMethodProperty): Promise<Arr
| 参数名 | 类型 | 必填 | 说明 |
| -------- | -------------------------------------------------- | ---- | ---------------------- |
| inputMethodProperty | InputMethodProperty| 是 |
指定获取
子类型所属的输入法应用。 |
| inputMethodProperty | InputMethodProperty| 是 | 子类型所属的输入法应用。 |
**返回值:**
| 类型 | 说明 |
| ----------------------------------------------------------- | ---------------------- |
| Promise
<Array
<[
InputMethodSubtype
](./
js-apis-inputmethod-subtype.md#inputmethodsubtype
)
>
> | Promise对象,返回
已安装输入法子类型列表
。 |
| Promise
<Array
<[
InputMethodSubtype
](./
js-apis-inputmethod-subtype.md#inputmethodsubtype
)
>
> | Promise对象,返回
指定输入法应用的所有子类型
。 |
**错误码:**
...
...
@@ -1011,7 +1013,7 @@ listCurrentInputMethodSubtype(): Promise<Array<InputMethodSubtype>>
| 类型 | 说明 |
| ----------------------------------------------------------- | ---------------------- |
| Promise
<Array
<[
InputMethodSubtype
](./
js-apis-inputmethod-subtype.md#inputmethodsubtype
)
>
> | Promise对象,返回当前输入法
的子类型列表
。 |
| Promise
<Array
<[
InputMethodSubtype
](./
js-apis-inputmethod-subtype.md#inputmethodsubtype
)
>
> | Promise对象,返回当前输入法
应用的所有子类型
。 |
**错误码:**
...
...
@@ -1040,7 +1042,7 @@ try {
getInputMethods(enable: boolean, callback: AsyncCallback
<
Array
<
InputMethodProperty
>>
): void
获取已激活/未激活输入法列表。参数enable取true,返回已激活输入法列表,取false返回未激活输入法列表。使用callback异步回调。
获取已激活/未激活输入法列表。参数enable取true,返回已激活输入法列表,取false返回未激活输入法列表。
已激活/未激活输入法的确切功能当前版本未支持。当前版本中,已激活输入法包括当前使用的输入法,未激活输入法包括当前输入法以外的其他已安装的输入法。
使用callback异步回调。
**系统能力:**
SystemCapability.MiscServices.InputMethodFramework
...
...
@@ -1080,7 +1082,7 @@ try {
getInputMethods(enable: boolean): Promise
<
Array
<
InputMethodProperty
>>
获取已激活/未激活输入法列表。参数enable取true
返回已激活输入法列表,取false返回未激活输入法列表
。使用promise异步回调。
获取已激活/未激活输入法列表。参数enable取true
,返回已激活输入法列表,取false返回未激活输入法列表。已激活/未激活输入法的确切功能当前版本未支持。当前版本中,已激活输入法包括当前使用的输入法,未激活输入法包括当前输入法以外的其他已安装的输入法
。使用promise异步回调。
**系统能力:**
SystemCapability.MiscServices.InputMethodFramework
...
...
@@ -1289,7 +1291,7 @@ displayOptionalInputMethod(): Promise<void>
> **说明:**
>
> 从API version 8开始支持,API version 9开始废弃, 建议使用[showOptionalInputMethods()](#showoptionalinputmethods9-1)替代。
> 从API version 8开始支持,
从
API version 9开始废弃, 建议使用[showOptionalInputMethods()](#showoptionalinputmethods9-1)替代。
**系统能力:**
SystemCapability.MiscServices.InputMethodFramework
...
...
This diff is collapsed.
Click to expand it.
zh-cn/application-dev/reference/apis/js-apis-inputmethodengine.md
浏览文件 @
a4b6da7a
此差异已折叠。
点击以展开。
编辑
预览
Markdown
is supported
0%
请重试
或
添加新附件
.
添加附件
取消
You are about to add
0
people
to the discussion. Proceed with caution.
先完成此消息的编辑!
取消
想要评论请
注册
或
登录
反馈
建议
客服
返回
顶部