Publishing a Text Notification

You can publish text notifications to send SMS messages, alert messages, and more. There are two types of text notifications: normal text and multi-line text.

Table 1 Basic notification content types

Type	Description
NOTIFICATION_CONTENT_BASIC_TEXT	Normal text notification.
NOTIFICATION_CONTENT_MULTILINE	Multi-line text notification.

Available APIs

The following table describes the APIs for notification publishing. You specify the notification information – content, ID, slot type, and publish time – by setting the NotificationRequest parameter in the APIs.

Name	Description
publish(request: NotificationRequest, callback: AsyncCallback<void>): void	Publishes a notification.
cancel(id: number, label: string, callback: AsyncCallback<void>): void	Cancels a notification.
cancelAll(callback: AsyncCallback<void>): void	Cancels all notifications published by the application.

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. Create a NotificationRequest object and publish a progress notification.

   • A normal text notification consists of the title, text, and additionalText parameters, of which title and text are mandatory. The value of these parameters contains less than 200 bytes. Excess content will be truncated.

     let notificationRequest: notificationManager.NotificationRequest = {
       id: 1,
       content: {
         notificationContentType: notificationManager.ContentType.NOTIFICATION_CONTENT_BASIC_TEXT, // Basic notification
         normal: {
           title: 'test_title',
           text: 'test_text',
           additionalText: 'test_additionalText',
         }
       }
     };
     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.');
     });
     

   • In addition to the parameters in the normal text notification, the multi-line text notification provides the lines, briefText, and longTitle parameters. The value of these parameters contains less than 200 bytes. Excess content will be truncated. By default, a multi-line notification looks in the same way as a normal text notification. When expanded, the notification displays the title and content specified in longTitle and lines, respectively.

     let notificationRequest: notificationManager.NotificationRequest = {
       id: 3,
       content: {
         notificationContentType: notificationManager.ContentType.NOTIFICATION_CONTENT_MULTILINE, // Multi-line text notification
         multiLine: {
           title: 'test_title',
           text: 'test_text',
           briefText: 'test_briefText',
           longTitle: 'test_longTitle',
           lines: ['line_01', 'line_02', 'line_03', 'line_04'],
         }
       }
     };
     // 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. Delete the notification.

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