org.jboss.aerogear.unifiedpush.message

Class Message

java.lang.Object

org.jboss.aerogear.unifiedpush.message.Message

public class Message
extends Object

The message part of the UnifiedPush message.

For details have a look at the Message Format Specification.

Constructor Summary

Constructors

Constructor and Description
Message()

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	getSimplePush() Returns the SimplePush specific version number.
String	getSound() Returns the value of the 'sound' key from the submitted payload.
Map<String,Object>	getUserData() Returns a Map, representing any other key-value pairs that were send to the RESTful Sender API.
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	setActionCategory(String actionCategory)
void	setAlert(String alert)
void	setBadge(int badge)
void	setContentAvailable(boolean contentAvailable)
void	setSimplePush(String simplePush)
void	setSound(String sound)
void	setUserData(Map<String,Object> userData)
String	toString()

Methods inherited from class java.lang.Object

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

Constructor Detail

Message

public Message()

Method Detail

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

setActionCategory

public void setActionCategory(String actionCategory)

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.

setAlert

public void setAlert(String alert)

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.

setSound

public void setSound(String sound)

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.

setContentAvailable

public void setContentAvailable(boolean contentAvailable)

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'.

setBadge

public void setBadge(int badge)

getUserData

public Map<String,Object> getUserData()

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

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

setUserData

public void setUserData(Map<String,Object> userData)

getSimplePush

public String getSimplePush()

Returns the SimplePush specific version number.

setSimplePush

public void setSimplePush(String simplePush)

toString

public String toString()

Overrides:

toString in class Object