org.jboss.aerogear.unifiedpush.rest.sender

Class PushNotificationSenderEndpoint

java.lang.Object

org.jboss.aerogear.unifiedpush.rest.sender.PushNotificationSenderEndpoint

public class PushNotificationSenderEndpoint
extends Object

Constructor Summary

Constructors

Constructor and Description
PushNotificationSenderEndpoint()

Method Summary

Methods

Modifier and Type	Method and Description
javax.ws.rs.core.Response	send(UnifiedPushMessage message, javax.servlet.http.HttpServletRequest request) RESTful API for sending Push Notifications.

Methods inherited from class java.lang.Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

Constructor Detail

PushNotificationSenderEndpoint

public PushNotificationSenderEndpoint()

Method Detail

send

public javax.ws.rs.core.Response send(UnifiedPushMessage message,
                             @Context
                             javax.servlet.http.HttpServletRequest request)

RESTful API for sending Push Notifications. The Endpoint is protected using HTTP Basic (credentials PushApplicationID:masterSecret).

Messages are submitted as flexible JSON maps, like:

 curl -u "PushApplicationID:MasterSecret"
   -v -H "Accept: application/json" -H "Content-type: application/json"
   -X POST
   -d '{
     "message": {
      "alert": "HELLO!",
      "sound": "default",
      "badge": 2,
      "user-data": {
          "key": "value",
          "key2": "other value"
      },
      "windows": {
          "type": "tile",
          "duration": "short",
          "badge": "alert",
          "tileType": "TileWideBlockAndText01",
          "images": ["Assets/test.jpg", "Assets/background.png"],
          "textFields": ["foreground text"]
      },
      "apns": {
          "title" : "someTitle",
          "action-category": "some value",
          "content-available": true,
          "action" : "someAction",
          "url-args" :["args1","arg2"],
          "localized-title-key" : "some value",
          "localized-title-arguments" : ["args1","arg2"]
      }
      "simple-push": "version=123"
     },
     "criteria": {
         "alias": [ "someUsername" ],
         "deviceType": [ "someDevice" ],
         "categories": [ "someCategories" ],
         "variants": [ "someVariantIDs" ]
     },
     "config": {
         "ttl": 3600
     }
   }'
   https://SERVER:PORT/CONTEXT/rest/sender
 

Details about the Message Format can be found HERE!