NativeScript 通知插件

这是 Nativescript Local Notifications 插件的分支。此项目的最终目标将是一个用于管理本地和推送通知的综合性插件，无需两个不同的包和修改 iOS 的共享代理。

在其当前状态下，此插件允许您的应用在应用内显示通知。

安装

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

NativeScript 7+

ns plugin add @badideas/nativescript-notifications

7 之前的 NativeScript

tns plugin add [email protected]

设置（自插件版本 3.0.0 起使用）

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

如果 iOS 10+ 上的通知未被您的应用接收或 addOnMessageReceivedCallback 未被调用，则您需要此操作...虽然如此，但为了保险起见，最好还是这样做！

// either
import { LocalNotifications } from '@badideas/nativescript-notifications';
// or (if that doesn't work for you)
import * as LocalNotifications from '@badideas/nativescript-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: 'customsound-ios.wav', // falls back to the default sound on Android
		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 上轻松创建这些图标的好指南这里有一个关于如何在 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);
});

取消

如果您想取消之前计划的通知（并且知道其 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);
});