Skip to content

Commit 5b63863

Browse files
committed
Deploying to gh-pages from @ 9568315 🚀
1 parent 9568315 commit 5b63863

24 files changed

+1112
-2640
lines changed
Lines changed: 92 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,92 @@
1+
# LoopBack Push Notification Component
2+
3+
**⚠️ LoopBack 3 is in Maintenance LTS mode, only critical bugs and critical
4+
security fixes will be provided. (See
5+
[Module Long Term Support Policy](#module-long-term-support-policy) below.)**
6+
7+
We urge all LoopBack 3 users to migrate their applications to LoopBack 4 as
8+
soon as possible. Refer to our
9+
[Migration Guide](https://loopback.io/doc/en/lb4/migration-overview.html)
10+
for more information on how to upgrade.
11+
12+
## Overview
13+
14+
> StrongLoop Labs projects provide early access to advanced or experimental functionality. In general, these projects may lack usability, completeness, documentation, and robustness, and may be outdated.
15+
However, StrongLoop supports these projects: Paying customers can open issues using the StrongLoop customer support system (Zendesk), and community users can report bugs on GitHub.
16+
17+
This module provides a set of LoopBack models to enable mobile device push notifications.
18+
19+
Please see the full documentation: [Push notifications](http://docs.strongloop.com/display/LB/Push+notifications).
20+
21+
> The loopback-component-push module supersedes [loopback-push-notification](https://www.npmjs.org/package/loopback-push-notification). Please update your package.json accordingly.
22+
23+
## Architecture
24+
25+
![push-notification.png](push-notification.png)
26+
27+
## Key Components
28+
29+
- Device model and APIs to manage devices with applications and users
30+
- Application model to provide push settings for device types such as ios and
31+
android
32+
- Notification model to capture notification messages and persist scheduled
33+
notifications
34+
- Optional Job to take scheduled notification requests
35+
- Push connector that interact with device registration records and push
36+
providers such as APNS, GCM, and MPNS
37+
- Push model to provide high level APIs for device-independent push notifications
38+
39+
## Samples
40+
41+
### Node.js server
42+
43+
This module includes an [example LoopBack server application](https://github.com/strongloop/loopback-example-push).
44+
45+
To run it, use these commands:
46+
47+
```shell
48+
$ cd example/server
49+
$ npm install
50+
$ bower install
51+
$ node app
52+
```
53+
54+
Open your browser to [http://127.0.0.1:3010](http://127.0.0.1:3010).
55+
56+
By default, the application uses an in-memory store for the application/installation data.
57+
To change to a MongoDB instance, set the MONGODB environment variable to the MongoDB URL. For example,
58+
59+
```shell
60+
MONGODB=mongodb://localhost/demo node app
61+
```
62+
63+
### iOS client
64+
65+
The [iOS example app](https://github.com/strongloop/loopback-example-push/tree/master/ios)
66+
uses the LoopBack iOS SDK to enable and handle push notifications.
67+
68+
### Android client
69+
70+
The [Android example app](https://github.com/strongloop/loopback-example-push/tree/master/android)
71+
uses the LoopBack Android SDK to enable and handle push notifications.
72+
73+
## References
74+
75+
- https://developer.apple.com/library/ios/documentation/NetworkingInternet/Conceptual/RemoteNotificationsPG/Chapters/ApplePushService.html
76+
- http://developer.android.com/google/gcm/index.html
77+
- http://msdn.microsoft.com/en-us/library/windowsphone/develop/hh202945(v=vs.105).aspx
78+
- https://github.com/argon/node-apn
79+
- https://github.com/logicalparadox/apnagent-ios
80+
- https://blog.engineyard.com/2013/developing-ios-push-notifications-nodejs
81+
82+
## Module Long Term Support Policy
83+
84+
This module adopts the [
85+
Module Long Term Support (LTS)](http://github.com/CloudNativeJS/ModuleLTS) policy,
86+
with the following End Of Life (EOL) dates:
87+
88+
| Version | Status | Published | EOL |
89+
| ------- | --------------- | --------- | -------- |
90+
| 3.x | Maintenance LTS | Dec 2016 | Dec 2020 |
91+
92+
Learn more about our LTS plan in [docs](https://loopback.io/doc/en/contrib/Long-term-support.html).

0 commit comments

Comments
 (0)