鸿蒙NEXT开发-用户通知服务

用户通知服务

基本介绍

Notification Kit（用户通知服务）为开发者提供本地通知发布通道，开发者可借助Notification Kit将应用产生的通知直接在客户端本地推送给用户，本地通知根据通知类型及发布场景会产生对应的铃声、震动、横幅、锁屏、息屏、通知栏提醒和显示。

能力范围

Notification Kit支持的能力主要包括:

• 发布文本、进度条等类型通知。

• 携带或更新应用通知数字角标。

• 取消曾经发布的某条或全部通知。

• 查询已发布的通知列表。

• 查询应用自身通知开关状态。

• 应用通知用户的能力默认关闭，开发者可拉起授权框，请求用户授权发布通知。

业务流程

使用Notification Kit的主要业务流程如下：

1.请求通知授权。

2.应用发布通知到通知服务。

3.将通知展示到通知中心。

Notification Kit中常用的通知样式如下：

注意：

• 单个应用已发布的通知在通知中心等系统入口的留存数量有限（当前规格最多24条）。

• 通知的长度不能超过200KB（跨进程序列化大小限制）。

• 系统所有应用发布新通知的频次累计不能超过每秒10条，更新通知的频次累计不能超过每秒20条。

官方文档地址：developer.huawei.com/consumer/cn…

用户通知服务-基础通知

基本介绍

文本类型通知主要应用于发送短信息、提示信息等，支持普通文本类型和多行文本类型。

接口方法

接口名	描述
publish(request: NotificationRequest, callback: AsyncCallback): void	发布通知。
cancel(id: number, label: string, callback: AsyncCallback): void	取消指定的通知。
cancelAll(callback: AsyncCallback): void	取消所有该应用发布的通知。

代码示例

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

// 日志标识
const TAG: string = '[publishTest]';
const DOMAIN_NUMBER: number = 0xFF00;
let context = getContext(this) as common.UIAbilityContext;

@Entry
@Component
struct Index {
  /**
   * 请求通知授权
   */
  aboutToAppear(): void {
    notificationManager.isNotificationEnabled().then((data: boolean) => {
      hilog.info(DOMAIN_NUMBER, TAG, "isNotificationEnabled success, data: " + JSON.stringify(data));
      if (!data) {
        notificationManager.requestEnableNotification(context).then(() => {
          hilog.info(DOMAIN_NUMBER, TAG, `[ANS] requestEnableNotification success`);
        }).catch((err: BusinessError) => {
          if (1600004 == err.code) {
            hilog.error(DOMAIN_NUMBER, TAG,
              `[ANS] requestEnableNotification refused, code is ${err.code}, message is ${err.message}`);
          } else {
            hilog.error(DOMAIN_NUMBER, TAG,
              `[ANS] requestEnableNotification failed, code is ${err.code}, message is ${err.message}`);
          }
        });
      }
    }).catch((err: BusinessError) => {
      hilog.error(DOMAIN_NUMBER, TAG, `isNotificationEnabled fail, code is ${err.code}, message is ${err.message}`);
    });
  }

  /**
   * 通知方法
   */
  publish() {
    let notificationRequest: notificationManager.NotificationRequest = {
      // 通知的唯一id
      id: 1,
      content: {
        notificationContentType: notificationManager.ContentType.NOTIFICATION_CONTENT_BASIC_TEXT, // 普通文本类型通知
        normal: {
          // 通知的标题
          title: '百得知识库',
          // 通知的内容
          text: '百得知识库提醒你该学习了',
          // 附加消息
          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.');
    });
  }

  /**
   * 取消指定的通知
   */
  cancelPublish() {
    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.');
    });
  }

  build() {
    Column({ space: 20 }) {

      Button('发布文本类型通知')
        .onClick(() => {
          this.publish()
        })

      Button('取消通知')
        .onClick(() => {
          this.cancelPublish()
        })

    }
    .height('100%')
    .width('100%')
    .justifyContent(FlexAlign.Center)
  }
}

