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