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