Skip to content
体验新版
项目
组织
正在加载...
登录
切换导航
打开侧边栏
OpenHarmony
Docs
提交
edab3cd5
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看板
提交
edab3cd5
编写于
7月 28, 2022
作者:
H
HelloCrease
浏览文件
操作
浏览文件
下载
电子邮件补丁
差异文件
update docs
Signed-off-by:
N
HelloCrease
<
lian15@huawei.com
>
上级
892901d8
变更
2
隐藏空白更改
内联
并排
Showing
2 changed file
with
325 addition
and
325 deletion
+325
-325
zh-cn/application-dev/reference/apis/js-apis-update.md
zh-cn/application-dev/reference/apis/js-apis-update.md
+321
-321
zh-cn/application-dev/reference/arkui-ts/ts-basic-components-image.md
...ation-dev/reference/arkui-ts/ts-basic-components-image.md
+4
-4
未找到文件。
zh-cn/application-dev/reference/apis/js-apis-update.md
浏览文件 @
edab3cd5
...
...
@@ -29,9 +29,9 @@ getOnlineUpdater(upgradeInfo: UpgradeInfo): Updater
**参数:**
| 参数名 | 类型 | 必填 | 说明 |
| ----------- | --------------------------- | ---- | ---- |
| upgradeInfo |
[
UpgradeInfo
](
#upgradeinfo
)
| 是 | 升级信息对象 |
| 参数名 | 类型 | 必填 | 说明
|
| ----------- | --------------------------- | ---- | ----
--
|
| upgradeInfo |
[
UpgradeInfo
](
#upgradeinfo
)
| 是 | 升级信息对象 |
**返回值:**
...
...
@@ -67,8 +67,8 @@ getRestorer(): Restorer
**返回值:**
| 类型
| 说明
|
| -------------------
|
---- |
| 类型
| 说明
|
| -------------------
-- | --
---- |
|
[
Restorer
](
#restorer
)
| 恢复出厂对象 |
**示例:**
...
...
@@ -91,8 +91,8 @@ getLocalUpdater(): LocalUpdater
**返回值:**
| 类型
| 说明
|
| -------------------
|
---- |
| 类型
| 说明
|
| -------------------
---------- | --
---- |
|
[
LocalUpdater
](
#localupdater
)
| 本地升级对象 |
**示例:**
...
...
@@ -119,8 +119,8 @@ checkNewVersion(callback: AsyncCallback\<CheckResult>): void
**参数:**
| 参数名 | 类型 | 必填 | 说明 |
| -------- | ---------------------------------------- | ---- | --------- |
| 参数名 | 类型 | 必填 | 说明
|
| -------- | ---------------------------------------- | ---- | ---------
-----
|
| callback | AsyncCallback
\<
[
CheckResult
](
#checkresult
)
> | 是 | 回调函数,返回搜包结果对象。 |
**示例:**
...
...
@@ -143,8 +143,8 @@ checkNewVersion(): Promise\<CheckResult>
**返回值:**
| 类型
| 说明
|
| -------------------------------------
--- |
---------------- |
| 类型
| 说明
|
| -------------------------------------
| ---
---------------- |
| Promise
\<
[
CheckResult
](
#checkresult
)
> | Promise对象,返回搜包结果对象。 |
**示例:**
...
...
@@ -171,8 +171,8 @@ getNewVersionInfo(callback: AsyncCallback\<NewVersionInfo>): void
**参数:**
| 参数名 | 类型 | 必填 | 说明 |
| -------- | ---------------------------------------- | ---- | --------- |
| 参数名 | 类型 | 必填 | 说明
|
| -------- | ---------------------------------------- | ---- | ---------
------
|
| callback | AsyncCallback
\<
[
NewVersionInfo
](
#newversioninfo
)
> | 是 | 回调函数,返回新版本信息对象。 |
**示例:**
...
...
@@ -196,8 +196,8 @@ getNewVersionInfo(): Promise\<NewVersionInfo>
**返回值:**
| 类型 | 说明 |
| ---------------------------------------- | ---------------- |
| 类型 | 说明
|
| ---------------------------------------- | ----------------
----
|
| Promise
\<
[
NewVersionInfo
](
#newversioninfo
)
> | Promise对象,返回新版本信息对象。 |
**示例:**
...
...
@@ -223,11 +223,11 @@ getNewVersionDescription(versionDigestInfo: VersionDigestInfo, descriptionOption
**参数:**
| 参数名
| 类型 | 必填 | 说明
|
| --------
| ---------------------------------------- | ---- |
--------- |
| versionDigestInfo
|
[
VersionDigestInfo
](
#versiondigestinfo
)
| 是 | 版本摘要信息
|
| descriptionOptions |
[
DescriptionOptions
](
#descriptionoptions
)
| 是 | 描述文件选项 |
| callback | AsyncCallback
\<
Array
\<
[
ComponentDescription
](
#componentdescription
)
>>) | 是 | 回调函数,返回新版本描述文件 |
| 参数名
| 类型 | 必填 | 说明
|
| --------
---------- | ---------------------------------------- | ---- | -----
--------- |
| versionDigestInfo
|
[
VersionDigestInfo
](
#versiondigestinfo
)
| 是 | 版本摘要信息
|
| descriptionOptions |
[
DescriptionOptions
](
#descriptionoptions
)
| 是 | 描述文件选项
|
| callback
| AsyncCallback
\<
Array
\<
[
ComponentDescription
](
#componentdescription
)
>>) | 是 | 回调函数,返回新版本描述文件 |
**示例:**
...
...
@@ -261,15 +261,15 @@ getNewVersionDescription(versionDigestInfo: VersionDigestInfo, descriptionOption
**参数:**
| 参数名
| 类型 | 必填 | 说明
|
| --------
| ---------------------------------------- | ---- | ---
------ |
| versionDigestInfo
|
[
VersionDigestInfo
](
#versiondigestinfo
)
| 是 | 版本摘要信息 |
| 参数名
| 类型 | 必填 | 说明
|
| --------
---------- | ---------------------------------------- | ---- |
------ |
| versionDigestInfo
|
[
VersionDigestInfo
](
#versiondigestinfo
)
| 是 | 版本摘要信息 |
| descriptionOptions |
[
DescriptionOptions
](
#descriptionoptions
)
| 是 | 描述文件选项 |
**返回值:**
| 类型 | 说明 |
| ---------------------------------------- | ---------------- |
| 类型 | 说明
|
| ---------------------------------------- | ----------------
---
|
| Promise
\<
Array
\<
[
ComponentDescription
](
#componentdescription
)
>> | Promise对象,返回新版本描述文件 |
**示例:**
...
...
@@ -305,8 +305,8 @@ getCurrentVersionInfo(callback: AsyncCallback\<CurrentVersionInfo>): void
**参数:**
| 参数名 | 类型 | 必填 | 说明 |
| -------- | ---------------------------------------- | ---- | --------- |
| 参数名 | 类型 | 必填 | 说明
|
| -------- | ---------------------------------------- | ---- | ---------
-------
|
| callback | AsyncCallback
\<
[
CurrentVersionInfo
](
#currentversioninfo
)
> | 是 | 回调函数,返回当前版本信息对象。 |
**示例:**
...
...
@@ -331,8 +331,8 @@ getCurrentVersionInfo(): Promise\<CurrentVersionInfo>
**返回值:**
| 类型 | 说明 |
| ---------------------------------------- | ---------------- |
| 类型 | 说明
|
| ---------------------------------------- | ----------------
---
|
| Promise
\<
[
CurrentVersionInfo
](
#currentversioninfo
)
> | Promise对象,返回当前版本对象。 |
**示例:**
...
...
@@ -359,10 +359,10 @@ getCurrentVersionDescription(descriptionOptions: DescriptionOptions, callback: A
**参数:**
| 参数名
| 类型 | 必填 | 说明
|
| --------
| ---------------------------------------- | ---- |
--------- |
| descriptionOptions |
[
DescriptionOptions
](
#descriptionoptions
)
| 是 | 描述文件选项 |
| callback | AsyncCallback
\<
Array
\<
[
ComponentDescription
](
#componentdescription
)
>>) | 是 | 回调函数,返回当前版本描述文件 |
| 参数名
| 类型 | 必填 | 说明
|
| --------
---------- | ---------------------------------------- | ---- | ------
--------- |
| descriptionOptions |
[
DescriptionOptions
](
#descriptionoptions
)
| 是 | 描述文件选项
|
| callback
| AsyncCallback
\<
Array
\<
[
ComponentDescription
](
#componentdescription
)
>>) | 是 | 回调函数,返回当前版本描述文件 |
**示例:**
...
...
@@ -391,14 +391,14 @@ getCurrentVersionDescription(descriptionOptions: DescriptionOptions): Promise\<A
**参数:**
| 参数名
| 类型 | 必填 | 说明
|
| --------
| ---------------------------------------- | ---- | ---
------ |
| 参数名
| 类型 | 必填 | 说明
|
| --------
---------- | ---------------------------------------- | ---- |
------ |
| descriptionOptions |
[
DescriptionOptions
](
#descriptionoptions
)
| 是 | 描述文件选项 |
**返回值:**
| 类型 | 说明 |
| ---------------------------------------- | ---------------- |
| 类型 | 说明
|
| ---------------------------------------- | ----------------
----
|
| Promise
\<
Array
\<
[
ComponentDescription
](
#componentdescription
)
>> | Promise对象,返回当前版本描述文件 |
**示例:**
...
...
@@ -429,8 +429,8 @@ getTaskInfo(callback: AsyncCallback\<TaskInfo>): void
**参数:**
| 参数名 | 类型
| 必填 | 说明
|
| -------- | -------------------------------------
--- | ---- |
--------- |
| 参数名 | 类型
| 必填 | 说明
|
| -------- | -------------------------------------
| ---- | -------
--------- |
| callback | AsyncCallback
\<
[
TaskInfo
](
#taskinfo
)
> | 是 | 回调函数,返回升级任务信息对象。 |
**示例:**
...
...
@@ -453,8 +453,8 @@ getTaskInfo(): Promise\<TaskInfo>
**返回值:**
| 类型
| 说明
|
| -------------------------------
--------- |
---------------- |
| 类型
| 说明
|
| -------------------------------
| ---
---------------- |
| Promise
\<
[
TaskInfo
](
#taskinfo
)
> | Promise对象,返回任务信息对象。 |
**示例:**
...
...
@@ -479,11 +479,11 @@ download(versionDigestInfo: VersionDigestInfo, downloadOptions: DownloadOptions,
**参数:**
| 参数名
| 类型 | 必填 | 说明
|
| --------
| ---------------------------------------- | ---- |
--------- |
| versionDigestInfo |
[
VersionDigestInfo
](
#versiondigestinfo
)
| 是 | 版本摘要信息 |
| downloadOptions
|
[
DownloadOptions
](
#downloadoptions
)
| 是 | 下载选项
|
| callback
| AsyncCallback
\<
void>
| 是 | 回调函数。当下载成功时,err为undefined,否则为错误对象。 |
| 参数名
| 类型 | 必填 | 说明
|
| --------
--------- | --------------------------------------- | ---- | -------------------------
--------- |
| versionDigestInfo |
[
VersionDigestInfo
](
#versiondigestinfo
)
| 是 | 版本摘要信息
|
| downloadOptions
|
[
DownloadOptions
](
#downloadoptions
)
| 是 | 下载选项
|
| callback
| AsyncCallback
\<
void>
| 是 | 回调函数。当下载成功时,err为undefined,否则为错误对象。 |
**示例:**
...
...
@@ -515,15 +515,15 @@ download(versionDigestInfo: VersionDigestInfo, downloadOptions: DownloadOptions)
**参数:**
| 参数名
| 类型 | 必填 | 说明
|
| --------
| ---------------------------------------- | ---- | ---
------ |
| 参数名
| 类型 | 必填 | 说明
|
| --------
--------- | --------------------------------------- | ---- |
------ |
| versionDigestInfo |
[
VersionDigestInfo
](
#versiondigestinfo
)
| 是 | 版本摘要信息 |
| downloadOptions
|
[
DownloadOptions
](
#downloadoptions
)
| 是 | 下载选项
|
| downloadOptions
|
[
DownloadOptions
](
#downloadoptions
)
| 是 | 下载选项
|
**返回值:**
| 类型
| 说明
|
| --------------
-------------------------- |
---------------- |
| 类型
| 说明
|
| --------------
| ----------
---------------- |
| Promise
\<
void> | Promise对象。无返回结果的Promise对象。 |
**示例:**
...
...
@@ -558,11 +558,11 @@ resumeDownload(versionDigestInfo: VersionDigestInfo, resumeDownloadOptions: Resu
**参数:**
| 参数名
| 类型 | 必填 | 说明
|
| --------
| ---------------------------------------- | ---- |
--------- |
| versionDigestInfo
|
[
VersionDigestInfo
](
#versiondigestinfo
)
| 是 | 版本摘要信息
|
| resumeDownloadOptions |
[
ResumeDownloadOptions
](
#resumedownloadoptions
)
| 是 | 恢复下载选项 |
| callback
| AsyncCallback
\<
void>
| 是 | 回调函数。当恢复下载成功时,err为undefined,否则为错误对象。 |
| 参数名
| 类型 | 必填 | 说明
|
| --------
------------- | ---------------------------------------- | ---- | ---------------------------
--------- |
| versionDigestInfo
|
[
VersionDigestInfo
](
#versiondigestinfo
)
| 是 | 版本摘要信息
|
| resumeDownloadOptions |
[
ResumeDownloadOptions
](
#resumedownloadoptions
)
| 是 | 恢复下载选项
|
| callback
| AsyncCallback
\<
void>
| 是 | 回调函数。当恢复下载成功时,err为undefined,否则为错误对象。 |
**示例:**
...
...
@@ -593,15 +593,15 @@ resumeDownload(versionDigestInfo: VersionDigestInfo, resumeDownloadOptions: Resu
**参数:**
| 参数名
| 类型 | 必填 | 说明
|
| --------
| ---------------------------------------- | ---- | ---
------ |
| versionDigestInfo
|
[
VersionDigestInfo
](
#versiondigestinfo
)
| 是 | 版本摘要信息 |
| 参数名
| 类型 | 必填 | 说明
|
| --------
------------- | ---------------------------------------- | ---- |
------ |
| versionDigestInfo
|
[
VersionDigestInfo
](
#versiondigestinfo
)
| 是 | 版本摘要信息 |
| resumeDownloadOptions |
[
ResumeDownloadOptions
](
#resumedownloadoptions
)
| 是 | 恢复下载选项 |
**返回值:**
| 类型
| 说明
|
| --------------
-------------------------- |
---------------- |
| 类型
| 说明
|
| --------------
| ----------
---------------- |
| Promise
\<
void> | Promise对象。无返回结果的Promise对象。 |
**示例:**
...
...
@@ -635,11 +635,11 @@ pauseDownload(versionDigestInfo: VersionDigestInfo, pauseDownloadOptions: PauseD
**参数:**
| 参数名
| 类型 | 必填 | 说明
|
| --------
| ---------------------------------------- | ---- |
--------- |
| versionDigestInfo
|
[
VersionDigestInfo
](
#versiondigestinfo
)
| 是 | 版本摘要信息
|
| pauseDownloadOptions |
[
PauseDownloadOptions
](
#pausedownloadoptions
)
| 是 | 暂停下载选项 |
| callback
| AsyncCallback
\<
void>
| 是 | 回调函数。当暂停下载成功时,err为undefined,否则为错误对象。 |
| 参数名
| 类型 | 必填 | 说明
|
| --------
------------ | ---------------------------------------- | ---- | ---------------------------
--------- |
| versionDigestInfo
|
[
VersionDigestInfo
](
#versiondigestinfo
)
| 是 | 版本摘要信息
|
| pauseDownloadOptions |
[
PauseDownloadOptions
](
#pausedownloadoptions
)
| 是 | 暂停下载选项
|
| callback
| AsyncCallback
\<
void>
| 是 | 回调函数。当暂停下载成功时,err为undefined,否则为错误对象。 |
**示例:**
...
...
@@ -670,15 +670,15 @@ pauseDownload(versionDigestInfo: VersionDigestInfo, pauseDownloadOptions: PauseD
**参数:**
| 参数名
| 类型 | 必填 | 说明
|
| --------
| ---------------------------------------- | ---- | ---
------ |
| versionDigestInfo
|
[
VersionDigestInfo
](
#versiondigestinfo
)
| 是 | 版本摘要信息 |
| 参数名
| 类型 | 必填 | 说明
|
| --------
------------ | ---------------------------------------- | ---- |
------ |
| versionDigestInfo
|
[
VersionDigestInfo
](
#versiondigestinfo
)
| 是 | 版本摘要信息 |
| pauseDownloadOptions |
[
PauseDownloadOptions
](
#pausedownloadoptions
)
| 是 | 暂停下载选项 |
**返回值:**
| 类型
| 说明
|
| --------------
-------------------------- |
---------------- |
| 类型
| 说明
|
| --------------
| ----------
---------------- |
| Promise
\<
void> | Promise对象。无返回结果的Promise对象。 |
**示例:**
...
...
@@ -712,11 +712,11 @@ upgrade(versionDigestInfo: VersionDigestInfo, upgradeOptions: UpgradeOptions, ca
**参数:**
| 参数名
| 类型 | 必填 | 说明
|
| --------
| ---------------------------------------- | ---- |
--------- |
| versionDigestInfo |
[
VersionDigestInfo
](
#versiondigestinfo
)
| 是 | 版本摘要信息 |
| upgradeOptions
|
[
UpgradeOptions
](
#upgradeoptions
)
| 是 | 更新选项
|
| callback
| AsyncCallback
\<
void>
| 是 | 回调函数。当升级执行成功时,err为undefined,否则为错误对象。 |
| 参数名
| 类型 | 必填 | 说明
|
| --------
--------- | --------------------------------------- | ---- | ---------------------------
--------- |
| versionDigestInfo |
[
VersionDigestInfo
](
#versiondigestinfo
)
| 是 | 版本摘要信息
|
| upgradeOptions
|
[
UpgradeOptions
](
#upgradeoptions
)
| 是 | 更新选项
|
| callback
| AsyncCallback
\<
void>
| 是 | 回调函数。当升级执行成功时,err为undefined,否则为错误对象。 |
**示例:**
...
...
@@ -747,15 +747,15 @@ upgrade(versionDigestInfo: VersionDigestInfo, upgradeOptions: UpgradeOptions): P
**参数:**
| 参数名
| 类型 | 必填 | 说明
|
| --------
| ---------------------------------------- | ---- | ---
------ |
| 参数名
| 类型 | 必填 | 说明
|
| --------
--------- | --------------------------------------- | ---- |
------ |
| versionDigestInfo |
[
VersionDigestInfo
](
#versiondigestinfo
)
| 是 | 版本摘要信息 |
| upgradeOptions
|
[
UpgradeOptions
](
#upgradeoptions
)
| 是 | 更新选项
|
| upgradeOptions
|
[
UpgradeOptions
](
#upgradeoptions
)
| 是 | 更新选项
|
**返回值:**
| 类型
| 说明
|
| --------------
-------------------------- |
---------------- |
| 类型
| 说明
|
| --------------
| ----------
---------------- |
| Promise
\<
void> | Promise对象。无返回结果的Promise对象。 |
**示例:**
...
...
@@ -789,11 +789,11 @@ clearError(versionDigestInfo: VersionDigestInfo, clearOptions: ClearOptions, cal
**参数:**
| 参数名
| 类型 | 必填 | 说明
|
| --------
| ---------------------------------------- | ---- |
--------- |
| versionDigestInfo |
[
VersionDigestInfo
](
#versiondigestinfo
)
| 是 | 版本摘要信息 |
| clearOptions
|
[
ClearOptions
](
#clearoptions
)
| 是 | 清除选项
|
| callback
| AsyncCallback
\<
void>
| 是 | 回调函数。当清除异常成功时,err为undefined,否则为错误对象。 |
| 参数名
| 类型 | 必填 | 说明
|
| --------
--------- | --------------------------------------- | ---- | ---------------------------
--------- |
| versionDigestInfo |
[
VersionDigestInfo
](
#versiondigestinfo
)
| 是 | 版本摘要信息
|
| clearOptions
|
[
ClearOptions
](
#clearoptions
)
| 是 | 清除选项
|
| callback
| AsyncCallback
\<
void>
| 是 | 回调函数。当清除异常成功时,err为undefined,否则为错误对象。 |
**示例:**
...
...
@@ -824,15 +824,15 @@ clearError(versionDigestInfo: VersionDigestInfo, clearOptions: ClearOptions): Pr
**参数:**
| 参数名
| 类型 | 必填 | 说明
|
| --------
| ---------------------------------------- | ---- | ---
------ |
| 参数名
| 类型 | 必填 | 说明
|
| --------
--------- | --------------------------------------- | ---- |
------ |
| versionDigestInfo |
[
VersionDigestInfo
](
#versiondigestinfo
)
| 是 | 版本摘要信息 |
| clearOptions
|
[
ClearOptions
](
#clearoptions
)
| 是 | 更新选项
|
| clearOptions
|
[
ClearOptions
](
#clearoptions
)
| 是 | 更新选项
|
**返回值:**
| 类型
| 说明
|
| --------------
-------------------------- |
---------------- |
| 类型
| 说明
|
| --------------
| ----------
---------------- |
| Promise
\<
void> | Promise对象。无返回结果的Promise对象。 |
**示例:**
...
...
@@ -866,8 +866,8 @@ getUpgradePolicy(callback: AsyncCallback\<UpgradePolicy>): void
**参数:**
| 参数名 | 类型 | 必填 | 说明 |
| -------- | ---------------------------------------- | ---- | ---------- |
| 参数名 | 类型 | 必填 | 说明
|
| -------- | ---------------------------------------- | ---- | ----------
-----
|
| callback | AsyncCallback
\<
[
UpgradePolicy
](
#upgradepolicy
)
> | 是 | 回调函数,返回升级策略信息对象 |
**示例:**
...
...
@@ -891,8 +891,8 @@ getUpgradePolicy(): Promise\<UpgradePolicy>
**返回值:**
| 类型
| 说明
|
| ---------------------------------------
|
----------------- |
| 类型
| 说明
|
| ---------------------------------------
- | ----
----------------- |
| Promise
\<
[
UpgradePolicy
](
#upgradepolicy
)
> | Promise对象,返回升级策略信息对象。 |
**示例:**
...
...
@@ -918,10 +918,10 @@ setUpgradePolicy(policy: UpgradePolicy, callback: AsyncCallback\<void>): void
**参数:**
| 参数名 | 类型
| 必填 | 说明
|
| -------- | -------------------------------
--------- | ---- |
---------- |
| policy
|
[
UpgradePolicy
](
#upgradepolicy
)
| 是 | 升级策略
|
| callback | AsyncCallback
\<
void> | 是 | 回调函数,返回设置结果对象 |
| 参数名 | 类型
| 必填 | 说明
|
| -------- | -------------------------------
| ---- | ---
---------- |
| policy
|
[
UpgradePolicy
](
#upgradepolicy
)
| 是 | 升级策略
|
| callback | AsyncCallback
\<
void>
| 是 | 回调函数,返回设置结果对象 |
**示例:**
...
...
@@ -948,14 +948,14 @@ setUpgradePolicy(policy: UpgradePolicy): Promise\<void>
**参数:**
| 参数名 | 类型
| 必填 | 说明
|
| ------ | -----------------------------
| ---- | --
---- |
| 参数名 | 类型
| 必填 | 说明
|
| ------ | -----------------------------
-- | ---- |
---- |
| policy |
[
UpgradePolicy
](
#upgradepolicy
)
| 是 | 升级策略 |
**返回值:**
| 类型
| 说明
|
| --------------
-- |
--------------- |
| 类型
| 说明
|
| --------------
| ----
--------------- |
| Promise
\<
void> | Promise对象,返回设置结果对象。 |
**示例:**
...
...
@@ -985,8 +985,8 @@ terminateUpgrade(callback: AsyncCallback\<void>): void
**参数:**
| 参数名 | 类型
| 必填 | 说明
|
| -------- | --------------------
-------------------- | ---- |
--------- |
| 参数名 | 类型
| 必填 | 说明
|
| -------- | --------------------
| ---- | -----------------------------
--------- |
| callback | AsyncCallback
\<
void> | 是 | 回调函数。当清除升级缓存成功时,err为undefined,否则为错误对象。 |
**示例:**
...
...
@@ -1009,8 +1009,8 @@ terminateUpgrade(): Promise\<void>
**返回值:**
| 类型
| 说明
|
| --------------
-------------------------- |
---------------- |
| 类型
| 说明
|
| --------------
| ----------
---------------- |
| Promise
\<
void> | Promise对象。无返回结果的Promise对象。 |
**示例:**
...
...
@@ -1033,10 +1033,10 @@ on(eventClassifyInfo: EventClassifyInfo, taskCallback: UpgradeTaskCallback): voi
**参数:**
| 参数名
| 类型 | 必填 | 说明
|
| --------
| ---------------------------------------- | ---- | -----
---- |
| eventClassifyInfo |
[
EventClassifyInfo
](
#eventclassifyinfo
)
| 是 | 事件信息 |
| taskCallback
|
[
UpgradeTaskCallback
](
#upgradetaskcallback
)
| 是 | 事件回调 |
| 参数名
| 类型 | 必填 | 说明
|
| --------
--------- | ---------------------------------------- | ---- |
---- |
| eventClassifyInfo |
[
EventClassifyInfo
](
#eventclassifyinfo
)
| 是 | 事件信息 |
| taskCallback
|
[
UpgradeTaskCallback
](
#upgradetaskcallback
)
| 是 | 事件回调 |
**示例:**
...
...
@@ -1060,10 +1060,10 @@ off(eventClassifyInfo: EventClassifyInfo, taskCallback?: UpgradeTaskCallback): v
**参数:**
| 参数名
| 类型 | 必填 | 说明
|
| --------
| ---------------------------------------- | ---- | -----
---- |
| eventClassifyInfo |
[
EventClassifyInfo
](
#eventclassifyinfo
)
| 是 | 事件信息 |
| taskCallback
|
[
UpgradeTaskCallback
](
#upgradetaskcallback
)
| 否 | 事件回调 |
| 参数名
| 类型 | 必填 | 说明
|
| --------
--------- | ---------------------------------------- | ---- |
---- |
| eventClassifyInfo |
[
EventClassifyInfo
](
#eventclassifyinfo
)
| 是 | 事件信息 |
| taskCallback
|
[
UpgradeTaskCallback
](
#upgradetaskcallback
)
| 否 | 事件回调 |
**示例:**
...
...
@@ -1092,8 +1092,8 @@ factoryReset(callback: AsyncCallback\<void>): void
**参数:**
| 参数名 | 类型
| 必填 | 说明
|
| -------- | --------------------
-------------------- | ---- |
--------- |
| 参数名 | 类型
| 必填 | 说明
|
| -------- | --------------------
| ---- | -----------------------------
--------- |
| callback | AsyncCallback
\<
void> | 是 | 回调函数。当恢复出厂执行成功时,err为undefined,否则为错误对象。 |
**示例:**
...
...
@@ -1116,8 +1116,8 @@ factoryReset(): Promise\<void>
**返回值:**
| 类型
| 说明
|
| --------------
-------------------------- |
---------------- |
| 类型
| 说明
|
| --------------
| ----------
---------------- |
| Promise
\<
void> | Promise对象。无返回结果的Promise对象。 |
**示例:**
...
...
@@ -1144,11 +1144,11 @@ verifyUpgradePackage(upgradeFile: UpgradeFile, certsFile: string, callback: Asyn
**参数:**
| 参数名
| 类型 | 必填 | 说明
|
| --------
| ---------------------------------------- | ---- |
--------- |
| upgradeFile |
[
UpgradeFile
](
#upgradefile
)
| 是 | 升级文件 |
| certsFile
| string | 是 | 证书文件路径
|
| callback
| AsyncCallback
\<
void>
| 是 | 回调函数,返回升级包校验结果对象 |
| 参数名
| 类型 | 必填 | 说明
|
| --------
--- | --------------------------- | ---- | -------
--------- |
| upgradeFile |
[
UpgradeFile
](
#upgradefile
)
| 是 | 升级文件
|
| certsFile
| string | 是 | 证书文件路径
|
| callback
| AsyncCallback
\<
void>
| 是 | 回调函数,返回升级包校验结果对象 |
**示例:**
...
...
@@ -1175,15 +1175,15 @@ verifyUpgradePackage(upgradeFile: UpgradeFile, certsFile: string): Promise\<void
**参数:**
| 参数名
| 类型 | 必填 | 说明
|
| --------
| ---------------------------------------- | ---- | ---
------ |
| upgradeFile |
[
UpgradeFile
](
#upgradefile
)
| 是 | 升级文件 |
| certsFile
| string
| 是 | 证书文件路径 |
| 参数名
| 类型 | 必填 | 说明
|
| --------
--- | --------------------------- | ---- |
------ |
| upgradeFile |
[
UpgradeFile
](
#upgradefile
)
| 是 | 升级文件
|
| certsFile
| string
| 是 | 证书文件路径 |
**返回值:**
| 类型
| 说明
|
| --------------
-------------------------- |
---------------- |
| 类型
| 说明
|
| --------------
| ------
---------------- |
| Promise
\<
void> | Promise对象,返回升级包校验结果对象。 |
**示例:**
...
...
@@ -1211,10 +1211,10 @@ applyNewVersion(upgradeFiles: Array<[UpgradeFile](#upgradefile)>, callback: Asyn
**参数:**
| 参数名
| 类型 | 必填 | 说明
|
| --------
| ---------------------------------------- | ---- |
--------- |
| upgradeFile | Array
<
[
UpgradeFile
](
#upgradefile
)
>
| 是 | 升级文件 |
| callback
| AsyncCallback
\<
void>
| 是 | 回调函数。当安装升级包执行成功时,err为undefined,否则为错误对象。 |
| 参数名
| 类型 | 必填 | 说明
|
| --------
--- | ---------------------------------- | ---- | ------------------------------
--------- |
| upgradeFile | Array
<
[
UpgradeFile
](
#upgradefile
)
>
| 是 | 升级文件
|
| callback
| AsyncCallback
\<
void>
| 是 | 回调函数。当安装升级包执行成功时,err为undefined,否则为错误对象。 |
**示例:**
...
...
@@ -1241,8 +1241,8 @@ applyNewVersion(upgradeFiles: Array<[UpgradeFile](#upgradefile)>): Promise\<void
**返回值:**
| 类型
| 说明
|
| --------------
-------------------------- |
---------------- |
| 类型
| 说明
|
| --------------
| ----------
---------------- |
| Promise
\<
void> | Promise对象。无返回结果的Promise对象。 |
**示例:**
...
...
@@ -1268,10 +1268,10 @@ on(eventClassifyInfo: EventClassifyInfo, taskCallback: UpgradeTaskCallback): voi
**参数:**
| 参数名
| 类型 | 必填 | 说明
|
| --------
| ---------------------------------------- | ---- | -----
---- |
| eventClassifyInfo |
[
EventClassifyInfo
](
#eventclassifyinfo
)
| 是 | 事件信息 |
| taskCallback
|
[
UpgradeTaskCallback
](
#upgradetaskcallback
)
| 是 | 事件回调 |
| 参数名
| 类型 | 必填 | 说明
|
| --------
--------- | ---------------------------------------- | ---- |
---- |
| eventClassifyInfo |
[
EventClassifyInfo
](
#eventclassifyinfo
)
| 是 | 事件信息 |
| taskCallback
|
[
UpgradeTaskCallback
](
#upgradetaskcallback
)
| 是 | 事件回调 |
**示例:**
...
...
@@ -1297,10 +1297,10 @@ off(eventClassifyInfo: EventClassifyInfo, taskCallback?: UpgradeTaskCallback): v
**参数:**
| 参数名
| 类型 | 必填 | 说明
|
| --------
| ---------------------------------------- | ---- | -----
---- |
| eventClassifyInfo |
[
EventClassifyInfo
](
#eventclassifyinfo
)
| 是 | 事件信息 |
| taskCallback
|
[
UpgradeTaskCallback
](
#upgradetaskcallback
)
| 是 | 事件回调 |
| 参数名
| 类型 | 必填 | 说明
|
| --------
--------- | ---------------------------------------- | ---- |
---- |
| eventClassifyInfo |
[
EventClassifyInfo
](
#eventclassifyinfo
)
| 是 | 事件信息 |
| taskCallback
|
[
UpgradeTaskCallback
](
#upgradetaskcallback
)
| 是 | 事件回调 |
**示例:**
...
...
@@ -1323,10 +1323,10 @@ localUpdater.off(eventClassifyInfo, onTaskUpdate);
**系统能力**
:SystemCapability.Update.UpdateService
| 名称
| 参数类型 | 必填 | 说明
|
| ------------
------- | --------------------------- | ---- | -
------ |
| upgradeApp
| string
| 是 | 调用方包名 |
| businessType
|
[
BusinessType
](
#businesstype
)
| 是 | 升级业务类型
|
| 名称
| 参数类型 | 必填 | 说明
|
| ------------
| ----------------------------- | ---- |
------ |
| upgradeApp
| string
| 是 | 调用方包名 |
| businessType
|
[
BusinessType
](
#businesstype
)
| 是 | 升级业务类型
|
## BusinessType
...
...
@@ -1334,10 +1334,10 @@ localUpdater.off(eventClassifyInfo, onTaskUpdate);
**系统能力**
:SystemCapability.Update.UpdateService
| 名称
| 参数类型 | 必填 | 说明
|
| -------
------------ | --------------------------- | ---- | ---
---- |
| vendor
|
[
BusinessVendor
](
#businessvendor
)
| 是 | 供应商 |
| subType
|
[
BusinessSubType
](
#businesssubtype
)
| 是 | 类型
|
| 名称
| 参数类型 | 必填 | 说明
|
| -------
| ----------------------------------- | ---- |
---- |
| vendor |
[
BusinessVendor
](
#businessvendor
)
| 是 | 供应商 |
| subType
|
[
BusinessSubType
](
#businesssubtype
)
| 是 | 类型
|
## CheckResult
...
...
@@ -1345,10 +1345,10 @@ localUpdater.off(eventClassifyInfo, onTaskUpdate);
**系统能力**
:SystemCapability.Update.UpdateService
| 名称
| 参数类型 | 必填 | 说明
|
| -----------------
-- | --------------------------- | ---- | -
------ |
| isExistNewVersion
| bool | 是 | 是否有新版本
|
| newVersionInfo
|
[
NewVersionInfo
](
#newversioninfo
)
| 否 | 新版本数据
|
| 名称
| 参数类型 | 必填 | 说明
|
| -----------------
| --------------------------------- | ---- |
------ |
| isExistNewVersion
| bool | 是 | 是否有新版本
|
| newVersionInfo
|
[
NewVersionInfo
](
#newversioninfo
)
| 否 | 新版本数据
|
## NewVersionInfo
...
...
@@ -1356,10 +1356,10 @@ localUpdater.off(eventClassifyInfo, onTaskUpdate);
**系统能力**
:SystemCapability.Update.UpdateService
| 名称
| 参数类型 | 必填 | 说明
|
| -----------------
-- | --------------------------- | ---- | ---
---- |
| versionDigestInfo
|
[
VersionDigestInfo
](
#versiondigestinfo
)
| 是 | 版本摘要
|
| versionComponents
| Array
\<
[
VersionComponent
](
#versioncomponent
)
> | 是 | 版本组件
|
| 名称
| 参数类型 | 必填 | 说明
|
| -----------------
| ---------------------------------------- | ---- |
---- |
| versionDigestInfo
|
[
VersionDigestInfo
](
#versiondigestinfo
)
| 是 | 版本摘要
|
| versionComponents
| Array
\<
[
VersionComponent
](
#versioncomponent
)
> | 是 | 版本组件
|
## VersionDigestInfo
...
...
@@ -1367,9 +1367,9 @@ localUpdater.off(eventClassifyInfo, onTaskUpdate);
**系统能力**
:SystemCapability.Update.UpdateService
| 名称
| 参数类型 | 必填 | 说明
|
| -------------
------ | --------------------------- | ---- | ---
---- |
| versionDigest
| string | 是 | 版本摘要
|
| 名称
| 参数类型 | 必填 | 说明
|
| -------------
| ------ | ---- |
---- |
| versionDigest
| string | 是 | 版本摘要
|
## VersionComponent
...
...
@@ -1377,16 +1377,16 @@ localUpdater.off(eventClassifyInfo, onTaskUpdate);
**系统能力**
:SystemCapability.Update.UpdateService
| 名称
| 参数类型 | 必填 | 说明
|
| ---------------
---- | --------------------------- | ---- |
------- |
| componentId
| number | 是 | 组件标识
|
| componentType
|
[
ComponentType
](
#componentyype
)
| 是 | 组件类型
|
| upgradeAction
|
[
UpgradeAction
](
#upgradeaction
)
| 是 | 升级方式
|
| displayVersion
| string | 是 | 显示版本号
|
| innerVersion
| string | 是 | 版本号
|
| size
| number | 是 | 升级包大小
|
| effectiveMode
|
[
EffectiveMode
](
#effectivemode
)
| 是 | 生效模式
|
| descriptionInfo
|
[
DescriptionInfo
](
#descriptioninfo
)
| 是 | 版本描述文件信息
|
| 名称
| 参数类型 | 必填 | 说明
|
| ---------------
| ----------------------------------- | ---- | -
------- |
| componentId
| number | 是 | 组件标识
|
| componentType
|
[
ComponentType
](
#componenttype
)
| 是 | 组件类型
|
| upgradeAction
|
[
UpgradeAction
](
#upgradeaction
)
| 是 | 升级方式
|
| displayVersion
| string | 是 | 显示版本号
|
| innerVersion
| string | 是 | 版本号
|
| size
| number | 是 | 升级包大小
|
| effectiveMode
|
[
EffectiveMode
](
#effectivemode
)
| 是 | 生效模式
|
| descriptionInfo
|
[
DescriptionInfo
](
#descriptioninfo
)
| 是 | 版本描述文件信息
|
## DescriptionOptions
...
...
@@ -1394,10 +1394,10 @@ localUpdater.off(eventClassifyInfo, onTaskUpdate);
**系统能力**
:SystemCapability.Update.UpdateService
| 名称
| 参数类型 | 必填 | 说明
|
| --------
----------- | --------------------------- | ---- | -
------ |
| format
|
[
DescriptionFormat
](
#descriptionformat
)
| 是 | 描述文件格式
|
| language
| string | 是 | 描述文件语言
|
| 名称
| 参数类型 | 必填 | 说明
|
| --------
| --------------------------------------- | ---- |
------ |
| format
|
[
DescriptionFormat
](
#descriptionformat
)
| 是 | 描述文件格式
|
| language
| string | 是 | 描述文件语言
|
## ComponentDescription
...
...
@@ -1405,10 +1405,10 @@ localUpdater.off(eventClassifyInfo, onTaskUpdate);
**系统能力**
:SystemCapability.Update.UpdateService
| 名称
| 参数类型 | 必填 | 说明
|
| ---------------
---- | --------------------------- | ---- | -
------ |
| componentId
| string | 是 | 组件标识
|
| descriptionInfo
|
[
DescriptionInfo
](
#descriptioninfo
)
| 是 | 描述文件信息
|
| 名称
| 参数类型 | 必填 | 说明
|
| ---------------
| ----------------------------------- | ---- |
------ |
| componentId
| string | 是 | 组件标识
|
| descriptionInfo
|
[
DescriptionInfo
](
#descriptioninfo
)
| 是 | 描述文件信息
|
## DescriptionInfo
...
...
@@ -1416,10 +1416,10 @@ localUpdater.off(eventClassifyInfo, onTaskUpdate);
**系统能力**
:SystemCapability.Update.UpdateService
| 名称
| 参数类型 | 必填 | 说明
|
| ---------------
---- | --------------------------- | ---- | -
------ |
| descriptionType
|
[
DescriptionType
](
#descriptiontype
)
| 是 | 描述文件类型
|
| content
| string | 是 | 描述文件内容
|
| 名称
| 参数类型 | 必填 | 说明
|
| ---------------
| ----------------------------------- | ---- |
------ |
| descriptionType
|
[
DescriptionType
](
#descriptiontype
)
| 是 | 描述文件类型
|
| content
| string | 是 | 描述文件内容
|
## CurrentVersionInfo
...
...
@@ -1427,11 +1427,11 @@ localUpdater.off(eventClassifyInfo, onTaskUpdate);
**系统能力**
:SystemCapability.Update.UpdateService
| 名称
| 参数类型 | 必填 | 说明
|
| -----------------
-- | --------------------------- | ---- | --
----- |
| osVersion
| string | 是 | 系统版本号
|
| deviceName
| string | 是 | 设备名
|
| versionComponents
| Array
\<
[
VersionComponent
](
#vesioncomponent
)
>
| 否 | 版本组件 |
| 名称
| 参数类型 | 必填 | 说明
|
| -----------------
| ---------------------------------------- | ---- |
----- |
| osVersion
| string | 是 | 系统版本号
|
| deviceName
| string | 是 | 设备名
|
| versionComponents
| Array
\<
[
VersionComponent
](
#versioncomponent
)
>
| 否 | 版本组件 |
## DownloadOptions
...
...
@@ -1439,10 +1439,10 @@ localUpdater.off(eventClassifyInfo, onTaskUpdate);
**系统能力**
:SystemCapability.Update.UpdateService
| 名称
| 参数类型 | 必填 | 说明
|
| ------------
------- | --------------------------- | ---- | ---
---- |
| allowNetwork
|
[
NetType
](
#nettype
)
| 是 | 网络类型
|
| order
|
[
Order
](
#order
)
| 是 | 升级指令
|
| 名称
| 参数类型 | 必填 | 说明
|
| ------------
| ------------------- | ---- |
---- |
| allowNetwork
|
[
NetType
](
#nettype
)
| 是 | 网络类型
|
| order
|
[
Order
](
#order
)
| 是 | 升级指令
|
## ResumeDownloadOptions
...
...
@@ -1450,9 +1450,9 @@ localUpdater.off(eventClassifyInfo, onTaskUpdate);
**系统能力**
:SystemCapability.Update.UpdateService
| 名称
| 参数类型 | 必填 | 说明
|
| ------------
------- | --------------------------- | ---- | ---
---- |
| allowNetwork
|
[
NetType
](
#nettype
)
| 是 | 网络类型
|
| 名称
| 参数类型 | 必填 | 说明
|
| ------------
| ------------------- | ---- |
---- |
| allowNetwork
|
[
NetType
](
#nettype
)
| 是 | 网络类型
|
## PauseDownloadOptions
...
...
@@ -1460,9 +1460,9 @@ localUpdater.off(eventClassifyInfo, onTaskUpdate);
**系统能力**
:SystemCapability.Update.UpdateService
| 名称
| 参数类型 | 必填 | 说明
|
| -----------------
-- | --------------------------- | ---- |
------- |
| isAllowAutoResume
| bool | 是 | 是否允许自动恢复
|
| 名称
| 参数类型 | 必填 | 说明
|
| -----------------
| ---- | ---- | -
------- |
| isAllowAutoResume
| bool | 是 | 是否允许自动恢复
|
## UpgradeOptions
...
...
@@ -1470,9 +1470,9 @@ localUpdater.off(eventClassifyInfo, onTaskUpdate);
**系统能力**
:SystemCapability.Update.UpdateService
| 名称
| 参数类型 | 必填 | 说明
|
| -----
-------------- | --------------------------- | ---- | ---
---- |
| order
|
[
Order
](
#order
)
| 是 | 升级指令
|
| 名称
| 参数类型 | 必填 | 说明
|
| -----
| --------------- | ---- |
---- |
| order
|
[
Order
](
#order
)
| 是 | 升级指令
|
## ClearOptions
...
...
@@ -1480,9 +1480,9 @@ localUpdater.off(eventClassifyInfo, onTaskUpdate);
**系统能力**
:SystemCapability.Update.UpdateService
| 名称
| 参数类型 | 必填 | 说明
|
| ------
------------- | --------------------------- | ---- | ---
---- |
| status
|
[
UpgradeStatus
](
#upgradestatus
)
| 是 | 异常状态
|
| 名称
| 参数类型 | 必填 | 说明
|
| ------
| ------------------------------- | ---- |
---- |
| status
|
[
UpgradeStatus
](
#upgradestatus
)
| 是 | 异常状态
|
## UpgradePolicy
...
...
@@ -1490,11 +1490,11 @@ localUpdater.off(eventClassifyInfo, onTaskUpdate);
**系统能力**
:SystemCapability.Update.UpdateService
| 名称 | 参数类型 | 必填 | 说明 |
| ------------------- | --------------------------- | ---- | ------- |
| downloadStrategy
| bool
| 是 | 自动下载策略 |
| autoUpgradeStrategy
| bool | 是 | 自动升级策略
|
| autoUpgradePeriods
| Array
\<
[
UpgradePeriod
](
#upgradeperiod
)
>
| 是 | 自动升级时间段 |
| 名称 | 参数类型
| 必填 | 说明 |
| ------------------- | ---------------------------
------------
| ---- | ------- |
| downloadStrategy
| bool
| 是 | 自动下载策略 |
| autoUpgradeStrategy
| bool | 是 | 自动升级策略
|
| autoUpgradePeriods
| Array
\<
[
UpgradePeriod
](
#upgradeperiod
)
>
| 是 | 自动升级时间段 |
## UpgradePeriod
...
...
@@ -1502,10 +1502,10 @@ localUpdater.off(eventClassifyInfo, onTaskUpdate);
**系统能力**
:SystemCapability.Update.UpdateService
| 名称
| 参数类型 | 必填 | 说明
|
| -----
-------------- | --------------------------- | ---- | ---
---- |
| start
| number | 是 | 开始时间
|
| end
| number | 是 | 结束时间
|
| 名称
| 参数类型 | 必填 | 说明
|
| -----
| ------ | ---- |
---- |
| start
| number | 是 | 开始时间
|
| end
| number | 是 | 结束时间
|
## TaskInfo
...
...
@@ -1513,10 +1513,10 @@ localUpdater.off(eventClassifyInfo, onTaskUpdate);
**系统能力**
:SystemCapability.Update.UpdateService
| 名称
| 参数类型 | 必填 | 说明
|
| ---------
---------- | --------------------------- | ---- | -
------ |
| existTask
| bool | 是 | 是否存在任务
|
| taskBody
|
[
TaskBody
](
#taskinfo
)
| 是 | 任务数据
|
| 名称
| 参数类型 | 必填 | 说明
|
| ---------
| --------------------- | ---- |
------ |
| existTask
| bool | 是 | 是否存在任务
|
| taskBody
|
[
TaskBody
](
#taskinfo
)
| 是 | 任务数据
|
## EventInfo
...
...
@@ -1524,10 +1524,10 @@ localUpdater.off(eventClassifyInfo, onTaskUpdate);
**系统能力**
:SystemCapability.Update.UpdateService
| 名称
| 参数类型 | 必填 | 说明
|
| --------
----------- | --------------------------- | ---- | ---
---- |
| eventId
|
[
EventId
](
#eventid
)
| 是 | 事件ID
|
| taskBody
|
[
TaskBody
](
#taskinfo
)
| 是 | 任务数据
|
| 名称
| 参数类型 | 必填 | 说明
|
| --------
| --------------------- | ---- |
---- |
| eventId
|
[
EventId
](
#eventid
)
| 是 | 事件ID
|
| taskBody
|
[
TaskBody
](
#taskinfo
)
| 是 | 任务数据
|
## TaskBody
...
...
@@ -1535,15 +1535,15 @@ localUpdater.off(eventClassifyInfo, onTaskUpdate);
**系统能力**
:SystemCapability.Update.UpdateService
| 名称
| 参数类型 | 必填 | 说明
|
| -----------------
-- | --------------------------- | ---- | ---
---- |
| versionDigestInfo
|
[
VersionDigestInfo
](
#versiondigestinfo
)
| 是 | 版本摘要
|
| status
|
[
UpgradeStatus
](
#upgradestatus
)
| 是 | 升级状态
|
| subStatus | number
| 否 | 子状态
|
| progress
| number | 是 | 进度
|
| installMode
| number | 是 | 安装模式
|
| errorMessages
| Array
\<
[
ErrorMessage
](
#errormessage
)
> | 否 | 错误信息
|
| versionComponents
| Array
\<
[
VersionComponent
](
#versioncomponent
)
> | 是 | 版本组件
|
| 名称
| 参数类型 | 必填 | 说明
|
| -----------------
| ---------------------------------------- | ---- |
---- |
| versionDigestInfo
|
[
VersionDigestInfo
](
#versiondigestinfo
)
| 是 | 版本摘要
|
| status
|
[
UpgradeStatus
](
#upgradestatus
)
| 是 | 升级状态
|
| subStatus | number
| 否 | 子状态
|
| progress
| number | 是 | 进度
|
| installMode
| number | 是 | 安装模式
|
| errorMessages
| Array
\<
[
ErrorMessage
](
#errormessage
)
> | 否 | 错误信息
|
| versionComponents
| Array
\<
[
VersionComponent
](
#versioncomponent
)
> | 是 | 版本组件
|
## ErrorMessage
...
...
@@ -1551,10 +1551,10 @@ localUpdater.off(eventClassifyInfo, onTaskUpdate);
**系统能力**
:SystemCapability.Update.UpdateService
| 名称
| 参数类型 | 必填 | 说明
|
| ------------
------- | --------------------------- | ---- | ---
---- |
| errorCode
| number
| 是 | 错误码 |
| errorMessage
| string | 是 | 错误描述
|
| 名称
| 参数类型 | 必填 | 说明
|
| ------------
| ------ | ---- |
---- |
| errorCode
| number
| 是 | 错误码 |
| errorMessage
| string | 是 | 错误描述
|
## EventClassifyInfo
...
...
@@ -1562,10 +1562,10 @@ localUpdater.off(eventClassifyInfo, onTaskUpdate);
**系统能力**
:SystemCapability.Update.UpdateService
| 名称
| 参数类型 | 必填 | 说明
|
| -------------
------ | --------------------------- | ---- | ---
---- |
| eventClassify
|
[
EventClassify
](
#eventclassify
)
| 是 | 事件类型
|
| extraInfo
| string | 是 | 额外信息
|
| 名称
| 参数类型 | 必填 | 说明
|
| -------------
| ------------------------------- | ---- |
---- |
| eventClassify
|
[
EventClassify
](
#eventclassify
)
| 是 | 事件类型
|
| extraInfo
| string | 是 | 额外信息
|
## UpgradeFile
...
...
@@ -1573,10 +1573,10 @@ localUpdater.off(eventClassifyInfo, onTaskUpdate);
**系统能力**
:SystemCapability.Update.UpdateService
| 名称
| 参数类型 | 必填 | 说明
|
| --------
----------- | --------------------------- | ---- | ---
---- |
| fileType
|
[
ComponentType
](
#componenttype
)
| 是 | 文件类型
|
| filePath
| string | 是 | 文件路径
|
| 名称
| 参数类型 | 必填 | 说明
|
| --------
| ------------------------------- | ---- |
---- |
| fileType
|
[
ComponentType
](
#componenttype
)
| 是 | 文件类型
|
| filePath
| string | 是 | 文件路径
|
## UpgradeTaskCallback
...
...
@@ -1586,9 +1586,9 @@ localUpdater.off(eventClassifyInfo, onTaskUpdate);
**系统能力**
:SystemCapability.Update.UpdateService
| 名称
| 参数类型
| 必填 | 说明 |
| ---------
------ | -----------------
----------------------- | ---- | ---- |
| eventInfo
|
[
EventInfo
](
#eventinfo
)
| 是 | 事件信息 |
| 名称
| 参数类型
| 必填 | 说明 |
| ---------
|
----------------------- | ---- | ---- |
| eventInfo
|
[
EventInfo
](
#eventinfo
)
| 是 | 事件信息 |
## BusinessVendor
...
...
@@ -1596,9 +1596,9 @@ localUpdater.off(eventClassifyInfo, onTaskUpdate);
**系统能力**
:SystemCapability.Update.UpdateService
| 参数名
| 默认值 | 说明
|
| ------
------------- | ---- | ----
---- |
| PUBLIC
| "public" | 开源
|
| 参数名
| 默认值 | 说明
|
| ------
| -------- |
---- |
| PUBLIC
| "public" | 开源
|
## BusinessSubType
...
...
@@ -1606,9 +1606,9 @@ localUpdater.off(eventClassifyInfo, onTaskUpdate);
**系统能力**
:SystemCapability.Update.UpdateService
| 参数名
| 默认值 | 说明
|
| --------
----------- | ---- | ----
---- |
| FIRMWARE
| 1 | 固件
|
| 参数名
| 默认值 | 说明
|
| --------
| ---- |
---- |
| FIRMWARE
| 1 | 固件
|
## ComponentType
...
...
@@ -1616,9 +1616,9 @@ localUpdater.off(eventClassifyInfo, onTaskUpdate);
**系统能力**
:SystemCapability.Update.UpdateService
| 参数名
| 默认值 | 说明
|
| ----
--------------- | ---- | ----
---- |
| OTA
| 1 | 固件
|
| 参数名
| 默认值 | 说明
|
| ----
| ---- |
---- |
| OTA
| 1 | 固件
|
## UpgradeAction
...
...
@@ -1626,10 +1626,10 @@ localUpdater.off(eventClassifyInfo, onTaskUpdate);
**系统能力**
:SystemCapability.Update.UpdateService
| 参数名
| 默认值 | 说明
|
| --------
----------- | ---- | ----
---- |
| UPGRADE
| "upgrade"
| 差分包 |
| RECOVERY
| "recovery" | 修复包 |
| 参数名
| 默认值 | 说明
|
| --------
| ---------- |
---- |
| UPGRADE
| "upgrade"
| 差分包 |
| RECOVERY | "recovery" | 修复包 |
## EffectiveMode
...
...
@@ -1637,11 +1637,11 @@ localUpdater.off(eventClassifyInfo, onTaskUpdate);
**系统能力**
:SystemCapability.Update.UpdateService
| 参数名
| 默认值 | 说明
|
| -------------
------ | ---- | ----
---- |
| COLD
| 1
| 冷升级 |
| LIVE
| 2
| 热升级 |
| LIVE_AND_COLD
| 3 | 融合升级
|
| 参数名
| 默认值 | 说明
|
| -------------
| ---- |
---- |
| COLD
| 1
| 冷升级 |
| LIVE
| 2
| 热升级 |
| LIVE_AND_COLD
| 3 | 融合升级
|
## DescriptionType
...
...
@@ -1649,10 +1649,10 @@ localUpdater.off(eventClassifyInfo, onTaskUpdate);
**系统能力**
:SystemCapability.Update.UpdateService
| 参数名
| 默认值 | 说明
|
| -------
------------ | ---- | ----
---- |
| CONTENT
| 0 | 内容
|
| URI
| 1 | 链接
|
| 参数名
| 默认值 | 说明
|
| -------
| ---- |
---- |
| CONTENT
| 0 | 内容
|
| URI
| 1 | 链接
|
## DescriptionFormat
...
...
@@ -1660,10 +1660,10 @@ localUpdater.off(eventClassifyInfo, onTaskUpdate);
**系统能力**
:SystemCapability.Update.UpdateService
| 参数名
| 默认值 | 说明
|
| ----------
--------- | ---- | ----
---- |
| STANDARD | 0
| 标准格式
|
| SIMPLIFIED
| 1 | 简易格式
|
| 参数名
| 默认值 | 说明
|
| ----------
| ---- |
---- |
| STANDARD | 0
| 标准格式
|
| SIMPLIFIED
| 1 | 简易格式
|
## NetType
...
...
@@ -1671,13 +1671,13 @@ localUpdater.off(eventClassifyInfo, onTaskUpdate);
**系统能力**
:SystemCapability.Update.UpdateService
| 参数名
| 默认值 | 说明
|
| -----------------
-- | ---- |
-------- |
| CELLULAR
| 1 | 数据网络
|
| METERED_WIFI
| 2 | 热点WIFI
|
| NOT_METERED_WIFI
| 4 | 非热点WIFI
|
| WIFI
| 6 | WIFI
|
| CELLULAR_AND_WIFI
| 7 | 数据网络和WIFI
|
| 参数名
| 默认值 | 说明
|
| -----------------
| ---- | -
-------- |
| CELLULAR
| 1 | 数据网络
|
| METERED_WIFI
| 2 | 热点WIFI
|
| NOT_METERED_WIFI
| 4 | 非热点WIFI
|
| WIFI
| 6 | WIFI
|
| CELLULAR_AND_WIFI
| 7 | 数据网络和WIFI
|
## Order
...
...
@@ -1685,13 +1685,13 @@ localUpdater.off(eventClassifyInfo, onTaskUpdate);
**系统能力**
:SystemCapability.Update.UpdateService
| 参数名
| 默认值 | 说明
|
| -------------------
| ---- | ---
----- |
| DOWNLOAD
| 1 | 下载
|
| INSTALL
| 2 | 安装
|
| DOWNLOAD_AND_INSTALL
| 3 | 下载并安装
|
| APPLY
| 4 | 生效
|
| INSTALL_AND_APPLY
| 6 | 安装并生效
|
| 参数名
| 默认值 | 说明
|
| -------------------
- | ---- |
----- |
| DOWNLOAD
| 1 | 下载
|
| INSTALL
| 2 | 安装
|
| DOWNLOAD_AND_INSTALL
| 3 | 下载并安装
|
| APPLY
| 4 | 生效
|
| INSTALL_AND_APPLY
| 6 | 安装并生效
|
## UpgradeStatus
...
...
@@ -1699,18 +1699,18 @@ localUpdater.off(eventClassifyInfo, onTaskUpdate);
**系统能力**
:SystemCapability.Update.UpdateService
| 参数名
| 默认值 | 说明
|
| ----------------
--- | ---- | ----
---- |
| WAITING_DOWNLOAD
| 20
| 待下载 |
| DOWNLOADING
| 21
| 下载中 |
| DOWNLOAD_PAUSED
| 22 | 下载暂停
|
| DOWNLOAD_FAIL
| 23 | 下载失败
|
| WAITING_INSTALL
| 30
| 待安装 |
| UPDATING
| 31
| 更新中 |
| WAITING_APPLY
| 40
| 待生效 |
| APPLYING
| 21
| 生效中 |
| UPGRADE_SUCCESS
| 50 | 升级成功
|
| UPGRADE_FAIL
| 51 | 升级失败
|
| 参数名
| 默认值 | 说明
|
| ----------------
| ---- |
---- |
| WAITING_DOWNLOAD
| 20
| 待下载 |
| DOWNLOADING
| 21
| 下载中 |
| DOWNLOAD_PAUSED
| 22 | 下载暂停
|
| DOWNLOAD_FAIL
| 23 | 下载失败
|
| WAITING_INSTALL
| 30
| 待安装 |
| UPDATING
| 31
| 更新中 |
| WAITING_APPLY
| 40
| 待生效 |
| APPLYING
| 21
| 生效中 |
| UPGRADE_SUCCESS
| 50 | 升级成功
|
| UPGRADE_FAIL
| 51 | 升级失败
|
## EventClassify
...
...
@@ -1718,9 +1718,9 @@ localUpdater.off(eventClassifyInfo, onTaskUpdate);
**系统能力**
:SystemCapability.Update.UpdateService
| 参数名
| 默认值 | 说明
|
| ----
--------------- | ---- | ----
---- |
| TASK
| 0x01000000 | 任务事件
|
| 参数名
| 默认值 | 说明
|
| ----
| ---------- |
---- |
| TASK
| 0x01000000 | 任务事件
|
## EventId
...
...
@@ -1728,22 +1728,22 @@ localUpdater.off(eventClassifyInfo, onTaskUpdate);
**系统能力**
:SystemCapability.Update.UpdateService
| 参数名
| 默认值 | 说明
|
| -------------------
| ---- | --
------ |
| EVENT_TASK_BASE
| 0x01000000 | 任务事件
|
| EVENT_TASK_RECEIVE
| 0x01000001 | 收到任务
|
| EVENT_TASK_CANCEL
| 0x01000010 | 取消任务
|
| EVENT_DOWNLOAD_WAIT
| 0x01000011 | 待下载
|
| EVENT_DOWNLOAD_START | 0x01000100 | 开始下载 |
| EVENT_DOWNLOAD_UPDATE
| 0x01000101 | 下载进度更新
|
| EVENT_DOWNLOAD_PAUSE | 0x01000110 | 下载暂停 |
| EVENT_DOWNLOAD_RESUME
| 0x01000111 | 恢复下载
|
| EVENT_DOWNLOAD_SUCCESS
| 0x01001000 | 下载成功
|
| EVENT_DOWNLOAD_FAIL
| 0x01001001 | 下载失败
|
| EVENT_UPGRADE_WAIT
| 0x01001010 | 待升级
|
| EVENT_UPGRADE_START
| 0x01001011 | 开始升级
|
| EVENT_UPGRADE_UPDATE | 0x01001100 | 升级中 |
| EVENT_APPLY_WAIT
| 0x01001101 | 待生效
|
| EVENT_APPLY_START
| 0x01001110 | 开始生效
|
| EVENT_UPGRADE_SUCCESS
| 0x01001111 | 更新成功
|
| EVENT_UPGRADE_FAIL
| 0x01010000 | 更新失败
|
| 参数名
| 默认值 | 说明
|
| -------------------
--- | ---------- |
------ |
| EVENT_TASK_BASE
| 0x01000000 | 任务事件
|
| EVENT_TASK_RECEIVE
| 0x01000001 | 收到任务
|
| EVENT_TASK_CANCEL
| 0x01000010 | 取消任务
|
| EVENT_DOWNLOAD_WAIT
| 0x01000011 | 待下载
|
| EVENT_DOWNLOAD_START | 0x01000100 | 开始下载
|
| EVENT_DOWNLOAD_UPDATE
| 0x01000101 | 下载进度更新
|
| EVENT_DOWNLOAD_PAUSE | 0x01000110 | 下载暂停
|
| EVENT_DOWNLOAD_RESUME
| 0x01000111 | 恢复下载
|
| EVENT_DOWNLOAD_SUCCESS
| 0x01001000 | 下载成功
|
| EVENT_DOWNLOAD_FAIL
| 0x01001001 | 下载失败
|
| EVENT_UPGRADE_WAIT
| 0x01001010 | 待升级
|
| EVENT_UPGRADE_START
| 0x01001011 | 开始升级
|
| EVENT_UPGRADE_UPDATE | 0x01001100 | 升级中
|
| EVENT_APPLY_WAIT
| 0x01001101 | 待生效
|
| EVENT_APPLY_START
| 0x01001110 | 开始生效
|
| EVENT_UPGRADE_SUCCESS
| 0x01001111 | 更新成功
|
| EVENT_UPGRADE_FAIL
| 0x01010000 | 更新失败
|
zh-cn/application-dev/reference/arkui-ts/ts-basic-components-image.md
浏览文件 @
edab3cd5
...
...
@@ -34,9 +34,9 @@ Image(src: string | PixelMap | Resource)
**参数:**
| 参数名
| 参数类型 | 必填 | 默认值 | 参数描述
|
| ----
-- | ------------------------------------------------------------ | ---- | ------ | --------------------
---------------------------------------- |
| src
| string
\|
[PixelMap](../apis/js-apis-image.md#pixelmap7)\|
[
Resource
](
../../ui/ts-types.md#resource类型
)
| 是 | -
| 图片的数据源,支持本地图片和网络图片。
<br/>
当使用相对路径引用图片资源时,例如
`Image("common/test.jpg")`
,不支持该Image组件被跨包/跨模块调用,建议使用
`$r`
方式来管理需全局使用的图片资源。
<br/>
\-
支持的图片格式包括png、jpg、bmp、svg和gif。
<br/>
\-
支持
`Base64`
字符串。格式
`data:image/[png\|jpeg\|bmp\|webp];base64,[base64 data]`
, 其中
`[base64 data]`
为
`Base64`
字符串数据。
<br/>
\-
支持
`dataability://`
路径前缀的字符串,用于访问通过data
ability提供的图片路径。 |
| 参数名
| 参数类型 | 必填 | 默认值 | 参数描述
|
| ----
| ---------------------------------------- | ---- | ---- |
---------------------------------------- |
| src
| string
\|
[PixelMap](../apis/js-apis-image.md#pixelmap7)\|
[
Resource
](
../../ui/ts-types.md#resource类型
)
| 是 | -
| 图片的数据源,支持本地图片和网络图片。
<br/>
当使用相对路径引用图片资源时,例如
`Image("common/test.jpg")`
,不支持该Image组件被跨包/跨模块调用,建议使用
`$r`
方式来管理需全局使用的图片资源。
<br/>
\-
支持的图片格式包括png、jpg、bmp、svg和gif。
<br/>
\-
支持
`Base64`
字符串。格式
`data:image/[png\|jpeg\|bmp\|webp];base64,[base64 data]`
, 其中
`[base64 data]`
为
`Base64`
字符串数据。
<br/>
\-
支持
`dataability://`
路径前缀的字符串,用于访问通过data
ability提供的图片路径。 |
## 属性
...
...
@@ -45,7 +45,7 @@ Image(src: string | PixelMap | Resource)
| 名称 | 参数类型 | 默认值 | 描述 |
| --------------------- | ---------------------------------------- | ------------------------ | ---------------------------------------- |
| alt | string
\|
[
Resource
](
../../ui/ts-types.md#resource类型
)
| - | 加载时显示的占位图,支持本地图片和网络图片。 |
| objectFit | ImageFit | ImageFit.Cover | 设置图片的缩放类型。 |
| objectFit | ImageFit
| ImageFit.Cover | 设置图片的缩放类型。 |
| objectRepeat |
[
ImageRepeat
](
ts-appendix-enums.md#imagerepeat
)
| NoRepeat | 设置图片的重复样式。
<br/>
>
**说明:**
<br/>
>
-
svg类型图源不支持该属性。 |
| interpolation |
[
ImageInterpolation
](
#imageinterpolation
)
| ImageInterpolation.None | 设置图片的插值效果,仅针对图片放大插值。
<br/>
>
**说明:**
<br/>
>
-
svg类型图源不支持该属性。
<br/>
>
-
PixelMap资源不支持该属性。 |
| renderMode |
[
ImageRenderMode
](
#imagerendermode
)
| ImageRenderMode.Original | 设置图片渲染的模式。
<br/>
>
**说明:**
<br/>
>
-
svg类型图源不支持该属性。 |
...
...
编辑
预览
Markdown
is supported
0%
请重试
或
添加新附件
.
添加附件
取消
You are about to add
0
people
to the discussion. Proceed with caution.
先完成此消息的编辑!
取消
想要评论请
注册
或
登录