NativeScript 本地通知插件

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

⚠️ 插件版本 4.0.0 应与 NativeScript 6+ 一起使用。如果您有较老的 tns --version，请使用较旧的插件版本。

⚠️ 查找 NativeScript 7 兼容性？请访问 NativeScript/plugins 仓库。

安装

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

tns plugin add nativescript-local-notifications

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

添加此代码以便在 iOS 10+ 中进行一些连接（精确地说，设置 iOS UNUserNotificationCenter.delegate）。如果您的应用在启动时加载插件，则不需要此操作。

如果 iOS 10+ 上的通知未由您的应用接收或 addOnMessageReceivedCallback 未被调用，则您将知道需要此操作...但为了安全起见，还是更好。

require ("nativescript-local-notifications");

现在您可以在 .ts 文件中将插件作为对象导入，如下所示

// 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-Core（XML）

此演示具有最多的选项，因此是值得检查的一个

git clone https://github.com/EddyVerbruggen/nativescript-local-notifications
cd nativescript-local-notifications/src
npm run demo.ios # or demo.android

NativeScript-Angular

此插件是我使用 Angular 构建的 插件演示应用 的一部分。

此仓库中还有一个简单的 Angular 演示

git clone https://github.com/EddyVerbruggen/nativescript-local-notifications
cd nativescript-local-notifications/src
npm run demo-ng.ios # or demo-ng.android

NativeScript-Vue

我们还有一个 Vue 演示

git clone https://github.com/EddyVerbruggen/nativescript-local-notifications
cd nativescript-local-notifications/src
npm run demo-vue.ios # or demo-vue.android

插件 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(
      function(scheduledIds) {
        console.log("Notification id(s) scheduled: " + JSON.stringify(scheduledIds));
      },
      function(error) {
        console.log("scheduling error: " + error);
      }
  )

通知图标（Android）

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

silhouetteIcon 应该是仅包含 alpha 的图片，并将在 Android >= Lollipop (21) 版本中使用。

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

来源： 密度限定符文档

addOnMessageReceivedCallback

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

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

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

getScheduledIds

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

请注意，所有函数都有错误处理器（见 schedule），但为了保持可读性，我们不会重复说明。

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

cancel

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

  LocalNotifications.cancel(5 /* the ID */).then(
      function(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(
      function(granted) {
        console.log("Permission granted? " + granted);
      }
  )

hasPermission

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

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

  LocalNotifications.hasPermission().then(
      function(granted) {
        console.log("Permission granted? " + granted);
      }
  )