1# @ohos.update (升级) 2 3升级范围：升级整个系统，包括内置的资源、预置应用；第三方的应用不在升级的范围。 4 5升级依赖：升级分为SD卡升级和在线升级两种。 6 7- SD卡升级依赖升级包和SD卡安装。 8- 在线升级依赖设备厂商部署的用于管理升级包的服务器。服务器由设备厂商部署，IP由调用者传入，请求的request接口是固定的，由设备厂商开发。 9 10> **说明：** 11> 12> 本模块首批接口从API version 9开始支持。后续版本的新增接口，采用上角标单独标记接口的起始版本。 13> 14> 本模块接口为系统接口。 15 16## 导入模块 17 18```js 19import update from '@ohos.update' 20``` 21 22## update.getOnlineUpdater 23 24getOnlineUpdater(upgradeInfo: UpgradeInfo): Updater 25 26获取在线升级对象。 27 28**系统能力**：SystemCapability.Update.UpdateService 29 30**参数：** 31 32| 参数名 | 类型 | 必填 | 说明 | 33| ----------- | --------------------------- | ---- | ------ | 34| upgradeInfo | [UpgradeInfo](#upgradeinfo) | 是 | 升级信息对象。 | 35 36**返回值：** 37 38| 类型 | 说明 | 39| ------------------- | ---- | 40| [Updater](#updater) | 升级对象。 | 41 42 43**示例：** 44 45```ts 46try { 47 const upgradeInfo: update.UpgradeInfo = { 48 upgradeApp: "com.ohos.ota.updateclient", 49 businessType: { 50 vendor: update.BusinessVendor.PUBLIC, 51 subType: update.BusinessSubType.FIRMWARE 52 } 53 }; 54 let updater = update.getOnlineUpdater(upgradeInfo); 55 } catch(error) { 56 console.error(`Fail to get updater error: ${error}`); 57 } 58``` 59 60## update.getRestorer 61 62getRestorer(): Restorer 63 64获取恢复出厂对象。 65 66**系统能力**：SystemCapability.Update.UpdateService 67 68**返回值：** 69 70| 类型 | 说明 | 71| --------------------- | ------ | 72| [Restorer](#restorer) | 恢复出厂对象。 | 73 74 75**示例：** 76 77```ts 78try { 79 let restorer = update.getRestorer(); 80} catch(error) { 81 console.error(`Fail to get restorer: ${error}`); 82} 83``` 84 85## update.getLocalUpdater 86 87getLocalUpdater(): LocalUpdater 88 89获取本地升级对象。 90 91**系统能力**：SystemCapability.Update.UpdateService 92 93**返回值：** 94 95| 类型 | 说明 | 96| ----------------------------- | ------ | 97| [LocalUpdater](#localupdater) | 本地升级对象。 | 98 99 100**示例：** 101 102```ts 103try { 104 let localUpdater = update.getLocalUpdater(); 105} catch(error) { 106 console.error(`Fail to get localUpdater error: ${error}`); 107}; 108``` 109 110## Updater 111 112### checkNewVersion 113 114checkNewVersion(callback: AsyncCallback\<CheckResult>): void 115 116检查新版本信息。使用callback异步回调。 117 118**系统能力**：SystemCapability.Update.UpdateService 119 120**需要权限**：ohos.permission.UPDATE_SYSTEM，该权限为系统权限 121 122**参数：** 123 124| 参数名 | 类型 | 必填 | 说明 | 125| -------- | ---------------------------------------- | ---- | -------------- | 126| callback | AsyncCallback\<[CheckResult](#checkresult)> | 是 | 回调函数，返回搜包结果对象。 | 127 128**错误码**： 129 130以下的错误码的详细介绍请参见[升级错误码](../errorcodes/errorcode-update.md) 131 132| 错误码ID | 错误信息 | 133| ------- | ---------------------------------------------------- | 134| 11500104 | IPC error. | 135 136**示例：** 137 138```ts 139import { BusinessError } from '@ohos.base'; 140 141updater.checkNewVersion((err: BusinessError, result: update.CheckResult) => { 142 console.log(`checkNewVersion isExistNewVersion ${result?.isExistNewVersion}`); 143 }); 144``` 145 146### checkNewVersion 147 148checkNewVersion(): Promise\<CheckResult> 149 150检查新版本信息。使用Promise异步回调。 151 152**系统能力**：SystemCapability.Update.UpdateService 153 154**需要权限**：ohos.permission.UPDATE_SYSTEM，该权限为系统权限 155 156**返回值:** 157 158| 类型 | 说明 | 159| ------------------------------------- | ------------------- | 160| Promise\<[CheckResult](#checkresult)> | Promise对象，返回搜包结果对象。 | 161 162**错误码**： 163 164以下的错误码的详细介绍请参见[升级错误码](../errorcodes/errorcode-update.md) 165 166| 错误码ID | 错误信息 | 167| ------- | ---------------------------------------------------- | 168| 11500104 | IPC error. | 169 170**示例:** 171 172```ts 173import { BusinessError } from '@ohos.base'; 174 175updater.checkNewVersion() 176 .then((result: update.CheckResult) => { 177 console.log(`checkNewVersion isExistNewVersion: ${result.isExistNewVersion}`); 178 // 版本摘要信息 179 console.log(`checkNewVersion versionDigestInfo: ${result.newVersionInfo.versionDigestInfo.versionDigest}`); 180 }) 181 .catch((err: BusinessError)=>{ 182 console.log(`checkNewVersion promise error ${JSON.stringify(err)}`); 183 }) 184``` 185 186### getNewVersionInfo 187 188getNewVersionInfo(callback: AsyncCallback\<NewVersionInfo>): void 189 190获取新版本信息。使用callback异步回调。 191 192**系统能力**：SystemCapability.Update.UpdateService 193 194**需要权限**：ohos.permission.UPDATE_SYSTEM，该权限为系统权限 195 196**参数：** 197 198| 参数名 | 类型 | 必填 | 说明 | 199| -------- | ---------------------------------------- | ---- | --------------- | 200| callback | AsyncCallback\<[NewVersionInfo](#newversioninfo)> | 是 | 回调函数，返回新版本信息对象。 | 201 202**错误码**： 203 204以下的错误码的详细介绍请参见[升级错误码](../errorcodes/errorcode-update.md) 205 206| 错误码ID | 错误信息 | 207| ------- | ---------------------------------------------------- | 208| 11500104 | IPC error. | 209 210**示例：** 211 212```ts 213import { BusinessError } from '@ohos.base'; 214 215updater.getNewVersionInfo((err: BusinessError, info: update.NewVersionInfo) => { 216 console.log(`info displayVersion = ${info?.versionComponents[0].displayVersion}`); 217 console.log(`info innerVersion = ${info?.versionComponents[0].innerVersion}`); 218}); 219``` 220 221### getNewVersionInfo 222 223getNewVersionInfo(): Promise\<NewVersionInfo> 224 225获取新版本信息。使用Promise异步回调。 226 227**系统能力**：SystemCapability.Update.UpdateService 228 229**需要权限**：ohos.permission.UPDATE_SYSTEM，该权限为系统权限 230 231**返回值：** 232 233| 类型 | 说明 | 234| ---------------------------------------- | -------------------- | 235| Promise\<[NewVersionInfo](#newversioninfo)> | Promise对象，返回新版本信息对象。 | 236 237**错误码**： 238 239以下的错误码的详细介绍请参见[升级错误码](../errorcodes/errorcode-update.md) 240 241| 错误码ID | 错误信息 | 242| ------- | ---------------------------------------------------- | 243| 11500104 | IPC error. | 244 245**示例：** 246 247```ts 248import { BusinessError } from '@ohos.base'; 249 250updater.getNewVersionInfo().then((info: update.NewVersionInfo) => { 251 console.log(`info displayVersion = ${info.versionComponents[0].displayVersion}`); 252 console.log(`info innerVersion = ${info.versionComponents[0].innerVersion}`); 253}).catch((err: BusinessError) => { 254 console.log(`getNewVersionInfo promise error ${JSON.stringify(err)}`); 255}); 256``` 257 258### getNewVersionDescription 259 260getNewVersionDescription(versionDigestInfo: VersionDigestInfo, descriptionOptions: DescriptionOptions, callback: AsyncCallback\<Array\<ComponentDescription>>): void 261 262获取新版本描述文件。使用callback异步回调。 263 264**系统能力**：SystemCapability.Update.UpdateService 265 266**需要权限**：ohos.permission.UPDATE_SYSTEM，该权限为系统权限 267 268**参数：** 269 270| 参数名 | 类型 | 必填 | 说明 | 271| ------------------ | ---------------------------------------- | ---- | -------------- | 272| versionDigestInfo | [VersionDigestInfo](#versiondigestinfo) | 是 | 版本摘要信息。 | 273| descriptionOptions | [DescriptionOptions](#descriptionoptions) | 是 | 描述文件选项。 | 274| callback | AsyncCallback\<Array\<[ComponentDescription](#componentdescription)>> | 是 | 回调函数，返回新版本描述文件。 | 275 276**错误码**： 277 278以下的错误码的详细介绍请参见[升级错误码](../errorcodes/errorcode-update.md) 279 280| 错误码ID | 错误信息 | 281| ------- | ---------------------------------------------------- | 282| 11500104 | IPC error. | 283 284**示例：** 285 286```ts 287import { BusinessError } from '@ohos.base'; 288 289// 版本摘要信息 290const versionDigestInfo: update.VersionDigestInfo = { 291 versionDigest: "versionDigest" // 检测结果中的版本摘要信息 292}; 293 294// 描述文件选项 295const descriptionOptions: update.DescriptionOptions = { 296 format: update.DescriptionFormat.STANDARD, // 标准格式 297 language: "zh-cn" // 中文 298}; 299 300updater.getNewVersionDescription(versionDigestInfo, descriptionOptions).then((info: Array<update.ComponentDescription>)=> { 301 console.log(`getNewVersionDescription promise info ${JSON.stringify(info)}`); 302}).catch((err: BusinessError) => { 303 console.log(`getNewVersionDescription promise error ${JSON.stringify(err)}`); 304}); 305``` 306 307### getNewVersionDescription 308 309getNewVersionDescription(versionDigestInfo: VersionDigestInfo, descriptionOptions: DescriptionOptions): Promise\<Array\<ComponentDescription>>; 310 311获取新版本描述文件。使用Promise异步回调。 312 313**系统能力**：SystemCapability.Update.UpdateService 314 315**需要权限**：ohos.permission.UPDATE_SYSTEM，该权限为系统权限 316 317**参数：** 318 319| 参数名 | 类型 | 必填 | 说明 | 320| ------------------ | ---------------------------------------- | ---- | ------ | 321| versionDigestInfo | [VersionDigestInfo](#versiondigestinfo) | 是 | 版本摘要信息。 | 322| descriptionOptions | [DescriptionOptions](#descriptionoptions) | 是 | 描述文件选项。 | 323 324**返回值：** 325 326| 类型 | 说明 | 327| ---------------------------------------- | ------------------- | 328| Promise\<Array\<[ComponentDescription](#componentdescription)>> | Promise对象，返回新版本描述文件。 | 329 330**错误码**： 331 332以下的错误码的详细介绍请参见[升级错误码](../errorcodes/errorcode-update.md) 333 334| 错误码ID | 错误信息 | 335| ------- | ---------------------------------------------------- | 336| 11500104 | IPC error. | 337 338**示例：** 339 340```ts 341import { BusinessError } from '@ohos.base'; 342 343// 版本摘要信息 344const versionDigestInfo: update.VersionDigestInfo = { 345 versionDigest: "versionDigest" // 检测结果中的版本摘要信息 346}; 347 348// 描述文件选项 349const descriptionOptions: update.DescriptionOptions = { 350 format: update.DescriptionFormat.STANDARD, // 标准格式 351 language: "zh-cn" // 中文 352}; 353 354updater.getNewVersionDescription(versionDigestInfo, descriptionOptions).then((info: Array<update.ComponentDescription>)=> { 355 console.log(`getNewVersionDescription promise info ${JSON.stringify(info)}`); 356}).catch((err: BusinessError) => { 357 console.log(`getNewVersionDescription promise error ${JSON.stringify(err)}`); 358}); 359``` 360 361### getCurrentVersionInfo 362 363getCurrentVersionInfo(callback: AsyncCallback\<CurrentVersionInfo>): void 364 365获取当前版本信息。使用callback异步回调。 366 367**系统能力**：SystemCapability.Update.UpdateService 368 369**需要权限**：ohos.permission.UPDATE_SYSTEM，该权限为系统权限 370 371**参数：** 372 373| 参数名 | 类型 | 必填 | 说明 | 374| -------- | ---------------------------------------- | ---- | ---------------- | 375| callback | AsyncCallback\<[CurrentVersionInfo](#currentversioninfo)> | 是 | 回调函数，返回当前版本信息对象。 | 376 377**错误码**： 378 379以下的错误码的详细介绍请参见[升级错误码](../errorcodes/errorcode-update.md) 380 381| 错误码ID | 错误信息 | 382| ------- | ---------------------------------------------------- | 383| 11500104 | IPC error. | 384 385**示例：** 386 387```ts 388import { BusinessError } from '@ohos.base'; 389 390updater.getCurrentVersionInfo((err: BusinessError, info: update.CurrentVersionInfo) => { 391 console.log(`info osVersion = ${info?.osVersion}`); 392 console.log(`info deviceName = ${info?.deviceName}`); 393 console.log(`info displayVersion = ${info?.versionComponents[0].displayVersion}`); 394}); 395``` 396 397### getCurrentVersionInfo 398 399getCurrentVersionInfo(): Promise\<CurrentVersionInfo> 400 401获取当前版本信息。使用Promise异步回调。 402 403**系统能力**：SystemCapability.Update.UpdateService 404 405**需要权限**：ohos.permission.UPDATE_SYSTEM，该权限为系统权限 406 407**返回值：** 408 409| 类型 | 说明 | 410| ---------------------------------------- | ------------------- | 411| Promise\<[CurrentVersionInfo](#currentversioninfo)> | Promise对象，返回当前版本对象。 | 412 413**错误码**： 414 415以下的错误码的详细介绍请参见[升级错误码](../errorcodes/errorcode-update.md) 416 417| 错误码ID | 错误信息 | 418| ------- | ---------------------------------------------------- | 419| 11500104 | IPC error. | 420 421**示例：** 422 423```ts 424import { BusinessError } from '@ohos.base'; 425 426updater.getCurrentVersionInfo().then((info: update.CurrentVersionInfo) => { 427 console.log(`info osVersion = ${info.osVersion}`); 428 console.log(`info deviceName = ${info.deviceName}`); 429 console.log(`info displayVersion = ${info.versionComponents[0].displayVersion}`); 430}).catch((err: BusinessError) => { 431 console.log(`getCurrentVersionInfo promise error ${JSON.stringify(err)}`); 432}); 433``` 434 435### getCurrentVersionDescription 436 437getCurrentVersionDescription(descriptionOptions: DescriptionOptions, callback: AsyncCallback\<Array\<ComponentDescription>>): void 438 439获取当前版本描述文件。使用callback异步回调。 440 441**系统能力**：SystemCapability.Update.UpdateService 442 443**需要权限**：ohos.permission.UPDATE_SYSTEM，该权限为系统权限 444 445**参数：** 446 447| 参数名 | 类型 | 必填 | 说明 | 448| ------------------ | ---------------------------------------- | ---- | --------------- | 449| descriptionOptions | [DescriptionOptions](#descriptionoptions) | 是 | 描述文件选项。 | 450| callback | AsyncCallback\<Array\<[ComponentDescription](#componentdescription)>> | 是 | 回调函数，返回当前版本描述文件。 | 451 452**错误码**： 453 454以下的错误码的详细介绍请参见[升级错误码](../errorcodes/errorcode-update.md) 455 456| 错误码ID | 错误信息 | 457| ------- | ---------------------------------------------------- | 458| 11500104 | IPC error. | 459 460**示例：** 461 462```ts 463// 描述文件选项 464const descriptionOptions: update.DescriptionOptions = { 465 format: update.DescriptionFormat.STANDARD, // 标准格式 466 language: "zh-cn" // 中文 467}; 468 469updater.getCurrentVersionDescription(descriptionOptions, (err, info) => { 470 console.log(`getCurrentVersionDescription info ${JSON.stringify(info)}`); 471 console.log(`getCurrentVersionDescription err ${JSON.stringify(err)}`); 472}); 473``` 474 475### getCurrentVersionDescription 476 477getCurrentVersionDescription(descriptionOptions: DescriptionOptions): Promise\<Array\<ComponentDescription>> 478 479获取当前版本描述文件。使用Promise异步回调。 480 481**系统能力**：SystemCapability.Update.UpdateService 482 483**需要权限**：ohos.permission.UPDATE_SYSTEM，该权限为系统权限 484 485**参数：** 486 487| 参数名 | 类型 | 必填 | 说明 | 488| ------------------ | ---------------------------------------- | ---- | ------ | 489| descriptionOptions | [DescriptionOptions](#descriptionoptions) | 是 | 描述文件选项。 | 490 491**返回值：** 492 493| 类型 | 说明 | 494| ---------------------------------------- | -------------------- | 495| Promise\<Array\<[ComponentDescription](#componentdescription)>> | Promise对象，返回当前版本描述文件。 | 496 497**错误码**： 498 499以下的错误码的详细介绍请参见[升级错误码](../errorcodes/errorcode-update.md) 500 501| 错误码ID | 错误信息 | 502| ------- | ---------------------------------------------------- | 503| 11500104 | IPC error. | 504 505**示例：** 506 507```ts 508import { BusinessError } from '@ohos.base'; 509 510// 描述文件选项 511const descriptionOptions: update.DescriptionOptions = { 512 format: update.DescriptionFormat.STANDARD, // 标准格式 513 language: "zh-cn" // 中文 514}; 515updater.getCurrentVersionDescription(descriptionOptions).then((info: Array<update.ComponentDescription>) => { 516 console.log(`getCurrentVersionDescription promise info ${JSON.stringify(info)}`); 517}).catch((err: BusinessError) => { 518 console.log(`getCurrentVersionDescription promise error ${JSON.stringify(err)}`); 519}); 520``` 521 522### getTaskInfo 523 524getTaskInfo(callback: AsyncCallback\<TaskInfo>): void 525 526获取升级任务信息。使用callback异步回调。 527 528**系统能力**：SystemCapability.Update.UpdateService 529 530**需要权限**：ohos.permission.UPDATE_SYSTEM，该权限为系统权限 531 532**参数：** 533 534| 参数名 | 类型 | 必填 | 说明 | 535| -------- | ------------------------------------- | ---- | ---------------- | 536| callback | AsyncCallback\<[TaskInfo](#taskinfo)> | 是 | 回调函数，返回升级任务信息对象。 | 537 538**错误码**： 539 540以下的错误码的详细介绍请参见[升级错误码](../errorcodes/errorcode-update.md) 541 542| 错误码ID | 错误信息 | 543| ------- | ---------------------------------------------------- | 544| 11500104 | IPC error. | 545 546**示例：** 547 548```ts 549import { BusinessError } from '@ohos.base'; 550 551updater.getTaskInfo((err: BusinessError, info: update.TaskInfo) => { 552 console.log(`getTaskInfo isexistTask= ${info?.existTask}`); 553}); 554``` 555 556### getTaskInfo 557 558getTaskInfo(): Promise\<TaskInfo> 559 560获取升级任务信息。使用Promise异步回调。 561 562**系统能力**：SystemCapability.Update.UpdateService 563 564**需要权限**：ohos.permission.UPDATE_SYSTEM，该权限为系统权限 565 566**返回值：** 567 568| 类型 | 说明 | 569| ------------------------------- | ------------------- | 570| Promise\<[TaskInfo](#taskinfo)> | Promise对象，返回任务信息对象。 | 571 572**错误码**： 573 574以下的错误码的详细介绍请参见[升级错误码](../errorcodes/errorcode-update.md) 575 576| 错误码ID | 错误信息 | 577| ------- | ---------------------------------------------------- | 578| 11500104 | IPC error. | 579 580**示例：** 581 582```ts 583import { BusinessError } from '@ohos.base'; 584 585updater.getTaskInfo().then((info: update.TaskInfo) => { 586 console.log(`getTaskInfo isexistTask= ${info.existTask}`); 587}).catch((err: BusinessError) => { 588 console.log(`getTaskInfo promise error ${JSON.stringify(err)}`); 589}); 590``` 591 592### download 593 594download(versionDigestInfo: VersionDigestInfo, downloadOptions: DownloadOptions, callback: AsyncCallback\<void>): void 595 596下载新版本。使用callback异步回调。 597 598**系统能力**：SystemCapability.Update.UpdateService 599 600**需要权限**：ohos.permission.UPDATE_SYSTEM，该权限为系统权限 601 602**参数：** 603 604| 参数名 | 类型 | 必填 | 说明 | 605| ----------------- | --------------------------------------- | ---- | ---------------------------------- | 606| versionDigestInfo | [VersionDigestInfo](#versiondigestinfo) | 是 | 版本摘要信息。 | 607| downloadOptions | [DownloadOptions](#downloadoptions) | 是 | 下载选项。 | 608| callback | AsyncCallback\<void> | 是 | 回调函数。当下载成功时，err为undefined，否则为错误对象。 | 609 610**错误码**： 611 612以下的错误码的详细介绍请参见[升级错误码](../errorcodes/errorcode-update.md) 613 614| 错误码ID | 错误信息 | 615| ------- | ---------------------------------------------------- | 616| 11500104 | IPC error. | 617 618**示例：** 619 620```ts 621import { BusinessError } from '@ohos.base'; 622 623// 版本摘要信息 624const versionDigestInfo: update.VersionDigestInfo = { 625 versionDigest: "versionDigest" // 检测结果中的版本摘要信息 626}; 627 628// 下载选项 629const downloadOptions: update.DownloadOptions = { 630 allowNetwork: update.NetType.CELLULAR, // 允许数据网络下载 631 order: update.Order.DOWNLOAD // 下载 632}; 633updater.download(versionDigestInfo, downloadOptions, (err: BusinessError) => { 634 console.log(`download error ${JSON.stringify(err)}`); 635}); 636``` 637 638### download 639 640download(versionDigestInfo: VersionDigestInfo, downloadOptions: DownloadOptions): Promise\<void> 641 642下载新版本。使用Promise异步回调。 643 644**系统能力**：SystemCapability.Update.UpdateService 645 646**需要权限**：ohos.permission.UPDATE_SYSTEM，该权限为系统权限 647 648**参数：** 649 650| 参数名 | 类型 | 必填 | 说明 | 651| ----------------- | --------------------------------------- | ---- | ------ | 652| versionDigestInfo | [VersionDigestInfo](#versiondigestinfo) | 是 | 版本摘要信息。 | 653| downloadOptions | [DownloadOptions](#downloadoptions) | 是 | 下载选项。 | 654 655**返回值：** 656 657| 类型 | 说明 | 658| -------------- | -------------------------- | 659| Promise\<void> | Promise对象。无返回结果的Promise对象。 | 660 661**错误码**： 662 663以下的错误码的详细介绍请参见[升级错误码](../errorcodes/errorcode-update.md) 664 665| 错误码ID | 错误信息 | 666| ------- | ---------------------------------------------------- | 667| 11500104 | IPC error. | 668 669**示例：** 670 671```ts 672import { BusinessError } from '@ohos.base'; 673 674// 版本摘要信息 675const versionDigestInfo: update.VersionDigestInfo = { 676 versionDigest: "versionDigest" // 检测结果中的版本摘要信息 677}; 678 679// 下载选项 680const downloadOptions: update.DownloadOptions = { 681 allowNetwork: update.NetType.CELLULAR, // 允许数据网络下载 682 order: update.Order.DOWNLOAD // 下载 683}; 684updater.download(versionDigestInfo, downloadOptions).then(() => { 685 console.log(`download start`); 686}).catch((err: BusinessError) => { 687 console.log(`download error ${JSON.stringify(err)}`); 688}); 689``` 690 691### resumeDownload 692 693resumeDownload(versionDigestInfo: VersionDigestInfo, resumeDownloadOptions: ResumeDownloadOptions, callback: AsyncCallback\<void>): void 694 695恢复下载新版本。使用callback异步回调。 696 697**系统能力**：SystemCapability.Update.UpdateService 698 699**需要权限**：ohos.permission.UPDATE_SYSTEM，该权限为系统权限 700 701**参数：** 702 703| 参数名 | 类型 | 必填 | 说明 | 704| --------------------- | ---------------------------------------- | ---- | ------------------------------------ | 705| versionDigestInfo | [VersionDigestInfo](#versiondigestinfo) | 是 | 版本摘要信息。 | 706| resumeDownloadOptions | [ResumeDownloadOptions](#resumedownloadoptions) | 是 | 恢复下载选项。 | 707| callback | AsyncCallback\<void> | 是 | 回调函数。当恢复下载成功时，err为undefined，否则为错误对象。 | 708 709**错误码**： 710 711以下的错误码的详细介绍请参见[升级错误码](../errorcodes/errorcode-update.md) 712 713| 错误码ID | 错误信息 | 714| ------- | ---------------------------------------------------- | 715| 11500104 | IPC error. | 716 717**示例：** 718 719```ts 720import { BusinessError } from '@ohos.base'; 721 722// 版本摘要信息 723const versionDigestInfo : update.VersionDigestInfo= { 724 versionDigest: "versionDigest" // 检测结果中的版本摘要信息 725}; 726 727// 恢复下载选项 728const resumeDownloadOptions : update.ResumeDownloadOptions= { 729 allowNetwork: update.NetType.CELLULAR, // 允许数据网络下载 730}; 731updater.resumeDownload(versionDigestInfo, resumeDownloadOptions, (err: BusinessError) => { 732 console.log(`resumeDownload error ${JSON.stringify(err)}`); 733}); 734``` 735 736### resumeDownload 737 738resumeDownload(versionDigestInfo: VersionDigestInfo, resumeDownloadOptions: ResumeDownloadOptions): Promise\<void> 739 740恢复下载新版本。使用Promise异步回调。 741 742**系统能力**：SystemCapability.Update.UpdateService 743 744**需要权限**：ohos.permission.UPDATE_SYSTEM，该权限为系统权限 745 746**参数：** 747 748| 参数名 | 类型 | 必填 | 说明 | 749| --------------------- | ---------------------------------------- | ---- | ------ | 750| versionDigestInfo | [VersionDigestInfo](#versiondigestinfo) | 是 | 版本摘要信息。 | 751| resumeDownloadOptions | [ResumeDownloadOptions](#resumedownloadoptions) | 是 | 恢复下载选项。 | 752 753**返回值：** 754 755| 类型 | 说明 | 756| -------------- | -------------------------- | 757| Promise\<void> | Promise对象。无返回结果的Promise对象。 | 758 759**错误码**： 760 761以下的错误码的详细介绍请参见[升级错误码](../errorcodes/errorcode-update.md) 762 763| 错误码ID | 错误信息 | 764| ------- | ---------------------------------------------------- | 765| 11500104 | IPC error. | 766 767**示例：** 768 769```ts 770import { BusinessError } from '@ohos.base'; 771 772// 版本摘要信息 773const versionDigestInfo: update.VersionDigestInfo = { 774 versionDigest: "versionDigest" // 检测结果中的版本摘要信息 775}; 776 777// 恢复下载选项 778const resumeDownloadOptions: update.ResumeDownloadOptions = { 779 allowNetwork: update.NetType.CELLULAR, // 允许数据网络下载 780}; 781updater.resumeDownload(versionDigestInfo, resumeDownloadOptions).then(() => { 782 console.log(`resumeDownload start`); 783}).catch((err: BusinessError) => { 784 console.log(`resumeDownload error ${JSON.stringify(err)}`); 785}); 786``` 787 788### pauseDownload 789 790pauseDownload(versionDigestInfo: VersionDigestInfo, pauseDownloadOptions: PauseDownloadOptions, callback: AsyncCallback\<void>): void 791 792暂停下载新版本。使用callback异步回调。 793 794**系统能力**：SystemCapability.Update.UpdateService 795 796**需要权限**：ohos.permission.UPDATE_SYSTEM，该权限为系统权限 797 798**参数：** 799 800| 参数名 | 类型 | 必填 | 说明 | 801| -------------------- | ---------------------------------------- | ---- | ------------------------------------ | 802| versionDigestInfo | [VersionDigestInfo](#versiondigestinfo) | 是 | 版本摘要信息。 | 803| pauseDownloadOptions | [PauseDownloadOptions](#pausedownloadoptions) | 是 | 暂停下载选项。 | 804| callback | AsyncCallback\<void> | 是 | 回调函数。当暂停下载成功时，err为undefined，否则为错误对象。 | 805 806**错误码**： 807 808以下的错误码的详细介绍请参见[升级错误码](../errorcodes/errorcode-update.md) 809 810| 错误码ID | 错误信息 | 811| ------- | ---------------------------------------------------- | 812| 11500104 | IPC error. | 813 814**示例：** 815 816```ts 817import { BusinessError } from '@ohos.base'; 818 819// 版本摘要信息 820const versionDigestInfo: update.VersionDigestInfo = { 821 versionDigest: "versionDigest" // 检测结果中的版本摘要信息 822}; 823 824// 暂停下载选项 825const pauseDownloadOptions: update.PauseDownloadOptions = { 826 isAllowAutoResume: true // 允许自动恢复下载 827}; 828updater.pauseDownload(versionDigestInfo, pauseDownloadOptions, (err: BusinessError) => { 829 console.log(`pauseDownload error ${JSON.stringify(err)}`); 830}); 831``` 832 833### pauseDownload 834 835pauseDownload(versionDigestInfo: VersionDigestInfo, pauseDownloadOptions: PauseDownloadOptions): Promise\<void> 836 837恢复下载新版本。使用Promise异步回调。 838 839**系统能力**：SystemCapability.Update.UpdateService 840 841**需要权限**：ohos.permission.UPDATE_SYSTEM，该权限为系统权限 842 843**参数：** 844 845| 参数名 | 类型 | 必填 | 说明 | 846| -------------------- | ---------------------------------------- | ---- | ------ | 847| versionDigestInfo | [VersionDigestInfo](#versiondigestinfo) | 是 | 版本摘要信息。 | 848| pauseDownloadOptions | [PauseDownloadOptions](#pausedownloadoptions) | 是 | 暂停下载选项。 | 849 850**返回值：** 851 852| 类型 | 说明 | 853| -------------- | -------------------------- | 854| Promise\<void> | Promise对象。无返回结果的Promise对象。 | 855 856**错误码**： 857 858以下的错误码的详细介绍请参见[升级错误码](../errorcodes/errorcode-update.md) 859 860| 错误码ID | 错误信息 | 861| ------- | ---------------------------------------------------- | 862| 11500104 | IPC error. | 863 864**示例：** 865 866```ts 867import { BusinessError } from '@ohos.base'; 868 869// 版本摘要信息 870const versionDigestInfo: update.VersionDigestInfo = { 871 versionDigest: "versionDigest" // 检测结果中的版本摘要信息 872}; 873 874// 暂停下载选项 875const pauseDownloadOptions: update.PauseDownloadOptions = { 876 isAllowAutoResume: true // 允许自动恢复下载 877}; 878updater.pauseDownload(versionDigestInfo, pauseDownloadOptions).then(() => { 879 console.log(`pauseDownload`); 880}).catch((err: BusinessError) => { 881 console.log(`pauseDownload error ${JSON.stringify(err)}`); 882}); 883``` 884 885### upgrade 886 887upgrade(versionDigestInfo: VersionDigestInfo, upgradeOptions: UpgradeOptions, callback: AsyncCallback\<void>): void 888 889升级新版本。使用callback异步回调。 890 891**系统能力**：SystemCapability.Update.UpdateService 892 893**需要权限**：ohos.permission.UPDATE_SYSTEM，该权限为系统权限 894 895**参数：** 896 897| 参数名 | 类型 | 必填 | 说明 | 898| ----------------- | --------------------------------------- | ---- | ------------------------------------ | 899| versionDigestInfo | [VersionDigestInfo](#versiondigestinfo) | 是 | 版本摘要信息。 | 900| upgradeOptions | [UpgradeOptions](#upgradeoptions) | 是 | 更新选项。 | 901| callback | AsyncCallback\<void> | 是 | 回调函数。当升级执行成功时，err为undefined，否则为错误对象。 | 902 903**错误码**： 904 905以下的错误码的详细介绍请参见[升级错误码](../errorcodes/errorcode-update.md) 906 907| 错误码ID | 错误信息 | 908| ------- | ---------------------------------------------------- | 909| 11500104 | IPC error. | 910 911**示例：** 912 913```ts 914import { BusinessError } from '@ohos.base'; 915 916// 版本摘要信息 917const versionDigestInfo: update.VersionDigestInfo = { 918 versionDigest: "versionDigest" // 检测结果中的版本摘要信息 919}; 920 921// 安装选项 922const upgradeOptions: update.UpgradeOptions = { 923 order: update.Order.INSTALL // 安装指令 924}; 925updater.upgrade(versionDigestInfo, upgradeOptions, (err: BusinessError) => { 926 console.log(`upgrade error ${JSON.stringify(err)}`); 927}); 928``` 929 930### upgrade 931 932upgrade(versionDigestInfo: VersionDigestInfo, upgradeOptions: UpgradeOptions): Promise\<void> 933 934升级新版本。使用Promise异步回调。 935 936**系统能力**：SystemCapability.Update.UpdateService 937 938**需要权限**：ohos.permission.UPDATE_SYSTEM，该权限为系统权限 939 940**参数：** 941 942| 参数名 | 类型 | 必填 | 说明 | 943| ----------------- | --------------------------------------- | ---- | ------ | 944| versionDigestInfo | [VersionDigestInfo](#versiondigestinfo) | 是 | 版本摘要信息。 | 945| upgradeOptions | [UpgradeOptions](#upgradeoptions) | 是 | 更新选项。 | 946 947**返回值：** 948 949| 类型 | 说明 | 950| -------------- | -------------------------- | 951| Promise\<void> | Promise对象。无返回结果的Promise对象。 | 952 953**错误码**： 954 955以下的错误码的详细介绍请参见[升级错误码](../errorcodes/errorcode-update.md) 956 957| 错误码ID | 错误信息 | 958| ------- | ---------------------------------------------------- | 959| 11500104 | IPC error. | 960 961**示例：** 962 963```ts 964import { BusinessError } from '@ohos.base'; 965 966// 版本摘要信息 967const versionDigestInfo: update.VersionDigestInfo = { 968 versionDigest: "versionDigest" // 检测结果中的版本摘要信息 969}; 970 971// 安装选项 972const upgradeOptions: update.UpgradeOptions = { 973 order: update.Order.INSTALL // 安装指令 974}; 975updater.upgrade(versionDigestInfo, upgradeOptions).then(() => { 976 console.log(`upgrade start`); 977}).catch((err: BusinessError) => { 978 console.log(`upgrade error ${JSON.stringify(err)}`); 979}); 980``` 981 982### clearError 983 984clearError(versionDigestInfo: VersionDigestInfo, clearOptions: ClearOptions, callback: AsyncCallback\<void>): void 985 986清除异常状态。使用callback异步回调。 987 988**系统能力**：SystemCapability.Update.UpdateService 989 990**需要权限**：ohos.permission.UPDATE_SYSTEM，该权限为系统权限 991 992**参数：** 993 994| 参数名 | 类型 | 必填 | 说明 | 995| ----------------- | --------------------------------------- | ---- | ------------------------------------ | 996| versionDigestInfo | [VersionDigestInfo](#versiondigestinfo) | 是 | 版本摘要信息。 | 997| clearOptions | [ClearOptions](#clearoptions) | 是 | 清除选项。 | 998| callback | AsyncCallback\<void> | 是 | 回调函数。当清除异常成功时，err为undefined，否则为错误对象。 | 999 1000**错误码**： 1001 1002以下的错误码的详细介绍请参见[升级错误码](../errorcodes/errorcode-update.md) 1003 1004| 错误码ID | 错误信息 | 1005| ------- | ---------------------------------------------------- | 1006| 11500104 | IPC error. | 1007 1008**示例：** 1009 1010```ts 1011import { BusinessError } from '@ohos.base'; 1012 1013// 版本摘要信息 1014const versionDigestInfo: update.VersionDigestInfo = { 1015 versionDigest: "versionDigest" // 检测结果中的版本摘要信息 1016}; 1017 1018// 清除选项 1019const clearOptions: update.ClearOptions = { 1020 status: update.UpgradeStatus.UPGRADE_FAIL, 1021}; 1022updater.clearError(versionDigestInfo, clearOptions, (err: BusinessError) => { 1023 console.log(`clearError error ${JSON.stringify(err)}`); 1024}); 1025``` 1026 1027### clearError 1028 1029clearError(versionDigestInfo: VersionDigestInfo, clearOptions: ClearOptions): Promise\<void> 1030 1031清除异常状态。使用Promise异步回调。 1032 1033**系统能力**：SystemCapability.Update.UpdateService 1034 1035**需要权限**：ohos.permission.UPDATE_SYSTEM，该权限为系统权限 1036 1037**参数：** 1038 1039| 参数名 | 类型 | 必填 | 说明 | 1040| ----------------- | --------------------------------------- | ---- | ------ | 1041| versionDigestInfo | [VersionDigestInfo](#versiondigestinfo) | 是 | 版本摘要信息。 | 1042| clearOptions | [ClearOptions](#clearoptions) | 是 | 更新选项。 | 1043 1044**返回值：** 1045 1046| 类型 | 说明 | 1047| -------------- | -------------------------- | 1048| Promise\<void> | Promise对象。无返回结果的Promise对象。 | 1049 1050**错误码**： 1051 1052以下的错误码的详细介绍请参见[升级错误码](../errorcodes/errorcode-update.md) 1053 1054| 错误码ID | 错误信息 | 1055| ------- | ---------------------------------------------------- | 1056| 11500104 | IPC error. | 1057 1058**示例：** 1059 1060```ts 1061import { BusinessError } from '@ohos.base'; 1062 1063// 版本摘要信息 1064const versionDigestInfo: update.VersionDigestInfo = { 1065 versionDigest: "versionDigest" // 检测结果中的版本摘要信息 1066}; 1067 1068// 清除选项 1069const clearOptions: update.ClearOptions = { 1070 status: update.UpgradeStatus.UPGRADE_FAIL, 1071}; 1072updater.clearError(versionDigestInfo, clearOptions).then(() => { 1073 console.log(`clearError success`); 1074}).catch((err: BusinessError) => { 1075 console.log(`clearError error ${JSON.stringify(err)}`); 1076}); 1077``` 1078 1079### getUpgradePolicy 1080 1081getUpgradePolicy(callback: AsyncCallback\<UpgradePolicy>): void 1082 1083获取升级策略信息。使用callback异步回调。 1084 1085**系统能力**：SystemCapability.Update.UpdateService 1086 1087**需要权限**：ohos.permission.UPDATE_SYSTEM，该权限为系统权限 1088 1089**参数：** 1090 1091| 参数名 | 类型 | 必填 | 说明 | 1092| -------- | ---------------------------------------- | ---- | --------------- | 1093| callback | AsyncCallback\<[UpgradePolicy](#upgradepolicy)> | 是 | 回调函数，返回升级策略信息对象。 | 1094 1095**错误码**： 1096 1097以下的错误码的详细介绍请参见[升级错误码](../errorcodes/errorcode-update.md) 1098 1099| 错误码ID | 错误信息 | 1100| ------- | ---------------------------------------------------- | 1101| 11500104 | IPC error. | 1102 1103**示例：** 1104 1105```ts 1106import { BusinessError } from '@ohos.base'; 1107 1108updater.getUpgradePolicy(err: BusinessError, policy: update.UpgradePolicy) => { 1109 console.log(`policy downloadStrategy = ${policy?.downloadStrategy}`); 1110 console.log(`policy autoUpgradeStrategy = ${policy?.autoUpgradeStrategy}`); 1111}); 1112``` 1113 1114### getUpgradePolicy 1115 1116getUpgradePolicy(): Promise\<UpgradePolicy> 1117 1118获取升级策略，通过promise方式作为异步方法。 1119 1120**系统能力**：SystemCapability.Update.UpdateService 1121 1122**需要权限**：ohos.permission.UPDATE_SYSTEM，该权限为系统权限 1123 1124**返回值：** 1125 1126| 类型 | 说明 | 1127| ---------------------------------------- | --------------------- | 1128| Promise\<[UpgradePolicy](#upgradepolicy)> | Promise对象，返回升级策略信息对象。 | 1129 1130**错误码**： 1131 1132以下的错误码的详细介绍请参见[升级错误码](../errorcodes/errorcode-update.md) 1133 1134| 错误码ID | 错误信息 | 1135| ------- | ---------------------------------------------------- | 1136| 11500104 | IPC error. | 1137 1138**示例：** 1139 1140```ts 1141import { BusinessError } from '@ohos.base'; 1142 1143updater.getUpgradePolicy().then((policy: update.UpgradePolicy) => { 1144 console.log(`policy downloadStrategy = ${policy.downloadStrategy}`); 1145 console.log(`policy autoUpgradeStrategy = ${policy.autoUpgradeStrategy}`); 1146}).catch((err: BusinessError) => { 1147 console.log(`getUpgradePolicy promise error ${JSON.stringify(err)}`); 1148}); 1149``` 1150 1151### setUpgradePolicy 1152 1153setUpgradePolicy(policy: UpgradePolicy, callback: AsyncCallback\<void>): void 1154 1155设置升级策略。使用callback异步回调。 1156 1157**系统能力**：SystemCapability.Update.UpdateService 1158 1159**需要权限**：ohos.permission.UPDATE_SYSTEM，该权限为系统权限 1160 1161**参数：** 1162 1163| 参数名 | 类型 | 必填 | 说明 | 1164| -------- | ------------------------------- | ---- | ------------- | 1165| policy | [UpgradePolicy](#upgradepolicy) | 是 | 升级策略。 | 1166| callback | AsyncCallback\<void> | 是 | 回调函数，返回设置结果对象。 | 1167 1168**错误码**： 1169 1170以下的错误码的详细介绍请参见[升级错误码](../errorcodes/errorcode-update.md) 1171 1172| 错误码ID | 错误信息 | 1173| ------- | ---------------------------------------------------- | 1174| 11500104 | IPC error. | 1175 1176**示例：** 1177 1178```ts 1179import { BusinessError } from '@ohos.base'; 1180 1181const policy: update.UpgradePolicy = { 1182 downloadStrategy: false, 1183 autoUpgradeStrategy: false, 1184 autoUpgradePeriods: [{ start: 120, end: 240 }] // 自动升级时间段，用分钟表示 1185}; 1186updater.setUpgradePolicy(policy, (err: BusinessError) => { 1187 console.log(`setUpgradePolicy result: ${err}`); 1188}); 1189``` 1190 1191### setUpgradePolicy 1192 1193setUpgradePolicy(policy: UpgradePolicy): Promise\<void> 1194 1195设置升级策略。使用Promise异步回调。 1196 1197**系统能力**：SystemCapability.Update.UpdateService 1198 1199**需要权限**：ohos.permission.UPDATE_SYSTEM，该权限为系统权限 1200 1201**参数：** 1202 1203| 参数名 | 类型 | 必填 | 说明 | 1204| ------ | ------------------------------- | ---- | ---- | 1205| policy | [UpgradePolicy](#upgradepolicy) | 是 | 升级策略。 | 1206 1207**返回值：** 1208 1209| 类型 | 说明 | 1210| -------------- | ------------------- | 1211| Promise\<void> | Promise对象，返回设置结果对象。 | 1212 1213**错误码**： 1214 1215以下的错误码的详细介绍请参见[升级错误码](../errorcodes/errorcode-update.md) 1216 1217| 错误码ID | 错误信息 | 1218| ------- | ---------------------------------------------------- | 1219| 11500104 | IPC error. | 1220 1221**示例：** 1222 1223```ts 1224import { BusinessError } from '@ohos.base'; 1225 1226const policy: update.UpgradePolicy = { 1227 downloadStrategy: false, 1228 autoUpgradeStrategy: false, 1229 autoUpgradePeriods: [ { start: 120, end: 240 } ] // 自动升级时间段，用分钟表示 1230}; 1231updater.setUpgradePolicy(policy).then(() => { 1232 console.log(`setUpgradePolicy success`); 1233}).catch((err: BusinessError) => { 1234 console.log(`setUpgradePolicy promise error ${JSON.stringify(err)}`); 1235}); 1236``` 1237 1238### terminateUpgrade 1239 1240terminateUpgrade(callback: AsyncCallback\<void>): void 1241 1242终止升级。使用callback异步回调。 1243 1244**系统能力**：SystemCapability.Update.UpdateService 1245 1246**需要权限**：ohos.permission.UPDATE_SYSTEM，该权限为系统权限 1247 1248**参数：** 1249 1250| 参数名 | 类型 | 必填 | 说明 | 1251| -------- | -------------------- | ---- | -------------------------------------- | 1252| callback | AsyncCallback\<void> | 是 | 回调函数。当清除升级缓存成功时，err为undefined，否则为错误对象。 | 1253 1254**错误码**： 1255 1256以下的错误码的详细介绍请参见[升级错误码](../errorcodes/errorcode-update.md) 1257 1258| 错误码ID | 错误信息 | 1259| ------- | ---------------------------------------------------- | 1260| 11500104 | IPC error. | 1261 1262**示例：** 1263 1264```ts 1265import { BusinessError } from '@ohos.base'; 1266 1267updater.terminateUpgrade((err: BusinessError) => { 1268 console.log(`terminateUpgrade error ${JSON.stringify(err)}`); 1269}); 1270``` 1271 1272### terminateUpgrade 1273 1274terminateUpgrade(): Promise\<void> 1275 1276终止升级。使用Promise异步回调。 1277 1278**系统能力**：SystemCapability.Update.UpdateService 1279 1280**需要权限**：ohos.permission.UPDATE_SYSTEM，该权限为系统权限 1281 1282**返回值：** 1283 1284| 类型 | 说明 | 1285| -------------- | -------------------------- | 1286| Promise\<void> | Promise对象。无返回结果的Promise对象。 | 1287 1288**错误码**： 1289 1290以下的错误码的详细介绍请参见[升级错误码](../errorcodes/errorcode-update.md) 1291 1292| 错误码ID | 错误信息 | 1293| ------- | ---------------------------------------------------- | 1294| 11500104 | IPC error. | 1295 1296**示例：** 1297 1298```ts 1299import { BusinessError } from '@ohos.base'; 1300 1301updater.terminateUpgrade().then(() => { 1302 console.log(`terminateUpgrade success`); 1303}).catch((err: BusinessError) => { 1304 console.log(`terminateUpgrade error ${JSON.stringify(err)}`); 1305}); 1306``` 1307 1308 1309### on 1310on(eventClassifyInfo: EventClassifyInfo, taskCallback: UpgradeTaskCallback): void 1311 1312注册事件监听。使用callback异步回调。 1313 1314**系统能力**：SystemCapability.Update.UpdateService 1315 1316**参数：** 1317 1318| 参数名 | 类型 | 必填 | 说明 | 1319| ----------------- | ---------------------------------------- | ---- | ---- | 1320| eventClassifyInfo | [EventClassifyInfo](#eventclassifyinfo) | 是 | 事件信息。 | 1321| taskCallback | [UpgradeTaskCallback](#upgradetaskcallback) | 是 | 事件回调。 | 1322 1323 1324**示例：** 1325 1326```ts 1327const eventClassifyInfo: update.EventClassifyInfo = { 1328 eventClassify: update.EventClassify.TASK, // 订阅升级更新事件 1329 extraInfo: "" 1330}; 1331 1332updater.on(eventClassifyInfo, (eventInfo: update.EventInfo) => { 1333 console.log("updater on " + JSON.stringify(eventInfo)); 1334}); 1335``` 1336 1337### off 1338off(eventClassifyInfo: EventClassifyInfo, taskCallback?: UpgradeTaskCallback): void 1339 1340取消注册事件监听。使用callback异步回调。 1341 1342**系统能力**：SystemCapability.Update.UpdateService 1343 1344**参数：** 1345 1346| 参数名 | 类型 | 必填 | 说明 | 1347| ----------------- | ---------------------------------------- | ---- | ---- | 1348| eventClassifyInfo | [EventClassifyInfo](#eventclassifyinfo) | 是 | 事件信息。 | 1349| taskCallback | [UpgradeTaskCallback](#upgradetaskcallback) | 否 | 事件回调。 | 1350 1351**示例：** 1352 1353```ts 1354const eventClassifyInfo: update.EventClassifyInfo = { 1355 eventClassify: update.EventClassify.TASK, // 订阅升级更新事件 1356 extraInfo: "" 1357}; 1358 1359updater.off(eventClassifyInfo, (eventInfo: update.EventInfo) => { 1360 console.log("updater off " + JSON.stringify(eventInfo)); 1361}); 1362``` 1363 1364## Restorer 1365 1366### factoryReset 1367 1368factoryReset(callback: AsyncCallback\<void>): void 1369 1370恢复出厂设置。使用callback异步回调。 1371 1372**系统能力**：SystemCapability.Update.UpdateService 1373 1374**需要权限**：ohos.permission.FACTORY_RESET，该权限为系统权限 1375 1376**参数：** 1377 1378| 参数名 | 类型 | 必填 | 说明 | 1379| -------- | -------------------- | ---- | -------------------------------------- | 1380| callback | AsyncCallback\<void> | 是 | 回调函数。当恢复出厂执行成功时，err为undefined，否则为错误对象。 | 1381 1382**错误码**： 1383 1384以下的错误码的详细介绍请参见[升级错误码](../errorcodes/errorcode-update.md) 1385 1386| 错误码ID | 错误信息 | 1387| ------- | ---------------------------------------------------- | 1388| 11500104 | IPC error. | 1389 1390**示例：** 1391 1392```ts 1393restorer.factoryReset((err) => { 1394 console.log(`factoryReset error ${JSON.stringify(err)}`); 1395}); 1396``` 1397 1398### factoryReset 1399 1400factoryReset(): Promise\<void> 1401 1402恢复出厂设置。使用Promise异步回调。 1403 1404**系统能力**：SystemCapability.Update.UpdateService 1405 1406**需要权限**：ohos.permission.FACTORY_RESET，该权限为系统权限 1407 1408**返回值:** 1409 1410| 类型 | 说明 | 1411| -------------- | -------------------------- | 1412| Promise\<void> | Promise对象。无返回结果的Promise对象。 | 1413 1414**错误码**： 1415 1416以下的错误码的详细介绍请参见[升级错误码](../errorcodes/errorcode-update.md) 1417 1418| 错误码ID | 错误信息 | 1419| ------- | ---------------------------------------------------- | 1420| 11500104 | IPC error. | 1421 1422**示例:** 1423 1424```ts 1425import { BusinessError } from '@ohos.base'; 1426 1427restorer.factoryReset().then(() => { 1428 console.log(`factoryReset success`); 1429}).catch((err: BusinessError) => { 1430 console.log(`factoryReset error ${JSON.stringify(err)}`); 1431}); 1432``` 1433 1434## LocalUpdater 1435 1436### verifyUpgradePackage 1437 1438verifyUpgradePackage(upgradeFile: UpgradeFile, certsFile: string, callback: AsyncCallback\<void>): void 1439 1440校验升级包。使用callback异步回调。 1441 1442**系统能力**：SystemCapability.Update.UpdateService 1443 1444**需要权限**：ohos.permission.UPDATE_SYSTEM，该权限为系统权限 1445 1446**参数：** 1447 1448| 参数名 | 类型 | 必填 | 说明 | 1449| ----------- | --------------------------- | ---- | ---------------- | 1450| upgradeFile | [UpgradeFile](#upgradefile) | 是 | 升级文件。 | 1451| certsFile | string | 是 | 证书文件路径。 | 1452| callback | AsyncCallback\<void> | 是 | 回调函数，返回升级包校验结果对象。 | 1453 1454**错误码**： 1455 1456以下的错误码的详细介绍请参见[升级错误码](../errorcodes/errorcode-update.md) 1457 1458| 错误码ID | 错误信息 | 1459| ------- | ---------------------------------------------------- | 1460| 11500104 | IPC error. | 1461 1462**示例：** 1463 1464```ts 1465const upgradeFile: update.UpgradeFile = { 1466 fileType: update.ComponentType.OTA, // OTA包 1467 filePath: "path" // 本地升级包路径 1468}; 1469 1470localUpdater.verifyUpgradePackage(upgradeFile, "cerstFilePath", (err) => { 1471 console.log(`factoryReset error ${JSON.stringify(err)}`); 1472}); 1473``` 1474 1475### verifyUpgradePackage 1476 1477verifyUpgradePackage(upgradeFile: UpgradeFile, certsFile: string): Promise\<void> 1478 1479校验升级包。使用Promise异步回调。 1480 1481**系统能力**：SystemCapability.Update.UpdateService 1482 1483**需要权限**：ohos.permission.UPDATE_SYSTEM，该权限为系统权限 1484 1485**参数：** 1486 1487| 参数名 | 类型 | 必填 | 说明 | 1488| ----------- | --------------------------- | ---- | ------ | 1489| upgradeFile | [UpgradeFile](#upgradefile) | 是 | 升级文件。 | 1490| certsFile | string | 是 | 证书文件路径。 | 1491 1492**返回值:** 1493 1494| 类型 | 说明 | 1495| -------------- | ---------------------- | 1496| Promise\<void> | Promise对象，返回升级包校验结果对象。 | 1497 1498**错误码**： 1499 1500以下的错误码的详细介绍请参见[升级错误码](../errorcodes/errorcode-update.md) 1501 1502| 错误码ID | 错误信息 | 1503| ------- | ---------------------------------------------------- | 1504| 11500104 | IPC error. | 1505 1506**示例:** 1507 1508```ts 1509import { BusinessError } from '@ohos.base'; 1510 1511const upgradeFile: update.UpgradeFile = { 1512 fileType: update.ComponentType.OTA, // OTA包 1513 filePath: "path" // 本地升级包路径 1514}; 1515localUpdater.verifyUpgradePackage(upgradeFile, "cerstFilePath").then(() => { 1516 console.log(`verifyUpgradePackage success`); 1517}).catch((err: BusinessError) => { 1518 console.log(`verifyUpgradePackage error ${JSON.stringify(err)}`); 1519}); 1520``` 1521 1522### applyNewVersion 1523applyNewVersion(upgradeFiles: Array<[UpgradeFile](#upgradefile)>, callback: AsyncCallback\<void>): void 1524 1525安装升级包。使用callback异步回调。 1526 1527**系统能力**：SystemCapability.Update.UpdateService 1528 1529**需要权限**：ohos.permission.UPDATE_SYSTEM，该权限为系统权限 1530 1531**参数：** 1532 1533| 参数名 | 类型 | 必填 | 说明 | 1534| ----------- | ---------------------------------- | ---- | --------------------------------------- | 1535| upgradeFile | Array<[UpgradeFile](#upgradefile)> | 是 | 升级文件。 | 1536| callback | AsyncCallback\<void> | 是 | 回调函数。当安装升级包执行成功时，err为undefined，否则为错误对象。 | 1537 1538**错误码**： 1539 1540以下的错误码的详细介绍请参见[升级错误码](../errorcodes/errorcode-update.md) 1541 1542| 错误码ID | 错误信息 | 1543| ------- | ---------------------------------------------------- | 1544| 11500104 | IPC error. | 1545 1546**示例：** 1547 1548```ts 1549const upgradeFiles: Array<update.UpgradeFile> = [{ 1550 fileType: update.ComponentType.OTA, // OTA包 1551 filePath: "path" // 本地升级包路径 1552}]; 1553 1554localUpdater.applyNewVersion(upgradeFiles, (err) => { 1555 console.log(`applyNewVersion error ${JSON.stringify(err)}`); 1556}); 1557``` 1558 1559### applyNewVersion 1560 1561applyNewVersion(upgradeFiles: Array<[UpgradeFile](#upgradefile)>): Promise\<void> 1562 1563安装升级包。使用Promise异步回调。 1564 1565**系统能力**：SystemCapability.Update.UpdateService 1566 1567**需要权限**：ohos.permission.UPDATE_SYSTEM，该权限为系统权限 1568 1569**返回值:** 1570 1571| 类型 | 说明 | 1572| -------------- | -------------------------- | 1573| Promise\<void> | Promise对象。无返回结果的Promise对象。 | 1574 1575**错误码**： 1576 1577以下的错误码的详细介绍请参见[升级错误码](../errorcodes/errorcode-update.md) 1578 1579| 错误码ID | 错误信息 | 1580| ------- | ---------------------------------------------------- | 1581| 11500104 | IPC error. | 1582 1583**示例:** 1584 1585```ts 1586import { BusinessError } from '@ohos.base'; 1587 1588const upgradeFiles: Array<update.UpgradeFile> = [{ 1589 fileType: update.ComponentType.OTA, // OTA包 1590 filePath: "path" // 本地升级包路径 1591}]; 1592localUpdater.applyNewVersion(upgradeFiles).then(() => { 1593 console.log(`applyNewVersion success`); 1594}).catch((err: BusinessError) => { 1595 console.log(`applyNewVersion error ${JSON.stringify(err)}`); 1596}); 1597``` 1598 1599### on 1600on(eventClassifyInfo: EventClassifyInfo, taskCallback: UpgradeTaskCallback): void 1601 1602注册事件监听。使用callback异步回调。 1603 1604**系统能力**：SystemCapability.Update.UpdateService 1605 1606**参数：** 1607 1608| 参数名 | 类型 | 必填 | 说明 | 1609| ----------------- | ---------------------------------------- | ---- | ---- | 1610| eventClassifyInfo | [EventClassifyInfo](#eventclassifyinfo) | 是 | 事件信息。 | 1611| taskCallback | [UpgradeTaskCallback](#upgradetaskcallback) | 是 | 事件回调。 | 1612 1613 1614**示例：** 1615 1616```ts 1617const eventClassifyInfo: update.EventClassifyInfo = { 1618 eventClassify: update.EventClassify.TASK, // 订阅升级更新事件 1619 extraInfo: "" 1620}; 1621 1622let onTaskUpdate: update.UpgradeTaskCallback = (eventInfo: update.EventInfo) => { 1623 console.log(`on eventInfo id `, eventInfo.eventId); 1624}; 1625 1626localUpdater.on(eventClassifyInfo, onTaskUpdate); 1627``` 1628 1629### off 1630off(eventClassifyInfo: EventClassifyInfo, taskCallback?: UpgradeTaskCallback): void 1631 1632取消注册事件监听。使用callback异步回调。 1633 1634**系统能力**：SystemCapability.Update.UpdateService 1635 1636**参数：** 1637 1638| 参数名 | 类型 | 必填 | 说明 | 1639| ----------------- | ---------------------------------------- | ---- | ---- | 1640| eventClassifyInfo | [EventClassifyInfo](#eventclassifyinfo) | 是 | 事件信息。 | 1641| taskCallback | [UpgradeTaskCallback](#upgradetaskcallback) | 否 | 事件回调。 | 1642 1643 1644**示例：** 1645 1646```ts 1647const eventClassifyInfo: update.EventClassifyInfo = { 1648 eventClassify: update.EventClassify.TASK, // 订阅升级更新事件 1649 extraInfo: "" 1650}; 1651 1652let onTaskUpdate: update.UpgradeTaskCallback = (eventInfo: update.EventInfo) => { 1653 console.log(`on eventInfo id `, eventInfo.eventId); 1654}; 1655 1656localUpdater.off(eventClassifyInfo, onTaskUpdate); 1657``` 1658 1659## UpgradeInfo 1660 1661升级信息。 1662 1663**系统能力**：SystemCapability.Update.UpdateService 1664 1665| 名称 | 类型 | 必填 | 说明 | 1666| ------------ | ----------------------------- | ---- | ------ | 1667| upgradeApp | string | 是 | 调用方包名。 | 1668| businessType | [BusinessType](#businesstype) | 是 | 升级业务类型。 | 1669 1670## BusinessType 1671 1672升级业务类型。 1673 1674**系统能力**：SystemCapability.Update.UpdateService 1675 1676| 名称 | 类型 | 必填 | 说明 | 1677| ------- | ----------------------------------- | ---- | ---- | 1678| vendor | [BusinessVendor](#businessvendor) | 是 | 供应商。 | 1679| subType | [BusinessSubType](#businesssubtype) | 是 | 类型。 | 1680 1681## CheckResult 1682 1683搜包结果。 1684 1685**系统能力**：SystemCapability.Update.UpdateService 1686 1687| 名称 | 类型 | 必填 | 说明 | 1688| ----------------- | --------------------------------- | ---- | ------ | 1689| isExistNewVersion | bool | 是 | 是否有新版本。 | 1690| newVersionInfo | [NewVersionInfo](#newversioninfo) | 否 | 新版本数据。 | 1691 1692## NewVersionInfo 1693 1694新版本数据。 1695 1696**系统能力**：SystemCapability.Update.UpdateService 1697 1698| 名称 | 类型 | 必填 | 说明 | 1699| ----------------- | ---------------------------------------- | ---- | ---- | 1700| versionDigestInfo | [VersionDigestInfo](#versiondigestinfo) | 是 | 版本摘要。 | 1701| versionComponents | Array\<[VersionComponent](#versioncomponent)> | 是 | 版本组件。 | 1702 1703## VersionDigestInfo 1704 1705版本摘要。 1706 1707**系统能力**：SystemCapability.Update.UpdateService 1708 1709| 名称 | 类型 | 必填 | 说明 | 1710| ------------- | ------ | ---- | ---- | 1711| versionDigest | string | 是 | 版本摘要。 | 1712 1713## VersionComponent 1714 1715版本组件。 1716 1717**系统能力**：SystemCapability.Update.UpdateService 1718 1719| 名称 | 类型 | 必填 | 说明 | 1720| --------------- | ----------------------------------- | ---- | -------- | 1721| componentId | string | 是 | 组件标识。 | 1722| componentType | [ComponentType](#componenttype) | 是 | 组件类型。 | 1723| upgradeAction | [UpgradeAction](#upgradeaction) | 是 | 升级方式。 | 1724| displayVersion | string | 是 | 显示版本号。 | 1725| innerVersion | string | 是 | 版本号。 | 1726| size | number | 是 | 升级包大小。 | 1727| effectiveMode | [EffectiveMode](#effectivemode) | 是 | 生效模式。 | 1728| descriptionInfo | [DescriptionInfo](#descriptioninfo) | 是 | 版本描述文件信息。 | 1729 1730## DescriptionOptions 1731 1732描述文件选项。 1733 1734**系统能力**：SystemCapability.Update.UpdateService 1735 1736| 名称 | 类型 | 必填 | 说明 | 1737| -------- | --------------------------------------- | ---- | ------ | 1738| format | [DescriptionFormat](#descriptionformat) | 是 | 描述文件格式。 | 1739| language | string | 是 | 描述文件语言。 | 1740 1741## ComponentDescription 1742 1743组件描述文件。 1744 1745**系统能力**：SystemCapability.Update.UpdateService 1746 1747| 名称 | 类型 | 必填 | 说明 | 1748| --------------- | ----------------------------------- | ---- | ------ | 1749| componentId | string | 是 | 组件标识。 | 1750| descriptionInfo | [DescriptionInfo](#descriptioninfo) | 是 | 描述文件信息。 | 1751 1752## DescriptionInfo 1753 1754版本描述文件信息。 1755 1756**系统能力**：SystemCapability.Update.UpdateService 1757 1758| 名称 | 类型 | 必填 | 说明 | 1759| --------------- | ----------------------------------- | ---- | ------ | 1760| descriptionType | [DescriptionType](#descriptiontype) | 是 | 描述文件类型。 | 1761| content | string | 是 | 描述文件内容。 | 1762 1763## CurrentVersionInfo 1764 1765当前版本信息。 1766 1767**系统能力**：SystemCapability.Update.UpdateService 1768 1769| 名称 | 类型 | 必填 | 说明 | 1770| ----------------- | ---------------------------------------- | ---- | ----- | 1771| osVersion | string | 是 | 系统版本号。 | 1772| deviceName | string | 是 | 设备名。 | 1773| versionComponents | Array\<[VersionComponent](#versioncomponent)> | 否 | 版本组件。 | 1774 1775## DownloadOptions 1776 1777下载选项。 1778 1779**系统能力**：SystemCapability.Update.UpdateService 1780 1781| 名称 | 类型 | 必填 | 说明 | 1782| ------------ | ------------------- | ---- | ---- | 1783| allowNetwork | [NetType](#nettype) | 是 | 网络类型。 | 1784| order | [Order](#order) | 是 | 升级指令。 | 1785 1786## ResumeDownloadOptions 1787 1788恢复下载选项。 1789 1790**系统能力**：SystemCapability.Update.UpdateService 1791 1792| 名称 | 类型 | 必填 | 说明 | 1793| ------------ | ------------------- | ---- | ---- | 1794| allowNetwork | [NetType](#nettype) | 是 | 网络类型。 | 1795 1796## PauseDownloadOptions 1797 1798暂停下载选项。 1799 1800**系统能力**：SystemCapability.Update.UpdateService 1801 1802| 名称 | 类型 | 必填 | 说明 | 1803| ----------------- | ---- | ---- | -------- | 1804| isAllowAutoResume | bool | 是 | 是否允许自动恢复。 | 1805 1806## UpgradeOptions 1807 1808升级选项。 1809 1810**系统能力**：SystemCapability.Update.UpdateService 1811 1812| 名称 | 类型 | 必填 | 说明 | 1813| ----- | --------------- | ---- | ---- | 1814| order | [Order](#order) | 是 | 升级指令。 | 1815 1816## ClearOptions 1817 1818清除异常选项。 1819 1820**系统能力**：SystemCapability.Update.UpdateService 1821 1822| 名称 | 类型 | 必填 | 说明 | 1823| ------ | ------------------------------- | ---- | ---- | 1824| status | [UpgradeStatus](#upgradestatus) | 是 | 异常状态。 | 1825 1826## UpgradePolicy 1827 1828升级策略。 1829 1830**系统能力**：SystemCapability.Update.UpdateService 1831 1832| 名称 | 类型 | 必填 | 说明 | 1833| ------------------- | --------------------------------------- | ---- | ------- | 1834| downloadStrategy | bool | 是 | 自动下载策略。 | 1835| autoUpgradeStrategy | bool | 是 | 自动升级策略。 | 1836| autoUpgradePeriods | Array\<[UpgradePeriod](#upgradeperiod)> | 是 | 自动升级时间段。 | 1837 1838## UpgradePeriod 1839 1840升级时间段。 1841 1842**系统能力**：SystemCapability.Update.UpdateService 1843 1844| 名称 | 类型 | 必填 | 说明 | 1845| ----- | ------ | ---- | ---- | 1846| start | number | 是 | 开始时间。 | 1847| end | number | 是 | 结束时间。 | 1848 1849## TaskInfo 1850 1851任务信息。 1852 1853**系统能力**：SystemCapability.Update.UpdateService 1854 1855| 名称 | 类型 | 必填 | 说明 | 1856| --------- | --------------------- | ---- | ------ | 1857| existTask | bool | 是 | 是否存在任务。 | 1858| taskBody | [TaskBody](#taskinfo) | 是 | 任务数据。 | 1859 1860## EventInfo 1861 1862事件信息。 1863 1864**系统能力**：SystemCapability.Update.UpdateService 1865 1866| 名称 | 类型 | 必填 | 说明 | 1867| -------- | --------------------- | ---- | ---- | 1868| eventId | [EventId](#eventid) | 是 | 事件ID。 | 1869| taskBody | [TaskBody](#taskinfo) | 是 | 任务数据。 | 1870 1871## TaskBody 1872 1873任务数据。 1874 1875**系统能力**：SystemCapability.Update.UpdateService 1876 1877| 名称 | 类型 | 必填 | 说明 | 1878| ----------------- | ---------------------------------------- | ---- | ---- | 1879| versionDigestInfo | [VersionDigestInfo](#versiondigestinfo) | 是 | 版本摘要。 | 1880| status | [UpgradeStatus](#upgradestatus) | 是 | 升级状态。 | 1881| subStatus | number | 否 | 子状态。 | 1882| progress | number | 是 | 进度。 | 1883| installMode | number | 是 | 安装模式。 | 1884| errorMessages | Array\<[ErrorMessage](#errormessage)> | 否 | 错误信息。 | 1885| versionComponents | Array\<[VersionComponent](#versioncomponent)> | 是 | 版本组件。 | 1886 1887## ErrorMessage 1888 1889错误信息。 1890 1891**系统能力**：SystemCapability.Update.UpdateService 1892 1893| 名称 | 类型 | 必填 | 说明 | 1894| ------------ | ------ | ---- | ---- | 1895| errorCode | number | 是 | 错误码。 | 1896| errorMessage | string | 是 | 错误描述。 | 1897 1898## EventClassifyInfo 1899 1900事件信息。 1901 1902**系统能力**：SystemCapability.Update.UpdateService 1903 1904| 名称 | 类型 | 必填 | 说明 | 1905| ------------- | ------------------------------- | ---- | ---- | 1906| eventClassify | [EventClassify](#eventclassify) | 是 | 事件类型。 | 1907| extraInfo | string | 是 | 额外信息。 | 1908 1909## UpgradeFile 1910 1911升级文件。 1912 1913**系统能力**：SystemCapability.Update.UpdateService 1914 1915| 名称 | 类型 | 必填 | 说明 | 1916| -------- | ------------------------------- | ---- | ---- | 1917| fileType | [ComponentType](#componenttype) | 是 | 文件类型。 | 1918| filePath | string | 是 | 文件路径。 | 1919 1920## UpgradeTaskCallback 1921 1922(eventInfo: EventInfo): void 1923 1924事件回调。 1925 1926**系统能力**：SystemCapability.Update.UpdateService 1927 1928| 名称 | 类型 | 必填 | 说明 | 1929| --------- | ----------------------- | ---- | ---- | 1930| eventInfo | [EventInfo](#eventinfo) | 是 | 事件信息。 | 1931 1932## BusinessVendor 1933 1934设备厂家。 1935 1936**系统能力**：SystemCapability.Update.UpdateService 1937 1938| 名称 | 值 | 说明 | 1939| ------ | -------- | ---- | 1940| PUBLIC | "public" | 开源。 | 1941 1942## BusinessSubType 1943 1944升级类型。 1945 1946**系统能力**：SystemCapability.Update.UpdateService 1947 1948| 名称 | 值 | 说明 | 1949| -------- | ---- | ---- | 1950| FIRMWARE | 1 | 固件。 | 1951 1952## ComponentType 1953 1954组件类型。 1955 1956**系统能力**：SystemCapability.Update.UpdateService 1957 1958| 名称 | 值 | 说明 | 1959| ---- | ---- | ---- | 1960| OTA | 1 | 固件。 | 1961 1962## UpgradeAction 1963 1964升级方式。 1965 1966**系统能力**：SystemCapability.Update.UpdateService 1967 1968| 名称 | 值 | 说明 | 1969| -------- | ---------- | ---- | 1970| UPGRADE | "upgrade" | 差分包。 | 1971| RECOVERY | "recovery" | 修复包。 | 1972 1973## EffectiveMode 1974 1975生效模式。 1976 1977**系统能力**：SystemCapability.Update.UpdateService 1978 1979| 名称 | 值 | 说明 | 1980| ------------- | ---- | ---- | 1981| COLD | 1 | 冷升级。 | 1982| LIVE | 2 | 热升级。 | 1983| LIVE_AND_COLD | 3 | 融合升级。 | 1984 1985## DescriptionType 1986 1987描述文件类型。 1988 1989**系统能力**：SystemCapability.Update.UpdateService 1990 1991| 名称 | 值 | 说明 | 1992| ------- | ---- | ---- | 1993| CONTENT | 0 | 内容。 | 1994| URI | 1 | 链接。 | 1995 1996## DescriptionFormat 1997 1998描述文件格式。 1999 2000**系统能力**：SystemCapability.Update.UpdateService 2001 2002| 名称 | 值 | 说明 | 2003| ---------- | ---- | ---- | 2004| STANDARD | 0 | 标准格式。 | 2005| SIMPLIFIED | 1 | 简易格式。 | 2006 2007## NetType 2008 2009网络类型。 2010 2011**系统能力**：SystemCapability.Update.UpdateService 2012 2013| 名称 | 值 | 说明 | 2014| ----------------- | ---- | --------- | 2015| CELLULAR | 1 | 数据网络。 | 2016| METERED_WIFI | 2 | 热点WIFI。 | 2017| NOT_METERED_WIFI | 4 | 非热点WIFI。 | 2018| WIFI | 6 | WIFI。 | 2019| CELLULAR_AND_WIFI | 7 | 数据网络和WIFI。 | 2020 2021## Order 2022 2023升级指令。 2024 2025**系统能力**：SystemCapability.Update.UpdateService 2026 2027| 名称 | 值 | 说明 | 2028| -------------------- | ---- | ----- | 2029| DOWNLOAD | 1 | 下载。 | 2030| INSTALL | 2 | 安装。 | 2031| DOWNLOAD_AND_INSTALL | 3 | 下载并安装。 | 2032| APPLY | 4 | 生效。 | 2033| INSTALL_AND_APPLY | 6 | 安装并生效。 | 2034 2035## UpgradeStatus 2036 2037升级状态。 2038 2039**系统能力**：SystemCapability.Update.UpdateService 2040 2041| 名称 | 值 | 说明 | 2042| ---------------- | ---- | ---- | 2043| WAITING_DOWNLOAD | 20 | 待下载。 | 2044| DOWNLOADING | 21 | 下载中。 | 2045| DOWNLOAD_PAUSED | 22 | 下载暂停。 | 2046| DOWNLOAD_FAIL | 23 | 下载失败。 | 2047| WAITING_INSTALL | 30 | 待安装。 | 2048| UPDATING | 31 | 更新中。 | 2049| WAITING_APPLY | 40 | 待生效。 | 2050| APPLYING | 41 | 生效中。 | 2051| UPGRADE_SUCCESS | 50 | 升级成功。 | 2052| UPGRADE_FAIL | 51 | 升级失败。 | 2053 2054## EventClassify 2055 2056事件类型。 2057 2058**系统能力**：SystemCapability.Update.UpdateService 2059 2060| 名称 | 值 | 说明 | 2061| ---- | ---------- | ---- | 2062| TASK | 0x01000000 | 任务事件。 | 2063 2064## EventId 2065 2066事件ID。 2067 2068**系统能力**：SystemCapability.Update.UpdateService 2069 2070| 名称 | 值 | 说明 | 2071| ---------------------- | ---------- | ------ | 2072| EVENT_TASK_BASE | EventClassify.TASK | 任务事件。 | 2073| EVENT_TASK_RECEIVE | 0x01000001 | 收到任务。 | 2074| EVENT_TASK_CANCEL | 0x01000002 | 取消任务。 | 2075| EVENT_DOWNLOAD_WAIT | 0x01000003 | 待下载。 | 2076| EVENT_DOWNLOAD_START | 0x01000004 | 开始下载。 | 2077| EVENT_DOWNLOAD_UPDATE | 0x01000005 | 下载进度更新。 | 2078| EVENT_DOWNLOAD_PAUSE | 0x01000006 | 下载暂停。 | 2079| EVENT_DOWNLOAD_RESUME | 0x01000007 | 恢复下载。 | 2080| EVENT_DOWNLOAD_SUCCESS | 0x01000008 | 下载成功。 | 2081| EVENT_DOWNLOAD_FAIL | 0x01000009 | 下载失败。 | 2082| EVENT_UPGRADE_WAIT | 0x0100000A | 待升级。 | 2083| EVENT_UPGRADE_START | 0x0100000B | 开始升级。 | 2084| EVENT_UPGRADE_UPDATE | 0x0100000C | 升级中。 | 2085| EVENT_APPLY_WAIT | 0x0100000D | 待生效。 | 2086| EVENT_APPLY_START | 0x0100000E | 开始生效。 | 2087| EVENT_UPGRADE_SUCCESS | 0x0100000F | 更新成功。 | 2088| EVENT_UPGRADE_FAIL | 0x01000010 | 更新失败。 | 2089