org.jboss.aerogear.unifiedpush.message

Class UnifiedPushMessage

java.lang.Object

org.jboss.aerogear.unifiedpush.message.UnifiedPushMessage

All Implemented Interfaces:

Serializable

public class UnifiedPushMessage
extends Object
implements Serializable

Contains the data of the JSON payload that has been sent to the RESTful Sender endpoint.

For details have a look at the Message Format Specification. Messages are submitted as follows:

 {
   "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-key" : "some value",
           "localized-arguments" : ["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
     }
 }
 

See Also:

Serialized Form

Constructor Summary

Constructors

Constructor and Description
UnifiedPushMessage()

Method Summary

Methods

Modifier and Type	Method and Description
Config	getConfig()
Criteria	getCriteria() Returns the object that contains all the submitted query criteria.
Message	getMessage()
void	setConfig(Config config)
void	setCriteria(Criteria criteria)
void	setMessage(Message message)
String	toJsonString()
String	toMinimizedJsonString() Returns a minimized JSON representation of the payload.
String	toString()
String	toStrippedJsonString() Returns a JSON representation of the payload.

Methods inherited from class java.lang.Object

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

Constructor Detail

UnifiedPushMessage

public UnifiedPushMessage()

Method Detail

getCriteria

public Criteria getCriteria()

Returns the object that contains all the submitted query criteria.

setCriteria

public void setCriteria(Criteria criteria)

getConfig

public Config getConfig()

setConfig

public void setConfig(Config config)

getMessage

public Message getMessage()

setMessage

public void setMessage(Message message)

toStrippedJsonString

public String toStrippedJsonString()

Returns a JSON representation of the payload. This does not include any pushed data, just the alert of the message. This also contains the entire criteria object.

Returns:

JSON payload

See Also:

toMinimizedJsonString()

toMinimizedJsonString

public String toMinimizedJsonString()

Returns a minimized JSON representation of the payload. This does not include potentially large objects, like alias or category from the given criteria.

Returns:

minizmized JSON payload

See Also:

toStrippedJsonString()

toJsonString

public String toJsonString()

toString

public String toString()

Overrides:

toString in class Object