diff --git a/README.md b/README.md index 744c5d32..9806d432 100644 --- a/README.md +++ b/README.md @@ -163,7 +163,7 @@ note.pushType = "liveactivity", note.relevanceScore = 75, note.timestamp = Math.floor(Date.now() / 1000); // Current time note.staleDate = Math.floor(Date.now() / 1000) + (8 * 3600); // Expires 8 hour from now. -note.events = "update" +note.event = "update" note.contentState = {} ``` @@ -179,7 +179,7 @@ This will result in the the following notification payload being sent to the dev ```json -{"messageFrom":"John Appleseed","aps":{"badge":3,"sound":"ping.aiff","alert":"\uD83D\uDCE7 \u2709 You have a new message", "relevance-score":75,"timestamp":1683129662,"stale-date":1683216062,"events":"update","content-state":{}}} +{"messageFrom":"John Appleseed","aps":{"badge":3,"sound":"ping.aiff","alert":"\uD83D\uDCE7 \u2709 You have a new message", "relevance-score":75,"timestamp":1683129662,"stale-date":1683216062,"event":"update","content-state":{}}} ``` You should only create one `Provider` per-process for each certificate/key pair you have. You do not need to create a new `Provider` for each notification. If you are only sending notifications to one app then there is no need for more than one `Provider`. diff --git a/doc/notification.markdown b/doc/notification.markdown index 3ad00c78..8916fe44 100644 --- a/doc/notification.markdown +++ b/doc/notification.markdown @@ -110,7 +110,7 @@ This table shows the name of the setter, with the key-path of the underlying pro | `relevanceScore` | `aps.relevance-score` | `Number` | | `timestamp` | `aps.timestamp` | `Number` | | `staleDate` | `aps.staleDate` | `Number` | -| `events` | `aps.events` | `String` | +| `event` | `aps.event` | `String` | | `contentState` | `aps.content-state` | `Object` | | `mdm` | `mdm` | `String` | diff --git a/lib/notification/apsProperties.js b/lib/notification/apsProperties.js index 1d1924ea..8381becc 100644 --- a/lib/notification/apsProperties.js +++ b/lib/notification/apsProperties.js @@ -101,9 +101,9 @@ module.exports = { } }, - set events(value) { + set event(value) { if (typeof value === 'string' || value === undefined) { - this.aps.events = value; + this.aps.event = value; } }, diff --git a/lib/notification/index.js b/lib/notification/index.js index 2d778b43..4b4f9b50 100644 --- a/lib/notification/index.js +++ b/lib/notification/index.js @@ -52,7 +52,7 @@ Notification.prototype = require('./apsProperties'); 'relevanceScore', 'timestamp', 'staleDate', - 'events', + 'event', 'contentState', ].forEach(propName => { const methodName = 'set' + propName[0].toUpperCase() + propName.slice(1); diff --git a/test/notification/apsProperties.js b/test/notification/apsProperties.js index 9ec9b6eb..04bbb727 100644 --- a/test/notification/apsProperties.js +++ b/test/notification/apsProperties.js @@ -832,28 +832,28 @@ describe('Notification', function () { }); }); - describe('events', function () { + describe('event', function () { it('defaults to undefined', function () { - expect(compiledOutput()).to.not.have.nested.property('aps.events'); + expect(compiledOutput()).to.not.have.nested.property('aps.event'); }); it('can be set to a string', function () { - note.events = 'the-event'; + note.event = 'the-event'; - expect(compiledOutput()).to.have.nested.property('aps.events', 'the-event'); + expect(compiledOutput()).to.have.nested.property('aps.event', 'the-event'); }); it('can be set to undefined', function () { - note.events = 'the-event'; - note.events = undefined; + note.event = 'the-event'; + note.event = undefined; - expect(compiledOutput()).to.not.have.nested.property('aps.events'); + expect(compiledOutput()).to.not.have.nested.property('aps.event'); }); - describe('setEvents', function () { + describe('setEvent', function () { it('is chainable', function () { - expect(note.setEvents('the-event')).to.equal(note); - expect(compiledOutput()).to.have.nested.property('aps.events', 'the-event'); + expect(note.setEvent('the-event')).to.equal(note); + expect(compiledOutput()).to.have.nested.property('aps.event', 'the-event'); }); }); });