org.jboss.aerogear.unifiedpush.message

Class UnifiedPushMessage

java.lang.Object

org.jboss.aerogear.unifiedpush.message.UnifiedPushMessage

public class UnifiedPushMessage
extends Object

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.

Constructor Summary

Constructors

Constructor and Description
UnifiedPushMessage(Map<String,Object> data) Messages are submitted as flexible JSON maps, like:

Method Summary

Methods

Modifier and Type	Method and Description
String	getActionCategory() Returns the value of the 'action-category', which is used on the client (iOS for now), to invoke a certain "user action" on the device, based on the push message.
String	getAlert() Returns the value of the 'alert' key from the submitted payload.
int	getBadge() Returns the value of the 'badge' key from the submitted payload.
String	getClientIdentifier() The Client Identifier showing who triggered the Push Notification
Map<String,Object>	getData() Returns a Map, representing any other key-value pairs that were send to the RESTful Sender API.
String	getIpAddress() The IP address from the agent that did issue the push message request.
SendCriteria	getSendCriteria() Returns the object that contains all the submitted query criteria.
String	getSimplePush() Returns the SimplePush specific version number.
String	getSound() Returns the value of the 'sound' key from the submitted payload.
int	getTimeToLive() Returns the value of the 'ttl' key from the submitted payload.
boolean	isContentAvailable() Used for in iOS specific feature, to indicate if content (for Newsstand or silent messages) has marked as being available Not supported on other platforms.
void	setClientIdentifier(String clientIdentifier)
void	setIpAddress(String ipAddress)
String	toJsonString()
String	toString()

Methods inherited from class java.lang.Object

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

Constructor Detail

UnifiedPushMessage

public UnifiedPushMessage(Map<String,Object> data)

Messages are submitted as flexible JSON maps, like:

   {
     "alias" : ["someUsername"],
     "deviceType" : ["someDevice"],
     "categories" : ["someCategories"],
     "variants" : ["someVariantIDs"],
     "ttl" : 3600,
     "message":
     {
       "key":"value",
       "key2":"other value",
       "alert":"HELLO!",
       "action-category":"some value",
       "sound":"default",
       "badge":2,
       "content-available" : true
     },
     "simple-push":"version=123"
   }
 

This class give some convenient methods to access the query components (alias or deviceType), the simple-push value or some highlighted keywords.

Method Detail

getSendCriteria

public SendCriteria getSendCriteria()

Returns the object that contains all the submitted query criteria.

getSimplePush

public String getSimplePush()

Returns the SimplePush specific version number.

getAlert

public String getAlert()

Returns the value of the 'alert' key from the submitted payload. This key is recognized in native iOS, without any API invocation and on AeroGear's GCM offerings. Android users that are not using AGDROID can read the value as well, but need to call specific APIs to show the 'alert' value.

getActionCategory

public String getActionCategory()

Returns the value of the 'action-category', which is used on the client (iOS for now), to invoke a certain "user action" on the device, based on the push message. Implemented for iOS8

getTimeToLive

public int getTimeToLive()

Returns the value of the 'ttl' key from the submitted payload. This key is recognized for the Android and iOS Push Notification Service. If the 'ttl' key has not been specified on the submitted payload, this method will return -1.

getSound

public String getSound()

Returns the value of the 'sound' key from the submitted payload. This key is recognized in native iOS, without any API invocation. Android users can read the value as well, but need to call specific APIs to play the referenced 'sound' file.

getBadge

public int getBadge()

Returns the value of the 'badge' key from the submitted payload. This key is recognized in native iOS, without any API invocation. Android users can read the value as well, but need to call specific APIs to show the 'badge number'.

isContentAvailable

public boolean isContentAvailable()

Used for in iOS specific feature, to indicate if content (for Newsstand or silent messages) has marked as being available Not supported on other platforms.

getData

public Map<String,Object> getData()

Returns a Map, representing any other key-value pairs that were send to the RESTful Sender API. This map usually contains application specific data, like:

  "sport-news-channel15" : "San Francisco 49er won last game"
 

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)

toJsonString

public String toJsonString()

toString

public String toString()

Overrides:

toString in class Object