org.jboss.aerogear.unifiedpush.message

Class UnifiedMessage

java.lang.Object

org.jboss.aerogear.unifiedpush.message.UnifiedMessage

public class UnifiedMessage
extends Object

A UnifiedMessage represents a message in the format expected from the Unified Push Server. The message format is very simple: A generic JSON map is used to sent messages to Android and iOS devices. The applications on the devices will receive the JSON map and are responsible for performing a lookup to read values of the given keys. See the Message Specification for more information.

To construct a message use the UnifiedMessage.Builder like this :

 // Sending an UnifiedMessage
  UnifiedMessage unifiedMessage = new UnifiedMessage.Builder()
       .pushApplicationId("c7fc6525-5506-4ca9-9cf1-55cc261ddb9c")
       .masterSecret("8b2f43a9-23c8-44fe-bee9-d6b0af9e316b")
       .alert("Hello")
       .sound("default")
       .variants(Arrays.asList("c3f0a94f-48de-4b77-a08e-68114460857e")) //e.g. HR_Premium
       .aliases(Arrays.asList("mike", "john"))
       .categories(Arrays.asList("sport","world cup"))
       .deviceType(Arrays.asList("iPad","AndroidTablet"))
       .build();
 
 

Nested Class Summary

Nested Classes

Modifier and Type	Class and Description
static class	UnifiedMessage.Builder A builder to provide a fluent API

Method Summary

Methods

Modifier and Type	Method and Description
List<String>	getAliases() Get a list of "identifiers", like username or email address.
Map<String,Object>	getAttributes() Get a map containing various key-value pairs, that represent application specific values.
Set<String>	getCategories() Get a category list, a category is a semantical tag.
List<String>	getDeviceType() Get a filter for notifying only users running a certain device.
String	getMasterSecret() Get the masterSecret used to authenticate against the Push Server.
String	getPushApplicationId() Get the push Application Id.
String	getSimplePush() Get the key-value pair represented by a String and used by the Simple Push Networks.
Integer	getTimeToLive() Get the Time To Live of the message, used by the APNs/GCM Push Networks
List<String>	getVariants() Get A filter for notifying only specific mobile variants of the Push Application.

Methods inherited from class java.lang.Object

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

Method Detail

getPushApplicationId

public String getPushApplicationId()

Get the push Application Id.

Returns:

the push Application Id

getMasterSecret

public String getMasterSecret()

Get the masterSecret used to authenticate against the Push Server.

Returns:

the master Secret

getAliases

public List<String> getAliases()

Get a list of "identifiers", like username or email address.

Returns:

a list of "identifiers", like username or email address

getVariants

public List<String> getVariants()

Get A filter for notifying only specific mobile variants of the Push Application.

Returns:

A filter for notifying only specific mobile variants of the Push Application

getAttributes

public Map<String,Object> getAttributes()

Get a map containing various key-value pairs, that represent application specific values. The mobile application is asked to look for those keys.

Returns:

A map containing various key-value pairs, that represent application specific values. The mobile application is asked to look for those keys

getCategories

public Set<String> getCategories()

Get a category list, a category is a semantical tag.

Returns:

the category list

getDeviceType

public List<String> getDeviceType()

Get a filter for notifying only users running a certain device.

Returns:

a filter for notifying only users running a certain device

getSimplePush

public String getSimplePush()

Get the key-value pair represented by a String and used by the Simple Push Networks.

Returns:

a String in the form of "version=5"

getTimeToLive

public Integer getTimeToLive()

Get the Time To Live of the message, used by the APNs/GCM Push Networks

Returns:

the Time To Live of the message, used by the APNs/GCM Push Networks