用户通知服务-进度条通知

基本介绍

进度条通知也是常见的通知类型，主要应用于文件下载、事务处理进度显示。当前系统提供了进度条模板，发布通知应用设置好进度条模板的属性值，如模板名、模板数据，通过通知子系统发送到通知栏显示。

接口方法

接口名	描述
isSupportTemplate(templateName: string): Promise	查询模板是否存在。

代码示例

import { notificationManager } from '@kit.NotificationKit';
import { BusinessError } from '@kit.BasicServicesKit';
import { hilog } from '@kit.PerformanceAnalysisKit';
import { promptAction } from '@kit.ArkUI';
import { common } from '@kit.AbilityKit';

const TAG: string = '[publishTest]';
const DOMAIN_NUMBER: number = 0xFF00;
let context = getContext(this) as common.UIAbilityContext;

@Entry
  @Component
  struct Page {
    /**
   * 请求通知授权
   */
    aboutToAppear(): void {
      notificationManager.isNotificationEnabled().then((data: boolean) => {
        hilog.info(DOMAIN_NUMBER, TAG, "isNotificationEnabled success, data: " + JSON.stringify(data));
        if (!data) {
          notificationManager.requestEnableNotification(context).then(() => {
            hilog.info(DOMAIN_NUMBER, TAG, `[ANS] requestEnableNotification success`);
          }).catch((err: BusinessError) => {
            if (1600004 == err.code) {
              hilog.error(DOMAIN_NUMBER, TAG,
                          `[ANS] requestEnableNotification refused, code is ${err.code}, message is ${err.message}`);
            } else {
              hilog.error(DOMAIN_NUMBER, TAG,
                          `[ANS] requestEnableNotification failed, code is ${err.code}, message is ${err.message}`);
            }
          });
        }
      }).catch((err: BusinessError) => {
        hilog.error(DOMAIN_NUMBER, TAG, `isNotificationEnabled fail, code is ${err.code}, message is ${err.message}`);
      });
    }

    /**
   * 发布通知
   */
    publish() {
      // 查询系统是否支持进度条模板
      notificationManager.isSupportTemplate('downloadTemplate').then((data: boolean) => {
        hilog.info(DOMAIN_NUMBER, TAG, 'Succeeded in supporting download template notification.');
        let isSupportTpl: boolean = data;
        // isSupportTpl的值为true表示支持downloadTemplate模板类通知，false表示不支持
        if (isSupportTpl) {
          let notificationRequest: notificationManager.NotificationRequest = {
            id: 1,
            content: {
              notificationContentType: notificationManager.ContentType.NOTIFICATION_CONTENT_BASIC_TEXT,
              normal: {
                title: '东林视频',
                text: '东林视频下载',
                additionalText: '东林'
              }
            },
            // 构造进度条模板，name字段当前需要固定配置为downloadTemplate
            template: {
              name: 'downloadTemplate',
              data: { title: '东林视频', fileName: '搞笑.mp4', progressValue: 80 }
            }
          }

          // 发布通知
          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.');
          });
        } else {
          promptAction.showToast({
            message: '不支持进度条通知'
          })
        }
      }).catch((err: BusinessError) => {
        hilog.error(DOMAIN_NUMBER, TAG,
                    `Failed to support download template notification. Code is ${err.code}, message is ${err.message}`);
    });


  }

  /**
   * 取消发布
   */
  cancelPublish() {
    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.');
    });
  }

  build() {
    Column() {
      Button('发布进度条通知').onClick(() => {
        this.publish()
      }).margin(100)
      Button('取消发布进度条通知').onClick(() => {
        this.cancelPublish()
      })

    }
    .height('100%')
    .width('100%')
    .justifyContent(FlexAlign.Center)
  }
}

注意：东林在下节案例给大家具体说下载进度条的用法，真实的模拟下载进度通知

用户通知服务-通知行为意图

