目录

Updating a Notification

Starting from API version 18, applications can update only published notifications, such as the upload/download progress and IMs.

Available APIs

The following table describes the APIs for publishing and updating notifications. Notification update can be specified by carrying the updateOnly field in the NotificationRequest parameter. If this field is not specified, it defaults to false.

API Description
publish(request: NotificationRequest, callback: AsyncCallback<void>): void Publishes an updated notification.

How to Develop

The following uses the progress bar notification as an example.

  1. Import modules.

    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. Publish the progress bar 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: 50 }
  }
};

// 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.');
});

  3. Update the progress bar notification using the updateOnly field in the NotificationRequest API.

    let notificationRequest: notificationManager.NotificationRequest = {
  id: 5,
  updateOnly: true,
  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: 99 }
  }
};

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