org.jboss.aerogear.unifiedpush.message

Class UnifiedMessage.MessageBuilder

java.lang.Object

org.jboss.aerogear.unifiedpush.message.UnifiedMessage.MessageBuilder

Enclosing class:

UnifiedMessage

public static class UnifiedMessage.MessageBuilder
extends Object

Constructor Summary

Constructors

Constructor and Description
MessageBuilder(UnifiedMessage.Builder builder)

Method Summary

Modifier and Type	Method and Description
UnifiedMessage.MessageBuilder	actionCategory(String actionCategory) An iOS specific argument to pass an Action Category for interaction notifications ( iOS8)
UnifiedMessage.MessageBuilder	alert(String message) Triggers a dialog, displaying the value.
UnifiedMessage.MessageBuilder	badge(String badge) Sets the value of the badge icon - no iOS API needs to be invoked by the app developer.
UnifiedMessage	build()
UnifiedMessage.ConfigBuilder	config()
UnifiedMessage.MessageBuilder	contentAvailable() An iOS specific argument to mark the payload as 'content-available'.
UnifiedMessage.CriteriaBuilder	criteria()
protected org.jboss.aerogear.unifiedpush.message.Message	getObject()
UnifiedMessage.MessageBuilder	simplePush(String version) Needed when sending a message to a SimplePush Network
UnifiedMessage.MessageBuilder	sound(String sound) Plays a given sound - On iOS no API needs to be invoked to play the sound file.
UnifiedMessage.MessageBuilder	userData(Map<String,Object> userDataMap) Adds a map containing custom key/value entries.
UnifiedMessage.MessageBuilder	userData(String key, String value) Adds an custom value for the given key.

Methods inherited from class java.lang.Object

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

Constructor Detail

MessageBuilder

public MessageBuilder(UnifiedMessage.Builder builder)

Method Detail

alert

public UnifiedMessage.MessageBuilder alert(String message)

Triggers a dialog, displaying the value.

Parameters:

message - that will be displayed on the alert UI element

Returns:

the current UnifiedMessage.MessageBuilder instance

sound

public UnifiedMessage.MessageBuilder 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.MessageBuilder instance

badge

public UnifiedMessage.MessageBuilder 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.MessageBuilder instance

contentAvailable

public UnifiedMessage.MessageBuilder contentAvailable()

An iOS specific argument to mark the payload as 'content-available'. The feature is needed when sending notifications to Newsstand applications and submitting silent iOS notifications (iOS7)

Returns:

the current UnifiedMessage.MessageBuilder instance

actionCategory

public UnifiedMessage.MessageBuilder actionCategory(String actionCategory)

An iOS specific argument to pass an Action Category for interaction notifications ( iOS8)

Parameters:

actionCategory - , the identifier of the action category for the interactive notification

Returns:

the current UnifiedMessage.MessageBuilder instance

simplePush

public UnifiedMessage.MessageBuilder simplePush(String version)

Needed when sending a message to a SimplePush Network

Parameters:

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

Returns:

the current UnifiedMessage.MessageBuilder instance

userData

public UnifiedMessage.MessageBuilder userData(String key,
                                              String value)

Adds an custom value for the given key. This is used to pass user data to the UnifiedPush Server

Parameters:

key - of an user data entry

value - of an user data entry

Returns:

the current UnifiedMessage.MessageBuilder instance

userData

public UnifiedMessage.MessageBuilder userData(Map<String,Object> userDataMap)

Adds a map containing custom key/value entries. This is used to pass user data to the UnifiedPush Server

Parameters:

userDataMap - containing custom key/value entries

Returns:

the current UnifiedMessage.MessageBuilder instance

criteria

public UnifiedMessage.CriteriaBuilder criteria()

config

public UnifiedMessage.ConfigBuilder config()

build

public UnifiedMessage build()

getObject

protected org.jboss.aerogear.unifiedpush.message.Message getObject()