基本介绍

当发布通知时，如果期望用户可以通过点击通知栏拉起目标应用组件或发布公共事件，可以通过Ability Kit申请WantAgent封装至通知消息中。

接口方法

接口名	描述
getWantAgent(info: WantAgentInfo, callback: AsyncCallback): void	创建WantAgent。

代码示例

import { notificationManager } from '@kit.NotificationKit';
import { BusinessError } from '@kit.BasicServicesKit';
import { hilog } from '@kit.PerformanceAnalysisKit';
import { common } from '@kit.AbilityKit';
import { wantAgent, WantAgent } from '@kit.AbilityKit'

// 日志标识
const TAG: string = '[publishTest]';
const DOMAIN_NUMBER: number = 0xFF00;
let context = getContext(this) as common.UIAbilityContext;

@Entry
@Component
struct Page2 {
  /**
   * 请求通知授权
   */
  aboutToAppear(): void {
    notificationManager.isNotificationEnabled().then((data: boolean) => {
      hilog.info(DOMAIN_NUMBER, TAG, "isNotificationEnabled success, data: " + JSON.stringify(data));
      if (!data) {
        notificationManager.requestEnableNotification(context).then(() => {
          hilog.info(DOMAIN_NUMBER, TAG, `[ANS] requestEnableNotification success`);
        }).catch((err: BusinessError) => {
          if (1600004 == err.code) {
            hilog.error(DOMAIN_NUMBER, TAG,
              `[ANS] requestEnableNotification refused, code is ${err.code}, message is ${err.message}`);
          } else {
            hilog.error(DOMAIN_NUMBER, TAG,
              `[ANS] requestEnableNotification failed, code is ${err.code}, message is ${err.message}`);
          }
        });
      }
    }).catch((err: BusinessError) => {
      hilog.error(DOMAIN_NUMBER, TAG, `isNotificationEnabled fail, code is ${err.code}, message is ${err.message}`);
    });
  }

  /**
   * 通知方法
   */
  publish() {

    let wantAgentObj:WantAgent; // 用于保存创建成功的wantAgent对象，后续使用其完成触发的动作。
    // 通过WantAgentInfo的operationType设置动作类型
    let wantAgentInfo:wantAgent.WantAgentInfo = {
      wants: [
        {
          deviceId: '',
          bundleName: 'com.xt.myapplication',
          abilityName: 'EntryAbility',
          action: '',
          entities: [],
          uri: '',
          parameters: {}
        }
      ],
      actionType: wantAgent.OperationType.START_ABILITY,
      requestCode: 0,
      wantAgentFlags:[wantAgent.WantAgentFlags.CONSTANT_FLAG]
    };

    // 创建WantAgent
    wantAgent.getWantAgent(wantAgentInfo, (err: BusinessError, data:WantAgent) => {
      if (err) {
        hilog.error(DOMAIN_NUMBER, TAG, `Failed to get want agent. Code is ${err.code}, message is ${err.message}`);
        return;
      }
      hilog.info(DOMAIN_NUMBER, TAG, 'Succeeded in getting want agent.');
      wantAgentObj = data;

      let notificationRequest: notificationManager.NotificationRequest = {
        // 通知的唯一id
        id: 1,
        content: {
          notificationContentType: notificationManager.ContentType.NOTIFICATION_CONTENT_BASIC_TEXT, // 普通文本类型通知
          normal: {
            // 通知的标题
            title: '百得知识库',
            // 通知的内容
            text: '百得知识库提醒你该学习了',
            // 附加消息
            additionalText: '百得',
          }
        },
        // wantAgentObj使用前需要保证已被赋值（即步骤3执行完成）
        wantAgent: wantAgentObj,
      };
      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.');
      });
    });
  }

  /**
   * 取消指定的通知
   */
  cancelPublish() {
    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.');
    });
  }

  build() {
    Column({ space: 20 }) {

      Button('发布文本类型通知')
        .onClick(() => {
          this.publish()
        })

      Button('取消通知')
        .onClick(() => {
          this.cancelPublish()
        })

    }
    .height('100%')
    .width('100%')
    .justifyContent(FlexAlign.Center)
  }
}

