@nativescript/local-notifications

内容

• 简介
• 安装
• 使用 @nativescript/local-notifications
  • 导入插件
  • 请求权限
  • 安排通知
  • 获取所有安排通知的 ID
  • 取消安排的通知
  • 监听通知点击事件
• API
  • schedule()
    • ScheduleOptions
      • NotificationAction
  • addOnMessageReceivedCallback()
  • addOnMessageClearedCallback()
  • getScheduledIds()
  • cancel()
  • cancelAll()
  • requestPermission()
  • hasPermission()

简介

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

安装

在您项目的根目录中运行以下命令来安装插件。

npm install @nativescript/local-notifications

使用 @nativescript/local-notifications

注意：高级！ 如果在 iOS 10+ 上没有收到通知或 addOnMessageReceivedCallback 方法没有被调用，您可以尝试将 UNUserNotificationCenterDelegate 连接起来。

导入插件

要导入插件，可以使用以下两种方法之一。

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

请求权限

默认情况下，schedule 方法会为您请求用户权限。对于手动权限请求，请使用 requestPermission 方法。

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

安排通知

要安排通知，请调用 schedule 方法并传递一个通知对象的数组。有关通知对象成员的列表，请参阅 ScheduleOptions。

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': 15 }, // repeat the notification every 15 minutes
		displayImmediately: true, // display the notification immediately when using a ScheduleIntervalObject
		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);
	}
);

获取所有安排通知的 ID

要获取所有安排通知的 ID，请调用 getScheduledIds 方法。

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

取消安排的通知

要取消安排的通知，请使用 cancel 方法。

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

监听通知点击事件

点击通知中心的通知将启动您的应用。

在 iOS 上，甚至在应用处于前台时收到通知也会触发。

要处理通知点击，请调用 addMessageReceivedCallback 方法并传递一个回调函数。回调函数接收一个类型为 ReceivedNotification 的通知对象。

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

API

schedule()

scheduledNotificationsIDs: Array<number> = await LocalNotifications.schedule(scheduleOptions)

如果用户已授予权限，将安排指定的 scheduleOptions 通知。如果尚未提示用户请求权限，则将提示用户请求权限，如果权限被授予，则安排通知。对于手动权限请求，请使用 requestPermission 方法。

ScheduleOptions

NotificationAction

图标和轮廓图标选项（仅限Android）

这些选项默认为 res://ic_stat_notify 和 res://ic_stat_notify_silhouette，或者如果不存在，则为应用程序图标。

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

来源： 密度限定符文档

addOnMessageReceivedCallback()

LocalNotifications.addOnMessageReceivedCallback((notification: ReceivedNotification) => {
	//Handle the received notification
}).then(() => {
	console.log('Listener added');
});

响应通知点击事件。

ReceivedNotification

addOnMessageClearedCallback()

LocalNotifications.addOnMessageClearedCallback((notification: ReceivedNotification) => {
	//Handle the received notification
}).then(() => {
	console.log('Listener added');
});

响应通知清除事件。有关更多信息，请参阅 ReceivedNotification。

getScheduledIds()

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

返回所有计划中的通知的ID。

cancel()

LocalNotifications.cancel(id).then((foundAndCanceled: boolean) => {
	if (foundAndCanceled) {
		//
	} else {
		//
	}
});

取消具有指定ID的计划中的通知。

cancelAll()

LocalNotifications.cancelAll();

取消所有计划中的通知。

requestPermission()

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

请求用户授权应用程序发送通知。您只需要在iOS上调用此方法。如果权限已经授予，则返回 true。否则，返回 false。

hasPermission()

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

检查应用程序是否具有通知用户的权限。