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-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
String	getClientIdentifier() The Client Identifier showing who triggered the Push Notification
Config	getConfig()
Criteria	getCriteria() Returns the object that contains all the submitted query criteria.
String	getIpAddress() The IP address from the agent that did issue the push message request.
Message	getMessage()
void	setClientIdentifier(String clientIdentifier)
void	setConfig(Config config)
void	setCriteria(Criteria criteria)
void	setIpAddress(String ipAddress)
void	setMessage(Message message)
String	toJsonString()
String	toString()
String	toStrippedJsonString()

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)

getIpAddress

public String getIpAddress()

The IP address from the agent that did issue the push message request.

setIpAddress

public void setIpAddress(String ipAddress)

getClientIdentifier

public String getClientIdentifier()

The Client Identifier showing who triggered the Push Notification

setClientIdentifier

public void setClientIdentifier(String clientIdentifier)

toStrippedJsonString

public String toStrippedJsonString()

toJsonString

public String toJsonString()

toString

public String toString()

Overrides:

toString in class Object