• Home
  • Line#
  • Scopes#
  • Navigate#
  • Raw
  • Download
1# 发布进度条类型通知
2<!--Kit: Notification Kit-->
3<!--Subsystem: Notification-->
4<!--Owner: @michael_woo888-->
5<!--Designer: @dongqingran; @wulong158-->
6<!--Tester: @wanghong1997-->
7<!--Adviser: @huipeizi-->
8
9进度条通知也是常见的通知类型，主要应用于文件下载、事务处理进度显示。当前系统提供了进度条模板，发布通知应用设置好进度条模板的属性值，如模板名、模板数据，通过通知子系统发送到通知栏显示。
10
11目前系统模板仅支持进度条模板，通知模板[NotificationTemplate](../reference/apis-notification-kit/js-apis-inner-notification-notificationTemplate.md)中的data参数为用户自定义数据，用于显示与模块相关的数据。
12
13## 接口说明
14
15[`isSupportTemplate()`](../reference/apis-notification-kit/js-apis-notificationManager.md#notificationmanagerissupporttemplate)是查询模板是否支持接口，目前仅支持进度条模板。
16
17| **接口名** | **描述** |
18| -------- | -------- |
19| isSupportTemplate(templateName: string): Promise\<boolean\> | 查询模板是否存在。 |
20
21
22## 开发步骤
23
241. 导入模块。
25
26   ```ts
27   import { notificationManager } from '@kit.NotificationKit';
28   import { BusinessError } from '@kit.BasicServicesKit';
29   import { hilog } from '@kit.PerformanceAnalysisKit';
30
31   const TAG: string = '[PublishOperation]';
32   const DOMAIN_NUMBER: number = 0xFF00;
33   ```
34
352. 查询系统是否支持进度条模板，查询结果为支持downloadTemplate模板类通知。
36
37   ```ts
38   notificationManager.isSupportTemplate('downloadTemplate').then((data:boolean) => {
39     let isSupportTpl: boolean = data; // isSupportTpl的值为true表示支持downloadTemplate模板类通知，false表示不支持
40     hilog.info(DOMAIN_NUMBER, TAG, `Succeeded in supporting download template notification. data is ${isSupportTpl}`);
41   }).catch((err: BusinessError) => {
42     hilog.error(DOMAIN_NUMBER, TAG, `Failed to support download template notification. Code is ${err.code}, message is ${err.message}`);
43   });
44   ```
45
46   > **说明：**
47   > 查询系统支持进度条模板后，再进行后续的步骤操作。
48
493. 构造进度条模板对象，并发布通知。
50
51   ```ts
52   let notificationRequest: notificationManager.NotificationRequest = {
53     id: 5,
54     content: {
55       notificationContentType: notificationManager.ContentType.NOTIFICATION_CONTENT_BASIC_TEXT,
56       normal: {
57         title: 'test_title',
58         text: 'test_text',
59         additionalText: 'test_additionalText'
60       }
61     },
62     // 构造进度条模板，name字段当前需要固定配置为downloadTemplate
63     template: {
64       name: 'downloadTemplate',
65       data: { title: 'File Title', fileName: 'music.mp4', progressValue: 45 }
66     }
67   }
68
69   // 发布通知
70   notificationManager.publish(notificationRequest, (err: BusinessError) => {
71     if (err) {
72       hilog.error(DOMAIN_NUMBER, TAG, `Failed to publish notification. Code is ${err.code}, message is ${err.message}`);
73       return;
74     }
75     hilog.info(DOMAIN_NUMBER, TAG, 'Succeeded in publishing notification.');
76   });
77   ```
78