org.jboss.aerogear.unifiedpush.message

Class UnifiedMessage.Builder

java.lang.Object

org.jboss.aerogear.unifiedpush.message.UnifiedMessage.Builder

Enclosing class:

UnifiedMessage

public static class UnifiedMessage.Builder
extends Object

A builder to provide a Fluid API

Constructor Summary

Constructors

Constructor and Description
UnifiedMessage.Builder()

Method Summary

Methods

Modifier and Type	Method and Description
UnifiedMessage.Builder	alert(String message) Triggers a dialog, displaying the value.
UnifiedMessage.Builder	aliases(List<String> aliases) Sets a list of "identifiers", like username or email address.
UnifiedMessage.Builder	attribute(String key, String value) Adds an application specific value for the given key.
UnifiedMessage.Builder	attributes(Map<String,Object> attributes) A map containing various key-value pairs, that represent application specific values.
UnifiedMessage.Builder	badge(String badge) Sets the value of the badge icon - no iOS API needs to be invoked by the app developer.
UnifiedMessage	build()
UnifiedMessage.Builder	category(String category) A category is a semantical tag.
UnifiedMessage.Builder	deviceType(List<String> deviceType) A filter for notifying only users running a certain device.
UnifiedMessage.Builder	masterSecret(String masterSecret) Set the masterSecret used to authenticate against the Push Server.
UnifiedMessage.Builder	pushApplicationId(String pushApplicationId) Specifies which Push Application the message is for.
UnifiedMessage.Builder	simplePush(Map<String,String> entries) Needed when doing a selective send to a SimplePush Network Note: Do not use this method for a "broadcast send".
UnifiedMessage.Builder	simplePush(String version) Needed when broadcasting a message to a SimplePush Network Note: Do not use this method for a "selective send".
UnifiedMessage.Builder	sound(String sound) Plays a given sound - On iOS no API needs to be invoked to play the sound file.
UnifiedMessage.Builder	variants(List<String> variants) 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

Constructor Detail

UnifiedMessage.Builder

public UnifiedMessage.Builder()

Method Detail

pushApplicationId

public UnifiedMessage.Builder pushApplicationId(String pushApplicationId)

Specifies which Push Application the message is for.

Parameters:

pushApplicationId - The pushApplicationID

Returns:

the current UnifiedMessage.Builder instance

masterSecret

public UnifiedMessage.Builder masterSecret(String masterSecret)

Set the masterSecret used to authenticate against the Push Server.

Parameters:

masterSecret - The masterSecret

Returns:

the current UnifiedMessage.Builder instance

aliases

public UnifiedMessage.Builder aliases(List<String> aliases)

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

Parameters:

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

Returns:

the current UnifiedMessage.Builder instance

variants

public UnifiedMessage.Builder variants(List<String> variants)

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

Parameters:

variants - a list of mobile variants ids

Returns:

the current UnifiedMessage.Builder instance

category

public UnifiedMessage.Builder category(String category)

A category is a semantical tag.

Parameters:

category - a semantical tag

Returns:

the current UnifiedMessage.Builder instance

deviceType

public UnifiedMessage.Builder deviceType(List<String> deviceType)

A filter for notifying only users running a certain device.

Parameters:

deviceType - a list of devices i.e ["iPad","iPhone"]

Returns:

the current UnifiedMessage.Builder instance

attributes

public UnifiedMessage.Builder attributes(Map<String,Object> attributes)

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

Parameters:

attributes - map containing several key-value pairs

Returns:

the current UnifiedMessage.Builder instance

attribute

public UnifiedMessage.Builder attribute(String key,
                               String value)

Adds an application specific value for the given key.

Parameters:

key - of an application specific entry

value - of an application specific entry

Returns:

the current UnifiedMessage.Builder instance

alert

public UnifiedMessage.Builder alert(String message)

Triggers a dialog, displaying the value.

Parameters:

message - that will be displayed on the alert UI element

Returns:

the current UnifiedMessage.Builder instance

sound

public UnifiedMessage.Builder sound(String sound)

Plays a given sound - On iOS no API needs to be invoked to play the sound file. However on other platforms custom API call may be required.

Parameters:

sound - i.e name of the sound file

Returns:

the current UnifiedMessage.Builder instance

badge

public UnifiedMessage.Builder badge(String badge)

Sets the value of the badge icon - no iOS API needs to be invoked by the app developer.

Parameters:

badge - i.e file name of the icon

Returns:

the current UnifiedMessage.Builder instance

simplePush

public UnifiedMessage.Builder simplePush(String version)

Needed when broadcasting a message to a SimplePush Network Note: Do not use this method for a "selective send".

Parameters:

version - to pass to the broadcast channel, i.e "version=5"

Returns:

the current UnifiedMessage.Builder instance

simplePush

public UnifiedMessage.Builder simplePush(Map<String,String> entries)

Needed when doing a selective send to a SimplePush Network Note: Do not use this method for a "broadcast send".

Parameters:

entries - representing a key:value where key is an alias (category) of the channel and value some version (i.e "version=5")

Returns:

the current UnifiedMessage.Builder instance

build

public UnifiedMessage build()