用户通知服务-工具类封装小案例

基本介绍

通过案例我们能学习到：用户通知服务还有部分文件服务基础能力工具类的封装，教大家如何进行工具类封装。

主体功能：用户点击下载文件按钮，触发通知，也可以取消通知

操作环境

记得在module.json文件中配置网络权限

    "requestPermissions":[
      {
        "name" : "ohos.permission.INTERNET",
        "reason": "$string:internet",
        "usedScene": {
          "abilities": [
            "FormAbility"
          ],
          "when":"inuse"
        }
      }
    ],

代码实现

界面如下：

1、文本通知工具类

NotificationUtil.ets

import { notificationManager } from '@kit.NotificationKit';
import { common } from '@kit.AbilityKit';
import { BusinessError } from '@kit.BasicServicesKit';

export class NotificationUtil {
  /**
   * 查询通知是否授权
   */
  static async isNotificationEnabled(): Promise<boolean> {
    return await notificationManager.isNotificationEnabled(); //查询通知是否授权。
  }


  /**
   * 请求通知授权，第一次调用会弹窗让用户选择。
   * @returns
   */
  static async authorizeNotification(): Promise<boolean> {
    let isEnabled = await NotificationUtil.isNotificationEnabled(); //查询通知是否授权
    if (!isEnabled) { //未授权，拉起授权
      try {
        let context = getContext() as common.UIAbilityContext;
        await notificationManager.requestEnableNotification(context);
        return true;
      } catch (e) {
        return false;
      }
    } else {
      return true;
    }
  }

  /**
   * 发起普通文本通知
   */
  static publishText(notificationOptions: NotificationOptions): Promise<boolean> {
    return new Promise<boolean>((resolve, reject) => {
      let notificationRequest: notificationManager.NotificationRequest = {
        // 通知的唯一id
        id: notificationOptions.id,
        content: {
          notificationContentType: notificationManager.ContentType.NOTIFICATION_CONTENT_BASIC_TEXT, // 普通文本类型通知
          normal: {
            // 通知的标题
            title: notificationOptions.title,
            // 通知的内容
            text: notificationOptions.text,
            // 附加消息
            additionalText: notificationOptions.additionalText,
          }
        }
      };
      notificationManager.publish(notificationRequest, (err: BusinessError) => {
        if (err) {
          console.log(`Failed to publish notification. Code is ${err.code}, message is ${err.message}`)
          reject(err)
        }
        console.log('Succeeded in publishing notification.')
        resolve(true)
      });
    })
  }

  /**
   * 取消通知
   */
  static cancel(id: number): Promise<boolean> {
    return new Promise<boolean>((resolve, reject) => {
      notificationManager.cancel(id, (err: BusinessError) => {
        if (err) {
          console.log(`Failed to cancel notification. Code is ${err.code}, message is ${err.message}`)
          reject(err)
        }
        console.log('Succeeded in cancel notification.')
        resolve(true)
      });
    })
  }

  /**
   * 取消所有通知
   */
  static cancelAll(): Promise<boolean> {
    return new Promise<boolean>((resolve, reject) => {
      notificationManager.cancelAll((err: BusinessError) => {
        if (err) {
          console.log(`Failed to cancel notification. Code is ${err.code}, message is ${err.message}`)
          reject(err)
        }
        console.log('Succeeded in cancel notification.')
        resolve(true)
      });
    })
  }
}


interface NotificationOptions {
  id: number
  title: string
  text: string
  additionalText: string

}

2、文件通知工具类

FileUtil.ets

import { common } from '@kit.AbilityKit';
import fs from '@ohos.file.fs';
import request from '@ohos.request';
import { BusinessError } from '@ohos.base';

