29.HarmonyOS App(JAVA)通知

普通通知:

通知渠道,弹出消息后，自动消失

长文本通知

//多行文本通知

//图片通知

//社交通知

//媒体通知--经测试，图片无法显示，文字不显示

场景介绍

HarmonyOS提供了通知功能，即在一个应用的UI界面之外显示的消息，主要用来提醒用户有来自该应用中的信息。当应用向系统发出通知时，它将先以图标的形式显示在通知栏中，用户可以下拉通知栏查看通知的详细信息。常见的使用场景：

显示接收到短消息、即时消息等。
显示应用的推送消息，如广告、版本更新等。
显示当前正在进行的事件，如播放音乐、导航、下载等。

接口说明

通知相关基础类包含NotificationSlot、NotificationRequest和NotificationHelper。基础类之间的关系如下所示：

图1 通知基础类关系图

NotificationSlot

NotificationSlot可以对提示音、振动、重要级别等进行设置。一个应用可以创建一个或多个NotificationSlot，在发布通知时，通过绑定不同的NotificationSlot，实现不同用途。

说明

NotificationSlot需要先通过NotificationHelper的addNotificationSlot(NotificationSlot)方法发布后，通知才能绑定使用；所有绑定该NotificationSlot的通知在发布后都具备相应的特性，对象在创建后，将无法更改这些设置，对于是否启动相应设置，用户有最终控制权。

不指定NotificationSlot时，当前通知会使用默认的NotificationSlot，默认的NotificationSlot优先级为LEVEL_DEFAULT。

表1 NotificationSlot主要接口
接口名	描述
NotificationSlot(String id, String name, int level)	构造NotificationSlot。
setLevel(int level)	设置NotificationSlot的级别。
setName(String name)	设置NotificationSlot的命名。
setDescription(String description)	设置NotificationSlot的描述信息。
enableBypassDnd(boolean bypassDnd)	设置是否绕过系统的免打扰模式。
setEnableVibration(boolean vibration)	设置收到通知时是否使能振动。
setEnableLight(boolean isLightEnabled)	设置收到通知时是否开启呼吸灯，前提是当前硬件支持呼吸灯。
setLedLightColor(int color)	设置收到通知时的呼吸灯颜色。
setSlotGroup(String groupId)	绑定当前NotificationSlot到一个NotificationSlot组。

NotificationSlot的级别目前支持如下几种，由低到高：

LEVEL_NONE：表示通知不发布。
LEVEL_MIN：表示通知可以发布，但不在状态栏显示，不自动弹出，无提示音；该级别不适用于前台服务的场景。
LEVEL_LOW：表示通知发布后在状态栏显示，不自动弹出，无提示音。
LEVEL_DEFAULT：表示通知发布后在状态栏显示，不自动弹出，触发提示音。
LEVEL_HIGH：表示通知发布后在状态栏显示，自动弹出，触发提示音。

NotificationRequest

NotificationRequest用于设置具体的通知对象，包括设置通知的属性，如：通知的分发时间、小图标、大图标、自动删除等参数，以及设置具体的通知类型，如普通文本、长文本等。

表2 NotificationRequest主要接口
接口名	描述
NotificationRequest()	构建一个通知。
NotificationRequest(int notificationId)	构建一个通知，指定通知的id。通知的Id在应用内具有唯一性，如果不指定，默认为0。
setNotificationId(int notificationId)	设置当前通知id。
setAutoDeletedTime(long time)	设置通知自动取消的时间戳。
setContent(NotificationRequest.NotificationContent content)	设置通知的具体内容。
setDeliveryTime(long deliveryTime)	设置通知分发的时间戳。
setSlotId(String slotId)	设置通知的NotificationSlot id。
setTapDismissed(boolean tapDismissed)	设置通知在用户点击后是否自动取消。
setLittleIcon(PixelMap smallIcon)	设置通知的小图标，在通知左上角显示。
setBigIcon(PixelMap bigIcon)	设置通知的大图标，在通知的右边显示。
setGroupValue(String groupValue)	设置分组通知，相同分组的通知在通知栏显示时，将会折叠在一组应用中显示。
addActionButton(NotificationActionButton actionButton)	设置通知添加通知ActionButton。
setIntentAgent(IntentAgent agent)	设置通知承载指定的IntentAgent，在通知中实现即将触发的事件。

