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