@awarns/notifications

此模块允许在发生事件时向用户发送通知。它还定义了一些原始框架记录，用于保存用户对通知的可能反应和交互。

此插件作为 EddyVerbruggen 的 NativeScript Local Notifications 插件的包装器，适应与 AwarNS 框架任务模型一起使用。

使用以下命令行指令安装插件

ns plugin add @awarns/notifications

用法

安装并配置此插件后，您将获得两种交互机制来与之交互

1. 插件 API。通过它，您将能够管理已发送的通知及其可能的反应。
2. 通知发送任务，允许使用系统服务在本地向用户显示通知。用户可以点击或丢弃通知。该插件包含特定的记录以直接反应：NotificationTap 和 NotificationDiscard。它还包含更具体的通知点击动作的 records 定义。

设置

此插件要求您在框架初始化期间注册其加载器，如下所示

// ... platform imports
import { awarns } from '@awarns/core';
import { demoTasks } from '../tasks';
import { demoTaskGraph } from '../graph';
import { registerNotificationsPlugin } from '@awarns/notifications';

awarns
  .init(
    demoTasks,
    demoTaskGraph,
    [
      registerNotificationsPlugin('App notifications'),
    ]
  )
  // ... handle initialization promise

插件加载器参数

API

notificationsManager

notificationsManager 单例对象允许管理对通知的反应。它提供以下操作

notifications

notifications 单例对象允许访问已发送但尚未处理/读取的通知。它提供以下操作

Notification

TapAction

TapActionType

任务

发送通知

任务名称: sendNotification

描述: 发送包含指定信息的通知

执行要求: 无

要注册此任务以供使用，您只需将其导入并在应用程序的任务列表中调用其生成函数即可

import { Task } from '@awarns/core/tasks';
import { sendNotificationTask } from '@awarns/notifications';

export const demoTasks: Array<Task> = [
  sendNotificationTask(),
];

任务生成器参数

任务生成器不接受任何参数。

任务输出事件

该任务在执行完成后不产生重大事件，除了常规的{task-name}Finished事件：sendNotificationFinished。

然而，一旦它运行完成，相关的内部监听器将发出事件。以下列出这些事件。

• notificationTapped
• notificationDiscarded

在应用程序任务图中的示例使用

on(
  'startEvent',
  run('sendNotification', {
    title: 'New content available', // All notifications must contain a title
    body: 'This information may be valuable for you', // The body of the notification can be provided through here 
                                                      // or inside the payload (data) of the event trigger, inside a 
                                                      // property called body
    tapAction: { // (Optional) If not provided, defaults to OPEN_APP
      type: TapActionType.OPEN_CONTENT, // See the rest of the options in the TapActionType enum
      id: 'content-1', // For the app to distingish what content must be displayed after tapping the notification
    },
  })
);

on('notificationTapped', run('writeRecords'));
on('notificationCleared', run('writeRecords'));

注意：要使用writeRecords任务，必须安装和配置持久化包。请参阅持久化包文档。

发送一组选项中的随机通知

任务名称: sendRandomNotification

描述: 在给定集合中发送随机通知

执行要求: 无

要注册此任务以供使用，您只需将其导入并在应用程序的任务列表中调用其生成函数即可

import { Task } from '@awarns/core/tasks';
import { sendRandomNotificationTask } from '@awarns/notifications';

export const demoTasks: Array<Task> = [
  sendRandomNotificationTask(),
];

任务生成器参数

任务生成器不接受任何参数。

任务输出事件

该任务在执行完成后不产生重大事件，除了常规的{task-name}Finished事件：sendNotificationFinished。

然而，一旦它运行完成，相关的内部监听器将发出事件。以下列出这些事件。

• notificationTapped
• notificationDiscarded

在应用程序任务图中的示例使用

on(
  'startEvent',
  run('sendRandomNotification', {
    options: [
      {
        title: 'Would you like to rate the app?', // All notifications must contain a title
        // But the body is optional
      },
      {
        title: 'Do you like the app so far?',
        body: 'Your feedback can make us better', // Unlike the sendNotification task, 
                                                  // the notification body can only be set through here
      },
      {
        title: 'Your opinion is very valuable',
        tapAction: { // (Optional) Including a tap action inside one of the options will override the default one (see below)
          type: TapActionType.ASK_FEEDBACK,
          id: 'special-feedback',
        },
      },
    ],
    defaultTapAction: { // (Optional) Common tap action for all the notification options that don't declare one
          type: TapActionType.ASK_FEEDBACK,
          id: 'regular-feedback',
     },
  })
);

on('notificationTapped', run('writeRecords'));
on('notificationCleared', run('writeRecords'));

注意：要使用writeRecords任务，必须安装和配置持久化包。请参阅持久化包文档。

事件

记录

此插件包括记录，可分为两大类：用户反应和用户交互。

License

Apache License Version 2.0