let context = getContext(this) as common.UIAbilityContext;
let filesDir = context.filesDir

export class FileUtil {
  /**
   * 判断文件是否存在
   */
  static isExist(fileName: string, fileSuffix: string) {
    // 判断文件是否存在，存在就删除
    let path = filesDir + '/' + fileName + '.' + fileSuffix;
    if (fs.accessSync(path)) {
      fs.unlinkSync(path);
    }
  }

  /**
   * 下载文件
   */
  static downloadFile(fileName: string, fileSuffix: string, fileUrl: string): Promise<boolean> {
    return new Promise<boolean>((resolve, reject) => {
      // 判断文件是否已存在
      FileUtil.isExist(fileName, fileSuffix)
      request.downloadFile(context, {
        url: fileUrl,
        filePath: filesDir + '/' + fileName + '.' + fileSuffix
      }).then((downloadTask: request.DownloadTask) => {
        downloadTask.on('complete', () => {
          resolve(true)
        })
      }).catch((err: BusinessError) => {
        console.error(`Invoke downloadTask failed, code is ${err.code}, message is ${err.message}`);
        reject(err)
      });
    })
  }
}

3、页面的编写

Index.ets

import { NotificationUtil } from '../utils/NotificationUtil'
import { promptAction } from '@kit.ArkUI'
import { BusinessError } from '@kit.BasicServicesKit'
import { FileUtil } from '../utils/FileUtil'

@Entry
  @Component
  struct Index {
    build() {
      Column({ space: 20 }) {

        Button('发起通知')
          .onClick(async () => {
            // 发起通知授权
            let isSuccess = await NotificationUtil.authorizeNotification()
            if (isSuccess) {
              // 发起通知
              NotificationUtil.publishText({
                id: 1,
                title: '百得知识库',
                text: '百得知识库提醒你该学习了',
                additionalText: '百得'
              })
                .then(() => {
                  promptAction.showToast({ message: '发起通知成功' })
                }).catch((error: BusinessError) => {
                  promptAction.showToast({ message: '发起通知失败' + error.message })
                })
            } else {
              promptAction.showToast({ message: '通知授权失败' })
            }
          }).margin(100)


        Button('取消通知')
          .onClick(async () => {
            let flag = await NotificationUtil.cancel(1)
            if (flag) {
              promptAction.showToast({ message: '取消通知成功' })
              return
            }
            promptAction.showToast({ message: '取消通知失败' })
          })

        Button('取消所有通知')
          .onClick(async () => {
            let flag = await NotificationUtil.cancelAll()
            if (flag) {
              promptAction.showToast({ message: '取消所有通知成功' })
              return
            }
            promptAction.showToast({ message: '取消所有通知失败' })
          }).margin(100)

        Button('下载文件完成通知')
          .onClick(() => {
            FileUtil.downloadFile('hello', 'txt', 'http://121.41.123.231:8888/f/e01ace4294264594b632/?dl=1')
              .then(async (data) => {
                promptAction.showToast({ message: '文件下载成功' })
                // 发起通知授权
                let isSuccess = await NotificationUtil.authorizeNotification()
                if (isSuccess) {
                  // 发起通知
                  NotificationUtil.publishText({
                    id: 2,
                    title: '百得知识库',
                    text: '文件下载成功',
                    additionalText: '百得'
                  })
                    .then((data) => {
                      if (data) {
                        promptAction.showToast({ message: '发起通知成功' })
                        return
                      }
                      promptAction.showToast({ message: '发起通知失败' })
                    }).catch((error: BusinessError) => {
                      promptAction.showToast({ message: '发起通知失败' + error.message })
                    })
                } else {
                  promptAction.showToast({ message: '通知授权失败' })
                }
              })
              .catch((error: BusinessError) => {
                promptAction.showToast({ message: '文件下载失败' + error.message })
              })
          })
      }
      .height('100%')
        .width('100%')
        .justifyContent(FlexAlign.Center)
    }
  }