Skip to content
体验新版
项目
组织
正在加载...
登录
切换导航
打开侧边栏
OpenHarmony
Docs
提交
fc41d891
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看板
未验证
提交
fc41d891
编写于
5月 16, 2023
作者:
O
openharmony_ci
提交者:
Gitee
5月 16, 2023
浏览文件
操作
浏览文件
下载
差异文件
!18037 formHost新增api文档,on/off/getFormsRuningInfo
Merge pull request !18037 from chenyuyan/onoff
上级
c552d02a
e0d57188
变更
1
隐藏空白更改
内联
并排
Showing
1 changed file
with
221 addition
and
0 deletion
+221
-0
zh-cn/application-dev/reference/apis/js-apis-app-form-formHost.md
...plication-dev/reference/apis/js-apis-app-form-formHost.md
+221
-0
未找到文件。
zh-cn/application-dev/reference/apis/js-apis-app-form-formHost.md
浏览文件 @
fc41d891
...
...
@@ -1178,6 +1178,95 @@ try {
}
```
## getRunningFormInfos<sup>10+</sup>
getRunningFormInfos(callback: AsyncCallback
<
Array
<
formInfo.RunningFormInfo
>>
, hostBundleName?: string): void
获取设备上正在运行的所有非临时卡片信息。使用callback异步回调。
**需要权限**
:ohos.permission.REQUIRE_FORM
**系统能力**
:SystemCapability.Ability.Form
**参数:**
| 参数名 | 类型 | 必填 | 说明 |
| ------ | ------ | ---- | ------- |
| callback | AsyncCallback
<
Array
<
formInfo.RunningFormInfo
>>
| 是 | 回调函数。获取设备上指定应用为卡片使用方的当前卡片信息成功,error为undefined,data为查询到的卡片信息。|
| hostBundleName | string | 否 | 指定要查询的卡片使用方名称,指定后会仅返回该卡片使用方下正在运行的非临时卡片信息。
<br>
缺省时,返回设备上所有正在运行的非临时卡片信息。 |
**错误码:**
以下错误码的详细介绍请参见
[
卡片错误码
](
../errorcodes/errorcode-form.md
)
。
| 错误码ID | 错误信息 |
| -------- | -------- |
| 16500050 | An IPC connection error happened. |
| 16500060 | A service connection error happened, please try again later. ||
**示例:**
```
ts
import
formHost
from
'
@ohos.app.form.formHost
'
;
try
{
formHost
.
getRunningFormInfos
((
error
,
data
)
=>
{
if
(
error
)
{
console
.
error
(
`error, code:
${
error
.
code
}
, message:
${
error
.
message
}
`
);
}
else
{
console
.
log
(
'
formHost getRunningFormInfos, data: ${JSON.stringify(data)}
'
);
}
},
'
com.example.ohos.formjsdemo
'
);
}
catch
(
error
)
{
console
.
error
(
`catch error, code:
${
error
.
code
}
, message:
${
error
.
message
}
`
);
}
```
## getRunningFormInfos<sup>10+</sup>
getRunningFormInfos(hostBundleName?: string): Promise
<
Array
<
formInfo.RunningFormInfo
>>
获取设备上正在运行的所有非临时卡片信息。使用Promise异步回调。
**需要权限**
:ohos.permission.REQUIRE_FORM
**系统能力**
:SystemCapability.Ability.Form
**参数:**
| 参数名 | 类型 | 必填 | 说明 |
| ------ | ------ | ---- | ------- |
| hostBundleName | string | 否 | 指定要查询的卡片使用方名称,指定后会仅返回该卡片使用方下正在运行的非临时卡片信息。
<br>
缺省时,返回设备上所有正在运行的非临时卡片信息。 |
**返回值:**
| 类型 | 说明 |
| :----------------------------------------------------------- | :---------------------------------- |
| Promise
<
Array
<
[formInfo.RunningFormInfo](js-apis-app-form-formInfo.md)
>>
| Promise对象,返回查询到的卡片信息。 |
**错误码:**
以下错误码的详细介绍请参见
[
卡片错误码
](
../errorcodes/errorcode-form.md
)
。
| 错误码ID | 错误信息 |
| -------- | -------- |
| 16500050 | An IPC connection error happened. |
| 16500060 | A service connection error happened, please try again later. ||
**示例:**
```
ts
import
formHost
from
'
@ohos.app.form.formHost
'
;
try
{
formHost
.
getRunningFormInfos
(
'
com.example.ohos.formjsdemo
'
).
then
((
data
)
=>
{
console
.
log
(
'
formHost getRunningFormInfos, data: ${JSON.stringify(data)}
'
);
}).
catch
((
error
)
=>
{
console
.
error
(
`error, code:
${
error
.
code
}
, message:
${
error
.
message
}
`
);
});
}
catch
(
error
)
{
console
.
error
(
`catch error, code:
${
error
.
code
}
, message:
${
error
.
message
}
`
);
}
```
## deleteInvalidForms
deleteInvalidForms(formIds: Array
<
string
>
, callback: AsyncCallback
<
number
>
): void
...
...
@@ -1464,6 +1553,138 @@ let callback = function(formId) {
formHost
.
off
(
'
formUninstall
'
,
callback
);
```
## on('formAdd')<sup>10+</sup>
on(type: 'formAdd', observerCallback: Callback
<
formInfo.RunningFormInfo
>
, bundleName?: string): void
订阅卡片新增事件。使用callback异步回调,返回当前新增卡片的
[
RunningFormInfo
](
js-apis-app-form-formInfo.md
)
。
**需要权限**
:ohos.permission.REQUIRE_FORM
**系统能力**
:SystemCapability.Ability.Form
**参数:**
| 参数名 | 类型 | 必填 | 说明 |
| ------ | ------ | ---- | ------- |
| type | string | 是 | 填写'formAdd',表示卡片新增事件。 |
| callback | Callback
<
formInfo.RunningFormInfo
>
| 是 | 回调函数。返回新增卡片的RunningFormInfo。 |
| bundleName | string | 否 | 指定订阅卡片使用方包的bundleName。缺省则订阅所有卡片使用方的卡片新增事件。 |
**示例:**
```
ts
import
formHost
from
'
@ohos.app.form.formHost
'
;
let
bundleName
=
'
ohos.samples.FormApplication
'
;
let
callback
=
function
(
data
)
{
console
.
log
(
'
a new form added, data: ${JSON.stringify(data)
'
);
}
formHost
.
on
(
'
formAdd
'
,
callback
);
formHost
.
on
(
'
formAdd
'
,
callback
,
bundleName
);
```
## off('formAdd')<sup>10+</sup>
off(type: "formAdd", observerCallback?: Callback
<
formInfo.RunningFormInfo
>
, bundleName?: string): void
取消订阅卡片新增事件。使用callback异步回调,返回当前新增卡片的
[
RunningFormInfo
](
js-apis-app-form-formInfo.md
)
。
**需要权限**
:ohos.permission.REQUIRE_FORM
**系统能力**
:SystemCapability.Ability.Form
**参数:**
| 参数名 | 类型 | 必填 | 说明 |
| ------ | ------ | ---- | ------- |
| type | string | 是 | 填写'formAdd',表示卡片新增事件。 |
| callback | Callback
<
formInfo.RunningFormInfo
>
| 否 | 回调函数。返回卡片RunningFormInfo。缺省时,表示注销对应已注册事件回调。
<br>
需与对应on('formAdd')的callback一致。|
| bundleName | string | 否 | 指定订阅卡片使用方包的bundleName。
<br>
填写该参数时,与注册时填写bundleName的on接口对应。
<br>
缺省则订阅所有卡片使用方的卡片删除事件,与注册时未填写bundleName的on接口相对应。 |
**示例:**
```
ts
import
formHost
from
'
@ohos.app.form.formHost
'
;
let
bundleName
=
'
ohos.samples.FormApplication
'
;
let
callback
=
function
(
data
)
{
console
.
log
(
'
a new form added, data: ${JSON.stringify(data)
'
);
}
formHost
.
off
(
'
formAdd
'
,
callback
);
formHost
.
off
(
'
formAdd
'
,
callback
,
bundleName
);
```
> **说明:**
> on('formAdd', callback)与off('formAdd', callback)相对应;
> on('formAdd', callback, bundleName)与off('formAdd', callback, bundleName)相对应;
> 订阅(on)只能由自己对应的取消订阅接口(off)取消。
## on('formRemove')<sup>10+</sup>
on(type: 'formRemove', observerCallback: Callback
<
formInfo.RunningFormInfo
>
, bundleName?: string): void
订阅卡片删除事件。使用callback异步回调,返回当前删除卡片的
[
RunningFormInfo
](
js-apis-app-form-formInfo.md
)
。
**需要权限**
:ohos.permission.REQUIRE_FORM
**系统能力**
:SystemCapability.Ability.Form
**参数:**
| 参数名 | 类型 | 必填 | 说明 |
| ------ | ------ | ---- | ------- |
| type | string | 是 | 填写'formRemove',表示卡片删除事件。 |
| callback | Callback
<
formInfo.RunningFormInfo
>
| 是 | 回调函数。返回删除卡片的RunningFormInfo。 |
| bundleName | string | 否 | 指定订阅卡片使用方包的bundleName。缺省则订阅所有卡片使用方的卡片删除事件。 |
**示例:**
```
ts
import
formHost
from
'
@ohos.app.form.formHost
'
;
let
bundleName
=
'
ohos.samples.FormApplication
'
;
let
callback
=
function
(
data
)
{
console
.
log
(
'
a new form added, data: ${JSON.stringify(data)
'
);
}
formHost
.
on
(
'
formRemove
'
,
callback
);
formHost
.
on
(
'
formRemove
'
,
callback
,
bundleName
);
```
## off('formRemove')<sup>10+</sup>
off(type: "formRemove", observerCallback?: Callback
<
formInfo.RunningFormInfo
>
, bundleName?: string): void
取消订阅卡片删除事件。使用callback异步回调,返回当前删除卡片的
[
RunningFormInfo
](
js-apis-app-form-formInfo.md
)
。
**需要权限**
:ohos.permission.REQUIRE_FORM
**系统能力**
:SystemCapability.Ability.Form
**参数:**
| 参数名 | 类型 | 必填 | 说明 |
| ------ | ------ | ---- | ------- |
| type | string | 是 | 填写'formRemove',表示卡片删除事件。 |
| callback | Callback
<
formInfo.RunningFormInfo
>
| 否 | 回调函数。返回卡片RunningFormInfo。缺省时,表示注销对应已注册事件回调。
<br>
需与对应on('formRemove')的callback一致。|
| bundleName | string | 否 | 指定订阅卡片使用方包的bundleName。
<br>
填写该参数时,与注册时填写bundleName的on接口对应。
<br>
缺省则订阅所有卡片使用方的卡片删除事件,与注册时未填写bundleName的on接口相对应。 |
**示例:**
```
ts
import
formHost
from
'
@ohos.app.form.formHost
'
;
let
bundleName
=
'
ohos.samples.FormApplication
'
;
let
callback
=
function
(
data
)
{
console
.
log
(
'
a new form added, data: ${JSON.stringify(data)
'
);
}
formHost
.
off
(
'
formRemove
'
,
callback
);
formHost
.
off
(
'
formRemove
'
,
callback
,
bundleName
);
```
> **说明:**
> on('formRemove', callback)与off('formRemove', callback)相对应;
> on('formRemove', callback, bundleName)与off('formRemove', callback, bundleName)相对应;
> 订阅(on)只能由自己对应的取消订阅接口(off)取消。
## notifyFormsVisible
notifyFormsVisible(formIds: Array
<
string
>
, isVisible: boolean, callback: AsyncCallback
<
void
>
): void
...
...
编辑
预览
Markdown
is supported
0%
请重试
或
添加新附件
.
添加附件
取消
You are about to add
0
people
to the discussion. Proceed with caution.
先完成此消息的编辑!
取消
想要评论请
注册
或
登录