Node-apn模块技术文档

1. 安装指南

推荐使用npm进行安装：

$ npm install apn --save

2. 项目使用说明

node-apn 是一个Node.js模块，用于与苹果推送通知服务（APNs）进行交互。以下是一个简单的使用流程：

加载模块

var apn = require('apn');

创建连接

创建一个新的连接到苹果推送通知服务提供商API，向构造函数传递一个包含配置选项的字典。必须提供您的令牌凭证。

var options = {
  token: {
    key: "path/to/APNsAuthKey_XXXXXXXXXX.p8",
    keyId: "key-id",
    teamId: "developer-team-id"
  },
  production: false
};

var apnProvider = new apn.Provider(options);

默认情况下，如果没有设置环境变量 NODE_ENV=production，提供者将连接到沙盒。

发送通知

首先，需要一个从您的应用程序获取的设备令牌。

let deviceToken = "a9d0ed10e9cfd022a61cb08753f49c5a0b0dfb383697bf9f9d750a1003da19c7";

创建一个通知对象，并配置相关参数。

var note = new apn.Notification();

note.expiry = Math.floor(Date.now() / 1000) + 3600; // 设置1小时后过期。
note.badge = 3;
note.sound = "ping.aiff";
note.alert = "\uD83D\uDCE7 \u2709 您有一条新消息";
note.payload = {'messageFrom': 'John Appleseed'};
note.topic = "<your-app-bundle-id>";

使用 send 方法发送通知，该方法返回一个Promise。

apnProvider.send(note, deviceToken).then( (result) => {
  // 查看文档以了解结果的解释
});

3. 项目API使用文档

请参考项目的完整文档了解API的详细使用方法。

4. 项目安装方式

项目安装方式同安装指南部分，使用npm进行安装：

$ npm install apn --save

请确保在项目中正确配置证书和密钥，并遵循相关文档进行操作。如果在连接或发送通知时遇到问题，请查看故障排除文档或联系支持。