具体的通知类型：目前支持六种类型，包括普通文本NotificationNormalContent、长文本NotificationLongTextContent、图片NotificationPictureContent、多行NotificationMultiLineContent、社交NotificationConversationalContent、媒体NotificationMediaContent。

表3 通知类型的主要接口
类名	接口名	描述
NotificationNormalContent	setTitle(String title)	设置通知标题。
NotificationNormalContent	setText(String text)	设置通知内容。
NotificationNormalContent	setAdditionalText(String additionalText)	设置通知次要内容，是对通知内容的补充。
NotificationPictureContent	setBriefText(String briefText)	设置通知概要内容，是对通知内容的总结。
NotificationPictureContent	setExpandedTitle(String expandedTitle)	设置附加图片的通知展开时的标题。
NotificationPictureContent	setBigPicture(PixelMap bigPicture)	设置通知的图片内容，附加在setText(String text)下方。
NotificationLongTextContent	setLongText(String longText)	设置通知的长文本。
NotificationConversationalContent	setConversationTitle(String conversationTitle)	设置社交通知的标题。
NotificationConversationalContent	addConversationalMessage(ConversationalMessage message)	通知添加一条消息。
NotificationMultiLineContent	addSingleLine(String line)	在当前通知中添加一行文本。
NotificationMediaContent	setAVToken(AVToken avToken)	将媒体通知绑定指定的AVToken。
NotificationMediaContent	setShownActions(int[] actions)	设置媒体通知待展示的按钮。

说明

通知发布后，通知的设置不可修改。如果下次发布通知使用相同的id，就会更新之前发布的通知。

NotificationHelperNotificationHelper封装了发布、更新、删除通知等静态方法。

表4 NotificationHelper主要接口
接口名	描述
publishNotification(NotificationRequest request)	发布一条通知。
publishNotification(String tag, NotificationRequest request)	发布一条带TAG的通知。
cancelNotification(int notificationId)	取消指定的通知。
cancelNotification(String tag, int notificationId)	取消指定的带TAG的通知。
cancelAllNotifications()	取消之前发布的所有通知。
addNotificationSlot(NotificationSlot slot)	创建一个NotificationSlot。
getNotificationSlot(String slotId)	获取NotificationSlot。
removeNotificationSlot(String slotId)	删除一个NotificationSlot。
getActiveNotifications()	获取当前应用发的活跃通知。
getActiveNotificationNums()	获取系统中当前应用发的活跃通知的数量。
setNotificationBadgeNum(int num)	设置通知的角标。
setNotificationBadgeNum()	设置当前应用中活跃状态通知的数量在角标显示。

开发步骤

通知的开发指导分为创建NotificationSlot、发布通知和取消通知等开发场景。

创建NotificationSlot

NotificationSlot可以设置公共通知的震动，重要级别等，并通过调用NotificationHelper.addNotificationSlot()发布NotificationSlot对象。

NotificationSlot slot = new NotificationSlot("slot_001", "slot_default", NotificationSlot.LEVEL_MIN); // 创建notificationSlot对象
slot.setDescription("NotificationSlotDescription");
slot.setEnableVibration(true); // 设置振动提醒
slot.setEnableLight(true); // 设置开启呼吸灯提醒
slot.setLedLightColor(Color.RED.getValue());// 设置呼吸灯的提醒颜色
try {
NotificationHelper.addNotificationSlot(slot);
} catch (RemoteException ex) {
HiLog.error(LABEL, "Exception occurred during addNotificationSlot invocation.");
}

发布通知

构建NotificationRequest对象，应用发布通知前，通过NotificationRequest的setSlotId()方法与NotificationSlot绑定，使该通知在发布后都具备该对象的特征。
1. int notificationId = 1;
2. NotificationRequest request = new NotificationRequest(notificationId);
3. request.setSlotId(slot.getId());
调用setContent()设置通知的内容。
1. String title = "title";
2. String text = "There is a normal notification content.";
3. NotificationNormalContent content = new NotificationNormalContent();
4. content.setTitle(title)
5. .setText(text);
6. NotificationRequest.NotificationContent notificationContent = new NotificationRequest.NotificationContent(content);
7. request.setContent(notificationContent); // 设置通知的内容
调用publishNotification()发布通知。
1. try {
2. NotificationHelper.publishNotification(request);
3. } catch (RemoteException ex) {
4. HiLog.error(LABEL, "Exception occurred during publishNotification invocation.");
5. }

