uniapp 监听通知栏消息插件（支持白名单、黑名单、过滤） Ba-NotifyListener

news2024/11/15 23:53:01

简介（下载地址）

Ba-NotifyListener 是一款实时监听通知栏消息的uniapp插件。支持白名单、黑名单；支持监听消息移除；支持自定义过滤条件（如短信验证码）等。

支持监听所有通知栏消息（包含id、ticker、标题、内容、时间等等内容）
支持白名单（需要监听的应用，设置后其他应用都不监听）
支持黑名单（不想监听的应用，不设置白名单时有效）
支持自定义内容过滤条件（如过滤短信验证码，默认过滤4~8位数字）

截图展示

在这里插入图片描述

使用方法

在 script 中引入组件

	const listener = uni.requireNativePlugin('Ba-NotifyListener');

在 script 中调用（示例参考，可根据自己业务和调用方法自行修改）

	const listener = uni.requireNativePlugin('Ba-NotifyListener'); //本插件
	const notify = uni.requireNativePlugin('Ba-Notify'); //应用通知插件（https://ext.dcloud.net.cn/plugin?id=9231）
	export default {
		data() {
			return {
				whiteList: [ //白名单
					'com.ba.UniTemp',
					'com.tencent.mobileqq', //qq
					'com.tencent.mm', //微信
					'com.android.mms', //短信
					'com.android.incallui', //来电
				],
				blackList: [ //黑名单
					'com.ba.UniTemp',
				],
				msgList: []
			}
		},
		methods: {
			setListener(flag = 0) { //设置监听
				let params = {};
				if (flag == 1) {
					params = {
						whiteList: this.whiteList,
					    //regex: "(\\d{4,8})",正则表达式，默认为匹配4-8位的数字
					};
				} else if (flag == 2) {
					params = {
						blackList: this.blackList,
					    //regex: "(\\d{4,8})",正则表达式，默认为匹配4-8位的数字
					};
				}
				listener.setListener(params, res => {
					console.log(res);
					if (res.ok && res.data) {
						if (res.data.listenType == 1) {
							this.msgList.push('收到消息：');
							this.msgList.push(JSON.stringify(res.data));
							if (res.data.result)
								this.msgList.push("解析结果：" + res.data.result);

						}
						if (res.data.listenType == 2) {
							this.msgList.push('移除消息：');
							this.msgList.push(JSON.stringify(res.data));
						}
					}
					uni.showToast({
						title: res.msg,
						icon: "none",
						duration: 3000
					})
				});
			},
			isHasPermission() { //是否开启获取通知权限
				listener.isHasPermission(res => {
					console.log(res);
					uni.showToast({
						title: res.ok ? (res.data && res.data.isHasPermission ? '已开启' : '未开启') : res.msg,
						icon: "none",
						duration: 3000
					})
				});
			},
			openPermission() { //跳转到通知权限设置界面（仅判断未打开时跳转）
				listener.openPermission(res => {
					let msg = res.msg;
					if (res.data && res.data.isHasPermission) {
						msg = res.data.isHasPermission ? "权限打开" : "权限关闭";
					}
					uni.showToast({
						title: msg,
						icon: "none",
						duration: 3000
					})
				});
			},
			setPermission() { //跳转到通知权限设置界面（开不开都跳转）
				listener.setPermission(res => {
					console.log(res);
					let msg = res.msg;
					if (res.data && res.data.isHasPermission) {
						msg = res.data.isHasPermission ? "权限打开" : "权限关闭";
					}
					uni.showToast({
						title: msg,
						icon: "none",
						duration: 3000
					})
				});
			},
			sendNotify() {//用于测试通知
				notify.show({
						channelID: '0',
						channelName: '普通通知',
						ID: 1,
						notifyType: 0,
						ticker: 'Ticker',
						title: 'title',
						content: "【某某应用】验证码：708563。尊敬的用户，您正在...，我们不会向您索要此验证码，切勿告知他人！",
						extend: "附加参数",
					},
					(res) => {
						console.log(res)
					});
			}
		}
	}

api 列表

方法名	说明
setListener	设置监听
isHasPermission	是否开启获取通知权限
openPermission	跳转到通知权限设置界面（仅判断未打开时跳转）
setPermission	跳转到通知权限设置界面（开不开都跳转）

setListener 方法参数

设置监听

属性名	类型	必填	默认值	说明
whiteList	Array	false	‘’	白名单
blackList	Array	false	‘’	黑名单
regex	String	false	‘’	正则表达式过滤短信内容，默认过滤4~8位数字验证码，如’(\d{4,8})’

监听通知的参数

判断 res.data 有内容（参照使用方法），监听接收到的通知

属性名	类型	说明
listenType	Number	1 接收到通知 2 移除通知
packageName	String	应用包名
id	Number	通知 id
postTime	long	时间（毫秒）
postTimeS	String	时间（yyyy-MM-dd HH:mm:ss 格式）
tickerText	String	通知 ticker，在顶部状态栏中的提示信息
title	String	通知标题
content	String	通知内容
result	String	通知内容根据过滤规则，解析后的结果，如短信验证码
isOngoing	Boolean	通知是否持续显示，侧滑不能删除
isClearable	Boolean	点击通知，是否自动消失