Skip to content
体验新版
项目
组织
正在加载...
登录
切换导航
打开侧边栏
OpenHarmony
Docs
提交
5b577301
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看板
提交
5b577301
编写于
5月 06, 2023
作者:
X
xinking129
浏览文件
操作
浏览文件
下载
电子邮件补丁
差异文件
add doc description
Signed-off-by:
N
xinking129
<
xinxin13@huawei.com
>
上级
d318f2d3
变更
2
隐藏空白更改
内联
并排
Showing
2 changed file
with
225 addition
and
1 deletion
+225
-1
zh-cn/application-dev/reference/apis/js-apis-app-form-formHost.md
...plication-dev/reference/apis/js-apis-app-form-formHost.md
+194
-0
zh-cn/application-dev/reference/apis/js-apis-app-form-formInfo.md
...plication-dev/reference/apis/js-apis-app-form-formInfo.md
+31
-1
未找到文件。
zh-cn/application-dev/reference/apis/js-apis-app-form-formHost.md
浏览文件 @
5b577301
...
...
@@ -1865,3 +1865,197 @@ try {
}
```
## getRunningFormInfosByFilter
function getRunningFormInfosByFilter(formProviderFilter: formInfo.formProviderFilter): Promise
<
Array
<
formInfo.RunningFormInfo
>>
根据提供方信息查询卡片已有的使用方列表信息。使用Promise异步回调。
**需要权限**
:ohos.permission.REQUIRE_FORM
**系统能力**
:SystemCapability.Ability.Form
**参数:**
| 参数名 | 类型 | 必填 | 说明 |
| ----------- | --------------- | ---- | -------------------------------- |
| formProviderFilter | formInfo.formProviderFilter | 是 | 卡片提供方应用信息。 |
**返回值:**
| 类型 | 说明 |
| ------------------- | ------------------------- |
| Promise
<
Array
<
formInfo.RunningFormInfo
>>
| Promise对象,返回查询到的使用方列表信息。 |
**错误码:**
| 错误码ID | 错误信息 |
| -------- | -------- |
| 201 | Permissions denied. |
| 202 | The application is not a system application. |
| 401 | If the input parameter is not valid parameter. |
| 16500050 | An IPC connection error happened. |
| 16501000 | An internal functional error occurred. |
| 以上错误码的详细介绍请参见
[
卡片错误码
](
../errorcodes/errorcode-form.md
)
。 | |
```
ts
import
formHost
from
'
@ohos.app.form.formHost
'
;
let
formInstanceFilter
=
{
bundleName
:
"
com.example.formprovide
"
,
abilityName
:
"
EntryFormAbility
"
,
formName
:
"
widget
"
,
moduleName
:
"
entry
"
}
try
{
formHost
.
getRunningFormInfosByFilter
(
formInstanceFilter
).
then
(
data1
=>
{
console
.
info
(
'
formHost getRunningFormInfosByFilter return err :
'
);
}).
catch
((
error
)
=>
{
console
.
error
(
`error, code:
${
error
.
code
}
, message:
${
error
.
message
}
`
);
});
}
catch
(
error
)
{
console
.
error
(
`catch error, code:
${
error
.
code
}
, message:
${
error
.
message
}
`
);
}
```
## getRunningFormInfosByFilter
function getRunningFormInfosByFilter(formProviderFilter: formInfo.formProviderFilter, callback: AsyncCallback
<
Array
<
formInfo.FormInfo
>>
): void
根据提供方信息查询卡片已有的使用方列表信息。使用callback异步回调。
**需要权限**
:ohos.permission.REQUIRE_FORM
**系统能力**
:SystemCapability.Ability.Form
**参数:**
| 参数名 | 类型 | 必填 | 说明 |
| ----------- | --------------- | ---- | -------------------------------- |
| formProviderFilter | formInfo.formProviderFilter | 是 | 卡片提供方应用信息。 |
| callback | AsyncCallback
<
Array
<
[formInfo.RunningFormInfo](js-apis-app-form-formInfo.md)
>>
| 是 | 回调函数。返回查询到的使用方列表信息,error为undefined,data为查询到的使用方列表信息;否则为错误对象。 |
**错误码:**
| 错误码ID | 错误信息 |
| -------- | -------- |
| 201 | Permissions denied. |
| 202 | The application is not a system application. |
| 401 | If the input parameter is not valid parameter. |
| 16500050 | An IPC connection error happened. |
| 16501000 | An internal functional error occurred. |
| 以上错误码的详细介绍请参见
[
卡片错误码
](
../errorcodes/errorcode-form.md
)
。 | |
```
ts
import
formHost
from
'
@ohos.app.form.formHost
'
;
let
formInstanceFilter
=
{
bundleName
:
"
com.example.formprovide
"
,
abilityName
:
"
EntryFormAbility
"
,
formName
:
"
widget
"
,
moduleName
:
"
entry
"
}
try
{
formHost
.
getRunningFormInfosByFilter
(
formInstanceFilter
,(
error
,
data
)
=>
{
if
(
error
)
{
console
.
error
(
`error, code:
${
error
.
code
}
, message:
${
error
.
message
}
`
);
}
else
{
console
.
log
(
'
formHost getRunningFormInfosByFilter, data: ${JSON.stringify(data)}
'
);
}
});
}
catch
(
error
)
{
console
.
error
(
`catch error, code:
${
error
.
code
}
, message:
${
error
.
message
}
`
);
}
```
## getRunningFormInfoById
function getRunningFormInfoById(formId: string): Promise
<
Array
<
formInfo.RunningFormInfo
>>
根据formId查询卡片已有的使用方列表信息。使用Promise异步回调。
**需要权限**
:ohos.permission.REQUIRE_FORM
**系统能力**
:SystemCapability.Ability.Form
**参数:**
| 参数名 | 类型 | 必填 | 说明 |
| ----------- | --------------- | ---- | -------------------------------- |
| formId | string | 是 | 卡片标识。 |
**返回值:**
| 类型 | 说明 |
| ------------------- | ------------------------- |
| Promise
<
Array
<
formInfo.RunningFormInfo
>>
| Promise对象,返回查询到的使用方列表信息。 |
**错误码:**
| 错误码ID | 错误信息 |
| -------- | -------- |
| 201 | Permissions denied. |
| 202 | The application is not a system application. |
| 401 | If the input parameter is not valid parameter. |
| 16500050 | An IPC connection error happened. |
| 16501000 | An internal functional error occurred. |
| 以上错误码的详细介绍请参见
[
卡片错误码
](
../errorcodes/errorcode-form.md
)
。 | |
```
ts
import
formHost
from
'
@ohos.app.form.formHost
'
;
let
formId
=
'
12400633174999288
'
;
try
{
formHost
.
getRunningFormInfoById
(
formId
).
then
(
data1
=>
{
console
.
info
(
'
formHost getRunningFormInfoById return err :
'
);
}).
catch
((
error
)
=>
{
console
.
error
(
`error, code:
${
error
.
code
}
, message:
${
error
.
message
}
`
);
});
}
catch
(
error
)
{
console
.
error
(
`catch error, code:
${
error
.
code
}
, message:
${
error
.
message
}
`
);
}
```
## getRunningFormInfoById
function getRunningFormInfoById(formId: string, callback: AsyncCallback
<
Array
<
formInfo.FormInfo
>>
): void
根据提供方信息查询卡片已有的使用方列表信息。使用callback异步回调。
**需要权限**
:ohos.permission.REQUIRE_FORM
**系统能力**
:SystemCapability.Ability.Form
**参数:**
| 参数名 | 类型 | 必填 | 说明 |
| ----------- | --------------- | ---- | -------------------------------- |
| formId | string | 是 | 卡片标识。 |
| callback | AsyncCallback
<
Array
<
[formInfo.RunningFormInfo](js-apis-app-form-formInfo.md)
>>
| 是 | 回调函数。返回查询到的使用方列表信息,error为undefined,data为查询到的使用方列表信息;否则为错误对象。 |
**错误码:**
| 错误码ID | 错误信息 |
| -------- | -------- |
| 201 | Permissions denied. |
| 202 | The application is not a system application. |
| 401 | If the input parameter is not valid parameter. |
| 16500050 | An IPC connection error happened. |
| 16501000 | An internal functional error occurred. |
| 以上错误码的详细介绍请参见
[
卡片错误码
](
../errorcodes/errorcode-form.md
)
。 | |
```
ts
import
formHost
from
'
@ohos.app.form.formHost
'
;
let
formId
=
'
12400633174999288
'
;
try
{
formHost
.
getRunningFormInfoById
(
formId
,(
error
,
data
)
=>
{
if
(
error
)
{
console
.
error
(
`error, code:
${
error
.
code
}
, message:
${
error
.
message
}
`
);
}
else
{
console
.
log
(
'
formHost getRunningFormInfoById, data: ${JSON.stringify(data)}
'
);
}
});
}
catch
(
error
)
{
console
.
error
(
`catch error, code:
${
error
.
code
}
, message:
${
error
.
message
}
`
);
}
```
\ No newline at end of file
zh-cn/application-dev/reference/apis/js-apis-app-form-formInfo.md
浏览文件 @
5b577301
...
...
@@ -137,4 +137,34 @@ import formInfo from '@ohos.app.form.formInfo';
| 名称 | 值 | 说明 |
| ----------- | ---- | ------------ |
| FORM_VISIBLE | 1 | 表示卡片为可见。 |
| FORM_INVISIBLE | 2 | 表示卡片为不可见。 |
\ No newline at end of file
| FORM_INVISIBLE | 2 | 表示卡片为不可见。 |
## RunningFormInfo
卡片使用方信息
**系统能力**
:SystemCapability.Ability.Form
| 名称 | 类型 | 可读 | 可写 | 说明 |
| ----------- | -------- | -------- | -------------------- | ------------------------------------------------------------ |
| formId | string | 是 | 否 | 卡片标识。 |
| bundleName | string | 是 | 否 | 提供方卡片所属包的Bundle名称。 |
| hostBundleName | string | 是 | 否 | 使用方卡片所属包的Bundle名称。 |
| visibilityType |
[
VisibilityType
](
#visibilitytype
)
| 是 | 否 | 卡片当前可见类型枚举。 |
| moduleName | string | 是 | 否 | 卡片所属模块的模块名称。 |
| abilityName | string | 是 | 否 | 卡片所属的Ability名称。 |
| formName | string | 是 | 否 | 卡片名称。 |
| dimension | number | 是 | 否 | 卡片规格。 |
## formProviderFilter
卡片提供方信息
**系统能力**
:SystemCapability.Ability.Form
| 名称 | 类型 | 可读 | 可写 | 说明 |
| ----------- | -------- | -------- | -------------------- | ------------------------------------------------------------ |
| bundleName | string | 是 | 否 | 提供方卡片所属包的Bundle名称。 |
| formName | string | 是 | 否 | 卡片名称。 |
| moduleName | string | 是 | 否 | 卡片所属模块的模块名称。 |
| abilityName | string | 是 | 否 | 卡片所属的Ability名称。 |
\ No newline at end of file
编辑
预览
Markdown
is supported
0%
请重试
或
添加新附件
.
添加附件
取消
You are about to add
0
people
to the discussion. Proceed with caution.
先完成此消息的编辑!
取消
想要评论请
注册
或
登录