From e05dee3ca557158d78cb65bf8ab6f0a1dbbb997e Mon Sep 17 00:00:00 2001 From: jackd320 Date: Mon, 21 Nov 2022 11:08:19 +0000 Subject: [PATCH] Signed-off-by: jackd320 Signed-off-by: jackd320 --- .../reference/apis/js-apis-update.md | 328 ++++++++++++++++++ 1 file changed, 328 insertions(+) diff --git a/zh-cn/application-dev/reference/apis/js-apis-update.md b/zh-cn/application-dev/reference/apis/js-apis-update.md index 1053f46291..c0b57c19b5 100644 --- a/zh-cn/application-dev/reference/apis/js-apis-update.md +++ b/zh-cn/application-dev/reference/apis/js-apis-update.md @@ -39,6 +39,14 @@ getOnlineUpdater(upgradeInfo: UpgradeInfo): Updater | ------------------- | ---- | | [Updater](#updater) | 升级对象。 | +**错误码**： + +以下的错误码的详细介绍请参见[升级错误码](../errorcodes/errorcode-update.md) + +| 类型 | 说明 | +| ------- | ------------------------------------- | +| 11500104 | IPC error. | + **示例：** ```ts @@ -71,6 +79,14 @@ getRestorer(): Restorer | --------------------- | ------ | | [Restorer](#restorer) | 恢复出厂对象。 | +**错误码**： + +以下的错误码的详细介绍请参见[升级错误码](../errorcodes/errorcode-update.md) + +| 类型 | 说明 | +| ------- | ------------------------------------- | +| 11500104 | IPC error. | + **示例：** ```ts @@ -95,6 +111,14 @@ getLocalUpdater(): LocalUpdater | ----------------------------- | ------ | | [LocalUpdater](#localupdater) | 本地升级对象。 | +**错误码**： + +以下的错误码的详细介绍请参见[升级错误码](../errorcodes/errorcode-update.md) + +| 类型 | 说明 | +| ------- | ------------------------------------- | +| 11500104 | IPC error. | + **示例：** ```ts @@ -123,6 +147,14 @@ checkNewVersion(callback: AsyncCallback\): void | -------- | ---------------------------------------- | ---- | -------------- | | callback | AsyncCallback\<[CheckResult](#checkresult)> | 是 | 回调函数，返回搜包结果对象。 | +**错误码**： + +以下的错误码的详细介绍请参见[升级错误码](../errorcodes/errorcode-update.md) + +| 类型 | 说明 | +| ------- | ------------------------------------- | +| 11500104 | IPC error. | + **示例：** ```ts @@ -147,6 +179,14 @@ checkNewVersion(): Promise\ | ------------------------------------- | ------------------- | | Promise\<[CheckResult](#checkresult)> | Promise对象，返回搜包结果对象。 | +**错误码**： + +以下的错误码的详细介绍请参见[升级错误码](../errorcodes/errorcode-update.md) + +| 类型 | 说明 | +| ------- | ------------------------------------- | +| 11500104 | IPC error. | + **示例:** ```ts @@ -175,6 +215,14 @@ getNewVersionInfo(callback: AsyncCallback\): void | -------- | ---------------------------------------- | ---- | --------------- | | callback | AsyncCallback\<[NewVersionInfo](#newversioninfo)> | 是 | 回调函数，返回新版本信息对象。 | +**错误码**： + +以下的错误码的详细介绍请参见[升级错误码](../errorcodes/errorcode-update.md) + +| 类型 | 说明 | +| ------- | ------------------------------------- | +| 11500104 | IPC error. | + **示例：** ```ts @@ -200,6 +248,14 @@ getNewVersionInfo(): Promise\ | ---------------------------------------- | -------------------- | | Promise\<[NewVersionInfo](#newversioninfo)> | Promise对象，返回新版本信息对象。 | +**错误码**： + +以下的错误码的详细介绍请参见[升级错误码](../errorcodes/errorcode-update.md) + +| 类型 | 说明 | +| ------- | ------------------------------------- | +| 11500104 | IPC error. | + **示例：** ```ts @@ -229,6 +285,14 @@ getNewVersionDescription(versionDigestInfo: VersionDigestInfo, descriptionOption | descriptionOptions | [DescriptionOptions](#descriptionoptions) | 是 | 描述文件选项。 | | callback | AsyncCallback\>) | 是 | 回调函数，返回新版本描述文件。 | +**错误码**： + +以下的错误码的详细介绍请参见[升级错误码](../errorcodes/errorcode-update.md) + +| 类型 | 说明 | +| ------- | ------------------------------------- | +| 11500104 | IPC error. | + **示例：** ```ts @@ -272,6 +336,14 @@ getNewVersionDescription(versionDigestInfo: VersionDigestInfo, descriptionOption | ---------------------------------------- | ------------------- | | Promise\> | Promise对象，返回新版本描述文件。 | +**错误码**： + +以下的错误码的详细介绍请参见[升级错误码](../errorcodes/errorcode-update.md) + +| 类型 | 说明 | +| ------- | ------------------------------------- | +| 11500104 | IPC error. | + **示例：** ```ts @@ -309,6 +381,14 @@ getCurrentVersionInfo(callback: AsyncCallback\): void | -------- | ---------------------------------------- | ---- | ---------------- | | callback | AsyncCallback\<[CurrentVersionInfo](#currentversioninfo)> | 是 | 回调函数，返回当前版本信息对象。 | +**错误码**： + +以下的错误码的详细介绍请参见[升级错误码](../errorcodes/errorcode-update.md) + +| 类型 | 说明 | +| ------- | ------------------------------------- | +| 11500104 | IPC error. | + **示例：** ```ts @@ -335,6 +415,14 @@ getCurrentVersionInfo(): Promise\ | ---------------------------------------- | ------------------- | | Promise\<[CurrentVersionInfo](#currentversioninfo)> | Promise对象，返回当前版本对象。 | +**错误码**： + +以下的错误码的详细介绍请参见[升级错误码](../errorcodes/errorcode-update.md) + +| 类型 | 说明 | +| ------- | ------------------------------------- | +| 11500104 | IPC error. | + **示例：** ```ts @@ -364,6 +452,14 @@ getCurrentVersionDescription(descriptionOptions: DescriptionOptions, callback: A | descriptionOptions | [DescriptionOptions](#descriptionoptions) | 是 | 描述文件选项。 | | callback | AsyncCallback\>) | 是 | 回调函数，返回当前版本描述文件。 | +**错误码**： + +以下的错误码的详细介绍请参见[升级错误码](../errorcodes/errorcode-update.md) + +| 类型 | 说明 | +| ------- | ------------------------------------- | +| 11500104 | IPC error. | + **示例：** ```ts @@ -401,6 +497,14 @@ getCurrentVersionDescription(descriptionOptions: DescriptionOptions): Promise\> | Promise对象，返回当前版本描述文件。 | +**错误码**： + +以下的错误码的详细介绍请参见[升级错误码](../errorcodes/errorcode-update.md) + +| 类型 | 说明 | +| ------- | ------------------------------------- | +| 11500104 | IPC error. | + **示例：** ```ts @@ -433,6 +537,14 @@ getTaskInfo(callback: AsyncCallback\): void | -------- | ------------------------------------- | ---- | ---------------- | | callback | AsyncCallback\<[TaskInfo](#taskinfo)> | 是 | 回调函数，返回升级任务信息对象。 | +**错误码**： + +以下的错误码的详细介绍请参见[升级错误码](../errorcodes/errorcode-update.md) + +| 类型 | 说明 | +| ------- | ------------------------------------- | +| 11500104 | IPC error. | + **示例：** ```ts @@ -457,6 +569,14 @@ getTaskInfo(): Promise\ | ------------------------------- | ------------------- | | Promise\<[TaskInfo](#taskinfo)> | Promise对象，返回任务信息对象。 | +**错误码**： + +以下的错误码的详细介绍请参见[升级错误码](../errorcodes/errorcode-update.md) + +| 类型 | 说明 | +| ------- | ------------------------------------- | +| 11500104 | IPC error. | + **示例：** ```ts @@ -485,6 +605,14 @@ download(versionDigestInfo: VersionDigestInfo, downloadOptions: DownloadOptions, | downloadOptions | [DownloadOptions](#downloadoptions) | 是 | 下载选项。 | | callback | AsyncCallback\ | 是 | 回调函数。当下载成功时，err为undefined，否则为错误对象。 | +**错误码**： + +以下的错误码的详细介绍请参见[升级错误码](../errorcodes/errorcode-update.md) + +| 类型 | 说明 | +| ------- | ------------------------------------- | +| 11500104 | IPC error. | + **示例：** ```ts @@ -526,6 +654,14 @@ download(versionDigestInfo: VersionDigestInfo, downloadOptions: DownloadOptions) | -------------- | -------------------------- | | Promise\ | Promise对象。无返回结果的Promise对象。 | +**错误码**： + +以下的错误码的详细介绍请参见[升级错误码](../errorcodes/errorcode-update.md) + +| 类型 | 说明 | +| ------- | ------------------------------------- | +| 11500104 | IPC error. | + **示例：** ```ts @@ -564,6 +700,14 @@ resumeDownload(versionDigestInfo: VersionDigestInfo, resumeDownloadOptions: Resu | resumeDownloadOptions | [ResumeDownloadOptions](#resumedownloadoptions) | 是 | 恢复下载选项。 | | callback | AsyncCallback\ | 是 | 回调函数。当恢复下载成功时，err为undefined，否则为错误对象。 | +**错误码**： + +以下的错误码的详细介绍请参见[升级错误码](../errorcodes/errorcode-update.md) + +| 类型 | 说明 | +| ------- | ------------------------------------- | +| 11500104 | IPC error. | + **示例：** ```ts @@ -604,6 +748,14 @@ resumeDownload(versionDigestInfo: VersionDigestInfo, resumeDownloadOptions: Resu | -------------- | -------------------------- | | Promise\ | Promise对象。无返回结果的Promise对象。 | +**错误码**： + +以下的错误码的详细介绍请参见[升级错误码](../errorcodes/errorcode-update.md) + +| 类型 | 说明 | +| ------- | ------------------------------------- | +| 11500104 | IPC error. | + **示例：** ```ts @@ -641,6 +793,14 @@ pauseDownload(versionDigestInfo: VersionDigestInfo, pauseDownloadOptions: PauseD | pauseDownloadOptions | [PauseDownloadOptions](#pausedownloadoptions) | 是 | 暂停下载选项。 | | callback | AsyncCallback\ | 是 | 回调函数。当暂停下载成功时，err为undefined，否则为错误对象。 | +**错误码**： + +以下的错误码的详细介绍请参见[升级错误码](../errorcodes/errorcode-update.md) + +| 类型 | 说明 | +| ------- | ------------------------------------- | +| 11500104 | IPC error. | + **示例：** ```ts @@ -681,6 +841,14 @@ pauseDownload(versionDigestInfo: VersionDigestInfo, pauseDownloadOptions: PauseD | -------------- | -------------------------- | | Promise\ | Promise对象。无返回结果的Promise对象。 | +**错误码**： + +以下的错误码的详细介绍请参见[升级错误码](../errorcodes/errorcode-update.md) + +| 类型 | 说明 | +| ------- | ------------------------------------- | +| 11500104 | IPC error. | + **示例：** ```ts @@ -718,6 +886,14 @@ upgrade(versionDigestInfo: VersionDigestInfo, upgradeOptions: UpgradeOptions, ca | upgradeOptions | [UpgradeOptions](#upgradeoptions) | 是 | 更新选项。 | | callback | AsyncCallback\ | 是 | 回调函数。当升级执行成功时，err为undefined，否则为错误对象。 | +**错误码**： + +以下的错误码的详细介绍请参见[升级错误码](../errorcodes/errorcode-update.md) + +| 类型 | 说明 | +| ------- | ------------------------------------- | +| 11500104 | IPC error. | + **示例：** ```ts @@ -758,6 +934,14 @@ upgrade(versionDigestInfo: VersionDigestInfo, upgradeOptions: UpgradeOptions): P | -------------- | -------------------------- | | Promise\ | Promise对象。无返回结果的Promise对象。 | +**错误码**： + +以下的错误码的详细介绍请参见[升级错误码](../errorcodes/errorcode-update.md) + +| 类型 | 说明 | +| ------- | ------------------------------------- | +| 11500104 | IPC error. | + **示例：** ```ts @@ -795,6 +979,14 @@ clearError(versionDigestInfo: VersionDigestInfo, clearOptions: ClearOptions, cal | clearOptions | [ClearOptions](#clearoptions) | 是 | 清除选项。 | | callback | AsyncCallback\ | 是 | 回调函数。当清除异常成功时，err为undefined，否则为错误对象。 | +**错误码**： + +以下的错误码的详细介绍请参见[升级错误码](../errorcodes/errorcode-update.md) + +| 类型 | 说明 | +| ------- | ------------------------------------- | +| 11500104 | IPC error. | + **示例：** ```ts @@ -835,6 +1027,14 @@ clearError(versionDigestInfo: VersionDigestInfo, clearOptions: ClearOptions): Pr | -------------- | -------------------------- | | Promise\ | Promise对象。无返回结果的Promise对象。 | +**错误码**： + +以下的错误码的详细介绍请参见[升级错误码](../errorcodes/errorcode-update.md) + +| 类型 | 说明 | +| ------- | ------------------------------------- | +| 11500104 | IPC error. | + **示例：** ```ts @@ -870,6 +1070,14 @@ getUpgradePolicy(callback: AsyncCallback\): void | -------- | ---------------------------------------- | ---- | --------------- | | callback | AsyncCallback\<[UpgradePolicy](#upgradepolicy)> | 是 | 回调函数，返回升级策略信息对象。 | +**错误码**： + +以下的错误码的详细介绍请参见[升级错误码](../errorcodes/errorcode-update.md) + +| 类型 | 说明 | +| ------- | ------------------------------------- | +| 11500104 | IPC error. | + **示例：** ```ts @@ -895,6 +1103,14 @@ getUpgradePolicy(): Promise\ | ---------------------------------------- | --------------------- | | Promise\<[UpgradePolicy](#upgradepolicy)> | Promise对象，返回升级策略信息对象。 | +**错误码**： + +以下的错误码的详细介绍请参见[升级错误码](../errorcodes/errorcode-update.md) + +| 类型 | 说明 | +| ------- | ------------------------------------- | +| 11500104 | IPC error. | + **示例：** ```ts @@ -923,6 +1139,14 @@ setUpgradePolicy(policy: UpgradePolicy, callback: AsyncCallback\): void | policy | [UpgradePolicy](#upgradepolicy) | 是 | 升级策略。 | | callback | AsyncCallback\ | 是 | 回调函数，返回设置结果对象。 | +**错误码**： + +以下的错误码的详细介绍请参见[升级错误码](../errorcodes/errorcode-update.md) + +| 类型 | 说明 | +| ------- | ------------------------------------- | +| 11500104 | IPC error. | + **示例：** ```ts @@ -958,6 +1182,14 @@ setUpgradePolicy(policy: UpgradePolicy): Promise\ | -------------- | ------------------- | | Promise\ | Promise对象，返回设置结果对象。 | +**错误码**： + +以下的错误码的详细介绍请参见[升级错误码](../errorcodes/errorcode-update.md) + +| 类型 | 说明 | +| ------- | ------------------------------------- | +| 11500104 | IPC error. | + **示例：** ```ts @@ -989,6 +1221,14 @@ terminateUpgrade(callback: AsyncCallback\): void | -------- | -------------------- | ---- | -------------------------------------- | | callback | AsyncCallback\ | 是 | 回调函数。当清除升级缓存成功时，err为undefined，否则为错误对象。 | +**错误码**： + +以下的错误码的详细介绍请参见[升级错误码](../errorcodes/errorcode-update.md) + +| 类型 | 说明 | +| ------- | ------------------------------------- | +| 11500104 | IPC error. | + **示例：** ```ts @@ -1013,6 +1253,14 @@ terminateUpgrade(): Promise\ | -------------- | -------------------------- | | Promise\ | Promise对象。无返回结果的Promise对象。 | +**错误码**： + +以下的错误码的详细介绍请参见[升级错误码](../errorcodes/errorcode-update.md) + +| 类型 | 说明 | +| ------- | ------------------------------------- | +| 11500104 | IPC error. | + **示例：** ```ts @@ -1038,6 +1286,14 @@ on(eventClassifyInfo: EventClassifyInfo, taskCallback: UpgradeTaskCallback): voi | eventClassifyInfo | [EventClassifyInfo](#eventclassifyinfo) | 是 | 事件信息。 | | taskCallback | [UpgradeTaskCallback](#upgradetaskcallback) | 是 | 事件回调。 | +**错误码**： + +以下的错误码的详细介绍请参见[升级错误码](../errorcodes/errorcode-update.md) + +| 类型 | 说明 | +| ------- | ------------------------------------- | +| 11500104 | IPC error. | + **示例：** ```ts @@ -1065,6 +1321,14 @@ off(eventClassifyInfo: EventClassifyInfo, taskCallback?: UpgradeTaskCallback): v | eventClassifyInfo | [EventClassifyInfo](#eventclassifyinfo) | 是 | 事件信息。 | | taskCallback | [UpgradeTaskCallback](#upgradetaskcallback) | 否 | 事件回调。 | +**错误码**： + +以下的错误码的详细介绍请参见[升级错误码](../errorcodes/errorcode-update.md) + +| 类型 | 说明 | +| ------- | ------------------------------------- | +| 11500104 | IPC error. | + **示例：** ```ts @@ -1096,6 +1360,14 @@ factoryReset(callback: AsyncCallback\): void | -------- | -------------------- | ---- | -------------------------------------- | | callback | AsyncCallback\ | 是 | 回调函数。当恢复出厂执行成功时，err为undefined，否则为错误对象。 | +**错误码**： + +以下的错误码的详细介绍请参见[升级错误码](../errorcodes/errorcode-update.md) + +| 类型 | 说明 | +| ------- | ------------------------------------- | +| 11500104 | IPC error. | + **示例：** ```ts @@ -1120,6 +1392,14 @@ factoryReset(): Promise\ | -------------- | -------------------------- | | Promise\ | Promise对象。无返回结果的Promise对象。 | +**错误码**： + +以下的错误码的详细介绍请参见[升级错误码](../errorcodes/errorcode-update.md) + +| 类型 | 说明 | +| ------- | ------------------------------------- | +| 11500104 | IPC error. | + **示例:** ```ts @@ -1150,6 +1430,14 @@ verifyUpgradePackage(upgradeFile: UpgradeFile, certsFile: string, callback: Asyn | certsFile | string | 是 | 证书文件路径。 | | callback | AsyncCallback\ | 是 | 回调函数，返回升级包校验结果对象。 | +**错误码**： + +以下的错误码的详细介绍请参见[升级错误码](../errorcodes/errorcode-update.md) + +| 类型 | 说明 | +| ------- | ------------------------------------- | +| 11500104 | IPC error. | + **示例：** ```ts @@ -1186,6 +1474,14 @@ verifyUpgradePackage(upgradeFile: UpgradeFile, certsFile: string): Promise\ | Promise对象，返回升级包校验结果对象。 | +**错误码**： + +以下的错误码的详细介绍请参见[升级错误码](../errorcodes/errorcode-update.md) + +| 类型 | 说明 | +| ------- | ------------------------------------- | +| 11500104 | IPC error. | + **示例:** ```ts @@ -1216,6 +1512,14 @@ applyNewVersion(upgradeFiles: Array<[UpgradeFile](#upgradefile)>, callback: Asyn | upgradeFile | Array<[UpgradeFile](#upgradefile)> | 是 | 升级文件。 | | callback | AsyncCallback\ | 是 | 回调函数。当安装升级包执行成功时，err为undefined，否则为错误对象。 | +**错误码**： + +以下的错误码的详细介绍请参见[升级错误码](../errorcodes/errorcode-update.md) + +| 类型 | 说明 | +| ------- | ------------------------------------- | +| 11500104 | IPC error. | + **示例：** ```ts @@ -1245,6 +1549,14 @@ applyNewVersion(upgradeFiles: Array<[UpgradeFile](#upgradefile)>): Promise\ | Promise对象。无返回结果的Promise对象。 | +**错误码**： + +以下的错误码的详细介绍请参见[升级错误码](../errorcodes/errorcode-update.md) + +| 类型 | 说明 | +| ------- | ------------------------------------- | +| 11500104 | IPC error. | + **示例:** ```ts @@ -1273,6 +1585,14 @@ on(eventClassifyInfo: EventClassifyInfo, taskCallback: UpgradeTaskCallback): voi | eventClassifyInfo | [EventClassifyInfo](#eventclassifyinfo) | 是 | 事件信息。 | | taskCallback | [UpgradeTaskCallback](#upgradetaskcallback) | 是 | 事件回调。 | +**错误码**： + +以下的错误码的详细介绍请参见[升级错误码](../errorcodes/errorcode-update.md) + +| 类型 | 说明 | +| ------- | ------------------------------------- | +| 11500104 | IPC error. | + **示例：** ```ts @@ -1302,6 +1622,14 @@ off(eventClassifyInfo: EventClassifyInfo, taskCallback?: UpgradeTaskCallback): v | eventClassifyInfo | [EventClassifyInfo](#eventclassifyinfo) | 是 | 事件信息。 | | taskCallback | [UpgradeTaskCallback](#upgradetaskcallback) | 是 | 事件回调。 | +**错误码**： + +以下的错误码的详细介绍请参见[升级错误码](../errorcodes/errorcode-update.md) + +| 类型 | 说明 | +| ------- | ------------------------------------- | +| 11500104 | IPC error. | + **示例：** ```ts -- GitLab