@nativescript/local-notifications

本地通知插件允许您的应用程序在应用程序未运行时显示通知。就像远程推送通知一样，但设置起来要容易得多。

安装

从命令提示符进入您的应用程序根目录并执行

NativeScript 7+

ns plugin add @nativescript/local-notifications

NativeScript 7之前

tns plugin add [email protected]

设置（自插件版本 3.0.0 以来）

添加此内容，以便对于 iOS 10+，我们可以做一些连接（精确地设置 iOS UNUserNotificationCenter.delegate）。如果您的应用程序在启动时加载插件，则不需要此操作。

如果您在 iOS 10+ 上未收到通知或 addOnMessageReceivedCallback 未被调用，则需要此操作。但最好还是小心为上。

// either
import { LocalNotifications } from '@nativescript/local-notifications';
// or (if that doesn't work for you)
import * as LocalNotifications from '@nativescript/local-notifications';

// then use it as:
LocalNotifications.hasPermission();

NativeScript-Angular

此插件是我使用 Angular 构建的一个插件展示应用程序的一部分。

此外，此存储库中还有一个简单的 Angular 示例

NativeScript-Vue

还有一个 Vue 示例

插件 API

schedule

在 iOS 上，您需要请求权限才能安排通知。您可以让 schedule 函数自动为您完成（如果用户授予了权限，则将安排通知），或者您可以手动调用 requestPermission，如果您想这样做。

您可以为此函数传递几个选项，所有选项都是可选的

NotificationAction

LocalNotifications.schedule([
	{
		id: 1, // generated id if not set
		title: 'The title',
		body: 'Recurs every minute until cancelled',
		ticker: 'The ticker',
		color: new Color('red'),
		badge: 1,
		groupedMessages: ['The first', 'Second', 'Keep going', 'one more..', 'OK Stop'], //android only
		groupSummary: 'Summary of the grouped messages above', //android only
		ongoing: true, // makes the notification ongoing (Android only)
		icon: 'res://heart',
		image: 'https://cdn-images-1.medium.com/max/1200/1*c3cQvYJrVezv_Az0CoDcbA.jpeg',
		thumbnail: true,
		interval: 'minute',
		channel: 'My Channel', // default: 'Channel'
		sound: isAndroid ? 'customsound' : 'customsound.wav',
		at: new Date(new Date().getTime() + 10 * 1000), // 10 seconds from now
	},
]).then(
	(scheduledIds) => {
		console.log('Notification id(s) scheduled: ' + JSON.stringify(scheduledIds));
	},
	(error) => {
		console.log('scheduling error: ' + error);
	}
);

通知图标（Android）

这些选项默认为 res://ic_stat_notify 和 res://ic_stat_notify_silhouette，如果没有则使用应用图标。

silhouetteIcon 应仅是透明图像，并在Android >= Lollipop (21)中使用。

这些是官方图标尺寸指南，以及如何在Android上轻松创建这些图标的优秀指南。

来源： 密度限定符文档

addOnMessageReceivedCallback

在通知中心轻触通知将启动您的应用。但如果您安排了两个通知，想知道用户点击的是哪一个怎么办？

使用此功能，当通知被用来启动您的应用时将触发回调。注意，在iOS上，即使在应用处于前台且收到通知时，此功能也会被触发。

LocalNotifications.addOnMessageReceivedCallback((notification) => {
	console.log('ID: ' + notification.id);
	console.log('Title: ' + notification.title);
	console.log('Body: ' + notification.body);
}).then(() => {
	console.log('Listener added');
});

getScheduledIds

如果您想了解所有已安排的通知的ID，请这样做

LocalNotifications.getScheduledIds().then((ids) => {
	console.log("ID's: " + ids);
});

cancel

如果您想取消之前安排的通知（并且知道其ID），您可以取消它

LocalNotifications.cancel(5 /* the ID */).then((foundAndCanceled) => {
	if (foundAndCanceled) {
		console.log("OK, it's gone!");
	} else {
		console.log('No ID 5 was scheduled');
	}
});

cancelAll

如果您只想取消之前安排的所有通知，请这样做

LocalNotifications.cancelAll();

requestPermission

在Android上，您不需要权限，但在iOS上您需要。Android将简单地返回true。

如果之前运行了requestPermission或schedule函数，用户已经被提示授予权限。如果用户授予了权限，此函数返回true，但如果他拒绝了权限，此函数将返回false，因为iOS只能请求权限一次。在这种情况下，用户需要进入iOS设置应用并手动为您的应用启用权限。

LocalNotifications.requestPermission().then((granted) => {
	console.log('Permission granted? ' + granted);
});

hasPermission

在Android上，您不需要权限，但在iOS上您需要。Android将简单地返回true。

如果之前运行了requestPermission或schedule函数，您可能想要检查用户是否已授予权限

LocalNotifications.hasPermission().then((granted) => {
	console.log('Permission granted? ' + granted);
});