Skip to content
体验新版
项目
组织
正在加载...
登录
切换导航
打开侧边栏
OpenHarmony
Docs
提交
cec23ad1
D
Docs
项目概览
OpenHarmony
/
Docs
接近 2 年 前同步成功
通知
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看板
未验证
提交
cec23ad1
编写于
3月 22, 2022
作者:
O
openharmony_ci
提交者:
Gitee
3月 22, 2022
浏览文件
操作
浏览文件
下载
差异文件
!2232 添加jformHost api资料
Merge pull request !2232 from 李伟峰/master
上级
c5a88fdf
97a48953
变更
2
隐藏空白更改
内联
并排
Showing
2 changed file
with
951 addition
and
4 deletion
+951
-4
zh-cn/application-dev/reference/apis/js-apis-formhost.md
zh-cn/application-dev/reference/apis/js-apis-formhost.md
+945
-0
zh-cn/application-dev/reference/apis/js-apis-formprovider.md
zh-cn/application-dev/reference/apis/js-apis-formprovider.md
+6
-4
未找到文件。
zh-cn/application-dev/reference/apis/js-apis-formhost.md
0 → 100644
浏览文件 @
cec23ad1
# FormHost
>  **说明:**
> 本模块首批接口从API version 8开始支持。后续版本的新增接口,采用上角标单独标记接口的起始版本。
卡片提供方相关接口。
## 导入模块
```
import formHost from '@ohos.application.formHost';
```
## 权限
ohos.permission.REQUIRE_FORM
ohos.permission.GET_BUNDLE_INFO_PRIVILEGED
## deleteForm
deleteForm(formId: string, callback: AsyncCallback
<
void
>
): void;
删除指定的卡片。调用此方法后,应用程序将无法使用该卡片,卡片管理器服务不再保留有关该卡片的信息。
**系统能力:**
SystemCapability.Ability.Form
**参数:**
| 参数名 | 类型 | 必填 | 说明 |
| ------ | ------ | ---- | ------- |
| formId | string | 是 | 卡片标识 |
| callback | AsyncCallback
<
void
>
| 是 | callback形式返回启动结果 |
**示例:**
```
js
var
formId
=
"
12400633174999288
"
;
formHost
.
deleteForm
(
formId
,
(
error
,
data
)
=>
{
if
(
error
)
{
console
.
log
(
'
formHost deleteForm, error:
'
+
error
.
code
);
}
});
```
## deleteForm
deleteForm(formId: string): Promise
<
void
>
;
删除指定的卡片。调用此方法后,应用程序将无法使用该卡片,卡片管理器服务不再保留有关该卡片的信息。
**参数:**
| 参数名 | 类型 | 必填 | 说明 |
| ------ | ------ | ---- | ------- |
| formId | string | 是 | 卡片标识 |
**系统能力:**
SystemCapability.Ability.Form
**参数:**
```
js
var
formId
=
"
12400633174999288
"
;
formHost
.
deleteForm
(
formId
).
catch
((
error
)
=>
{
console
.
log
(
'
formProvider deleteForm, error:
'
+
JSON
.
stringify
(
error
));
});
```
## releaseForm
releaseForm(formId: string, callback: AsyncCallback
<
void
>
): void;
释放指定的卡片。调用此方法后,应用程序将无法使用该卡片,但卡片管理器服务仍然保留有关该卡片的缓存信息和存储信息。
**系统能力:**
SystemCapability.Ability.Form
**参数:**
| 参数名 | 类型 | 必填 | 说明 |
| ------ | ------ | ---- | ------- |
| formId | string | 是 | 卡片标识 |
| callback | AsyncCallback
<
void
>
| 是 | callback形式返回启动结果 |
**示例:**
```
js
var
formId
=
"
12400633174999288
"
;
formHost
.
releaseForm
(
formId
,
(
error
,
data
)
=>
{
if
(
error
)
{
console
.
log
(
'
formHost releaseForm, error:
'
+
error
.
code
);
}
});
```
## releaseForm
releaseForm(formId: string, isReleaseCache: boolean, callback: AsyncCallback
<
void
>
): void;
释放指定的卡片。调用此方法后,应用程序将无法使用该卡片,卡片管理器服务保留有关该卡片的存储信息,可以选择是否保留缓存信息。
**系统能力:**
SystemCapability.Ability.Form
**参数:**
| 参数名 | 类型 | 必填 | 说明 |
| -------------- | ------ | ---- | ----------- |
| formId | string | 是 | 卡片标识 |
| isReleaseCache | boolean | 是 | 是否释放缓存 |
| callback | AsyncCallback
<
void
>
| 是 | callback形式返回启动结果 |
**示例:**
```
js
var
formId
=
"
12400633174999288
"
;
formHost
.
releaseForm
(
formId
,
true
,
(
error
,
data
)
=>
{
if
(
error
)
{
console
.
log
(
'
formHost releaseForm, error:
'
+
error
.
code
);
}
});
```
## releaseForm
releaseForm(formId: string, isReleaseCache?: boolean): Promise
<
void
>
;
释放指定的卡片。调用此方法后,应用程序将无法使用该卡片,卡片管理器服务保留有关该卡片的存储信息,可以选择是否保留缓存信息。
**系统能力:**
SystemCapability.Ability.Form
**参数:**
| 参数名 | 类型 | 必填 | 说明 |
| -------------- | ------ | ---- | ----------- |
| formId | string | 是 | 卡片标识 |
| isReleaseCache | boolean | 否 | 是否释放缓存 |
**示例:**
```
js
var
formId
=
"
12400633174999288
"
;
formHost
.
releaseForm
(
formId
,
true
).
catch
((
error
)
=>
{
console
.
log
(
'
formProvider releaseForm, error:
'
+
JSON
.
stringify
(
error
));
});
```
## requestForm
requestForm(formId: string, callback: AsyncCallback
<
void
>
): void;
请求卡片更新。
**系统能力:**
SystemCapability.Ability.Form
**参数:**
| 参数名 | 类型 | 必填 | 说明 |
| ------ | ------ | ---- | ------- |
| formId | string | 是 | 卡片标识 |
| callback | AsyncCallback
<
void
>
| 是 | callback形式返回启动结果 |
**示例:**
```
js
var
formId
=
"
12400633174999288
"
;
formHost
.
requestForm
(
formId
,
(
error
,
data
)
=>
{
if
(
error
)
{
console
.
log
(
'
formHost requestForm, error:
'
+
error
.
code
);
}
});
```
## requestForm
requestForm(formId: string): Promise
<
void
>
;
请求卡片更新。
**参数:**
| 参数名 | 类型 | 必填 | 说明 |
| ------ | ------ | ---- | ------- |
| formId | string | 是 | 卡片标识 |
**系统能力:**
SystemCapability.Ability.Form
**示例:**
```
js
var
formId
=
"
12400633174999288
"
;
formHost
.
requestForm
(
formId
).
catch
((
error
)
=>
{
console
.
log
(
'
formProvider requestForm, error:
'
+
JSON
.
stringify
(
error
));
});
```
## castTempForm
castTempForm(formId: string, callback: AsyncCallback
<
void
>
): void;
将指定的临时卡片转换为普通卡片。
**系统能力:**
SystemCapability.Ability.Form
**参数:**
| 参数名 | 类型 | 必填 | 说明 |
| ------ | ------ | ---- | ------- |
| formId | string | 是 | 卡片标识 |
| callback | AsyncCallback
<
void
>
| 是 | callback形式返回启动结果 |
**示例:**
```
js
var
formId
=
"
12400633174999288
"
;
formHost
.
castTempForm
(
formId
,
(
error
,
data
)
=>
{
if
(
error
)
{
console
.
log
(
'
formHost castTempForm, error:
'
+
error
.
code
);
}
});
```
## castTempForm
castTempForm(formId: string): Promise
<
void
>
;
将指定的临时卡片转换为普通卡片。
**参数:**
| 参数名 | 类型 | 必填 | 说明 |
| ------ | ------ | ---- | ------- |
| formId | string | 是 | 卡片标识 |
**系统能力:**
SystemCapability.Ability.Form
**示例:**
```
js
var
formId
=
"
12400633174999288
"
;
formHost
.
castTempForm
(
formId
).
catch
((
error
)
=>
{
console
.
log
(
'
formProvider castTempForm, error:
'
+
JSON
.
stringify
(
error
));
});
```
## notifyVisibleForms
notifyVisibleForms(formId: string, callback: AsyncCallback
<
void
>
): void;
向卡片框架发送通知以使指定的卡片可见。该方法调用成功后,会调用onVisibilityChange通知卡片提供方。
**系统能力:**
SystemCapability.Ability.Form
**参数:**
| 参数名 | 类型 | 必填 | 说明 |
| ------ | ------ | ---- | ------- |
| formId | string | 是 | 卡片标识 |
| callback | AsyncCallback
<
void
>
| 是 | callback形式返回启动结果 |
**示例:**
```
js
var
formId
=
"
12400633174999288
"
;
formHost
.
notifyVisibleForms
(
formId
,
(
error
,
data
)
=>
{
if
(
error
)
{
console
.
log
(
'
formHost notifyVisibleForms, error:
'
+
error
.
code
);
}
});
```
## notifyVisibleForms
notifyVisibleForms(formId: string): Promise
<
void
>
;
向卡片框架发送通知以使指定的卡片可见。该方法调用成功后,会调用onVisibilityChange通知卡片提供方。
**参数:**
| 参数名 | 类型 | 必填 | 说明 |
| ------ | ------ | ---- | ------- |
| formId | string | 是 | 卡片标识 |
**系统能力:**
SystemCapability.Ability.Form
**示例:**
```
js
var
formId
=
"
12400633174999288
"
;
formHost
.
notifyVisibleForms
(
formId
).
catch
((
error
)
=>
{
console
.
log
(
'
formProvider notifyVisibleForms, error:
'
+
JSON
.
stringify
(
error
));
});
```
## notifyInvisibleForms
notifyInvisibleForms(formId: string, callback: AsyncCallback
<
void
>
): void;
向卡片框架发送通知以使指定的卡片不可见。该方法调用成功后,会调用onVisibilityChange通知卡片提供方。
**系统能力:**
SystemCapability.Ability.Form
**参数:**
| 参数名 | 类型 | 必填 | 说明 |
| ------ | ------ | ---- | ------- |
| formId | string | 是 | 卡片标识 |
| callback | AsyncCallback
<
void
>
| 是 | callback形式返回启动结果 |
**示例:**
```
js
var
formId
=
"
12400633174999288
"
;
formHost
.
notifyInvisibleForms
(
formId
,
(
error
,
data
)
=>
{
if
(
error
)
{
console
.
log
(
'
formHost notifyInvisibleForms, error:
'
+
error
.
code
);
}
});
```
## notifyInvisibleForms
notifyInvisibleForms(formId: string): Promise
<
void
>
;
向卡片框架发送通知以使指定的卡片不可见。该方法调用成功后,会调用onVisibilityChange通知卡片提供方。
**参数:**
| 参数名 | 类型 | 必填 | 说明 |
| ------ | ------ | ---- | ------- |
| formId | string | 是 | 卡片标识 |
**系统能力:**
SystemCapability.Ability.Form
**示例:**
```
js
var
formId
=
"
12400633174999288
"
;
formHost
.
notifyInvisibleForms
(
formId
).
catch
((
error
)
=>
{
console
.
log
(
'
formProvider notifyInvisibleForms, error:
'
+
JSON
.
stringify
(
error
));
});
```
## enableFormsUpdate
enableFormsUpdate(formId: string, callback: AsyncCallback
<
void
>
): void;
向卡片框架发送通知以使指定的卡片可以更新。该方法调用成功后,卡片刷新状态设置为使能,卡片可以接收来自卡片提供方的更新。
**系统能力:**
SystemCapability.Ability.Form
**参数:**
| 参数名 | 类型 | 必填 | 说明 |
| ------ | ------ | ---- | ------- |
| formId | string | 是 | 卡片标识 |
| callback | AsyncCallback
<
void
>
| 是 | callback形式返回启动结果 |
**示例:**
```
js
var
formId
=
"
12400633174999288
"
;
formHost
.
enableFormsUpdate
(
formId
,
(
error
,
data
)
=>
{
if
(
error
)
{
console
.
log
(
'
formHost enableFormsUpdate, error:
'
+
error
.
code
);
}
});
```
## enableFormsUpdate
enableFormsUpdate(formId: string): Promise
<
void
>
;
向卡片框架发送通知以使指定的卡片可以更新。该方法调用成功后,卡片刷新状态设置为使能,卡片可以接收来自卡片提供方的更新。
**参数:**
| 参数名 | 类型 | 必填 | 说明 |
| ------ | ------ | ---- | ------- |
| formId | string | 是 | 卡片标识 |
**系统能力:**
SystemCapability.Ability.Form
**示例:**
```
js
var
formId
=
"
12400633174999288
"
;
formHost
.
enableFormsUpdate
(
formId
).
catch
((
error
)
=>
{
console
.
log
(
'
formProvider enableFormsUpdate, error:
'
+
JSON
.
stringify
(
error
));
});
```
## disableFormsUpdate
disableFormsUpdate(formId: string, callback: AsyncCallback
<
void
>
): void;
向卡片框架发送通知以使指定的卡片不可以更新。该方法调用成功后,卡片刷新状态设置为去使能,卡片不可以接收来自卡片提供方的更新。
**系统能力:**
SystemCapability.Ability.Form
**参数:**
| 参数名 | 类型 | 必填 | 说明 |
| ------ | ------ | ---- | ------- |
| formId | string | 是 | 卡片标识 |
| callback | AsyncCallback
<
void
>
| 是 | callback形式返回启动结果 |
**示例:**
```
js
var
formId
=
"
12400633174999288
"
;
formHost
.
disableFormsUpdate
(
formId
,
(
error
,
data
)
=>
{
if
(
error
)
{
console
.
log
(
'
formHost disableFormsUpdate, error:
'
+
error
.
code
);
}
});
```
## disableFormsUpdate
disableFormsUpdate(formId: string): Promise
<
void
>
;
向卡片框架发送通知以使指定的卡片不可以更新。该方法调用成功后,卡片刷新状态设置为去使能,卡片不可以接收来自卡片提供方的更新。
**参数:**
| 参数名 | 类型 | 必填 | 说明 |
| ------ | ------ | ---- | ------- |
| formId | string | 是 | 卡片标识 |
**系统能力:**
SystemCapability.Ability.Form
**示例:**
```
js
var
formId
=
"
12400633174999288
"
;
formHost
.
disableFormsUpdate
(
formId
).
catch
((
error
)
=>
{
console
.
log
(
'
formProvider disableFormsUpdate, error:
'
+
JSON
.
stringify
(
error
));
});
```
## isSystemReady
isSystemReady(callback: AsyncCallback
<
void
>
): void;
检查系统是否准备好。
**系统能力:**
SystemCapability.Ability.Form
**参数:**
| 参数名 | 类型 | 必填 | 说明 |
| ------ | ------ | ---- | ------- |
| callback | AsyncCallback
<
void
>
| 是 | callback形式返回启动结果 |
**示例:**
```
js
var
formId
=
"
12400633174999288
"
;
formHost
.
isSystemReady
((
error
,
data
)
=>
{
if
(
error
)
{
console
.
log
(
'
formHost isSystemReady, error:
'
+
error
.
code
);
}
});
```
## isSystemReady
isSystemReady(): Promise
<
void
>
;
检查系统是否准备好。
**系统能力:**
SystemCapability.Ability.Form
**示例:**
```
js
var
formId
=
"
12400633174999288
"
;
formHost
.
isSystemReady
().
catch
((
error
)
=>
{
console
.
log
(
'
formProvider isSystemReady, error:
'
+
JSON
.
stringify
(
error
));
});
```
## getAllFormsInfo
getAllFormsInfo(callback: AsyncCallback
<
Array
<
FormInfo
>>
): void;
获取设备上所有应用提供的卡片信息。
**系统能力:**
SystemCapability.Ability.Form
**参数:**
| 参数名 | 类型 | 必填 | 说明 |
| ------ | ------ | ---- | ------- |
| callback | AsyncCallback
<
Array
<
[FormInfo](./js-apis-formInfo.md#forminfo-1)
>>
| 是 | callback形式返回查询到的卡片信息 |
**示例:**
```
js
formHost
.
getAllFormsInfo
((
error
,
data
)
=>
{
if
(
error
)
{
console
.
log
(
'
formHost getAllFormsInfo, error:
'
+
error
.
code
);
}
});
```
## getAllFormsInfo
getAllFormsInfo(): Promise
<
Array
<
FormInfo
>>
;
获取设备上所有应用提供的卡片信息。
**系统能力:**
SystemCapability.Ability.Form
**返回值:**
| 类型 | 说明 |
| :------------ | :---------------------------------- |
| Promise
<
Array
<
[FormInfo](./js-apis-formInfo.md#forminfo-1)
>>
| Promise实例,用于获取异步返回查询到的卡片信息 |
**示例:**
```
js
formHost
.
getAllFormsInfo
().
catch
((
error
)
=>
{
console
.
log
(
'
formProvider getAllFormsInfo, error:
'
+
JSON
.
stringify
(
error
));
});
```
## getFormsInfo
getFormsInfo(bundleName: string, callback: AsyncCallback
<
Array
<
FormInfo
>>
): void;
获取设备上指定应用程序提供的卡片信息。
**系统能力:**
SystemCapability.Ability.Form
**参数:**
| 参数名 | 类型 | 必填 | 说明 |
| ------ | ------ | ---- | ------- |
| bundleName | string | 是 | 要查询的应用程序包名称 |
| callback | AsyncCallback
<
Array
<
[FormInfo](./js-apis-formInfo.md#forminfo-1)
>>
| 是 | callback形式返回查询到的卡片信息 |
**示例:**
```
js
formHost
.
getFormsInfo
(
"
com.example.ohos.accountjsdemo
"
,
(
error
,
data
)
=>
{
if
(
error
)
{
console
.
log
(
'
formHost getFormsInfo, error:
'
+
error
.
code
);
}
});
```
## getFormsInfo
getFormsInfo(bundleName: string, moduleName: string, callback: AsyncCallback
<
Array
<
FormInfo
>>
): void;
获取设备上指定应用程序提供的卡片信息。
**系统能力:**
SystemCapability.Ability.Form
**参数:**
| 参数名 | 类型 | 必填 | 说明 |
| ------ | ------ | ---- | ------- |
| bundleName | string | 是 | 要查询的应用程序包名称 |
| moduleName | string | 是 | 要查询的模块名称 |
| callback | AsyncCallback
<
Array
<
[FormInfo](./js-apis-formInfo.md#forminfo-1)
>>
| 是 | callback形式返回查询到的卡片信息 |
**示例:**
```
js
formHost
.
getFormsInfo
(
"
com.example.ohos.accountjsdemo
"
,
(
error
,
data
)
=>
{
if
(
error
)
{
console
.
log
(
'
formHost getFormsInfo, error:
'
+
error
.
code
);
}
});
```
## getFormsInfo
getFormsInfo(bundleName: string, moduleName?: string): Promise
<
Array
<
FormInfo
>>
;
获取设备上所有应用提供的卡片信息。
**系统能力:**
SystemCapability.Ability.Form
**参数:**
| 参数名 | 类型 | 必填 | 说明 |
| ------ | ------ | ---- | ------- |
| bundleName | string | 是 | 要查询的应用程序包名称 |
| moduleName | string | 否 | 要查询的模块名称 |
**返回值:**
| 类型 | 说明 |
| :------------ | :---------------------------------- |
| Promise
<
Array
<
[FormInfo](./js-apis-formInfo.md#forminfo-1)
>>
| Promise实例,用于获取异步返回查询到的卡片信息 |
**示例:**
```
js
formHost
.
getAllFormsInfo
().
catch
((
error
)
=>
{
console
.
log
(
'
formProvider getAllFormsInfo, error:
'
+
JSON
.
stringify
(
error
));
});
```
## deleteInvalidForms
deleteInvalidForms(formIds: Array
<
string
>
, callback: AsyncCallback
<
number
>
): void;
根据列表删除应用程序的无效卡片。
**系统能力:**
SystemCapability.Ability.Form
**参数:**
| 参数名 | 类型 | 必填 | 说明 |
| ------ | ------ | ---- | ------- |
| formIds | Array
<
string
>
| 是 | 卡片标识列表 |
| callback | AsyncCallback
<
number
>
| 是 | callback形式返回删除的卡片个数 |
**示例:**
```
js
var
formIds
=
new
Array
(
"
12400633174999288
"
,
"
12400633174999289
"
);
formHost
.
deleteInvalidForms
(
formIds
,
(
error
,
data
)
=>
{
if
(
error
)
{
console
.
log
(
'
formHost deleteInvalidForms, error:
'
+
error
.
code
);
}
});
```
## deleteInvalidForms
function deleteInvalidForms(formIds: Array<string>): Promise
<
number
>
;
根据列表删除应用程序的无效卡片。
**参数:**
| 参数名 | 类型 | 必填 | 说明 |
| ------ | ------ | ---- | ------- |
| formIds | Array
<
string
>
| 是 | 卡片标识列表 |
**返回值:**
| 类型 | 说明 |
| :------------ | :---------------------------------- |
| Promise
<
number
>
| Promise实例,用于获取异步返回删除的卡片个数 |
**系统能力:**
SystemCapability.Ability.Form
**示例:**
```
js
var
formIds
=
new
Array
(
"
12400633174999288
"
,
"
12400633174999289
"
);
formHost
.
deleteInvalidForms
(
formIds
).
catch
((
error
)
=>
{
console
.
log
(
'
formProvider deleteInvalidForms, error:
'
+
JSON
.
stringify
(
error
));
});
```
## acquireFormState
acquireFormState(want: Want, callback: AsyncCallback
<
FormStateInfo
>
): void;
获取卡片状态
**系统能力:**
SystemCapability.Ability.Form
**参数:**
| 参数名 | 类型 | 必填 | 说明 |
| ------ | ------ | ---- | ------- |
| want |
[
Want
](
js-apis-featureAbility.md#want
)
| 是 | 查询卡片状态时携带的want信息 |
| callback | AsyncCallback
<
[FormStateInfo](./js-apis-formInfo.md#formstateinfo)
>
| 是 | callback形式返回卡片状态 |
**示例:**
```
js
var
want
=
{
"
deviceId
"
:
""
,
"
bundleName
"
:
"
com.extreme.test
"
,
"
abilityName
"
:
"
com.extreme.test.MainAbility
"
};
formHost
.
acquireFormState
(
want
,
(
error
,
data
)
=>
{
if
(
error
)
{
console
.
log
(
'
formHost acquireFormState, error:
'
+
error
.
code
);
}
});
```
## acquireFormState
function acquireFormState(formIds: Array<string>): Promise
<
formInfo.FormStateInfo
>
;
根据列表删除应用程序的无效卡片。
**参数:**
| 参数名 | 类型 | 必填 | 说明 |
| ------ | ------ | ---- | ------- |
| formIds | Array
<
string
>
| 是 | 卡片标识列表 |
**返回值:**
| 类型 | 说明 |
| :------------ | :---------------------------------- |
| Promise
<
[FormStateInfo](./js-apis-formInfo.md#formstateinfo)
>
| Promise实例,用于返回卡片状态 |
**系统能力:**
SystemCapability.Ability.Form
**示例:**
```
js
var
want
=
{
"
deviceId
"
:
""
,
"
bundleName
"
:
"
com.extreme.test
"
,
"
abilityName
"
:
"
com.extreme.test.MainAbility
"
};
formHost
.
acquireFormState
(
want
).
catch
((
error
)
=>
{
console
.
log
(
'
formProvider acquireFormState, error:
'
+
JSON
.
stringify
(
error
));
});
```
## on("formUninstall")
on(type: "formUninstall", callback: Callback
<
string
>
): void;
获取卡片状态
**系统能力:**
SystemCapability.Ability.Form
**参数:**
| 参数名 | 类型 | 必填 | 说明 |
| ------ | ------ | ---- | ------- |
| type | string | 是 | 填写"formUninstall",表示卡片卸载事件 |
| callback | Callback
<
string
>
| 是 | 接口本身调用的回调方法 |
**示例:**
```
js
formHost
.
on
(
"
formUninstall
"
,
(
error
,
data
)
=>
{
if
(
error
)
{
console
.
log
(
'
formHost on formUninstall, error:
'
+
error
.
code
);
}
});
```
## off("formUninstall")
off(type: "formUninstall", callback: Callback
<
string
>
): void;
获取卡片状态
**系统能力:**
SystemCapability.Ability.Form
**参数:**
| 参数名 | 类型 | 必填 | 说明 |
| ------ | ------ | ---- | ------- |
| type | string | 是 | 填写"formUninstall",表示卡片卸载事件 |
| callback | Callback
<
string
>
| 是 | 接口本身调用的回调方法 |
**示例:**
```
js
formHost
.
off
(
"
formUninstall
"
,
(
error
,
data
)
=>
{
if
(
error
)
{
console
.
log
(
'
formHost off formUninstall, error:
'
+
error
.
code
);
}
});
```
## notifyFormsVisible
notifyFormsVisible(formIds: Array
<
string
>
, isVisible: boolean, callback: AsyncCallback
<
void
>
): void;
通知卡片是否可见。
**系统能力:**
SystemCapability.Ability.Form
**参数:**
| 参数名 | 类型 | 必填 | 说明 |
| ------ | ------ | ---- | ------- |
| formIds | Array
<
string
>
| 是 | 卡片标识列表 |
| isVisible | boolean | 是 | 是否可见 |
| callback | AsyncCallback
<
void
>
| 是 | callback形式返回启动结果 |
**示例:**
```
js
var
formIds
=
new
Array
(
"
12400633174999288
"
,
"
12400633174999289
"
);
formHost
.
notifyFormsVisible
(
formIds
,
true
,
(
error
,
data
)
=>
{
if
(
error
)
{
console
.
log
(
'
formHost notifyFormsVisible, error:
'
+
error
.
code
);
}
});
```
## notifyFormsVisible
notifyFormsVisible(formIds: Array
<
string
>
, isVisible: boolean): Promise
<
void
>
;
通知卡片是否可见。
**系统能力:**
SystemCapability.Ability.Form
**参数:**
| 参数名 | 类型 | 必填 | 说明 |
| ------ | ------ | ---- | ------- |
| formIds | Array
<
string
>
| 是 | 卡片标识列表 |
| isVisible | boolean | 是 | 是否可见 |
**示例:**
```
js
var
formIds
=
new
Array
(
"
12400633174999288
"
,
"
12400633174999289
"
);
formHost
.
notifyFormsVisible
(
formIds
,
true
).
catch
((
error
)
=>
{
console
.
log
(
'
formProvider notifyFormsVisible, error:
'
+
JSON
.
stringify
(
error
));
});
```
## notifyFormsEnableUpdate
notifyFormsEnableUpdate(formIds: Array
<
string
>
, isEnableUpdate: boolean, callback: AsyncCallback
<
void
>
): void;
通知卡片是否启用更新状态。
**系统能力:**
SystemCapability.Ability.Form
**参数:**
| 参数名 | 类型 | 必填 | 说明 |
| ------ | ------ | ---- | ------- |
| formIds | Array
<
string
>
| 是 | 卡片标识列表 |
| isEnableUpdate | boolean | 是 | 是否使能更新 |
| callback | AsyncCallback
<
void
>
| 是 | callback形式返回启动结果 |
**示例:**
```
js
var
formIds
=
new
Array
(
"
12400633174999288
"
,
"
12400633174999289
"
);
formHost
.
notifyFormsEnableUpdate
(
formIds
,
true
,
(
error
,
data
)
=>
{
if
(
error
)
{
console
.
log
(
'
formHost notifyFormsEnableUpdate, error:
'
+
error
.
code
);
}
});
```
## notifyFormsEnableUpdate
notifyFormsEnableUpdate(formIds: Array
<
string
>
, isEnableUpdate: boolean): Promise
<
void
>
;
通知卡片是否启用更新状态。
**系统能力:**
SystemCapability.Ability.Form
**参数:**
| 参数名 | 类型 | 必填 | 说明 |
| ------ | ------ | ---- | ------- |
| formIds | Array
<
string
>
| 是 | 卡片标识列表 |
| isEnableUpdate | boolean | 是 | 是否使能更新 |
**示例:**
```
js
var
formIds
=
new
Array
(
"
12400633174999288
"
,
"
12400633174999289
"
);
formHost
.
notifyFormsEnableUpdate
(
formIds
,
true
).
catch
((
error
)
=>
{
console
.
log
(
'
formProvider notifyFormsEnableUpdate, error:
'
+
JSON
.
stringify
(
error
));
});
```
\ No newline at end of file
zh-cn/application-dev/reference/apis/js-apis-formprovider.md
浏览文件 @
cec23ad1
...
@@ -17,7 +17,7 @@ import formProvider from '@ohos.application.formProvider';
...
@@ -17,7 +17,7 @@ import formProvider from '@ohos.application.formProvider';
## setFormNextRefreshTime
## setFormNextRefreshTime
setFormNextRefreshTime(formId: string, minute: number, callback: AsyncCallback
<void>
): void;
setFormNextRefreshTime(formId: string, minute: number, callback: AsyncCallback
<
void
>
): void;
设置指定卡片的下一次更新时间。
设置指定卡片的下一次更新时间。
...
@@ -31,6 +31,7 @@ SystemCapability.Ability.Form
...
@@ -31,6 +31,7 @@ SystemCapability.Ability.Form
| ------ | ------ | ---- | ------------------------------------- |
| ------ | ------ | ---- | ------------------------------------- |
| formId | string | 是 | 卡片标识 |
| formId | string | 是 | 卡片标识 |
| minute | number | 是 | 指定多久之后更新,单位分钟,大于等于5 |
| minute | number | 是 | 指定多久之后更新,单位分钟,大于等于5 |
| callback | AsyncCallback
<
void
>
| 是 | callback形式返回启动结果 |
**示例:**
**示例:**
...
@@ -45,7 +46,7 @@ SystemCapability.Ability.Form
...
@@ -45,7 +46,7 @@ SystemCapability.Ability.Form
## setFormNextRefreshTime
## setFormNextRefreshTime
setFormNextRefreshTime(formId: string, minute: number): Promise
<void>
;
setFormNextRefreshTime(formId: string, minute: number): Promise
<
void
>
;
设置指定卡片的下一次更新时间,以promise方式返回。
设置指定卡片的下一次更新时间,以promise方式返回。
...
@@ -71,7 +72,7 @@ SystemCapability.Ability.Form
...
@@ -71,7 +72,7 @@ SystemCapability.Ability.Form
## updateForm
## updateForm
updateForm(formId: string, formBindingData:
formBindingData.FormBindingData, callback: AsyncCallback
<void>
): void;
updateForm(formId: string, formBindingData:
FormBindingData, callback: AsyncCallback
<
void
>
): void;
更新指定的卡片。
更新指定的卡片。
...
@@ -85,6 +86,7 @@ SystemCapability.Ability.Form
...
@@ -85,6 +86,7 @@ SystemCapability.Ability.Form
| ------ | ---------------------------------------------------------------------- | ---- | ---------------- |
| ------ | ---------------------------------------------------------------------- | ---- | ---------------- |
| formId | string | 是 | 请求更新的卡片标识 |
| formId | string | 是 | 请求更新的卡片标识 |
| formBindingData |
[
FormBindingData
](
js-apis-formbindingdata.md#formbindingdata
)
| 是 | 用于更新的数据 |
| formBindingData |
[
FormBindingData
](
js-apis-formbindingdata.md#formbindingdata
)
| 是 | 用于更新的数据 |
| callback | AsyncCallback
<
void
>
| 是 | callback形式返回启动结果 |
**示例:**
**示例:**
...
@@ -101,7 +103,7 @@ SystemCapability.Ability.Form
...
@@ -101,7 +103,7 @@ SystemCapability.Ability.Form
## updateForm
## updateForm
updateForm(formId: string, formBindingData:
formBindingData.FormBindingData): Promise
<void>
;
updateForm(formId: string, formBindingData:
FormBindingData): Promise
<
void
>
;
更新指定的卡片,以promise方式返回。
更新指定的卡片,以promise方式返回。
...
...
编辑
预览
Markdown
is supported
0%
请重试
或
添加新附件
.
添加附件
取消
You are about to add
0
people
to the discussion. Proceed with caution.
先完成此消息的编辑!
取消
想要评论请
注册
或
登录