目录

Publishing a Progress Notification

The progress notification is a commonly used notification type, mainly used to display the progress of an ongoing operation, such as file downloading. When publishing a progress notification through the notification subsystem, you can use the readily available template by specifying the related attributes, such as the template name and template data.

Currently, the system template supports only the progress bar template. The data parameter in the notification template NotificationTemplate is user-defined data used to display template-related data.

Available APIs

isSupportTemplate() checks whether a specific notification template is supported. Currently, only the progress bar template is supported.

Name Description
isSupportTemplate(templateName: string): Promise<boolean> Checks whether the corresponding notification template is supported.

How to Develop

  1. Import the module.

    import { notificationManager } from '@kit.NotificationKit';
import { BusinessError } from '@kit.BasicServicesKit';
import { hilog } from '@kit.PerformanceAnalysisKit';

const TAG: string = '[PublishOperation]';
const DOMAIN_NUMBER: number = 0xFF00;

  2. Check whether a specific template is supported. In this example, the template of the downloadTemplate type is checked.

    notificationManager.isSupportTemplate('downloadTemplate').then((data: boolean) => {
  let isSupportTemplate: boolean = data; // The value true means that the template of the downloadTemplate type is supported, and false means the opposite.
  hilog.info(DOMAIN_NUMBER, TAG,
    `Succeeded in supporting download template notification. data is ${isSupportTemplate}`);
}).catch((err: BusinessError) => {
  hilog.error(DOMAIN_NUMBER, TAG,
    `Failed to support download template notification. Code is ${err.code}, message is ${err.message}`);
});

    Proceed with the step below only when the specified template is supported.

  3. Create a NotificationRequest object and publish a progress notification.

    let notificationRequest: notificationManager.NotificationRequest = {
  id: 5,
  content: {
    notificationContentType: notificationManager.ContentType.NOTIFICATION_CONTENT_BASIC_TEXT,
    normal: {
      title: 'test_title',
      text: 'test_text',
      additionalText: 'test_additionalText'
    }
  },
  // Create a progress template. The name field has a fixed value of downloadTemplate.
  template: {
    name: 'downloadTemplate',
    data: { title: 'File Title', fileName: 'music.mp4', progressValue: 45 }
  }
};

// Publish the notification.
notificationManager.publish(notificationRequest, (err: BusinessError) => {
  if (err) {
    hilog.error(DOMAIN_NUMBER, TAG,
      `Failed to publish notification. Code is ${err.code}, message is ${err.message}`);
    return;
  }
  hilog.info(DOMAIN_NUMBER, TAG, 'Succeeded in publishing notification.');
});