Skip to content
体验新版
项目
组织
正在加载...
登录
切换导航
打开侧边栏
OpenHarmony
Docs
提交
29b76632
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看板
未验证
提交
29b76632
编写于
8月 09, 2022
作者:
O
openharmony_ci
提交者:
Gitee
8月 09, 2022
浏览文件
操作
浏览文件
下载
差异文件
!7891 新增输入法框架extension相关文档
Merge pull request !7891 from 赵凌岚/master
上级
3e6c5e27
04128420
变更
3
隐藏空白更改
内联
并排
Showing
3 changed file
with
231 addition
and
0 deletion
+231
-0
zh-cn/application-dev/reference/apis/Readme-CN.md
zh-cn/application-dev/reference/apis/Readme-CN.md
+2
-0
zh-cn/application-dev/reference/apis/js-apis-inputmethod-extension-ability.md
...v/reference/apis/js-apis-inputmethod-extension-ability.md
+66
-0
zh-cn/application-dev/reference/apis/js-apis-inputmethod-extension-context.md
...v/reference/apis/js-apis-inputmethod-extension-context.md
+163
-0
未找到文件。
zh-cn/application-dev/reference/apis/Readme-CN.md
浏览文件 @
29b76632
...
...
@@ -28,6 +28,8 @@
-
application/
[
FormExtensionContext (FormExtensionContext)
](
js-apis-formextensioncontext.md
)
-
application/
[
PermissionRequestResult (PermissionRequestResult)
](
js-apis-permissionrequestresult.md
)
-
application/
[
ServiceExtensionContext (ServiceExtensionContext)
](
js-apis-service-extension-context.md
)
-
[
InputMethodExtensionAbility (InputMethodExtensionAbility)
](
js-apis-inputmethod-extension-ability.md
)
-
[
InputMethodExtensionContext (InputMethodExtensionContext)
](
js-apis-inputmethod-extension-context.md
)
-
通用
-
[
@ohos.ability.dataUriUtils (DataUriUtils模块)
](
js-apis-DataUriUtils.md
)
-
[
@ohos.ability.errorCode (ErrorCode)
](
js-apis-ability-errorCode.md
)
...
...
zh-cn/application-dev/reference/apis/js-apis-inputmethod-extension-ability.md
0 → 100644
浏览文件 @
29b76632
# InputMethodExtensionAbility
InputMethodExtensionAbility模块,提供生态输入法应用开发者通过InputMethodExtensionAbility、InputMethodExtensionContext接口创作输入法应用,并管理输入法应用生命周期。
> **说明:**
>
> 本模块首批接口从API version 9开始支持。后续版本的新增接口,采用上角标单独标记接口的起始版本。
> 本模块接口仅可在Stage模型下使用。
## 导入模块
```
import InputMethodExtension from '@ohos.inputmethodextensionability';
```
## 属性
**系统能力**
:SystemCapability.MiscServices.InputMethodFramework
| 名称 | 参数类型 | 可读 | 可写 | 说明 |
| -------- | -------- | -------- | -------- | -------- |
| context |
[
InputMethodExtensionContext
](
js-apis-inputmethod-extension-context.md
)
| 是 | 否 | InputMethodExtension的上下文环境,继承自ExtensionContext。 |
## InputMethodExtensionAbility.onCreate()
onCreate(want: Want): void;
Extension生命周期回调,在拉起Extension输入法应用时调用,执行初始化输入法应用操作。
**系统能力**
:SystemCapability.MiscServices.InputMethodFramework
**参数:**
| 参数名 | 类型 | 必填 | 说明 |
| -------- | -------- | -------- | -------- |
| want |
[
Want
](
js-apis-application-Want.md
)
| 是 | 当前Extension相关的Want类型信息,包括ability名称、bundle名称等。 |
**示例:**
```
js
class
InputMethodExt
extends
InputMethodExtensionAbility
{
onCreate
(
want
)
{
console
.
log
(
'
onCreate, want:
'
+
want
.
abilityName
);
}
}
```
## InputMethodExtensionAbility.onDestroy()
onDestroy(): void;
Extension生命周期回调,在销毁输入法应用时回调,执行资源清理等操作。
**系统能力**
:SystemCapability.MiscServices.InputMethodFramework
**示例:**
```
js
class
InputMethodExt
extends
InputMethodExtensionAbility
{
onDestroy
()
{
console
.
log
(
'
onDestroy
'
);
}
}
```
zh-cn/application-dev/reference/apis/js-apis-inputmethod-extension-context.md
0 → 100644
浏览文件 @
29b76632
# InputMethodExtensionContext
InputMethodExtensionContext模块是InputMethodExtensionAbility的上下文环境,继承自ExtensionContext。
InputMethodExtensionContext模块提供InputMethodExtensionAbility具有的能力和接口,包括启动、停止、绑定、解绑Ability。
> **说明:**
>
> 本模块首批接口从API version 9开始支持。后续版本的新增接口,采用上角标单独标记接口的起始版本。
> 本模块接口仅可在Stage模型下使用。
## 使用说明
在使用InputMethodExtensionContext的功能前,需要通过InputMethodExtensionAbility子类实例获取。
```
js
import
InputMethodExtensionAbility
from
'
@ohos.inputmethodextensionability
'
;
class
MainAbility
extends
InputMethodExtensionAbility
{
onCreate
()
{
let
context
=
this
.
context
;
}
}
```
## InputMethodExtensionContext.startAbility
startAbility(want: Want, callback: AsyncCallback
<
void
>
): void;
启动Ability,包含一个Want类型参数。callback形式返回启动结果。
**系统能力**
:SystemCapability.MiscServices.InputMethodFramework
**参数:**
| 参数名 | 类型 | 必填 | 说明 |
| -------- | -------- | -------- | -------- |
| want |
[
Want
](
js-apis-application-Want.md
)
| 是 | Want类型参数,传入需要启动的ability的信息,如ability名称,包名等。 |
| callback | AsyncCallback
<
void
>
| 是 | 回调函数,返回接口调用是否成功的结果。 |
**示例:**
```
js
let
want
=
{
"
bundleName
"
:
"
com.example.myapp
"
,
"
abilityName
"
:
"
MyAbility
"
};
this
.
context
.
startAbility
(
want
,
(
err
)
=>
{
console
.
log
(
'
startAbility result:
'
+
JSON
.
stringify
(
err
));
});
```
## InputMethodExtensionContext.startAbility
startAbility(want: Want, options?: StartOptions): Promise
\<
void>;
启动Ability,包含Want类型参数,以及可选填的StartOption类型参数。通过Promise方法返回结果。
**系统能力**
:SystemCapability.MiscServices.InputMethodFramework
**参数:**
| 参数名 | 类型 | 必填 | 说明 |
| -------- | -------- | -------- | -------- |
| want |
[
Want
](
js-apis-application-Want.md
)
| 是 | Want类型参数,传入需要启动的ability的信息,如ability名称,包名等。 |
| options |
[
StartOptions
](
js-apis-application-StartOptions.md
)
| 否 | 启动Ability所携带的参数。 |
**返回值:**
| 类型 | 说明 |
| -------- | -------- |
| Promise
<
void
>
| 返回一个Promise,包含接口的结果。 |
**示例:**
```
js
let
want
=
{
"
bundleName
"
:
"
com.example.myapp
"
,
"
abilityName
"
:
"
MyAbility
"
};
this
.
context
.
startAbility
(
want
).
then
((
data
)
=>
{
console
.
log
(
'
success:
'
+
JSON
.
stringify
(
data
));
}).
catch
((
error
)
=>
{
console
.
log
(
'
failed:
'
+
JSON
.
stringify
(
error
));
});
```
## InputMethodExtensionContext.startAbility
startAbility(want: Want, options: StartOptions, callback: AsyncCallback
<
void
>
): void
启动Ability,包含有两个参数,Want类型和StartOption类型参数。callback形式返回启动结果。
**系统能力**
:SystemCapability.MiscServices.InputMethodFramework
**参数:**
| 参数名 | 类型 | 必填 | 说明 |
| -------- | -------- | -------- | -------- |
| want |
[
Want
](
js-apis-application-Want.md
)
| 是 | 启动Ability的want信息。 |
| options |
[
StartOptions
](
js-apis-application-StartOptions.md
)
| 是 | 启动Ability所携带的参数。 |
| callback | AsyncCallback
<
void
>
| 是 | callback形式返回启动结果。 |
**示例:**
```
js
var
want
=
{
"
deviceId
"
:
""
,
"
bundleName
"
:
"
com.extreme.test
"
,
"
abilityName
"
:
"
MainAbility
"
};
var
options
=
{
windowMode
:
0
,
};
this
.
context
.
startAbility
(
want
,
options
,
(
error
)
=>
{
console
.
log
(
"
error.code =
"
+
error
.
code
)
})
```
## InputMethodExtensionContext.terminateSelf
terminateSelf(callback: AsyncCallback
<
void
>
): void;
停止输入法应用自身,通过Callback方法返回接口调用是否成功。
**系统能力**
:SystemCapability.MiscServices.InputMethodFramework
**参数:**
| 参数名 | 类型 | 必填 | 说明 |
| -------- | ------------------------- | ---- | -------------------------------------- |
| callback | AsyncCallback
<
void
>
| 是 | 回调函数,返回接口调用是否成功的结果。 |
**示例:**
```
js
this
.
context
.
terminateSelf
((
err
)
=>
{
console
.
log
(
'
terminateSelf result:
'
+
JSON
.
stringify
(
err
));
});
```
## InputMethodExtensionContext.terminateSelf
terminateSelf(): Promise
<
void
>
;
停止输入法应用自身。通过Promise返回结果。
**系统能力**
:SystemCapability.MiscServices.InputMethodFramework
**返回值:**
| 类型 | 说明 |
| -------- | -------- |
| Promise
<
void
>
| 返回一个Promise,包含接口的结果。 |
**示例:**
```
js
this
.
context
.
terminateSelf
().
then
((
data
)
=>
{
console
.
log
(
'
success:
'
+
JSON
.
stringify
(
data
));
}).
catch
((
error
)
=>
{
console
.
log
(
'
failed:
'
+
JSON
.
stringify
(
error
));
});
```
编辑
预览
Markdown
is supported
0%
请重试
或
添加新附件
.
添加附件
取消
You are about to add
0
people
to the discussion. Proceed with caution.
先完成此消息的编辑!
取消
想要评论请
注册
或
登录