PushEvent
PushEvent 表示一条到达的静默推送。它是 application.remoteNotifications 上 push 事件的事件对象,带着推送的内容,并让 App 告诉系统:处理这条推送的事什么时候做完、结果怎样。
系统唤醒 App 处理静默推送时,给的时间有限。App 用 waitUntil() 把要做的事交给它,系统就等这件事做完,再根据结果安排 App 回到暂停状态。
它属于 @nacrejs/push 这个包,装法见 RemoteNotifications。
继承关系:Event → PushEvent
构造函数
静默推送到了时,运行时创建它,派发给 push 的监听器。也可以自己用 new PushEvent('push', { data }) 建一个,派发出去试监听器。
实例属性
还继承 Event 的属性。cancelable 是 false(实测)。
| 属性 | 说明 |
|---|---|
data 只读 | 推送的内容:服务器发来的整个 JSON 对象,包括 aps |
实例方法
| 方法 | 说明 |
|---|---|
waitUntil() | 让系统等一个 Promise 落定,用它的结果回答系统 |
系统得到的结果
派发完之后,运行时等这次派发里 waitUntil() 收下的全部 Promise 落定,再把结果告诉系统:
| 监听器做了什么 | 系统得到的结果 |
|---|---|
调了 waitUntil(),给的 Promise 全部兑现 | 有新数据 |
调了 waitUntil(),给的 Promise 有一个被拒绝 | 失败了 |
没有调 waitUntil() | 没有新数据 |
没有 push 监听器 | 没有新数据 |
表里四种情况都在验收用例里验证过,用例里推送到达的那一步是模拟的。
- 给
waitUntil()的不是 Promise 时,当成一个已经兑现的 Promise(实测)。 - 系统等的时间有限。 Apple 的文档说大约 30 秒。给网络请求设一个更短的超时,保证 Promise 在那之前落定。未在真机验证。
示例
js
const push = application.remoteNotifications;
push.addEventListener('push', (event) => {
console.log(event instanceof PushEvent, event.cancelable);
event.waitUntil(new Promise((resolve) => setTimeout(resolve, 1000)));
});效果:一条静默推送到了时,输出 true false。一秒后系统得到「有新数据」。推送到达和后台唤醒未在真机验证。
对应的 iOS API
| ObjC | JS |
|---|---|
application:didReceiveRemoteNotification:fetchCompletionHandler: 的参数 userInfo | event.data |
completionHandler(UIBackgroundFetchResultNewData) | waitUntil() 收下的 Promise 全部兑现 |
completionHandler(UIBackgroundFetchResultFailed) | 其中有一个被拒绝 |
completionHandler(UIBackgroundFetchResultNoData) | 没有调 waitUntil() |