org.jboss.aerogear.unifiedpush.message

Class Message

java.lang.Object

org.jboss.aerogear.unifiedpush.message.Message

All Implemented Interfaces:

Serializable

public class Message
extends Object
implements Serializable

The message part of the UnifiedPush message.

For details have a look at the Message Format Specification.

See Also:

Serialized Form

Constructor Summary

Constructors

Constructor and Description
Message()

Method Summary

Methods

Modifier and Type	Method and Description
String	getAlert() Returns the value of the 'alert' key from the submitted payload.
APNs	getApns() Apns specific parameters to configure how the message will be displayed.
int	getBadge() Returns the value of the 'badge' key from the submitted payload.
String	getConsolidationKey() Used for ADM Payload when used for "sync" Push messages.
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.
Windows	getWindows() Windows specific parameters to configure how the message will be displayed.
void	setAlert(String alert)
void	setApns(APNs apns)
void	setBadge(int badge)
void	setConsolidationKey(String consolidationKey)
void	setSimplePush(String simplePush)
void	setSound(String sound)
void	setUserData(Map<String,Object> userData)
void	setWindows(Windows windows)
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

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)

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)

getConsolidationKey

public String getConsolidationKey()

Used for ADM Payload when used for "sync" Push messages. Not supported on other platforms.

Returns:

the consolidation key

setConsolidationKey

public void setConsolidationKey(String consolidationKey)

getApns

public APNs getApns()

Apns specific parameters to configure how the message will be displayed.

setApns

public void setApns(APNs apns)

getWindows

public Windows getWindows()

Windows specific parameters to configure how the message will be displayed.

setWindows

public void setWindows(Windows windows)

toString

public String toString()

Overrides:

toString in class Object