显示另外一个页面。

MainAbilitySlice.java

package com.example.myapplication.slice;import com.example.myapplication.ResourceTable;
import ohos.aafwk.ability.AbilitySlice;
import ohos.aafwk.content.Intent;
import ohos.aafwk.content.Operation;
import ohos.agp.components.Button;
import ohos.agp.components.Component;
import ohos.agp.render.opengl.Utils;
import ohos.agp.utils.Color;
import ohos.agp.utils.LayoutAlignment;
import ohos.agp.window.dialog.ToastDialog;
import ohos.event.intentagent.IntentAgent;
import ohos.event.intentagent.IntentAgentConstant;
import ohos.event.intentagent.IntentAgentHelper;
import ohos.event.intentagent.IntentAgentInfo;
import ohos.event.notification.*;
import ohos.global.resource.NotExistException;
import ohos.hiviewdfx.HiLog;
import ohos.hiviewdfx.HiLogLabel;
import ohos.media.image.ImageSource;
import ohos.media.image.PixelMap;
import ohos.media.image.common.PixelFormat;
import ohos.media.image.common.Rect;
import ohos.media.image.common.Size;
import ohos.miscservices.timeutility.Time;
import ohos.rpc.RemoteException;import java.io.IOException;
import java.io.InputStream;
import java.time.LocalDateTime;
import java.util.ArrayList;
import java.util.ConcurrentModificationException;
import java.util.Date;
import java.util.List;public class MainAbilitySlice extends AbilitySlice {@Overridepublic void onStart(Intent intent) {super.onStart(intent);super.setUIContent(ResourceTable.Layout_ability_main);Button btn1 = (Button) findComponentById(ResourceTable.Id_btn1);btn1.setClickedListener(new Component.ClickedListener() {@Overridepublic void onClick(Component component) {ShowNoti1();}});Button btn2 = (Button) findComponentById(ResourceTable.Id_btn2);btn2.setClickedListener(new Component.ClickedListener() {@Overridepublic void onClick(Component component) {IntentAgent agent = createOpenThisAbilityIntentAgent1();NotificationRequest.NotificationNormalContent content = new NotificationRequest.NotificationNormalContent().setTitle("notification test").setText("单击打开PageAbility页面");//创建页面方法，参考这里。https://txwtech.blog.csdn.net/article/details/135095068NotificationRequest.NotificationContent notificationContent = new NotificationRequest.NotificationContent(content);NotificationRequest request = new NotificationRequest(1002).setContent(notificationContent).setIntentAgent(agent);try{NotificationHelper.publishNotification(request);}catch (Exception ex){}}});//创建通知渠道NotificationSlot slot = new NotificationSlot("slot1","一般性通知",NotificationSlot.LEVEL_DEFAULT);slot.setDescription("一般性通知");NotificationSlot slot2 = new NotificationSlot("slot2","特别重要通知",NotificationSlot.LEVEL_HIGH);slot2.setDescription("特别重要通知");//震动提醒slot2.setEnableVibration(true);//锁屏通知slot2.setLockscreenVisibleness(NotificationRequest.VISIBLENESS_TYPE_PUBLIC);//跳过免打扰模式slot2.enableBypassDnd(true);//开启呼吸灯提醒slot2.setEnableLight(true);//设置呼吸灯的提醒颜色slot2.setLedLightColor(Color.RED.getValue());try{NotificationHelper.addNotificationSlot(slot);NotificationHelper.addNotificationSlot(slot2);}catch (RemoteException e){//加入通知渠道失败ToastDialog toastDialog = new ToastDialog(this);toastDialog.setTransparent(true).setDuration(2000).setAlignment(LayoutAlignment.BOTTOM+LayoutAlignment.HORIZONTAL_CENTER).setOffset(0,200)//距离底边距离.show();}Button button_qudao = (Button) findComponentById(ResourceTable.Id_btn3_qudao);button_qudao.setClickedListener(new Component.ClickedListener() {@Overridepublic void onClick(Component component) {QudaoNotification();}});Button button_long_text = (Button) findComponentById(ResourceTable.Id_btn4_long_text);button_long_text.setClickedListener(new Component.ClickedListener() {@Overridepublic void onClick(Component component) {LongTextNotification();}});Button button_duohang = (Button) findComponentById(ResourceTable.Id_btn5_duohang);button_duohang.setClickedListener(new Component.ClickedListener() {@Overridepublic void onClick(Component component) {MultiTextNotification();}});Button button_pic = (Button) findComponentById(ResourceTable.Id_btn3_picture);button_pic.setClickedListener(new Component.ClickedListener() {@Overridepublic void onClick(Component component) {PictureNotification();}});Button button_social = (Button) findComponentById(ResourceTable.Id_btn4_social);button_social.setClickedListener(new Component.ClickedListener() {@Overridepublic void onClick(Component component) {SocialNotification();}});Button button_media = (Button) findComponentById(ResourceTable.Id_btn5_media);button_media.setClickedListener(new Component.ClickedListener() {@Overridepublic void onClick(Component component) {MediaNotification();}});}public void ShowNoti1(){NotificationRequest.NotificationNormalContent content = new NotificationRequest.NotificationNormalContent().setTitle("标题Title").setText("内容Text").setAdditionalText("次要内容");//创建notificationContent通知内容对象NotificationRequest.NotificationContent notificationContent = new NotificationRequest.NotificationContent(content);//创建notificationRequest通知请求对象NotificationRequest request = new NotificationRequest(1001).setContent(notificationContent);try{//发布通知NotificationHelper.publishNotification(request);}catch (RemoteException ex){HiLog.info(new HiLogLabel(1,1,null),"aa");}}//创建方法private IntentAgent createOpenThisAbilityIntentAgent1(){//创建打开ablity的Itent对象Operation operation = new Intent.OperationBuilder().withDeviceId("").withBundleName("com.example.myapplication").withAbilityName("com.example.myapplication.PageAbility").build();Intent intent = new Intent();intent.setOperation(operation);//将Intent对象添加到List<intent>对象中List<Intent> intents = new ArrayList<>();intents.add(intent);//创建flags对象List<IntentAgentConstant.Flags> flags = new ArrayList<>();flags.add(IntentAgentConstant.Flags.ONE_TIME_FLAG);//创建启动Ability的ItentAgentInfo对象IntentAgentInfo info = new IntentAgentInfo(200,IntentAgentConstant.OperationType.START_ABILITIES,flags,intents,null);//通过IntentAgentHelper创建IntentAgent对象IntentAgent agent = IntentAgentHelper.getIntentAgent(this,info);return agent;}//通知渠道public void QudaoNotification(){//普通文本通知内容NotificationRequest.NotificationNormalContent content = new NotificationRequest.NotificationNormalContent().setTitle("重要通知").setText("雨天路滑，注意安全");//创建notificationContent通知内容对象NotificationRequest.NotificationContent notificationContent = new NotificationRequest.NotificationContent(content);NotificationRequest request = new NotificationRequest(1003).setContent(notificationContent).setSlotId("slot2");try{//发布通知NotificationHelper.publishNotification(request);}catch (RemoteException e){}}/*长文本通知*/public void LongTextNotification(){NotificationRequest.NotificationLongTextContent content = new NotificationRequest.NotificationLongTextContent();content.setTitle("标题title").setExpandedTitle("扩展标题expandedtitle").setAdditionalText("额外内容addtitionalText").setLongText("长文本，longtext,longtext");//创建通知内容对象NotificationRequest.NotificationContent notificationContent= new NotificationRequest.NotificationContent(content);//创建通知请求对象NotificationRequest request = new NotificationRequest(1004).setContent(notificationContent);try{//发布通知NotificationHelper.publishNotification(request);}catch (RemoteException ex){}}//多行文本通知public void MultiTextNotification(){NotificationRequest.NotificationMultiLineContent multiLineContent = new NotificationRequest.NotificationMultiLineContent();multiLineContent.setTitle("多行文本").setText("内容text").setExpandedTitle("扩展标题").addSingleLine("行1内容").addSingleLine("行2内容").addSingleLine("行3内容");NotificationRequest.NotificationContent notificationContent = new NotificationRequest.NotificationContent(multiLineContent);NotificationRequest notificationRequest = new NotificationRequest(1005);notificationRequest.setContent(notificationContent);try{NotificationHelper.publishNotification(notificationRequest);}catch (RemoteException ex){}}//图片通知public void PictureNotification(){NotificationRequest.NotificationPictureContent notificationPictureContent = new NotificationRequest.NotificationPictureContent();notificationPictureContent.setTitle("图片标题-荷花").setText("内容。。。").setBriefText("春天来了，天气不错，记得晒太阳哦").setExpandedTitle("温馨提示").setBigPicture(getPixelMap((ResourceTable.Media_hehua)));NotificationRequest.NotificationContent notificationContent = new NotificationRequest.NotificationContent(notificationPictureContent);NotificationRequest request = new NotificationRequest(1006);request.setContent(notificationContent);try{NotificationHelper.publishNotification(request);}catch (RemoteException ex){}}//图片通知private PixelMap getPixelMap(int drawableId){InputStream drawableInputStream = null;try{drawableInputStream = getResourceManager().getResource(drawableId);ImageSource.SourceOptions sourceOptions = new ImageSource.SourceOptions();sourceOptions.formatHint="image/png";ImageSource imageSource = ImageSource.create(drawableInputStream,sourceOptions);ImageSource.DecodingOptions decodingOptions = new ImageSource.DecodingOptions();decodingOptions.desiredSize = new Size(0,0);decodingOptions.desiredRegion = new Rect(0,0,0,0);decodingOptions.desiredPixelFormat = PixelFormat.ARGB_8888;PixelMap pixelMap = imageSource.createPixelmap(decodingOptions);return pixelMap;}catch (Exception ex){ex.printStackTrace();}finally {try{if(drawableInputStream!=null){drawableInputStream.close();}}catch (Exception e){e.printStackTrace();}}return null;}//社交通知private void SocialNotification(){MessageUser user1 = new MessageUser();user1.setName("张大天");user1.setPixelMap(getPixelMap(ResourceTable.Media_dog1));MessageUser user2 = new MessageUser();user2.setName("小明");user2.setPixelMap(getPixelMap(ResourceTable.Media_rabit));//社交通知内容NotificationRequest.NotificationConversationalContent notificationConversationalContent = new NotificationRequest.NotificationConversationalContent(user1);notificationConversationalContent.setConversationTitle("即时消息").addConversationalMessage(new NotificationRequest.NotificationConversationalContent.ConversationalMessage("您好", Time.getCurrentTime(),user1)).addConversationalMessage(new NotificationRequest.NotificationConversationalContent.ConversationalMessage("在哦，您好",Time.getCurrentTime(),user2));NotificationRequest.NotificationContent notificationContent = new NotificationRequest.NotificationContent(notificationConversationalContent);NotificationRequest notificationRequest = new NotificationRequest(1007);notificationRequest.setContent(notificationContent);try{NotificationHelper.publishNotification(notificationRequest);}catch (RemoteException ex){}}//媒体通知--经测试，图片无法显示，文字不显示private void MediaNotification(){NotificationRequest.NotificationMediaContent content = new NotificationRequest.NotificationMediaContent();content.setTitle("标题title").setText("媒体通知--内容text").setAdditionalText("额外内容").setShownActions(new int[]{0});//定义3个按钮NotificationActionButton btn1 = new NotificationActionButton.Builder(getPixelMap(ResourceTable.Media_play),"开始",null).build();NotificationActionButton btn2 = new NotificationActionButton.Builder(getPixelMap(ResourceTable.Media_heart),"喜欢",null).build();NotificationActionButton btn3 = new NotificationActionButton.Builder(getPixelMap(ResourceTable.Media_start),"收藏",null).build();NotificationRequest.NotificationContent notificationContent = new NotificationRequest.NotificationContent(content);NotificationRequest notificationRequest = new NotificationRequest(1008).setContent(notificationContent).addActionButton(btn1).addActionButton(btn2).addActionButton(btn3);try{NotificationHelper.publishNotification(notificationRequest);}catch (RemoteException ex){}}@Overridepublic void onActive() {super.onActive();}@Overridepublic void onForeground(Intent intent) {super.onForeground(intent);}
}

项目工程代码：

待更新。。。