提交 edab3cd5 编写于 作者: H HelloCrease

update docs

Signed-off-by: NHelloCrease <lian15@huawei.com>
上级 892901d8
......@@ -30,7 +30,7 @@ getOnlineUpdater(upgradeInfo: UpgradeInfo): Updater
**参数:**
| 参数名 | 类型 | 必填 | 说明 |
| ----------- | --------------------------- | ---- | ---- |
| ----------- | --------------------------- | ---- | ------ |
| upgradeInfo | [UpgradeInfo](#upgradeinfo) | 是 | 升级信息对象 |
**返回值:**
......@@ -68,7 +68,7 @@ getRestorer(): Restorer
**返回值:**
| 类型 | 说明 |
| ------------------- | ---- |
| --------------------- | ------ |
| [Restorer](#restorer) | 恢复出厂对象 |
**示例:**
......@@ -92,7 +92,7 @@ getLocalUpdater(): LocalUpdater
**返回值:**
| 类型 | 说明 |
| ------------------- | ---- |
| ----------------------------- | ------ |
| [LocalUpdater](#localupdater) | 本地升级对象 |
**示例:**
......@@ -120,7 +120,7 @@ checkNewVersion(callback: AsyncCallback\<CheckResult>): void
**参数:**
| 参数名 | 类型 | 必填 | 说明 |
| -------- | ---------------------------------------- | ---- | --------- |
| -------- | ---------------------------------------- | ---- | -------------- |
| callback | AsyncCallback\<[CheckResult](#checkresult)> | 是 | 回调函数,返回搜包结果对象。 |
**示例:**
......@@ -144,7 +144,7 @@ checkNewVersion(): Promise\<CheckResult>
**返回值:**
| 类型 | 说明 |
| ---------------------------------------- | ---------------- |
| ------------------------------------- | ------------------- |
| Promise\<[CheckResult](#checkresult)> | Promise对象,返回搜包结果对象。 |
**示例:**
......@@ -172,7 +172,7 @@ getNewVersionInfo(callback: AsyncCallback\<NewVersionInfo>): void
**参数:**
| 参数名 | 类型 | 必填 | 说明 |
| -------- | ---------------------------------------- | ---- | --------- |
| -------- | ---------------------------------------- | ---- | --------------- |
| callback | AsyncCallback\<[NewVersionInfo](#newversioninfo)> | 是 | 回调函数,返回新版本信息对象。 |
**示例:**
......@@ -197,7 +197,7 @@ getNewVersionInfo(): Promise\<NewVersionInfo>
**返回值:**
| 类型 | 说明 |
| ---------------------------------------- | ---------------- |
| ---------------------------------------- | -------------------- |
| Promise\<[NewVersionInfo](#newversioninfo)> | Promise对象,返回新版本信息对象。 |
**示例:**
......@@ -224,7 +224,7 @@ getNewVersionDescription(versionDigestInfo: VersionDigestInfo, descriptionOption
**参数:**
| 参数名 | 类型 | 必填 | 说明 |
| -------- | ---------------------------------------- | ---- | --------- |
| ------------------ | ---------------------------------------- | ---- | -------------- |
| versionDigestInfo | [VersionDigestInfo](#versiondigestinfo) | 是 | 版本摘要信息 |
| descriptionOptions | [DescriptionOptions](#descriptionoptions) | 是 | 描述文件选项 |
| callback | AsyncCallback\<Array\<[ComponentDescription](#componentdescription)>>) | 是 | 回调函数,返回新版本描述文件 |
......@@ -262,14 +262,14 @@ getNewVersionDescription(versionDigestInfo: VersionDigestInfo, descriptionOption
**参数:**
| 参数名 | 类型 | 必填 | 说明 |
| -------- | ---------------------------------------- | ---- | --------- |
| ------------------ | ---------------------------------------- | ---- | ------ |
| versionDigestInfo | [VersionDigestInfo](#versiondigestinfo) | 是 | 版本摘要信息 |
| descriptionOptions | [DescriptionOptions](#descriptionoptions) | 是 | 描述文件选项 |
**返回值:**
| 类型 | 说明 |
| ---------------------------------------- | ---------------- |
| ---------------------------------------- | ------------------- |
| Promise\<Array\<[ComponentDescription](#componentdescription)>> | Promise对象,返回新版本描述文件 |
**示例:**
......@@ -306,7 +306,7 @@ getCurrentVersionInfo(callback: AsyncCallback\<CurrentVersionInfo>): void
**参数:**
| 参数名 | 类型 | 必填 | 说明 |
| -------- | ---------------------------------------- | ---- | --------- |
| -------- | ---------------------------------------- | ---- | ---------------- |
| callback | AsyncCallback\<[CurrentVersionInfo](#currentversioninfo)> | 是 | 回调函数,返回当前版本信息对象。 |
**示例:**
......@@ -332,7 +332,7 @@ getCurrentVersionInfo(): Promise\<CurrentVersionInfo>
**返回值:**
| 类型 | 说明 |
| ---------------------------------------- | ---------------- |
| ---------------------------------------- | ------------------- |
| Promise\<[CurrentVersionInfo](#currentversioninfo)> | Promise对象,返回当前版本对象。 |
**示例:**
......@@ -360,7 +360,7 @@ getCurrentVersionDescription(descriptionOptions: DescriptionOptions, callback: A
**参数:**
| 参数名 | 类型 | 必填 | 说明 |
| -------- | ---------------------------------------- | ---- | --------- |
| ------------------ | ---------------------------------------- | ---- | --------------- |
| descriptionOptions | [DescriptionOptions](#descriptionoptions) | 是 | 描述文件选项 |
| callback | AsyncCallback\<Array\<[ComponentDescription](#componentdescription)>>) | 是 | 回调函数,返回当前版本描述文件 |
......@@ -392,13 +392,13 @@ getCurrentVersionDescription(descriptionOptions: DescriptionOptions): Promise\<A
**参数:**
| 参数名 | 类型 | 必填 | 说明 |
| -------- | ---------------------------------------- | ---- | --------- |
| ------------------ | ---------------------------------------- | ---- | ------ |
| descriptionOptions | [DescriptionOptions](#descriptionoptions) | 是 | 描述文件选项 |
**返回值:**
| 类型 | 说明 |
| ---------------------------------------- | ---------------- |
| ---------------------------------------- | -------------------- |
| Promise\<Array\<[ComponentDescription](#componentdescription)>> | Promise对象,返回当前版本描述文件 |
**示例:**
......@@ -430,7 +430,7 @@ getTaskInfo(callback: AsyncCallback\<TaskInfo>): void
**参数:**
| 参数名 | 类型 | 必填 | 说明 |
| -------- | ---------------------------------------- | ---- | --------- |
| -------- | ------------------------------------- | ---- | ---------------- |
| callback | AsyncCallback\<[TaskInfo](#taskinfo)> | 是 | 回调函数,返回升级任务信息对象。 |
**示例:**
......@@ -454,7 +454,7 @@ getTaskInfo(): Promise\<TaskInfo>
**返回值:**
| 类型 | 说明 |
| ---------------------------------------- | ---------------- |
| ------------------------------- | ------------------- |
| Promise\<[TaskInfo](#taskinfo)> | Promise对象,返回任务信息对象。 |
**示例:**
......@@ -480,7 +480,7 @@ download(versionDigestInfo: VersionDigestInfo, downloadOptions: DownloadOptions,
**参数:**
| 参数名 | 类型 | 必填 | 说明 |
| -------- | ---------------------------------------- | ---- | --------- |
| ----------------- | --------------------------------------- | ---- | ---------------------------------- |
| versionDigestInfo | [VersionDigestInfo](#versiondigestinfo) | 是 | 版本摘要信息 |
| downloadOptions | [DownloadOptions](#downloadoptions) | 是 | 下载选项 |
| callback | AsyncCallback\<void> | 是 | 回调函数。当下载成功时,err为undefined,否则为错误对象。 |
......@@ -516,14 +516,14 @@ download(versionDigestInfo: VersionDigestInfo, downloadOptions: DownloadOptions)
**参数:**
| 参数名 | 类型 | 必填 | 说明 |
| -------- | ---------------------------------------- | ---- | --------- |
| ----------------- | --------------------------------------- | ---- | ------ |
| versionDigestInfo | [VersionDigestInfo](#versiondigestinfo) | 是 | 版本摘要信息 |
| downloadOptions | [DownloadOptions](#downloadoptions) | 是 | 下载选项 |
**返回值:**
| 类型 | 说明 |
| ---------------------------------------- | ---------------- |
| -------------- | -------------------------- |
| Promise\<void> | Promise对象。无返回结果的Promise对象。 |
**示例:**
......@@ -559,7 +559,7 @@ resumeDownload(versionDigestInfo: VersionDigestInfo, resumeDownloadOptions: Resu
**参数:**
| 参数名 | 类型 | 必填 | 说明 |
| -------- | ---------------------------------------- | ---- | --------- |
| --------------------- | ---------------------------------------- | ---- | ------------------------------------ |
| versionDigestInfo | [VersionDigestInfo](#versiondigestinfo) | 是 | 版本摘要信息 |
| resumeDownloadOptions | [ResumeDownloadOptions](#resumedownloadoptions) | 是 | 恢复下载选项 |
| callback | AsyncCallback\<void> | 是 | 回调函数。当恢复下载成功时,err为undefined,否则为错误对象。 |
......@@ -594,14 +594,14 @@ resumeDownload(versionDigestInfo: VersionDigestInfo, resumeDownloadOptions: Resu
**参数:**
| 参数名 | 类型 | 必填 | 说明 |
| -------- | ---------------------------------------- | ---- | --------- |
| --------------------- | ---------------------------------------- | ---- | ------ |
| versionDigestInfo | [VersionDigestInfo](#versiondigestinfo) | 是 | 版本摘要信息 |
| resumeDownloadOptions | [ResumeDownloadOptions](#resumedownloadoptions) | 是 | 恢复下载选项 |
**返回值:**
| 类型 | 说明 |
| ---------------------------------------- | ---------------- |
| -------------- | -------------------------- |
| Promise\<void> | Promise对象。无返回结果的Promise对象。 |
**示例:**
......@@ -636,7 +636,7 @@ pauseDownload(versionDigestInfo: VersionDigestInfo, pauseDownloadOptions: PauseD
**参数:**
| 参数名 | 类型 | 必填 | 说明 |
| -------- | ---------------------------------------- | ---- | --------- |
| -------------------- | ---------------------------------------- | ---- | ------------------------------------ |
| versionDigestInfo | [VersionDigestInfo](#versiondigestinfo) | 是 | 版本摘要信息 |
| pauseDownloadOptions | [PauseDownloadOptions](#pausedownloadoptions) | 是 | 暂停下载选项 |
| callback | AsyncCallback\<void> | 是 | 回调函数。当暂停下载成功时,err为undefined,否则为错误对象。 |
......@@ -671,14 +671,14 @@ pauseDownload(versionDigestInfo: VersionDigestInfo, pauseDownloadOptions: PauseD
**参数:**
| 参数名 | 类型 | 必填 | 说明 |
| -------- | ---------------------------------------- | ---- | --------- |
| -------------------- | ---------------------------------------- | ---- | ------ |
| versionDigestInfo | [VersionDigestInfo](#versiondigestinfo) | 是 | 版本摘要信息 |
| pauseDownloadOptions | [PauseDownloadOptions](#pausedownloadoptions) | 是 | 暂停下载选项 |
**返回值:**
| 类型 | 说明 |
| ---------------------------------------- | ---------------- |
| -------------- | -------------------------- |
| Promise\<void> | Promise对象。无返回结果的Promise对象。 |
**示例:**
......@@ -713,7 +713,7 @@ upgrade(versionDigestInfo: VersionDigestInfo, upgradeOptions: UpgradeOptions, ca
**参数:**
| 参数名 | 类型 | 必填 | 说明 |
| -------- | ---------------------------------------- | ---- | --------- |
| ----------------- | --------------------------------------- | ---- | ------------------------------------ |
| versionDigestInfo | [VersionDigestInfo](#versiondigestinfo) | 是 | 版本摘要信息 |
| upgradeOptions | [UpgradeOptions](#upgradeoptions) | 是 | 更新选项 |
| callback | AsyncCallback\<void> | 是 | 回调函数。当升级执行成功时,err为undefined,否则为错误对象。 |
......@@ -748,14 +748,14 @@ upgrade(versionDigestInfo: VersionDigestInfo, upgradeOptions: UpgradeOptions): P
**参数:**
| 参数名 | 类型 | 必填 | 说明 |
| -------- | ---------------------------------------- | ---- | --------- |
| ----------------- | --------------------------------------- | ---- | ------ |
| versionDigestInfo | [VersionDigestInfo](#versiondigestinfo) | 是 | 版本摘要信息 |
| upgradeOptions | [UpgradeOptions](#upgradeoptions) | 是 | 更新选项 |
**返回值:**
| 类型 | 说明 |
| ---------------------------------------- | ---------------- |
| -------------- | -------------------------- |
| Promise\<void> | Promise对象。无返回结果的Promise对象。 |
**示例:**
......@@ -790,7 +790,7 @@ clearError(versionDigestInfo: VersionDigestInfo, clearOptions: ClearOptions, cal
**参数:**
| 参数名 | 类型 | 必填 | 说明 |
| -------- | ---------------------------------------- | ---- | --------- |
| ----------------- | --------------------------------------- | ---- | ------------------------------------ |
| versionDigestInfo | [VersionDigestInfo](#versiondigestinfo) | 是 | 版本摘要信息 |
| clearOptions | [ClearOptions](#clearoptions) | 是 | 清除选项 |
| callback | AsyncCallback\<void> | 是 | 回调函数。当清除异常成功时,err为undefined,否则为错误对象。 |
......@@ -825,14 +825,14 @@ clearError(versionDigestInfo: VersionDigestInfo, clearOptions: ClearOptions): Pr
**参数:**
| 参数名 | 类型 | 必填 | 说明 |
| -------- | ---------------------------------------- | ---- | --------- |
| ----------------- | --------------------------------------- | ---- | ------ |
| versionDigestInfo | [VersionDigestInfo](#versiondigestinfo) | 是 | 版本摘要信息 |
| clearOptions | [ClearOptions](#clearoptions) | 是 | 更新选项 |
**返回值:**
| 类型 | 说明 |
| ---------------------------------------- | ---------------- |
| -------------- | -------------------------- |
| Promise\<void> | Promise对象。无返回结果的Promise对象。 |
**示例:**
......@@ -867,7 +867,7 @@ getUpgradePolicy(callback: AsyncCallback\<UpgradePolicy>): void
**参数:**
| 参数名 | 类型 | 必填 | 说明 |
| -------- | ---------------------------------------- | ---- | ---------- |
| -------- | ---------------------------------------- | ---- | --------------- |
| callback | AsyncCallback\<[UpgradePolicy](#upgradepolicy)> | 是 | 回调函数,返回升级策略信息对象 |
**示例:**
......@@ -892,7 +892,7 @@ getUpgradePolicy(): Promise\<UpgradePolicy>
**返回值:**
| 类型 | 说明 |
| --------------------------------------- | ----------------- |
| ---------------------------------------- | --------------------- |
| Promise\<[UpgradePolicy](#upgradepolicy)> | Promise对象,返回升级策略信息对象。 |
**示例:**
......@@ -919,7 +919,7 @@ setUpgradePolicy(policy: UpgradePolicy, callback: AsyncCallback\<void>): void
**参数:**
| 参数名 | 类型 | 必填 | 说明 |
| -------- | ---------------------------------------- | ---- | ---------- |
| -------- | ------------------------------- | ---- | ------------- |
| policy | [UpgradePolicy](#upgradepolicy) | 是 | 升级策略 |
| callback | AsyncCallback\<void> | 是 | 回调函数,返回设置结果对象 |
......@@ -949,13 +949,13 @@ setUpgradePolicy(policy: UpgradePolicy): Promise\<void>
**参数:**
| 参数名 | 类型 | 必填 | 说明 |
| ------ | ----------------------------- | ---- | ------ |
| ------ | ------------------------------- | ---- | ---- |
| policy | [UpgradePolicy](#upgradepolicy) | 是 | 升级策略 |
**返回值:**
| 类型 | 说明 |
| ---------------- | --------------- |
| -------------- | ------------------- |
| Promise\<void> | Promise对象,返回设置结果对象。 |
**示例:**
......@@ -986,7 +986,7 @@ terminateUpgrade(callback: AsyncCallback\<void>): void
**参数:**
| 参数名 | 类型 | 必填 | 说明 |
| -------- | ---------------------------------------- | ---- | --------- |
| -------- | -------------------- | ---- | -------------------------------------- |
| callback | AsyncCallback\<void> | 是 | 回调函数。当清除升级缓存成功时,err为undefined,否则为错误对象。 |
**示例:**
......@@ -1010,7 +1010,7 @@ terminateUpgrade(): Promise\<void>
**返回值:**
| 类型 | 说明 |
| ---------------------------------------- | ---------------- |
| -------------- | -------------------------- |
| Promise\<void> | Promise对象。无返回结果的Promise对象。 |
**示例:**
......@@ -1034,7 +1034,7 @@ on(eventClassifyInfo: EventClassifyInfo, taskCallback: UpgradeTaskCallback): voi
**参数:**
| 参数名 | 类型 | 必填 | 说明 |
| -------- | ---------------------------------------- | ---- | --------- |
| ----------------- | ---------------------------------------- | ---- | ---- |
| eventClassifyInfo | [EventClassifyInfo](#eventclassifyinfo) | 是 | 事件信息 |
| taskCallback | [UpgradeTaskCallback](#upgradetaskcallback) | 是 | 事件回调 |
......@@ -1061,7 +1061,7 @@ off(eventClassifyInfo: EventClassifyInfo, taskCallback?: UpgradeTaskCallback): v
**参数:**
| 参数名 | 类型 | 必填 | 说明 |
| -------- | ---------------------------------------- | ---- | --------- |
| ----------------- | ---------------------------------------- | ---- | ---- |
| eventClassifyInfo | [EventClassifyInfo](#eventclassifyinfo) | 是 | 事件信息 |
| taskCallback | [UpgradeTaskCallback](#upgradetaskcallback) | 否 | 事件回调 |
......@@ -1093,7 +1093,7 @@ factoryReset(callback: AsyncCallback\<void>): void
**参数:**
| 参数名 | 类型 | 必填 | 说明 |
| -------- | ---------------------------------------- | ---- | --------- |
| -------- | -------------------- | ---- | -------------------------------------- |
| callback | AsyncCallback\<void> | 是 | 回调函数。当恢复出厂执行成功时,err为undefined,否则为错误对象。 |
**示例:**
......@@ -1117,7 +1117,7 @@ factoryReset(): Promise\<void>
**返回值:**
| 类型 | 说明 |
| ---------------------------------------- | ---------------- |
| -------------- | -------------------------- |
| Promise\<void> | Promise对象。无返回结果的Promise对象。 |
**示例:**
......@@ -1145,7 +1145,7 @@ verifyUpgradePackage(upgradeFile: UpgradeFile, certsFile: string, callback: Asyn
**参数:**
| 参数名 | 类型 | 必填 | 说明 |
| -------- | ---------------------------------------- | ---- | --------- |
| ----------- | --------------------------- | ---- | ---------------- |
| upgradeFile | [UpgradeFile](#upgradefile) | 是 | 升级文件 |
| certsFile | string | 是 | 证书文件路径 |
| callback | AsyncCallback\<void> | 是 | 回调函数,返回升级包校验结果对象 |
......@@ -1176,14 +1176,14 @@ verifyUpgradePackage(upgradeFile: UpgradeFile, certsFile: string): Promise\<void
**参数:**
| 参数名 | 类型 | 必填 | 说明 |
| -------- | ---------------------------------------- | ---- | --------- |
| ----------- | --------------------------- | ---- | ------ |
| upgradeFile | [UpgradeFile](#upgradefile) | 是 | 升级文件 |
| certsFile | string | 是 | 证书文件路径 |
**返回值:**
| 类型 | 说明 |
| ---------------------------------------- | ---------------- |
| -------------- | ---------------------- |
| Promise\<void> | Promise对象,返回升级包校验结果对象。 |
**示例:**
......@@ -1212,7 +1212,7 @@ applyNewVersion(upgradeFiles: Array<[UpgradeFile](#upgradefile)>, callback: Asyn
**参数:**
| 参数名 | 类型 | 必填 | 说明 |
| -------- | ---------------------------------------- | ---- | --------- |
| ----------- | ---------------------------------- | ---- | --------------------------------------- |
| upgradeFile | Array<[UpgradeFile](#upgradefile)> | 是 | 升级文件 |
| callback | AsyncCallback\<void> | 是 | 回调函数。当安装升级包执行成功时,err为undefined,否则为错误对象。 |
......@@ -1242,7 +1242,7 @@ applyNewVersion(upgradeFiles: Array<[UpgradeFile](#upgradefile)>): Promise\<void
**返回值:**
| 类型 | 说明 |
| ---------------------------------------- | ---------------- |
| -------------- | -------------------------- |
| Promise\<void> | Promise对象。无返回结果的Promise对象。 |
**示例:**
......@@ -1269,7 +1269,7 @@ on(eventClassifyInfo: EventClassifyInfo, taskCallback: UpgradeTaskCallback): voi
**参数:**
| 参数名 | 类型 | 必填 | 说明 |
| -------- | ---------------------------------------- | ---- | --------- |
| ----------------- | ---------------------------------------- | ---- | ---- |
| eventClassifyInfo | [EventClassifyInfo](#eventclassifyinfo) | 是 | 事件信息 |
| taskCallback | [UpgradeTaskCallback](#upgradetaskcallback) | 是 | 事件回调 |
......@@ -1298,7 +1298,7 @@ off(eventClassifyInfo: EventClassifyInfo, taskCallback?: UpgradeTaskCallback): v
**参数:**
| 参数名 | 类型 | 必填 | 说明 |
| -------- | ---------------------------------------- | ---- | --------- |
| ----------------- | ---------------------------------------- | ---- | ---- |
| eventClassifyInfo | [EventClassifyInfo](#eventclassifyinfo) | 是 | 事件信息 |
| taskCallback | [UpgradeTaskCallback](#upgradetaskcallback) | 是 | 事件回调 |
......@@ -1324,7 +1324,7 @@ localUpdater.off(eventClassifyInfo, onTaskUpdate);
**系统能力**:SystemCapability.Update.UpdateService
| 名称 | 参数类型 | 必填 | 说明 |
| ------------------- | --------------------------- | ---- | ------- |
| ------------ | ----------------------------- | ---- | ------ |
| upgradeApp | string | 是 | 调用方包名 |
| businessType | [BusinessType](#businesstype) | 是 | 升级业务类型 |
......@@ -1335,7 +1335,7 @@ localUpdater.off(eventClassifyInfo, onTaskUpdate);
**系统能力**:SystemCapability.Update.UpdateService
| 名称 | 参数类型 | 必填 | 说明 |
| ------------------- | --------------------------- | ---- | ------- |
| ------- | ----------------------------------- | ---- | ---- |
| vendor | [BusinessVendor](#businessvendor) | 是 | 供应商 |
| subType | [BusinessSubType](#businesssubtype) | 是 | 类型 |
......@@ -1346,7 +1346,7 @@ localUpdater.off(eventClassifyInfo, onTaskUpdate);
**系统能力**:SystemCapability.Update.UpdateService
| 名称 | 参数类型 | 必填 | 说明 |
| ------------------- | --------------------------- | ---- | ------- |
| ----------------- | --------------------------------- | ---- | ------ |
| isExistNewVersion | bool | 是 | 是否有新版本 |
| newVersionInfo | [NewVersionInfo](#newversioninfo) | 否 | 新版本数据 |
......@@ -1357,7 +1357,7 @@ localUpdater.off(eventClassifyInfo, onTaskUpdate);
**系统能力**:SystemCapability.Update.UpdateService
| 名称 | 参数类型 | 必填 | 说明 |
| ------------------- | --------------------------- | ---- | ------- |
| ----------------- | ---------------------------------------- | ---- | ---- |
| versionDigestInfo | [VersionDigestInfo](#versiondigestinfo) | 是 | 版本摘要 |
| versionComponents | Array\<[VersionComponent](#versioncomponent)> | 是 | 版本组件 |
......@@ -1368,7 +1368,7 @@ localUpdater.off(eventClassifyInfo, onTaskUpdate);
**系统能力**:SystemCapability.Update.UpdateService
| 名称 | 参数类型 | 必填 | 说明 |
| ------------------- | --------------------------- | ---- | ------- |
| ------------- | ------ | ---- | ---- |
| versionDigest | string | 是 | 版本摘要 |
## VersionComponent
......@@ -1378,9 +1378,9 @@ localUpdater.off(eventClassifyInfo, onTaskUpdate);
**系统能力**:SystemCapability.Update.UpdateService
| 名称 | 参数类型 | 必填 | 说明 |
| ------------------- | --------------------------- | ---- | ------- |
| --------------- | ----------------------------------- | ---- | -------- |
| componentId | number | 是 | 组件标识 |
| componentType | [ComponentType](#componentyype) | 是 | 组件类型 |
| componentType | [ComponentType](#componenttype) | 是 | 组件类型 |
| upgradeAction | [UpgradeAction](#upgradeaction) | 是 | 升级方式 |
| displayVersion | string | 是 | 显示版本号 |
| innerVersion | string | 是 | 版本号 |
......@@ -1395,7 +1395,7 @@ localUpdater.off(eventClassifyInfo, onTaskUpdate);
**系统能力**:SystemCapability.Update.UpdateService
| 名称 | 参数类型 | 必填 | 说明 |
| ------------------- | --------------------------- | ---- | ------- |
| -------- | --------------------------------------- | ---- | ------ |
| format | [DescriptionFormat](#descriptionformat) | 是 | 描述文件格式 |
| language | string | 是 | 描述文件语言 |
......@@ -1406,7 +1406,7 @@ localUpdater.off(eventClassifyInfo, onTaskUpdate);
**系统能力**:SystemCapability.Update.UpdateService
| 名称 | 参数类型 | 必填 | 说明 |
| ------------------- | --------------------------- | ---- | ------- |
| --------------- | ----------------------------------- | ---- | ------ |
| componentId | string | 是 | 组件标识 |
| descriptionInfo | [DescriptionInfo](#descriptioninfo) | 是 | 描述文件信息 |
......@@ -1417,7 +1417,7 @@ localUpdater.off(eventClassifyInfo, onTaskUpdate);
**系统能力**:SystemCapability.Update.UpdateService
| 名称 | 参数类型 | 必填 | 说明 |
| ------------------- | --------------------------- | ---- | ------- |
| --------------- | ----------------------------------- | ---- | ------ |
| descriptionType | [DescriptionType](#descriptiontype) | 是 | 描述文件类型 |
| content | string | 是 | 描述文件内容 |
......@@ -1428,10 +1428,10 @@ localUpdater.off(eventClassifyInfo, onTaskUpdate);
**系统能力**:SystemCapability.Update.UpdateService
| 名称 | 参数类型 | 必填 | 说明 |
| ------------------- | --------------------------- | ---- | ------- |
| ----------------- | ---------------------------------------- | ---- | ----- |
| osVersion | string | 是 | 系统版本号 |
| deviceName | string | 是 | 设备名 |
| versionComponents | Array\<[VersionComponent](#vesioncomponent)> | 否 | 版本组件 |
| versionComponents | Array\<[VersionComponent](#versioncomponent)> | 否 | 版本组件 |
## DownloadOptions
......@@ -1440,7 +1440,7 @@ localUpdater.off(eventClassifyInfo, onTaskUpdate);
**系统能力**:SystemCapability.Update.UpdateService
| 名称 | 参数类型 | 必填 | 说明 |
| ------------------- | --------------------------- | ---- | ------- |
| ------------ | ------------------- | ---- | ---- |
| allowNetwork | [NetType](#nettype) | 是 | 网络类型 |
| order | [Order](#order) | 是 | 升级指令 |
......@@ -1451,7 +1451,7 @@ localUpdater.off(eventClassifyInfo, onTaskUpdate);
**系统能力**:SystemCapability.Update.UpdateService
| 名称 | 参数类型 | 必填 | 说明 |
| ------------------- | --------------------------- | ---- | ------- |
| ------------ | ------------------- | ---- | ---- |
| allowNetwork | [NetType](#nettype) | 是 | 网络类型 |
## PauseDownloadOptions
......@@ -1461,7 +1461,7 @@ localUpdater.off(eventClassifyInfo, onTaskUpdate);
**系统能力**:SystemCapability.Update.UpdateService
| 名称 | 参数类型 | 必填 | 说明 |
| ------------------- | --------------------------- | ---- | ------- |
| ----------------- | ---- | ---- | -------- |
| isAllowAutoResume | bool | 是 | 是否允许自动恢复 |
## UpgradeOptions
......@@ -1471,7 +1471,7 @@ localUpdater.off(eventClassifyInfo, onTaskUpdate);
**系统能力**:SystemCapability.Update.UpdateService
| 名称 | 参数类型 | 必填 | 说明 |
| ------------------- | --------------------------- | ---- | ------- |
| ----- | --------------- | ---- | ---- |
| order | [Order](#order) | 是 | 升级指令 |
## ClearOptions
......@@ -1481,7 +1481,7 @@ localUpdater.off(eventClassifyInfo, onTaskUpdate);
**系统能力**:SystemCapability.Update.UpdateService
| 名称 | 参数类型 | 必填 | 说明 |
| ------------------- | --------------------------- | ---- | ------- |
| ------ | ------------------------------- | ---- | ---- |
| status | [UpgradeStatus](#upgradestatus) | 是 | 异常状态 |
## UpgradePolicy
......@@ -1491,7 +1491,7 @@ localUpdater.off(eventClassifyInfo, onTaskUpdate);
**系统能力**:SystemCapability.Update.UpdateService
| 名称 | 参数类型 | 必填 | 说明 |
| ------------------- | --------------------------- | ---- | ------- |
| ------------------- | --------------------------------------- | ---- | ------- |
| downloadStrategy | bool | 是 | 自动下载策略 |
| autoUpgradeStrategy | bool | 是 | 自动升级策略 |
| autoUpgradePeriods | Array\<[UpgradePeriod](#upgradeperiod)> | 是 | 自动升级时间段 |
......@@ -1503,7 +1503,7 @@ localUpdater.off(eventClassifyInfo, onTaskUpdate);
**系统能力**:SystemCapability.Update.UpdateService
| 名称 | 参数类型 | 必填 | 说明 |
| ------------------- | --------------------------- | ---- | ------- |
| ----- | ------ | ---- | ---- |
| start | number | 是 | 开始时间 |
| end | number | 是 | 结束时间 |
......@@ -1514,7 +1514,7 @@ localUpdater.off(eventClassifyInfo, onTaskUpdate);
**系统能力**:SystemCapability.Update.UpdateService
| 名称 | 参数类型 | 必填 | 说明 |
| ------------------- | --------------------------- | ---- | ------- |
| --------- | --------------------- | ---- | ------ |
| existTask | bool | 是 | 是否存在任务 |
| taskBody | [TaskBody](#taskinfo) | 是 | 任务数据 |
......@@ -1525,7 +1525,7 @@ localUpdater.off(eventClassifyInfo, onTaskUpdate);
**系统能力**:SystemCapability.Update.UpdateService
| 名称 | 参数类型 | 必填 | 说明 |
| ------------------- | --------------------------- | ---- | ------- |
| -------- | --------------------- | ---- | ---- |
| eventId | [EventId](#eventid) | 是 | 事件ID |
| taskBody | [TaskBody](#taskinfo) | 是 | 任务数据 |
......@@ -1536,7 +1536,7 @@ localUpdater.off(eventClassifyInfo, onTaskUpdate);
**系统能力**:SystemCapability.Update.UpdateService
| 名称 | 参数类型 | 必填 | 说明 |
| ------------------- | --------------------------- | ---- | ------- |
| ----------------- | ---------------------------------------- | ---- | ---- |
| versionDigestInfo | [VersionDigestInfo](#versiondigestinfo) | 是 | 版本摘要 |
| status | [UpgradeStatus](#upgradestatus) | 是 | 升级状态 |
| subStatus | number | 否 | 子状态 |
......@@ -1552,7 +1552,7 @@ localUpdater.off(eventClassifyInfo, onTaskUpdate);
**系统能力**:SystemCapability.Update.UpdateService
| 名称 | 参数类型 | 必填 | 说明 |
| ------------------- | --------------------------- | ---- | ------- |
| ------------ | ------ | ---- | ---- |
| errorCode | number | 是 | 错误码 |
| errorMessage | string | 是 | 错误描述 |
......@@ -1563,7 +1563,7 @@ localUpdater.off(eventClassifyInfo, onTaskUpdate);
**系统能力**:SystemCapability.Update.UpdateService
| 名称 | 参数类型 | 必填 | 说明 |
| ------------------- | --------------------------- | ---- | ------- |
| ------------- | ------------------------------- | ---- | ---- |
| eventClassify | [EventClassify](#eventclassify) | 是 | 事件类型 |
| extraInfo | string | 是 | 额外信息 |
......@@ -1574,7 +1574,7 @@ localUpdater.off(eventClassifyInfo, onTaskUpdate);
**系统能力**:SystemCapability.Update.UpdateService
| 名称 | 参数类型 | 必填 | 说明 |
| ------------------- | --------------------------- | ---- | ------- |
| -------- | ------------------------------- | ---- | ---- |
| fileType | [ComponentType](#componenttype) | 是 | 文件类型 |
| filePath | string | 是 | 文件路径 |
......@@ -1587,7 +1587,7 @@ localUpdater.off(eventClassifyInfo, onTaskUpdate);
**系统能力**:SystemCapability.Update.UpdateService
| 名称 | 参数类型 | 必填 | 说明 |
| --------------- | ---------------------------------------- | ---- | ---- |
| --------- | ----------------------- | ---- | ---- |
| eventInfo | [EventInfo](#eventinfo) | 是 | 事件信息 |
## BusinessVendor
......@@ -1597,7 +1597,7 @@ localUpdater.off(eventClassifyInfo, onTaskUpdate);
**系统能力**:SystemCapability.Update.UpdateService
| 参数名 | 默认值 | 说明 |
| ------------------- | ---- | -------- |
| ------ | -------- | ---- |
| PUBLIC | "public" | 开源 |
## BusinessSubType
......@@ -1607,7 +1607,7 @@ localUpdater.off(eventClassifyInfo, onTaskUpdate);
**系统能力**:SystemCapability.Update.UpdateService
| 参数名 | 默认值 | 说明 |
| ------------------- | ---- | -------- |
| -------- | ---- | ---- |
| FIRMWARE | 1 | 固件 |
## ComponentType
......@@ -1617,7 +1617,7 @@ localUpdater.off(eventClassifyInfo, onTaskUpdate);
**系统能力**:SystemCapability.Update.UpdateService
| 参数名 | 默认值 | 说明 |
| ------------------- | ---- | -------- |
| ---- | ---- | ---- |
| OTA | 1 | 固件 |
## UpgradeAction
......@@ -1627,7 +1627,7 @@ localUpdater.off(eventClassifyInfo, onTaskUpdate);
**系统能力**:SystemCapability.Update.UpdateService
| 参数名 | 默认值 | 说明 |
| ------------------- | ---- | -------- |
| -------- | ---------- | ---- |
| UPGRADE | "upgrade" | 差分包 |
| RECOVERY | "recovery" | 修复包 |
......@@ -1638,7 +1638,7 @@ localUpdater.off(eventClassifyInfo, onTaskUpdate);
**系统能力**:SystemCapability.Update.UpdateService
| 参数名 | 默认值 | 说明 |
| ------------------- | ---- | -------- |
| ------------- | ---- | ---- |
| COLD | 1 | 冷升级 |
| LIVE | 2 | 热升级 |
| LIVE_AND_COLD | 3 | 融合升级 |
......@@ -1650,7 +1650,7 @@ localUpdater.off(eventClassifyInfo, onTaskUpdate);
**系统能力**:SystemCapability.Update.UpdateService
| 参数名 | 默认值 | 说明 |
| ------------------- | ---- | -------- |
| ------- | ---- | ---- |
| CONTENT | 0 | 内容 |
| URI | 1 | 链接 |
......@@ -1661,7 +1661,7 @@ localUpdater.off(eventClassifyInfo, onTaskUpdate);
**系统能力**:SystemCapability.Update.UpdateService
| 参数名 | 默认值 | 说明 |
| ------------------- | ---- | -------- |
| ---------- | ---- | ---- |
| STANDARD | 0 | 标准格式 |
| SIMPLIFIED | 1 | 简易格式 |
......@@ -1672,7 +1672,7 @@ localUpdater.off(eventClassifyInfo, onTaskUpdate);
**系统能力**:SystemCapability.Update.UpdateService
| 参数名 | 默认值 | 说明 |
| ------------------- | ---- | -------- |
| ----------------- | ---- | --------- |
| CELLULAR | 1 | 数据网络 |
| METERED_WIFI | 2 | 热点WIFI |
| NOT_METERED_WIFI | 4 | 非热点WIFI |
......@@ -1686,7 +1686,7 @@ localUpdater.off(eventClassifyInfo, onTaskUpdate);
**系统能力**:SystemCapability.Update.UpdateService
| 参数名 | 默认值 | 说明 |
| ------------------- | ---- | -------- |
| -------------------- | ---- | ----- |
| DOWNLOAD | 1 | 下载 |
| INSTALL | 2 | 安装 |
| DOWNLOAD_AND_INSTALL | 3 | 下载并安装 |
......@@ -1700,7 +1700,7 @@ localUpdater.off(eventClassifyInfo, onTaskUpdate);
**系统能力**:SystemCapability.Update.UpdateService
| 参数名 | 默认值 | 说明 |
| ------------------- | ---- | -------- |
| ---------------- | ---- | ---- |
| WAITING_DOWNLOAD | 20 | 待下载 |
| DOWNLOADING | 21 | 下载中 |
| DOWNLOAD_PAUSED | 22 | 下载暂停 |
......@@ -1719,7 +1719,7 @@ localUpdater.off(eventClassifyInfo, onTaskUpdate);
**系统能力**:SystemCapability.Update.UpdateService
| 参数名 | 默认值 | 说明 |
| ------------------- | ---- | -------- |
| ---- | ---------- | ---- |
| TASK | 0x01000000 | 任务事件 |
## EventId
......@@ -1729,7 +1729,7 @@ localUpdater.off(eventClassifyInfo, onTaskUpdate);
**系统能力**:SystemCapability.Update.UpdateService
| 参数名 | 默认值 | 说明 |
| ------------------- | ---- | -------- |
| ---------------------- | ---------- | ------ |
| EVENT_TASK_BASE | 0x01000000 | 任务事件 |
| EVENT_TASK_RECEIVE | 0x01000001 | 收到任务 |
| EVENT_TASK_CANCEL | 0x01000010 | 取消任务 |
......
......@@ -35,7 +35,7 @@ Image(src: string | PixelMap | Resource)
**参数:**
| 参数名 | 参数类型 | 必填 | 默认值 | 参数描述 |
| ------ | ------------------------------------------------------------ | ---- | ------ | ------------------------------------------------------------ |
| ---- | ---------------------------------------- | ---- | ---- | ---------------------------------------- |
| src | string\|&nbsp;[PixelMap](../apis/js-apis-image.md#pixelmap7)\|&nbsp;[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&nbsp;ability提供的图片路径。 |
## 属性
......
Markdown is supported
0% .
You are about to add 0 people to the discussion. Proceed with caution.
先完成此消息的编辑!
想要评论请 注册