Ecosyste.ms: Awesome
An open API service indexing awesome lists of open source software.
https://github.com/fernandospr/javapns-jdk16
Apple Push Notification Service Provider for Java
https://github.com/fernandospr/javapns-jdk16
Last synced: about 6 hours ago
JSON representation
Apple Push Notification Service Provider for Java
- Host: GitHub
- URL: https://github.com/fernandospr/javapns-jdk16
- Owner: fernandospr
- License: lgpl-3.0
- Created: 2013-10-02T14:10:34.000Z (over 11 years ago)
- Default Branch: master
- Last Pushed: 2019-11-21T22:27:06.000Z (about 5 years ago)
- Last Synced: 2024-12-28T22:15:18.274Z (7 days ago)
- Language: Java
- Size: 135 KB
- Stars: 106
- Watchers: 23
- Forks: 64
- Open Issues: 19
-
Metadata Files:
- Readme: README.md
- License: LICENSE
Awesome Lists containing this project
README
DEPRECATED
==========
This library uses the legacy Apple API. Please, consider moving to a more efficient HTTP-2/based API, by using another library (e.g. https://github.com/CleverTap/apns-http2).
I will stop mantaining this library, thanks everyone for your contributions.
javapns-jdk16
=============
Apple Push Notification Service Provider for Java
Fork of JavaPNS to include Maven support - http://code.google.com/p/javapns/
Java1.6 compatible
## Updates
Version 2.4.0 released!
**2.4.0 Changes**
* Added support for the following fields:
* category
* mutable-content (iOS>=10)
* title, subtitle (iOS>=10), title-loc-key, title-loc-args and launch-image
**2.3.1 Changes**
* PushNotificationBigPayload ```complex``` and ```fromJson``` methods fixed
* Fix to make trust store work on IBM JVM
**2.3 Changes**
* iOS>=8 bigger notification payload support (2KB)
* iOS>=7 Silent push notifications support ("content-available":1)
## Installation through Central Maven Repository
javapns-jdk16 is available on the Central Maven Repository.
To use javapns-jdk16 in your project, please add the following dependency to your pom.xml file:
```
com.github.fernandospr
javapns-jdk16
2.4.0
```
## Usage
You need to first construct the push notification payload.
```
PushNotificationBigPayload payload = ... // See Payload examples below
```
Then send it:
```
Push.payload(payload, p12File, password, isProduction, deviceTokens);
```
## Payload examples
Based on Apple docs
#### Example 1
To send the following payload:
```
{
"aps" : { "alert" : "Message received from Bob" },
"acme2" : [ "bang", "whiz" ]
}
```
You should code the following:
```
PushNotificationBigPayload payload = PushNotificationBigPayload.complex();
payload.addAlert("Message received from Bob");
payload.addCustomDictionary("acme2", Arrays.asList("bang", "whiz"));
```
#### Example 2
To send the following payload:
```
{
"aps" : {
"alert" : {
"title" : "Game Request",
"body" : "Bob wants to play poker",
"action-loc-key" : "PLAY"
},
"badge" : 5
},
"acme1" : "bar",
"acme2" : [ "bang", "whiz" ]
}
```
You should code the following:
```
PushNotificationBigPayload payload = PushNotificationBigPayload.complex();
payload.addCustomAlertTitle("Game Request");
payload.addCustomAlertBody("Bob wants to play poker");
payload.addCustomAlertActionLocKey("PLAY");
payload.addBadge(5);
payload.addCustomDictionary("acme1", "bar");
payload.addCustomDictionary("acme2", Arrays.asList("bang", "whiz"));
```
#### Example 3
To send the following payload:
```
{
"aps" : {
"alert" : "You got your emails.",
"badge" : 9,
"sound" : "bingbong.aiff"
},
"acme1" : "bar",
"acme2" : 42
}
```
You should code the following:
```
PushNotificationBigPayload payload = PushNotificationBigPayload.complex();
payload.addCustomAlertBody("You got your emails.");
payload.addBadge(9);
payload.addSound("bingbong.aiff");
payload.addCustomDictionary("acme1", "bar");
payload.addCustomDictionary("acme2", 42);
```
#### Example 4
To send the following payload:
```
{
"aps" : {
"alert" : {
"loc-key" : "GAME_PLAY_REQUEST_FORMAT",
"loc-args" : [ "Jenna", "Frank"]
},
"sound" : "chime.aiff"
},
"acme" : "foo"
}
```
You should code the following:
```
PushNotificationBigPayload payload = PushNotificationBigPayload.complex();
payload.addCustomAlertLocKey("GAME_PLAY_REQUEST_FORMAT");
payload.addCustomAlertLocArgs(Arrays.asList("Jenna", "Frank"));
payload.addSound("chime.aiff");
payload.addCustomDictionary("acme", "foo");
```
#### Example 5
To send the following payload:
```
{
"aps" : {
"content-available" : 1
},
"acme" : "foo"
}
```
You should code the following:
```
PushNotificationBigPayload payload = PushNotificationBigPayload.complex();
payload.setContentAvailable(true);
payload.addCustomDictionary("acme", "foo");
```
#### Example 6
To send the following payload:
```
{
"aps": {
"mutable-content":1,
"alert":{
"title": "Notification title",
"subtitle": "Notification subtitle",
"body": "Notification body"
}
},
"media-attachment": "https://url/to/content.mpg"
}
```
You should code the following:
```
PushNotificationBigPayload payload = PushNotificationBigPayload.complex();
payload.setMutableContent(true);
payload.addCustomAlertTitle("Notification title");
payload.addCustomAlertSubtitle("Notification subtitle");
payload.addCustomAlertBody("Notification body");
payload.addCustomDictionary("media-attachment", "https://url/to/content.mpg");
```